net.sourceforge.plantuml.skin.VisibilityModifier Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit 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 MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* 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 MIT license.
*
* The generated images can then be used without any reference to the MIT 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.skin;
import net.atmp.InnerStrategy;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XRectangle2D;
import net.sourceforge.plantuml.klimt.shape.AbstractTextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.UDrawable;
import net.sourceforge.plantuml.klimt.shape.UEllipse;
import net.sourceforge.plantuml.klimt.shape.UPolygon;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
public enum VisibilityModifier {
PRIVATE_FIELD(StringUtils.PRIVATE_FIELD, ColorParam.iconPrivate, null),
PROTECTED_FIELD(StringUtils.PROTECTED_FIELD, ColorParam.iconProtected, null),
PACKAGE_PRIVATE_FIELD(StringUtils.PACKAGE_PRIVATE_FIELD, ColorParam.iconPackage, null),
PUBLIC_FIELD(StringUtils.PUBLIC_FIELD, ColorParam.iconPublic, null),
PRIVATE_METHOD(StringUtils.PRIVATE_METHOD, ColorParam.iconPrivate, ColorParam.iconPrivateBackground),
PROTECTED_METHOD(StringUtils.PROTECTED_METHOD, ColorParam.iconProtected, ColorParam.iconProtectedBackground),
PACKAGE_PRIVATE_METHOD(StringUtils.PACKAGE_PRIVATE_METHOD, ColorParam.iconPackage,
ColorParam.iconPackageBackground),
PUBLIC_METHOD(StringUtils.PUBLIC_METHOD, ColorParam.iconPublic, ColorParam.iconPublicBackground),
IE_MANDATORY(StringUtils.IE_MANDATORY, ColorParam.iconIEMandatory, ColorParam.iconIEMandatory);
private final ColorParam foregroundParam;
private final ColorParam backgroundParam;
private final char unicode;
public static String regexForVisibilityCharacterInClassName() {
return "[-#+~]";
}
private VisibilityModifier(char unicode, ColorParam foreground, ColorParam background) {
this.foregroundParam = foreground;
this.backgroundParam = background;
this.unicode = unicode;
}
public UDrawable getUDrawable(final int size, final HColor foregroundColor, final HColor backgoundColor) {
return new UDrawable() {
public void drawU(UGraphic ug) {
drawInternal(ug, size, foregroundColor, backgoundColor, 0, 0);
}
};
}
public TextBlock getUBlock(final int size, final HColor foregroundColor, final HColor backgoundColor,
final boolean withInvisibleRectanble) {
return new AbstractTextBlock() {
public XDimension2D calculateDimension(StringBounder stringBounder) {
return new XDimension2D(size + 1, size + 1);
}
@Override
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder, InnerStrategy strategy) {
return null;
}
public void drawU(UGraphic ug) {
if (withInvisibleRectanble)
ug.apply(HColors.none()).draw(URectangle.build(size * 2, size));
drawInternal(ug, size, foregroundColor, backgoundColor, 0, 0);
}
};
}
private void drawInternal(UGraphic ug, int size, final HColor foregroundColor, final HColor backgoundColor,
double x, double y) {
if (backgoundColor == null)
ug = ug.apply(HColors.none().bg());
else
ug = ug.apply(backgoundColor.bg());
ug = ug.apply(foregroundColor);
size = ensureEven(size);
switch (this) {
case PACKAGE_PRIVATE_FIELD:
drawTriangle(ug, false, size, x, y);
break;
case PRIVATE_FIELD:
drawSquare(ug, false, size, x, y);
break;
case PROTECTED_FIELD:
drawDiamond(ug, false, size, x, y);
break;
case PUBLIC_FIELD:
drawCircle(ug, false, size, x, y);
break;
case PACKAGE_PRIVATE_METHOD:
drawTriangle(ug, true, size, x, y);
break;
case PRIVATE_METHOD:
drawSquare(ug, true, size, x, y);
break;
case PROTECTED_METHOD:
drawDiamond(ug, true, size, x, y);
break;
case PUBLIC_METHOD:
drawCircle(ug, true, size, x, y);
break;
case IE_MANDATORY:
drawCircle(ug, true, size, x, y);
break;
default:
throw new IllegalStateException();
}
}
private void drawSquare(UGraphic ug, boolean filled, int size, double x, double y) {
ug.apply(new UTranslate(x + 2, y + 2)).draw(URectangle.build(size - 4, size - 4));
}
private void drawCircle(UGraphic ug, boolean filled, int size, double x, double y) {
ug.apply(new UTranslate(x + 2, y + 2)).draw(UEllipse.build(size - 4, size - 4));
}
static private int ensureEven(int n) {
if (n % 2 == 1)
n--;
return n;
}
private void drawDiamond(UGraphic ug, boolean filled, int size, double x, double y) {
final UPolygon poly = new UPolygon();
size -= 2;
poly.addPoint(size / 2.0, 0);
poly.addPoint(size, size / 2.0);
poly.addPoint(size / 2.0, size);
poly.addPoint(0, size / 2.0);
ug.apply(new UTranslate(x + 1, y)).draw(poly);
}
private void drawTriangle(UGraphic ug, boolean filled, int size, double x, double y) {
final UPolygon poly = new UPolygon();
size -= 2;
poly.addPoint(size / 2.0, 1);
poly.addPoint(0, size - 1);
poly.addPoint(size, size - 1);
ug.apply(new UTranslate(x + 1, y)).draw(poly);
}
public static boolean isVisibilityCharacter(CharSequence s) {
if (s.length() <= 2)
return false;
final char c = s.charAt(0);
if (s.charAt(1) == c)
return false;
if (c == '-')
return true;
if (c == '#')
return true;
if (c == '+')
return true;
if (c == '~')
return true;
if (c == '*')
return true;
return false;
}
public static VisibilityModifier getByUnicode(char c) {
for (VisibilityModifier modifier : VisibilityModifier.values())
if (modifier.unicode == c)
return modifier;
return null;
}
public static String replaceVisibilityModifierByUnicodeChar(String s, boolean isField) {
final VisibilityModifier modifier = getVisibilityModifier(s, isField);
if (modifier == null)
return s;
return "" + modifier.unicode + s.substring(1);
}
public static VisibilityModifier getVisibilityModifier(CharSequence s, boolean isField) {
if (s.length() <= 2)
return null;
final char c = s.charAt(0);
if (s.charAt(1) == c)
return null;
if (isField)
return getVisibilityModifierForField(c);
return getVisibilityModifierForMethod(c);
}
private static VisibilityModifier getVisibilityModifierForField(char c) {
if (c == '-')
return VisibilityModifier.PRIVATE_FIELD;
if (c == '#')
return VisibilityModifier.PROTECTED_FIELD;
if (c == '+')
return VisibilityModifier.PUBLIC_FIELD;
if (c == '~')
return VisibilityModifier.PACKAGE_PRIVATE_FIELD;
if (c == '*')
return VisibilityModifier.IE_MANDATORY;
return null;
}
private static VisibilityModifier getVisibilityModifierForMethod(char c) {
if (c == '-')
return VisibilityModifier.PRIVATE_METHOD;
if (c == '#')
return VisibilityModifier.PROTECTED_METHOD;
if (c == '+')
return VisibilityModifier.PUBLIC_METHOD;
if (c == '~')
return VisibilityModifier.PACKAGE_PRIVATE_METHOD;
if (c == '*')
return VisibilityModifier.IE_MANDATORY;
return null;
}
public final ColorParam getForeground() {
return foregroundParam;
}
public final ColorParam getBackground() {
return backgroundParam;
}
public String getXmiVisibility() {
if (this == PUBLIC_FIELD || this == PUBLIC_METHOD)
return "public";
if (this == PRIVATE_FIELD || this == PRIVATE_METHOD)
return "private";
if (this == PROTECTED_FIELD || this == PROTECTED_METHOD)
return "protected";
if (this == PACKAGE_PRIVATE_FIELD || this == VisibilityModifier.PACKAGE_PRIVATE_METHOD)
return "package";
throw new IllegalStateException();
}
public boolean isField() {
if (this == PUBLIC_FIELD || this == PRIVATE_FIELD || this == PROTECTED_FIELD || this == PACKAGE_PRIVATE_FIELD)
return true;
return false;
}
public StyleSignatureBasic getStyleSignature() {
if (this == IE_MANDATORY)
return StyleSignatureBasic.of(SName.root, SName.element, SName.visibilityIcon, SName.IEMandatory);
if (this == PUBLIC_FIELD || this == PUBLIC_METHOD)
return StyleSignatureBasic.of(SName.root, SName.element, SName.visibilityIcon, SName.public_);
if (this == PRIVATE_FIELD || this == PRIVATE_METHOD)
return StyleSignatureBasic.of(SName.root, SName.element, SName.visibilityIcon, SName.private_);
if (this == PROTECTED_FIELD || this == PROTECTED_METHOD)
return StyleSignatureBasic.of(SName.root, SName.element, SName.visibilityIcon, SName.protected_);
if (this == PACKAGE_PRIVATE_FIELD || this == VisibilityModifier.PACKAGE_PRIVATE_METHOD)
return StyleSignatureBasic.of(SName.root, SName.element, SName.visibilityIcon, SName.package_);
throw new IllegalStateException();
}
}