CommandCreateState.java
/* ========================================================================
* 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/paypal
*
* This file is part of PlantUML.
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
* License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
*
* Original Author: Arnaud Roques
*
*
*/
package net.sourceforge.plantuml.statediagram.command;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.annotation.Explain;
import net.sourceforge.plantuml.classdiagram.command.CommandCreateClassMultilines;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.command.ParserPass;
import net.sourceforge.plantuml.command.SingleLineCommand2;
import net.sourceforge.plantuml.klimt.color.ColorParser;
import net.sourceforge.plantuml.klimt.color.ColorType;
import net.sourceforge.plantuml.klimt.color.Colors;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColorSet;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.plasma.Quark;
import net.sourceforge.plantuml.regex.IRegex;
import net.sourceforge.plantuml.regex.RegexConcat;
import net.sourceforge.plantuml.regex.RegexLeaf;
import net.sourceforge.plantuml.regex.RegexOptional;
import net.sourceforge.plantuml.regex.RegexOr;
import net.sourceforge.plantuml.regex.RegexResult;
import net.sourceforge.plantuml.statediagram.StateDiagram;
import net.sourceforge.plantuml.stereo.Stereogroup;
import net.sourceforge.plantuml.stereo.Stereotag;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.url.UrlBuilder;
import net.sourceforge.plantuml.url.UrlMode;
import net.sourceforge.plantuml.utils.LineLocation;
public class CommandCreateState extends SingleLineCommand2<StateDiagram> {
public CommandCreateState() {
super(getRegexConcat());
}
@Override
public boolean isEligibleFor(ParserPass pass) {
return pass == ParserPass.ONE || pass == ParserPass.TWO || pass == ParserPass.THREE;
}
private static IRegex getRegexConcat() {
return RegexConcat.build(CommandCreateState.class.getName(), RegexLeaf.start(), //
new RegexLeaf("state"), //
RegexLeaf.spaceOneOrMore(), //
new RegexOr(//
new RegexConcat(//
new RegexLeaf(1, "CODE1", "([%pLN_.]+)"), //
RegexLeaf.spaceOneOrMore(), //
new RegexLeaf("as"), //
RegexLeaf.spaceOneOrMore(), //
new RegexLeaf(1, "DISPLAY1", "[%g]([^%g]+)[%g]")), //
new RegexConcat(//
new RegexLeaf(1, "DISPLAY2", "[%g]([^%g]+)[%g]"), //
RegexLeaf.spaceOneOrMore(), //
new RegexLeaf("as"), //
RegexLeaf.spaceOneOrMore(), //
new RegexLeaf(1, "CODE2", "([%pLN_.]+)")), //
new RegexLeaf(1, "CODE3", "([%pLN_.]+)"), //
new RegexLeaf(1, "CODE4", "[%g]([^%g]+)[%g]")), //
RegexLeaf.spaceZeroOrMore(), //
new RegexLeaf(4, "TAGS1", Stereotag.pattern() + "?"), //
Stereogroup.optionalStereogroup(), //
new RegexLeaf(4, "TAGS2", Stereotag.pattern() + "?"), //
RegexLeaf.spaceZeroOrMore(), //
UrlBuilder.OPTIONAL, //
RegexLeaf.spaceZeroOrMore(), //
color().getRegex(), //
RegexLeaf.spaceZeroOrMore(), //
new RegexOptional(new RegexLeaf(2, "LINECOLOR", "##(?:\\[(dotted|dashed|bold)\\])?(\\w+)?")), //
RegexLeaf.spaceZeroOrMore(), //
new RegexOptional( //
new RegexConcat( //
new RegexLeaf(":"), //
RegexLeaf.spaceZeroOrMore(), //
new RegexLeaf(1, "ADDFIELD", "(.*)") //
)), RegexLeaf.end());
}
private static ColorParser color() {
return ColorParser.simpleColor(ColorType.BACK);
}
@Override
@Explain
protected String explainArg(LineLocation location, RegexResult arg) {
final StringBuilder sb = new StringBuilder();
// 'state Name' declares (or reuses) a state. The code and the display
// may be written in both orders or alone, hence the lazzy lookups,
// like in executeArg. Some stereotypes, like <<choice>> or <<fork>>,
// turn the state into the corresponding pseudo-state (see
// Stereogroup.getLeafType).
sb.append("Declaring the state '").append(arg.getLazzy("CODE", 0)).append("'");
final String display = arg.getLazzy("DISPLAY", 0);
if (display != null)
sb.append(" displayed as \"").append(display).append("\"");
final Stereogroup stereogroup = Stereogroup.build(arg);
if (stereogroup.isEmpty() == false) {
sb.append(", stereotyped ").append(arg.get("STEREOGROUP", 0));
final LeafType type = stereogroup.getLeafType();
if (type != null)
sb.append(" (pseudo-state type: ").append(StringUtils.goLowerCase(type.name()).replace('_', ' '))
.append(")");
}
// The stereotag may be written before or after the stereotypes
// (TAGS1/TAGS2), hence the lazzy lookup, like in executeArg.
final String tags = arg.getLazzy("TAGS", 0);
if (tags != null && tags.isEmpty() == false)
sb.append(", tagged ").append(tags);
if (arg.get(UrlBuilder.URL_KEY, 0) != null)
sb.append(", with a URL link");
if (arg.get("COLOR", 0) != null)
sb.append(", background color ").append(arg.get("COLOR", 0));
// '##[style]color' sets the border style and color.
if (arg.get("LINECOLOR", 1) != null)
sb.append(", line color ").append(arg.get("LINECOLOR", 1));
if (arg.get("LINECOLOR", 0) != null)
sb.append(", line style ").append(arg.get("LINECOLOR", 0));
final String addField = arg.get("ADDFIELD", 0);
if (addField != null && addField.isEmpty() == false)
sb.append(", with the description line \"").append(addField).append("\"");
return sb.toString();
}
@Override
protected CommandExecutionResult executeArg(StateDiagram diagram, LineLocation location, RegexResult arg,
ParserPass currentPass) throws NoSuchColorException {
final String idShort = arg.getLazzy("CODE", 0);
final Quark<Entity> quark = diagram.quarkInContext(true, diagram.cleanId(idShort));
String display = arg.getLazzy("DISPLAY", 0);
if (display == null)
display = quark.getName();
final Stereogroup stereogroup = Stereogroup.build(arg);
LeafType type = stereogroup.getLeafType();
if (type == null)
type = LeafType.STATE;
if (diagram.checkConcurrentStateOk(quark) == false)
return CommandExecutionResult.error("The state " + quark.getName()
+ " has been created in a concurrent state : it cannot be used here.");
Entity ent = quark.getData();
if (ent == null)
ent = diagram.reallyCreateLeaf(location, quark, Display.getWithNewlines(diagram.getPragma(), display), type,
null);
else
diagram.setLastEntity(ent);
diagram.ensureParentState(location, quark);
if (currentPass == ParserPass.ONE) {
ent.setDisplay(Display.getWithNewlines(diagram.getPragma(), display));
ent.setStereotype(stereogroup.buildStereotype());
final String urlString = arg.get(UrlBuilder.URL_KEY, 0);
if (urlString != null) {
final UrlBuilder urlBuilder = new UrlBuilder(diagram.getSkinParam().getValue("topurl"), UrlMode.STRICT);
final Url url = urlBuilder.getUrl(urlString);
ent.addUrl(url);
}
final HColorSet colorSet = diagram.getSkinParam().getIHtmlColorSet();
Colors colors = color().getColor(arg, colorSet);
final String s = arg.get("LINECOLOR", 1);
final HColor lineColor = s == null ? null : colorSet.getColor(s);
if (lineColor != null)
colors = colors.add(ColorType.LINE, lineColor);
if (arg.get("LINECOLOR", 0) != null)
colors = colors.addLegacyStroke(arg.get("LINECOLOR", 0));
colors = colors.mergeWith(stereogroup.getInnerColors(colorSet));
ent.setColors(colors);
final String addFields = arg.get("ADDFIELD", 0);
if (addFields != null)
ent.getBodier().addFieldOrMethod(addFields);
CommandCreateClassMultilines.addTags(ent, arg.getLazzy("TAGS", 0));
}
return CommandExecutionResult.ok();
}
}