NoteTile.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.teoz;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.real.Real;
import net.sourceforge.plantuml.real.RealUtils;
import net.sourceforge.plantuml.sequencediagram.Event;
import net.sourceforge.plantuml.sequencediagram.Note;
import net.sourceforge.plantuml.sequencediagram.NotePosition;
import net.sourceforge.plantuml.sequencediagram.NoteStyle;
import net.sourceforge.plantuml.skin.Area;
import net.sourceforge.plantuml.skin.Component;
import net.sourceforge.plantuml.skin.ComponentType;
import net.sourceforge.plantuml.skin.Context2D;
import net.sourceforge.plantuml.skin.rose.Rose;
import net.sourceforge.plantuml.style.ISkinParam;

public class NoteTile extends AbstractTile implements Tile {

	private final LivingSpace livingSpace1;
	private final LivingSpace livingSpace2;
	private final Rose skin;
	private final ISkinParam skinParam;
	private final Note note;
	private final YGauge yGauge;

	public Event getEvent() {
		return note;
	}

	@Override
	public double getContactPointRelative() {
		return getComponent(getStringBounder()).getPreferredHeight(getStringBounder()) / 2;
	}

	public NoteTile(StringBounder stringBounder, LivingSpace livingSpace1, LivingSpace livingSpace2, Note note,
			Rose skin, ISkinParam skinParam, YGauge currentY) {
		super(stringBounder, currentY);
		this.livingSpace1 = livingSpace1;
		this.livingSpace2 = livingSpace2;
		this.note = note;
		this.skin = skin;
		this.skinParam = skinParam;

		// Same chaining as CommunicationTile: a standalone note published via
		// "& note ..." must share the previous tile's contact line (top-aligned
		// via createParallel) instead of stacking sequentially below it. The
		// note's own "contact point" is its vertical center (see
		// getContactPointRelative below), mirroring how the legacy TileParallel
		// aligned notes against message arrows by their respective
		// contact points.
		//
		// EXCEPT when this note's own footprint was already claimed by an
		// earlier note in the same "&" run (e.g. "note over A & note over A"):
		// contact-point alignment centers both on the very same line, which,
		// since they occupy the same side of the same participant, means the
		// same X footprint too -- i.e. they would be drawn directly on top of
		// one another. In that case fall back to createPropagating(): it
		// stacks this note below everything drawn so far in the run (like a
		// LifeEventTile passing through the run without joining the alignment
		// itself) while still forwarding the run's contact/origin, so a LATER
		// sibling on a genuinely different footprint still aligns against the
		// original line (see issue #2883's follow-up: notes on different
		// participants were fixed there, same-participant notes were an
		// explicit out-of-scope limitation, closed here).
		//
		// The footprint key is (participant, position), not just the
		// participant: "note left of U" and "note right of U" both resolve to
		// livingSpace1 == U, but extend away from U in opposite directions and
		// never actually overlap -- only two notes on the very same side (or
		// both plain OVER) do.
		final double contactRelative = getContactPointRelative();
		final double height = getPreferredHeight();
		final Object footprint = Arrays.asList(livingSpace1, note.getPosition());
		final Set<Object> anchorsInRun = currentY.getNoteAnchorsInRun();
		if (note.isParallel() && anchorsInRun != null && anchorsInRun.contains(footprint)) {
			this.yGauge = YGauge.createPropagating(currentY, height).withNoteAnchorsInRun(anchorsInRun);
		} else if (note.isParallel()) {
			final Set<Object> grown = anchorsInRun == null ? new HashSet<Object>() : new HashSet<>(anchorsInRun);
			grown.add(footprint);
			this.yGauge = YGauge.createParallel(currentY, contactRelative, height).withNoteAnchorsInRun(grown);
		} else {
			final Set<Object> fresh = new HashSet<>();
			fresh.add(footprint);
			this.yGauge = YGauge.createWithContact(currentY, contactRelative, height).withNoteAnchorsInRun(fresh);
		}
	}

	@Override
	public YGauge getYGauge() {
		return yGauge;
	}

	// The component only depends on the tile's fixed data, not on the string
	// bounder, but it was rebuilt on every call from every layout phase
	private Component cachedComponent;

