net.sourceforge.plantuml.SourceFileReaderAbstract 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 static net.sourceforge.plantuml.utils.CharsetUtils.charsetOrDefault;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import net.sourceforge.plantuml.api.ImageDataSimple;
import net.sourceforge.plantuml.core.Diagram;
import net.sourceforge.plantuml.error.PSystemError;
import net.sourceforge.plantuml.file.SuggestedFile;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.preproc.Defines;
import net.sourceforge.plantuml.preproc.FileWithSuffix;
import net.sourceforge.plantuml.security.SFile;
import net.sourceforge.plantuml.security.SecurityUtils;
import net.sourceforge.plantuml.utils.Log;
public abstract class SourceFileReaderAbstract implements ISourceFileReader {
// ::remove file when __CORE__
// ::remove file when __HAXE__
final private File file;
private FileFormatOption fileFormatOption;
private boolean checkMetadata;
private boolean noerror;
final private Charset charset;
private final BlockUmlBuilder builder;
private int cpt;
protected final SuggestedFile getSuggestedFile(File outputDirectory, String newName) {
final File outFile = new File(outputDirectory, newName);
return SuggestedFile.fromOutputFile(outFile, getFileFormatOption().getFileFormat(), cpt++);
}
public SourceFileReaderAbstract(File file, FileFormatOption fileFormatOption, Defines defines, List config,
String charsetName) throws IOException {
if (file.exists() == false)
throw new IllegalArgumentException();
this.file = file;
this.charset = charsetOrDefault(charsetName);
this.fileFormatOption = fileFormatOption;
this.builder = new BlockUmlBuilder(config, charset, defines, getReader(charset),
SFile.fromFile(file.getAbsoluteFile().getParentFile()), FileWithSuffix.getFileName(file));
}
protected final FileFormatOption getFileFormatOption() {
return fileFormatOption;
}
public void setCheckMetadata(boolean checkMetadata) {
this.checkMetadata = checkMetadata;
}
public boolean hasError() {
for (final BlockUml b : builder.getBlockUmls())
if (b.getDiagram() instanceof PSystemError)
return true;
return false;
}
public List getBlocks() {
return builder.getBlockUmls();
}
protected Reader getReader(Charset charset) throws FileNotFoundException, UnsupportedEncodingException {
return new InputStreamReader(new BufferedInputStream(new FileInputStream(file)), charset);
}
public final Set getIncludedFiles() throws IOException {
return builder.getIncludedFiles();
}
@Override
public final ISourceFileReader setFileFormatOption(FileFormatOption fileFormatOption) {
this.fileFormatOption = fileFormatOption;
return this;
}
protected boolean endsWithSlashOrAntislash(String newName) {
return newName.endsWith("/") || newName.endsWith("\\");
}
private List getCrashedImage(BlockUml blockUml, Throwable t, SFile outputFile) throws IOException {
final GeneratedImage image = new GeneratedImageImpl(outputFile, "Crash Error", blockUml, FileImageData.CRASH);
try (OutputStream os = outputFile.createBufferedOutputStream()) {
UmlDiagram.exportDiagramError(os, t, fileFormatOption, 42, null, blockUml.getFlashData(),
UmlDiagram.getFailureText2(t, blockUml.getFlashData()));
}
return Collections.singletonList(image);
}
protected void exportWarnOrErrIfWord(SFile f, Diagram system) throws FileNotFoundException {
if (OptionFlags.getInstance().isWord() && f != null) {
final String warnOrError = system.getWarningOrError();
if (warnOrError != null) {
final String name = f.getName().substring(0, f.getName().length() - 4) + ".err";
final SFile errorFile = f.getParentFile().file(name);
try (PrintStream ps = SecurityUtils.createPrintStream(errorFile.createFileOutputStream())) {
ps.print(warnOrError);
}
}
}
}
final public List getGeneratedImages() throws IOException {
Log.info("Reading file: " + file);
cpt = 0;
final List result = new ArrayList<>();
for (BlockUml blockUml : builder.getBlockUmls()) {
final SuggestedFile suggested = getSuggestedFile(blockUml);
final Diagram system;
try {
system = blockUml.getDiagram();
} catch (Throwable t) {
Logme.error(t);
if (OptionFlags.getInstance().isSilentlyCompletelyIgnoreErrors() || noerror)
continue;
return getCrashedImage(blockUml, t, suggested.getFile(0));
}
if (OptionFlags.getInstance().isSilentlyCompletelyIgnoreErrors() && system instanceof PSystemError)
continue;
OptionFlags.getInstance().logData(SFile.fromFile(file), system);
final List exportDiagrams;
if (noerror && system instanceof PSystemError) {
exportDiagrams = new ArrayList();
exportDiagrams
.add(new FileImageData(null, new ImageDataSimple(new XDimension2D(0, 0), FileImageData.ERROR)));
} else
exportDiagrams = PSystemUtils.exportDiagrams(system, suggested, fileFormatOption, checkMetadata);
if (exportDiagrams.size() > 1)
cpt += exportDiagrams.size() - 1;
for (FileImageData fdata : exportDiagrams) {
final String desc = "[" + file.getName() + "] " + system.getDescription();
final SFile f = fdata.getFile();
exportWarnOrErrIfWord(f, system);
final GeneratedImage generatedImage = new GeneratedImageImpl(f, desc, blockUml, fdata.getStatus());
result.add(generatedImage);
}
}
Log.info("Number of image(s): " + result.size());
return Collections.unmodifiableList(result);
}
abstract protected SuggestedFile getSuggestedFile(BlockUml blockUml) throws FileNotFoundException;
protected final void setNoerror(boolean noerror) {
this.noerror = noerror;
}
final protected String getFileName() {
return file.getName();
}
}