net.sourceforge.plantuml.command.CommandMultilines3 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.command;
import net.sourceforge.plantuml.core.Diagram;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
import net.sourceforge.plantuml.regex.IRegex;
import net.sourceforge.plantuml.regex.RegexConcat;
import net.sourceforge.plantuml.text.StringLocated;
import net.sourceforge.plantuml.utils.BlocLines;
public abstract class CommandMultilines3 implements Command {
private final IRegex starting;
private final MultilinesStrategy strategy;
private final Trim trimEnd;
public CommandMultilines3(IRegex patternStart, MultilinesStrategy strategy, Trim trimEnd) {
if (patternStart.getPattern().startsWith("^") == false || patternStart.getPattern().endsWith("$") == false)
throw new IllegalArgumentException("Bad pattern " + patternStart.getPattern());
this.strategy = strategy;
this.starting = patternStart;
this.trimEnd = trimEnd;
}
public abstract RegexConcat getPatternEnd2();
public String[] getDescription() {
return new String[] { "START: " + starting.getPattern(), "END: " + getPatternEnd2().getPattern() };
}
final public CommandControl isValid(BlocLines lines) {
lines = lines.cleanList(strategy);
if (isCommandForbidden())
return CommandControl.NOT_OK;
final StringLocated first = lines.getFirst();
if (first == null)
return CommandControl.NOT_OK;
final boolean result1 = starting.match(first.getTrimmed());
if (result1 == false)
return CommandControl.NOT_OK;
if (lines.size() == 1)
return CommandControl.OK_PARTIAL;
final StringLocated potentialLast;
if (trimEnd == Trim.NONE)
potentialLast = lines.getLast();
else if (trimEnd == Trim.BOTH)
potentialLast = lines.getLast().getTrimmed();
else
throw new IllegalStateException();
final boolean m1 = getPatternEnd2().match(potentialLast);
if (m1 == false)
return CommandControl.OK_PARTIAL;
return finalVerification();
}
public final CommandExecutionResult execute(S system, BlocLines lines) throws NoSuchColorException {
lines = lines.cleanList(strategy);
return executeNow(system, lines);
}
protected abstract CommandExecutionResult executeNow(S system, BlocLines lines) throws NoSuchColorException;
protected boolean isCommandForbidden() {
return false;
}
protected CommandControl finalVerification() {
return CommandControl.OK;
}
protected final IRegex getStartingPattern() {
return starting;
}
}