net.sourceforge.plantuml.tim.TFunctionImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 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 GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.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 GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 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.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import net.sourceforge.plantuml.text.StringLocated;
import net.sourceforge.plantuml.text.TLineType;
import net.sourceforge.plantuml.tim.expression.TValue;
import net.sourceforge.plantuml.utils.LineLocation;
public class TFunctionImpl implements TFunction {
private final TFunctionSignature signature;
private final List args;
private final List body = new ArrayList<>();
private final boolean unquoted;
private /* final */ TFunctionType functionType;// = TFunctionType.VOID;
private String legacyDefinition;
private boolean containsReturn;
public TFunctionImpl(String functionName, List args, boolean unquoted,
TFunctionType functionType) {
final Set names = new HashSet<>();
for (TFunctionArgument tmp : args)
names.add(tmp.getName());
this.signature = new TFunctionSignature(functionName, args.size(), names);
this.args = args;
this.unquoted = unquoted;
this.functionType = functionType;
}
public boolean canCover(int nbArg, Set namedArguments) {
for (String n : namedArguments)
if (signature.getNamedArguments().contains(n) == false)
return false;
if (nbArg > args.size())
return false;
assert nbArg <= args.size();
int neededArgument = 0;
for (TFunctionArgument arg : args) {
if (namedArguments.contains(arg.getName()))
continue;
if (arg.getOptionalDefaultValue() == null)
neededArgument++;
}
if (nbArg < neededArgument)
return false;
assert nbArg >= neededArgument;
return true;
}
private TMemory getNewMemory(TMemory memory, List values, Map namedArguments) {
final Map result = new HashMap();
int ivalue = 0;
for (TFunctionArgument arg : args) {
final TValue value;
if (namedArguments.containsKey(arg.getName())) {
value = namedArguments.get(arg.getName());
} else if (ivalue < values.size()) {
value = values.get(ivalue);
ivalue++;
} else {
value = arg.getOptionalDefaultValue();
}
if (value == null)
throw new IllegalStateException();
result.put(arg.getName(), value);
}
return memory.forkFromGlobal(result);
}
@Override
public String toString() {
return "FUNCTION " + signature + " " + args;
}
public void addBody(StringLocated s) throws EaterExceptionLocated {
body.add(s);
if (s.getType() == TLineType.RETURN) {
this.containsReturn = true;
if (functionType == TFunctionType.PROCEDURE)
throw EaterExceptionLocated
.located("A procedure cannot have !return directive. Declare it as a function instead ?", s);
}
}
public void executeProcedure(TContext context, TMemory memory, LineLocation location, String s)
throws EaterException, EaterExceptionLocated {
final EaterFunctionCall call = new EaterFunctionCall(new StringLocated(s, location),
context.isLegacyDefine(signature.getFunctionName()), unquoted);
call.analyze(context, memory);
final String endOfLine = call.getEndOfLine();
final List args = call.getValues();
final Map named = call.getNamedArguments();
executeProcedureInternal(context, memory, args, named);
context.appendEndOfLine(endOfLine);
}
public void executeProcedureInternal(TContext context, TMemory memory, List args, Map named)
throws EaterException, EaterExceptionLocated {
if (functionType != TFunctionType.PROCEDURE && functionType != TFunctionType.LEGACY_DEFINELONG)
throw new IllegalStateException();
final TMemory copy = getNewMemory(memory, args, named);
context.executeLines(copy, body, TFunctionType.PROCEDURE, false);
}
public TValue executeReturnFunction(TContext context, TMemory memory, LineLocation location, List args,
Map named) throws EaterException, EaterExceptionLocated {
if (functionType == TFunctionType.LEGACY_DEFINE)
return executeReturnLegacyDefine(location, context, memory, args);
if (functionType != TFunctionType.RETURN_FUNCTION)
throw EaterException.unlocated("Illegal call here. Is there a return directive in your function?");
final TMemory copy = getNewMemory(memory, args, named);
final TValue result = context.executeLines(copy, body, TFunctionType.RETURN_FUNCTION, true);
if (result == null)
throw EaterException.unlocated("No return directive found in your function");
return result;
}
private TValue executeReturnLegacyDefine(LineLocation location, TContext context, TMemory memory, List args)
throws EaterException, EaterExceptionLocated {
if (legacyDefinition == null)
throw new IllegalStateException();
final TMemory copy = getNewMemory(memory, args, Collections.emptyMap());
final String tmp = context.applyFunctionsAndVariables(copy, location, legacyDefinition);
if (tmp == null)
return TValue.fromString("");
return TValue.fromString(tmp);
// eaterReturn.execute(context, copy);
// // System.err.println("s3=" + eaterReturn.getValue2());
// return eaterReturn.getValue2();
}
public final TFunctionType getFunctionType() {
return functionType;
}
public final TFunctionSignature getSignature() {
return signature;
}
// public void setFunctionType(TFunctionType type) {
// this.functionType = type;
// }
public void setLegacyDefinition(String legacyDefinition) {
this.legacyDefinition = legacyDefinition;
}
public boolean isUnquoted() {
return unquoted;
}
public boolean hasBody() {
return body.size() > 0;
}
public void finalizeEnddefinelong() {
if (functionType != TFunctionType.LEGACY_DEFINELONG)
throw new UnsupportedOperationException();
if (body.size() == 1) {
this.functionType = TFunctionType.LEGACY_DEFINE;
this.legacyDefinition = body.get(0).getString();
}
}
public final boolean doesContainReturn() {
return containsReturn;
}
}