CommandChartHAxis.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 java.util.ArrayList;
import java.util.List;

import net.sourceforge.plantuml.chart.ChartAxis;
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.RegexResult;
import net.sourceforge.plantuml.utils.LineLocation;

public class CommandChartHAxis extends SingleLineCommand2<ChartDiagram> {

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

	static IRegex getRegexConcat() {
		return RegexConcat.build(CommandChartHAxis.class.getName(), RegexLeaf.start(), //
				new RegexLeaf("h-axis"), //
				RegexLeaf.spaceZeroOrMore(), //
				new net.sourceforge.plantuml.regex.RegexOptional(new RegexLeaf(1, "TITLE", "\"([^\"]+)\"")), //
				RegexLeaf.spaceZeroOrMore(), //
				new net.sourceforge.plantuml.regex.RegexOptional(new RegexLeaf(2, "RANGE", "(-?[0-9.]+)\\s*-->\\s*(-?[0-9.]+)")), //
				RegexLeaf.spaceZeroOrMore(), //
				new net.sourceforge.plantuml.regex.RegexOptional(new RegexLeaf(1, "DATA", "\\[(.*)\\]")), //
				RegexLeaf.spaceZeroOrMore(), //
				new net.sourceforge.plantuml.regex.RegexOptional(new net.sourceforge.plantuml.regex.RegexConcat( //
						new RegexLeaf("spacing"), //
						net.sourceforge.plantuml.regex.RegexLeaf.spaceOneOrMore(), //
						new RegexLeaf(1, "SPACING", "([0-9]+)"))), //
				RegexLeaf.spaceZeroOrMore(), //
				new net.sourceforge.plantuml.regex.RegexOptional(new RegexLeaf(1, "LABELRIGHT", "(label-right)")), //
				RegexLeaf.spaceZeroOrMore(), //
				new net.sourceforge.plantuml.regex.RegexOptional(new RegexLeaf(1, "GRID", "(grid)")), //
				RegexLeaf.end());
	}

	@Override
	protected CommandExecutionResult executeArg(ChartDiagram diagram, LineLocation location, RegexResult arg,
			ParserPass currentPass) {
		final String title = arg.getLazzy("TITLE", 0);
		final String minStr = arg.getLazzy("RANGE", 0);
		final String maxStr = arg.getLazzy("RANGE", 1);
		final String data = arg.getLazzy("DATA", 0);
		final String spacingStr = arg.getLazzy("SPACING", 0);
		final String labelRightStr = arg.getLazzy("LABELRIGHT", 0);
		final String gridStr = arg.getLazzy("GRID", 0);

		// Parse tick spacing if present (do this first, before any returns)
		if (spacingStr != null) {
			try {
				final int spacing = Integer.parseInt(spacingStr);
				if (spacing <= 0) {
					return CommandExecutionResult.error("X-axis spacing must be greater than 0");
				}
				diagram.setXAxisTickSpacing(spacing);
			} catch (NumberFormatException e) {
				return CommandExecutionResult.error("Invalid number format in spacing value");
			}
		}

		// Set label position if label-right option is present (do this before any returns)
		if (labelRightStr != null) {
			diagram.setXAxisLabelPosition(ChartAxis.LabelPosition.RIGHT);
		}

		// Enable grid if grid option is present (do this before any returns)
		if (gridStr != null) {
			diagram.setXGridMode(ChartDiagram.GridMode.MAJOR);
		}

		// If numeric range is provided, this is for horizontal bar chart mode
		if (minStr != null && maxStr != null) {
			try {
				final double min = Double.parseDouble(minStr);
				final double max = Double.parseDouble(maxStr);
				return diagram.setXAxis(title, min, max);
			} catch (NumberFormatException e) {
				return CommandExecutionResult.error("Invalid number format in axis range");
			}
		}

		// Otherwise, parse as labels
		final List<String> labels = parseLabels(data);
		diagram.setXAxisTitle(title);

		return diagram.setXAxisLabels(labels);
	}

	private List<String> parseLabels(String data) {
		final List<String> result = new ArrayList<>();
		if (data == null || data.trim().isEmpty())
			return result;

		// Split by comma, handling quoted strings
		final String[] parts = data.split(",");
		for (String part : parts) {
			String label = part.trim();
			// Remove quotes if present
			if (label.startsWith("\"") && label.endsWith("\""))
				label = label.substring(1, label.length() - 1);
			result.add(label);
		}
		return result;
	}
}