]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/MathFactory.cpp
Account for old versions of Pygments
[lyx.git] / src / mathed / MathFactory.cpp
index eae377706593f0de34e9b8efd21ddaff1c40e7d1..79ae676fc39b3ddc3d583149fd7d306f41e6d568 100644 (file)
 #include "InsetMathArray.h"
 #include "InsetMathBoldSymbol.h"
 #include "InsetMathBox.h"
+#include "InsetMathCancel.h"
+#include "InsetMathCancelto.h"
 #include "InsetMathCases.h"
+#include "InsetMathClass.h"
 #include "InsetMathColor.h"
 #include "InsetMathDecoration.h"
 #include "InsetMathDots.h"
@@ -30,6 +33,7 @@
 #include "InsetMathPhantom.h"
 #include "InsetMathRef.h"
 #include "InsetMathRoot.h"
+#include "InsetMathSideset.h"
 #include "InsetMathSize.h"
 #include "InsetMathSpace.h"
 #include "InsetMathSpecialChar.h"
@@ -44,6 +48,7 @@
 #include "InsetMathHull.h"
 #include "InsetMathXArrow.h"
 #include "InsetMathXYMatrix.h"
+#include "InsetMathDiagram.h"
 #include "MacroTable.h"
 #include "MathMacro.h"
 #include "MathMacroArgument.h"
@@ -59,6 +64,7 @@
 #include "support/FileName.h"
 #include "support/filetools.h" // LibFileSearch
 #include "support/lstrings.h"
+#include "support/textutils.h"
 
 #include "frontends/FontLoader.h"
 
@@ -68,6 +74,8 @@
 #include "LyX.h" // use_gui
 #include "OutputParams.h"
 
+#include <iomanip>
+
 using namespace std;
 using namespace lyx::support;
 
@@ -78,10 +86,10 @@ bool has_math_fonts;
 
 namespace {
 
-MathWordList theWordList;
+MathWordList theMathWordList;
 
 
-bool isMathFontAvailable(docstring & name)
+bool isMathFontAvailable(string & name)
 {
        if (!use_gui)
                return false;
@@ -95,16 +103,42 @@ bool isMathFontAvailable(docstring & name)
 
        // can we fake it?
        if (name == "eufrak") {
-               name = from_ascii("lyxfakefrak");
+               name = "lyxfakefrak";
                return true;
        }
 
        LYXERR(Debug::MATHED,
-               "font " << to_utf8(name) << " not available and I can't fake it");
+               "font " << name << " not available and I can't fake it");
        return false;
 }
 
 
+bool canBeDisplayed(char_type c)
+{
+       if (!use_gui)
+               return true;
+       return theFontLoader().canBeDisplayed(c);
+}
+
+
+bool isUnicodeSymbolAvailable(docstring const & name, char_type & c)
+{
+       docstring cmd(from_ascii("\\") + name);
+       bool is_combining;
+       bool termination;
+       c = Encodings::fromLaTeXCommand(cmd, Encodings::MATH_CMD,
+                                       is_combining, termination);
+       if (c == 0 && name == "varOmega") {
+               // fallback for bug 7954, unicodesymbols does not list
+               // \\varOmega because of requirements, but this might change
+               cmd = from_ascii("\\mathit{\\Omega}");
+               c = Encodings::fromLaTeXCommand(cmd, Encodings::MATH_CMD,
+                                               is_combining, termination);
+       }
+       return c != 0 && !is_combining;
+}
+
+
 void initSymbols()
 {
        FileName const filename = libFileSearch(string(), "symbols");
@@ -115,6 +149,8 @@ void initSymbols()
        }
 
        ifstream fs(filename.toFilesystemEncoding().c_str());
