net.sourceforge.plantuml.command.SingleLineCommand2 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.command;
import java.util.Objects;
import net.sourceforge.plantuml.core.Diagram;
import net.sourceforge.plantuml.error.PSystemError;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
import net.sourceforge.plantuml.regex.IRegex;
import net.sourceforge.plantuml.regex.RegexResult;
import net.sourceforge.plantuml.text.StringLocated;
import net.sourceforge.plantuml.utils.BlocLines;
import net.sourceforge.plantuml.utils.LineLocation;
public abstract class SingleLineCommand2 implements Command {
private final IRegex pattern;
private final boolean doTrim;
public SingleLineCommand2(IRegex pattern) {
this(true, pattern);
}
public SingleLineCommand2(boolean doTrim, IRegex pattern) {
this.doTrim = doTrim;
this.pattern = Objects.requireNonNull(pattern);
}
public boolean syntaxWithFinalBracket() {
return false;
}
public String[] getDescription() {
return new String[] { pattern.getClass().getName() };
}
private String myTrim(StringLocated s) {
if (doTrim)
return s.getTrimmed().getString();
return s.getString();
}
private StringLocated myTrim2(StringLocated s) {
if (doTrim)
return s.getTrimmed();
return s;
}
final public CommandControl isValid(BlocLines lines) {
if (lines.size() == 2 && syntaxWithFinalBracket())
return isValidBracket(lines);
if (lines.size() != 1)
return CommandControl.NOT_OK;
if (isCommandForbidden())
return CommandControl.NOT_OK;
final StringLocated line2 = myTrim2(lines.getFirst());
if (syntaxWithFinalBracket() && line2.getString().endsWith("{") == false) {
final String vline = lines.getAt(0).getString() + " {";
if (isValid(BlocLines.singleString(vline)) == CommandControl.OK)
return CommandControl.OK_PARTIAL;
return CommandControl.NOT_OK;
}
final boolean result = pattern.match(line2);
if (result)
return finalVerification();
return CommandControl.NOT_OK;
}
private CommandControl isValidBracket(BlocLines lines) {
assert lines.size() == 2;
assert syntaxWithFinalBracket();
if (myTrim(lines.getAt(1)).equals("{") == false)
return CommandControl.NOT_OK;
final String vline = lines.getAt(0).getString() + " {";
return isValid(BlocLines.singleString(vline));
}
protected boolean isCommandForbidden() {
return false;
}
protected CommandControl finalVerification() {
return CommandControl.OK;
}
public final CommandExecutionResult execute(S system, BlocLines lines) {
if (syntaxWithFinalBracket() && lines.size() == 2) {
assert myTrim(lines.getAt(1)).equals("{");
lines = BlocLines.singleString(lines.getFirst().getString() + " {");
}
if (lines.size() != 1)
throw new IllegalArgumentException();
final StringLocated first = lines.getFirst();
final String line = myTrim(first);
if (isForbidden(line))
return CommandExecutionResult.error("Syntax error: " + line);
final RegexResult arg = pattern.matcher(line);
if (arg == null)
return CommandExecutionResult.error("Cannot parse line " + line);
if (system instanceof PSystemError)
return CommandExecutionResult.error("PSystemError cannot be cast");
try {
return executeArg(system, first.getLocation(), arg);
} catch (NoSuchColorException e) {
return CommandExecutionResult.badColor();
}
}
protected boolean isForbidden(CharSequence line) {
return false;
}
protected abstract CommandExecutionResult executeArg(S system, LineLocation location, RegexResult arg)
throws NoSuchColorException;
}