net.sourceforge.plantuml.svek.ClusterDotString 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.Collections;
import java.util.EnumSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.abel.EntityPosition;
import net.sourceforge.plantuml.decoration.symbol.USymbols;
import net.sourceforge.plantuml.dot.GraphvizVersion;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.skin.AlignmentParam;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.style.ISkinParam;
public class ClusterDotString {
// ::remove file when __CORE__
private final Cluster cluster;
private final ISkinParam skinParam;
private static final String ID_EE = "ee";
public ClusterDotString(Cluster cluster, ISkinParam skinParam) {
this.cluster = cluster;
this.skinParam = skinParam;
}
private boolean isPacked() {
return cluster.getGroup().isPacked();
}
void printInternal(StringBuilder sb, Collection lines, StringBounder stringBounder, DotMode dotMode,
GraphvizVersion graphvizVersion, UmlDiagramType type) {
if (cluster.diagram.getPragma().useKermor()) {
new ClusterDotStringKermor(cluster, skinParam).printInternal(sb, lines, stringBounder, dotMode,
graphvizVersion, type);
return;
}
final boolean packed = isPacked();
if (packed) {
cluster.printCluster1(sb, lines, stringBounder);
final SvekNode added = cluster.printCluster2(sb, lines, stringBounder, dotMode, graphvizVersion, type);
return;
}
final boolean thereALinkFromOrToGroup2 = isThereALinkFromOrToGroup(lines);
boolean thereALinkFromOrToGroup1 = thereALinkFromOrToGroup2;
final boolean useProtectionWhenThereALinkFromOrToGroup = graphvizVersion
.useProtectionWhenThereALinkFromOrToGroup();
if (useProtectionWhenThereALinkFromOrToGroup == false)
thereALinkFromOrToGroup1 = false;
if (thereALinkFromOrToGroup1)
subgraphClusterNoLabel(sb, "a");
final Set entityPositionsExceptNormal = entityPositionsExceptNormal();
if (entityPositionsExceptNormal.size() > 0)
for (SvekLine line : lines)
if (line.isLinkFromOrTo(cluster.getGroup()))
line.setProjectionCluster(cluster);
boolean protection0 = protection0(type);
boolean protection1 = protection1(type);
if (entityPositionsExceptNormal.size() > 0 || useProtectionWhenThereALinkFromOrToGroup == false) {
protection0 = false;
protection1 = false;
}
if (protection0)
subgraphClusterNoLabel(sb, "p0");
sb.append("subgraph " + cluster.getClusterId() + " {");
sb.append("style=solid;");
sb.append("color=\"" + StringUtils.sharp000000(cluster.getColor()) + "\";");
final String label;
if (cluster.isLabel()) {
final StringBuilder sblabel = new StringBuilder("<");
SvekLine.appendTable(sblabel, cluster.getTitleAndAttributeWidth(), cluster.getTitleAndAttributeHeight() - 5,
cluster.getTitleColor());
sblabel.append(">");
label = sblabel.toString();
final HorizontalAlignment align = skinParam.getHorizontalAlignment(AlignmentParam.packageTitleAlignment,
null, false, null);
sb.append("labeljust=\"" + align.getGraphVizValue() + "\";");
} else {
label = "\"\"";
}
if (entityPositionsExceptNormal.size() > 0) {
printRanks(Cluster.RANK_SOURCE, withPosition(EntityPosition.getInputs()), sb, stringBounder);
printRanks(Cluster.RANK_SINK, withPosition(EntityPosition.getOutputs()), sb, stringBounder);
if (hasPort())
subgraphClusterNoLabel(sb, ID_EE);
else
subgraphClusterWithLabel(sb, ID_EE, label);
} else {
sb.append("label=" + label + ";");
SvekUtils.println(sb);
}
if (thereALinkFromOrToGroup2)
sb.append(Cluster.getSpecialPointId(cluster.getGroup()) + " [shape=point,width=.01,label=\"\"];");
if (thereALinkFromOrToGroup1)
subgraphClusterNoLabel(sb, "i");
if (protection1)
subgraphClusterNoLabel(sb, "p1");
if (skinParam.useSwimlanes(type)) {
sb.append("{rank = source; ");
sb.append(getSourceInPoint(type));
sb.append(" [shape=point,width=.01,label=\"\"];");
sb.append(cluster.getMinPoint(type) + "->" + getSourceInPoint(type) + " [weight=999];");
sb.append("}");
SvekUtils.println(sb);
sb.append("{rank = sink; ");
sb.append(getSinkInPoint(type));
sb.append(" [shape=point,width=.01,label=\"\"];");
sb.append("}");
sb.append(getSinkInPoint(type) + "->" + cluster.getMaxPoint(type) + " [weight=999];");
SvekUtils.println(sb);
}
SvekUtils.println(sb);
// -----------
cluster.printCluster1(sb, lines, stringBounder);
final SvekNode added = cluster.printCluster2(sb, lines, stringBounder, dotMode, graphvizVersion, type);
if (entityPositionsExceptNormal.size() > 0)
if (hasPort()) {
sb.append(empty() + " [shape=rect,width=.01,height=.01,label=");
sb.append(label);
sb.append("];");
} else if (added == null) {
sb.append(empty() + " [shape=point,width=.01,label=\"\"];");
}
SvekUtils.println(sb);
// -----------
sb.append("}");
if (protection1)
sb.append("}");
if (thereALinkFromOrToGroup1) {
sb.append("}");
sb.append("}");
}
if (entityPositionsExceptNormal.size() > 0)
sb.append("}");
if (protection0)
sb.append("}");
SvekUtils.println(sb);
}
private String getSourceInPoint(UmlDiagramType type) {
if (skinParam.useSwimlanes(type))
return "sourceIn" + cluster.getColor();
return null;
}
private String getSinkInPoint(UmlDiagramType type) {
if (skinParam.useSwimlanes(type))
return "sinkIn" + cluster.getColor();
return null;
}
private String empty() {
// return "empty" + color;
// We use the same node with one for thereALinkFromOrToGroup2 as an empty
// because we cannot put a new node in the nested inside of the cluster
// if thereALinkFromOrToGroup2 is enabled.
return Cluster.getSpecialPointId(cluster.getGroup());
}
private boolean hasPort() {
for (EntityPosition pos : entityPositionsExceptNormal())
if (pos.isPort())
return true;
return false;
}
private Set entityPositionsExceptNormal() {
final Set result = EnumSet.noneOf(EntityPosition.class);
for (SvekNode sh : cluster.getNodes())
if (sh.getEntityPosition() != EntityPosition.NORMAL)
result.add(sh.getEntityPosition());
return Collections.unmodifiableSet(result);
}
private void subgraphClusterNoLabel(StringBuilder sb, String id) {
subgraphClusterWithLabel(sb, id, "\"\"");
}
private void subgraphClusterWithLabel(StringBuilder sb, String id, String label) {
sb.append("subgraph " + cluster.getClusterId() + id + " {");
sb.append("label=" + label + ";");
}
private void printRanks(String rank, List entries, StringBuilder sb,
StringBounder stringBounder) {
if (entries.size() > 0) {
sb.append("{rank=" + rank + ";");
for (SvekNode sh1 : entries)
sb.append(sh1.getUid() + ";");
sb.append("}");
SvekUtils.println(sb);
for (SvekNode sh2 : entries)
sh2.appendShape(sb, stringBounder);
SvekUtils.println(sb);
if (hasPort()) {
boolean arrow = false;
String node = null;
for (SvekNode sh : entries) {
if (arrow)
sb.append("->");
arrow = true;
node = sh.getUid();
sb.append(node);
}
if (arrow)
sb.append(" [arrowhead=none]");
sb.append(';');
SvekUtils.println(sb);
sb.append(node + "->" + empty() + ";");
SvekUtils.println(sb);
}
}
}
private List withPosition(Set positions) {
final List result = new ArrayList<>();
for (final Iterator it = cluster.getNodes().iterator(); it.hasNext();) {
final SvekNode sh = it.next();
if (positions.contains(sh.getEntityPosition()))
result.add(sh);
}
return result;
}
private boolean protection0(UmlDiagramType type) {
if (skinParam.useSwimlanes(type))
return false;
return true;
}
private boolean protection1(UmlDiagramType type) {
if (cluster.getGroup().getUSymbol() == USymbols.NODE)
return true;
if (skinParam.useSwimlanes(type))
return false;
return true;
}
private boolean isThereALinkFromOrToGroup(Collection lines) {
for (SvekLine line : lines)
if (line.isLinkFromOrTo(cluster.getGroup()))
return true;
return false;
}
}