UBrexCommandEndPartition.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.activitydiagram.command;

import java.util.Arrays;
import java.util.Collection;

import com.plantuml.ubrex.UnicodeBracketedExpression;
import com.plantuml.ubrex.builder.UBrexConcat;
import com.plantuml.ubrex.builder.UBrexLeaf;
import com.plantuml.ubrex.builder.UBrexOr;

import net.sourceforge.plantuml.activitydiagram.ActivityDiagram;
import net.sourceforge.plantuml.annotation.Explain;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.command.ParserPass;
import net.sourceforge.plantuml.command.UBrexSingleLineCommand2;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
import net.sourceforge.plantuml.regex.RegexResult;
import net.sourceforge.plantuml.utils.LineLocation;

public class UBrexCommandEndPartition extends UBrexSingleLineCommand2<ActivityDiagram> {

	private static final Collection<String> FIRST_TOKENS = Arrays.asList( //
			"end", "endpartition", "}");

	public UBrexCommandEndPartition() {
		super(getRegexConcat());
	}

	static UnicodeBracketedExpression getRegexConcat() {
		// UBrexLeaf.end() closes the whole expression. It used to sit inside the UBrexOr, as a
		// third alternative, which made a blank line a valid "end partition".
		return UBrexConcat.build(new UBrexOr( //
				UBrexConcat.build(new UBrexLeaf("end"), //
						UBrexLeaf.spaceZeroOrMore(), //
						new UBrexLeaf("partition")), //
				new UBrexLeaf("}")), //
				UBrexLeaf.end()); //
	}

	@Override
	@Explain
	protected String explainArg(LineLocation location, RegexResult arg) {
		// '}' (or 'end partition') closes the partition opened by the matching
		// 'partition Name {' command (executeArg fails if none is open).
		return "Closing the current partition";
	}

	@Override
	protected CommandExecutionResult executeArg(ActivityDiagram diagram, LineLocation location, RegexResult arg,
			ParserPass currentPass) throws NoSuchColorException {
		final boolean result = diagram.endGroup();
		if (result == false)
			return CommandExecutionResult.error("No partition defined");

		return CommandExecutionResult.ok();
	}

	// Declared by hand: FirstTokens only reads regex patterns, and this one is a UBrex expression.
	@Override
	public Collection<String> mandatoryFirstTokensSlow() {
		return FIRST_TOKENS;
	}

	@Override
	public Collection<String> mandatoryFirstTokensFast() {
		return FIRST_TOKENS;
	}

}