net.sourceforge.plantuml.EmbeddedDiagram 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;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import net.atmp.PixelImage;
import net.sourceforge.plantuml.core.Diagram;
import net.sourceforge.plantuml.klimt.AffineTransformType;
import net.sourceforge.plantuml.klimt.UShape;
import net.sourceforge.plantuml.klimt.creole.Neutron;
import net.sourceforge.plantuml.klimt.creole.atom.Atom;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.AbstractTextBlock;
import net.sourceforge.plantuml.klimt.shape.Line;
import net.sourceforge.plantuml.klimt.shape.UImage;
import net.sourceforge.plantuml.klimt.shape.UImageSvg;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.preproc.Defines;
import net.sourceforge.plantuml.security.SImageIO;
import net.sourceforge.plantuml.style.ISkinSimple;
import net.sourceforge.plantuml.text.StringLocated;
public class EmbeddedDiagram extends AbstractTextBlock implements Line, Atom {
// ::remove file when __HAXE__
public static final String EMBEDDED_START = "{{";
public static final String EMBEDDED_END = "}}";
public static String getEmbeddedType(CharSequence cs) {
if (cs == null)
return null;
final String s = StringUtils.trin(cs.toString());
if (s.startsWith(EMBEDDED_START) == false)
return null;
if (s.equals(EMBEDDED_START))
return "uml";
if (s.equals(EMBEDDED_START + "ditaa"))
return "ditaa";
if (s.equals(EMBEDDED_START + "uml"))
return "uml";
if (s.equals(EMBEDDED_START + "wbs"))
return "wbs";
if (s.equals(EMBEDDED_START + "mindmap"))
return "mindmap";
if (s.equals(EMBEDDED_START + "gantt"))
return "gantt";
if (s.equals(EMBEDDED_START + "json"))
return "json";
if (s.equals(EMBEDDED_START + "yaml"))
return "yaml";
if (s.equals(EMBEDDED_START + "wire"))
return "wire";
if (s.equals(EMBEDDED_START + "creole"))
return "creole";
if (s.equals(EMBEDDED_START + "board"))
return "board";
if (s.equals(EMBEDDED_START + "ebnf"))
return "ebnf";
if (s.equals(EMBEDDED_START + "regex"))
return "regex";
if (s.equals(EMBEDDED_START + "files"))
return "files";
return null;
}
public static EmbeddedDiagram createAndSkip(String type, Iterator it, ISkinSimple skinParam) {
final List result = new ArrayList();
result.add("@start" + type);
int nested = 1;
while (it.hasNext()) {
final CharSequence s2 = it.next();
if (EmbeddedDiagram.getEmbeddedType(StringUtils.trinNoTrace(s2)) != null)
// if (StringUtils.trinNoTrace(s2).startsWith(EmbeddedDiagram.EMBEDDED_START))
nested++;
else if (StringUtils.trinNoTrace(s2).equals(EmbeddedDiagram.EMBEDDED_END)) {
nested--;
if (nested == 0)
break;
}
result.add(s2.toString());
}
result.add("@end" + type);
return EmbeddedDiagram.from(skinParam, result);
}
private final List list;
private final ISkinSimple skinParam;
private BufferedImage image;
private EmbeddedDiagram(ISkinSimple skinParam, List system) {
this.list = system;
this.skinParam = skinParam;
}
public static EmbeddedDiagram from(ISkinSimple skinParam, List strings) {
return new EmbeddedDiagram(skinParam, BlockUml.convert(strings));
}
public double getStartingAltitude(StringBounder stringBounder) {
return 0;
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
try {
if (stringBounder.matchesProperty("SVG")) {
final String imageSvg = getImageSvg();
final UImageSvg svg = new UImageSvg(imageSvg, 1);
return new XDimension2D(svg.getWidth(), svg.getHeight());
}
final BufferedImage im = getImage();
return new XDimension2D(im.getWidth(), im.getHeight());
} catch (IOException e) {
Logme.error(e);
} catch (InterruptedException e) {
Logme.error(e);
}
return new XDimension2D(42, 42);
}
public void drawU(UGraphic ug) {
try {
final boolean isSvg = ug.matchesProperty("SVG");
if (isSvg) {
final String imageSvg = getImageSvg();
final UImageSvg svg = new UImageSvg(imageSvg, 1);
ug.draw(svg);
return;
}
final BufferedImage im = getImage();
final UShape image = new UImage(new PixelImage(im, AffineTransformType.TYPE_BILINEAR));
ug.draw(image);
} catch (IOException e) {
Logme.error(e);
} catch (InterruptedException e) {
Logme.error(e);
}
}
private String getImageSvg() throws IOException, InterruptedException {
final Diagram system = getSystem();
final ByteArrayOutputStream os = new ByteArrayOutputStream();
system.exportDiagram(os, 0, new FileFormatOption(FileFormat.SVG));
os.close();
return new String(os.toByteArray());
}
private BufferedImage getImage() throws IOException, InterruptedException {
if (image == null)
image = getImageSlow();
return image;
}
private BufferedImage getImageSlow() throws IOException, InterruptedException {
final Diagram system = getSystem();
final ByteArrayOutputStream os = new ByteArrayOutputStream();
system.exportDiagram(os, 0, new FileFormatOption(FileFormat.PNG));
os.close();
return SImageIO.read(os.toByteArray());
}
public HorizontalAlignment getHorizontalAlignment() {
return HorizontalAlignment.LEFT;
}
private Diagram getSystem() throws IOException, InterruptedException {
final BlockUml blockUml = new BlockUml(list, Defines.createEmpty(), skinParam, null, null);
return blockUml.getDiagram();
}
@Override
public List getNeutrons() {
return Arrays.asList(Neutron.create(this));
}
}