net.sourceforge.plantuml.regexdiagram.PSystemRegex 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.regexdiagram;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Deque;
import java.util.List;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.TitledDiagram;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.core.DiagramDescription;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.ebnf.ETile;
import net.sourceforge.plantuml.ebnf.ETileAlternation;
import net.sourceforge.plantuml.ebnf.ETileBox;
import net.sourceforge.plantuml.ebnf.ETileConcatenation;
import net.sourceforge.plantuml.ebnf.ETileLookAheadOrBehind;
import net.sourceforge.plantuml.ebnf.ETileNamedGroup;
import net.sourceforge.plantuml.ebnf.ETileOneOrMore;
import net.sourceforge.plantuml.ebnf.ETileOptional;
import net.sourceforge.plantuml.ebnf.ETileZeroOrMore;
import net.sourceforge.plantuml.ebnf.Symbol;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColorSet;
import net.sourceforge.plantuml.klimt.color.HColors;
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.AbstractTextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.skin.UmlDiagramType;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.utils.BlocLines;
import net.sourceforge.plantuml.utils.CharInspector;
public class PSystemRegex extends TitledDiagram {
public PSystemRegex(UmlSource source) {
super(source, UmlDiagramType.REGEX, null);
final ISkinParam skinParam = getSkinParam();
this.style = ETile.getStyleSignature().getMergedStyle(skinParam.getCurrentStyleBuilder());
this.fontConfiguration = style.getFontConfiguration(skinParam.getIHtmlColorSet());
this.colorSet = skinParam.getIHtmlColorSet();
this.lineColor = style.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
}
public DiagramDescription getDescription() {
return new DiagramDescription("(Regular Expression)");
}
private final Deque stack = new ArrayDeque<>();
private final FontConfiguration fontConfiguration;
private final Style style;
private final HColorSet colorSet;
private final HColor lineColor;
// public CommandExecutionResult addBlocLines(BlocLines blines, String commentAbove, String commentBelow) {
// final boolean isCompact = getPragma().isDefine("compact");
// final CharIterator it = new CharIteratorImpl(blines);
// final EbnfExpression tmp1 = EbnfExpression.create(it, isCompact, commentAbove, commentBelow);
// if (tmp1.isEmpty())
// return CommandExecutionResult.error("Unparsable expression");
// expressions.add(tmp1);
// return CommandExecutionResult.ok();
//
// }
//
// public CommandExecutionResult addNote(final Display note, Colors colors) {
// expressions.add(new TextBlockable() {
// @Override
// public TextBlock getUDrawable(ISkinParam skinParam) {
// final FloatingNote f = FloatingNote.create(note, skinParam, SName.ebnf);
// return TextBlockUtils.withMargin(f, 0, 0, 5, 15);
// }
// });
// return CommandExecutionResult.ok();
// }
@Override
protected ImageData exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption)
throws IOException {
return createImageBuilder(fileFormatOption).drawable(getTextMainBlock(fileFormatOption)).write(os);
}
@Override
protected TextBlock getTextMainBlock(FileFormatOption fileFormatOption) {
// while (stack.size() > 1)
// concatenation();
final ETile peekFirst = stack.peekFirst();
final TextBlock tb = new AbstractTextBlock() {
@Override
public void drawU(UGraphic ug) {
peekFirst.drawU(ug.apply(HColors.BLACK));
}
@Override
public XDimension2D calculateDimension(StringBounder stringBounder) {
return peekFirst.calculateDimension(stringBounder);
}
};
return TextBlockUtils.addBackcolor(tb, null);
}
public CommandExecutionResult addBlocLines(BlocLines from) {
try {
final CharInspector it = from.inspector();
final List parsed1 = RegexExpression.parse(it);
// System.err.println("parsed1=" + parsed1);
final List parsed2 = addImplicitConcatenation(parsed1);
// System.err.println("parsed2=" + parsed2);
final ShuntingYard shuntingYard = new ShuntingYard(parsed2.iterator());
final List result = shuntingYard.getOuputQueue();
// System.err.println("result=" + result);
for (ReToken token : result)
if (token.getType() == ReTokenType.SIMPLE_CHAR)
push(token, Symbol.TERMINAL_STRING1);
else if (token.getType() == ReTokenType.ESCAPED_CHAR)
push(token, Symbol.TERMINAL_STRING1);
else if (token.getType() == ReTokenType.GROUP)
push(token, Symbol.SPECIAL_SEQUENCE);
else if (token.getType() == ReTokenType.LOOK_AHEAD)
lookAheadOrBehind(token.getData());
else if (token.getType() == ReTokenType.LOOK_BEHIND)
lookAheadOrBehind(token.getData());
else if (token.getType() == ReTokenType.NAMED_GROUP)
namedGroup(token.getData());
else if (token.getType() == ReTokenType.CLASS)
push(token, Symbol.LITTERAL);
else if (token.getType() == ReTokenType.ANCHOR)
push(token, Symbol.LITTERAL);
else if (token.getType() == ReTokenType.CONCATENATION_IMPLICIT)
concatenation();
else if (token.getType() == ReTokenType.ALTERNATIVE)
alternation();
else if (token.getType() == ReTokenType.QUANTIFIER && token.getData().startsWith("*"))
repetitionZeroOrMore(false);
else if (token.getType() == ReTokenType.QUANTIFIER && token.getData().startsWith("+"))
repetitionOneOrMore();
else if (token.getType() == ReTokenType.QUANTIFIER && token.getData().startsWith("?"))
optional();
else if (token.getType() == ReTokenType.QUANTIFIER && token.getData().startsWith("{"))
repetitionOneOrMore(token.getData());
else
throw new RegexParsingException(token.toString());
} catch (RegexParsingException ex) {
return CommandExecutionResult.error("Error parsing: " + ex.getMessage());
}
return CommandExecutionResult.ok();
}
private List addImplicitConcatenation(List list) {
final List result = new ArrayList<>();
for (ReToken token : list) {
if (result.size() > 0
&& ReTokenType.needImplicitConcatenation(result.get(result.size() - 1).getType(), token.getType()))
result.add(new ReToken(ReTokenType.CONCATENATION_IMPLICIT, ""));
result.add(token);
}
return result;
}
private void push(ReToken element, Symbol type) {
// final Symbol type = Symbol.LITTERAL;
stack.addFirst(new ETileBox(element.getData(), type, fontConfiguration, style, colorSet, getSkinParam()));
}
private void lookAheadOrBehind(String name) {
final ETile arg1 = stack.removeFirst();
stack.addFirst(new ETileLookAheadOrBehind(arg1, fontConfiguration, style, colorSet, name));
}
private void namedGroup(String name) {
final ETile arg1 = stack.removeFirst();
stack.addFirst(new ETileNamedGroup(arg1, fontConfiguration, colorSet, getSkinParam(), name));
}
private void repetitionZeroOrMore(boolean isCompact) {
final ETile arg1 = stack.removeFirst();
if (isCompact)
stack.addFirst(new ETileZeroOrMore(arg1));
else
stack.addFirst(new ETileOptional(new ETileOneOrMore(arg1), getSkinParam()));
}
private void optional() {
final ETile arg1 = stack.removeFirst();
stack.addFirst(new ETileOptional(arg1, getSkinParam()));
}
private void repetitionOneOrMore() {
final ETile arg1 = stack.removeFirst();
stack.addFirst(new ETileOneOrMore(arg1));
}
private void repetitionOneOrMore(String repetition) {
final ETile arg1 = stack.removeFirst();
stack.addFirst(new ETileOneOrMore(arg1, repetition, fontConfiguration.bigger(-2), getSkinParam()));
}
private void alternation() {
final ETile arg1 = stack.removeFirst();
final ETile arg2 = stack.removeFirst();
if (arg1 instanceof ETileAlternation) {
arg1.push(arg2);
stack.addFirst(arg1);
} else if (arg2 instanceof ETileAlternation) {
arg2.push(arg1);
stack.addFirst(arg2);
} else {
final ETile concat = new ETileAlternation();
concat.push(arg1);
concat.push(arg2);
stack.addFirst(concat);
}
}
private void concatenation() {
final ETile arg1 = stack.removeFirst();
final ETile arg2 = stack.removeFirst();
if (isBoxMergeable(arg1) && isBoxMergeable(arg2)) {
final ETileBox box1 = (ETileBox) arg1;
final ETileBox box2 = (ETileBox) arg2;
stack.addFirst(box2.mergeWith(box1));
return;
}
if (isConcatenation1Mergeable(arg1) && isBoxMergeable(arg2)) {
final ETileConcatenation concat1 = (ETileConcatenation) arg1;
final ETileBox box1 = (ETileBox) concat1.getFirst();
final ETileBox box2 = (ETileBox) arg2;
concat1.overideFirst(box2.mergeWith(box1));
stack.addFirst(concat1);
return;
}
if (arg1 instanceof ETileConcatenation) {
arg1.push(arg2);
stack.addFirst(arg1);
// This does not work for (A[B])(C)
// } else if (arg2 instanceof ETileConcatenation) {
// arg2.push(arg1);
// stack.addFirst(arg2);
} else {
final ETile concat = new ETileConcatenation();
concat.push(arg1);
concat.push(arg2);
stack.addFirst(concat);
}
}
private boolean isConcatenation1Mergeable(ETile tile) {
if (tile instanceof ETileConcatenation) {
final ETileConcatenation concat = (ETileConcatenation) tile;
return isBoxMergeable(concat.getFirst());
}
return false;
}
private boolean isBoxMergeable(ETile tile) {
if (tile instanceof ETileBox) {
final ETileBox box = (ETileBox) tile;
return box.getSymbol() == Symbol.TERMINAL_STRING1;
}
return false;
}
}