2 * \file MathFactory.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "MathFactory.h"
15 #include "InsetMathAMSArray.h"
16 #include "InsetMathArray.h"
17 #include "InsetMathBoldSymbol.h"
18 #include "InsetMathBox.h"
19 #include "InsetMathCancel.h"
20 #include "InsetMathCancelto.h"
21 #include "InsetMathCases.h"
22 #include "InsetMathColor.h"
23 #include "InsetMathDecoration.h"
24 #include "InsetMathDots.h"
25 #include "InsetMathEnsureMath.h"
26 #include "InsetMathFont.h"
27 #include "InsetMathFontOld.h"
28 #include "InsetMathFrac.h"
29 #include "InsetMathKern.h"
30 #include "InsetMathLefteqn.h"
31 #include "InsetMathOverset.h"
32 #include "InsetMathPhantom.h"
33 #include "InsetMathRef.h"
34 #include "InsetMathRoot.h"
35 #include "InsetMathSize.h"
36 #include "InsetMathSpace.h"
37 #include "InsetMathSpecialChar.h"
38 #include "InsetMathSplit.h"
39 #include "InsetMathSqrt.h"
40 #include "InsetMathStackrel.h"
41 #include "InsetMathSubstack.h"
42 #include "InsetMathSymbol.h"
43 #include "InsetMathTabular.h"
44 #include "InsetMathUnderset.h"
45 #include "InsetMathUnknown.h"
46 #include "InsetMathHull.h"
47 #include "InsetMathXArrow.h"
48 #include "InsetMathXYMatrix.h"
49 #include "InsetMathDiagram.h"
50 #include "MacroTable.h"
51 #include "MathMacro.h"
52 #include "MathMacroArgument.h"
53 #include "MathParser.h"
54 #include "MathStream.h"
55 #include "MathSupport.h"
57 #include "insets/InsetCommand.h"
58 #include "insets/InsetSpace.h"
60 #include "support/debug.h"
61 #include "support/docstream.h"
62 #include "support/FileName.h"
63 #include "support/filetools.h" // LibFileSearch
64 #include "support/lstrings.h"
66 #include "frontends/FontLoader.h"
69 #include "BufferParams.h"
71 #include "LyX.h" // use_gui
72 #include "OutputParams.h"
75 using namespace lyx::support;
84 MathWordList theMathWordList;
87 bool isMathFontAvailable(docstring & name)
95 // Do we have the font proper?
96 if (theFontLoader().available(f))
100 if (name == "eufrak") {
101 name = from_ascii("lyxfakefrak");
105 LYXERR(Debug::MATHED,
106 "font " << to_utf8(name) << " not available and I can't fake it");
113 FileName const filename = libFileSearch(string(), "symbols");
114 LYXERR(Debug::MATHED, "read symbols from " << filename);
115 if (filename.empty()) {
116 lyxerr << "Could not find symbols file" << endl;
120 ifstream fs(filename.toFilesystemEncoding().c_str());
123 while (getline(fs, line)) {
126 if (line.empty() || line[0] == '#')
129 // special case of iffont/else/endif
130 if (line.size() >= 7 && line.substr(0, 6) == "iffont") {
131 istringstream is(line);
135 docstring t = from_utf8(tmp);
136 skip = !isMathFontAvailable(t);
138 } else if (line.size() >= 4 && line.substr(0, 4) == "else") {
141 } else if (line.size() >= 5 && line.substr(0, 5) == "endif") {
147 // special case of pre-defined macros
148 if (line.size() > 8 && line.substr(0, 5) == "\\def\\") {
149 //lyxerr << "macro definition: '" << line << '\'' << endl;
150 istringstream is(line);
153 is >> macro >> requires;
154 MacroTable::globalMacros().insert(0, from_utf8(macro), requires);
158 idocstringstream is(from_utf8(line));
160 is >> tmp.name >> tmp.inset;
161 if (isFontName(tmp.inset))
162 is >> charid >> fallbackid >> tmp.extra >> tmp.xmlname;
165 // requires is optional
168 // backward compatibility
169 if (tmp.requires == "esintoramsmath")
170 tmp.requires = from_ascii("esint|amsmath");
172 LYXERR(Debug::MATHED, "skipping line '" << line << "'\n"
173 << to_utf8(tmp.name) << ' ' << to_utf8(tmp.inset) << ' '
174 << to_utf8(tmp.extra));
178 if (isFontName(tmp.inset)) {
179 // tmp.inset _is_ the fontname here.
180 // create fallbacks if necessary
182 // store requirements as long as we can
183 if (tmp.requires.empty()) {
184 if (tmp.inset == "msa" || tmp.inset == "msb")
185 tmp.requires = from_ascii("amssymb");
186 else if (tmp.inset == "wasy")
187 tmp.requires = from_ascii("wasysym");
188 else if (tmp.inset == "mathscr")
189 tmp.requires = from_ascii("mathrsfs");
192 // symbol font is not available sometimes
193 docstring symbol_font = from_ascii("lyxsymbol");
195 if (tmp.extra == "func" || tmp.extra == "funclim" || tmp.extra == "special") {
196 LYXERR(Debug::MATHED, "symbol abuse for " << to_utf8(tmp.name));
198 } else if (isMathFontAvailable(tmp.inset)) {
199 LYXERR(Debug::MATHED, "symbol available for " << to_utf8(tmp.name));
200 tmp.draw.push_back(char_type(charid));
201 } else if (fallbackid && isMathFontAvailable(symbol_font)) {
202 if (tmp.inset == "cmex")
203 tmp.inset = from_ascii("lyxsymbol");
205 tmp.inset = from_ascii("lyxboldsymbol");
206 LYXERR(Debug::MATHED, "symbol fallback for " << to_utf8(tmp.name));
207 tmp.draw.push_back(char_type(fallbackid));
209 LYXERR(Debug::MATHED, "faking " << to_utf8(tmp.name));
211 tmp.inset = from_ascii("lyxtex");
214 // it's a proper inset
215 LYXERR(Debug::MATHED, "inset " << to_utf8(tmp.inset)
216 << " used for " << to_utf8(tmp.name));
219 if (theMathWordList.find(tmp.name) != theMathWordList.end())
220 LYXERR(Debug::MATHED, "readSymbols: inset " << to_utf8(tmp.name)
221 << " already exists.");
223 theMathWordList[tmp.name] = tmp;
225 LYXERR(Debug::MATHED, "read symbol '" << to_utf8(tmp.name)
226 << " inset: " << to_utf8(tmp.inset)
227 << " draw: " << int(tmp.draw.empty() ? 0 : tmp.draw[0])
228 << " extra: " << to_utf8(tmp.extra)
229 << " requires: " << to_utf8(tmp.requires) << '\'');
231 docstring tmp = from_ascii("cmm");
232 docstring tmp2 = from_ascii("cmsy");
233 has_math_fonts = isMathFontAvailable(tmp) && isMathFontAvailable(tmp2);
237 bool isSpecialChar(docstring const & name)
239 if (name.size() != 1)
240 return name == "textasciicircum" || name == "mathcircumflex" ||
241 name == "textasciitilde" || name == "textbackslash";
243 char_type const c = name.at(0);
244 return c == '{' || c == '}' || c == '&' || c == '$' ||
245 c == '#' || c == '%' || c == '_';
251 MathWordList const & mathedWordList()
253 return theMathWordList;
259 static bool initialized = false;
268 bool ensureMath(WriteStream & os, bool needs_math_mode, bool macro)
270 bool brace = os.pendingBrace();
271 os.pendingBrace(false);
274 if (os.textMode() && needs_math_mode) {
275 os << "\\ensuremath{";
278 } else if (macro && brace && !needs_math_mode) {
279 // This is a user defined macro, but not a MathMacro, so we
280 // cannot be sure what mode is needed. As it was entered in
281 // a text box, we restore the text mode.
290 int ensureMode(WriteStream & os, InsetMath::mode_type mode,
291 bool locked, bool ascii)
293 bool textmode = mode == InsetMath::TEXT_MODE;
294 if (os.latex() && textmode && os.pendingBrace()) {
296 os.pendingBrace(false);
297 os.pendingSpace(false);
300 int oldmodes = os.textMode() ? 0x01 : 0;
301 os.textMode(textmode);
302 oldmodes |= os.lockedMode() ? 0x02 : 0;
303 os.lockedMode(locked);
304 oldmodes |= os.asciiOnly() ? 0x04 : 0;
310 latexkeys const * in_word_set(docstring const & str)
312 MathWordList::iterator it = theMathWordList.find(str);
313 return it != theMathWordList.end() ? &(it->second) : 0;
317 MathAtom createInsetMath(char const * const s, Buffer * buf)
319 return createInsetMath(from_utf8(s), buf);
323 MathAtom createInsetMath(docstring const & s, Buffer * buf)
325 //lyxerr << "creating inset with name: '" << to_utf8(s) << '\'' << endl;
326 if ((s == "ce" || s == "cf") && buf
327 && buf->params().use_package("mhchem") == BufferParams::package_off)
328 return MathAtom(new MathMacro(buf, s));
330 latexkeys const * l = in_word_set(s);
332 docstring const & inset = l->inset;
333 //lyxerr << " found inset: '" << inset << '\'' << endl;
335 return MathAtom(new InsetMathRef(buf, l->name));
336 if (inset == "overset")
337 return MathAtom(new InsetMathOverset(buf));
338 if (inset == "underset")
339 return MathAtom(new InsetMathUnderset(buf));
340 if (inset == "decoration")
341 return MathAtom(new InsetMathDecoration(buf, l));
342 if (inset == "space")
343 return MathAtom(new InsetMathSpace(to_ascii(l->name), ""));
345 return MathAtom(new InsetMathDots(l));
347 // return MathAtom(new InsetMathMBox);
348 // InsetMathMBox is proposed to replace InsetMathBox,
349 // but is not ready yet (it needs a BufferView for
351 return MathAtom(new InsetMathBox(buf, l->name));
352 // if (inset == "fbox")
353 // return MathAtom(new InsetMathFBox(l));
354 if (inset == "style")
355 return MathAtom(new InsetMathSize(buf, l));
357 return MathAtom(new InsetMathFont(buf, l));
358 if (inset == "oldfont")
359 return MathAtom(new InsetMathFontOld(buf, l));
360 if (inset == "matrix")
361 return MathAtom(new InsetMathAMSArray(buf, s));
362 if (inset == "split")
363 return MathAtom(new InsetMathSplit(buf, s));
365 // we can't create a InsetMathBig, since the argument
367 return MathAtom(new InsetMathUnknown(s));
368 return MathAtom(new InsetMathSymbol(l));
371 if (s.size() == 2 && s[0] == '#' && s[1] >= '1' && s[1] <= '9')
372 return MathAtom(new MathMacroArgument(s[1] - '0'));
373 if (s.size() == 3 && s[0] == '\\' && s[1] == '#'
374 && s[2] >= '1' && s[2] <= '9')
375 return MathAtom(new MathMacroArgument(s[2] - '0'));
377 return MathAtom(new InsetMathBoxed(buf));
379 return MathAtom(new InsetMathFBox(buf));
381 return MathAtom(new InsetMathMakebox(buf, true));
383 return MathAtom(new InsetMathMakebox(buf, false));
385 return MathAtom(new InsetMathKern);
386 if (s.substr(0, 8) == "xymatrix") {
387 char spacing_code = '\0';
389 bool equal_spacing = false;
390 size_t const len = s.length();
392 if (i < len && s[i] == '@') {
394 if (i < len && s[i] == '!') {
395 equal_spacing = true;
402 spacing_code = static_cast<char>(s[i]);
405 } else if (i < len) {
413 spacing_code = static_cast<char>(s[i]);
417 if (i < len && s[i] == '=') {
419 spacing = Length(to_ascii(s.substr(i)));
423 return MathAtom(new InsetMathXYMatrix(buf, spacing, spacing_code,
428 return MathAtom(new InsetMathDiagram(buf));
429 if (s == "xrightarrow" || s == "xleftarrow")
430 return MathAtom(new InsetMathXArrow(buf, s));
431 if (s == "split" || s == "alignedat")
432 return MathAtom(new InsetMathSplit(buf, s));
434 return MathAtom(new InsetMathCases(buf));
436 return MathAtom(new InsetMathSubstack(buf));
437 if (s == "subarray" || s == "array")
438 return MathAtom(new InsetMathArray(buf, s, 1, 1));
440 return MathAtom(new InsetMathSqrt(buf));
442 return MathAtom(new InsetMathRoot(buf));
444 return MathAtom(new InsetMathTabular(buf, s, 1, 1));
446 return MathAtom(new InsetMathStackrel(buf));
448 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BINOM));
450 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::DBINOM));
452 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::TBINOM));
454 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::CHOOSE));
456 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BRACE));
458 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BRACK));
460 return MathAtom(new InsetMathFrac(buf));
462 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRAC));
464 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::DFRAC));
466 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::TFRAC));
468 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::OVER));
470 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::NICEFRAC));
472 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC));
473 // These string values are only for math toolbar use, no LaTeX names
474 if (s == "unitfracthree")
475 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC, 3));
477 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT, 1));
479 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT));
480 if (s == "cfracleft")
481 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACLEFT));
482 if (s == "cfracright")
483 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACRIGHT));
485 // return MathAtom(new MathInferInset);
487 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::ATOP));
489 return MathAtom(new InsetMathLefteqn(buf));
490 if (s == "boldsymbol")
491 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::AMS_BOLD));
493 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::BM_BOLD));
494 if (s == "heavysymbol" || s == "hm")
495 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::BM_HEAVY));
496 if (s == "color" || s == "normalcolor")
497 return MathAtom(new InsetMathColor(buf, true));
498 if (s == "textcolor")
499 return MathAtom(new InsetMathColor(buf, false));
501 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::hphantom));
503 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::phantom));
505 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::vphantom));
507 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::cancel));
509 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::bcancel));
511 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::xcancel));
513 return MathAtom(new InsetMathCancelto(buf));
515 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smash));
517 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathclap));
519 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathllap));
521 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathrlap));
522 if (s == "ensuremath")
523 return MathAtom(new InsetMathEnsureMath(buf));
524 if (isSpecialChar(s))
525 return MathAtom(new InsetMathSpecialChar(s));
527 return MathAtom(new InsetMathSpace(" ", ""));
530 return MathAtom(new InsetMathHull(buf, hullRegexp));
532 return MathAtom(new MathMacro(buf, s));
536 bool createInsetMath_fromDialogStr(docstring const & str, MathData & ar)
539 // "ref LatexCommand ref\nreference \"sec:Title\"\n\\end_inset\n\n";
541 docstring body = split(str, name, ' ');
544 InsetCommandParams icp(REF_CODE);
546 InsetCommand::string2params(to_utf8(str), icp);
547 Encoding const * const utf8 = encodings.fromLyXName("utf8");
548 OutputParams op(utf8);
549 mathed_parse_cell(ar, icp.getCommand(op));
550 } else if (name == "mathspace") {
551 InsetSpaceParams isp(true);
552 InsetSpace::string2params(to_utf8(str), isp);
555 odocstringstream ods;
556 otexstream os(ods, texrow);
557 Encoding const * const ascii = encodings.fromLyXName("ascii");
558 OutputParams op(ascii);
560 mathed_parse_cell(ar, ods.str());
561 if (ar.size() == 2) {
563 if (ar[1].nucleus()->asBraceInset())
572 return ar[0].nucleus();
576 bool isAsciiOrMathAlpha(char_type c)
578 return c < 0x80 || Encodings::isMathAlpha(c);