net.sourceforge.plantuml.klimt.creole.legacy.AtomText Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// 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 Apache Software License.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 APACHE license.
*
* The generated images can then be used without any reference to the APACHE 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.creole.legacy;
import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Neutron;
import net.sourceforge.plantuml.klimt.creole.NeutronType;
import net.sourceforge.plantuml.klimt.creole.atom.AbstractAtom;
import net.sourceforge.plantuml.klimt.creole.atom.Atom;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.UText;
import net.sourceforge.plantuml.text.BackSlash;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.utils.CharHidder;
import net.sourceforge.plantuml.utils.Log;
public final class AtomText extends AbstractAtom implements Atom {
protected interface DelayedDouble {
public double getDouble(StringBounder stringBounder);
}
private final FontConfiguration fontConfiguration;
private final String text;
private final DelayedDouble marginLeft;
private final DelayedDouble marginRight;
private final Url url;
private final boolean manageSpecialChars;
protected AtomText(String text, FontConfiguration style, Url url, DelayedDouble marginLeft,
DelayedDouble marginRight, boolean manageSpecialChars) {
if (text.contains("" + BackSlash.hiddenNewLine()))
throw new IllegalArgumentException(text);
this.marginLeft = marginLeft;
this.marginRight = marginRight;
String s = CharHidder.unhide(text);
if (manageSpecialChars) {
s = StringUtils.showComparatorCharacters(s);
s = StringUtils.manageAmpDiese(s);
s = StringUtils.manageUnicodeNotationUplus(s);
s = StringUtils.manageTildeArobaseStart(s);
s = StringUtils.manageEscapedTabs(s);
}
this.manageSpecialChars = manageSpecialChars;
this.text = s;
this.fontConfiguration = style;
this.url = url;
}
private AtomText withText(String text) {
return new AtomText(text, fontConfiguration, url, marginLeft, marginRight, manageSpecialChars);
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
final XDimension2D rect = stringBounder.calculateDimension(fontConfiguration.getFont(), text);
Log.debug("g2d=" + rect);
Log.debug("Size for " + text + " is " + rect);
double h = rect.getHeight();
if (h < 10)
h = 10;
double width = text.indexOf("\t") == -1 ? rect.getWidth() : getWidth(stringBounder, text);
final double left = marginLeft.getDouble(stringBounder);
final double right = marginRight.getDouble(stringBounder);
return new XDimension2D(width + left + right, h);
}
public void drawU(UGraphic ug) {
if (url != null)
ug.startUrl(url);
if (ug.matchesProperty("SPECIALTXT")) {
ug.draw(this);
} else {
HColor textColor = fontConfiguration.getColor();
FontConfiguration useFontConfiguration = fontConfiguration;
HColor backcolor = ug.getParam().getBackcolor();
if (backcolor.isTransparent())
backcolor = ug.getDefaultBackground();
textColor = textColor.getAppropriateColor(backcolor);
useFontConfiguration = fontConfiguration.changeColor(textColor);
if (marginLeft != AtomTextUtils.ZERO)
ug = ug.apply(UTranslate.dx(marginLeft.getDouble(ug.getStringBounder())));
final StringTokenizer tokenizer = new StringTokenizer(text, "\t", true);
// final int ypos = fontConfiguration.getSpace();
final XDimension2D rect = ug.getStringBounder().calculateDimension(fontConfiguration.getFont(), text);
final double descent = getDescent(ug.getStringBounder());
final double ypos = rect.getHeight() - descent;
double x = 0;
if (tokenizer.hasMoreTokens()) {
final double tabSize = getTabSize(ug.getStringBounder());
while (tokenizer.hasMoreTokens()) {
final String s = tokenizer.nextToken();
if (s.equals("\t")) {
final double remainder = x % tabSize;
x += tabSize - remainder;
} else {
final XDimension2D dim = ug.getStringBounder().calculateDimension(fontConfiguration.getFont(),
s);
final UText utext = UText.build(s, useFontConfiguration);
ug.apply(new UTranslate(x, ypos)).draw(utext);
x += dim.getWidth();
}
}
}
}
if (url != null)
ug.closeUrl();
}
private double getWidth(StringBounder stringBounder, String text) {
final StringTokenizer tokenizer = new StringTokenizer(text, "\t", true);
final double tabSize = getTabSize(stringBounder);
double x = 0;
while (tokenizer.hasMoreTokens()) {
final String s = tokenizer.nextToken();
if (s.equals("\t")) {
final double remainder = x % tabSize;
x += tabSize - remainder;
} else {
final XDimension2D dim = stringBounder.calculateDimension(fontConfiguration.getFont(), s);
x += dim.getWidth();
}
}
return x;
}
private String tabString() {
final int nb = fontConfiguration.getTabSize();
if (nb >= 1 && nb < 7)
return " ".substring(0, nb);
return " ";
}
private double getDescent(StringBounder stringBounder) {
return stringBounder.getDescent(fontConfiguration.getFont(), text);
}
private double getTabSize(StringBounder stringBounder) {
return stringBounder.calculateDimension(fontConfiguration.getFont(), tabString()).getWidth();
}
@Override
public final List getNeutrons() {
final List result = new ArrayList<>();
final StringBuilder pending = new StringBuilder();
for (int i = 0; i < text.length(); i++) {
final char ch = text.charAt(i);
if (pending.length() == 0) {
pending.append(ch);
continue;
}
final NeutronType pendingType = Neutron.getNeutronTypeFromChar(pending.charAt(0));
final NeutronType currentType = Neutron.getNeutronTypeFromChar(ch);
if (pendingType != currentType) {
addPending(result, pending.toString());
pending.setLength(0);
}
pending.append(ch);
// if (Neutron.isSentenceBoundary(ch) || Neutron.isChineseSentenceBoundary(ch))
if (Neutron.isChineseSentenceBoundary(ch)) {
addPending(result, pending.toString());
pending.setLength(0);
result.add(Neutron.zwspSeparator());
}
}
if (pending.length() > 0) {
addPending(result, pending.toString());
}
return result;
}
private void addPending(List result, String pending) {
final Neutron tmp = Neutron.create(withText(pending));
if (tmp.getType() == NeutronType.SPACE)
result.add(Neutron.zwspSeparator());
result.add(tmp);
if (tmp.getType() == NeutronType.SPACE)
result.add(Neutron.zwspSeparator());
}
public final String getText() {
return text;
}
public double getStartingAltitude(StringBounder stringBounder) {
return fontConfiguration.getSpace();
}
@Override
public String toString() {
return text + " " + fontConfiguration;
}
public FontConfiguration getFontConfiguration() {
return fontConfiguration;
}
}