net.sourceforge.plantuml.style.StyleSignatureBasic Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.style;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import net.sourceforge.plantuml.stereo.Stereostyles;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.stereo.StereotypeDecoration;
import net.sourceforge.plantuml.text.Guillemet;
import net.sourceforge.plantuml.url.Url;
public class StyleSignatureBasic implements StyleSignature {
// ::remove file when __HAXE__
public static final String STAR = "*";
private final Set names = new LinkedHashSet<>();
private final boolean withDot;
public StyleSignatureBasic(String s) {
if (s.contains(STAR) || s.contains("&") || s.contains("-"))
throw new IllegalArgumentException();
this.withDot = s.contains(".");
this.names.add(clean(s));
}
public static StyleSignatureBasic empty() {
return new StyleSignatureBasic(false);
}
private StyleSignatureBasic(boolean withDot) {
this.withDot = withDot;
}
private StyleSignatureBasic(boolean withDot, Collection copy) {
this.names.addAll(copy);
this.withDot = withDot;
}
public StyleSignatureBasic addClickable(Url url) {
if (url == null)
return this;
final Set result = new LinkedHashSet<>(names);
result.add(SName.clickable.name());
return new StyleSignatureBasic(withDot, result);
}
public StyleSignatureBasic add(String s) {
if (s == null)
return this;
if (s.contains("&"))
throw new IllegalArgumentException();
final Set result = new LinkedHashSet<>(names);
result.add(clean(s));
return new StyleSignatureBasic(withDot || s.contains("."), result);
}
public StyleSignatureBasic addS(Stereotype stereo) {
if (stereo == null)
return this;
final Set result = new LinkedHashSet<>(names);
boolean withDotLocal = withDot;
for (String s : stereo.getLabels(Guillemet.NONE)) {
if (s.contains("&"))
throw new IllegalArgumentException();
result.add(StereotypeDecoration.PREFIX + clean(s));
withDotLocal = withDotLocal || s.contains(".");
}
return new StyleSignatureBasic(withDotLocal, result);
}
public StyleSignatureBasic add(SName name) {
return add(name.name().toLowerCase().replace("_", ""));
}
public StyleSignatureBasic addStar() {
final Set result = new LinkedHashSet<>(names);
result.add(STAR);
return new StyleSignatureBasic(withDot, result);
}
public boolean isStarred() {
return names.contains(STAR);
}
@Override
public boolean equals(Object arg) {
final StyleSignatureBasic other = (StyleSignatureBasic) arg;
return this.names.equals(other.names);
}
@Override
public int hashCode() {
return names.hashCode();
}
@Override
public String toString() {
final StringBuilder result = new StringBuilder();
for (String n : names) {
if (result.length() > 0)
result.append('.');
result.append(n);
}
return result.toString() + " " + withDot;
}
public boolean matchAll(StyleSignatureBasic other) {
final boolean namesContainsStar = names.contains(STAR);
if (other.isStarred() && namesContainsStar == false)
return false;
final int depthInNames = depthFromTokens(other.names);
for (String token : names) {
if (token.equals(STAR))
continue;
if (namesContainsStar && depthInNames != -1 && depthFromToken(token) != -1) {
// depth comparaison
if (depthInNames < depthFromToken(token))
return false;
} else {
if (other.names.contains(token) == false)
return false;
}
}
return true;
}
private static int depthFromToken(String token) {
if (token.startsWith("depth("))
return Integer.parseInt(token.substring("depth(".length(), token.length() - 1));
return -1;
}
private static int depthFromTokens(Collection tokens) {
for (String token : tokens) {
final int depth = depthFromToken(token);
if (depth != -1)
return depth;
}
return -1;
}
public final Set getNames() {
return Collections.unmodifiableSet(names);
}
public static StyleSignatureBasic of(SName... names) {
final List result = new ArrayList<>();
for (SName name : names)
result.add(name.name().toLowerCase().replace("_", ""));
return new StyleSignatureBasic(false, result);
}
public StyleSignature forStereotypeItself(Stereotype stereotype) {
if (stereotype == null || stereotype.getStyleNames().size() == 0)
return this;
final StyleSignatures result = new StyleSignatures();
for (String name : stereotype.getStyleNames()) {
final List tmp = new ArrayList<>(names);
tmp.add(SName.stereotype.name().toLowerCase().replace("_", ""));
tmp.add(clean(name));
result.add(new StyleSignatureBasic(false, tmp));
}
return result;
}
@Override
public StyleSignature withTOBECHANGED(Stereotype stereotype) {
if (stereotype == null || stereotype.getStyleNames().size() == 0)
return this;
final StyleSignatures result = new StyleSignatures();
for (String name : stereotype.getStyleNames()) {
final List tmp = new ArrayList<>(names);
tmp.add(clean(name));
result.add(new StyleSignatureBasic(true, tmp));
}
return result;
}
@Override
public StyleSignature with(Stereostyles stereostyles) {
if (stereostyles.isEmpty())
return this;
final List result = new ArrayList<>(names);
for (String name : stereostyles.getStyleNames())
result.add(StereotypeDecoration.PREFIX + clean(name));
return new StyleSignatureBasic(true, result);
}
private String clean(String name) {
if (name.startsWith("."))
name = StereotypeDecoration.PREFIX + name;
return name.toLowerCase().replace("_", "").replace(".", "");
}
public StyleSignatureBasic mergeWith(List