+       // limit the size of strings we read to avoid memory problems
+       fs >> setw(65636);
        string line;
        bool skip = false;
        while (getline(fs, line)) {
@@ -126,14 +162,16 @@ void initSymbols()
                // special case of iffont/else/endif
                if (line.size() >= 7 && line.substr(0, 6) == "iffont") {
                        istringstream is(line);
+                       // limit the size of strings we read to avoid memory problems
+                       is >> setw(65636);
                        string tmp;
                        is >> tmp;
                        is >> tmp;
-                       docstring t = from_utf8(tmp);
-                       skip = !isMathFontAvailable(t);
+                       skip = !isMathFontAvailable(tmp);
                        continue;
                } else if (line.size() >= 4 && line.substr(0, 4) == "else") {
                        skip = !skip;
+                       continue;
                } else if (line.size() >= 5 && line.substr(0, 5) == "endif") {
                        skip = false;
                        continue;
@@ -143,27 +181,81 @@ void initSymbols()
                // special case of pre-defined macros
                if (line.size() > 8 && line.substr(0, 5) == "\\def\\") {
                        //lyxerr << "macro definition: '" << line << '\'' << endl;
+                       // syntax: Either
+                       // \def\macroname{definition}
+                       // or
+                       // \def\macroname{definition} requires
+                       // or
+                       // \def\macroname{definition} extra xmlname requires
                        istringstream is(line);
                        string macro;
                        string requires;
-                       is >> macro >> requires;
-                       MacroTable::globalMacros().insert(0, from_utf8(macro), requires);
+                       string extra;
+                       string xmlname;
+                       bool hidden = false;
+                       is >> setw(65536) >> macro >> requires;
+                       if ((is >> xmlname)) {
+                               extra = requires;
+                               if (!(is >> requires))
+                                       requires = "";
+                       } else
+                               xmlname = "";
+                       MacroTable::iterator it = MacroTable::globalMacros().insert(
+                                       0, from_utf8(macro));
+                       if (!extra.empty() || !xmlname.empty() || !requires.empty()) {
+                               MathWordList::iterator wit = theMathWordList.find(it->first);
+                               if (wit != theMathWordList.end())
+                                       LYXERR(Debug::MATHED, "readSymbols: inset "
+                                               << to_utf8(it->first) << " already exists.");
+                               else {
+                                       latexkeys tmp;
+                                       tmp.inset = "macro";
+                                       tmp.name = it->first;
+                                       tmp.extra = from_utf8(extra);
+                                       tmp.xmlname = from_utf8(xmlname);
+                                       if (requires == "hiddensymbol") {
+                                               requires = "";
+                                               tmp.hidden = hidden = true;
+                                       } else
+                                               tmp.requires = requires;
+                                       theMathWordList[it->first] = tmp;
+                                       wit = theMathWordList.find(it->first);
+                                       it->second.setSymbol(&(wit->second));
+                               }
+                       }
+                       // If you change the following output, please adjust
+                       // development/tools/generate_symbols_images.py.
+                       LYXERR(Debug::MATHED, "read symbol '" << to_utf8(it->first)
+                               << "  inset: macro"
+                               << "  draw: 0"
+                               << "  extra: " << extra
+                               << "  xml: " << xmlname
+                               << "  requires: " << requires
+                               << "  hidden: " << hidden << '\'');
                        continue;
                }
 
                idocstringstream is(from_utf8(line));
                latexkeys tmp;
-               is >> tmp.name >> tmp.inset;
+               docstring help;
+               is >> tmp.name >> help;
+               tmp.inset = to_ascii(help);
                if (isFontName(tmp.inset))
                        is >> charid >> fallbackid >> tmp.extra >> tmp.xmlname;
                else
                        is >> tmp.extra;
                // requires is optional
-               if (is)
-                       is >> tmp.requires;
-               else {
+               if (is) {
+                       if ((is >> help)) {
+                               // backward compatibility
+                               if (help == "esintoramsmath")
+                                       tmp.requires = "esint|amsmath";
+                               else
+                                       tmp.requires = to_ascii(help);
+                       }
+               } else {
                        LYXERR(Debug::MATHED, "skipping line '" << line << "'\n"
-                               << to_utf8(tmp.name) << ' ' << to_utf8(tmp.inset) << ' '
+                               << to_utf8(tmp.name) << ' ' << tmp.inset << ' '
                                << to_utf8(tmp.extra));
                        continue;
                }
@@ -175,52 +267,70 @@ void initSymbols()
                        // store requirements as long as we can
                        if (tmp.requires.empty()) {
                                if (tmp.inset == "msa" || tmp.inset == "msb")
-                                       tmp.requires = from_ascii("amssymb");
+                                       tmp.requires = "amssymb";
                                else if (tmp.inset == "wasy")
-                                       tmp.requires = from_ascii("wasysym");
+                                       tmp.requires = "wasysym";
+                               else if (tmp.inset == "mathscr")
+                                       tmp.requires = "mathrsfs";
                        }
 
                        // symbol font is not available sometimes
-                       docstring symbol_font = from_ascii("lyxsymbol");
+                       string symbol_font = "lyxsymbol";
+                       char_type unicodesymbol = 0;
 
                        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)) {
+                       } else if (isMathFontAvailable(tmp.inset) && canBeDisplayed(charid)) {
                                LYXERR(Debug::MATHED, "symbol available for " << to_utf8(tmp.name));
                                tmp.draw.push_back(char_type(charid));
-                       } else if (fallbackid && isMathFontAvailable(symbol_font)) {
+                       } else if (fallbackid && isMathFontAvailable(symbol_font) &&
+                                  canBeDisplayed(fallbackid)) {
                                if (tmp.inset == "cmex")
-                                       tmp.inset = from_ascii("lyxsymbol");
+                                       tmp.inset = "lyxsymbol";
                                else
-                                       tmp.inset = from_ascii("lyxboldsymbol");
+                                       tmp.inset = "lyxboldsymbol";
                                LYXERR(Debug::MATHED, "symbol fallback for " << to_utf8(tmp.name));
                                tmp.draw.push_back(char_type(fallbackid));
+                       } else if (isUnicodeSymbolAvailable(tmp.name, unicodesymbol)) {
+                               LYXERR(Debug::MATHED, "unicode fallback for " << to_utf8(tmp.name));
+                               tmp.inset = "mathnormal";
+                               tmp.draw.push_back(unicodesymbol);
                        } else {
                                LYXERR(Debug::MATHED, "faking " << to_utf8(tmp.name));
                                tmp.draw = tmp.name;
-                               tmp.inset = from_ascii("lyxtex");
+                               tmp.inset = "lyxtex";
                        }
                } else {
                        // it's a proper inset
-                       LYXERR(Debug::MATHED, "inset " << to_utf8(tmp.inset)
+                       LYXERR(Debug::MATHED, "inset " << tmp.inset
                                              << " used for " << to_utf8(tmp.name));
                }
 
-               if (theWordList.find(tmp.name) != theWordList.end())
+               if (tmp.requires == "hiddensymbol")
+               {
+                       tmp.requires = "";
+                       tmp.hidden = true;
+               }
+
+               if (theMathWordList.find(tmp.name) != theMathWordList.end())
                        LYXERR(Debug::MATHED, "readSymbols: inset " << to_utf8(tmp.name)
                                << " already exists.");
                else
-                       theWordList[tmp.name] = tmp;
+                       theMathWordList[tmp.name] = tmp;
 
+               // If you change the following output, please adjust
+               // development/tools/generate_symbols_images.py.
                LYXERR(Debug::MATHED, "read symbol '" << to_utf8(tmp.name)
-                       << "  inset: " << to_utf8(tmp.inset)
+                       << "  inset: " << tmp.inset
                        << "  draw: " << int(tmp.draw.empty() ? 0 : tmp.draw[0])
                        << "  extra: " << to_utf8(tmp.extra)
-                       << "  requires: " << to_utf8(tmp.requires) << '\'');
+                       << "  xml: " << to_utf8(tmp.xmlname)
+                       << "  requires: " << tmp.requires
+                       << "  hidden: " << tmp.hidden << '\'');
        }
