PSystemSalt.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.salt;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.ScaleSimple;
import net.sourceforge.plantuml.TitledDiagram;
import net.sourceforge.plantuml.command.Command;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.command.CommandFactorySprite;
import net.sourceforge.plantuml.command.ParserPass;
import net.sourceforge.plantuml.core.DiagramDescription;
import net.sourceforge.plantuml.core.DiagramType;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.color.HColors;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.MinMax;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.klimt.shape.UDrawable;
import net.sourceforge.plantuml.klimt.sprite.Sprite;
import net.sourceforge.plantuml.preproc.PreprocessingArtifact;
import net.sourceforge.plantuml.salt.element.Element;
import net.sourceforge.plantuml.salt.factory.AbstractElementFactoryComplex;
import net.sourceforge.plantuml.salt.factory.ElementFactory;
import net.sourceforge.plantuml.salt.factory.ElementFactoryBorder;
import net.sourceforge.plantuml.salt.factory.ElementFactoryButton;
import net.sourceforge.plantuml.salt.factory.ElementFactoryCheckboxOff;
import net.sourceforge.plantuml.salt.factory.ElementFactoryCheckboxOn;
import net.sourceforge.plantuml.salt.factory.ElementFactoryDroplist;
import net.sourceforge.plantuml.salt.factory.ElementFactoryImage;
import net.sourceforge.plantuml.salt.factory.ElementFactoryLine;
import net.sourceforge.plantuml.salt.factory.ElementFactoryMenu;
import net.sourceforge.plantuml.salt.factory.ElementFactoryPyramid;
import net.sourceforge.plantuml.salt.factory.ElementFactoryRadioOff;
import net.sourceforge.plantuml.salt.factory.ElementFactoryRadioOn;
import net.sourceforge.plantuml.salt.factory.ElementFactoryRetrieveFromDictonnary;
import net.sourceforge.plantuml.salt.factory.ElementFactoryScroll;
import net.sourceforge.plantuml.salt.factory.ElementFactoryTab;
import net.sourceforge.plantuml.salt.factory.ElementFactoryText;
import net.sourceforge.plantuml.salt.factory.ElementFactoryTextField;
import net.sourceforge.plantuml.salt.factory.ElementFactoryTree;
import net.sourceforge.plantuml.style.ClockwiseTopRightBottomLeft;
import net.sourceforge.plantuml.text.StringLocated;
import net.sourceforge.plantuml.utils.BlocLines;
import net.sourceforge.plantuml.utils.Log;

public class PSystemSalt extends TitledDiagram {

	private final List<String> data;
	private final SaltDictionary dictionary;

	@Deprecated
	public PSystemSalt(UmlSource source, List<String> data, PreprocessingArtifact preprocessing) {
		super(source, DiagramType.SALT, null, preprocessing);
		this.dictionary = new SaltDictionary(source.getPathSystem(), preprocessing.getOption());
		this.data = data;
	}

	public PSystemSalt(UmlSource source, PreprocessingArtifact preprocessing) {
		this(source, new ArrayList<String>(), preprocessing);
	}

	public void add(String s) {
		data.addAll(StringLocated.expandsNewline(s));
	}

	public int size() {
		return data.size();
	}

	@Override
	public TextBlock getTextBlock(int num, FileFormatOption fileFormatOption) {
		final Element salt = createElement(manageSprite());
		final StringBounder stringBounder = fileFormatOption.getDefaultStringBounder(getSkinParam(), getPragma());
		final XDimension2D preferred = salt.getPreferredDimension(stringBounder, 0, 0);
		// Only pay for the extra dry-run pass - and only let it influence the
		// final size - when something in the tree can actually draw beyond
		// its own preferred dimension. It measures via LimitFinder, a
		// different (UText-based) code path than getPreferredDimension's own
		// (creole-aware) text measurement, so it is not always pixel-for-
		// pixel identical even when nothing truly overflows; gating it here
		// keeps every ordinary salt diagram byte-identical to before this
		// existed instead of picking up a stray pixel or two of margin.
		final XDimension2D size = salt.mayDrawBeyondPreferredDimension() ? withActualExtent(salt, preferred, stringBounder)
				: preferred;
		return new TextBlock() {

			public void drawU(UGraphic ug) {
				ug = ug.apply(getBlack());
				salt.drawU(ug, 0, new XDimension2D(size.getWidth(), size.getHeight()));
				salt.drawU(ug, 1, new XDimension2D(size.getWidth(), size.getHeight()));
			}

			public XDimension2D calculateDimension(StringBounder stringBounder) {
				return size;
			}

			public HColor getBackcolor() {
				return getSkinParam().getBackgroundColor();
			}
		};
	}

