net.sourceforge.plantuml.html.LinkHtmlPrinter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-epl Show documentation
Show all versions of plantuml-epl 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 Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.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 EPL license.
*
* The generated images can then be used without any reference to the EPL 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.html;
import java.io.PrintWriter;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.abel.Link;
import net.sourceforge.plantuml.decoration.LinkDecor;
public final class LinkHtmlPrinter {
// ::remove folder when __HAXE__
private final Link link;
// private final Entity entity;
private final boolean chiral;
public LinkHtmlPrinter(Link link, Entity entity) {
this.link = link;
if (link.getEntity1() == entity) {
this.chiral = false;
} else if (link.getEntity2() == entity) {
this.chiral = true;
} else {
throw new IllegalArgumentException();
}
}
void printLink(PrintWriter pw) {
final String ent1h;
final String ent2h;
if (chiral) {
ent1h = htmlLink(link.getEntity1());
ent2h = "" + StringUtils.unicodeForHtml(link.getEntity2().getName()) + "";
} else {
ent1h = "" + StringUtils.unicodeForHtml(link.getEntity1().getName()) + "";
ent2h = htmlLink(link.getEntity2());
}
String label = link.getLabel() == null ? null : StringUtils.unicodeForHtml(link.getLabel());
String ent1 = ent1h;
String ent2 = ent2h;
if (link.getQuantifier1() != null) {
ent1 = ent1 + " (" + link.getQuantifier1() + ")";
if (label != null) {
label = "(" + link.getQuantifier1() + " " + ent1h + ") " + label;
}
}
if (link.getQuantifier2() != null) {
ent2 = ent2 + " (" + link.getQuantifier2() + ")";
if (label != null) {
label = label + " (" + link.getQuantifier2() + " " + ent2h + ")";
}
}
if (chiral) {
pw.println(getHtmlChiral(ent1, ent2));
} else {
pw.println(getHtml(ent1, ent2));
}
if (label != null) {
pw.println(" : ");
pw.println(label);
}
}
private String getHtml(String ent1, String ent2) {
final LinkDecor decor1 = link.getType().getDecor1();
final LinkDecor decor2 = link.getType().getDecor2();
if (decor1 == LinkDecor.NONE && decor2 == LinkDecor.NONE) {
return ent1 + " is linked to " + ent2;
}
if (decor1 == LinkDecor.NONE && decor2 == LinkDecor.EXTENDS) {
return ent1 + " is extended by " + ent2;
}
if (decor1 == LinkDecor.EXTENDS && decor2 == LinkDecor.NONE) {
return ent1 + " extends " + ent2;
}
if (decor2 == LinkDecor.AGREGATION) {
return ent1 + " is aggregated by " + ent2;
}
if (decor1 == LinkDecor.AGREGATION) {
return ent1 + " aggregates " + ent2;
}
if (decor2 == LinkDecor.COMPOSITION) {
return ent1 + " is composed by " + ent2;
}
if (decor1 == LinkDecor.COMPOSITION) {
return ent1 + " composes " + ent2;
}
if (decor1 == LinkDecor.NONE && decor2 == LinkDecor.ARROW) {
return ent1 + " is navigable from " + ent2;
}
if (decor1 == LinkDecor.ARROW && decor2 == LinkDecor.NONE) {
return ent1 + " navigates to " + ent2;
}
return ent1 + " " + decor1 + "-" + decor2 + " " + ent2;
}
private String getHtmlChiral(String ent1, String ent2) {
final LinkDecor decor1 = link.getType().getDecor1();
final LinkDecor decor2 = link.getType().getDecor2();
if (decor1 == LinkDecor.NONE && decor2 == LinkDecor.NONE) {
return ent2 + " is linked to " + ent1;
}
if (decor1 == LinkDecor.NONE && decor2 == LinkDecor.EXTENDS) {
return ent2 + " extends " + ent1;
}
if (decor1 == LinkDecor.EXTENDS && decor2 == LinkDecor.NONE) {
return ent2 + " is extended by " + ent1;
}
if (decor2 == LinkDecor.AGREGATION) {
return ent2 + " aggregates " + ent1;
}
if (decor1 == LinkDecor.AGREGATION) {
return ent2 + " is aggregated by " + ent1;
}
if (decor2 == LinkDecor.COMPOSITION) {
return ent2 + " composes " + ent1;
}
if (decor1 == LinkDecor.COMPOSITION) {
return ent2 + " is composed by " + ent1;
}
if (decor1 == LinkDecor.NONE && decor2 == LinkDecor.ARROW) {
return ent2 + " navigates to " + ent1;
}
if (decor1 == LinkDecor.ARROW && decor2 == LinkDecor.NONE) {
return ent2 + " is navigable from " + ent1;
}
return ent1 + " " + decor1 + "-" + decor2 + " " + ent2;
}
static String htmlLink(Entity ent) {
final StringBuilder sb = new StringBuilder();
sb.append("");
sb.append(StringUtils.unicodeForHtml(ent.getName()));
sb.append("");
return sb.toString();
}
static String urlOf(Entity ent) {
if (ent.getLeafType() == LeafType.NOTE) {
throw new IllegalArgumentException();
}
if (ent.getName().matches("[-\\w_ .]+")) {
return StringUtils.unicodeForHtml(ent.getName()) + ".html";
}
return StringUtils.unicodeForHtml(ent.getUid()) + ".html";
}
}