net.sourceforge.plantuml.bpm.BpmDiagram 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 .
*
* 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 LGPL license.
*
* The generated images can then be used without any reference to the LGPL 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.bpm;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Deque;
import java.util.List;
import net.atmp.ImageBuilder;
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.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.UDrawable;
import net.sourceforge.plantuml.skin.SkinParam;
import net.sourceforge.plantuml.skin.UmlDiagramType;
public class BpmDiagram extends UmlDiagram {
// ::remove folder when __CORE__
private void cleanGrid(Grid grid) {
while (true) {
final boolean v1 = new CleanerEmptyLine().clean(grid);
final boolean v2 = new CleanerInterleavingLines().clean(grid);
final boolean v3 = new CleanerMoveBlock().clean(grid);
if (v1 == false && v2 == false && v3 == false) {
return;
}
}
}
private final BpmElement start = new BpmElement(null, BpmElementType.START);
private List events = new ArrayList<>();
private Deque branches = new ArrayDeque<>();
public DiagramDescription getDescription() {
return new DiagramDescription("(Bpm Diagram)");
}
public BpmDiagram(UmlSource source) {
super(source, UmlDiagramType.BPM, null);
}
@Override
public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption) throws IOException {
return super.createImageBuilder(fileFormatOption).annotations(false);
}
@Override
protected ImageData exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
return createImageBuilder(fileFormatOption).drawable(getUDrawable()).write(os);
}
private UDrawable getUDrawable() {
final Grid grid = createGrid();
cleanGrid(grid);
final GridArray gridArray = grid.toArray(SkinParam.create(getUmlDiagramType()));
// gridArray.addEdges(edges);
// System.err.println("gridArray=" + gridArray);
return gridArray;
}
public CommandExecutionResult addEvent(BpmEvent event) {
this.events.add(event);
return CommandExecutionResult.ok();
}
private Coord current;
private Cell last;
private Grid createGrid() {
final Grid grid = new Grid();
this.current = grid.getRoot();
// this.edges.clear();
last = grid.getCell(current);
grid.getCell(current).setData(start);
for (BpmEvent event : events) {
if (event instanceof BpmEventAdd) {
final BpmEventAdd tmp = (BpmEventAdd) event;
addInGrid(grid, tmp.getElement());
} else if (event instanceof BpmEventResume) {
final String idDestination = ((BpmEventResume) event).getId();
current = grid.getById(idDestination);
last = grid.getCell(current);
if (last == null) {
throw new IllegalStateException();
}
final Navigator nav = grid.linesOf(current);
final Line newLine = new Line();
nav.insertAfter(newLine);
final Col row = current.getCol();
current = new Coord(newLine, row);
} else if (event instanceof BpmEventGoto) {
final BpmEventGoto tmp = (BpmEventGoto) event;
final String idDestination = tmp.getId();
current = grid.getById(idDestination);
final Cell src = last;
last = grid.getCell(current);
if (last == null) {
throw new IllegalStateException();
}
final Navigator nav = grid.linesOf(current);
final Line newLine = new Line();
nav.insertAfter(newLine);
final Col row = current.getCol();
current = new Coord(newLine, row);
src.addConnectionTo2(last.getData());
} else {
throw new IllegalStateException();
}
}
grid.addConnections();
// for (GridEdge edge : edges) {
// System.err.println("EDGE=" + edge.getEdgeDirection());
// edge.addLineIn(grid);
// }
// grid.addEdge(edges);
return grid;
}
private void addInGrid(Grid grid, BpmElement element) {
final Navigator nav = grid.colsOf(current);
final Col newRow = new Col();
nav.insertAfter(newRow);
current = new Coord(current.getLine(), newRow);
grid.getCell(current).setData(element);
last.addConnectionTo2(grid.getCell(current).getData());
last = grid.getCell(current);
}
public CommandExecutionResult newBranch() {
final BpmBranch branch = new BpmBranch(events.size());
branches.addLast(branch);
return addEvent(new BpmEventAdd(branch.getEntryElement()));
}
public CommandExecutionResult elseBranch() {
final BpmBranch branch = branches.getLast();
final int counter = branch.incAndGetCounter();
if (counter == 2) {
addEvent(new BpmEventAdd(branch.getElseElement()));
return addEvent(branch.getResumeEntryEvent());
}
addEvent(branch.getGoToEndEvent());
return addEvent(branch.getResumeEntryEvent());
}
public CommandExecutionResult endBranch() {
final BpmBranch branch = branches.removeLast();
return addEvent(branch.getGoToEndEvent());
}
@Override
protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption) {
throw new UnsupportedOperationException();
}
}