2013-12-10 19:36:50 +00:00
|
|
|
/* ========================================================================
|
|
|
|
* PlantUML : a free UML diagram generator
|
|
|
|
* ========================================================================
|
|
|
|
*
|
2016-01-09 12:15:40 +00:00
|
|
|
* (C) Copyright 2009-2017, Arnaud Roques
|
2013-12-10 19:36:50 +00:00
|
|
|
*
|
2016-03-06 16:47:34 +00:00
|
|
|
* Project Info: http://plantuml.com
|
2013-12-10 19:36:50 +00:00
|
|
|
*
|
2017-03-15 19:13:31 +00:00
|
|
|
* If you like this project or if you find it useful, you can support us at:
|
|
|
|
*
|
|
|
|
* http://plantuml.com/patreon (only 1$ per month!)
|
|
|
|
* http://plantuml.com/paypal
|
|
|
|
*
|
2013-12-10 19:36:50 +00:00
|
|
|
* 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.command;
|
|
|
|
|
|
|
|
import java.util.ArrayList;
|
|
|
|
import java.util.Arrays;
|
|
|
|
import java.util.Collections;
|
|
|
|
import java.util.List;
|
|
|
|
|
|
|
|
import net.sourceforge.plantuml.AbstractPSystem;
|
2015-06-20 10:54:49 +00:00
|
|
|
import net.sourceforge.plantuml.CharSequence2;
|
2013-12-10 19:36:50 +00:00
|
|
|
import net.sourceforge.plantuml.ErrorUml;
|
|
|
|
import net.sourceforge.plantuml.ErrorUmlType;
|
2016-01-09 12:15:40 +00:00
|
|
|
import net.sourceforge.plantuml.NewpagedDiagram;
|
2013-12-10 19:36:50 +00:00
|
|
|
import net.sourceforge.plantuml.OptionFlags;
|
|
|
|
import net.sourceforge.plantuml.PSystemError;
|
2015-05-31 18:56:03 +00:00
|
|
|
import net.sourceforge.plantuml.StringUtils;
|
2016-11-04 21:39:29 +00:00
|
|
|
import net.sourceforge.plantuml.classdiagram.command.CommandHideShowByGender;
|
|
|
|
import net.sourceforge.plantuml.classdiagram.command.CommandHideShowByVisibility;
|
2013-12-10 19:36:50 +00:00
|
|
|
import net.sourceforge.plantuml.core.Diagram;
|
|
|
|
import net.sourceforge.plantuml.core.DiagramType;
|
|
|
|
import net.sourceforge.plantuml.core.UmlSource;
|
|
|
|
import net.sourceforge.plantuml.suggest.SuggestEngine;
|
|
|
|
import net.sourceforge.plantuml.suggest.SuggestEngineResult;
|
|
|
|
import net.sourceforge.plantuml.suggest.SuggestEngineStatus;
|
2015-04-07 18:18:37 +00:00
|
|
|
import net.sourceforge.plantuml.utils.StartUtils;
|
2015-06-20 10:54:49 +00:00
|
|
|
import net.sourceforge.plantuml.version.IteratorCounter2;
|
2013-12-10 19:36:50 +00:00
|
|
|
|
|
|
|
public abstract class UmlDiagramFactory extends PSystemAbstractFactory {
|
|
|
|
|
|
|
|
private final List<Command> cmds;
|
|
|
|
|
|
|
|
protected UmlDiagramFactory() {
|
|
|
|
this(DiagramType.UML);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected UmlDiagramFactory(DiagramType type) {
|
|
|
|
super(type);
|
|
|
|
cmds = createCommands();
|
|
|
|
}
|
|
|
|
|
|
|
|
final public Diagram createSystem(UmlSource source) {
|
2015-06-20 10:54:49 +00:00
|
|
|
final IteratorCounter2 it = source.iterator2();
|
|
|
|
final CharSequence2 startLine = it.next();
|
2013-12-10 19:36:50 +00:00
|
|
|
if (StartUtils.isArobaseStartDiagram(startLine) == false) {
|
|
|
|
throw new UnsupportedOperationException();
|
|
|
|
}
|
|
|
|
|
|
|
|
if (source.isEmpty()) {
|
2015-06-20 10:54:49 +00:00
|
|
|
return buildEmptyError(source, startLine.getLocation());
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
|
|
|
AbstractPSystem sys = createEmptyDiagram();
|
|
|
|
|
|
|
|
while (it.hasNext()) {
|
2015-05-31 18:56:03 +00:00
|
|
|
if (StartUtils.isArobaseEndDiagram(it.peek())) {
|
2016-05-31 19:41:55 +00:00
|
|
|
if (sys == null) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
final String err = sys.checkFinalError();
|
2013-12-10 19:36:50 +00:00
|
|
|
if (err != null) {
|
2017-06-05 11:27:21 +00:00
|
|
|
return buildExecutionError(source, err, it.peek().getLocation());
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
|
|
|
if (source.getTotalLineCount() == 2) {
|
2015-06-20 10:54:49 +00:00
|
|
|
return buildEmptyError(source, it.peek().getLocation());
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
|
|
|
sys.makeDiagramReady();
|
|
|
|
if (sys.isOk() == false) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
sys.setSource(source);
|
|
|
|
return sys;
|
|
|
|
}
|
2015-05-31 18:56:03 +00:00
|
|
|
sys = executeOneLine(sys, source, it);
|
2013-12-10 19:36:50 +00:00
|
|
|
if (sys instanceof PSystemError) {
|
|
|
|
return sys;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
sys.setSource(source);
|
|
|
|
return sys;
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2015-06-20 10:54:49 +00:00
|
|
|
private AbstractPSystem executeOneLine(AbstractPSystem sys, UmlSource source, final IteratorCounter2 it) {
|
2015-05-31 18:56:03 +00:00
|
|
|
final CommandControl commandControl = isValid2(it);
|
2013-12-10 19:36:50 +00:00
|
|
|
if (commandControl == CommandControl.NOT_OK) {
|
2017-06-05 11:27:21 +00:00
|
|
|
final ErrorUml err = new ErrorUml(ErrorUmlType.SYNTAX_ERROR, "Syntax Error?", /* it.currentNum(), */it.peek()
|
2015-06-20 10:54:49 +00:00
|
|
|
.getLocation());
|
2017-11-20 16:10:36 +00:00
|
|
|
if (OptionFlags.getInstance().isUseSuggestEngine2()) {
|
2013-12-10 19:36:50 +00:00
|
|
|
final SuggestEngine engine = new SuggestEngine(source, this);
|
|
|
|
final SuggestEngineResult result = engine.tryToSuggest(sys);
|
|
|
|
if (result.getStatus() == SuggestEngineStatus.ONE_SUGGESTION) {
|
|
|
|
err.setSuggest(result);
|
|
|
|
}
|
|
|
|
}
|
2015-05-31 18:56:03 +00:00
|
|
|
sys = new PSystemError(source, err, null);
|
2013-12-10 19:36:50 +00:00
|
|
|
} else if (commandControl == CommandControl.OK_PARTIAL) {
|
2015-06-20 10:54:49 +00:00
|
|
|
final IteratorCounter2 saved = it.cloneMe();
|
2015-08-05 20:17:01 +00:00
|
|
|
final CommandExecutionResult result = manageMultiline2(it, sys);
|
|
|
|
if (result.isOk() == false) {
|
2017-06-05 11:27:21 +00:00
|
|
|
final ErrorUml err = new ErrorUml(ErrorUmlType.EXECUTION_ERROR, result.getError(),
|
|
|
|
/* it.currentNum() - 1, */saved.next().getLocation());
|
|
|
|
sys = new PSystemError(source, err, null);
|
2013-12-10 19:36:50 +00:00
|
|
|
|
|
|
|
}
|
|
|
|
} else if (commandControl == CommandControl.OK) {
|
2015-06-20 10:54:49 +00:00
|
|
|
final CharSequence line = it.next();
|
|
|
|
final BlocLines lines = BlocLines.single(line);
|
|
|
|
Command cmd = getFirstCommandOkForLines(lines);
|
|
|
|
final CommandExecutionResult result = sys.executeCommand(cmd, lines);
|
2013-12-10 19:36:50 +00:00
|
|
|
if (result.isOk() == false) {
|
2017-06-05 11:27:21 +00:00
|
|
|
final ErrorUml err = new ErrorUml(ErrorUmlType.EXECUTION_ERROR, result.getError(),
|
|
|
|
/* it.currentNum() - 1, */((CharSequence2) line).getLocation());
|
|
|
|
sys = new PSystemError(source, err,
|
|
|
|
result.getDebugLines());
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
|
|
|
if (result.getNewDiagram() != null) {
|
|
|
|
sys = result.getNewDiagram();
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
assert false;
|
|
|
|
}
|
|
|
|
return sys;
|
|
|
|
}
|
|
|
|
|
2015-06-20 10:54:49 +00:00
|
|
|
public CommandControl isValid2(final IteratorCounter2 it) {
|
|
|
|
final BlocLines lines = BlocLines.single(it.peek());
|
2015-05-31 18:56:03 +00:00
|
|
|
for (Command cmd : cmds) {
|
2015-06-20 10:54:49 +00:00
|
|
|
final CommandControl result = cmd.isValid(lines);
|
2015-05-31 18:56:03 +00:00
|
|
|
if (result == CommandControl.OK) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
if (result == CommandControl.OK_PARTIAL && isMultilineCommandOk(it.cloneMe(), cmd) != null) {
|
|
|
|
return result;
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
2015-05-31 18:56:03 +00:00
|
|
|
}
|
|
|
|
return CommandControl.NOT_OK;
|
|
|
|
}
|
|
|
|
|
2015-06-20 10:54:49 +00:00
|
|
|
public CommandControl goForwardMultiline(final IteratorCounter2 it) {
|
|
|
|
final BlocLines lines = BlocLines.single(it.peek());
|
2015-05-31 18:56:03 +00:00
|
|
|
for (Command cmd : cmds) {
|
2015-06-20 10:54:49 +00:00
|
|
|
final CommandControl result = cmd.isValid(lines);
|
2015-05-31 18:56:03 +00:00
|
|
|
if (result == CommandControl.OK) {
|
|
|
|
throw new IllegalStateException();
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
2015-05-31 18:56:03 +00:00
|
|
|
if (result == CommandControl.OK_PARTIAL && isMultilineCommandOk(it, cmd) != null) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
}
|
2015-09-06 17:28:59 +00:00
|
|
|
return CommandControl.NOT_OK;
|
|
|
|
// throw new IllegalStateException();
|
2015-05-31 18:56:03 +00:00
|
|
|
}
|
|
|
|
|
2015-08-05 20:17:01 +00:00
|
|
|
private CommandExecutionResult manageMultiline2(IteratorCounter2 it, AbstractPSystem system) {
|
2015-05-31 18:56:03 +00:00
|
|
|
for (Command cmd : cmds) {
|
|
|
|
if (isMultilineCommandOk(it.cloneMe(), cmd) != null) {
|
2015-06-20 10:54:49 +00:00
|
|
|
final BlocLines lines = isMultilineCommandOk(it, cmd);
|
2016-01-09 12:15:40 +00:00
|
|
|
if (system instanceof NewpagedDiagram) {
|
|
|
|
final NewpagedDiagram newpagedDiagram = (NewpagedDiagram) system;
|
|
|
|
return cmd.execute(newpagedDiagram.getLastDiagram(), lines);
|
2016-05-31 19:41:55 +00:00
|
|
|
|
2016-01-09 12:15:40 +00:00
|
|
|
}
|
2015-08-05 20:17:01 +00:00
|
|
|
return cmd.execute(system, lines);
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
|
|
|
}
|
2015-08-05 20:17:01 +00:00
|
|
|
return CommandExecutionResult.ok();
|
2015-05-31 18:56:03 +00:00
|
|
|
}
|
2013-12-10 19:36:50 +00:00
|
|
|
|
2015-06-20 10:54:49 +00:00
|
|
|
private BlocLines isMultilineCommandOk(IteratorCounter2 it, Command cmd) {
|
|
|
|
BlocLines lines = new BlocLines();
|
2016-05-31 19:41:55 +00:00
|
|
|
int nb = 0;
|
2015-05-31 18:56:03 +00:00
|
|
|
while (it.hasNext()) {
|
2015-06-20 10:54:49 +00:00
|
|
|
lines = addOneSingleLineManageEmbedded2(it, lines);
|
2015-05-31 18:56:03 +00:00
|
|
|
final CommandControl result = cmd.isValid(lines);
|
|
|
|
if (result == CommandControl.NOT_OK) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
if (result == CommandControl.OK) {
|
|
|
|
return lines;
|
|
|
|
}
|
2016-05-31 19:41:55 +00:00
|
|
|
nb++;
|
|
|
|
if (cmd instanceof CommandDecoratorMultine && nb > ((CommandDecoratorMultine) cmd).getNbMaxLines()) {
|
|
|
|
return null;
|
|
|
|
}
|
2015-05-31 18:56:03 +00:00
|
|
|
}
|
|
|
|
return null;
|
2013-12-10 19:36:50 +00:00
|
|
|
}
|
|
|
|
|
2015-06-20 10:54:49 +00:00
|
|
|
private BlocLines addOneSingleLineManageEmbedded2(IteratorCounter2 it, BlocLines lines) {
|
|
|
|
final CharSequence linetoBeAdded = it.next();
|
|
|
|
lines = lines.add2(linetoBeAdded);
|
2015-05-31 18:56:03 +00:00
|
|
|
if (StringUtils.trinNoTrace(linetoBeAdded).equals("{{")) {
|
2015-04-07 18:18:37 +00:00
|
|
|
while (it.hasNext()) {
|
2015-06-20 10:54:49 +00:00
|
|
|
final CharSequence s = it.next();
|
|
|
|
lines = lines.add2(s);
|
2015-05-31 18:56:03 +00:00
|
|
|
if (StringUtils.trinNoTrace(s).equals("}}")) {
|
2015-06-20 10:54:49 +00:00
|
|
|
return lines;
|
2015-04-07 18:18:37 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2015-06-20 10:54:49 +00:00
|
|
|
return lines;
|
2015-04-07 18:18:37 +00:00
|
|
|
}
|
|
|
|
|
2013-12-10 19:36:50 +00:00
|
|
|
// -----------------------------------
|
|
|
|
|
2015-06-20 10:54:49 +00:00
|
|
|
final public CommandControl isValid(BlocLines lines) {
|
2013-12-10 19:36:50 +00:00
|
|
|
for (Command cmd : cmds) {
|
|
|
|
final CommandControl result = cmd.isValid(lines);
|
2015-05-31 18:56:03 +00:00
|
|
|
if (result == CommandControl.OK) {
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
if (result == CommandControl.OK_PARTIAL) {
|
2013-12-10 19:36:50 +00:00
|
|
|
return result;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return CommandControl.NOT_OK;
|
|
|
|
|
|
|
|
}
|
|
|
|
|
2015-06-20 10:54:49 +00:00
|
|
|
private Command getFirstCommandOkForLines(BlocLines lines) {
|
2013-12-10 19:36:50 +00:00
|
|
|
for (Command cmd : cmds) {
|
|
|
|
final CommandControl result = cmd.isValid(lines);
|
|
|
|
if (result == CommandControl.OK) {
|
|
|
|
return cmd;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
throw new IllegalArgumentException();
|
|
|
|
}
|
|
|
|
|
|
|
|
protected abstract List<Command> createCommands();
|
|
|
|
|
|
|
|
public abstract AbstractPSystem createEmptyDiagram();
|
|
|
|
|
|
|
|
final protected void addCommonCommands(List<Command> cmds) {
|
|
|
|
cmds.add(new CommandNope());
|
2017-12-11 21:02:10 +00:00
|
|
|
// cmds.add(new CommandComment());
|
|
|
|
// cmds.add(new CommandMultilinesComment());
|
2013-12-10 19:36:50 +00:00
|
|
|
cmds.add(new CommandPragma());
|
|
|
|
cmds.add(new CommandTitle());
|
2016-01-30 12:20:07 +00:00
|
|
|
cmds.add(new CommandCaption());
|
2013-12-10 19:36:50 +00:00
|
|
|
cmds.add(new CommandMultilinesTitle());
|
|
|
|
cmds.add(new CommandMultilinesLegend());
|
|
|
|
|
|
|
|
cmds.add(new CommandFooter());
|
|
|
|
cmds.add(new CommandMultilinesFooter());
|
|
|
|
|
|
|
|
cmds.add(new CommandHeader());
|
|
|
|
cmds.add(new CommandMultilinesHeader());
|
|
|
|
|
|
|
|
cmds.add(new CommandSkinParam());
|
|
|
|
cmds.add(new CommandSkinParamMultilines());
|
|
|
|
cmds.add(new CommandMinwidth());
|
|
|
|
cmds.add(new CommandRotate());
|
|
|
|
cmds.add(new CommandScale());
|
|
|
|
cmds.add(new CommandScaleWidthAndHeight());
|
|
|
|
cmds.add(new CommandScaleWidthOrHeight());
|
2016-02-07 21:13:01 +00:00
|
|
|
cmds.add(new CommandScaleMaxWidth());
|
|
|
|
cmds.add(new CommandScaleMaxHeight());
|
2015-09-06 17:28:59 +00:00
|
|
|
cmds.add(new CommandScaleMaxWidthAndHeight());
|
2015-04-07 18:18:37 +00:00
|
|
|
cmds.add(new CommandAffineTransform());
|
|
|
|
cmds.add(new CommandAffineTransformMultiline());
|
2013-12-10 19:36:50 +00:00
|
|
|
cmds.add(new CommandHideUnlinked());
|
|
|
|
final FactorySpriteCommand factorySpriteCommand = new FactorySpriteCommand();
|
2015-09-06 17:28:59 +00:00
|
|
|
cmds.add(factorySpriteCommand.createMultiLine(false));
|
2013-12-10 19:36:50 +00:00
|
|
|
cmds.add(factorySpriteCommand.createSingleLine());
|
|
|
|
cmds.add(new CommandSpriteFile());
|
2015-05-31 18:56:03 +00:00
|
|
|
|
2016-11-04 21:39:29 +00:00
|
|
|
cmds.add(new CommandHideShowByVisibility());
|
|
|
|
cmds.add(new CommandHideShowByGender());
|
2013-12-10 19:36:50 +00:00
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
final public List<String> getDescription() {
|
|
|
|
final List<String> result = new ArrayList<String>();
|
|
|
|
for (Command cmd : createCommands()) {
|
|
|
|
result.addAll(Arrays.asList(cmd.getDescription()));
|
|
|
|
}
|
|
|
|
return Collections.unmodifiableList(result);
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|