-       docstring tmp = from_ascii("cmm");
-       docstring tmp2 = from_ascii("cmsy");
+       string tmp = "cmm";
+       string tmp2 = "cmsy";
        has_math_fonts = isMathFontAvailable(tmp) && isMathFontAvailable(tmp2);
 }
 
@@ -233,7 +343,7 @@ bool isSpecialChar(docstring const & name)
 
        char_type const c = name.at(0);
        return  c == '{' || c == '}' || c == '&' || c == '$' ||
-               c == '#' || c == '%' || c == '_' || c == ' ';
+               c == '#' || c == '%' || c == '_';
 }
 
 
@@ -241,7 +351,7 @@ bool isSpecialChar(docstring const & name)
 
 MathWordList const & mathedWordList()
 {
-       return theWordList;
+       return theMathWordList;
 }
 
 
@@ -256,29 +366,48 @@ void initMath()
 }
 
 
-bool ensureMath(WriteStream & os, bool needs_math_mode, bool macro)
+bool ensureMath(WriteStream & os, bool needs_mathmode, bool macro,
+                bool textmode_macro)
 {
        bool brace = os.pendingBrace();
        os.pendingBrace(false);
        if (!os.latex())
                return brace;
-       if (os.textMode() && needs_math_mode) {
-               os << "\\ensuremath{";
+       if (os.textMode() && needs_mathmode) {
+               if (brace) {
+                       // close \lyxmathsym
+                       os << '}';
+                       brace = false;
+               } else {
+                       os << "\\ensuremath{";
+                       brace = true;
+               }
                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 << '}';
+       } else if (macro && textmode_macro && !os.textMode()) {
+               if (brace) {
+                       // close \ensuremath
+                       os << '}';
+                       brace = false;
+               } else {
+                       os << "\\lyxmathsym{";
+                       brace = true;
+               }
                os.textMode(true);
+       } else if (macro && brace && !needs_mathmode && !textmode_macro) {
+               // This is a user defined macro, not a MathMacro, so we
+               // cannot be sure what mode is needed. We leave it in the
+               // same environment it was entered by closing either \lyxmathsym
+               // or \ensuremath, whichever was opened.
+               os << '}';
                brace = false;
+               os.textMode(!os.textMode());
        }
        return brace;
 }
 
 
-int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked)
+int ensureMode(WriteStream & os, InsetMath::mode_type mode,
+               bool locked, bool ascii)
 {
        bool textmode = mode == InsetMath::TEXT_MODE;
        if (os.latex() && textmode && os.pendingBrace()) {
@@ -287,18 +416,24 @@ int ensureMode(WriteStream & os, InsetMath::mode_type mode, bool locked)
                os.pendingSpace(false);
                os.textMode(true);
        }
-       int oldmodes = os.textMode() ? 1 : 0;
+       int oldmodes = os.textMode() ? 0x01 : 0;
        os.textMode(textmode);
-       oldmodes |= os.lockedMode() ? 2 : 0;
+       oldmodes |= os.lockedMode() ? 0x02 : 0;
        os.lockedMode(locked);
+       oldmodes |= os.asciiOnly() ? 0x04 : 0;
+       os.asciiOnly(ascii);
        return oldmodes;
 }
 
 
 latexkeys const * in_word_set(docstring const & str)
 {
-       MathWordList::iterator it = theWordList.find(str);
-       return it != theWordList.end() ? &(it->second) : 0;
+       MathWordList::iterator it = theMathWordList.find(str);
+       if (it == theMathWordList.end())
+               return 0;
+       if (it->second.inset == "macro")
+               return 0;
+       return &(it->second);
 }
 
 