	private Component getComponent(StringBounder stringBounder) {
		if (cachedComponent == null)
			cachedComponent = skin.createComponentNote(note.getUsedStyles(),
					getNoteComponentType(note.getNoteStyle()), note.getSkinParamBackcolored(skinParam),
					note.getDisplay(), note.getColors(), note.getPosition());
		return cachedComponent;
	}

	protected static ComponentType getNoteComponentType(NoteStyle noteStyle) {
		if (noteStyle == NoteStyle.HEXAGONAL)
			return ComponentType.NOTE_HEXAGONAL;

		if (noteStyle == NoteStyle.BOX)
			return ComponentType.NOTE_BOX;

		return ComponentType.NOTE;
	}

	public void drawU(UGraphic ug) {
		// Self-translate prologue: absolute gauge position
		ug = ug.apply(UTranslate.dy(getYGauge().getMin().getCurrentValue()));
		final StringBounder stringBounder = ug.getStringBounder();
		final Component comp = getComponent(stringBounder);
		final XDimension2D dim = comp.getPreferredDimension(stringBounder);
		final double x = getX(stringBounder).getCurrentValue();
		final Area area = Area.create(getUsedWidth(stringBounder), dim.getHeight());

		ug = ug.apply(UTranslate.dx(x));
		comp.drawU(ug, area, (Context2D) ug);
	}

	private double getUsedWidth(StringBounder stringBounder) {
		final Component comp = getComponent(stringBounder);
		final XDimension2D dim = comp.getPreferredDimension(stringBounder);
		final double width = dim.getWidth();
		if (note.getPosition() == NotePosition.OVER_SEVERAL) {
			final double x1 = livingSpace1.getPosB(stringBounder).getCurrentValue();
			final double x2 = livingSpace2.getPosD(stringBounder).getCurrentValue();
			final double w = x2 - x1;
			if (width < w)
				return w;

		}
		return width;
	}

	private Real getX(StringBounder stringBounder) {
		final NotePosition position = note.getPosition();
		final double width = getUsedWidth(stringBounder);
		if (position == NotePosition.LEFT) {
			return livingSpace1.getPosC(stringBounder).addFixed(-width);
		} else if (position == NotePosition.RIGHT) {
			final int level = livingSpace1.getLevelAt(this, EventsHistoryMode.IGNORE_FUTURE_DEACTIVATE);
			final double dx = level * CommunicationTile.LIVE_DELTA_SIZE;
			return livingSpace1.getPosC(stringBounder).addFixed(dx);
		} else if (position == NotePosition.OVER_SEVERAL) {
			final Real x1 = livingSpace1.getPosC(stringBounder);
			final Real x2 = livingSpace2.getPosC(stringBounder);
			return RealUtils.middle(x1, x2).addFixed(-width / 2);
		} else if (position == NotePosition.OVER) {
			return livingSpace1.getPosC(stringBounder).addFixed(-width / 2);
		} else {
			throw new UnsupportedOperationException(position.toString());
		}
	}

	@Override
	public double getPreferredHeight() {
		final Component comp = getComponent(getStringBounder());
		final XDimension2D dim = comp.getPreferredDimension(getStringBounder());
		return dim.getHeight();
	}

	public void addConstraints() {
		ensureOwnBoxClearsNote();
	}

