net.sourceforge.plantuml.wbs.WBSDiagram Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 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 General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* 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 GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 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.wbs;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
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.ColorType;
import net.sourceforge.plantuml.klimt.color.Colors;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.AbstractCommonUGraphic;
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.mindmap.IdeaShape;
import net.sourceforge.plantuml.regex.Matcher2;
import net.sourceforge.plantuml.regex.MyPattern;
import net.sourceforge.plantuml.regex.Pattern2;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.NoStyleAvailableException;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.utils.Direction;
public class WBSDiagram extends UmlDiagram {
private WElement root;
private WElement last;
private String first;
private final Map codes = new LinkedHashMap<>();
private final List links = new ArrayList<>();
public DiagramDescription getDescription() {
return new DiagramDescription("Work Breakdown Structure");
}
public WBSDiagram(UmlSource source) {
super(source, UmlDiagramType.WBS, 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);
}
};
}
private void drawMe(UGraphic ug) {
UTranslate translate = null;
if (ug instanceof AbstractCommonUGraphic)
translate = ((AbstractCommonUGraphic) ug).getTranslate();
final Fork fork = getDrawingElement();
fork.drawU(ug);
if (translate == null)
return;
ug = ug.apply(translate.reverse());
for (WBSLink link : links)
link.drawU(ug);
}
private Fork getDrawingElement() {
return new Fork(getSkinParam(), root);
}
public final static Pattern2 patternStereotype = MyPattern
.cmpile("^\\s*(.*?)\\s*(\\<\\<\\s*(.*)\\s*\\>\\>)\\s*$");
public CommandExecutionResult addIdea(String code, HColor backColor, int level, String label, Direction direction,
IdeaShape shape) {
final Matcher2 m = patternStereotype.matcher(label);
String stereotype = null;
if (m.matches()) {
label = m.group(1);
stereotype = m.group(2);
}
final Display display = Display.getWithNewlines(label);
return addIdea(code, backColor, level, display, Stereotype.build(stereotype), direction, shape);
}
public CommandExecutionResult addIdea(String code, HColor backColor, int level, Display display, Stereotype stereotype,
Direction direction, IdeaShape shape) {
try {
if (level == 0) {
if (root != null)
return CommandExecutionResult.error("Error 44");
initRoot(backColor, display, stereotype, shape);
return CommandExecutionResult.ok();
}
return add(code, backColor, level, display, stereotype, direction, shape);
} catch (NoStyleAvailableException e) {
// Logme.error(e);
return CommandExecutionResult.error("General failure: no style available.");
}
}
private void initRoot(HColor backColor, Display display, Stereotype stereotype, IdeaShape shape) {
root = new WElement(backColor, display, stereotype, getSkinParam().getCurrentStyleBuilder(), shape);
last = root;
}
private WElement getParentOfLast(int nb) {
WElement result = last;
for (int i = 0; i < nb; i++)
result = result.getParent();
return result;
}
public int getSmartLevel(String type) {
if (root == null) {
assert first == null;
first = type;
return 0;
}
type = type.replace('\t', ' ');
if (type.contains(" ") == false)
return type.length() - 1;
if (type.endsWith(first))
return type.length() - first.length();
if (type.trim().length() == 1)
return type.length() - 1;
if (type.startsWith(first))
return type.length() - first.length();
throw new UnsupportedOperationException("type=<" + type + ">[" + first + "]");
}
private CommandExecutionResult add(String code, HColor backColor, int level, Display display, Stereotype stereotype,
Direction direction, IdeaShape shape) {
try {
if (level == last.getLevel() + 1) {
final WElement newIdea = last.createElement(backColor, level, display, stereotype, direction, shape,
getSkinParam().getCurrentStyleBuilder());
last = newIdea;
if (code != null)
codes.put(code, newIdea);
return CommandExecutionResult.ok();
}
if (level <= last.getLevel()) {
final int diff = last.getLevel() - level + 1;
final WElement newIdea = getParentOfLast(diff).createElement(backColor, level, display, stereotype,
direction, shape, getSkinParam().getCurrentStyleBuilder());
last = newIdea;
if (code != null)
codes.put(code, newIdea);
return CommandExecutionResult.ok();
}
return CommandExecutionResult.error("Bad tree structure");
} catch (NoStyleAvailableException e) {
// Logme.error(e);
return CommandExecutionResult.error("General failure: no style available.");
}
}
public CommandExecutionResult link(String code1, String code2, Colors colors, Stereotype stereotype) {
final WElement element1 = codes.get(code1);
if (element1 == null)
return CommandExecutionResult.error("No such node " + code1);
final WElement element2 = codes.get(code2);
if (element2 == null)
return CommandExecutionResult.error("No such node " + code2);
HColor color = colors.getColor(ColorType.LINE);
if (color == null) {
final Style style = StyleSignatureBasic.of(SName.root, SName.element, SName.wbsDiagram, SName.arrow)
.withTOBECHANGED(stereotype).getMergedStyle(getCurrentStyleBuilder());
color = style.value(PName.LineColor).asColor(getSkinParam().getIHtmlColorSet());
}
links.add(new WBSLink(element1, element2, color));
return CommandExecutionResult.ok();
}
}