CommandChartAnnotation.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:  David Fyfe
 *
 */
package net.sourceforge.plantuml.chart.command;

import net.sourceforge.plantuml.chart.ChartAnnotation;
import net.sourceforge.plantuml.chart.ChartDiagram;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.command.ParserPass;
import net.sourceforge.plantuml.command.SingleLineCommand2;
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.RegexResult;
import net.sourceforge.plantuml.utils.LineLocation;

/**
 * Command to parse annotation syntax:
 * annotation "text" at (xPos, yPos)
 * annotation "text" at (xPos, yPos) <<arrow>>
 */
public class CommandChartAnnotation extends SingleLineCommand2<ChartDiagram> {

	public CommandChartAnnotation() {
		super(false, getRegexConcat());
	}

	static IRegex getRegexConcat() {
		return RegexConcat.build(CommandChartAnnotation.class.getName(), RegexLeaf.start(), //
				new RegexLeaf("annotation"), //
				RegexLeaf.spaceOneOrMore(), //
				new RegexLeaf(1, "TEXT", "\"([^\"]+)\""), //
				RegexLeaf.spaceOneOrMore(), //
				new RegexLeaf("at"), //
				RegexLeaf.spaceZeroOrMore(), //
				new RegexLeaf("\\("), //
				RegexLeaf.spaceZeroOrMore(), //
				new RegexLeaf(1, "XPOS", "([^,]+)"), //
				RegexLeaf.spaceZeroOrMore(), //
				new RegexLeaf(","), //
				RegexLeaf.spaceZeroOrMore(), //
				new RegexLeaf(1, "YPOS", "([^)]+)"), //
				RegexLeaf.spaceZeroOrMore(), //
				new RegexLeaf("\\)"), //
				RegexLeaf.spaceZeroOrMore(), //
				new RegexOptional(new RegexLeaf(1, "ARROW", "<<(arrow)>>")), //
				RegexLeaf.end());
	}

	@Override
	protected CommandExecutionResult executeArg(ChartDiagram diagram, LineLocation location, RegexResult arg,
			ParserPass currentPass) {
		final String text = arg.get("TEXT", 0);
		final String xPosStr = arg.get("XPOS", 0).trim();
		final String yPosStr = arg.get("YPOS", 0).trim();
		final String arrowStr = arg.getLazzy("ARROW", 0);

		// Parse X position - can be either a string (categorical) or numeric
		Object xPosition;
		try {
			xPosition = Double.parseDouble(xPosStr);
		} catch (NumberFormatException e) {
			// Not a number, treat as categorical label
			xPosition = xPosStr;
		}

		// Parse Y position - must be numeric
		double yPosition;
		try {
			yPosition = Double.parseDouble(yPosStr);
		} catch (NumberFormatException e) {
			return CommandExecutionResult.error("Y position must be a numeric value: " + yPosStr);
		}

		final boolean showArrow = arrowStr != null;
		final ChartAnnotation annotation = new ChartAnnotation(text, xPosition, yPosition, showArrow);

		return diagram.addAnnotation(annotation);
	}
}