net.sourceforge.plantuml.preproc.Defines 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.preproc;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import net.sourceforge.plantuml.api.ApiWarning;
import net.sourceforge.plantuml.file.AParentFolder;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SecurityProfile;
import net.sourceforge.plantuml.security.SecurityUtils;
import net.sourceforge.plantuml.text.StringLocated;
import net.sourceforge.plantuml.tim.EaterException;
import net.sourceforge.plantuml.tim.TMemory;
import net.sourceforge.plantuml.tim.TVariableScope;
import net.sourceforge.plantuml.utils.Log;
import net.sourceforge.plantuml.version.Version;
public class Defines implements Truth {
private final Map environment = new LinkedHashMap();
private final Map values = new LinkedHashMap();
@Deprecated
@ApiWarning(willBeRemoved = "in next major release")
public Defines() {
environment.put("PLANTUML_VERSION", "" + Version.versionString());
}
@Override
public String toString() {
return values.keySet().toString() + " " + environment.keySet();
}
public static Defines createEmpty() {
return new Defines();
}
public void copyTo(TMemory memory, StringLocated location) throws EaterException {
for (Entry ent : values.entrySet()) {
final String name = ent.getKey();
final Define def = ent.getValue();
memory.putVariable(name, def.asTVariable(), TVariableScope.GLOBAL, location);
}
}
public void overrideFilename(String filename) {
if (filename != null) {
environment.put("filename", filename);
environment.put("filenameNoExtension", nameNoExtension(filename));
}
}
public void importFrom(Defines other) {
this.environment.putAll(other.environment);
this.values.putAll(other.values);
magic = null;
}
public Defines cloneMe() {
final Defines result = new Defines();
result.importFrom(this);
return result;
}
public static Defines createWithFileName(SFile file) {
Objects.requireNonNull(file);
final Defines result = createEmpty();
result.overrideFilename(file.getName());
result.environment.put("filedate", new Date(file.lastModified()).toString());
if (SecurityUtils.getSecurityProfile() == SecurityProfile.UNSECURE)
result.environment.put("dirpath",
file.getAbsoluteFile().getParentFile().getAbsolutePath().replace('\\', '/'));
return result;
}
public static Defines createWithFileName(java.io.File file) {
Objects.requireNonNull(file);
final Defines result = createEmpty();
result.overrideFilename(file.getName());
result.environment.put("filedate", new Date(file.lastModified()).toString());
if (SecurityUtils.getSecurityProfile() == SecurityProfile.UNSECURE)
result.environment.put("dirpath",
file.getAbsoluteFile().getParentFile().getAbsolutePath().replace('\\', '/'));
return result;
}
private static Defines createWithMap(Map init) {
final Defines result = createEmpty();
for (Map.Entry ent : init.entrySet()) {
result.environment.put(ent.getKey(), ent.getValue());
}
return result;
}
public String getEnvironmentValue(String key) {
return this.environment.get(key);
}
private static String nameNoExtension(String name) {
final int x = name.lastIndexOf('.');
if (x == -1)
return name;
return name.substring(0, x);
}
public void define(String name, List value, boolean emptyParentheses, AParentFolder currentDir) {
values.put(name, new Define(name, value, emptyParentheses, currentDir));
magic = null;
}
public boolean isDefine(String expression) {
try {
final EvalBoolean eval = new EvalBoolean(expression, this);
return eval.eval();
} catch (IllegalArgumentException e) {
Log.info("Error in " + expression);
return false;
}
}
public boolean isTrue(String name) {
for (String key : values.keySet())
if (key.equals(name) || key.startsWith(name + "("))
return true;
return false;
}
public void undefine(String name) {
values.remove(name);
magic = null;
}
public List applyDefines(String line) {
// System.err.println("line=" + line + " " + values.size());
line = manageDate(line);
line = manageEnvironment(line);
line = method1(line);
// line = values.size() < 10 ? method1(line) : method2(line);
return Arrays.asList(line.split("\n"));
}
private String method1(String line) {
for (Define def : values.values())
line = def.apply(line);
return line;
}
private Map> getAll() {
final Map> result = new LinkedHashMap>();
for (Define def : values.values()) {
Collection tmp = result.get(def.getFunctionName());
if (tmp == null) {
tmp = new ArrayList<>();
result.put(def.getFunctionName(), tmp);
}
tmp.add(def);
}
return result;
}
private Map> magic;
private String method2(String line) {
final Set words = words(line);
if (magic == null)
magic = getAll();
for (String w : words) {
Collection tmp = magic.get(w);
if (tmp == null)
continue;
for (Define def : tmp)
line = def.apply(line);
}
return line;
}
private Set words(String line) {
final String ID = "[A-Za-z_][A-Za-z_0-9]*";
Pattern p = Pattern.compile(ID);
Matcher m = p.matcher(line);
final Set words = new HashSet<>();
while (m.find())
words.add(m.group(0));
return words;
}
private String manageEnvironment(String line) {
for (Map.Entry ent : environment.entrySet()) {
final String key = Pattern.quote("%" + ent.getKey() + "%");
line = line.replaceAll(key, ent.getValue());
}
return line;
}
private static final String DATE = "(?i)%date(\\[(.+?)\\])?%";
private final static Pattern datePattern = Pattern.compile(DATE);
private String manageDate(String line) {
final Matcher m = datePattern.matcher(line);
if (m.find()) {
final String format = m.group(2);
String replace;
if (format == null) {
replace = new Date().toString();
} else {
try {
replace = new SimpleDateFormat(format).format(new Date());
} catch (Exception e) {
replace = "(BAD DATE PATTERN:" + format + ")";
}
}
line = line.replaceAll(DATE, replace);
}
return line;
}
}