net.sourceforge.plantuml.svek.GraphvizImageBuilder Maven / Gradle / Ivy
// 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 Revised BSD License.
*
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the University of California, Berkeley nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* 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 BSD license.
*
* The generated images can then be used without any reference to the BSD 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.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.atmp.InnerStrategy;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.GroupType;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.decoration.symbol.USymbolHexagon;
import net.sourceforge.plantuml.dot.DotData;
import net.sourceforge.plantuml.dot.ExeState;
import net.sourceforge.plantuml.dot.GraphvizUtils;
import net.sourceforge.plantuml.dot.UnparsableGraphvizException;
import net.sourceforge.plantuml.klimt.color.HColor;
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.MagneticBorder;
import net.sourceforge.plantuml.klimt.geom.MagneticBorderNone;
import net.sourceforge.plantuml.klimt.geom.MinMax;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XRectangle2D;
import net.sourceforge.plantuml.klimt.shape.GraphicStrings;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.security.SecurityProfile;
import net.sourceforge.plantuml.security.SecurityUtils;
import net.sourceforge.plantuml.skin.Pragma;
import net.sourceforge.plantuml.skin.SkinParam;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.stereo.Stereotype;
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.style.StyleSignature;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.svek.image.EntityImageClass;
import net.sourceforge.plantuml.svek.image.EntityImageNote;
import net.sourceforge.plantuml.text.BackSlash;
import net.sourceforge.plantuml.utils.Log;
public final class GraphvizImageBuilder {
private final DotData dotData;
private final DotMode dotMode;
private final UmlSource source;
private final Pragma pragma;
private Map maxX;
private final SName styleName;
private final DotStringFactory dotStringFactory;
private final ClusterManager clusterManager;
public GraphvizImageBuilder(DotData dotData, UmlSource source, Pragma pragma, SName styleName, DotMode dotMode,
DotStringFactory dotStringFactory, ClusterManager clusterManager) {
this.dotData = dotData;
this.dotMode = dotMode;
this.styleName = styleName;
this.source = source;
this.pragma = pragma;
this.dotStringFactory = dotStringFactory;
this.clusterManager = clusterManager;
}
final public StyleSignature getDefaultStyleDefinitionArrow(Stereotype stereotype) {
StyleSignature result = StyleSignatureBasic.of(SName.root, SName.element, styleName, SName.arrow);
if (stereotype != null)
result = result.withTOBECHANGED(stereotype);
return result;
}
final public StyleSignature getStyleArrowCardinality(Stereotype stereotype) {
StyleSignature result = StyleSignatureBasic.of(SName.root, SName.element, styleName, SName.arrow,
SName.cardinality);
if (stereotype != null)
result = result.withTOBECHANGED(stereotype);
return result;
}
private boolean isOpalisable(Entity entity) {
if (dotData.getSkinParam().strictUmlStyle())
return false;
if (entity.isGroup())
return false;
if (entity.getLeafType() != LeafType.NOTE)
return false;
final Link single = onlyOneLink(entity);
if (single == null)
return false;
return single.getOther(entity).getLeafType() != LeafType.NOTE;
}
static class EntityImageSimpleEmpty implements IEntityImage {
private final HColor backColor;
EntityImageSimpleEmpty(HColor backColor) {
this.backColor = backColor;
}
public boolean isHidden() {
return false;
}
public HColor getBackcolor() {
return backColor;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return new XDimension2D(10, 10);
}
public MinMax getMinMax(StringBounder stringBounder) {
return MinMax.fromDim(calculateDimension(stringBounder));
}
public XRectangle2D getInnerPosition(String member, StringBounder stringBounder, InnerStrategy strategy) {
return null;
}
public void drawU(UGraphic ug) {
}
public ShapeType getShapeType() {
return ShapeType.RECTANGLE;
}
public Margins getShield(StringBounder stringBounder) {
return Margins.NONE;
}
public double getOverscanX(StringBounder stringBounder) {
return 0;
}
@Override
public MagneticBorder getMagneticBorder() {
return new MagneticBorderNone();
}
}
// Duplicate SvekResult / GeneralImageBuilder
private HColor getBackcolor() {
final Style style = StyleSignatureBasic.of(SName.root, SName.document)
.getMergedStyle(dotData.getSkinParam().getCurrentStyleBuilder());
return style.value(PName.BackGroundColor).asColor(dotData.getSkinParam().getIHtmlColorSet());
}
public IEntityImage buildImage(StringBounder stringBounder, BaseFile basefile, String dotStrings[],
boolean fileFormatOptionIsDebugSvek) {
// ::comment when __CORE__
if (dotData.isDegeneratedWithFewEntities(0))
return new EntityImageSimpleEmpty(dotData.getSkinParam().getBackgroundColor());
if (dotData.isDegeneratedWithFewEntities(1) && dotData.getUmlDiagramType() != UmlDiagramType.STATE) {
final Entity single = dotData.getLeafs().iterator().next();
final Entity group = single.getParentContainer();
if (group.isRoot() && single.getUSymbol() instanceof USymbolHexagon == false) {
final IEntityImage tmp = GeneralImageBuilder.createEntityImageBlock(single,
dotData.isHideEmptyDescriptionForState(), dotData.getPortionShower(), null, null,
dotData.getLinks());
return new EntityImageDegenerated(tmp, getBackcolor());
}
}
dotData.removeIrrelevantSametail();
printGroups(stringBounder, dotData.getRootGroup());
printEntities(stringBounder, getUnpackagedEntities());
for (Link link : dotData.getLinks()) {
if (link.isRemoved())
continue;
try {
final ISkinParam skinParam = dotData.getSkinParam();
final FontConfiguration labelFont = getDefaultStyleDefinitionArrow(link.getStereotype())
.getMergedStyle(link.getStyleBuilder()).getFontConfiguration(skinParam.getIHtmlColorSet());
final FontConfiguration cardinalityFont = getStyleArrowCardinality(link.getStereotype())
.getMergedStyle(link.getStyleBuilder()).getFontConfiguration(skinParam.getIHtmlColorSet());
final SvekEdge line = new SvekEdge(link, skinParam, stringBounder, labelFont, cardinalityFont,
dotStringFactory.getBibliotekon(), pragma, dotStringFactory.getGraphvizVersion());
dotStringFactory.getBibliotekon().addLine(line);
if (isOpalisable(link.getEntity1())) {
final SvekNode node = dotStringFactory.getBibliotekon().getNode(link.getEntity1());
final SvekNode other = dotStringFactory.getBibliotekon().getNode(link.getEntity2());
if (other != null) {
((EntityImageNote) node.getImage()).setOpaleLine(line, node, other);
line.setOpale(true);
}
} else if (isOpalisable(link.getEntity2())) {
final SvekNode node = dotStringFactory.getBibliotekon().getNode(link.getEntity2());
final SvekNode other = dotStringFactory.getBibliotekon().getNode(link.getEntity1());
if (other != null) {
((EntityImageNote) node.getImage()).setOpaleLine(line, node, other);
line.setOpale(true);
}
}
} catch (IllegalStateException e) {
Logme.error(e);
}
}
if (dotStringFactory.illegalDotExe())
return error(dotStringFactory.getDotExe());
if (basefile == null && (fileFormatOptionIsDebugSvek || isSvekTrace())
&& (SecurityUtils.getSecurityProfile() == SecurityProfile.UNSECURE
|| SecurityUtils.getSecurityProfile() == SecurityProfile.LEGACY
|| SecurityUtils.getSecurityProfile() == SecurityProfile.SANDBOX))
basefile = new BaseFile(null);
final String svg;
try {
svg = dotStringFactory.getSvg(stringBounder, dotMode, basefile, dotStrings);
} catch (IOException e) {
return new GraphvizCrash(source.getPlainString(BackSlash.lineSeparator()),
GraphvizUtils.graphviz244onWindows(), e);
}
if (svg.length() == 0)
return new GraphvizCrash(source.getPlainString(BackSlash.lineSeparator()),
GraphvizUtils.graphviz244onWindows(), new EmptySvgException());
final String graphvizVersion = extractGraphvizVersion(svg);
try {
dotStringFactory.solve(svg);
final SvekResult result = new SvekResult(dotData, dotStringFactory);
this.maxX = dotStringFactory.getBibliotekon().getMaxX();
return result;
} catch (Exception e) {
Log.error("Exception " + e);
throw new UnparsableGraphvizException(e, graphvizVersion, svg,
source.getPlainString(BackSlash.lineSeparator()));
}
// ::uncomment when __CORE__
// return null;
}
private boolean isSvekTrace() {
final String value = pragma.getValue("svek_trace");
return "true".equalsIgnoreCase(value) || "on".equalsIgnoreCase(value);
}
private String extractGraphvizVersion(String svg) {
final Pattern pGraph = Pattern.compile("(?mi)!-- generated by graphviz(.*)");
final Matcher mGraph = pGraph.matcher(svg);
if (mGraph.find())
return StringUtils.trin(mGraph.group(1));
return null;
}
private Link onlyOneLink(Entity ent) {
Link single = null;
for (Link link : dotData.getLinks()) {
if (link.isInvis())
continue;
if (link.contains(ent) == false)
continue;
if (single != null)
return null;
single = link;
}
return single;
}
// ::comment when __CORE__
private IEntityImage error(File dotExe) {
final List msg = new ArrayList<>();
msg.add("Dot Executable: " + dotExe);
final ExeState exeState = ExeState.checkFile(dotExe);
msg.add(exeState.getTextMessage());
msg.add("Cannot find Graphviz. You should try");
msg.add(" ");
msg.add("@startuml");
msg.add("testdot");
msg.add("@enduml");
msg.add(" ");
msg.add(" or ");
msg.add(" ");
msg.add("java -jar plantuml.jar -testdot");
msg.add(" ");
return GraphicStrings.createForError(msg, false);
}
private void printEntities(StringBounder stringBounder, Collection entities2) {
for (Entity ent : entities2) {
if (ent.isRemoved())
continue;
printEntity(stringBounder, ent);
}
}
private void printEntity(StringBounder stringBounder, Entity ent) {
if (ent.isRemoved())
throw new IllegalStateException(ent.toString());
final IEntityImage image = printEntityInternal(stringBounder, ent);
final SvekNode node = dotStringFactory.getBibliotekon().createNode(ent, image, stringBounder);
clusterManager.addNode(node);
}
private IEntityImage printEntityInternal(StringBounder stringBounder, Entity ent) {
if (ent.isRemoved())
throw new IllegalStateException();
if (ent.getSvekImage() == null) {
ISkinParam skinParam = dotData.getSkinParam();
if (skinParam.sameClassWidth()) {
final double width = getMaxWidth(stringBounder);
((SkinParam) skinParam).setParamSameClassWidth(width);
}
return GeneralImageBuilder.createEntityImageBlock(ent, dotData.isHideEmptyDescriptionForState(),
dotData.getPortionShower(), dotStringFactory.getBibliotekon(),
dotStringFactory.getGraphvizVersion(), dotData.getLinks());
}
return ent.getSvekImage();
}
private double getMaxWidth(StringBounder stringBounder) {
double result = 0;
for (Entity ent : dotData.getLeafs()) {
if (ent.getLeafType().isLikeClass() == false)
continue;
final IEntityImage im = new EntityImageClass(ent, dotData.getPortionShower());
final double w = im.calculateDimension(stringBounder).getWidth();
if (w > result)
result = w;
}
return result;
}
private Collection getUnpackagedEntities() {
final List result = new ArrayList<>();
for (Entity ent : dotData.getLeafs())
if (dotData.getTopParent() == ent.getParentContainer())
result.add(ent);
return result;
}
private void printGroups(StringBounder stringBounder, Entity parent) {
// System.err.println("PARENT=" + parent);
final Collection groups = dotData.getGroupHierarchy().getChildrenGroups(parent);
// System.err.println("groups=" + groups);
for (Entity g : groups) {
if (g.isRemoved())
continue;
if (dotData.isEmpty(g) && g.getGroupType() == GroupType.PACKAGE) {
g.muteToType(LeafType.EMPTY_PACKAGE);
printEntity(stringBounder, g);
} else {
printGroup(stringBounder, g);
}
}
}
private void printGroup(StringBounder stringBounder, Entity g) {
if (g.getGroupType() == GroupType.CONCURRENT_STATE)
return;
final ClusterHeader clusterHeader = new ClusterHeader(g, dotData.getPortionShower(), stringBounder);
clusterManager.openCluster(g, clusterHeader);
this.printEntities(stringBounder, g.leafs());
printGroups(stringBounder, g);
clusterManager.closeCluster();
}
public String getWarningOrError(int warningOrError) {
if (maxX == null)
return "";
final StringBuilder sb = new StringBuilder();
for (Map.Entry ent : maxX.entrySet())
if (ent.getValue() > warningOrError) {
sb.append(ent.getKey() + " is overpassing the width limit.");
sb.append("\n");
}
return sb.length() == 0 ? "" : sb.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy