net.sourceforge.plantuml.elk.CucaDiagramFileMakerElk Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-lgpl Show documentation
Show all versions of plantuml-lgpl 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 GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see nodes = new LinkedHashMap();
private final Map clusters = new LinkedHashMap();
private final Map edges = new LinkedHashMap();
public CucaDiagramFileMakerElk(CucaDiagram diagram) {
super(diagram);
}
// Duplication from SvekEdge
final public StyleSignature getDefaultStyleDefinitionArrow(Stereotype stereotype, SName styleName) {
StyleSignature result = StyleSignatureBasic.of(SName.root, SName.element, styleName, SName.arrow);
if (stereotype != null)
result = result.withTOBECHANGED(stereotype);
return result;
}
private FontConfiguration getFontForLink(Link link, final ISkinParam skinParam) {
final SName styleName = skinParam.getUmlDiagramType().getStyleName();
final Style style = getDefaultStyleDefinitionArrow(link.getStereotype(), styleName)
.getMergedStyle(link.getStyleBuilder());
return style.getFontConfiguration(skinParam.getIHtmlColorSet());
}
private HorizontalAlignment getMessageTextAlignment(UmlDiagramType umlDiagramType, ISkinParam skinParam) {
if (umlDiagramType == UmlDiagramType.STATE)
return skinParam.getHorizontalAlignment(AlignmentParam.stateMessageAlignment, null, false, null);
return skinParam.getDefaultTextAlignment(HorizontalAlignment.CENTER);
}
private TextBlock addVisibilityModifier(TextBlock block, Link link, ISkinParam skinParam) {
final VisibilityModifier visibilityModifier = link.getVisibilityModifier();
if (visibilityModifier != null) {
final Rose rose = new Rose();
final HColor fore = rose.getHtmlColor(skinParam, visibilityModifier.getForeground());
TextBlock visibility = visibilityModifier.getUBlock(skinParam.classAttributeIconSize(), fore, null, false);
visibility = TextBlockUtils.withMargin(visibility, 0, 1, 2, 0);
block = TextBlockUtils.mergeLR(visibility, block, VerticalAlignment.CENTER);
}
final double marginLabel = 1; // startUid.equalsId(endUid) ? 6 : 1;
return TextBlockUtils.withMargin(block, marginLabel, marginLabel);
}
private LinkArrow getLinkArrow(Link link) {
return link.getLinkArrow();
}
private TextBlock getLabel(StringBounder stringBounder, Link link) {
ISkinParam skinParam = diagram.getSkinParam();
final double marginLabel = 1; // startUid.equals(endUid) ? 6 : 1;
// final FontConfiguration labelFont =
// style.getFontConfiguration(skinParam.getIHtmlColorSet());
// TextBlock labelOnly = link.getLabel().create(labelFont,
// skinParam.getDefaultTextAlignment(HorizontalAlignment.CENTER), skinParam);
final UmlDiagramType type = skinParam.getUmlDiagramType();
final FontConfiguration font = getFontForLink(link, skinParam);
TextBlock labelOnly;
// toto2
if (Display.isNull(link.getLabel())) {
labelOnly = TextBlockUtils.EMPTY_TEXT_BLOCK;
if (getLinkArrow(link) != LinkArrow.NONE_OR_SEVERAL) {
// labelOnly = StringWithArrow.addMagicArrow(labelOnly, this, font);
}
} else {
final HorizontalAlignment alignment = getMessageTextAlignment(type, skinParam);
final boolean hasSeveralGuideLines = link.getLabel().hasSeveralGuideLines();
final TextBlock block;
// if (hasSeveralGuideLines)
// block = StringWithArrow.addSeveralMagicArrows(link.getLabel(), this, font,
// alignment, skinParam);
// else
block = link.getLabel().create0(font, alignment, skinParam, skinParam.maxMessageSize(),
CreoleMode.SIMPLE_LINE, null, null);
labelOnly = addVisibilityModifier(block, link, skinParam);
if (getLinkArrow(link) != LinkArrow.NONE_OR_SEVERAL && hasSeveralGuideLines == false) {
// labelOnly = StringWithArrow.addMagicArrow(labelOnly, this, font);
}
}
final CucaNote note = link.getNote();
if (note == null) {
if (TextBlockUtils.isEmpty(labelOnly, stringBounder) == false)
labelOnly = TextBlockUtils.withMargin(labelOnly, marginLabel, marginLabel);
return labelOnly;
}
final TextBlock noteOnly = new EntityImageNoteLink(note.getDisplay(), note.getColors(), skinParam,
link.getStyleBuilder());
if (note.getPosition() == Position.LEFT)
return TextBlockUtils.mergeLR(noteOnly, labelOnly, VerticalAlignment.CENTER);
else if (note.getPosition() == Position.RIGHT)
return TextBlockUtils.mergeLR(labelOnly, noteOnly, VerticalAlignment.CENTER);
else if (note.getPosition() == Position.TOP)
return TextBlockUtils.mergeTB(noteOnly, labelOnly, HorizontalAlignment.CENTER);
else
return TextBlockUtils.mergeTB(labelOnly, noteOnly, HorizontalAlignment.CENTER);
}
private TextBlock getQuantifier(StringBounder stringBounder, Link link, int n) {
final String tmp = n == 1 ? link.getQuantifier1() : link.getQuantifier2();
if (tmp == null)
return null;
final ISkinParam skinParam = diagram.getSkinParam();
final FontConfiguration labelFont = FontConfiguration.create(skinParam, FontParam.ARROW, null);
final TextBlock label = Display.getWithNewlines(tmp).create(labelFont,
skinParam.getDefaultTextAlignment(HorizontalAlignment.CENTER), skinParam);
if (TextBlockUtils.isEmpty(label, stringBounder))
return null;
return label;
}
// Retrieve the real position of a node, depending on its parents
public static XPoint2D getPosition(ElkNode elkNode) {
final ElkNode parent = elkNode.getParent();
final double x = elkNode.getX();
final double y = elkNode.getY();
// This nasty test checks that parent is "root"
if (parent == null || parent.getLabels().size() == 0) {
return new XPoint2D(x, y);
}
// Right now, this is recursive
final XPoint2D parentPosition = getPosition(parent);
return new XPoint2D(parentPosition.getX() + x, parentPosition.getY() + y);
}
private Collection getUnpackagedEntities() {
final List result = new ArrayList<>();
for (Entity ent : diagram.leafs())
if (diagram.getRootGroup() == ent.getParentContainer())
result.add(ent);
return result;
}
private ElkNode getElkNode(final Entity entity) {
ElkNode node = nodes.get(entity);
if (node == null)
node = clusters.get(entity);
return node;
}
@Override
public ImageData createFile(OutputStream os, List dotStrings, FileFormatOption fileFormatOption)
throws IOException {
// https://www.eclipse.org/forums/index.php/t/1095737/
try {
final ElkNode root = ElkGraphUtil.createGraph();
root.setProperty(CoreOptions.DIRECTION, Direction.DOWN);
root.setProperty(CoreOptions.HIERARCHY_HANDLING, HierarchyHandling.INCLUDE_CHILDREN);
final StringBounder stringBounder = fileFormatOption.getDefaultStringBounder(diagram.getSkinParam());
this.printAllSubgroups(stringBounder, root, diagram.getRootGroup());
this.printEntities(stringBounder, root, getUnpackagedEntities());
this.manageAllEdges(stringBounder);
new RecursiveGraphLayoutEngine().layout(root, new NullElkProgressMonitor());
final MinMax minMax = TextBlockUtils.getMinMax(
new MyElkDrawing(clusterManager, diagram, null, clusters, edges, nodes), stringBounder, false);
final TextBlock drawable = new MyElkDrawing(clusterManager, diagram, minMax, clusters, edges, nodes);
return diagram.createImageBuilder(fileFormatOption) //
.drawable(drawable) //
.write(os); //
} catch (Throwable e) {
UmlDiagram.exportDiagramError(os, e, fileFormatOption, diagram.seed(), diagram.getMetadata(),
diagram.getFlashData(), getFailureText3(e));
return ImageDataSimple.error(e);
}
}
private void printAllSubgroups(StringBounder stringBounder, ElkNode cluster, Entity group) {
for (Entity g : diagram.getChildrenGroups(group)) {
if (g.isRemoved())
continue;
if (diagram.isEmpty(g) && g.getGroupType() == GroupType.PACKAGE) {
g.muteToType(LeafType.EMPTY_PACKAGE);
this.prinEntity(stringBounder, g, cluster);
} else {
// We create the "cluster" in ELK for this group
final ElkNode elkCluster = ElkGraphUtil.createNode(cluster);
elkCluster.setProperty(CoreOptions.DIRECTION, Direction.DOWN);
final ClusterHeader clusterHeader = new ClusterHeader(g, diagram.getSkinParam(), diagram,
stringBounder);
final int titleAndAttributeHeight = clusterHeader.getTitleAndAttributeHeight();
final double topPadding = Math.max(25, titleAndAttributeHeight) + 15;
elkCluster.setProperty(CoreOptions.PADDING, new ElkPadding(topPadding, 15, 15, 15));
// Not sure this is usefull to put a label on a "cluster"
final ElkLabel label = ElkGraphUtil.createLabel(elkCluster);
label.setText("C");
// We need it anyway to recurse up to the real "root"
this.clusters.put(g, elkCluster);
this.printSingleGroup(stringBounder, g);
}
}
}
private void printSingleGroup(StringBounder stringBounder, Entity g) {
if (g.getGroupType() == GroupType.CONCURRENT_STATE)
return;
this.printEntities(stringBounder, clusters.get(g), g.leafs());
this.printAllSubgroups(stringBounder, clusters.get(g), g);
}
private void printEntities(StringBounder stringBounder, ElkNode parent, Collection entities) {
// Convert all "leaf" to ELK node
for (Entity ent : entities) {
if (ent.isRemoved())
continue;
this.prinEntity(stringBounder, ent, parent);
}
}
private void manageAllEdges(StringBounder stringBounder) {
// Convert all "link" to ELK edge
for (final Link link : diagram.getLinks())
this.manageSingleEdge(stringBounder, link);
}
@DuplicateCode(reference = "CucaDiagramFileMakerSmetana::printEntity")
private void prinEntity(StringBounder stringBounder, Entity ent, ElkNode parent) {
final IEntityImage image = printEntityInternal(ent);
// Expected dimension of the node
final XDimension2D dimension = image.calculateDimension(stringBounder);
final SvekNode node = getBibliotekon().createNode(ent, image, stringBounder);
clusterManager.addNode(node);
// Here, we try to tell ELK to use this dimension as node dimension
final ElkNode elkNode = ElkGraphUtil.createNode(parent);
elkNode.setDimensions(dimension.getWidth(), dimension.getHeight());
// There is no real "label" here
// We just would like to force node dimension
final ElkLabel label = ElkGraphUtil.createLabel(elkNode);
label.setText("X");
// I don't know why we have to do this hack, but somebody has to fix it
final double VERY_STRANGE_OFFSET = 10;
label.setDimensions(dimension.getWidth(), dimension.getHeight() - VERY_STRANGE_OFFSET);
// No idea of what we are doing here :-)
label.setProperty(CoreOptions.NODE_LABELS_PLACEMENT,
EnumSet.of(NodeLabelPlacement.INSIDE, NodeLabelPlacement.H_CENTER, NodeLabelPlacement.V_CENTER));
// This padding setting have no impact ?
// label.setProperty(CoreOptions.NODE_LABELS_PADDING, new ElkPadding(100.0));
// final EnumSet constraints =
// EnumSet.of(SizeConstraint.NODE_LABELS);
// node.setProperty(CoreOptions.NODE_SIZE_CONSTRAINTS, constraints);
// node.setProperty(CoreOptions.NODE_SIZE_OPTIONS,
// EnumSet.noneOf(SizeOptions.class));
// Let's store this
nodes.put(ent, elkNode);
}
private void manageSingleEdge(StringBounder stringBounder, final Link link) {
final ElkNode node1 = getElkNode(link.getEntity1());
final ElkNode node2 = getElkNode(link.getEntity2());
final ElkEdge edge = ElkGraphUtil.createSimpleEdge(node1, node2);
final TextBlock labelLink = getLabel(stringBounder, link);
if (labelLink != null) {
final ElkLabel edgeLabel = ElkGraphUtil.createLabel(edge);
final XDimension2D dim = labelLink.calculateDimension(stringBounder);
edgeLabel.setText("X");
edgeLabel.setDimensions(dim.getWidth(), dim.getHeight());
// Duplicated, with qualifier, but who cares?
edge.setProperty(CoreOptions.EDGE_LABELS_INLINE, true);
// edge.setProperty(CoreOptions.EDGE_TYPE, EdgeType.ASSOCIATION);
}
if (link.getQuantifier1() != null) {
final ElkLabel edgeLabel = ElkGraphUtil.createLabel(edge);
final XDimension2D dim = getQuantifier(stringBounder, link, 1).calculateDimension(stringBounder);
// Nasty trick, we store the kind of label in the text
edgeLabel.setText("1");
edgeLabel.setDimensions(dim.getWidth(), dim.getHeight());
edgeLabel.setProperty(CoreOptions.EDGE_LABELS_PLACEMENT, EdgeLabelPlacement.TAIL);
// Duplicated, with main label, but who cares?
edge.setProperty(CoreOptions.EDGE_LABELS_INLINE, true);
// edge.setProperty(CoreOptions.EDGE_TYPE, EdgeType.ASSOCIATION);
}
if (link.getQuantifier2() != null) {
final ElkLabel edgeLabel = ElkGraphUtil.createLabel(edge);
final XDimension2D dim = getQuantifier(stringBounder, link, 2).calculateDimension(stringBounder);
// Nasty trick, we store the kind of label in the text
edgeLabel.setText("2");
edgeLabel.setDimensions(dim.getWidth(), dim.getHeight());
edgeLabel.setProperty(CoreOptions.EDGE_LABELS_PLACEMENT, EdgeLabelPlacement.HEAD);
// Duplicated, with main label, but who cares?
edge.setProperty(CoreOptions.EDGE_LABELS_INLINE, true);
// edge.setProperty(CoreOptions.EDGE_TYPE, EdgeType.ASSOCIATION);
}
edges.put(link, edge);
}
static private List getFailureText3(Throwable exception) {
Logme.error(exception);
final List strings = new ArrayList<>();
strings.add("An error has occured : " + exception);
final String quote = StringUtils.rot(QuoteUtils.getSomeQuote());
strings.add("" + quote);
strings.add(" ");
GraphvizCrash.addProperties(strings);
strings.add(" ");
strings.add("Sorry, ELK intregration is really alpha feature...");
strings.add(" ");
strings.add("You should send this diagram and this image to [email protected] or");
strings.add("post to https://plantuml.com/qa to solve this issue.");
strings.add(" ");
return strings;
}
private IEntityImage printEntityInternal(Entity ent) {
if (ent.isRemoved())
throw new IllegalStateException();
if (ent.getSvekImage() == null) {
final ISkinParam skinParam = diagram.getSkinParam();
if (skinParam.sameClassWidth())
System.err.println("NOT YET IMPLEMENED");
return GeneralImageBuilder.createEntityImageBlock(ent, skinParam, diagram.isHideEmptyDescriptionForState(),
diagram, getBibliotekon(), null, diagram.getUmlDiagramType(), diagram.getLinks());
}
return ent.getSvekImage();
}
@Override
public void createOneGraphic(UGraphic ug) {
throw new UnsupportedOperationException();
}
}