net.sourceforge.plantuml.math.ScientificEquationSafe 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.math;
import static net.atmp.ImageBuilder.plainImageBuilder;
import java.awt.Color;
import java.awt.image.BufferedImage;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Arrays;
import net.atmp.ImageBuilder;
import net.atmp.PixelImage;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.FileFormatOption;
import net.sourceforge.plantuml.api.ImageDataSimple;
import net.sourceforge.plantuml.core.ImageData;
import net.sourceforge.plantuml.klimt.AffineTransformType;
import net.sourceforge.plantuml.klimt.MutableImage;
import net.sourceforge.plantuml.klimt.drawing.eps.EpsGraphics;
import net.sourceforge.plantuml.klimt.shape.GraphicStrings;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.UImageSvg;
import net.sourceforge.plantuml.log.Logme;
import net.sourceforge.plantuml.security.SImageIO;
import net.sourceforge.plantuml.utils.Log;
public class ScientificEquationSafe {
private final ScientificEquation equation;
private final String formula;
private ScientificEquationSafe(String formula, ScientificEquation equation) {
this.formula = formula;
this.equation = equation;
}
public static ScientificEquationSafe fromAsciiMath(String formula) {
try {
return new ScientificEquationSafe(formula, new AsciiMath(formula));
} catch (Exception e) {
Logme.error(e);
Log.info("Error parsing " + formula);
return new ScientificEquationSafe(formula, null);
}
}
public static ScientificEquationSafe fromLatex(String formula) {
try {
return new ScientificEquationSafe(formula, new LatexBuilder(formula));
} catch (Exception e) {
Logme.error(e);
Log.info("Error parsing " + formula);
return new ScientificEquationSafe(formula, null);
}
}
private ImageData dimSvg;
public UImageSvg getSvg(double scale, Color foregroundColor, Color backgroundColor) {
if (equation != null)
try {
final UImageSvg svg = equation.getSvg(scale, foregroundColor, backgroundColor);
dimSvg = new ImageDataSimple(equation.getDimension());
return svg;
} catch (Exception e) {
printTrace(e);
}
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
try {
dimSvg = plainImageBuilder(getRollback(), new FileFormatOption(FileFormat.SVG)).write(baos);
} catch (IOException e1) {
return null;
}
return new UImageSvg(new String(baos.toByteArray()), scale);
}
public MutableImage getImage(Color foregroundColor, Color backgroundColor) {
if (equation != null)
try {
return equation.getImage(foregroundColor, backgroundColor);
} catch (Exception e) {
printTrace(e);
}
try {
final byte[] bytes = ImageBuilder.plainPngBuilder(getRollback()).writeByteArray();
return new PixelImage(SImageIO.read(bytes), AffineTransformType.TYPE_BILINEAR);
} catch (IOException e1) {
return null;
}
}
private void printTrace(Exception e) {
System.err.println("formula=" + formula);
if (equation != null) {
System.err.println("Latex=" + equation.getSource());
}
Logme.error(e);
}
private TextBlock getRollback() {
return GraphicStrings.createBlackOnWhiteMonospaced(Arrays.asList(formula));
}
public ImageData export(OutputStream os, FileFormatOption fileFormat, float scale, Color foregroundColor,
Color backgroundColor) throws IOException {
if (fileFormat.getFileFormat() == FileFormat.PNG) {
final BufferedImage image = getImage(foregroundColor, backgroundColor).withScale(scale).getImage();
SImageIO.write(image, "png", os);
return new ImageDataSimple(image.getWidth(), image.getHeight());
}
if (fileFormat.getFileFormat() == FileFormat.SVG) {
os.write(getSvg(1, foregroundColor, backgroundColor).getSvg(true).getBytes());
return dimSvg;
}
if (fileFormat.getFileFormat() == FileFormat.EPS) {
final BufferedImage image = getImage(foregroundColor, backgroundColor).withScale(scale).getImage();
final EpsGraphics out = new EpsGraphics();
out.drawImage(image, 0, 0);
out.close();
os.write(out.getEPSCode().getBytes());
return new ImageDataSimple(image.getWidth(), image.getHeight());
}
throw new UnsupportedOperationException();
}
public final String getFormula() {
return formula;
}
}