mirror of https://github.com/octoleo/plantuml.git
460 lines
15 KiB
Java
460 lines
15 KiB
Java
/* ========================================================================
|
|
* PlantUML : a free UML diagram generator
|
|
* ========================================================================
|
|
*
|
|
* (C) Copyright 2009-2020, Arnaud Roques
|
|
*
|
|
* Project Info: http://plantuml.com
|
|
*
|
|
* If you like this project or if you find it useful, you can support us at:
|
|
*
|
|
* http://plantuml.com/patreon (only 1$ per month!)
|
|
* http://plantuml.com/paypal
|
|
*
|
|
* This file is part of PlantUML.
|
|
*
|
|
* PlantUML is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU 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 General Public
|
|
* License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
|
|
* USA.
|
|
*
|
|
*
|
|
* Original Author: Arnaud Roques
|
|
*
|
|
*
|
|
*/
|
|
package net.sourceforge.plantuml;
|
|
|
|
import java.awt.Color;
|
|
import java.awt.geom.AffineTransform;
|
|
import java.awt.geom.Dimension2D;
|
|
import java.awt.image.BufferedImage;
|
|
import java.io.BufferedOutputStream;
|
|
import java.io.ByteArrayInputStream;
|
|
import java.io.ByteArrayOutputStream;
|
|
import java.io.File;
|
|
import java.io.FileNotFoundException;
|
|
import java.io.FileOutputStream;
|
|
import java.io.IOException;
|
|
import java.io.InputStream;
|
|
import java.io.OutputStream;
|
|
import java.io.PrintWriter;
|
|
import java.util.List;
|
|
|
|
import javax.imageio.ImageIO;
|
|
import javax.script.ScriptException;
|
|
|
|
import net.sourceforge.plantuml.anim.Animation;
|
|
import net.sourceforge.plantuml.anim.AnimationDecoder;
|
|
import net.sourceforge.plantuml.api.ImageDataSimple;
|
|
import net.sourceforge.plantuml.command.BlocLines;
|
|
import net.sourceforge.plantuml.command.CommandControl;
|
|
import net.sourceforge.plantuml.command.CommandExecutionResult;
|
|
import net.sourceforge.plantuml.command.CommandSkinParam;
|
|
import net.sourceforge.plantuml.command.CommandSkinParamMultilines;
|
|
import net.sourceforge.plantuml.core.Diagram;
|
|
import net.sourceforge.plantuml.core.ImageData;
|
|
import net.sourceforge.plantuml.core.UmlSource;
|
|
import net.sourceforge.plantuml.cucadiagram.DisplaySection;
|
|
import net.sourceforge.plantuml.cucadiagram.UnparsableGraphvizException;
|
|
import net.sourceforge.plantuml.flashcode.FlashCodeFactory;
|
|
import net.sourceforge.plantuml.flashcode.FlashCodeUtils;
|
|
import net.sourceforge.plantuml.fun.IconLoader;
|
|
import net.sourceforge.plantuml.graphic.GraphicPosition;
|
|
import net.sourceforge.plantuml.graphic.GraphicStrings;
|
|
import net.sourceforge.plantuml.graphic.HtmlColor;
|
|
import net.sourceforge.plantuml.graphic.HtmlColorUtils;
|
|
import net.sourceforge.plantuml.graphic.UDrawable;
|
|
import net.sourceforge.plantuml.mjpeg.MJPEGGenerator;
|
|
import net.sourceforge.plantuml.pdf.PdfConverter;
|
|
import net.sourceforge.plantuml.sprite.Sprite;
|
|
import net.sourceforge.plantuml.svek.EmptySvgException;
|
|
import net.sourceforge.plantuml.svek.GraphvizCrash;
|
|
import net.sourceforge.plantuml.svek.TextBlockBackcolored;
|
|
import net.sourceforge.plantuml.ugraphic.ColorMapperIdentity;
|
|
import net.sourceforge.plantuml.ugraphic.ImageBuilder;
|
|
import net.sourceforge.plantuml.ugraphic.UGraphic;
|
|
import net.sourceforge.plantuml.ugraphic.UImage;
|
|
import net.sourceforge.plantuml.ugraphic.UTranslate;
|
|
import net.sourceforge.plantuml.version.Version;
|
|
|
|
public abstract class UmlDiagram extends TitledDiagram implements Diagram, Annotated, WithSprite {
|
|
|
|
private boolean rotation;
|
|
private boolean hideUnlinkedData;
|
|
|
|
private int minwidth = Integer.MAX_VALUE;
|
|
|
|
private final Pragma pragma = new Pragma();
|
|
private Animation animation;
|
|
|
|
private final SkinParam skinParam;
|
|
|
|
public UmlDiagram() {
|
|
this.skinParam = SkinParam.create(getUmlDiagramType());
|
|
}
|
|
|
|
public UmlDiagram(ISkinSimple orig) {
|
|
this();
|
|
if (orig != null) {
|
|
this.skinParam.copyAllFrom(orig);
|
|
}
|
|
}
|
|
|
|
final public int getMinwidth() {
|
|
return minwidth;
|
|
}
|
|
|
|
final public void setMinwidth(int minwidth) {
|
|
this.minwidth = minwidth;
|
|
}
|
|
|
|
final public boolean isRotation() {
|
|
return rotation;
|
|
}
|
|
|
|
final public void setRotation(boolean rotation) {
|
|
this.rotation = rotation;
|
|
}
|
|
|
|
public final ISkinParam getSkinParam() {
|
|
return skinParam;
|
|
}
|
|
|
|
public void setParam(String key, String value) {
|
|
skinParam.setParam(StringUtils.goLowerCase(key), value);
|
|
}
|
|
|
|
public final DisplaySection getFooterOrHeaderTeoz(FontParam param) {
|
|
if (param == FontParam.FOOTER) {
|
|
return getFooter();
|
|
}
|
|
if (param == FontParam.HEADER) {
|
|
return getHeader();
|
|
}
|
|
throw new IllegalArgumentException();
|
|
}
|
|
|
|
abstract public UmlDiagramType getUmlDiagramType();
|
|
|
|
public Pragma getPragma() {
|
|
return pragma;
|
|
}
|
|
|
|
final public void setAnimation(Iterable<CharSequence> animationData) {
|
|
try {
|
|
final AnimationDecoder animationDecoder = new AnimationDecoder(animationData);
|
|
this.animation = Animation.create(animationDecoder.decode());
|
|
} catch (ScriptException e) {
|
|
e.printStackTrace();
|
|
}
|
|
|
|
}
|
|
|
|
final public Animation getAnimation() {
|
|
return animation;
|
|
}
|
|
|
|
public final double getScaleCoef(FileFormatOption fileFormatOption) {
|
|
if (getSkinParam().getDpi() == 96) {
|
|
return fileFormatOption.getScaleCoef();
|
|
}
|
|
return getSkinParam().getDpi() * fileFormatOption.getScaleCoef() / 96.0;
|
|
}
|
|
|
|
public final boolean isHideUnlinkedData() {
|
|
return hideUnlinkedData;
|
|
}
|
|
|
|
public final void setHideUnlinkedData(boolean hideUnlinkedData) {
|
|
this.hideUnlinkedData = hideUnlinkedData;
|
|
}
|
|
|
|
@Override
|
|
final protected ImageData exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption, long seed)
|
|
throws IOException {
|
|
|
|
final HtmlColor hover = getSkinParam().getHoverPathColor();
|
|
if (fileFormatOption.getSvgLinkTarget() == null || fileFormatOption.getSvgLinkTarget().equals("_top")) {
|
|
fileFormatOption = fileFormatOption.withSvgLinkTarget(getSkinParam().getSvgLinkTarget());
|
|
}
|
|
fileFormatOption = fileFormatOption.withTikzFontDistortion(getSkinParam().getTikzFontDistortion());
|
|
if (hover != null) {
|
|
fileFormatOption = fileFormatOption.withHoverColor(StringUtils.getAsHtml(getSkinParam().getColorMapper()
|
|
.getMappedColor(hover)));
|
|
}
|
|
|
|
if (fileFormatOption.getFileFormat() == FileFormat.PDF) {
|
|
return exportDiagramInternalPdf(os, index);
|
|
}
|
|
|
|
try {
|
|
final ImageData imageData = exportDiagramInternal(os, index, fileFormatOption);
|
|
this.lastInfo = new Dimension2DDouble(imageData.getWidth(), imageData.getHeight());
|
|
return imageData;
|
|
} catch (UnparsableGraphvizException e) {
|
|
e.printStackTrace();
|
|
exportDiagramError(os, e.getCause(), fileFormatOption, seed, e.getGraphvizVersion());
|
|
} catch (Exception e) {
|
|
e.printStackTrace();
|
|
exportDiagramError(os, e, fileFormatOption, seed, null);
|
|
}
|
|
return ImageDataSimple.error();
|
|
}
|
|
|
|
private void exportDiagramError(OutputStream os, Throwable exception, FileFormatOption fileFormat, long seed,
|
|
String graphvizVersion) throws IOException {
|
|
exportDiagramError(os, exception, fileFormat, seed, getMetadata(), getFlashData(),
|
|
getFailureText1(exception, graphvizVersion, getFlashData()));
|
|
}
|
|
|
|
public static void exportDiagramError(OutputStream os, Throwable exception, FileFormatOption fileFormat, long seed,
|
|
String metadata, String flash, List<String> strings) throws IOException {
|
|
|
|
if (fileFormat.getFileFormat() == FileFormat.ATXT || fileFormat.getFileFormat() == FileFormat.UTXT) {
|
|
exportDiagramErrorText(os, exception, strings);
|
|
return;
|
|
}
|
|
|
|
strings.addAll(CommandExecutionResult.getStackTrace(exception));
|
|
|
|
final ImageBuilder imageBuilder = new ImageBuilder(new ColorMapperIdentity(), 1.0, HtmlColorUtils.WHITE,
|
|
metadata, null, 0, 0, null, false);
|
|
|
|
final FlashCodeUtils utils = FlashCodeFactory.getFlashCodeUtils();
|
|
final BufferedImage im = utils.exportFlashcode(flash, Color.BLACK, Color.WHITE);
|
|
if (im != null) {
|
|
GraphvizCrash.addDecodeHint(strings);
|
|
}
|
|
|
|
final TextBlockBackcolored graphicStrings = GraphicStrings.createBlackOnWhite(strings, IconLoader.getRandom(),
|
|
GraphicPosition.BACKGROUND_CORNER_TOP_RIGHT);
|
|
|
|
if (im == null) {
|
|
imageBuilder.setUDrawable(graphicStrings);
|
|
} else {
|
|
imageBuilder.setUDrawable(new UDrawable() {
|
|
public void drawU(UGraphic ug) {
|
|
graphicStrings.drawU(ug);
|
|
final double height = graphicStrings.calculateDimension(ug.getStringBounder()).getHeight();
|
|
ug = ug.apply(new UTranslate(0, height));
|
|
ug.draw(new UImage(im).scaleNearestNeighbor(3));
|
|
}
|
|
});
|
|
}
|
|
imageBuilder.writeImageTOBEMOVED(fileFormat, seed, os);
|
|
}
|
|
|
|
private static void exportDiagramErrorText(OutputStream os, Throwable exception, List<String> strings) {
|
|
final PrintWriter pw = new PrintWriter(os);
|
|
exception.printStackTrace(pw);
|
|
pw.println();
|
|
pw.println();
|
|
for (String s : strings) {
|
|
s = s.replaceAll("\\</?\\w+?\\>", "");
|
|
pw.println(s);
|
|
}
|
|
pw.flush();
|
|
}
|
|
|
|
public String getFlashData() {
|
|
final UmlSource source = getSource();
|
|
if (source == null) {
|
|
return "";
|
|
}
|
|
return source.getPlainString();
|
|
}
|
|
|
|
static private List<String> getFailureText1(Throwable exception, String graphvizVersion, String textDiagram) {
|
|
final List<String> strings = GraphvizCrash.anErrorHasOccured(exception, textDiagram);
|
|
strings.add("PlantUML (" + Version.versionString() + ") cannot parse result from dot/GraphViz.");
|
|
if (exception instanceof EmptySvgException) {
|
|
strings.add("Because dot/GraphViz returns an empty string.");
|
|
}
|
|
GraphvizCrash.checkOldVersionWarning(strings);
|
|
if (graphvizVersion != null) {
|
|
strings.add(" ");
|
|
strings.add("GraphViz version used : " + graphvizVersion);
|
|
}
|
|
GraphvizCrash.pleaseGoTo(strings);
|
|
GraphvizCrash.addProperties(strings);
|
|
strings.add(" ");
|
|
GraphvizCrash.thisMayBeCaused(strings);
|
|
strings.add(" ");
|
|
GraphvizCrash.youShouldSendThisDiagram(strings);
|
|
strings.add(" ");
|
|
return strings;
|
|
}
|
|
|
|
public static List<String> getFailureText2(Throwable exception, String textDiagram) {
|
|
final List<String> strings = GraphvizCrash.anErrorHasOccured(exception, textDiagram);
|
|
strings.add("PlantUML (" + Version.versionString() + ") has crashed.");
|
|
GraphvizCrash.checkOldVersionWarning(strings);
|
|
strings.add(" ");
|
|
GraphvizCrash.youShouldSendThisDiagram(strings);
|
|
strings.add(" ");
|
|
return strings;
|
|
}
|
|
|
|
private void exportDiagramInternalMjpeg(OutputStream os) throws IOException {
|
|
final File f = new File("c:/test.avi");
|
|
final int nb = 150;
|
|
final double framerate = 30;
|
|
final MJPEGGenerator m = new MJPEGGenerator(f, 640, 480, framerate, nb);
|
|
|
|
for (int i = 0; i < nb; i++) {
|
|
final AffineTransform at = new AffineTransform();
|
|
final double coef = (nb - 1 - i) * 1.0 / nb;
|
|
at.setToShear(coef, coef);
|
|
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
|
|
// exportDiagramTOxxBEREMOVED(baos, null, 0, new FileFormatOption(FileFormat.PNG, at));
|
|
baos.close();
|
|
final BufferedImage im = ImageIO.read(new ByteArrayInputStream(baos.toByteArray()));
|
|
m.addImage(im);
|
|
}
|
|
m.finishAVI();
|
|
|
|
}
|
|
|
|
private Dimension2D lastInfo;
|
|
|
|
private ImageData exportDiagramInternalPdf(OutputStream os, int index) throws IOException {
|
|
final File svg = FileUtils.createTempFile("pdf", ".svf");
|
|
final File pdfFile = FileUtils.createTempFile("pdf", ".pdf");
|
|
final OutputStream fos = new BufferedOutputStream(new FileOutputStream(svg));
|
|
final ImageData result = exportDiagram(fos, index, new FileFormatOption(FileFormat.SVG));
|
|
fos.close();
|
|
PdfConverter.convert(svg, pdfFile);
|
|
FileUtils.copyToStream(pdfFile, os);
|
|
return result;
|
|
}
|
|
|
|
protected abstract ImageData exportDiagramInternal(OutputStream os, int index, FileFormatOption fileFormatOption)
|
|
throws IOException;
|
|
|
|
final protected void exportCmap(SuggestedFile suggestedFile, int index, final ImageData cmapdata)
|
|
throws FileNotFoundException {
|
|
final String name = changeName(suggestedFile.getFile(index).getAbsolutePath());
|
|
final File cmapFile = new File(name);
|
|
PrintWriter pw = null;
|
|
try {
|
|
if (PSystemUtils.canFileBeWritten(cmapFile) == false) {
|
|
return;
|
|
}
|
|
pw = new PrintWriter(cmapFile);
|
|
pw.print(cmapdata.getCMapData(cmapFile.getName().substring(0, cmapFile.getName().length() - 6)));
|
|
pw.close();
|
|
} finally {
|
|
if (pw != null) {
|
|
pw.close();
|
|
}
|
|
}
|
|
}
|
|
|
|
static String changeName(String name) {
|
|
return name.replaceAll("(?i)\\.\\w{3}$", ".cmapx");
|
|
}
|
|
|
|
@Override
|
|
public String getWarningOrError() {
|
|
if (lastInfo == null) {
|
|
return null;
|
|
}
|
|
final double actualWidth = lastInfo.getWidth();
|
|
if (actualWidth == 0) {
|
|
return null;
|
|
}
|
|
final String value = getSkinParam().getValue("widthwarning");
|
|
if (value == null) {
|
|
return null;
|
|
}
|
|
if (value.matches("\\d+") == false) {
|
|
return null;
|
|
}
|
|
final int widthwarning = Integer.parseInt(value);
|
|
if (actualWidth > widthwarning) {
|
|
return "The image is " + ((int) actualWidth) + " pixel width. (Warning limit is " + widthwarning + ")";
|
|
}
|
|
return null;
|
|
}
|
|
|
|
public void addSprite(String name, Sprite sprite) {
|
|
skinParam.addSprite(name, sprite);
|
|
}
|
|
|
|
private boolean useJDot;
|
|
|
|
public void setUseJDot(boolean useJDot) {
|
|
this.useJDot = useJDot;
|
|
}
|
|
|
|
public static final boolean FORCE_JDOT = false;
|
|
|
|
public boolean isUseJDot() {
|
|
if (FORCE_JDOT)
|
|
return true;
|
|
return useJDot;
|
|
}
|
|
|
|
public CommandExecutionResult loadSkin(String newSkin) throws IOException {
|
|
getSkinParam().setDefaultSkin(newSkin + ".skin");
|
|
return CommandExecutionResult.ok();
|
|
// final String res = "/skin/" + filename + ".skin";
|
|
// final InputStream internalIs = UmlDiagram.class.getResourceAsStream(res);
|
|
// if (internalIs != null) {
|
|
// final BlocLines lines2 = BlocLines.load(internalIs, new LineLocationImpl(filename, null));
|
|
// return loadSkinInternal(lines2);
|
|
// }
|
|
// if (OptionFlags.ALLOW_INCLUDE == false) {
|
|
// return CommandExecutionResult.ok();
|
|
// }
|
|
// final File f = FileSystem.getInstance().getFile(filename + ".skin");
|
|
// if (f == null || f.exists() == false || f.canRead() == false) {
|
|
// return CommandExecutionResult.error("Cannot load skin from " + filename);
|
|
// }
|
|
// final BlocLines lines = BlocLines.load(f, new LineLocationImpl(f.getName(), null));
|
|
// return loadSkinInternal(lines);
|
|
}
|
|
|
|
// private CommandExecutionResult loadSkinInternal(final BlocLines lines) {
|
|
// final CommandSkinParam cmd1 = new CommandSkinParam();
|
|
// final CommandSkinParamMultilines cmd2 = new CommandSkinParamMultilines();
|
|
// for (int i = 0; i < lines.size(); i++) {
|
|
// final BlocLines ext1 = lines.subList(i, i + 1);
|
|
// if (cmd1.isValid(ext1) == CommandControl.OK) {
|
|
// cmd1.execute(this, ext1);
|
|
// } else if (cmd2.isValid(ext1) == CommandControl.OK_PARTIAL) {
|
|
// i = tryMultilines(cmd2, i, lines);
|
|
// }
|
|
// }
|
|
// return CommandExecutionResult.ok();
|
|
// }
|
|
|
|
private int tryMultilines(CommandSkinParamMultilines cmd2, int i, BlocLines lines) {
|
|
for (int j = i + 1; j <= lines.size(); j++) {
|
|
final BlocLines ext1 = lines.subList(i, j);
|
|
if (cmd2.isValid(ext1) == CommandControl.OK) {
|
|
cmd2.execute(this, ext1);
|
|
return j;
|
|
} else if (cmd2.isValid(ext1) == CommandControl.NOT_OK) {
|
|
return j;
|
|
}
|
|
}
|
|
return i;
|
|
}
|
|
|
|
public void setHideEmptyDescription(boolean hideEmptyDescription) {
|
|
}
|
|
|
|
}
|