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::iterator it = MacroTable::globalMacros().insert(
155 0, from_utf8(macro), requires);
156 // If you change the following output, please adjust
157 // development/tools/generate_symbols_images.py.
158 LYXERR(Debug::MATHED, "read symbol '" << to_utf8(it->first)
162 << " requires: " << requires << '\'');
166 idocstringstream is(from_utf8(line));
168 is >> tmp.name >> tmp.inset;
169 if (isFontName(tmp.inset))
170 is >> charid >> fallbackid >> tmp.extra >> tmp.xmlname;
173 // requires is optional
176 // backward compatibility
177 if (tmp.requires == "esintoramsmath")
178 tmp.requires = from_ascii("esint|amsmath");
180 LYXERR(Debug::MATHED, "skipping line '" << line << "'\n"
181 << to_utf8(tmp.name) << ' ' << to_utf8(tmp.inset) << ' '
182 << to_utf8(tmp.extra));
186 if (isFontName(tmp.inset)) {
187 // tmp.inset _is_ the fontname here.
188 // create fallbacks if necessary
190 // store requirements as long as we can
191 if (tmp.requires.empty()) {
192 if (tmp.inset == "msa" || tmp.inset == "msb")
193 tmp.requires = from_ascii("amssymb");
194 else if (tmp.inset == "wasy")
195 tmp.requires = from_ascii("wasysym");
196 else if (tmp.inset == "mathscr")
197 tmp.requires = from_ascii("mathrsfs");
200 // symbol font is not available sometimes
201 docstring symbol_font = from_ascii("lyxsymbol");
203 if (tmp.extra == "func" || tmp.extra == "funclim" || tmp.extra == "special") {
204 LYXERR(Debug::MATHED, "symbol abuse for " << to_utf8(tmp.name));
206 } else if (isMathFontAvailable(tmp.inset)) {
207 LYXERR(Debug::MATHED, "symbol available for " << to_utf8(tmp.name));
208 tmp.draw.push_back(char_type(charid));
209 } else if (fallbackid && isMathFontAvailable(symbol_font)) {
210 if (tmp.inset == "cmex")
211 tmp.inset = from_ascii("lyxsymbol");
213 tmp.inset = from_ascii("lyxboldsymbol");
214 LYXERR(Debug::MATHED, "symbol fallback for " << to_utf8(tmp.name));
215 tmp.draw.push_back(char_type(fallbackid));
217 LYXERR(Debug::MATHED, "faking " << to_utf8(tmp.name));
219 tmp.inset = from_ascii("lyxtex");
222 // it's a proper inset
223 LYXERR(Debug::MATHED, "inset " << to_utf8(tmp.inset)
224 << " used for " << to_utf8(tmp.name));
227 if (theMathWordList.find(tmp.name) != theMathWordList.end())
228 LYXERR(Debug::MATHED, "readSymbols: inset " << to_utf8(tmp.name)
229 << " already exists.");
231 theMathWordList[tmp.name] = tmp;
233 // If you change the following output, please adjust
234 // development/tools/generate_symbols_images.py.
235 LYXERR(Debug::MATHED, "read symbol '" << to_utf8(tmp.name)
236 << " inset: " << to_utf8(tmp.inset)
237 << " draw: " << int(tmp.draw.empty() ? 0 : tmp.draw[0])
238 << " extra: " << to_utf8(tmp.extra)
239 << " requires: " << to_utf8(tmp.requires) << '\'');
241 docstring tmp = from_ascii("cmm");
242 docstring tmp2 = from_ascii("cmsy");
243 has_math_fonts = isMathFontAvailable(tmp) && isMathFontAvailable(tmp2);
247 bool isSpecialChar(docstring const & name)
249 if (name.size() != 1)
250 return name == "textasciicircum" || name == "mathcircumflex" ||
251 name == "textasciitilde" || name == "textbackslash";
253 char_type const c = name.at(0);
254 return c == '{' || c == '}' || c == '&' || c == '$' ||
255 c == '#' || c == '%' || c == '_';
261 MathWordList const & mathedWordList()
263 return theMathWordList;
269 static bool initialized = false;
278 bool ensureMath(WriteStream & os, bool needs_math_mode, bool macro)
280 bool brace = os.pendingBrace();
281 os.pendingBrace(false);
284 if (os.textMode() && needs_math_mode) {
285 os << "\\ensuremath{";
288 } else if (macro && brace && !needs_math_mode) {
289 // This is a user defined macro, but not a MathMacro, so we
290 // cannot be sure what mode is needed. As it was entered in
291 // a text box, we restore the text mode.
300 int ensureMode(WriteStream & os, InsetMath::mode_type mode,
301 bool locked, bool ascii)
303 bool textmode = mode == InsetMath::TEXT_MODE;
304 if (os.latex() && textmode && os.pendingBrace()) {
306 os.pendingBrace(false);
307 os.pendingSpace(false);
310 int oldmodes = os.textMode() ? 0x01 : 0;
311 os.textMode(textmode);
312 oldmodes |= os.lockedMode() ? 0x02 : 0;
313 os.lockedMode(locked);
314 oldmodes |= os.asciiOnly() ? 0x04 : 0;
320 latexkeys const * in_word_set(docstring const & str)
322 MathWordList::iterator it = theMathWordList.find(str);
323 return it != theMathWordList.end() ? &(it->second) : 0;
327 MathAtom createInsetMath(char const * const s, Buffer * buf)
329 return createInsetMath(from_utf8(s), buf);
333 MathAtom createInsetMath(docstring const & s, Buffer * buf)
335 //lyxerr << "creating inset with name: '" << to_utf8(s) << '\'' << endl;
336 if ((s == "ce" || s == "cf") && buf
337 && buf->params().use_package("mhchem") == BufferParams::package_off)
338 return MathAtom(new MathMacro(buf, s));
340 latexkeys const * l = in_word_set(s);
342 docstring const & inset = l->inset;
343 //lyxerr << " found inset: '" << inset << '\'' << endl;
345 return MathAtom(new InsetMathRef(buf, l->name));
346 if (inset == "overset")
347 return MathAtom(new InsetMathOverset(buf));
348 if (inset == "underset")
349 return MathAtom(new InsetMathUnderset(buf));
350 if (inset == "decoration")
351 return MathAtom(new InsetMathDecoration(buf, l));
352 if (inset == "space")
353 return MathAtom(new InsetMathSpace(to_ascii(l->name), ""));
355 return MathAtom(new InsetMathDots(l));
357 // return MathAtom(new InsetMathMBox);
358 // InsetMathMBox is proposed to replace InsetMathBox,
359 // but is not ready yet (it needs a BufferView for
361 return MathAtom(new InsetMathBox(buf, l->name));
362 // if (inset == "fbox")
363 // return MathAtom(new InsetMathFBox(l));
364 if (inset == "style")
365 return MathAtom(new InsetMathSize(buf, l));
367 return MathAtom(new InsetMathFont(buf, l));
368 if (inset == "oldfont")
369 return MathAtom(new InsetMathFontOld(buf, l));
370 if (inset == "matrix")
371 return MathAtom(new InsetMathAMSArray(buf, s));
372 if (inset == "split")
373 return MathAtom(new InsetMathSplit(buf, s));
375 // we can't create a InsetMathBig, since the argument
377 return MathAtom(new InsetMathUnknown(s));
378 return MathAtom(new InsetMathSymbol(l));
381 if (s.size() == 2 && s[0] == '#' && s[1] >= '1' && s[1] <= '9')
382 return MathAtom(new MathMacroArgument(s[1] - '0'));
383 if (s.size() == 3 && s[0] == '\\' && s[1] == '#'
384 && s[2] >= '1' && s[2] <= '9')
385 return MathAtom(new MathMacroArgument(s[2] - '0'));
387 return MathAtom(new InsetMathBoxed(buf));
389 return MathAtom(new InsetMathFBox(buf));
391 return MathAtom(new InsetMathMakebox(buf, true));
393 return MathAtom(new InsetMathMakebox(buf, false));
395 return MathAtom(new InsetMathKern);
396 if (s.substr(0, 8) == "xymatrix") {
397 char spacing_code = '\0';
399 bool equal_spacing = false;
400 size_t const len = s.length();
402 if (i < len && s[i] == '@') {
404 if (i < len && s[i] == '!') {
405 equal_spacing = true;
412 spacing_code = static_cast<char>(s[i]);
415 } else if (i < len) {
423 spacing_code = static_cast<char>(s[i]);
427 if (i < len && s[i] == '=') {
429 spacing = Length(to_ascii(s.substr(i)));
433 return MathAtom(new InsetMathXYMatrix(buf, spacing, spacing_code,
438 return MathAtom(new InsetMathDiagram(buf));
439 if (s == "xrightarrow" || s == "xleftarrow")
440 return MathAtom(new InsetMathXArrow(buf, s));
441 if (s == "split" || s == "alignedat")
442 return MathAtom(new InsetMathSplit(buf, s));
444 return MathAtom(new InsetMathCases(buf));
446 return MathAtom(new InsetMathSubstack(buf));
447 if (s == "subarray" || s == "array")
448 return MathAtom(new InsetMathArray(buf, s, 1, 1));
450 return MathAtom(new InsetMathSqrt(buf));
452 return MathAtom(new InsetMathRoot(buf));
454 return MathAtom(new InsetMathTabular(buf, s, 1, 1));
456 return MathAtom(new InsetMathStackrel(buf));
458 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BINOM));
460 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::DBINOM));
462 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::TBINOM));
464 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::CHOOSE));
466 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BRACE));
468 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BRACK));
470 return MathAtom(new InsetMathFrac(buf));
472 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRAC));
474 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::DFRAC));
476 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::TFRAC));
478 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::OVER));
480 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::NICEFRAC));
482 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC));
483 // These string values are only for math toolbar use, no LaTeX names
484 if (s == "unitfracthree")
485 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC, 3));
487 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT, 1));
489 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT));
490 if (s == "cfracleft")
491 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACLEFT));
492 if (s == "cfracright")
493 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACRIGHT));
495 // return MathAtom(new MathInferInset);
497 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::ATOP));
499 return MathAtom(new InsetMathLefteqn(buf));
500 if (s == "boldsymbol")
501 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::AMS_BOLD));
503 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::BM_BOLD));
504 if (s == "heavysymbol" || s == "hm")
505 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::BM_HEAVY));
506 if (s == "color" || s == "normalcolor")
507 return MathAtom(new InsetMathColor(buf, true));
508 if (s == "textcolor")
509 return MathAtom(new InsetMathColor(buf, false));
511 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::hphantom));
513 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::phantom));
515 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::vphantom));
517 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::cancel));
519 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::bcancel));
521 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::xcancel));
523 return MathAtom(new InsetMathCancelto(buf));
525 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smash));
527 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathclap));
529 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathllap));
531 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathrlap));
532 if (s == "ensuremath")
533 return MathAtom(new InsetMathEnsureMath(buf));
534 if (isSpecialChar(s))
535 return MathAtom(new InsetMathSpecialChar(s));
537 return MathAtom(new InsetMathSpace(" ", ""));
540 return MathAtom(new InsetMathHull(buf, hullRegexp));
542 return MathAtom(new MathMacro(buf, s));
546 bool createInsetMath_fromDialogStr(docstring const & str, MathData & ar)
549 // "ref LatexCommand ref\nreference \"sec:Title\"\n\\end_inset\n\n";
551 docstring body = split(str, name, ' ');
554 InsetCommandParams icp(REF_CODE);
556 InsetCommand::string2params(to_utf8(str), icp);
557 Encoding const * const utf8 = encodings.fromLyXName("utf8");
558 OutputParams op(utf8);
559 mathed_parse_cell(ar, icp.getCommand(op));
560 } else if (name == "mathspace") {
561 InsetSpaceParams isp(true);
562 InsetSpace::string2params(to_utf8(str), isp);
565 odocstringstream ods;
566 otexstream os(ods, texrow);
567 Encoding const * const ascii = encodings.fromLyXName("ascii");
568 OutputParams op(ascii);
570 mathed_parse_cell(ar, ods.str());
571 if (ar.size() == 2) {
573 if (ar[1].nucleus()->asBraceInset())
582 return ar[0].nucleus();
586 bool isAsciiOrMathAlpha(char_type c)
588 return c < 0x80 || Encodings::isMathAlpha(c);