net.sourceforge.plantuml.dot.CucaDiagramTxtMaker 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.dot;
import static java.nio.charset.StandardCharsets.UTF_8;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import net.atmp.CucaDiagram;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.EntityPortion;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.asciiart.BasicCharArea;
import net.sourceforge.plantuml.cucadiagram.PortionShower;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.txt.UGraphicTxt;
import net.sourceforge.plantuml.klimt.geom.XCubicCurve2D;
import net.sourceforge.plantuml.klimt.geom.XPoint2D;
import net.sourceforge.plantuml.klimt.shape.DotPath;
import net.sourceforge.plantuml.posimo.Block;
import net.sourceforge.plantuml.posimo.Cluster;
import net.sourceforge.plantuml.posimo.GraphvizSolverB;
import net.sourceforge.plantuml.posimo.Path;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SecurityUtils;
import net.sourceforge.plantuml.text.BackSlash;
public final class CucaDiagramTxtMaker {
// ::remove file when __CORE__
// private final CucaDiagram diagram;
private final FileFormat fileFormat;
private final UGraphicTxt globalUg = new UGraphicTxt();
private final PortionShower portionShower;
private static double getXPixelPerChar() {
return 5;
}
private static double getYPixelPerChar() {
return 10;
}
private boolean showMember(Entity entity) {
final boolean showMethods = portionShower.showPortion(EntityPortion.METHOD, entity);
final boolean showFields = portionShower.showPortion(EntityPortion.FIELD, entity);
return showMethods || showFields;
}
public CucaDiagramTxtMaker(CucaDiagram diagram, FileFormat fileFormat) throws IOException {
this.fileFormat = fileFormat;
this.portionShower = diagram;
final Cluster root = new Cluster(null, 0, 0);
int uid = 0;
final Map blocks = new HashMap();
for (Entity ent : diagram.leafs()) {
// printClass(ent);
// ug.translate(0, getHeight(ent) + 1);
final double width = getWidth(ent) * getXPixelPerChar();
final double height = getHeight(ent) * getYPixelPerChar();
final Block b = new Block(uid++, width, height, null);
root.addBloc(b);
blocks.put(ent, b);
}
final GraphvizSolverB solver = new GraphvizSolverB();
final Collection paths = new ArrayList<>();
for (Link link : diagram.getLinks()) {
final Block b1 = blocks.get(link.getEntity1());
final Block b2 = blocks.get(link.getEntity2());
paths.add(new Path(b1, b2, null, link.getLength(), link.isInvis()));
}
solver.solve(root, paths);
for (Path p : paths) {
if (p.isInvis())
continue;
drawDotPath(p.getDotPath(), globalUg.getCharArea(), getXPixelPerChar(), getYPixelPerChar());
}
for (Entity ent : diagram.leafs()) {
final Block b = blocks.get(ent);
final XPoint2D p = b.getPosition();
printClass(ent, (UGraphicTxt) globalUg
.apply(new UTranslate(p.getX() / getXPixelPerChar(), p.getY() / getYPixelPerChar())));
}
}
private void drawDotPath(DotPath dotPath, BasicCharArea area, double pixelXPerChar, double pixelYPerChar) {
for (XCubicCurve2D bez : dotPath.getBeziers())
if (bez.x1 == bez.x2)
area.drawVLine('|', (int) (bez.x1 / pixelXPerChar), (int) (bez.y1 / pixelYPerChar),
(int) (bez.y2 / pixelYPerChar));
else if (bez.y1 == bez.y2)
area.drawHLine('-', (int) (bez.y1 / pixelYPerChar), (int) (bez.x1 / pixelXPerChar),
(int) (bez.x2 / pixelXPerChar));
}
private void printClass(final Entity ent, UGraphicTxt ug) {
final int w = getWidth(ent);
final int h = getHeight(ent);
ug.getCharArea().drawBoxSimple(0, 0, w, h);
ug.getCharArea().drawStringsLRSimple(ent.getDisplay().asList(), 1, 1);
if (showMember(ent)) {
int y = 2;
ug.getCharArea().drawHLine('-', y, 1, w - 1);
y++;
for (CharSequence att : ent.getBodier().getRawBody()) {
final List disp = BackSlash.getWithNewlines(att.toString());
ug.getCharArea().drawStringsLRSimple(disp, 1, y);
y += StringUtils.getHeight(disp);
}
// for (Member att : ent.getBodier().getFieldsToDisplay()) {
// final List disp = BackSlash.getWithNewlines(att.getDisplay(true));
// ug.getCharArea().drawStringsLR(disp, 1, y);
// y += StringUtils.getHeight(disp);
// }
// ug.getCharArea().drawHLine('-', y, 1, w - 1);
// y++;
// for (Member att : ent.getBodier().getMethodsToDisplay()) {
// final List disp = BackSlash.getWithNewlines(att.getDisplay(true));
// ug.getCharArea().drawStringsLR(disp, 1, y);
// y += StringUtils.getHeight(disp);
// }
}
}
public List createFiles(SFile suggestedFile) throws IOException {
if (fileFormat == FileFormat.UTXT)
globalUg.getCharArea().print(suggestedFile.createPrintStream(UTF_8));
else
globalUg.getCharArea().print(suggestedFile.createPrintStream());
return Collections.singletonList(suggestedFile);
}
private int getHeight(Entity entity) {
int result = StringUtils.getHeight(entity.getDisplay());
if (showMember(entity)) {
for (CharSequence att : entity.getBodier().getRawBody())
result += StringUtils.getHeight(Display.getWithNewlines(att.toString()));
// for (Member att : entity.getBodier().getMethodsToDisplay()) {
// result += StringUtils.getHeight(Display.getWithNewlines(att.getDisplay(true)));
// }
// result++;
// for (Member att : entity.getBodier().getFieldsToDisplay()) {
// result += StringUtils.getHeight(Display.getWithNewlines(att.getDisplay(true)));
// }
// result++;
}
return result + 3;
}
private int getWidth(Entity entity) {
int result = StringUtils.getWcWidth(entity.getDisplay());
if (showMember(entity)) {
for (CharSequence att : entity.getBodier().getRawBody()) {
final int w = StringUtils.getWcWidth(Display.getWithNewlines(att.toString()));
if (w > result)
result = w;
}
// for (Member att : entity.getBodier().getMethodsToDisplay()) {
// final int w = StringUtils.getWcWidth(Display.getWithNewlines(att.getDisplay(true)));
// if (w > result) {
// result = w;
// }
// }
// for (Member att : entity.getBodier().getFieldsToDisplay()) {
// final int w = StringUtils.getWcWidth(Display.getWithNewlines(att.getDisplay(true)));
// if (w > result) {
// result = w;
// }
// }
}
return result + 2;
}
public void createFiles(OutputStream os, int index) {
globalUg.getCharArea().print(SecurityUtils.createPrintStream(os));
}
}