lyx_mirror/src/mathed/MathFactory.cpp
Enrico Forestieri e224ef029b Implement the suggestion by Andre'
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@25287 a592a061-630c-0410-9148-cb99ea01b6c8
2008-06-17 11:10:43 +00:00

473 lines
13 KiB
C++

/**
* \file MathFactory.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "MathFactory.h"
#include "InsetMathAMSArray.h"
#include "InsetMathArray.h"
#include "InsetMathBoldSymbol.h"
#include "InsetMathBox.h"
#include "InsetMathCases.h"
#include "InsetMathColor.h"
#include "InsetMathDecoration.h"
#include "InsetMathDots.h"
#include "InsetMathFont.h"
#include "InsetMathFontOld.h"
#include "InsetMathFrac.h"
#include "InsetMathKern.h"
#include "InsetMathLefteqn.h"
#include "InsetMathOverset.h"
#include "InsetMathPhantom.h"
#include "InsetMathRef.h"
#include "InsetMathRoot.h"
#include "InsetMathSize.h"
#include "InsetMathSpace.h"
#include "InsetMathSplit.h"
#include "InsetMathSqrt.h"
#include "InsetMathStackrel.h"
#include "InsetMathSubstack.h"
#include "InsetMathSymbol.h"
#include "InsetMathTabular.h"
#include "InsetMathUnderset.h"
#include "InsetMathUnknown.h"
#include "InsetMathXArrow.h"
#include "InsetMathXYMatrix.h"
#include "MacroTable.h"
#include "MathMacro.h"
#include "MathMacroArgument.h"
#include "MathParser.h"
#include "MathStream.h"
#include "MathSupport.h"
#include "insets/InsetCommand.h"
#include "support/debug.h"
#include "support/docstream.h"
#include "support/FileName.h"
#include "support/filetools.h" // LibFileSearch
#include "support/lstrings.h"
#include "frontends/FontLoader.h"
#include "LyX.h" // use_gui
using namespace std;
using namespace lyx::support;
namespace lyx {
bool has_math_fonts;
namespace {
MathWordList theWordList;
bool isMathFontAvailable(docstring & name)
{
FontInfo f;
augmentFont(f, name);
// Do we have the font proper?
if (theFontLoader().available(f))
return true;
// can we fake it?
if (name == "eufrak") {
name = from_ascii("lyxfakefrak");
return true;
}
LYXERR(Debug::MATHED,
"font " << to_utf8(name) << " not available and I can't fake it");
return false;
}
void initSymbols()
{
if (!use_gui)
return;
FileName const filename = libFileSearch(string(), "symbols");
LYXERR(Debug::MATHED, "read symbols from " << filename);
if (filename.empty()) {
lyxerr << "Could not find symbols file" << endl;
return;
}
ifstream fs(filename.toFilesystemEncoding().c_str());
string line;
bool skip = false;
while (getline(fs, line)) {
int charid = 0;
int fallbackid = 0;
if (line.empty() || line[0] == '#')
continue;
// special case of iffont/else/endif
if (line.size() >= 7 && line.substr(0, 6) == "iffont") {
istringstream is(line);
string tmp;
is >> tmp;
is >> tmp;
docstring t = from_utf8(tmp);
skip = !isMathFontAvailable(t);
continue;
} else if (line.size() >= 4 && line.substr(0, 4) == "else") {
skip = !skip;
} else if (line.size() >= 5 && line.substr(0, 5) == "endif") {
skip = false;
continue;
} else if (skip)
continue;
// special case of pre-defined macros
if (line.size() > 8 && line.substr(0, 5) == "\\def\\") {
//lyxerr << "macro definition: '" << line << '\'' << endl;
istringstream is(line);
string macro;
string requires;
is >> macro >> requires;
MacroTable::globalMacros().insert(from_utf8(macro), requires);
continue;
}
idocstringstream is(from_utf8(line));
latexkeys tmp;
is >> tmp.name >> tmp.inset;
if (isFontName(tmp.inset))
is >> charid >> fallbackid >> tmp.extra >> tmp.xmlname;
else
is >> tmp.extra;
// requires is optional
if (is)
is >> tmp.requires;
else {
LYXERR(Debug::MATHED, "skipping line '" << line << "'\n"
<< to_utf8(tmp.name) << ' ' << to_utf8(tmp.inset) << ' '
<< to_utf8(tmp.extra));
continue;
}
if (isFontName(tmp.inset)) {
// tmp.inset _is_ the fontname here.
// create fallbacks if necessary
// store requirements as long as we can
if (tmp.requires.empty()) {
if (tmp.inset == "msa" || tmp.inset == "msb")
tmp.requires = from_ascii("amssymb");
else if (tmp.inset == "wasy")
tmp.requires = from_ascii("wasysym");
}
// symbol font is not available sometimes
docstring symbol_font = from_ascii("lyxsymbol");
if (tmp.extra == "func" || tmp.extra == "funclim" || tmp.extra == "special") {
LYXERR(Debug::MATHED, "symbol abuse for " << to_utf8(tmp.name));
tmp.draw = tmp.name;
} else if (isMathFontAvailable(tmp.inset)) {
LYXERR(Debug::MATHED, "symbol available for " << to_utf8(tmp.name));
tmp.draw.push_back(char_type(charid));
} else if (fallbackid && isMathFontAvailable(symbol_font)) {
if (tmp.inset == "cmex")
tmp.inset = from_ascii("lyxsymbol");
else
tmp.inset = from_ascii("lyxboldsymbol");
LYXERR(Debug::MATHED, "symbol fallback for " << to_utf8(tmp.name));
tmp.draw.push_back(char_type(fallbackid));
} else {
LYXERR(Debug::MATHED, "faking " << to_utf8(tmp.name));
tmp.draw = tmp.name;
tmp.inset = from_ascii("lyxtex");
}
} else {
// it's a proper inset
LYXERR(Debug::MATHED, "inset " << to_utf8(tmp.inset)
<< " used for " << to_utf8(tmp.name));
}
if (theWordList.find(tmp.name) != theWordList.end())
LYXERR(Debug::MATHED, "readSymbols: inset " << to_utf8(tmp.name)
<< " already exists.");
else
theWordList[tmp.name] = tmp;
LYXERR(Debug::MATHED, "read symbol '" << to_utf8(tmp.name)
<< " inset: " << to_utf8(tmp.inset)
<< " draw: " << int(tmp.draw.empty() ? 0 : tmp.draw[0])
<< " extra: " << to_utf8(tmp.extra)
<< " requires: " << to_utf8(tmp.requires) << '\'');
}
docstring tmp = from_ascii("cmm");
docstring tmp2 = from_ascii("cmsy");
has_math_fonts = isMathFontAvailable(tmp) && isMathFontAvailable(tmp2);
}
} // namespace anon
MathWordList const & mathedWordList()
{
return theWordList;
}
void initMath()
{
static bool initialized = false;
if (!initialized) {
initialized = true;
initParser();
initSymbols();
}
}
bool ensureMath(WriteStream & os, bool needs_math_mode, bool macro)
{
bool brace = os.pendingBrace();
os.pendingBrace(false);
if (!os.latex())
return brace;
if (os.textMode() && needs_math_mode) {
os << "\\ensuremath{";
os.textMode(false);
brace = true;
} else if (macro && brace && !needs_math_mode) {
// This is a user defined macro, but not a MathMacro, so we
// cannot be sure what mode is needed. As it was entered in
// a text box, we restore the text mode.
os << '}';
os.textMode(true);
brace = false;
}
return brace;
}
bool ensureMode(WriteStream & os, InsetMath::mode_type mode)
{
bool textmode = mode == InsetMath::TEXT_MODE;
if (os.latex() && textmode && os.pendingBrace()) {
os.os() << '}';
os.pendingBrace(false);
os.pendingSpace(false);
os.textMode(true);
}
bool oldmode = os.textMode();
os.textMode(textmode);
return oldmode;
}
latexkeys const * in_word_set(docstring const & str)
{
MathWordList::iterator it = theWordList.find(str);
return it != theWordList.end() ? &(it->second) : 0;
}
MathAtom createInsetMath(char const * const s)
{
return createInsetMath(from_utf8(s));
}
MathAtom createInsetMath(docstring const & s)
{
//lyxerr << "creating inset with name: '" << to_utf8(s) << '\'' << endl;
latexkeys const * l = in_word_set(s);
if (l) {
docstring const & inset = l->inset;
//lyxerr << " found inset: '" << inset << '\'' << endl;
if (inset == "ref")
return MathAtom(new InsetMathRef(l->name));
if (inset == "overset")
return MathAtom(new InsetMathOverset);
if (inset == "underset")
return MathAtom(new InsetMathUnderset);
if (inset == "decoration")
return MathAtom(new InsetMathDecoration(l));
if (inset == "space")
return MathAtom(new InsetMathSpace(l->name));
if (inset == "dots")
return MathAtom(new InsetMathDots(l));
if (inset == "mbox")
// return MathAtom(new InsetMathMBox);
// InsetMathMBox is proposed to replace InsetMathBox,
// but is not ready yet (it needs a BufferView for
// construction)
return MathAtom(new InsetMathBox(l->name));
// if (inset == "fbox")
// return MathAtom(new InsetMathFBox(l));
if (inset == "style")
return MathAtom(new InsetMathSize(l));
if (inset == "font")
return MathAtom(new InsetMathFont(l));
if (inset == "oldfont")
return MathAtom(new InsetMathFontOld(l));
if (inset == "matrix")
return MathAtom(new InsetMathAMSArray(s));
if (inset == "split")
return MathAtom(new InsetMathSplit(s));
if (inset == "big")
// we can't create a InsetMathBig, since the argument
// is missing.
return MathAtom(new InsetMathUnknown(s));
return MathAtom(new InsetMathSymbol(l));
}
if (s.size() == 2 && s[0] == '#' && s[1] >= '1' && s[1] <= '9')
return MathAtom(new MathMacroArgument(s[1] - '0'));
if (s.size() == 3 && s[0] == '\\' && s[1] == '#'
&& s[2] >= '1' && s[2] <= '9')
return MathAtom(new MathMacroArgument(s[2] - '0'));
if (s == "boxed")
return MathAtom(new InsetMathBoxed());
if (s == "fbox")
return MathAtom(new InsetMathFBox());
if (s == "framebox")
return MathAtom(new InsetMathMakebox(true));
if (s == "makebox")
return MathAtom(new InsetMathMakebox(false));
if (s == "kern")
return MathAtom(new InsetMathKern);
if (s.substr(0, 8) == "xymatrix") {
char spacing_code = '\0';
Length spacing;
size_t const len = s.length();
size_t i = 8;
if (i < len && s[i] == '@') {
++i;
if (i < len) {
switch (s[i]) {
case 'R':
case 'C':
case 'M':
case 'W':
case 'H':
case 'L':
spacing_code = static_cast<char>(s[i]);
++i;
break;
}
}
if (i < len && s[i] == '=') {
++i;
spacing = Length(to_ascii(s.substr(i)));
}
}
return MathAtom(new InsetMathXYMatrix(spacing, spacing_code));
}
if (s == "xrightarrow" || s == "xleftarrow")
return MathAtom(new InsetMathXArrow(s));
if (s == "split" || s == "gathered" || s == "aligned" || s == "alignedat")
return MathAtom(new InsetMathSplit(s));
if (s == "cases")
return MathAtom(new InsetMathCases);
if (s == "substack")
return MathAtom(new InsetMathSubstack);
if (s == "subarray" || s == "array")
return MathAtom(new InsetMathArray(s, 1, 1));
if (s == "sqrt")
return MathAtom(new InsetMathSqrt);
if (s == "root")
return MathAtom(new InsetMathRoot);
if (s == "tabular")
return MathAtom(new InsetMathTabular(s, 1, 1));
if (s == "stackrel")
return MathAtom(new InsetMathStackrel);
if (s == "binom")
return MathAtom(new InsetMathBinom(InsetMathBinom::BINOM));
if (s == "choose")
return MathAtom(new InsetMathBinom(InsetMathBinom::CHOOSE));
if (s == "brace")
return MathAtom(new InsetMathBinom(InsetMathBinom::BRACE));
if (s == "brack")
return MathAtom(new InsetMathBinom(InsetMathBinom::BRACK));
if (s == "frac")
return MathAtom(new InsetMathFrac);
if (s == "over")
return MathAtom(new InsetMathFrac(InsetMathFrac::OVER));
if (s == "nicefrac")
return MathAtom(new InsetMathFrac(InsetMathFrac::NICEFRAC));
if (s == "unitfrac")
return MathAtom(new InsetMathFrac(InsetMathFrac::UNITFRAC));
// This string value is only for math toolbar use. Not a LaTeX name
if (s == "unitfracthree")
return MathAtom(new InsetMathFrac(InsetMathFrac::UNITFRAC, 3));
if (s == "unitone")
return MathAtom(new InsetMathFrac(InsetMathFrac::UNIT, 1));
if (s == "unittwo")
return MathAtom(new InsetMathFrac(InsetMathFrac::UNIT));
//if (s == "infer")
// return MathAtom(new MathInferInset);
if (s == "atop")
return MathAtom(new InsetMathFrac(InsetMathFrac::ATOP));
if (s == "lefteqn")
return MathAtom(new InsetMathLefteqn);
if (s == "boldsymbol")
return MathAtom(new InsetMathBoldSymbol(InsetMathBoldSymbol::AMS_BOLD));
if (s == "bm")
return MathAtom(new InsetMathBoldSymbol(InsetMathBoldSymbol::BM_BOLD));
if (s == "heavysymbol" || s == "hm")
return MathAtom(new InsetMathBoldSymbol(InsetMathBoldSymbol::BM_HEAVY));
if (s == "color" || s == "normalcolor")
return MathAtom(new InsetMathColor(true));
if (s == "textcolor")
return MathAtom(new InsetMathColor(false));
if (s == "dfrac")
return MathAtom(new InsetMathDFrac);
if (s == "tfrac")
return MathAtom(new InsetMathTFrac);
if (s == "dbinom")
return MathAtom(new InsetMathDBinom);
if (s == "tbinom")
return MathAtom(new InsetMathTBinom);
if (s == "hphantom")
return MathAtom(new InsetMathPhantom(InsetMathPhantom::hphantom));
if (s == "phantom")
return MathAtom(new InsetMathPhantom(InsetMathPhantom::phantom));
if (s == "vphantom")
return MathAtom(new InsetMathPhantom(InsetMathPhantom::vphantom));
return MathAtom(new MathMacro(s));
}
bool createInsetMath_fromDialogStr(docstring const & str, MathData & ar)
{
// An example str:
// "ref LatexCommand ref\nreference \"sec:Title\"\n\\end_inset\n\n";
docstring name;
docstring body = split(str, name, ' ');
if (name != "ref" )
return false;
InsetCommandParams icp(REF_CODE);
// FIXME UNICODE
InsetCommand::string2params("ref", to_utf8(str), icp);
mathed_parse_cell(ar, icp.getCommand());
if (ar.size() != 1)
return false;
return ar[0].nucleus();
}
} // namespace lyx