@@ -312,12 +447,12 @@ MathAtom createInsetMath(docstring const & s, Buffer * buf)
 {
        //lyxerr << "creating inset with name: '" << to_utf8(s) << '\'' << endl;
        if ((s == "ce" || s == "cf") && buf
-           && buf->params().use_mhchem == BufferParams::package_off)
+           && buf->params().use_package("mhchem") == BufferParams::package_off)
                return MathAtom(new MathMacro(buf, s));
 
        latexkeys const * l = in_word_set(s);
        if (l) {
-               docstring const & inset = l->inset;
+               string const & inset = l->inset;
                //lyxerr << " found inset: '" << inset << '\'' << endl;
                if (inset == "ref")
                        return MathAtom(new InsetMathRef(buf, l->name));
@@ -329,13 +464,11 @@ MathAtom createInsetMath(docstring const & s, Buffer * buf)
                        return MathAtom(new InsetMathDecoration(buf, l));
                if (inset == "space")
                        return MathAtom(new InsetMathSpace(to_ascii(l->name), ""));
+               if (inset == "class")
+                       return MathAtom(new InsetMathClass(buf, string_to_class(s)));
                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(buf, l->name));
 //             if (inset == "fbox")
 //                     return MathAtom(new InsetMathFBox(l));
@@ -369,8 +502,6 @@ MathAtom createInsetMath(docstring const & s, Buffer * buf)
                return MathAtom(new InsetMathMakebox(buf, true));
        if (s == "makebox")
                return MathAtom(new InsetMathMakebox(buf, false));
-       if (s == "kern")
-               return MathAtom(new InsetMathKern);
        if (s.substr(0, 8) == "xymatrix") {
                char spacing_code = '\0';
                Length spacing;
@@ -411,7 +542,17 @@ MathAtom createInsetMath(docstring const & s, Buffer * buf)
                return MathAtom(new InsetMathXYMatrix(buf, spacing, spacing_code,
                        equal_spacing));
        }
-       if (s == "xrightarrow" || s == "xleftarrow")
+
+       if (s == "Diagram")
+               return MathAtom(new InsetMathDiagram(buf));
+       if (s == "xrightarrow" || s == "xleftarrow" ||
+               s == "xhookrightarrow" || s == "xhookleftarrow" ||
+               s == "xRightarrow" || s == "xLeftarrow" ||
+               s == "xleftrightarrow" || s == "xLeftrightarrow" ||
+               s == "xrightharpoondown" || s == "xrightharpoonup" ||
+               s == "xleftharpoondown" || s == "xleftharpoonup" ||
+               s == "xleftrightharpoons" || s == "xrightleftharpoons" ||
+               s == "xmapsto")
                return MathAtom(new InsetMathXArrow(buf, s));
        if (s == "split" || s == "alignedat")
                return MathAtom(new InsetMathSplit(buf, s));