	// Some elements (an open salt droplist - see ElementDroplist - is the
	// current example) deliberately draw beyond their own preferred
	// dimension, so they can float over / overlap whatever the layout put
	// after them instead of pushing it down, the way a real UI drop-down
	// covers whatever is under it. getPreferredDimension() has to stay
	// unaware of that overflow, since it is also what every grid/row/column
	// in the diagram is sized from (see ElementPyramid#init) - growing it
	// would reserve room for the overflow and defeat the "floats over"
	// behavior. But it means getPreferredDimension() alone is not always
	// large enough to size the final image: whatever gets drawn past its
	// edge is clipped outright by raster formats such as PNG, because their
	// canvas is allocated at exactly that size (see TextBlockExporter);
	// SVG happens to auto-grow its declared viewBox from the shapes it
	// actually draws instead, which is why this was never visible there
	// (see issue #2882). Do a dry run of the real drawU() calls - which,
	// unlike getPreferredDimension(), walks actual absolute positions - and
	// grow the canvas to whatever that dry run really touched, without
	// changing how any element itself gets laid out.
	private static XDimension2D withActualExtent(final Element salt, final XDimension2D preferred,
			StringBounder stringBounder) {
		final MinMax minmax = TextBlockUtils.getMinMax(new UDrawable() {
			public void drawU(UGraphic ug) {
				salt.drawU(ug, 0, preferred);
				salt.drawU(ug, 1, preferred);
			}
		}, stringBounder, true);
		return preferred.atLeast(minmax.getMaxX(), minmax.getMaxY());
	}

	public DiagramDescription getDescription() {
		return new DiagramDescription("(Salt)");
	}

	public void addSprite(String name, Sprite sprite) {
		dictionary.addSprite(name, sprite);
	}

	private List<String> manageSprite() {

		final Command<TitledDiagram> cmd = CommandFactorySprite.ME.createMultiLine(false);

		final List<String> result = new ArrayList<>();
		for (Iterator<String> it = data.iterator(); it.hasNext();) {
			String s = it.next();
			if (s.equals("hide stereotype")) {
				// System.err.println("skipping " + s);
			} else if (s.startsWith("skinparam ")) {
				// System.err.println("skipping " + s);
			} else if (s.startsWith("scale ")) {
				final double scale = Double.parseDouble(s.substring("scale ".length()));
				this.setScale(new ScaleSimple(scale));
				// System.err.println("skipping " + s);
			} else if (s.startsWith("sprite $")) {
				BlocLines block = BlocLines.singleString(s);
				do {
					s = it.next();
					block = block.addString(s);
				} while (s.equals("}") == false);
				try {
					final CommandExecutionResult cmdResult = cmd.execute(this, block, ParserPass.ONE);
				} catch (NoSuchColorException e) {
				}
			} else {
				result.add(s);
			}
		}
		return result;
	}

	private Element createElement(List<String> data) {

		final DataSourceImpl source = new DataSourceImpl(data);

		final Collection<AbstractElementFactoryComplex> cpx = new ArrayList<>();

		// A single, shared ElementFactoryTree instance, reused everywhere a tree
		// table can appear (top-level, and as a child of Pyramid/Scroll/Border/
		// itself below) instead of creating a fresh one per parent. Tree cells
		// are themselves dispatched through getNextElement() (see
		// ElementFactoryTree#create()), so whichever instance ends up handling a
		// given "{T#...}" block needs its own factories wired up exactly like
		// Pyramid/Scroll/Border do; sharing one instance guarantees that instead
		// of leaving every other copy with an empty, unusable factory list.
		final ElementFactoryTree treeFactory = new ElementFactoryTree(source, dictionary);

		// cpx.add(new ElementFactorySimpleFrame(source, dictionnary));
		cpx.add(new ElementFactoryPyramid(source, dictionary));
		cpx.add(new ElementFactoryScroll(source, dictionary));
		cpx.add(new ElementFactoryBorder(source, dictionary));
		// A tree table ("{T#...}") must be a top-level candidate too, not only
		// something reachable once already inside a Pyramid/Scroll/Border body -
		// otherwise a bare tree table needs a useless extra wrapping "{ ... }"
		// to render at all (see issue #2730).
		cpx.add(treeFactory);

		for (AbstractElementFactoryComplex f : cpx)
			addSimpleFactory(f, source, dictionary, treeFactory);

		for (AbstractElementFactoryComplex f1 : cpx)
			for (AbstractElementFactoryComplex f2 : cpx)
				f1.addFactory(f2);

		for (ElementFactory f : cpx) {
			if (f.ready()) {
				Log.info(() -> "Using " + f);
				return f.create().getElement();
			}
		}

		Log.println("data=" + data);
		throw new IllegalArgumentException();

	}

	private static void addSimpleFactory(final AbstractElementFactoryComplex cpxFactory, final DataSource source,
			SaltDictionary dictionary, ElementFactoryTree treeFactory) {
		cpxFactory.addFactory(new ElementFactoryMenu(source, dictionary));
		cpxFactory.addFactory(treeFactory);
		cpxFactory.addFactory(new ElementFactoryTab(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryLine(source));
		cpxFactory.addFactory(new ElementFactoryTextField(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryCheckboxOn(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryCheckboxOff(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryButton(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryDroplist(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryRadioOn(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryRadioOff(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryImage(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryRetrieveFromDictonnary(source, dictionary));
		cpxFactory.addFactory(new ElementFactoryText(source, dictionary));
	}

	@Override
	public ClockwiseTopRightBottomLeft getDefaultMargins() {
		return ClockwiseTopRightBottomLeft.same(5);
	}

	private HColor getBlack() {
		return HColors.BLACK;
	}

}