net.sourceforge.plantuml.tim.Eater 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.tim;
import java.util.ArrayList;
import java.util.List;
import net.sourceforge.plantuml.json.Json;
import net.sourceforge.plantuml.json.JsonValue;
import net.sourceforge.plantuml.text.StringLocated;
import net.sourceforge.plantuml.text.TLineType;
import net.sourceforge.plantuml.tim.expression.TValue;
import net.sourceforge.plantuml.tim.expression.Token;
import net.sourceforge.plantuml.tim.expression.TokenStack;
import net.sourceforge.plantuml.tim.expression.TokenType;
import net.sourceforge.plantuml.utils.LineLocation;
public abstract class Eater {
private int i = 0;
private final String s;
private final LineLocation lineLocation;
public Eater(StringLocated sl) {
this(sl.getString(), sl.getLocation());
}
protected Eater(String s, LineLocation lineLocation) {
this.s = s;
this.lineLocation = lineLocation;
}
public final LineLocation getLineLocation() {
return lineLocation;
}
public abstract void analyze(TContext context, TMemory memory) throws EaterException, EaterExceptionLocated;
public int getCurrentPosition() {
return i;
}
final protected String eatAllToEnd() throws EaterException {
final String result = s.substring(i);
i = s.length();
return result;
}
final public TValue eatExpression(TContext context, TMemory memory) throws EaterException, EaterExceptionLocated {
final char ch = peekChar();
if (ch == '{' || ch == '[') {
final String data = eatAllToEnd();
// System.err.println("data=" + data);
final JsonValue json = Json.parse(data);
// System.err.println("json=" + json);
return TValue.fromJson(json);
}
final TokenStack tokenStack = eatTokenStack();
return tokenStack.getResult(getLineLocation(), context, memory);
}
final protected TokenStack eatTokenStack() throws EaterException {
final TokenStack tokenStack = new TokenStack();
addIntoTokenStack(tokenStack, false);
if (tokenStack.size() == 0)
throw EaterException.located("Missing expression");
return tokenStack;
}
final protected TValue eatExpressionStopAtColon(TContext context, TMemory memory)
throws EaterException, EaterExceptionLocated {
final TokenStack tokenStack = new TokenStack();
addIntoTokenStack(tokenStack, true);
return tokenStack.getResult(getLineLocation(), context, memory);
}
final protected void addIntoTokenStack(TokenStack tokenStack, boolean stopAtColon) throws EaterException {
Token lastToken = null;
while (true) {
final Token token = TokenType.eatOneToken(lastToken, this, stopAtColon);
if (token == null)
return;
tokenStack.add(token);
if (token.getTokenType() != TokenType.SPACES)
lastToken = token;
}
}
final public String eatAndGetQuotedString() throws EaterException {
final char separator = peekChar();
if (TLineType.isQuote(separator) == false)
throw EaterException.located("quote10");
checkAndEatChar(separator);
final StringBuilder value = new StringBuilder();
addUpTo(separator, value);
checkAndEatChar(separator);
return value.toString();
}
final protected String eatAndGetOptionalQuotedString() throws EaterException {
final char quote = peekChar();
if (TLineType.isQuote(quote))
return eatAndGetQuotedString();
final StringBuilder value = new StringBuilder();
// DEPLICATE eatUntilCloseParenthesisOrComma
int level = 0;
while (true) {
char ch = peekChar();
if (ch == 0)
throw EaterException.located("until001");
if (level == 0 && (ch == ',' || ch == ')'))
return value.toString().trim();
ch = eatOneChar();
if (ch == '(')
level++;
else if (ch == ')')
level--;
value.append(ch);
}
// addUpTo(',', ')', value);
// return value.toString();
}
final public String eatAndGetNumber() throws EaterException {
final StringBuilder result = new StringBuilder();
while (true) {
final char ch = peekChar();
if (result.length() == 0 && ch == '-') {
result.append(eatOneChar());
continue;
}
if (ch == 0 || TLineType.isLatinDigit(ch) == false)
return result.toString();
result.append(eatOneChar());
}
}
final public String eatAndGetSpaces() throws EaterException {
final StringBuilder result = new StringBuilder();
while (true) {
final char ch = peekChar();
if (ch == 0 || TLineType.isSpaceChar(ch) == false)
return result.toString();
result.append(eatOneChar());
}
}
final protected String eatAndGetVarname() throws EaterException {
final StringBuilder varname = new StringBuilder("" + eatOneChar());
if (TLineType.isLetterOrUnderscoreOrDollar(varname.charAt(0)) == false)
throw EaterException.located("a002");
addUpToLastLetterOrUnderscoreOrDigit(varname);
return varname.toString();
}
final protected String eatAndGetFunctionName() throws EaterException {
final StringBuilder varname = new StringBuilder("" + eatOneChar());
if (TLineType.isLetterOrUnderscoreOrDollar(varname.charAt(0)) == false)
throw EaterException.located("a003");
addUpToLastLetterOrUnderscoreOrDigit(varname);
return varname.toString();
}
final public void skipSpaces() {
while (i < s.length() && Character.isWhitespace(s.charAt(i)))
i++;
}
final protected void skipUntilChar(char ch) {
while (i < s.length() && s.charAt(i) != ch)
i++;
}
final public char peekChar() {
if (i >= s.length())
return 0;
return s.charAt(i);
}
final public boolean matchAffectation() {
final String tmp = s.substring(i);
final boolean result = tmp.matches("^\\$?[_\\p{L}][_\\p{L}0-9]*\\s*=.*");
return result;
}
final public char peekCharN2() {
if (i + 1 >= s.length())
return 0;
return s.charAt(i + 1);
}
final protected boolean hasNextChar() {
return i < s.length();
}
final public char eatOneChar() {
final char ch = s.charAt(i);
i++;
return ch;
}
final protected void checkAndEatChar(char ch) throws EaterException {
if (i >= s.length() || s.charAt(i) != ch)
throw EaterException.located("a001");
i++;
}
final protected boolean safeCheckAndEatChar(char ch) throws EaterException {
if (i >= s.length() || s.charAt(i) != ch)
return false;
i++;
return true;
}
final protected void optionallyEatChar(char ch) throws EaterException {
if (i >= s.length() || s.charAt(i) != ch)
return;
assert s.charAt(i) == ch;
i++;
}
final protected void checkAndEatChar(String s) throws EaterException {
for (int j = 0; j < s.length(); j++)
checkAndEatChar(s.charAt(j));
}
final protected void addUpToLastLetterOrUnderscoreOrDigit(StringBuilder sb) {
while (i < s.length()) {
final char ch = s.charAt(i);
if (TLineType.isLetterOrUnderscoreOrDigit(ch) == false)
return;
i++;
sb.append(ch);
}
}
final protected void addUpTo(char separator, StringBuilder sb) {
while (i < s.length()) {
final char ch = peekChar();
if (ch == separator)
return;
i++;
sb.append(ch);
}
}
final protected TFunctionImpl eatDeclareFunction(TContext context, TMemory memory, boolean unquoted,
LineLocation location, boolean allowNoParenthesis, TFunctionType type)
throws EaterException, EaterExceptionLocated {
final List args = new ArrayList<>();
final String functionName = eatAndGetFunctionName();
skipSpaces();
if (safeCheckAndEatChar('(') == false) {
if (allowNoParenthesis)
return new TFunctionImpl(functionName, args, unquoted, type);
throw EaterException.located("Missing opening parenthesis");
}
while (true) {
skipSpaces();
char ch = peekChar();
if (TLineType.isLetterOrUnderscoreOrDollar(ch)) {
final String varname = eatAndGetVarname();
skipSpaces();
final TValue defValue;
if (peekChar() == '=') {
eatOneChar();
final TokenStack def = TokenStack.eatUntilCloseParenthesisOrComma(this);
def.guessFunctions();
defValue = def.getResult(getLineLocation(), context, memory);
// System.err.println("result=" + defValue);
} else {
defValue = null;
}
args.add(new TFunctionArgument(varname, defValue));
} else if (ch == ',') {
checkAndEatChar(',');
} else if (ch == ')') {
checkAndEatChar(")");
break;
} else {
throw EaterException.located("Error in function definition");
}
}
skipSpaces();
return new TFunctionImpl(functionName, args, unquoted, type);
}
final protected TFunctionImpl eatDeclareReturnFunctionWithOptionalReturn(TContext context, TMemory memory,
boolean unquoted, LineLocation location) throws EaterException, EaterExceptionLocated {
final TFunctionImpl result = eatDeclareFunction(context, memory, unquoted, location, false,
TFunctionType.RETURN_FUNCTION);
if (peekChar() == 'r') {
checkAndEatChar("return");
skipSpaces();
final String line = "!return " + eatAllToEnd();
result.addBody(new StringLocated(line, location));
} else if (peekChar() == '!') {
checkAndEatChar("!return");
skipSpaces();
final String line = "!return " + eatAllToEnd();
result.addBody(new StringLocated(line, location));
}
return result;
}
final protected TFunctionImpl eatDeclareProcedure(TContext context, TMemory memory, boolean unquoted,
LineLocation location) throws EaterException, EaterExceptionLocated {
final TFunctionImpl result = eatDeclareFunction(context, memory, unquoted, location, false,
TFunctionType.PROCEDURE);
return result;
}
}