CommandReferenceMultilinesOverSeveral.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.sequencediagram.command;

import java.util.ArrayList;
import java.util.List;

import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.command.CommandMultilines;
import net.sourceforge.plantuml.command.ParserPass;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.regex.Pattern2;
import net.sourceforge.plantuml.regex.RegexConcat;
import net.sourceforge.plantuml.regex.RegexLeaf;
import net.sourceforge.plantuml.regex.RegexOptional;
import net.sourceforge.plantuml.regex.RegexResult;
import net.sourceforge.plantuml.sequencediagram.Participant;
import net.sourceforge.plantuml.sequencediagram.Reference;
import net.sourceforge.plantuml.sequencediagram.SequenceDiagram;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.url.UrlBuilder;
import net.sourceforge.plantuml.url.UrlMode;
import net.sourceforge.plantuml.utils.BlocLines;

public class CommandReferenceMultilinesOverSeveral extends CommandMultilines<SequenceDiagram> {

	private static final RegexConcat REGEX_CONCAT = RegexConcat.build(
			CommandReferenceMultilinesOverSeveral.class.getName(), //
			RegexLeaf.start(), //
			new RegexLeaf("ref"), //
			new RegexLeaf(1, "REF", "(#\\w+)?"), //
			RegexLeaf.spaceOneOrMore(), //
			new RegexLeaf("over"), //
			RegexLeaf.spaceOneOrMore(), //
			new RegexLeaf(1, "PARTS", "((?:[%pLN_.@]+|[%g][^%g]+[%g])(?:[%s]*,[%s]*(?:[%pLN_.@]+|[%g][^%g]+[%g]))*)"), //
			RegexLeaf.spaceZeroOrMore(), //
			new RegexOptional(new RegexLeaf(1, UrlBuilder.URL_KEY, "(\\[\\[.*?\\]\\])")), //
			RegexLeaf.spaceZeroOrMore(), //
			new RegexLeaf(1, "UNUSED", "(#\\w+)?"), //
			RegexLeaf.end());

	public CommandReferenceMultilinesOverSeveral() {
		super(Pattern2.cmpile(REGEX_CONCAT.getPattern()),
				Pattern2.cmpile("^end[%s]?(ref)?$"));
	}

	@Override
	public String explain(BlocLines lines) {
		// CommandMultilines does not dispatch explain() to a helper like
		// CommandMultilines2.explainNow does, so it is overridden directly.
		// Mirror execute(): the first line carries the declaration, the lines
		// up to the closing 'end ref' are the text of the frame.
		final RegexResult arg = REGEX_CONCAT.matcher(lines.getFirst().getTrimmed().getString());
		if (arg == null)
			return "Drawing a reference frame";

		final StringBuilder sb = new StringBuilder();
		sb.append("Drawing a reference frame over ");
		final List<String> participants = StringUtils.splitComma(arg.get("PARTS", 0));
		for (int i = 0; i < participants.size(); i++) {
			if (i > 0)
				sb.append(i == participants.size() - 1 ? " and " : ", ");
			sb.append("'").append(StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(participants.get(i)))
					.append("'");
		}

		final String color = arg.get("REF", 0);
		if (color != null)
			sb.append(", background color ").append(color);

		if (arg.get(UrlBuilder.URL_KEY, 0) != null)
			sb.append(", with a URL link");

		// The trailing color is parsed but never applied by execute().
		final String unused = arg.get("UNUSED", 0);
		if (unused != null)
			sb.append(", second color ").append(unused).append(" (currently ignored)");

		// Body: the text lines between the 'ref over' line and 'end ref'.
		final int bodyCount = lines.size() > 2 ? lines.size() - 2 : 0;
		if (bodyCount > 0)
			sb.append(", with ").append(bodyCount).append(bodyCount == 1 ? " line" : " lines").append(" of text");

		return sb.toString();
	}

	public CommandExecutionResult execute(final SequenceDiagram diagram, BlocLines lines, ParserPass currentPass)
			throws NoSuchColorException {
		final String firstLine = lines.getFirst().getTrimmed().getString();
		final RegexResult arg = REGEX_CONCAT.matcher(firstLine);
		if (arg == null)
			return CommandExecutionResult.error("Cannot parse line " + firstLine);

		final String s1 = arg.get("REF", 0);
		final HColor backColorElement = s1 == null ? null : diagram.getSkinParam().getIHtmlColorSet().getColor(s1);
		// final HtmlColor backColorGeneral =
		// HtmlColorSetSimple.instance().getColorIfValid(line0.get(1));

		final List<String> participants = StringUtils.splitComma(arg.get("PARTS", 0));
		final List<Participant> p = new ArrayList<>();
		for (String s : participants)
			p.add(diagram.getOrCreateParticipant(lines.getLocation(),
					StringUtils.eventuallyRemoveStartingAndEndingDoubleQuote(s)));

		lines = lines.subExtract(1, 1);
		lines = lines.removeEmptyColumns();
		final Display strings = lines.toDisplay();

		final String url = arg.get(UrlBuilder.URL_KEY, 0);
		final UrlBuilder b = new UrlBuilder(diagram.getSkinParam().getValue("topurl"), UrlMode.STRICT);
		Url u = null;
		if (url != null)
			u = b.getUrl(url);

		final HColor backColorGeneral = null;
		final Reference ref = new Reference(p, u, strings, backColorGeneral, backColorElement,
				diagram.getSkinParam().getCurrentStyleBuilder());
		diagram.addReference(ref);
		return CommandExecutionResult.ok();
	}

}