net.sourceforge.plantuml.NewpagedDiagram Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 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 GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* 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 GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 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;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import net.sourceforge.plantuml.command.Command;
import net.sourceforge.plantuml.command.CommandExecutionResult;
import net.sourceforge.plantuml.core.Diagram;
import net.sourceforge.plantuml.core.DiagramDescription;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.core.UmlSource;
import net.sourceforge.plantuml.klimt.color.NoSuchColorException;
import net.sourceforge.plantuml.utils.BlocLines;
public class NewpagedDiagram extends AbstractPSystem {
// ::remove file when __HAXE__
private final List diagrams = new ArrayList<>();
public NewpagedDiagram(UmlSource source, AbstractPSystem diag1, AbstractPSystem diag2) {
super(source);
if (diag1 instanceof NewpagedDiagram) {
throw new IllegalArgumentException();
}
if (diag2 instanceof NewpagedDiagram) {
throw new IllegalArgumentException();
}
this.diagrams.add(diag1);
this.diagrams.add(diag2);
}
@Override
public String toString() {
return super.toString() + " SIZE=" + diagrams.size() + " " + diagrams;
}
public Diagram getLastDiagram() {
return diagrams.get(diagrams.size() - 1);
}
public CommandExecutionResult executeCommand(Command cmd, BlocLines lines) {
final int nb = diagrams.size();
try {
final CommandExecutionResult tmp = cmd.execute(diagrams.get(nb - 1), lines);
if (tmp.getNewDiagram() instanceof NewpagedDiagram) {
final NewpagedDiagram new1 = (NewpagedDiagram) tmp.getNewDiagram();
// System.err.println("this=" + this);
// System.err.println("new1=" + new1);
if (new1.size() != 2) {
throw new IllegalStateException();
}
if (new1.diagrams.get(0) != this.diagrams.get(nb - 1)) {
throw new IllegalStateException();
}
this.diagrams.add(new1.diagrams.get(1));
return tmp.withDiagram(this);
}
return tmp;
} catch (NoSuchColorException e) {
return CommandExecutionResult.badColor();
}
}
private int size() {
return diagrams.size();
}
@Override
final protected ImageData exportDiagramNow(OutputStream os, int num, FileFormatOption fileFormat)
throws IOException {
return diagrams.get(num).exportDiagram(os, 0, fileFormat);
}
public int getNbImages() {
int nb = 0;
for (Diagram d : diagrams) {
nb += d.getNbImages();
}
return nb;
}
public DiagramDescription getDescription() {
final StringBuilder sb = new StringBuilder();
for (Diagram d : diagrams) {
if (sb.length() > 0) {
sb.append(" ");
}
sb.append(d.getDescription());
}
return new DiagramDescription(sb.toString());
}
public String getWarningOrError() {
final StringBuilder sb = new StringBuilder();
for (Diagram d : diagrams) {
if (sb.length() > 0) {
sb.append(" ");
}
if (d.getWarningOrError() != null) {
sb.append(d.getWarningOrError());
}
}
if (sb.length() == 0) {
return null;
}
return sb.toString();
}
@Override
public void makeDiagramReady() {
super.makeDiagramReady();
for (Diagram diagram : diagrams) {
((AbstractPSystem) diagram).makeDiagramReady();
}
}
@Override
public String checkFinalError() {
for (Diagram p : getDiagrams()) {
final String check = ((AbstractPSystem) p).checkFinalError();
if (check != null) {
return check;
}
}
return super.checkFinalError();
}
public final List getDiagrams() {
return Collections.unmodifiableList(diagrams);
}
}