TeXFormula.java
/* TeXFormula.java
* =========================================================================
* This file is originally part of the JMathTeX Library - http://jmathtex.sourceforge.net
*
* Copyright (C) 2004-2007 Universiteit Gent
* Copyright (C) 2009 DENIZET Calixte
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* A copy of the GNU General Public License can be found in the file
* LICENSE.txt provided with the source distribution of this program (see
* the META-INF directory in the source jar). This license can also be
* found on the GNU website at http://www.gnu.org/licenses/gpl.html.
*
* If you did not receive a copy of the GNU General Public License along
* with this program, contact the lead developer, or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*
* Linking this library statically or dynamically with other modules
* is making a combined work based on this library. Thus, the terms
* and conditions of the GNU General Public License cover the whole
* combination.
*
* As a special exception, the copyright holders of this library give you
* permission to link this library with independent modules to produce
* an executable, regardless of the license terms of these independent
* modules, and to copy and distribute the resulting executable under terms
* of your choice, provided that you also meet, for each linked independent
* module, the terms and conditions of the license of that module.
* An independent module is a module which is not derived from or based
* on this library. If you modify this library, you may extend this exception
* to your version of the library, but you are not obliged to do so.
* If you do not wish to do so, delete this exception statement from your
* version.
*
*/
/* Modified by Calixte Denizet */
package org.scilab.forge.jlatexmath;
import java.io.InputStream;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import org.scilab.forge.jlatexmath.cyrillic.CyrillicRegistration;
import org.scilab.forge.jlatexmath.greek.GreekRegistration;
/**
* Represents a logical mathematical formula that will be displayed (by creating a
* {@link TeXIcon} from it and painting it) using algorithms that are based on the
* TeX algorithms.
* <p>
* These formula's can be built using the built-in primitive TeX parser
* (methods with String arguments) or using other TeXFormula objects. Most methods
* have (an) equivalent(s) where one or more TeXFormula arguments are replaced with
* String arguments. These are just shorter notations, because all they do is parse
* the string(s) to TeXFormula's and call an equivalent method with (a) TeXFormula argument(s).
* Most methods also come in 2 variants. One kind will use this TeXFormula to build
* another mathematical construction and then change this object to represent the newly
* build construction. The other kind will only use other
* TeXFormula's (or parse strings), build a mathematical construction with them and
* insert this newly build construction at the end of this TeXFormula.
* Because all the provided methods return a pointer to this (modified) TeXFormula
* (except for the createTeXIcon method that returns a TeXIcon pointer),
* method chaining is also possible.
* <p>
* <b> Important: All the provided methods modify this TeXFormula object, but all the
* TeXFormula arguments of these methods will remain unchanged and independent of
* this TeXFormula object!</b>
*/
public class TeXFormula {
public static final String VERSION = "1.0.3";
public static final int SERIF = 0;
public static final int SANSSERIF = 1;
public static final int BOLD = 2;
public static final int ITALIC = 4;
public static final int ROMAN = 8;
public static final int TYPEWRITER = 16;
// point-to-pixel conversion
public static float PIXELS_PER_POINT = 1f;
// font scale for deriving
public static float FONT_SCALE_FACTOR = 100f;
// for comparing floats with 0
protected static final float PREC = 0.0000001f;
// predefined TeXFormula's
public static Map<String, TeXFormula> predefinedTeXFormulas = new HashMap<String, TeXFormula>(150);
public static Map<String, String> predefinedTeXFormulasAsString = new HashMap<String, String>(150);
// character-to-symbol and character-to-delimiter mappings
public static String[] symbolMappings = new String[65536];
public static String[] symbolTextMappings = new String[65536];
public static String[] symbolFormulaMappings = new String[65536];
public List<MiddleAtom> middle = new LinkedList<MiddleAtom>();
protected Map<String, String> jlmXMLMap;
private TeXParser parser;
static {
// character-to-symbol and character-to-delimiter mappings
TeXFormulaSettingsParser parser = new TeXFormulaSettingsParser();
parser.parseSymbolMappings(symbolMappings, symbolTextMappings);
new PredefinedCommands();
new PredefinedTeXFormulas();
new PredefMacros();
parser.parseSymbolToFormulaMappings(symbolFormulaMappings, symbolTextMappings);
// direct: the reflection (Class.forName + newInstance) does not work in the TeaVM C build
DefaultTeXFont.registerAlphabet(new CyrillicRegistration());
DefaultTeXFont.registerAlphabet(new GreekRegistration());
//setDefaultDPI();
}
public static void addSymbolMappings(InputStream in, String name) throws ResourceParseException {
TeXFormulaSettingsParser tfsp = new TeXFormulaSettingsParser(in, name);
tfsp.parseSymbolMappings(symbolMappings, symbolTextMappings);
tfsp.parseSymbolToFormulaMappings(symbolFormulaMappings, symbolTextMappings);
}
// the root atom of the "atom tree" that represents the formula
public Atom root = null;
// the current text style
public String textStyle = null;
public boolean isColored = false;
/**
* Creates an empty TeXFormula.
*
*/
public TeXFormula() {
parser = new TeXParser("", this, false);
}
/**
* Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).
*
* @param s the string to be parsed
* @throws ParseException if the string could not be parsed correctly
*/
public TeXFormula(String s, Map<String, String> map) throws ParseException {
this.jlmXMLMap = map;
parser = new TeXParser(s, this);
parser.parse();
}
/**
* Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).
*
* @param s the string to be parsed
* @throws ParseException if the string could not be parsed correctly
*/
public TeXFormula(String s) throws ParseException {
this(s, (String) null);
}
public TeXFormula(String s, boolean firstpass) throws ParseException {
this.textStyle = null;
parser = new TeXParser(s, this, firstpass);
parser.parse();
}
/*
* Creates a TeXFormula by parsing the given string in the given text style.
* Used when a text style command was found in the parse string.
*/
public TeXFormula(String s, String textStyle) throws ParseException {
this.textStyle = textStyle;
parser = new TeXParser(s, this);
parser.parse();
}
public TeXFormula(String s, String textStyle, boolean firstpass, boolean space) throws ParseException {
this.textStyle = textStyle;
parser = new TeXParser(s, this, firstpass, space);
parser.parse();
}
/**
* Creates a new TeXFormula that is a copy of the given TeXFormula.
* <p>
* <b>Both TeXFormula's are independent of one another!</b>
*
* @param f the formula to be copied
*/
public TeXFormula(TeXFormula f) {
if (f != null) {
addImpl(f);
}
}
/**
* Creates an empty TeXFormula.
*
*/
protected TeXFormula(TeXParser tp) {
this.jlmXMLMap = tp.formula.jlmXMLMap;
parser = new TeXParser(tp.getIsPartial(), "", this, false);
}
/**
* Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).
*
* @param s the string to be parsed
* @throws ParseException if the string could not be parsed correctly
*/
protected TeXFormula(TeXParser tp, String s) throws ParseException {
this(tp, s, null);
}
protected TeXFormula(TeXParser tp, String s, boolean firstpass) throws ParseException {
this.textStyle = null;
this.jlmXMLMap = tp.formula.jlmXMLMap;
boolean isPartial = tp.getIsPartial();
parser = new TeXParser(isPartial, s, this, firstpass);
if (isPartial) {
try {
parser.parse();
} catch (Exception e) { }
} else {
parser.parse();
}
}
/*
* Creates a TeXFormula by parsing the given string in the given text style.
* Used when a text style command was found in the parse string.
*/
protected TeXFormula(TeXParser tp, String s, String textStyle) throws ParseException {
this.textStyle = textStyle;
this.jlmXMLMap = tp.formula.jlmXMLMap;
boolean isPartial = tp.getIsPartial();
parser = new TeXParser(isPartial, s, this);
if (isPartial) {
try {
parser.parse();
} catch (Exception e) {
if (root == null) {
root = new EmptyAtom();
}
}
} else {
parser.parse();
}
}
protected TeXFormula(TeXParser tp, String s, String textStyle, boolean firstpass, boolean space) throws ParseException {
this.textStyle = textStyle;
this.jlmXMLMap = tp.formula.jlmXMLMap;
boolean isPartial = tp.getIsPartial();
parser = new TeXParser(isPartial, s, this, firstpass, space);
if (isPartial) {
try {
parser.parse();
} catch (Exception e) {
if (root == null) {
root = new EmptyAtom();
}
}
} else {
parser.parse();
}
}
/**
* Change the text of the TeXFormula and regenerate the root
*
* @param ltx the latex formula
*/
public void setLaTeX(String ltx) throws ParseException {
parser.reset(ltx);
if (ltx != null && ltx.length() != 0)
parser.parse();
}
/**
* Inserts an atom at the end of the current formula
*/
public TeXFormula add(Atom el) {
if (el != null) {
if (el instanceof MiddleAtom)
middle.add((MiddleAtom) el);
if (root == null) {
root = el;
} else {
if (!(root instanceof RowAtom)) {
root = new RowAtom(root);
}
((RowAtom) root).add(el);
if (el instanceof TypedAtom) {
TypedAtom ta = (TypedAtom) el;
int rtype = ta.getRightType();
if (rtype == TeXConstants.TYPE_BINARY_OPERATOR || rtype == TeXConstants.TYPE_RELATION) {
((RowAtom) root).add(new BreakMarkAtom());
}
}
}
}
return this;
}
public TeXFormula append(boolean isPartial, String s) throws ParseException {
if (s != null && s.length() != 0) {
TeXParser tp = new TeXParser(isPartial, s, this);
tp.parse();
}
return this;
}
private void addImpl(TeXFormula f) {
if (f.root != null) {
// special copy-treatment for Mrow as a root!!
if (f.root instanceof RowAtom)
add(new RowAtom(f.root));
else
add(f.root);
}
}
/*
* Convert this TeXFormula into a box, starting form the given style
*/
private Box createBox(TeXEnvironment style) {
if (root == null)
return new StrutBox(0, 0, 0, 0);
else
return root.createBox(style);
}
private DefaultTeXFont createFont(float size, int type) {
DefaultTeXFont dtf = new DefaultTeXFont(size);
if (type == 0) {
dtf.setSs(false);
}
if ((type & ROMAN) != 0) {
dtf.setRoman(true);
}
if ((type & TYPEWRITER) != 0) {
dtf.setTt(true);
}
if ((type & SANSSERIF) != 0) {
dtf.setSs(true);
}
if ((type & ITALIC) != 0) {
dtf.setIt(true);
}
if ((type & BOLD) != 0) {
dtf.setBold(true);
}
return dtf;
}
/**
* Apply the Builder pattern instead of using the createTeXIcon(...) factories
* @author Felix Natter
*
*/
public class TeXIconBuilder {
private Integer style;
private Float size;
private Integer type;
private TeXColor fgcolor;
private boolean trueValues = false;
private Integer widthUnit;
private Float textWidth;
private Integer align;
private boolean isMaxWidth = false;
private Integer interLineUnit;
private Float interLineSpacing;
private TeXTextMeasurer textMeasurer;
/**
* Specify the style for rendering the given TeXFormula
* @param style the style
* @return the builder, used for chaining
*/
public TeXIconBuilder setStyle(final int style) {
this.style = style;
return this;
}
/**
* Specify the font size for rendering the given TeXFormula
* @param size the size
* @return the builder, used for chaining
*/
public TeXIconBuilder setSize(final float size) {
this.size = size;
return this;
}
/**
* Specify the font type for rendering the given TeXFormula
* @param type the font type
* @return the builder, used for chaining
*/
public TeXIconBuilder setType(final int type) {
this.type = type;
return this;
}
/**
* Specify the background color for rendering the given TeXFormula
* @param fgcolor the foreground color
* @return the builder, used for chaining
*/
public TeXIconBuilder setFGColor(final TeXColor fgcolor) {
this.fgcolor = fgcolor;
return this;
}
/**
* Specify the "true values" parameter for rendering the given TeXFormula
* @param trueValues the "true values" value
* @return the builder, used for chaining
*/
public TeXIconBuilder setTrueValues(final boolean trueValues) {
this.trueValues = trueValues;
return this;
}
/**
* Specify the width of the formula (may be exact or maximum width, see {@link #setIsMaxWidth(boolean)})
* @param widthUnit the width unit
* @param textWidth the width
* @param align the alignment
* @return the builder, used for chaining
*/
public TeXIconBuilder setWidth(final int widthUnit, final float textWidth, final int align) {
this.widthUnit = widthUnit;
this.textWidth = textWidth;
this.align = align;
trueValues = true; // TODO: is this necessary?
return this;
}
/**
* Specifies whether the width is the exact or the maximum width
* @param isMaxWidth whether the width is a maximum width
* @return the builder, used for chaining
*/
public TeXIconBuilder setIsMaxWidth(final boolean isMaxWidth) {
if (widthUnit == null) {
throw new IllegalStateException("Cannot set 'isMaxWidth' without having specified a width!");
}
if (isMaxWidth) {
// NOTE: Currently isMaxWidth==true does not work with ALIGN_CENTER or ALIGN_RIGHT (see HorizontalBox ctor)
// The case (1) we don't support by setting align := ALIGN_LEFT here is this:
// \text{hello world\\hello} with align=ALIGN_CENTER (but forced to ALIGN_LEFT) and isMaxWidth==true results in:
// [hello world]
// [hello ]
// and NOT:
// [hello world]
// [ hello ]
// However, this case (2) is currently not supported anyway (ALIGN_CENTER with isMaxWidth==false):
// [ hello world ]
// [ hello ]
// and NOT:
// [ hello world ]
// [ hello ]
// => until (2) is solved, we stick with the hack to set align := ALIGN_LEFT!
this.align = TeXConstants.ALIGN_LEFT;
}
this.isMaxWidth = isMaxWidth;
return this;
}
/**
* Specify the inter line spacing unit and value. NOTE: this is required for automatic linebreaks to work!
* @param interLineUnit the unit
* @param interLineSpacing the value
* @return the builder, used for chaining
*/
public TeXIconBuilder setInterLineSpacing(final int interLineUnit, final float interLineSpacing) {
if (widthUnit == null) {
throw new IllegalStateException("Cannot set inter line spacing without having specified a width!");
}
this.interLineUnit = interLineUnit;
this.interLineSpacing = interLineSpacing;
return this;
}
/**
* Gives the measure of the text that has no TeX glyph (CJK, ...), which the
* canvas draws. Without it, a rough estimate is used.
* @param textMeasurer the measurer
* @return the builder, used for chaining
*/
public TeXIconBuilder setTextMeasurer(final TeXTextMeasurer textMeasurer) {
this.textMeasurer = textMeasurer;
return this;
}
/**
* Create a TeXIcon from the information gathered by the (chained) setXXX() methods.
* (see Builder pattern)
* @return the TeXIcon
*/
public TeXIcon build() {
if (style == null) {
throw new IllegalStateException("A style is required. Use setStyle()");
}
if (size == null) {
throw new IllegalStateException("A size is required. Use setStyle()");
}
DefaultTeXFont font = (type == null) ? new DefaultTeXFont(size) : createFont(size, type);
TeXEnvironment te;
if (widthUnit != null) {
te = new TeXEnvironment(style, font, widthUnit, textWidth);
} else {
te = new TeXEnvironment(style, font);
}
if (interLineUnit != null) {
te.setInterline(interLineUnit, interLineSpacing);
}
te.setTextMeasurer(textMeasurer);
Box box = createBox(te);
TeXIcon ti;
if (widthUnit != null) {
HorizontalBox hb;
if (interLineUnit != null) {
float il = interLineSpacing * SpaceAtom.getFactor(interLineUnit, te);
Box b = BreakFormula.split(box, te.getTextwidth(), il);
hb = new HorizontalBox(b, isMaxWidth ? b.getWidth() : te.getTextwidth(), align);
} else {
hb = new HorizontalBox(box, isMaxWidth ? box.getWidth() : te.getTextwidth(), align);
}
ti = new TeXIcon(hb, size, trueValues);
} else {
ti = new TeXIcon(box, size, trueValues);
}
if (fgcolor != null) {
ti.setForeground(fgcolor);
}
ti.isColored = te.isColored;
return ti;
}
}
/**
* Creates a TeXIcon from this TeXFormula using the default TeXFont in the given
* point size and starting from the given TeX style. If the given integer value
* does not represent a valid TeX style, the default style
* TeXConstants.STYLE_DISPLAY will be used.
*
* @param style a TeX style constant (from {@link TeXConstants}) to start from
* @param size the default TeXFont's point size
* @return the created TeXIcon
*/
public TeXIcon createTeXIcon(int style, float size) {
return new TeXIconBuilder().setStyle(style).setSize(size).build();
}
/**
* Get a predefined TeXFormula.
*
* @param name the name of the predefined TeXFormula
* @return a copy of the predefined TeXFormula
* @throws FormulaNotFoundException if no predefined TeXFormula is found with the
* given name
*/
public static TeXFormula get(String name) throws FormulaNotFoundException {
TeXFormula formula = predefinedTeXFormulas.get(name);
if (formula == null) {
String f = predefinedTeXFormulasAsString.get(name);
if (f == null) {
throw new FormulaNotFoundException(name);
}
TeXFormula tf = new TeXFormula(f);
if (!(tf.root instanceof RowAtom)) {
// depending of the context a RowAtom can be modified
// so we can't reuse it
predefinedTeXFormulas.put(name, tf);
}
return tf;
} else {
return new TeXFormula(formula);
}
}
}