net.sourceforge.plantuml.svek.GroupMakerState 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.svek;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.EntityUtils;
import net.sourceforge.plantuml.abel.GroupType;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.cucadiagram.GroupHierarchy;
import net.sourceforge.plantuml.cucadiagram.ICucaDiagram;
import net.sourceforge.plantuml.dot.DotData;
import net.sourceforge.plantuml.klimt.UStroke;
import net.sourceforge.plantuml.klimt.color.ColorType;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
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.shape.TextBlock;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.svek.image.EntityImageState;
import net.sourceforge.plantuml.svek.image.EntityImageStateCommon;
public final class GroupMakerState {
private final ICucaDiagram diagram;
private final Entity group;
private final StringBounder stringBounder;
class InnerGroupHierarchy implements GroupHierarchy {
public Entity getRootGroup() {
throw new UnsupportedOperationException();
}
public Collection getChildrenGroups(Entity parent) {
if (parent.isRoot())
return filter(diagram.getChildrenGroups(group));
return filter(diagram.getChildrenGroups(parent));
}
private Collection filter(Collection groups) {
final List result = new ArrayList<>();
for (Entity g : groups)
if (g.getGroupType() != GroupType.CONCURRENT_STATE)
result.add(g);
return result;
}
public boolean isEmpty(Entity g) {
return diagram.isEmpty(g);
}
}
public GroupMakerState(ICucaDiagram diagram, Entity group, StringBounder stringBounder) {
this.diagram = diagram;
this.stringBounder = stringBounder;
this.group = group;
if (group.isGroup() == false)
throw new IllegalArgumentException();
}
private List getPureInnerLinks() {
final List result = new ArrayList<>();
for (Link link : diagram.getLinks())
if (EntityUtils.isPureInnerLink12(group, link))
result.add(link);
return result;
}
public IEntityImage getImage() {
final Display display = group.getDisplay();
final ISkinParam skinParam = diagram.getSkinParam();
final Style style = EntityImageStateCommon.getStyleState(group, skinParam);
final Style styleTitle = EntityImageStateCommon.getStyleStateTitle(group, skinParam);
final Style styleBody = EntityImageStateCommon.getStyleStateBody(group, skinParam);
final double rounded = style.value(PName.RoundCorner).asDouble();
final double shadowing = style.value(PName.Shadowing).asDouble();
final FontConfiguration titleFontConfiguration = styleTitle.getFontConfiguration(skinParam.getIHtmlColorSet());
final TextBlock title = display.create(titleFontConfiguration, HorizontalAlignment.CENTER,
diagram.getSkinParam());
if (group.countChildren() == 0 && group.groups().size() == 0)
return new EntityImageState(group, diagram.getSkinParam());
if (group.getGroupType() == GroupType.CONCURRENT_STATE)
return createGeneralImageBuilder(group.leafs(), skinParam).buildImage(null, new String[0], false);
if (group.getGroupType() != GroupType.STATE)
throw new UnsupportedOperationException(group.getGroupType().toString());
HColor borderColor = group.getColors().getColor(ColorType.LINE);
if (borderColor == null)
borderColor = style.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
HColor backColor = group.getColors().getColor(ColorType.BACK);
if (backColor == null)
backColor = style.value(PName.BackGroundColor).asColor(skinParam.getIHtmlColorSet());
UStroke stroke = group.getColors().getSpecificLineStroke();
if (stroke == null)
stroke = style.getStroke();
final IEntityImage image;
if (containsSomeConcurrentStates()) {
final List inners = new ArrayList<>();
inners.add(
createGeneralImageBuilder(filter(group.leafs()), skinParam).buildImage(null, new String[0], false));
for (Entity inner : group.leafs())
if (inner.getLeafType() == LeafType.STATE_CONCURRENT)
inners.add(inner.getSvekImage());
image = new ConcurrentStates(inners, group.getConcurrentSeparator(), skinParam, group.getStereotype());
} else {
image = createGeneralImageBuilder(filter(group.leafs()), skinParam).buildImage(null, new String[0], false);
}
final HColor bodyColor = styleBody.value(PName.BackGroundColor).asColor(skinParam.getIHtmlColorSet());
final boolean withSymbol = group.getStereotype() != null && group.getStereotype().isWithOOSymbol();
return new InnerStateAutonom(image, title, group.getStateHeader(skinParam), borderColor, backColor,
group.getUrl99(), withSymbol, stroke, rounded, shadowing, bodyColor);
}
protected GeneralImageBuilder createGeneralImageBuilder(Collection leafs, ISkinParam skinParam) {
final DotData dotData = new DotData(group, getPureInnerLinks(), leafs, diagram.getUmlDiagramType(), skinParam,
new InnerGroupHierarchy(), diagram.getEntityFactory(), diagram.isHideEmptyDescriptionForState(),
DotMode.NORMAL, diagram.getNamespaceSeparator(), diagram.getPragma());
return new GeneralImageBuilder(dotData, diagram.getEntityFactory(), diagram.getSource(), diagram.getPragma(),
stringBounder, SName.stateDiagram);
}
private Collection filter(Collection leafs) {
final List result = new ArrayList<>();
for (Entity leaf : leafs)
if (leaf.getLeafType() != LeafType.STATE_CONCURRENT)
result.add(leaf);
return result;
}
private boolean containsSomeConcurrentStates() {
for (Entity entity : group.leafs())
if (entity.getLeafType() == LeafType.STATE_CONCURRENT)
return true;
return false;
}
}