net.sourceforge.plantuml.cucadiagram.MethodsOrFieldsArea 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.cucadiagram;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import net.atmp.InnerStrategy;
import net.sourceforge.plantuml.EmbeddedDiagram;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.CreoleMode;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.PlacementStrategy;
import net.sourceforge.plantuml.klimt.geom.PlacementStrategyVisibility;
import net.sourceforge.plantuml.klimt.geom.PlacementStrategyY1Y2Center;
import net.sourceforge.plantuml.klimt.geom.PlacementStrategyY1Y2Left;
import net.sourceforge.plantuml.klimt.geom.PlacementStrategyY1Y2Right;
import net.sourceforge.plantuml.klimt.geom.ULayoutGroup;
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.TextBlockLineBefore;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.TextBlockWithUrl;
import net.sourceforge.plantuml.skin.VisibilityModifier;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.svek.Ports;
import net.sourceforge.plantuml.svek.WithPorts;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.utils.CharHidder;
public class MethodsOrFieldsArea extends AbstractTextBlock implements TextBlock, WithPorts {
public TextBlock asBlockMemberImpl() {
return new TextBlockLineBefore(style.value(PName.LineThickness).asDouble(),
TextBlockUtils.withMargin(this, 6, 4));
}
private final ISkinParam skinParam;
private final Display members;
private final HorizontalAlignment align;
private final List embeddeds = new ArrayList<>();
private final Entity leaf;
private final Style style;
public MethodsOrFieldsArea(Display members, ISkinParam skinParam, Entity leaf, Style style) {
this(members, skinParam, HorizontalAlignment.LEFT, leaf, style);
}
public MethodsOrFieldsArea(Display members, ISkinParam skinParam, HorizontalAlignment align, Entity leaf,
Style style) {
this.style = style;
this.leaf = leaf;
this.align = align;
this.skinParam = skinParam;
final List result = new ArrayList<>();
final Iterator it = members.iterator();
while (it.hasNext()) {
final CharSequence cs = it.next();
final String type = EmbeddedDiagram.getEmbeddedType(StringUtils.trinNoTrace(cs));
if (type != null)
embeddeds.add(EmbeddedDiagram.createAndSkip(type, it, skinParam));
else
result.add(cs);
}
this.members = Display.create(result);
}
private boolean hasSmallIcon() {
if (skinParam.classAttributeIconSize() == 0)
return false;
for (CharSequence cs : members) {
if (cs instanceof Member == false)
continue;
final Member m = (Member) cs;
if (m.getVisibilityModifier() != null)
return true;
}
return false;
}
@Override
public XDimension2D calculateDimension(StringBounder stringBounder) {
final XDimension2D dim1 = calculateDimensionOnlyMembers(stringBounder);
double x = dim1.getWidth();
double y = dim1.getHeight();
for (EmbeddedDiagram embedded : embeddeds) {
final XDimension2D dim = embedded.calculateDimension(stringBounder);
x = Math.max(dim.getWidth(), x);
y += dim.getHeight();
}
return new XDimension2D(x, y);
}
private XDimension2D calculateDimensionOnlyMembers(StringBounder stringBounder) {
double smallIcon = 0;
if (hasSmallIcon())
smallIcon = skinParam.getCircledCharacterRadius() + 3;
double x = 0;
double y = 0;
for (CharSequence cs : members) {
final TextBlock bloc = createTextBlock(cs);
final XDimension2D dim = bloc.calculateDimension(stringBounder);
x = Math.max(dim.getWidth(), x);
y += dim.getHeight();
}
x += smallIcon;
return new XDimension2D(x, y);
}
private Collection sortBySize(Collection all) {
final List result = new ArrayList(all);
Collections.sort(result, new Comparator() {
@Override
public int compare(String s1, String s2) {
final int diff = s2.length() - s1.length();
if (diff != 0)
return diff;
return s1.compareTo(s2);
}
});
return result;
}
@Override
public Ports getPorts(StringBounder stringBounder) {
final Ports ports = new Ports();
double y = 0;
final Collection shortNames = sortBySize(leaf.getPortShortNames());
for (CharSequence cs : members) {
final TextBlock bloc = createTextBlock(cs);
final XDimension2D dim = bloc.calculateDimension(stringBounder);
final Elected elected = getElected(convert(cs), shortNames);
if (elected != null)
ports.add(elected.getShortName(), elected.getScore(), y, dim.getHeight());
y += dim.getHeight();
}
return ports;
}
private String convert(CharSequence cs) {
if (cs instanceof Member)
return ((Member) cs).getDisplay(false);
return cs.toString();
}
public Elected getElected(String cs, Collection shortNames) {
for (String shortName : shortNames) {
final int score = getScore(cs, shortName);
if (score > 0)
return new Elected(shortName, score);
}
return null;
}
private int getScore(String cs, String shortName) {
if (cs.matches(".*\\b" + shortName + "\\b.*"))
return 100;
if (cs.contains(shortName))
return 50;
return 0;
}
private TextBlock createTextBlock(CharSequence cs) {
FontConfiguration config = FontConfiguration.create(skinParam, style, leaf.getColors());
if (cs instanceof Member) {
final Member m = (Member) cs;
final boolean withVisibilityChar = skinParam.classAttributeIconSize() == 0;
String s = m.getDisplay(withVisibilityChar);
if (withVisibilityChar && s.startsWith("#"))
s = CharHidder.addTileAtBegin(s);
if (m.isAbstract())
config = config.italic();
if (m.isStatic())
config = config.underline();
TextBlock bloc = Display.getWithNewlines(s).create8(config, align, skinParam, CreoleMode.SIMPLE_LINE,
style.wrapWidth());
bloc = TextBlockUtils.fullInnerPosition(bloc, m.getDisplay(false));
return new TextBlockTracer(m, bloc);
}
// if (cs instanceof EmbeddedDiagram)
// return ((EmbeddedDiagram) cs).asDraw(skinParam);
return Display.getWithNewlines(cs.toString()).create8(config, align, skinParam, CreoleMode.SIMPLE_LINE,
style.wrapWidth());
}
static class TextBlockTracer extends AbstractTextBlock implements TextBlock {
private final TextBlock bloc;
private final Url url;
public TextBlockTracer(Member m, TextBlock bloc) {
this.bloc = bloc;
this.url = m.getUrl();
}
public void drawU(UGraphic ug) {
if (url != null)
ug.startUrl(url);
bloc.drawU(ug);
if (url != null)
ug.closeUrl();
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
final XDimension2D dim = bloc.calculateDimension(stringBounder);
return dim;
}
@Override
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder, InnerStrategy strategy) {
return bloc.getInnerPosition(member, stringBounder, strategy);
}
}
private TextBlock getUBlock(final VisibilityModifier modifier, Url url) {
if (modifier == null) {
return new AbstractTextBlock() {
public void drawU(UGraphic ug) {
}
@Override
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder,
InnerStrategy strategy) {
return null;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return new XDimension2D(1, 1);
}
};
}
final Style style = modifier.getStyleSignature().getMergedStyle(skinParam.getCurrentStyleBuilder());
final HColor borderColor = style.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
final boolean isField = modifier.isField();
final HColor backColor = isField ? null
: style.value(PName.BackGroundColor).asColor(skinParam.getIHtmlColorSet());
final TextBlock uBlock = modifier.getUBlock(skinParam.classAttributeIconSize(), borderColor, backColor,
url != null);
return TextBlockWithUrl.withUrl(uBlock, url);
}
public boolean contains(String member) {
for (CharSequence cs : members) {
final Member att = (Member) cs;
if (att.getDisplay(false).startsWith(member))
return true;
}
return false;
}
@Override
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder, InnerStrategy strategy) {
final ULayoutGroup group = getLayout(stringBounder);
final XDimension2D dim = calculateDimension(stringBounder);
return group.getInnerPosition(member, dim.getWidth(), dim.getHeight(), stringBounder);
}
private ULayoutGroup getLayout(final StringBounder stringBounder) {
final ULayoutGroup group;
if (hasSmallIcon()) {
group = new ULayoutGroup(
new PlacementStrategyVisibility(stringBounder, skinParam.getCircledCharacterRadius() + 3));
for (CharSequence cs : members) {
final TextBlock bloc = createTextBlock(cs);
// if (cs instanceof EmbeddedDiagram) {
// group.add(getUBlock(null, null));
// } else {
final Member att = (Member) cs;
final VisibilityModifier modifier = att.getVisibilityModifier();
group.add(getUBlock(modifier, att.getUrl()));
// }
group.add(bloc);
}
} else {
final PlacementStrategy placementStrategy;
if (align == HorizontalAlignment.LEFT)
placementStrategy = new PlacementStrategyY1Y2Left(stringBounder);
else if (align == HorizontalAlignment.CENTER)
placementStrategy = new PlacementStrategyY1Y2Center(stringBounder);
else
placementStrategy = new PlacementStrategyY1Y2Right(stringBounder);
group = new ULayoutGroup(placementStrategy);
for (CharSequence cs : members) {
final TextBlock bloc = createTextBlock(cs);
group.add(bloc);
}
}
return group;
}
public void drawU(UGraphic ug) {
final StringBounder stringBounder = ug.getStringBounder();
final ULayoutGroup group = getLayout(stringBounder);
final XDimension2D dim = calculateDimensionOnlyMembers(stringBounder);
group.drawU(ug, dim.getWidth(), dim.getHeight());
ug = ug.apply(UTranslate.dy(dim.getHeight()));
for (EmbeddedDiagram embedded : embeddeds) {
embedded.drawU(ug);
ug = ug.apply(UTranslate.dy(embedded.calculateDimension(stringBounder).getHeight()));
}
}
}