net.sourceforge.plantuml.salt.PSystemSalt 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.salt;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.ScaleSimple;
import net.sourceforge.plantuml.TitledDiagram;
import net.sourceforge.plantuml.UmlDiagram;
import net.sourceforge.plantuml.WithSprite;
import net.sourceforge.plantuml.api.ImageDataSimple;
import net.sourceforge.plantuml.command.Command;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.command.CommandFactorySprite;
import net.sourceforge.plantuml.core.DiagramDescription;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
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.klimt.sprite.Sprite;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.salt.element.Element;
import net.sourceforge.plantuml.salt.factory.AbstractElementFactoryComplex;
import net.sourceforge.plantuml.salt.factory.ElementFactory;
import net.sourceforge.plantuml.salt.factory.ElementFactoryBorder;
import net.sourceforge.plantuml.salt.factory.ElementFactoryButton;
import net.sourceforge.plantuml.salt.factory.ElementFactoryCheckboxOff;
import net.sourceforge.plantuml.salt.factory.ElementFactoryCheckboxOn;
import net.sourceforge.plantuml.salt.factory.ElementFactoryDroplist;
import net.sourceforge.plantuml.salt.factory.ElementFactoryImage;
import net.sourceforge.plantuml.salt.factory.ElementFactoryLine;
import net.sourceforge.plantuml.salt.factory.ElementFactoryMenu;
import net.sourceforge.plantuml.salt.factory.ElementFactoryPyramid;
import net.sourceforge.plantuml.salt.factory.ElementFactoryRadioOff;
import net.sourceforge.plantuml.salt.factory.ElementFactoryRadioOn;
import net.sourceforge.plantuml.salt.factory.ElementFactoryRetrieveFromDictonnary;
import net.sourceforge.plantuml.salt.factory.ElementFactoryScroll;
import net.sourceforge.plantuml.salt.factory.ElementFactoryTab;
import net.sourceforge.plantuml.salt.factory.ElementFactoryText;
import net.sourceforge.plantuml.salt.factory.ElementFactoryTextField;
import net.sourceforge.plantuml.salt.factory.ElementFactoryTree;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.style.ClockwiseTopRightBottomLeft;
import net.sourceforge.plantuml.utils.BlocLines;
import net.sourceforge.plantuml.utils.Log;
public class PSystemSalt extends TitledDiagram implements WithSprite {
private final List data;
private final SaltDictionary dictionary = new SaltDictionary();
@Deprecated
public PSystemSalt(UmlSource source, List data) {
super(source, UmlDiagramType.SALT, null);
this.data = data;
}
public PSystemSalt(UmlSource source) {
this(source, new ArrayList());
}
public void add(String s) {
data.add(s);
}
@Override
final protected ImageData exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
try {
final Element salt = createElement(manageSprite());
final StringBounder stringBounder = fileFormatOption.getDefaultStringBounder(getSkinParam());
final XDimension2D size = salt.getPreferredDimension(stringBounder, 0, 0);
return createImageBuilder(fileFormatOption).drawable(getTextBlock(salt, size)).write(os);
} catch (Exception e) {
Logme.error(e);
UmlDiagram.exportDiagramError(os, e, fileFormatOption, seed(), getMetadata(), "none",
new ArrayList());
return ImageDataSimple.error();
}
}
@Override
protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption) {
final Element salt = createElement(manageSprite());
final StringBounder stringBounder = fileFormatOption.getDefaultStringBounder(getSkinParam());
final XDimension2D size = salt.getPreferredDimension(stringBounder, 0, 0);
return getTextBlock(salt, size);
}
private TextBlock getTextBlock(final Element salt, final XDimension2D size) {
return new AbstractTextBlock() {
public void drawU(UGraphic ug) {
ug = ug.apply(getBlack());
salt.drawU(ug, 0, new XDimension2D(size.getWidth(), size.getHeight()));
salt.drawU(ug, 1, new XDimension2D(size.getWidth(), size.getHeight()));
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return size;
}
public HColor getBackcolor() {
return getSkinParam().getBackgroundColor();
}
};
}
public DiagramDescription getDescription() {
return new DiagramDescription("(Salt)");
}
public void addSprite(String name, Sprite sprite) {
dictionary.addSprite(name, sprite);
}
private List manageSprite() {
final Command cmd = new CommandFactorySprite().createMultiLine(false);
final List result = new ArrayList<>();
for (Iterator it = data.iterator(); it.hasNext();) {
String s = it.next();
if (s.equals("hide stereotype")) {
// System.err.println("skipping " + s);
} else if (s.startsWith("skinparam ")) {
// System.err.println("skipping " + s);
} else if (s.startsWith("scale ")) {
final double scale = Double.parseDouble(s.substring("scale ".length()));
this.setScale(new ScaleSimple(scale));
// System.err.println("skipping " + s);
} else if (s.startsWith("sprite $")) {
BlocLines bloc = BlocLines.singleString(s);
do {
s = it.next();
bloc = bloc.addString(s);
} while (s.equals("}") == false);
try {
final CommandExecutionResult cmdResult = cmd.execute(this, bloc);
} catch (NoSuchColorException e) {
}
} else {
result.add(s);
}
}
return result;
}
private Element createElement(List data) {
final DataSourceImpl source = new DataSourceImpl(data);
final Collection cpx = new ArrayList<>();
// cpx.add(new ElementFactorySimpleFrame(source, dictionnary));
cpx.add(new ElementFactoryPyramid(source, dictionary));
cpx.add(new ElementFactoryScroll(source, dictionary));
cpx.add(new ElementFactoryBorder(source, dictionary));
for (AbstractElementFactoryComplex f : cpx) {
addSimpleFactory(f, source, dictionary);
}
for (AbstractElementFactoryComplex f1 : cpx) {
for (AbstractElementFactoryComplex f2 : cpx) {
f1.addFactory(f2);
}
}
for (ElementFactory f : cpx) {
if (f.ready()) {
Log.info("Using " + f);
return f.create().getElement();
}
}
Log.println("data=" + data);
throw new IllegalArgumentException();
}
private static void addSimpleFactory(final AbstractElementFactoryComplex cpxFactory, final DataSource source,
SaltDictionary dictionary) {
cpxFactory.addFactory(new ElementFactoryMenu(source, dictionary));
cpxFactory.addFactory(new ElementFactoryTree(source, dictionary));
cpxFactory.addFactory(new ElementFactoryTab(source, dictionary));
cpxFactory.addFactory(new ElementFactoryLine(source));
cpxFactory.addFactory(new ElementFactoryTextField(source, dictionary));
cpxFactory.addFactory(new ElementFactoryButton(source, dictionary));
cpxFactory.addFactory(new ElementFactoryDroplist(source, dictionary));
cpxFactory.addFactory(new ElementFactoryRadioOn(source, dictionary));
cpxFactory.addFactory(new ElementFactoryRadioOff(source, dictionary));
cpxFactory.addFactory(new ElementFactoryCheckboxOn(source, dictionary));
cpxFactory.addFactory(new ElementFactoryCheckboxOff(source, dictionary));
cpxFactory.addFactory(new ElementFactoryImage(source, dictionary));
cpxFactory.addFactory(new ElementFactoryRetrieveFromDictonnary(source, dictionary));
cpxFactory.addFactory(new ElementFactoryText(source, dictionary));
}
private boolean iamSalt;
public void setIamSalt(boolean iamSalt) {
this.iamSalt = true;
}
public final boolean isIamSalt() {
return iamSalt;
}
@Override
public ClockwiseTopRightBottomLeft getDefaultMargins() {
return ClockwiseTopRightBottomLeft.same(5);
}
private HColor getBlack() {
return HColors.BLACK;
}
}