/* SymbolAtom.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 com.himamis.retex.renderer.share;
import java.util.Map;
import com.himamis.retex.renderer.share.exception.InvalidSymbolTypeException;
import com.himamis.retex.renderer.share.exception.SymbolMappingNotFoundException;
import com.himamis.retex.renderer.share.exception.SymbolNotFoundException;
import com.himamis.retex.renderer.share.platform.Resource;
/**
* A box representing a symbol (a non-alphanumeric character).
*/
public class SymbolAtom extends CharSymbol {
// whether it's is a delimiter symbol
private final boolean delimiter;
// symbol name
private final String name;
// contains all defined symbols
public static Map<String, SymbolAtom> symbols;
// contains all the possible valid symbol types
private static BitSet validSymbolTypes;
private char unicode;
@Override
final public Atom duplicate() {
SymbolAtom ret = new SymbolAtom(name, delimiter);
ret.unicode = unicode;
ret.textSymbol = textSymbol;
return setFields(ret);
}
static {
symbols = new TeXSymbolParser().readSymbols();
// set valid symbol types
validSymbolTypes = new BitSet();
validSymbolTypes.setBit(TeXConstants.TYPE_ORDINARY);
validSymbolTypes.setBit(TeXConstants.TYPE_BIG_OPERATOR);
validSymbolTypes.setBit(TeXConstants.TYPE_BINARY_OPERATOR);
validSymbolTypes.setBit(TeXConstants.TYPE_RELATION);
validSymbolTypes.setBit(TeXConstants.TYPE_OPENING);
validSymbolTypes.setBit(TeXConstants.TYPE_CLOSING);
validSymbolTypes.setBit(TeXConstants.TYPE_PUNCTUATION);
validSymbolTypes.setBit(TeXConstants.TYPE_ACCENT);
}
public SymbolAtom(SymbolAtom s, int type) throws InvalidSymbolTypeException {
if (!validSymbolTypes.getBit(type)) {
throw new InvalidSymbolTypeException("The symbol type was not valid! "
+ "Use one of the symbol type constants from the class 'TeXConstants'.");
}
name = s.name;
this.type = type;
if (type == TeXConstants.TYPE_BIG_OPERATOR) {
this.type_limits = TeXConstants.SCRIPT_NORMAL;
}
delimiter = s.delimiter;
}
/**
* Constructs a new symbol. This used by "TeXSymbolParser" and the symbol types are guaranteed
* to be valid.
*
* @param name symbol name
* @param type symbol type constant
* @param del whether the symbol is a delimiter
*/
public SymbolAtom(String name, int type, boolean del) {
this.name = name;
this.type = type;
if (type == TeXConstants.TYPE_BIG_OPERATOR) {
this.type_limits = TeXConstants.SCRIPT_NORMAL;
}
delimiter = del;
}
public SymbolAtom(String name, boolean delimiter) {
this.delimiter = delimiter;
this.name = name;
}
public SymbolAtom setUnicode(char c) {
this.unicode = c;
return this;
}
public char getUnicode() {
return unicode;
}
public static void addSymbolAtom(String file) {
Object in = new Resource().loadResource(file);
addSymbolAtom(in, file);
}
public static void addSymbolAtom(Object in, String name) {
TeXSymbolParser tsp = new TeXSymbolParser(in, name);
symbols.putAll(tsp.readSymbols());
}
public static void addSymbolAtom(SymbolAtom sym) {
symbols.put(sym.name, sym);
}
/**
* Looks up the name in the table and returns the corresponding SymbolAtom representing the
* symbol (if it's found).
*
* @param name the name of the symbol
* @return a SymbolAtom representing the found symbol
* @throws SymbolNotFoundException if no symbol with the given name was found
*/
public static SymbolAtom get(String name) throws SymbolNotFoundException {
Object obj = symbols.get(name);
if (obj == null) {
throw new SymbolNotFoundException(name);
}
return (SymbolAtom) obj;
}
/**
*
* @return true if this symbol can act as a delimiter to embrace formulas
*/
public boolean isDelimiter() {
return delimiter;
}
public String getName() {
return name;
}
@Override
public Box createBox(TeXEnvironment env) {
TeXFont tf = env.getTeXFont();
int style = env.getStyle();
Char c = tf.getChar(name, style);
Box cb = new CharBox(c);
cb.setAtom(this);
if (env.getSmallCap() && unicode != 0 && Character.isLowerCase(unicode)) {
try {
cb = new ScaleBox(new CharBox(tf.getChar(
TeXFormula.symbolTextMappings[Character.toUpperCase(unicode)], style)), 0.8, 0.8);
} catch (SymbolMappingNotFoundException e) {
}
}
if (type == TeXConstants.TYPE_BIG_OPERATOR) {
if (style < TeXConstants.STYLE_TEXT && tf.hasNextLarger(c)) {
c = tf.getNextLarger(c, style);
}
cb = new CharBox(c);
cb.setAtom(this);
cb.setShift(-(cb.getHeight() + cb.getDepth()) / 2
- env.getTeXFont().getAxisHeight(env.getStyle()));
double delta = c.getItalic();
HorizontalBox hb = new HorizontalBox(cb);
if (delta > TeXFormula.PREC) {
hb.add(new StrutBox(delta, 0, 0, 0));
}
return hb;
}
return cb;
}
@Override
public CharFont getCharFont(TeXFont tf) {
// style doesn't matter here
return tf.getChar(name, TeXConstants.STYLE_DISPLAY).getCharFont();
}
}