	// See CommunicationTileSelf.ensureOwnBoxClearsLoop() (issue #2791): a `box
	// "..." ... endbox` grouping draws its rectangle purely from its first/last
	// participant's LivingSpace marginBefore/marginAfter (Doll.getPosA()/
	// getPosE()), never from any tile's own footprint. A standalone
	// "note left of"/"note right of"/"note over" can reach further than the
	// participant(s) it is attached to -- exactly the same shape of overflow
	// as a self-message loop, just for a note instead of a loop. Grow the
	// relevant LivingSpace's own margin to cover it; harmless when the
	// participant(s) here are not actually a box's first/last member (or are
	// in no box at all), since that margin is then never read (see
	// LivingSpace.getPosA()/getPosE(), read only by Doll).
	//
	// The formula self-selects by position: for NotePosition.LEFT, getMinX()
	// already equals getX() (no leftward reach past livingSpace1.getPosB()
	// unless the note itself is wider than the gap), and getMaxX() collapses
	// to livingSpace1.getPosC(), which never exceeds getPosD() -- so the
	// "wrong side" of the pair is always a no-op (overflow <= 0) without
	// needing to branch on note.getPosition() here.
	private void ensureOwnBoxClearsNote() {
		final StringBounder stringBounder = getStringBounder();

		final double overflowLeft = livingSpace1.getPosB(stringBounder).getCurrentValue()
				- getMinX().getCurrentValue();
		if (overflowLeft > 0)
			livingSpace1.ensureMarginBefore(overflowLeft);

		final LivingSpace rightAnchor = note.getPosition() == NotePosition.OVER_SEVERAL ? livingSpace2
				: livingSpace1;
		final double overflowRight = getMaxX().getCurrentValue()
				- rightAnchor.getPosD(stringBounder).getCurrentValue();
		if (overflowRight > 0)
			rightAnchor.ensureMarginAfter(overflowRight);
	}

	// The right edges this note is built on, broken back down into Reals that are
	// each safe to hand to Real.ensureBiggerThan() -- i.e. plain delta chains,
	// re-read on every compile() pass. getMaxX() itself is NOT safe for that:
	// under OVER_SEVERAL it composes a RealUtils.max(), which caches its resolved
	// value the first time it is read (see the note in GroupingTile). Stacking one
	// constraint per element of this list is the same "max", minus the caching.
	// RealUtils.middle(), which getX() uses under OVER_SEVERAL, does not cache and
	// needs no such treatment.
	// The participant this note's own left edge is measured from, and how far left
	// of that participant's posC it reaches -- a plain distance, no Real involved,
	// so a caller can subtract it from a position it already holds. Used by
	// GroupingTile to re-derive a group frame's left edge without reading the
	// RealMin the constructor built it from.
	//
	// 0 for OVER_SEVERAL, where the left edge is a RealUtils.middle() between two
	// participants and no fixed distance from either one describes it. That
	// over-estimates the frame's left edge, hence its title's right edge, hence the
	// push -- the harmless direction: a little too much room rather than a
	// participant back under the frame.
	LivingSpace getLeftAnchor() {
		return livingSpace1;
	}

	double getLeftOverhang() {
		final NotePosition position = note.getPosition();
		if (position == NotePosition.LEFT)
			return getUsedWidth(getStringBounder());

		if (position == NotePosition.OVER)
			return getUsedWidth(getStringBounder()) / 2;

		return 0;
	}

	List<Real> getStableMaxX() {
		final List<Real> result = new ArrayList<>();
		result.add(getX(getStringBounder()).addFixed(getUsedWidth(getStringBounder())));
		if (note.getPosition() == NotePosition.OVER_SEVERAL)
			result.add(livingSpace2.getPosD(getStringBounder()));

		return result;
	}

	// Left-side mirror of getStableMaxX(): the left edges this note is built
	// on, each safe to hand to Real.ensureBiggerThan() for the same reason --
	// getMinX() itself composes a RealUtils.min() under OVER_SEVERAL, which
	// caches its resolved value the first time it is read (see the note on
	// GroupingTile.ensureFollowingParticipantClearsFrame()), so that case is
	// split back into its two plain halves here too.
	List<Real> getStableMinX() {
		final List<Real> result = new ArrayList<>();
		result.add(getX(getStringBounder()));
		if (note.getPosition() == NotePosition.OVER_SEVERAL)
			result.add(livingSpace1.getPosB(getStringBounder()));

		return result;
	}

	@Override
	public Real getMinX() {
		final Real result = getX(getStringBounder());
		if (note.getPosition() == NotePosition.OVER_SEVERAL) {
			final Real x1 = livingSpace1.getPosB(getStringBounder());
			return RealUtils.min(result, x1);
		}
		return result;
	}

	@Override
	public Real getMaxX() {
		final Real result = getX(getStringBounder()).addFixed(getUsedWidth(getStringBounder()));
		if (note.getPosition() == NotePosition.OVER_SEVERAL) {
			final Real x2 = livingSpace2.getPosD(getStringBounder());
			return RealUtils.max(result, x2);
		}
		return result;
	}

}