net.sourceforge.plantuml.svek.DotStringFactory 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 static java.nio.charset.StandardCharsets.UTF_8;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.dot.DotSplines;
import net.sourceforge.plantuml.dot.Graphviz;
import net.sourceforge.plantuml.dot.GraphvizUtils;
import net.sourceforge.plantuml.dot.GraphvizVersion;
import net.sourceforge.plantuml.dot.GraphvizVersions;
import net.sourceforge.plantuml.dot.ProcessState;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.Moveable;
import net.sourceforge.plantuml.klimt.geom.Rankdir;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.utils.Position;
import net.sourceforge.plantuml.vizjs.GraphvizJs;
import net.sourceforge.plantuml.vizjs.GraphvizJsRuntimeException;
public final class DotStringFactory implements Moveable {
private final UmlDiagramType umlDiagramType;
private final ISkinParam skinParam;
private final Bibliotekon bibliotekon;
private final Cluster root;
public DotStringFactory(Bibliotekon bibliotekon, Cluster root, UmlDiagramType umlDiagramType,
ISkinParam skinParam) {
this.bibliotekon = bibliotekon;
this.skinParam = skinParam;
this.umlDiagramType = umlDiagramType;
this.root = root;
}
private double getHorizontalDzeta(StringBounder stringBounder) {
double max = 0;
for (SvekEdge l : getBibliotekon().allLines()) {
final double c = l.getHorizontalDzeta(stringBounder);
if (c > max)
max = c;
}
return max / 10;
}
public Bibliotekon getBibliotekon() {
return bibliotekon;
}
private double getVerticalDzeta(StringBounder stringBounder) {
double max = 0;
for (SvekEdge l : getBibliotekon().allLines()) {
final double c = l.getVerticalDzeta(stringBounder);
if (c > max)
max = c;
}
if (root.diagram.getPragma().useKermor())
return max / 100;
return max / 10;
}
// ::comment when __CORE__
private String createDotString(StringBounder stringBounder, DotMode dotMode, String... dotStrings) {
final StringBuilder sb = new StringBuilder();
double nodesep = getHorizontalDzeta(stringBounder);
if (nodesep < getMinNodeSep())
nodesep = getMinNodeSep();
if (skinParam.getNodesep() != 0)
nodesep = skinParam.getNodesep();
final String nodesepInches = SvekUtils.pixelToInches(nodesep);
// Log.println("nodesep=" + nodesepInches);
double ranksep = getVerticalDzeta(stringBounder);
if (ranksep < getMinRankSep())
ranksep = getMinRankSep();
if (skinParam.getRanksep() != 0)
ranksep = skinParam.getRanksep();
final String ranksepInches = SvekUtils.pixelToInches(ranksep);
// Log.println("ranksep=" + ranksepInches);
sb.append("digraph unix {");
SvekUtils.println(sb);
for (String s : dotStrings) {
if (s.startsWith("ranksep"))
sb.append("ranksep=" + ranksepInches + ";");
else if (s.startsWith("nodesep"))
sb.append("nodesep=" + nodesepInches + ";");
else
sb.append(s);
SvekUtils.println(sb);
}
// sb.append("newrank=true;");
// SvekUtils.println(sb);
sb.append("remincross=true;");
SvekUtils.println(sb);
sb.append("searchsize=500;");
SvekUtils.println(sb);
// if (OptionFlags.USE_COMPOUND) {
// sb.append("compound=true;");
// SvekUtils.println(sb);
// }
final DotSplines dotSplines = skinParam.getDotSplines();
if (dotSplines == DotSplines.POLYLINE) {
sb.append("splines=polyline;");
SvekUtils.println(sb);
} else if (dotSplines == DotSplines.ORTHO) {
sb.append("splines=ortho;");
sb.append("forcelabels=true;");
SvekUtils.println(sb);
}
if (skinParam.getRankdir() == Rankdir.LEFT_TO_RIGHT) {
sb.append("rankdir=LR;");
SvekUtils.println(sb);
}
manageMinMaxCluster(sb);
if (root.diagram.getPragma().useKermor()) {
for (SvekEdge line : getBibliotekon().lines0())
line.appendLine(getGraphvizVersion(), sb, dotMode, dotSplines);
for (SvekEdge line : getBibliotekon().lines1())
line.appendLine(getGraphvizVersion(), sb, dotMode, dotSplines);
root.printCluster3_forKermor(sb, getBibliotekon().allLines(), stringBounder, dotMode, getGraphvizVersion(),
umlDiagramType);
} else {
root.printCluster1(sb, getBibliotekon().allLines(), stringBounder);
for (SvekEdge line : getBibliotekon().lines0())
line.appendLine(getGraphvizVersion(), sb, dotMode, dotSplines);
root.printCluster2(sb, getBibliotekon().allLines(), stringBounder, dotMode, getGraphvizVersion(),
umlDiagramType);
for (SvekEdge line : getBibliotekon().lines1())
line.appendLine(getGraphvizVersion(), sb, dotMode, dotSplines);
}
SvekUtils.println(sb);
sb.append("}");
return sb.toString();
}
private void manageMinMaxCluster(final StringBuilder sb) {
final List minPointCluster = new ArrayList<>();
final List maxPointCluster = new ArrayList<>();
for (Cluster cluster : getBibliotekon().allCluster()) {
final String minPoint = cluster.getMinPoint(umlDiagramType);
if (minPoint != null)
minPointCluster.add(minPoint);
final String maxPoint = cluster.getMaxPoint(umlDiagramType);
if (maxPoint != null)
maxPointCluster.add(maxPoint);
}
if (minPointCluster.size() > 0) {
sb.append("{rank=min;");
for (String s : minPointCluster) {
sb.append(s);
sb.append(" [shape=point,width=.01,label=\"\"]");
sb.append(";");
}
sb.append("}");
SvekUtils.println(sb);
}
if (maxPointCluster.size() > 0) {
sb.append("{rank=max;");
for (String s : maxPointCluster) {
sb.append(s);
sb.append(" [shape=point,width=.01,label=\"\"]");
sb.append(";");
}
sb.append("}");
SvekUtils.println(sb);
}
}
private int getMinRankSep() {
if (umlDiagramType == UmlDiagramType.ACTIVITY) {
// return 29;
return 40;
}
if (root.diagram.getPragma().useKermor())
return 40;
return 60;
}
private int getMinNodeSep() {
if (umlDiagramType == UmlDiagramType.ACTIVITY) {
// return 15;
return 20;
}
return 35;
}
// ::uncomment when __CORE__
// public GraphvizVersion getGraphvizVersion() {
// return null;
// }
// ::comment when __CORE__
private GraphvizVersion graphvizVersion;
public GraphvizVersion getGraphvizVersion() {
if (graphvizVersion == null)
graphvizVersion = getGraphvizVersionInternal();
return graphvizVersion;
}
private GraphvizVersion getGraphvizVersionInternal() {
final Graphviz graphviz = GraphvizUtils.create(skinParam, "foo;", "svg");
if (graphviz instanceof GraphvizJs)
return GraphvizJs.getGraphvizVersion(false);
final File f = graphviz.getDotExe();
return GraphvizVersions.getInstance().getVersion(f);
}
public String getSvg(StringBounder stringBounder, DotMode dotMode, BaseFile basefile, String[] dotOptions)
throws IOException {
String dotString = createDotString(stringBounder, dotMode, dotOptions);
if (basefile != null) {
final SFile f = basefile.getTraceFile("svek.dot");
SvekUtils.traceString(f, dotString);
}
Graphviz graphviz = GraphvizUtils.create(skinParam, dotString, "svg");
ByteArrayOutputStream baos = new ByteArrayOutputStream();
try {
final ProcessState state = graphviz.createFile3(baos);
baos.close();
if (state.differs(ProcessState.TERMINATED_OK()))
throw new IllegalStateException("Timeout4 " + state, state.getCause());
} catch (GraphvizJsRuntimeException e) {
System.err.println("GraphvizJsRuntimeException");
graphvizVersion = GraphvizJs.getGraphvizVersion(true);
dotString = createDotString(stringBounder, dotMode, dotOptions);
graphviz = GraphvizUtils.create(skinParam, dotString, "svg");
baos = new ByteArrayOutputStream();
final ProcessState state = graphviz.createFile3(baos);
baos.close();
if (state.differs(ProcessState.TERMINATED_OK()))
throw new IllegalStateException("Timeout4 " + state, state.getCause());
}
final byte[] result = baos.toByteArray();
final String s = new String(result, UTF_8);
if (basefile != null) {
final SFile f = basefile.getTraceFile("svek.svg");
SvekUtils.traceString(f, s);
}
return s;
}
public boolean illegalDotExe() {
final Graphviz graphviz = GraphvizUtils.create(skinParam, "svg");
if (graphviz instanceof GraphvizJs)
return false;
final File dotExe = graphviz.getDotExe();
return dotExe == null || dotExe.isFile() == false || dotExe.canRead() == false;
}
public File getDotExe() {
final Graphviz graphviz = GraphvizUtils.create(skinParam, "svg");
return graphviz.getDotExe();
}
public void solve(final String svg) throws IOException, InterruptedException {
if (svg.length() == 0)
throw new EmptySvgException();
final Pattern pGraph = Pattern.compile("(?m)\\" + node.getUid() + "");
if (node.getType() == ShapeType.RECTANGLE || node.getType() == ShapeType.RECTANGLE_HTML_FOR_PORTS
|| node.getType() == ShapeType.RECTANGLE_WITH_CIRCLE_INSIDE || node.getType() == ShapeType.FOLDER
|| node.getType() == ShapeType.DIAMOND || node.getType() == ShapeType.RECTANGLE_PORT) {
final List points = svgResult.substring(idx).extractList(SvgResult.POINTS_EQUALS);
final XPoint2D min = SvekUtils.getMinXY(points);
node.moveDelta(min.getX(), min.getY());
} else if (node.getType() == ShapeType.ROUND_RECTANGLE) {
final int idx2 = svg.indexOf("d=\"", idx + 1);
idx = svg.indexOf("points=\"", idx + 1);
final List points;
if (idx2 != -1 && (idx == -1 || idx2 < idx)) {
// GraphViz 2.30
points = svgResult.substring(idx2).extractList(SvgResult.D_EQUALS);
} else {
points = svgResult.substring(idx).extractList(SvgResult.POINTS_EQUALS);
for (int i = 0; i < 3; i++) {
idx = svg.indexOf("points=\"", idx + 1);
points.addAll(svgResult.substring(idx).extractList(SvgResult.POINTS_EQUALS));
}
}
final XPoint2D min = SvekUtils.getMinXY(points);
node.moveDelta(min.getX(), min.getY());
} else if (node.getType() == ShapeType.OCTAGON || node.getType() == ShapeType.HEXAGON) {
idx = svg.indexOf("points=\"", idx + 1);
final int starting = idx;
final List points = svgResult.substring(starting).extractList(SvgResult.POINTS_EQUALS);
final XPoint2D min = SvekUtils.getMinXY(points);
// corner1.manage(minX, minY);
node.moveDelta(min.getX(), min.getY());
node.setPolygon(min.getX(), min.getY(), points);
} else if (node.getType() == ShapeType.CIRCLE || node.getType() == ShapeType.OVAL) {
final double cx = SvekUtils.getValue(svg, idx, "cx");
final double cy = SvekUtils.getValue(svg, idx, "cy") + fullHeight;
final double rx = SvekUtils.getValue(svg, idx, "rx");
final double ry = SvekUtils.getValue(svg, idx, "ry");
node.moveDelta(cx - rx, cy - ry);
} else {
throw new IllegalStateException(node.getType().toString() + " " + node.getUid());
}
}
for (Cluster cluster : getBibliotekon().allCluster()) {
if (cluster.getGroup().isPacked())
continue;
int idx = getClusterIndex(svg, cluster.getColor());
final int starting = idx;
final List points = svgResult.substring(starting).extractList(SvgResult.POINTS_EQUALS);
final XPoint2D min = SvekUtils.getMinXY(points);
final XPoint2D max = SvekUtils.getMaxXY(points);
cluster.setPosition(min, max);
if (cluster.getTitleAndAttributeWidth() == 0 || cluster.getTitleAndAttributeHeight() == 0)
continue;
idx = getClusterIndex(svg, cluster.getTitleColor());
final List pointsTitle = svgResult.substring(idx).extractList(SvgResult.POINTS_EQUALS);
cluster.setTitlePosition(SvekUtils.getMinXY(pointsTitle));
if (root.diagram.getPragma().useKermor()) {
if (cluster.getGroup().getNotes(Position.TOP).size() > 0) {
final List noteUp = svgResult.substring(getClusterIndex(svg, cluster.getColorNoteTop()))
.extractList(SvgResult.POINTS_EQUALS);
cluster.setNoteTopPosition(SvekUtils.getMinXY(noteUp));
}
if (cluster.getGroup().getNotes(Position.BOTTOM).size() > 0) {
final List noteBottom = svgResult
.substring(getClusterIndex(svg, cluster.getColorNoteBottom()))
.extractList(SvgResult.POINTS_EQUALS);
cluster.setNoteBottomPosition(SvekUtils.getMinXY(noteBottom));
}
}
}
for (SvekEdge line : getBibliotekon().allLines())
line.solveLine(svgResult);
for (SvekEdge line : getBibliotekon().allLines())
line.manageCollision(getBibliotekon().allNodes());
}
private int getClusterIndex(final String svg, int colorInt) {
final String colorString = StringUtils.goLowerCase(StringUtils.sharp000000(colorInt));
final String keyTitle1 = "=\"" + colorString + "\"";
int idx = svg.indexOf(keyTitle1);
if (idx == -1) {
final String keyTitle2 = "stroke:" + colorString + ";";
idx = svg.indexOf(keyTitle2);
}
if (idx == -1)
throw new IllegalStateException("Cannot find color " + colorString);
return idx;
}
public void moveDelta(double deltaX, double deltaY) {
for (SvekNode sh : getBibliotekon().allNodes())
sh.moveDelta(deltaX, deltaY);
for (SvekEdge line : getBibliotekon().allLines())
line.moveDelta(deltaX, deltaY);
for (Cluster cl : getBibliotekon().allCluster())
cl.moveDelta(deltaX, deltaY);
}
}