net.sourceforge.plantuml.sequencediagram.graphic.SequenceDiagramFileMakerPuma2 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-mit Show documentation
Show all versions of plantuml-mit Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | 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/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the MIT License.
*
* See http://opensource.org/licenses/MIT
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this MIT license.
*
* The generated images can then be used without any reference to the MIT license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.sequencediagram.graphic;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import net.sourceforge.plantuml.AnnotatedBuilder;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.cucadiagram.DisplaySection;
import net.sourceforge.plantuml.klimt.LineBreakStrategy;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontParam;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.VerticalAlignment;
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.png.PngTitler;
import net.sourceforge.plantuml.sequencediagram.Event;
import net.sourceforge.plantuml.sequencediagram.Newpage;
import net.sourceforge.plantuml.sequencediagram.Participant;
import net.sourceforge.plantuml.sequencediagram.SequenceDiagram;
import net.sourceforge.plantuml.skin.rose.Rose;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
public class SequenceDiagramFileMakerPuma2 implements FileMaker {
private final SequenceDiagram diagram;
private final DrawableSet drawableSet;
private final XDimension2D fullDimension;
private final List pages;
private final FileFormatOption fileFormatOption;
private final StringBounder stringBounder;
public SequenceDiagramFileMakerPuma2(SequenceDiagram diagram, Rose skin, FileFormatOption fileFormatOption) {
this.diagram = diagram;
this.stringBounder = fileFormatOption.getDefaultStringBounder(diagram.getSkinParam());
this.fileFormatOption = fileFormatOption;
final DrawableSetInitializer initializer = new DrawableSetInitializer(skin, diagram.getSkinParam(),
diagram.isShowFootbox(), diagram.getAutonewpage());
for (Participant p : diagram.participants())
initializer.addParticipant(p, diagram.getEnglober(p));
for (Event ev : diagram.events()) {
initializer.addEvent(ev);
// if (ev instanceof Message) {
// // TODO mieux faire
// final Message m = (Message) ev;
// for (LifeEvent lifeEvent : m.getLiveEvents()) {
// if (lifeEvent.getType() == LifeEventType.DESTROY
// /*
// * || lifeEvent.getType() == LifeEventType.CREATE
// */) {
// initializer.addEvent(lifeEvent);
// }
// }
// }
}
drawableSet = initializer.createDrawableSet(stringBounder);
final List newpages = new ArrayList<>();
for (Event ev : drawableSet.getAllEvents())
if (ev instanceof Newpage)
newpages.add((Newpage) ev);
fullDimension = drawableSet.getDimension();
final Map positions = new LinkedHashMap();
for (Newpage n : newpages)
positions.put(n, initializer.getYposition(stringBounder, n));
pages = create(drawableSet, positions, diagram.isShowFootbox(), diagram.getTitle().getDisplay()).getPages();
}
public int getNbPages() {
return pages.size();
}
private PageSplitter create(DrawableSet drawableSet, Map positions, boolean showFootbox,
Display title) {
final double headerHeight = drawableSet.getHeadHeight(stringBounder);
final double tailHeight = drawableSet.getTailHeight(stringBounder, showFootbox);
final double signatureHeight = 0;
final double newpageHeight = drawableSet.getSkin().createComponentNewPage(drawableSet.getSkinParam())
.getPreferredHeight(stringBounder);
return new PageSplitter(fullDimension.getHeight(), headerHeight, positions, tailHeight, signatureHeight,
newpageHeight, title);
}
@Override
public void createOneGraphic(UGraphic ug) {
final UDrawable drawable = createUDrawable(0);
drawable.drawU(ug);
}
@Override
public ImageData createOne(OutputStream os, final int index, boolean isWithMetadata) throws IOException {
final UDrawable drawable = createUDrawable(index);
return diagram.createImageBuilder(fileFormatOption).drawable(drawable).write(os);
}
private UDrawable createUDrawable(final int index) {
final Page page = pages.get(index);
final AnnotatedBuilder builder = new AnnotatedBuilder(diagram, diagram.getSkinParam(), stringBounder);
double pageHeight = page.getHeight();
if (builder.hasMainFrame())
pageHeight += builder.mainFrameSuppHeight();
final SequenceDiagramArea area = new SequenceDiagramArea(fullDimension.getWidth(), pageHeight);
final TextBlock compTitle;
final TextBlock caption = builder.getCaption();
area.setCaptionArea(caption.calculateDimension(stringBounder));
if (Display.isNull(page.getTitle())) {
compTitle = null;
} else {
final Style style = StyleSignatureBasic.of(SName.root, SName.document, SName.title)
.getMergedStyle(diagram.getSkinParam().getCurrentStyleBuilder());
compTitle = style.createTextBlockBordered(page.getTitle(), diagram.getSkinParam().getIHtmlColorSet(),
diagram.getSkinParam(), Style.ID_TITLE, LineBreakStrategy.NONE);
final XDimension2D dimTitle = compTitle.calculateDimension(stringBounder);
area.setTitleArea(dimTitle.getWidth(), dimTitle.getHeight());
}
area.initFooter(getPngTitler(FontParam.FOOTER, index), stringBounder);
area.initHeader(getPngTitler(FontParam.HEADER, index), stringBounder);
final TextBlock legendBlock;
if (diagram.getLegend().isNull()) {
legendBlock = TextBlockUtils.empty(0, 0);
} else {
final Style style = StyleSignatureBasic.of(SName.root, SName.document, SName.legend)
.getMergedStyle(diagram.getSkinParam().getCurrentStyleBuilder());
legendBlock = style.createTextBlockBordered(diagram.getLegend().getDisplay(),
diagram.getSkinParam().getIHtmlColorSet(), diagram.getSkinParam(), Style.ID_LEGEND,
LineBreakStrategy.NONE);
}
final XDimension2D dimLegend = legendBlock.calculateDimension(stringBounder);
area.setLegend(dimLegend, isLegendTop(), diagram.getLegend().getHorizontalAlignment());
final UDrawable drawable = new UDrawable() {
public void drawU(UGraphic ug) {
double delta = 0;
if (index > 0)
delta = page.getNewpage1() - page.getHeaderHeight();
if (delta < 0)
delta = 0;
if (compTitle != null) {
final HColor back = diagram.calculateBackColor();
compTitle.drawU(ug.apply(back.bg()).apply(new UTranslate(area.getTitleX(), area.getTitleY())));
}
caption.drawU(ug.apply(new UTranslate(area.getCaptionX(), area.getCaptionY())));
final double delta1 = Math.max(0, area.getLegendWidth() - area.getWidth());
final UTranslate forCore = new UTranslate(area.getSequenceAreaX() + delta1 / 2,
area.getSequenceAreaY());
TextBlock core = drawableSet.asTextBlock(delta, fullDimension.getWidth(), page,
diagram.isShowFootbox());
core = builder.decoreWithFrame(core);
core.drawU(ug.apply(forCore));
drawHeader(area, ug, index);
drawFooter(area, ug, index);
if (area.hasLegend())
legendBlock.drawU(ug.apply(new UTranslate(area.getLegendX(), area.getLegendY())));
}
};
return drawable;
}
private void drawFooter(SequenceDiagramArea area, UGraphic ug, int page) {
final PngTitler pngTitler = getPngTitler(FontParam.FOOTER, page);
final TextBlock text = pngTitler.getRibbonBlock();
if (text == null)
return;
text.drawU(ug.apply(
new UTranslate(area.getFooterX(diagram.getFooter().getHorizontalAlignment()), area.getFooterY())));
}
private void drawHeader(SequenceDiagramArea area, UGraphic ug, int page) {
final PngTitler pngTitler = getPngTitler(FontParam.HEADER, page);
final TextBlock text = pngTitler.getRibbonBlock();
if (text == null)
return;
text.drawU(ug.apply(
new UTranslate(area.getHeaderX(diagram.getHeader().getHorizontalAlignment()), area.getHeaderY())));
}
private PngTitler getPngTitler(final FontParam fontParam, int page) {
final ISkinParam skinParam = diagram.getSkinParam();
final DisplaySection display = diagram.getFooterOrHeaderTeoz(fontParam).withPage(page + 1, pages.size());
final StyleSignatureBasic def = fontParam.getStyleDefinition(null);
final Style style = def.getMergedStyle(skinParam.getCurrentStyleBuilder());
return new PngTitler(display, style, skinParam.getIHtmlColorSet(), skinParam);
}
private boolean isLegendTop() {
return diagram.getLegend().isNull() == false
&& diagram.getLegend().getVerticalAlignment() == VerticalAlignment.TOP;
}
}