Reference.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;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.style.MergeStrategy;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.parser2.StyleQuery;
import net.sourceforge.plantuml.url.Url;
import net.sourceforge.plantuml.warning.Warning;

public class Reference extends AbstractEvent implements EventWithNote {

	private final List<Participant> participants;
	private final Url url;
	private final HColor backColorGeneral;
	private final HColor backColorElement;

	private final Display strings;

	final private Style style;
	final private Style styleHeader;

	public StyleQuery getDefaultStyleDefinition() {
		return StyleQuery.of(Arrays.asList(SName.root, SName.element, SName.sequenceDiagram, SName.reference));
	}

	private StyleQuery getHeaderStyleDefinition() {
		return StyleQuery.of(Arrays.asList(SName.root, SName.element, SName.sequenceDiagram, SName.referenceHeader));
	}

	// The nested counterpart of the legacy flat "referenceHeader" above, added
	// for consistency with the dedicated "partition { header {...} }" selector
	// (#2679): `sequenceDiagram { reference { header {...} } }`. Kept as a
	// plain override layered on top of the flat style (see
	// computeStyleHeader()) rather than a replacement, so every existing
	// diagram styling `referenceHeader` directly keeps working unchanged: only
	// diagrams that opt into the new nested form are affected.
	private StyleQuery getNestedHeaderStyleDefinition() {
		return StyleQuery.of(Arrays.asList(SName.root, SName.element, SName.sequenceDiagram, SName.reference, SName.header));
	}

	private Style computeStyleHeader(StyleBuilder styleBuilder) {
		final Style flat = styleBuilder.getMergedStyle(getHeaderStyleDefinition());
		// "style" (this.style, already assigned above in the constructor) is the
		// plain "reference" style -- the exact ancestor "nested" cascades from,
		// so mergeNestedChildOver() can isolate what header{} itself actually
		// sets (see Style.mergeNestedChildOver()'s javadoc for why this
		// filtering is needed at all).
		final Style nested = styleBuilder.getMergedStyle(getNestedHeaderStyleDefinition());
		if (flat == null)
			return nested;

		return flat.mergeNestedChildOver(nested, style, MergeStrategy.OVERWRITE_EXISTING_VALUE);
	}

	public Style[] getUsedStyles() {
		return new Style[] { style, styleHeader == null ? styleHeader
				: styleHeader.eventuallyOverride(PName.BackGroundColor, backColorElement) };
	}

	public Reference(List<Participant> participants, Url url, Display strings, HColor backColorGeneral,
			HColor backColorElement, StyleBuilder styleBuilder) {
		this.participants = uniq(participants);
		this.url = url;
		this.strings = strings;
		this.backColorGeneral = backColorGeneral;
		this.backColorElement = backColorElement;
		this.style = styleBuilder.getMergedStyle(getDefaultStyleDefinition());
		this.styleHeader = computeStyleHeader(styleBuilder);
	}

	static private List<Participant> uniq(List<Participant> all) {
		final List<Participant> result = new ArrayList<Participant>();
		for (Participant p : all)
			if (result.contains(p) == false)
				result.add(p);
		return Collections.unmodifiableList(result);
	}

	public List<Participant> getParticipant() {
		return participants;
	}

	public Display getStrings() {
		return strings;
	}

	public boolean dealWith(Participant someone) {
		return participants.contains(someone);
	}

	public final Url getUrl() {
		return url;
	}

	public boolean hasUrl() {
		return url != null;
	}

	@Override
	public String toString() {
		final StringBuilder sb = new StringBuilder();
		for (final Iterator<Participant> it = participants.iterator(); it.hasNext();) {
			sb.append(it.next().getCode());
			if (it.hasNext())
				sb.append("-");

		}
		return sb.toString();
	}

	public final HColor getBackColorGeneral() {
		return backColorGeneral;
	}

	public final HColor getBackColorElement() {
		return backColorElement;
	}

	private List<Note> noteOnMessages = new ArrayList<>();

	@Override
	public final Warning addNote(Note note) {
		if (note.getPosition() != NotePosition.LEFT && note.getPosition() != NotePosition.RIGHT)
			return new Warning("This position is ignored: " + note.getPosition());

		this.noteOnMessages.add(note);
		return null;
	}

	public final List<Note> getNoteOnMessages() {
		return noteOnMessages;
	}

}