net.sourceforge.plantuml.wire.WireDiagram 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.wire;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.UmlDiagram;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.core.DiagramDescription;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.AbstractTextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.skin.UmlDiagramType;
public class WireDiagram extends UmlDiagram {
private final WBlock root = new WBlock("", UTranslate.none(), 0, 0, null);
private final List spots = new ArrayList<>();
private final List hlinks = new ArrayList<>();
private final List vlinks = new ArrayList<>();
public DiagramDescription getDescription() {
return new DiagramDescription("Wire Diagram");
}
public WireDiagram(UmlSource source) {
super(source, UmlDiagramType.WIRE, null);
}
@Override
protected ImageData exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
return createImageBuilder(fileFormatOption).drawable(getTextMainBlock(fileFormatOption)).write(os);
}
@Override
protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption) {
return new AbstractTextBlock() {
public void drawU(UGraphic ug) {
drawMe(ug);
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
// return getDrawingElement().calculateDimension(stringBounder);
throw new UnsupportedOperationException();
}
};
}
private void drawMe(UGraphic ug) {
root.drawMe(ug);
for (Spot spot : spots)
spot.drawMe(ug);
for (WLinkHorizontal link : hlinks)
link.drawMe(ug);
for (WLinkVertical link : vlinks)
link.drawMe(ug);
}
public CommandExecutionResult addComponent(String indent, String name, int width, int height, HColor color) {
final int level = computeIndentationLevel(indent);
return this.root.addBlock(level, name, width, height, color);
}
public CommandExecutionResult newColumn(String indent) {
final int level = computeIndentationLevel(indent);
return this.root.newColumn(level);
}
public CommandExecutionResult spot(String name, HColor color, String x, String y) {
final WBlock block = this.root.getBlock(name);
if (block == null)
return CommandExecutionResult.error("No such element " + name);
final Spot spot = new Spot(block, color, x, y);
this.spots.add(spot);
return CommandExecutionResult.ok();
}
public CommandExecutionResult wgoto(String indent, double x, double y) {
final int level = computeIndentationLevel(indent);
return this.root.wgoto(level, x, y);
}
public CommandExecutionResult wmove(String indent, double x, double y) {
final int level = computeIndentationLevel(indent);
return this.root.wmove(level, x, y);
}
public CommandExecutionResult print(String indent, String text) {
final int level = computeIndentationLevel(indent);
final StringBounder stringBounder = FileFormat.PNG.getDefaultStringBounder();
return this.root.print(stringBounder, getSkinParam(), level, text);
}
private int computeIndentationLevel(String indent) {
final int level = indent.replace(" ", "\t").length();
return level;
}
public CommandExecutionResult vlink(String name1, String x1, String y1, String name2, WLinkType type,
WArrowDirection direction, HColor color, Display label) {
final WBlock block1 = this.root.getBlock(name1);
if (block1 == null)
return CommandExecutionResult.error("No such element " + name1);
final WBlock block2 = this.root.getBlock(name2);
if (block2 == null)
return CommandExecutionResult.error("No such element " + name2);
final UTranslate start = block1.getNextOutVertical(x1, y1, type);
final double destination = block2.getAbsolutePosition("0", "0").getDy();
this.vlinks.add(new WLinkVertical(getSkinParam(), start, destination, type, direction, color, label));
return CommandExecutionResult.ok();
}
public CommandExecutionResult hlink(String name1, String x1, String y1, String name2, WLinkType type,
WArrowDirection direction, HColor color, Display label) {
final WBlock block1 = this.root.getBlock(name1);
if (block1 == null)
return CommandExecutionResult.error("No such element " + name1);
final WBlock block2 = this.root.getBlock(name2);
if (block2 == null)
return CommandExecutionResult.error("No such element " + name2);
final UTranslate start = block1.getNextOutHorizontal(x1, y1, type);
final double destination = block2.getAbsolutePosition("0", "0").getDx();
this.hlinks.add(new WLinkHorizontal(getSkinParam(), start, destination, type, direction, color, label));
return CommandExecutionResult.ok();
}
}