net.sourceforge.plantuml.ant.PlantUmlTask Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-asl Show documentation
Show all versions of plantuml-asl Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
The newest version!
// 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 Apache Software License.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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 APACHE license.
*
* The generated images can then be used without any reference to the APACHE 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.ant;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.FileList;
import org.apache.tools.ant.types.FileSet;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.GeneratedImage;
import net.sourceforge.plantuml.Option;
import net.sourceforge.plantuml.OptionFlags;
import net.sourceforge.plantuml.SourceFileReader;
import net.sourceforge.plantuml.Splash;
import net.sourceforge.plantuml.dot.GraphvizUtils;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.preproc.Defines;
import net.sourceforge.plantuml.stats.StatsUtils;
//
//
//
//
//
//
// Carriage Return in UTF-8 XML:
// Line Feed in UTF-8 XML:
public class PlantUmlTask extends Task {
// ::remove folder when __HAXE__
private String dir = null;
private final Option option = new Option();
private List filesets = new ArrayList<>();
private List filelists = new ArrayList<>();
private AtomicInteger nbFiles = new AtomicInteger(0);
private ExecutorService executorService;
/**
* Add a set of files to touch
*/
public void addFileset(FileSet set) {
filesets.add(set);
}
/**
* Add a filelist to touch
*/
public void addFilelist(FileList list) {
filelists.add(list);
}
// The method executing the task
@Override
public void execute() throws BuildException {
if (option.isSplash()) {
Splash.createSplash();
}
this.log("Starting PlantUML");
try {
if (dir != null) {
final File error = processingSingleDirectory(new File(dir));
eventuallyFailfast(error);
}
for (FileSet fileSet : filesets) {
final File error = manageFileSet(fileSet);
eventuallyFailfast(error);
}
for (FileList fileList : filelists) {
final File error = manageFileList(fileList);
eventuallyFailfast(error);
}
if (executorService != null) {
executorService.shutdown();
executorService.awaitTermination(Long.MAX_VALUE, TimeUnit.MILLISECONDS);
if (option.isSplash()) {
Splash.disposeSplash();
}
}
this.log("Nb images generated: " + nbFiles.get());
} catch (IOException e) {
Logme.error(e);
throw new BuildException(e.toString());
} catch (InterruptedException e) {
Logme.error(e);
throw new BuildException(e.toString());
}
}
private void eventuallyFailfast(final File error) throws IOException {
if (error != null && option.isFailfastOrFailfast2()) {
this.log("Error in file " + error.getCanonicalPath());
throw new BuildException("Error in file " + error.getCanonicalPath());
}
}
private File manageFileList(FileList fl) throws IOException, InterruptedException {
final File fromDir = fl.getDir(getProject());
final String[] srcFiles = fl.getFiles(getProject());
for (String src : srcFiles) {
final File f = new File(fromDir, src);
final boolean error = processingSingleFile(f);
if (error) {
return f;
}
}
return null;
}
private File manageFileSet(FileSet fs) throws IOException, InterruptedException {
final DirectoryScanner ds = fs.getDirectoryScanner(getProject());
final File fromDir = fs.getDir(getProject());
final String[] srcFiles = ds.getIncludedFiles();
final String[] srcDirs = ds.getIncludedDirectories();
for (String src : srcFiles) {
final File f = new File(fromDir, src);
final boolean error = processingSingleFile(f);
if (error) {
return f;
}
}
for (String src : srcDirs) {
final File dir = new File(fromDir, src);
final File errorFile = processingSingleDirectory(dir);
if (errorFile != null) {
return errorFile;
}
}
return null;
}
private boolean processingSingleFile(final File f) throws IOException, InterruptedException {
if (OptionFlags.getInstance().isVerbose()) {
this.log("Processing " + f.getAbsolutePath());
}
final SourceFileReader sourceFileReader = new SourceFileReader(Defines.createWithFileName(f), f,
option.getOutputDir(), option.getConfig(), option.getCharset(), option.getFileFormatOption());
if (option.isCheckOnly()) {
return sourceFileReader.hasError();
}
if (executorService == null) {
return doFile(f, sourceFileReader);
}
Splash.incTotal(1);
executorService.submit(new Callable() {
public Boolean call() throws Exception {
return doFile(f, sourceFileReader);
}
});
return false;
}
private boolean doFile(final File f, final SourceFileReader sourceFileReader)
throws IOException, InterruptedException {
final Collection result = sourceFileReader.getGeneratedImages();
boolean error = false;
for (GeneratedImage g : result) {
if (OptionFlags.getInstance().isVerbose()) {
myLog(g + " " + g.getDescription());
}
nbFiles.addAndGet(1);
if (g.lineErrorRaw() != -1) {
error = true;
}
}
Splash.incDone(error);
if (error) {
myLog("Error: " + f.getCanonicalPath());
}
if (error && option.isFailfastOrFailfast2()) {
return true;
}
return false;
}
private synchronized void myLog(String s) {
this.log(s);
}
private File processingSingleDirectory(File dir) throws IOException, InterruptedException {
if (dir.exists() == false) {
final String s = "The file " + dir.getAbsolutePath() + " does not exists.";
this.log(s);
throw new BuildException(s);
}
if (dir.listFiles() != null)
for (File f : dir.listFiles()) {
if (f.isFile() == false)
continue;
if (fileToProcess(f.getName()) == false)
continue;
final boolean error = processingSingleFile(f);
if (error)
return f;
}
return null;
}
private boolean fileToProcess(String name) {
return name.matches(Option.getPattern());
}
public void setDir(String s) {
this.dir = s;
}
public void setOutput(String s) {
option.setOutputDir(new File(s));
}
public void setCharset(String s) {
option.setCharset(s);
}
public void setConfig(String s) {
try {
option.initConfig(s);
} catch (IOException e) {
log("Error reading " + s);
}
}
public void setKeepTmpFiles(String s) {
// Deprecated
}
public void setDebugSvek(String s) {
if ("true".equalsIgnoreCase(s)) {
option.setDebugSvek(true);
}
}
public void setVerbose(String s) {
if ("true".equalsIgnoreCase(s)) {
OptionFlags.getInstance().setVerbose(true);
}
}
public void setFormat(String s) {
if ("scxml".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.SCXML));
}
if ("xmi".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.XMI_STANDARD));
}
if ("xmi:argo".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.XMI_ARGO));
}
if ("xmi:script".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.XMI_SCRIPT));
}
if ("xmi:start".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.XMI_STAR));
}
if ("eps".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.EPS));
}
if ("braille".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.BRAILLE_PNG));
}
if ("pdf".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.PDF));
}
if ("latex".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.LATEX));
}
if ("latex:nopreamble".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.LATEX_NO_PREAMBLE));
}
if ("eps:text".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.EPS_TEXT));
}
if ("svg".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.SVG));
}
if ("txt".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.ATXT));
}
if ("utxt".equalsIgnoreCase(s)) {
option.setFileFormatOption(new FileFormatOption(FileFormat.UTXT));
}
}
public void setGraphvizDot(String s) {
GraphvizUtils.setDotExecutable(s);
}
public void setNbThread(String s) {
if (s != null && s.matches("\\d+")) {
option.setNbThreads(Integer.parseInt(s));
final int nbThreads = option.getNbThreads();
this.executorService = Executors.newFixedThreadPool(nbThreads);
}
if ("auto".equalsIgnoreCase(s)) {
option.setNbThreads(Option.defaultNbThreads());
final int nbThreads = option.getNbThreads();
this.executorService = Executors.newFixedThreadPool(nbThreads);
}
}
public void setNbThreads(String s) {
setNbThread(s);
}
// public void setSuggestEngine(String s) {
// OptionFlags.getInstance().setUseSuggestEngine(
// "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s));
// }
public void setFailFast(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
option.setFailfast(flag);
}
public void setFailFast2(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
option.setFailfast2(flag);
}
public void setCheckOnly(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
option.setCheckOnly(flag);
}
public void setOverwrite(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
OptionFlags.getInstance().setOverwrite(flag);
}
public void setFileSeparator(String s) {
OptionFlags.getInstance().setFileSeparator(s);
}
public void setHtmlStats(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
StatsUtils.setHtmlStats(flag);
}
public void setXmlStats(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
StatsUtils.setXmlStats(flag);
}
public void setRealTimeStats(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
StatsUtils.setRealTimeStats(flag);
}
public void setEnableStats(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
OptionFlags.getInstance().setEnableStats(flag);
}
public void setSplash(String s) {
final boolean flag = "true".equalsIgnoreCase(s) || "yes".equalsIgnoreCase(s) || "on".equalsIgnoreCase(s);
option.setSplash(flag);
}
}