@@ -428,7 +569,10 @@ MathAtom createInsetMath(docstring const & s, Buffer * buf)
        if (s == "tabular")
                return MathAtom(new InsetMathTabular(buf, s, 1, 1));
        if (s == "stackrel")
-               return MathAtom(new InsetMathStackrel(buf));
+               return MathAtom(new InsetMathStackrel(buf, false));
+       // This string value is only for math toolbar use, no LaTeX name
+       if (s == "stackrelthree")
+               return MathAtom(new InsetMathStackrel(buf, true));
        if (s == "binom")
                return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BINOM));
        if (s == "dbinom")
@@ -488,11 +632,42 @@ MathAtom createInsetMath(docstring const & s, Buffer * buf)
                return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::phantom));
        if (s == "vphantom")
                return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::vphantom));
+       if (s == "cancel")
+               return MathAtom(new InsetMathCancel(buf, InsetMathCancel::cancel));
+       if (s == "bcancel")
+               return MathAtom(new InsetMathCancel(buf, InsetMathCancel::bcancel));
+       if (s == "xcancel")
+               return MathAtom(new InsetMathCancel(buf, InsetMathCancel::xcancel));
+       if (s == "cancelto")
+               return MathAtom(new InsetMathCancelto(buf));
+       if (s == "smash")
+               return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smash));
+       // The following 2 string values are only for math toolbar use, no LaTeX names
+       if (s == "smashb")
+               return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smashb));
+       if (s == "smasht")
+               return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smasht));
+       if (s == "mathclap")
+               return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathclap));
+       if (s == "mathllap")
+               return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathllap));
+       if (s == "mathrlap")
+               return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathrlap));
        if (s == "ensuremath")
                return MathAtom(new InsetMathEnsureMath(buf));
+       if (s == "sideset")
+               return MathAtom(new InsetMathSideset(buf, true, true));
+       // The following 3 string values are only for math toolbar use, no LaTeX names
+       if (s == "sidesetr")
+               return MathAtom(new InsetMathSideset(buf, false, true));
+       if (s == "sidesetl")
+               return MathAtom(new InsetMathSideset(buf, true, false));
+       if (s == "sidesetn")
+               return MathAtom(new InsetMathSideset(buf, false, false));
        if (isSpecialChar(s))
                return MathAtom(new InsetMathSpecialChar(s));
-
+       if (s == " ")
+               return MathAtom(new InsetMathSpace(" ", ""));
        if (s == "regexp")
                return MathAtom(new InsetMathHull(buf, hullRegexp));
 
@@ -510,17 +685,20 @@ bool createInsetMath_fromDialogStr(docstring const & str, MathData & ar)
        if (name == "ref") {
                InsetCommandParams icp(REF_CODE);
                // FIXME UNICODE
-               InsetCommand::string2params("ref", to_utf8(str), icp);
-               mathed_parse_cell(ar, icp.getCommand());
+               InsetCommand::string2params(to_utf8(str), icp);
+               Encoding const * const utf8 = encodings.fromLyXName("utf8");
+               OutputParams op(utf8);
+               mathed_parse_cell(ar, icp.getCommand(op));
        } else if (name == "mathspace") {
                InsetSpaceParams isp(true);
                InsetSpace::string2params(to_utf8(str), isp);
                InsetSpace is(isp);
-               odocstringstream os;
+               odocstringstream ods;
+               otexstream os(ods);
                Encoding const * const ascii = encodings.fromLyXName("ascii");
                OutputParams op(ascii);
                is.latex(os, op);
-               mathed_parse_cell(ar, os.str());
+               mathed_parse_cell(ar, ods.str());
                if (ar.size() == 2) {
                        // remove "{}"
                        if (ar[1].nucleus()->asBraceInset())
@@ -538,7 +716,7 @@ bool createInsetMath_fromDialogStr(docstring const & str, MathData & ar)
 
 bool isAsciiOrMathAlpha(char_type c)
 {
-       return c < 0x80 || Encodings::isMathAlpha(c);
+       return isASCII(c) || Encodings::isMathAlpha(c);
 }