net.sourceforge.plantuml.klimt.drawing.debug.UGraphicDebug 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.klimt.drawing.debug;
import static java.nio.charset.StandardCharsets.UTF_8;
import java.awt.Color;
import java.io.IOException;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import net.sourceforge.plantuml.klimt.ClipContainer;
import net.sourceforge.plantuml.klimt.UPath;
import net.sourceforge.plantuml.klimt.UShape;
import net.sourceforge.plantuml.klimt.color.ColorMapper;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColorMiddle;
import net.sourceforge.plantuml.klimt.color.HColorSimple;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.klimt.drawing.AbstractCommonUGraphic;
import net.sourceforge.plantuml.klimt.geom.USegment;
import net.sourceforge.plantuml.klimt.geom.USegmentType;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.shape.DotPath;
import net.sourceforge.plantuml.klimt.shape.UCenteredCharacter;
import net.sourceforge.plantuml.klimt.shape.UComment;
import net.sourceforge.plantuml.klimt.shape.UEllipse;
import net.sourceforge.plantuml.klimt.shape.UEmpty;
import net.sourceforge.plantuml.klimt.shape.ULine;
import net.sourceforge.plantuml.klimt.shape.UPolygon;
import net.sourceforge.plantuml.klimt.shape.URectangle;
import net.sourceforge.plantuml.klimt.shape.UText;
public class UGraphicDebug extends AbstractCommonUGraphic implements ClipContainer {
private final List output;
private final double scaleFactor;
private final XDimension2D dim;
private final String svgLinkTarget;
private final String hoverPathColorRGB;
private final long seed;
private final String preserveAspectRatio;
@Override
protected AbstractCommonUGraphic copyUGraphic() {
final UGraphicDebug result = new UGraphicDebug(this, output, scaleFactor, dim, svgLinkTarget, hoverPathColorRGB,
seed, preserveAspectRatio);
return result;
}
private UGraphicDebug(UGraphicDebug other, List output, double scaleFactor, XDimension2D dim,
String svgLinkTarget, String hoverPathColorRGB, long seed, String preserveAspectRatio) {
super(other.getStringBounder());
basicCopy(other);
this.output = output;
this.scaleFactor = scaleFactor;
this.dim = dim;
this.svgLinkTarget = svgLinkTarget;
this.hoverPathColorRGB = hoverPathColorRGB;
this.seed = seed;
this.preserveAspectRatio = preserveAspectRatio;
}
public UGraphicDebug(double scaleFactor, XDimension2D dim, String svgLinkTarget, String hoverPathColorRGB,
long seed, String preserveAspectRatio) {
super(new StringBounderDebug());
basicCopy(HColors.WHITE, ColorMapper.IDENTITY);
this.output = new ArrayList<>();
this.scaleFactor = scaleFactor;
this.dim = dim;
this.svgLinkTarget = svgLinkTarget;
this.hoverPathColorRGB = hoverPathColorRGB;
this.seed = seed;
this.preserveAspectRatio = preserveAspectRatio;
}
public void draw(UShape shape) {
if (shape instanceof ULine) {
outLine((ULine) shape);
} else if (shape instanceof URectangle) {
outRectangle((URectangle) shape);
} else if (shape instanceof UText) {
outText((UText) shape);
} else if (shape instanceof UPolygon) {
outPolygon((UPolygon) shape);
} else if (shape instanceof UEllipse) {
outEllipse((UEllipse) shape);
} else if (shape instanceof UEmpty) {
outEmpty((UEmpty) shape);
} else if (shape instanceof UPath) {
outPath((UPath) shape);
} else if (shape instanceof UComment) {
outComment((UComment) shape);
} else if (shape instanceof DotPath) {
outPath(((DotPath) shape).toUPath());
} else if (shape instanceof UCenteredCharacter) {
outCenteredCharacter(((UCenteredCharacter) shape));
} else {
System.err.println("UGraphicDebug " + shape.getClass().getSimpleName());
output.add("UGraphicDebug " + shape.getClass().getSimpleName() + " " + new Date());
}
}
private void outCenteredCharacter(UCenteredCharacter shape) {
output.add("CENTERED_CHAR:");
output.add(" char: " + shape.getChar());
output.add(" position: " + pointd(getTranslateX(), getTranslateY()));
output.add(" font: " + shape.getFont().toStringDebug());
output.add(" color: " + colorToString(getParam().getColor()));
output.add("");
}
private void outComment(UComment shape) {
output.add("COMMENT: " + shape.getComment());
}
private void outPath(UPath shape) {
output.add("PATH:");
for (USegment seg : shape) {
final USegmentType type = seg.getSegmentType();
final double coord[] = seg.getCoord();
output.add(" - type: " + type);
if (type == USegmentType.SEG_ARCTO) {
output.add(" radius: " + pointd(coord[0], coord[1]));
output.add(" angle: " + coord[2]);
output.add(" largeArcFlag: " + (coord[3] != 0));
output.add(" sweepFlag: " + (coord[4] != 0));
output.add(" dest: " + pointd(coord[5], coord[6]));
} else
for (int i = 0; i < type.getNbPoints(); i++) {
final String key = " pt" + (i + 1) + ": ";
output.add(key + pointd(coord[2 * i], coord[2 * i + 1]));
}
}
output.add(" stroke: " + getParam().getStroke());
output.add(" shadow: " + (int) shape.getDeltaShadow());
output.add(" color: " + colorToString(getParam().getColor()));
output.add(" backcolor: " + colorToString(getParam().getBackcolor()));
output.add("");
}
private void outPolygon(UPolygon shape) {
output.add("POLYGON:");
output.add(" points:");
for (XPoint2D pt : shape.getPoints()) {
final double xp = getTranslateX() + pt.getX();
final double yp = getTranslateY() + pt.getY();
output.add(" - " + pointd(xp, yp));
}
output.add(" stroke: " + getParam().getStroke());
output.add(" shadow: " + (int) shape.getDeltaShadow());
output.add(" color: " + colorToString(getParam().getColor()));
output.add(" backcolor: " + colorToString(getParam().getBackcolor()));
output.add("");
}
private void outText(UText shape) {
output.add("TEXT:");
output.add(" text: " + shape.getText());
output.add(" position: " + pointd(getTranslateX(), getTranslateY()));
output.add(" orientation: " + shape.getOrientation());
output.add(" font: " + shape.getFontConfiguration().toStringDebug());
output.add(" color: " + colorToString(shape.getFontConfiguration().getColor()));
output.add(" extendedColor: " + colorToString(shape.getFontConfiguration().getExtendedColor()));
output.add("");
}
private void outEmpty(UEmpty shape) {
output.add("EMPTY:");
output.add(" pt1: " + pointd(getTranslateX(), getTranslateY()));
output.add(" pt2: " + pointd(getTranslateX() + shape.getWidth(), getTranslateY() + shape.getHeight()));
output.add("");
}
private void outEllipse(UEllipse shape) {
output.add("ELLIPSE:");
output.add(" pt1: " + pointd(getTranslateX(), getTranslateY()));
output.add(" pt2: " + pointd(getTranslateX() + shape.getWidth(), getTranslateY() + shape.getHeight()));
output.add(" start: " + shape.getStart());
output.add(" extend: " + shape.getExtend());
output.add(" stroke: " + getParam().getStroke());
output.add(" shadow: " + (int) shape.getDeltaShadow());
output.add(" color: " + colorToString(getParam().getColor()));
output.add(" backcolor: " + colorToString(getParam().getBackcolor()));
output.add("");
}
private void outRectangle(URectangle shape) {
output.add("RECTANGLE:");
output.add(" pt1: " + pointd(getTranslateX(), getTranslateY()));
output.add(" pt2: " + pointd(getTranslateX() + shape.getWidth(), getTranslateY() + shape.getHeight()));
output.add(" xCorner: " + (int) shape.getRx());
output.add(" yCorner: " + (int) shape.getRy());
output.add(" stroke: " + getParam().getStroke());
output.add(" shadow: " + (int) shape.getDeltaShadow());
output.add(" color: " + colorToString(getParam().getColor()));
output.add(" backcolor: " + colorToString(getParam().getBackcolor()));
output.add("");
}
private void outLine(ULine shape) {
output.add("LINE:");
output.add(" pt1: " + pointd(getTranslateX(), getTranslateY()));
output.add(" pt2: " + pointd(getTranslateX() + shape.getDX(), getTranslateY() + shape.getDY()));
output.add(" stroke: " + getParam().getStroke());
output.add(" shadow: " + (int) shape.getDeltaShadow());
output.add(" color: " + colorToString(getParam().getColor()));
output.add("");
}
private String pointd(double x, double y) {
return String.format(Locale.US, "[ %.4f ; %.4f ]", x, y);
}
private String colorToString(HColor color) {
if (color == null || color.isTransparent())
return "NULL_COLOR";
if (color instanceof HColorSimple) {
final HColorSimple simple = (HColorSimple) color;
final Color internal = simple.getAwtColor();
return Integer.toHexString(internal.getRGB());
}
if (color instanceof HColorMiddle) {
final HColorMiddle middle = (HColorMiddle) color;
return "middle(" + colorToString(middle.getColor1()) + " & " + colorToString(middle.getColor1()) + " )";
}
System.err.println("Error colorToString " + color.getClass().getSimpleName());
return color.getClass().getSimpleName() + " " + new Date();
}
@Override
public void writeToStream(OutputStream os, String metadata, int dpi) throws IOException {
print(os, "DPI: " + dpi);
print(os, "dimension: " + pointd(dim.getWidth(), dim.getHeight()));
print(os, "scaleFactor: " + String.format(Locale.US, "%.4f", scaleFactor));
print(os, "seed: " + seed);
print(os, "svgLinkTarget: " + svgLinkTarget);
print(os, "hoverPathColorRGB: " + hoverPathColorRGB);
print(os, "preserveAspectRatio: " + preserveAspectRatio);
print(os, "");
for (String s : output)
print(os, s);
os.flush();
}
private void print(OutputStream os, String out) throws UnsupportedEncodingException, IOException {
os.write(out.getBytes(UTF_8));
os.write("\n".getBytes(UTF_8));
}
}