]> git.lyx.org Git - features.git/blob - src/mathed/MathFactory.cpp
Add support for the doublestroke package
[features.git] / src / mathed / MathFactory.cpp
1 /**
2  * \file MathFactory.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author André Pönitz
7  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #include <config.h>
12
13 #include "MathFactory.h"
14
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 "InsetMathClass.h"
23 #include "InsetMathColor.h"
24 #include "InsetMathDecoration.h"
25 #include "InsetMathDots.h"
26 #include "InsetMathEnsureMath.h"
27 #include "InsetMathFont.h"
28 #include "InsetMathFontOld.h"
29 #include "InsetMathFrac.h"
30 #include "InsetMathKern.h"
31 #include "InsetMathLefteqn.h"
32 #include "InsetMathOverset.h"
33 #include "InsetMathPhantom.h"
34 #include "InsetMathRef.h"
35 #include "InsetMathRoot.h"
36 #include "InsetMathSideset.h"
37 #include "InsetMathSize.h"
38 #include "InsetMathSpace.h"
39 #include "InsetMathSpecialChar.h"
40 #include "InsetMathSplit.h"
41 #include "InsetMathSqrt.h"
42 #include "InsetMathStackrel.h"
43 #include "InsetMathSubstack.h"
44 #include "InsetMathSymbol.h"
45 #include "InsetMathTabular.h"
46 #include "InsetMathUnderset.h"
47 #include "InsetMathUnknown.h"
48 #include "InsetMathHull.h"
49 #include "InsetMathXArrow.h"
50 #include "InsetMathXYMatrix.h"
51 #include "InsetMathDiagram.h"
52 #include "MacroTable.h"
53 #include "InsetMathMacro.h"
54 #include "InsetMathMacroArgument.h"
55 #include "MathParser.h"
56 #include "MathStream.h"
57 #include "MathSupport.h"
58
59 #include "insets/InsetCommand.h"
60 #include "insets/InsetSpace.h"
61
62 #include "support/debug.h"
63 #include "support/docstream.h"
64 #include "support/FileName.h"
65 #include "support/filetools.h" // LibFileSearch
66 #include "support/lstrings.h"
67 #include "support/textutils.h"
68
69 #include "frontends/FontLoader.h"
70
71 #include "Buffer.h"
72 #include "BufferParams.h"
73 #include "Encoding.h"
74 #include "LyX.h" // use_gui
75 #include "OutputParams.h"
76
77 #include <iomanip>
78
79 using namespace std;
80 using namespace lyx::support;
81
82 namespace lyx {
83
84 bool has_math_fonts;
85
86
87 namespace {
88
89 MathWordList theMathWordList;
90
91
92 bool isMathFontAvailable(string & name)
93 {
94         if (!use_gui)
95                 return false;
96
97         FontInfo f;
98         augmentFont(f, name);
99
100         // Do we have the font proper?
101         if (theFontLoader().available(f))
102                 return true;
103
104         // can we fake it?
105         if (name == "eufrak") {
106                 name = "lyxfakefrak";
107                 return true;
108         }
109
110         LYXERR(Debug::MATHED,
111                 "font " << name << " not available and I can't fake it");
112         return false;
113 }
114
115
116 bool canBeDisplayed(char_type c)
117 {
118         if (!use_gui)
119                 return true;
120         return theFontLoader().canBeDisplayed(c);
121 }
122
123
124 bool isUnicodeSymbolAvailable(docstring const & name, char_type & c)
125 {
126         docstring cmd(from_ascii("\\") + name);
127         bool is_combining;
128         bool termination;
129         c = Encodings::fromLaTeXCommand(cmd, Encodings::MATH_CMD,
130                                         is_combining, termination);
131         if (c == 0 && name == "varOmega") {
132                 // fallback for bug 7954, unicodesymbols does not list
133                 // \\varOmega because of requirements, but this might change
134                 cmd = from_ascii("\\mathit{\\Omega}");
135                 c = Encodings::fromLaTeXCommand(cmd, Encodings::MATH_CMD,
136                                                 is_combining, termination);
137         }
138         return c != 0 && !is_combining;
139 }
140
141
142 void initSymbols()
143 {
144         FileName const filename = libFileSearch(string(), "symbols");
145         LYXERR(Debug::MATHED, "read symbols from " << filename);
146         if (filename.empty()) {
147                 lyxerr << "Could not find symbols file" << endl;
148                 return;
149         }
150
151         ifstream fs(filename.toFilesystemEncoding().c_str());
152         // limit the size of strings we read to avoid memory problems
153         fs >> setw(65636);
154         string line;
155         bool skip = false;
156         while (getline(fs, line)) {
157                 int charid     = 0;
158                 int fallbackid = 0;
159                 if (line.empty() || line[0] == '#')
160                         continue;
161
162                 // special case of iffont/else/endif
163                 if (line.size() >= 7 && line.substr(0, 6) == "iffont") {
164                         istringstream is(line);
165                         // limit the size of strings we read to avoid memory problems
166                         is >> setw(65636);
167                         string tmp;
168                         is >> tmp;
169                         is >> tmp;
170                         skip = !isMathFontAvailable(tmp);
171                         continue;
172                 } else if (line.size() >= 4 && line.substr(0, 4) == "else") {
173                         skip = !skip;
174                         continue;
175                 } else if (line.size() >= 5 && line.substr(0, 5) == "endif") {
176                         skip = false;
177                         continue;
178                 } else if (skip)
179                         continue;
180
181                 // special case of pre-defined macros
182                 if (line.size() > 8 && line.substr(0, 5) == "\\def\\") {
183                         //lyxerr << "macro definition: '" << line << '\'' << endl;
184                         // syntax: Either
185                         // \def\macroname{definition}
186                         // or
187                         // \def\macroname{definition} requires
188                         // or
189                         // \def\macroname{definition} extra xmlname requires
190                         istringstream is(line);
191                         string macro;
192                         string required;
193                         string extra;
194                         string xmlname;
195                         bool hidden = false;
196                         is >> setw(65536) >> macro >> required;
197                         if ((is >> xmlname)) {
198                                 extra = required;
199                                 if (!(is >> required))
200                                         required = "";
201                         } else
202                                 xmlname = "";
203                         MacroTable::iterator it = MacroTable::globalMacros().insert(
204                                         0, from_utf8(macro));
205                         if (!extra.empty() || !xmlname.empty() || !required.empty()) {
206                                 MathWordList::iterator wit = theMathWordList.find(it->first);
207                                 if (wit != theMathWordList.end())
208                                         LYXERR(Debug::MATHED, "readSymbols: inset "
209                                                 << to_utf8(it->first) << " already exists.");
210                                 else {
211                                         latexkeys tmp;
212                                         tmp.inset = "macro";
213                                         tmp.name = it->first;
214                                         tmp.extra = from_utf8(extra);
215                                         tmp.xmlname = from_utf8(xmlname);
216                                         if (required == "hiddensymbol") {
217                                                 required = "";
218                                                 tmp.hidden = hidden = true;
219                                         } else
220                                                 tmp.required = required;
221                                         theMathWordList[it->first] = tmp;
222                                         wit = theMathWordList.find(it->first);
223                                         it->second.setSymbol(&(wit->second));
224                                 }
225                         }
226                         // If you change the following output, please adjust
227                         // development/tools/generate_symbols_images.py.
228                         LYXERR(Debug::MATHED, "read symbol '" << to_utf8(it->first)
229                                 << "  inset: macro"
230                                 << "  draw: 0"
231                                 << "  extra: " << extra
232                                 << "  xml: " << xmlname
233                                 << "  requires: " << required
234                                 << "  hidden: " << hidden << '\'');
235                         continue;
236                 }
237
238                 idocstringstream is(from_utf8(line));
239                 latexkeys tmp;
240                 docstring help;
241                 is >> tmp.name >> help;
242                 tmp.inset = to_ascii(help);
243                 if (isFontName(tmp.inset))
244                         is >> charid >> fallbackid >> tmp.extra >> tmp.xmlname;
245                 else
246                         is >> tmp.extra;
247                 // requires is optional
248                 if (is) {
249                         if ((is >> help)) {
250                                 // backward compatibility
251                                 if (help == "esintoramsmath")
252                                         tmp.required = "esint|amsmath";
253                                 else
254                                         tmp.required = to_ascii(help);
255                         }
256                 } else {
257                         LYXERR(Debug::MATHED, "skipping line '" << line << "'\n"
258                                 << to_utf8(tmp.name) << ' ' << tmp.inset << ' '
259                                 << to_utf8(tmp.extra));
260                         continue;
261                 }
262
263                 if (isFontName(tmp.inset)) {
264                         // tmp.inset _is_ the fontname here.
265                         // create fallbacks if necessary
266
267                         // store requirements as long as we can
268                         if (tmp.required.empty()) {
269                                 if (tmp.inset == "msa" || tmp.inset == "msb")
270                                         tmp.required = "amssymb";
271                                 else if (tmp.inset == "wasy")
272                                         tmp.required = "wasysym";
273                                 else if (tmp.inset == "mathscr")
274                                         tmp.required = "mathrsfs";
275                                 else if (tmp.inset == "mathds")
276                                         tmp.required = "dsfont";
277                         }
278
279                         // symbol font is not available sometimes
280                         string symbol_font = "lyxsymbol";
281                         char_type unicodesymbol = 0;
282
283                         if (tmp.extra == "func" || tmp.extra == "funclim" || tmp.extra == "special") {
284                                 LYXERR(Debug::MATHED, "symbol abuse for " << to_utf8(tmp.name));
285                                 tmp.draw = tmp.name;
286                         } else if (isMathFontAvailable(tmp.inset) && canBeDisplayed(charid)) {
287                                 LYXERR(Debug::MATHED, "symbol available for " << to_utf8(tmp.name));
288                                 tmp.draw.push_back(char_type(charid));
289                         } else if (fallbackid && isMathFontAvailable(symbol_font) &&
290                                    canBeDisplayed(fallbackid)) {
291                                 if (tmp.inset == "cmex")
292                                         tmp.inset = "lyxsymbol";
293                                 else
294                                         tmp.inset = "lyxboldsymbol";
295                                 LYXERR(Debug::MATHED, "symbol fallback for " << to_utf8(tmp.name));
296                                 tmp.draw.push_back(char_type(fallbackid));
297                         } else if (isUnicodeSymbolAvailable(tmp.name, unicodesymbol)) {
298                                 LYXERR(Debug::MATHED, "unicode fallback for " << to_utf8(tmp.name));
299                                 tmp.inset = "mathnormal";
300                                 tmp.draw.push_back(unicodesymbol);
301                         } else {
302                                 LYXERR(Debug::MATHED, "faking " << to_utf8(tmp.name));
303                                 tmp.draw = tmp.name;
304                                 tmp.inset = "lyxtex";
305                         }
306                 } else {
307                         // it's a proper inset
308                         LYXERR(Debug::MATHED, "inset " << tmp.inset
309                                               << " used for " << to_utf8(tmp.name));
310                 }
311
312                 if (tmp.required == "hiddensymbol")
313                 {
314                         tmp.required = "";
315                         tmp.hidden = true;
316                 }
317
318                 if (theMathWordList.find(tmp.name) != theMathWordList.end())
319                         LYXERR(Debug::MATHED, "readSymbols: inset " << to_utf8(tmp.name)
320                                 << " already exists.");
321                 else
322                         theMathWordList[tmp.name] = tmp;
323
324                 // If you change the following output, please adjust
325                 // development/tools/generate_symbols_images.py.
326                 LYXERR(Debug::MATHED, "read symbol '" << to_utf8(tmp.name)
327                         << "  inset: " << tmp.inset
328                         << "  draw: " << int(tmp.draw.empty() ? 0 : tmp.draw[0])
329                         << "  extra: " << to_utf8(tmp.extra)
330                         << "  xml: " << to_utf8(tmp.xmlname)
331                         << "  requires: " << tmp.required
332                         << "  hidden: " << tmp.hidden << '\'');
333         }
334         string tmp = "cmm";
335         string tmp2 = "cmsy";
336         has_math_fonts = isMathFontAvailable(tmp) && isMathFontAvailable(tmp2);
337 }
338
339
340 bool isSpecialChar(docstring const & name)
341 {
342         if (name.size() != 1)
343                 return  name == "textasciicircum" || name == "mathcircumflex" ||
344                         name == "textasciitilde"  || name == "textbackslash";
345
346         char_type const c = name.at(0);
347         return  c == '{' || c == '}' || c == '&' || c == '$' ||
348                 c == '#' || c == '%' || c == '_';
349 }
350
351
352 } // namespace
353
354 MathWordList const & mathedWordList()
355 {
356         return theMathWordList;
357 }
358
359
360 void initMath()
361 {
362         static bool initialized = false;
363         if (!initialized) {
364                 initialized = true;
365                 initParser();
366                 initSymbols();
367         }
368 }
369
370
371 bool ensureMath(WriteStream & os, bool needs_mathmode, bool macro,
372                 bool textmode_macro)
373 {
374         bool brace = os.pendingBrace();
375         os.pendingBrace(false);
376         if (!os.latex())
377                 return brace;
378         if (os.textMode() && needs_mathmode) {
379                 if (brace) {
380                         // close \lyxmathsym
381                         os << '}';
382                         brace = false;
383                 } else {
384                         os << "\\ensuremath{";
385                         brace = true;
386                 }
387                 os.textMode(false);
388         } else if (macro && textmode_macro && !os.textMode()) {
389                 if (brace) {
390                         // close \ensuremath
391                         os << '}';
392                         brace = false;
393                 } else {
394                         os << "\\lyxmathsym{";
395                         brace = true;
396                 }
397                 os.textMode(true);
398         } else if (macro && brace && !needs_mathmode && !textmode_macro) {
399                 // This is a user defined macro, not a InsetMathMacro, so we
400                 // cannot be sure what mode is needed. We leave it in the
401                 // same environment it was entered by closing either \lyxmathsym
402                 // or \ensuremath, whichever was opened.
403                 os << '}';
404                 brace = false;
405                 os.textMode(!os.textMode());
406         }
407         return brace;
408 }
409
410
411 int ensureMode(WriteStream & os, InsetMath::mode_type mode,
412                 bool locked, bool ascii)
413 {
414         bool textmode = mode == InsetMath::TEXT_MODE;
415         if (os.latex() && textmode && os.pendingBrace()) {
416                 os.os() << '}';
417                 os.pendingBrace(false);
418                 os.pendingSpace(false);
419                 os.textMode(true);
420         }
421         int oldmodes = os.textMode() ? 0x01 : 0;
422         os.textMode(textmode);
423         oldmodes |= os.lockedMode() ? 0x02 : 0;
424         os.lockedMode(locked);
425         oldmodes |= os.asciiOnly() ? 0x04 : 0;
426         os.asciiOnly(ascii);
427         return oldmodes;
428 }
429
430
431 latexkeys const * in_word_set(docstring const & str)
432 {
433         MathWordList::iterator it = theMathWordList.find(str);
434         if (it == theMathWordList.end())
435                 return 0;
436         if (it->second.inset == "macro")
437                 return 0;
438         return &(it->second);
439 }
440
441
442 MathAtom createInsetMath(char const * const s, Buffer * buf)
443 {
444         return createInsetMath(from_utf8(s), buf);
445 }
446
447
448 MathAtom createInsetMath(docstring const & s, Buffer * buf)
449 {
450         //lyxerr << "creating inset with name: '" << to_utf8(s) << '\'' << endl;
451         if ((s == "ce" || s == "cf") && buf
452             && buf->params().use_package("mhchem") == BufferParams::package_off)
453                 return MathAtom(new InsetMathMacro(buf, s));
454
455         latexkeys const * l = in_word_set(s);
456         if (l) {
457                 string const & inset = l->inset;
458                 //lyxerr << " found inset: '" << inset << '\'' << endl;
459                 if (inset == "ref")
460                         return MathAtom(new InsetMathRef(buf, l->name));
461                 if (inset == "overset")
462                         return MathAtom(new InsetMathOverset(buf));
463                 if (inset == "underset")
464                         return MathAtom(new InsetMathUnderset(buf));
465                 if (inset == "decoration")
466                         return MathAtom(new InsetMathDecoration(buf, l));
467                 if (inset == "space")
468                         return MathAtom(new InsetMathSpace(to_ascii(l->name), ""));
469                 if (inset == "class")
470                         return MathAtom(new InsetMathClass(buf, string_to_class(s)));
471                 if (inset == "dots")
472                         return MathAtom(new InsetMathDots(l));
473                 if (inset == "mbox")
474                         return MathAtom(new InsetMathBox(buf, l->name));
475 //              if (inset == "fbox")
476 //                      return MathAtom(new InsetMathFBox(l));
477                 if (inset == "style")
478                         return MathAtom(new InsetMathSize(buf, l));
479                 if (inset == "font")
480                         return MathAtom(new InsetMathFont(buf, l));
481                 if (inset == "oldfont")
482                         return MathAtom(new InsetMathFontOld(buf, l));
483                 if (inset == "matrix")
484                         return MathAtom(new InsetMathAMSArray(buf, s));
485                 if (inset == "split")
486                         return MathAtom(new InsetMathSplit(buf, s));
487                 if (inset == "big")
488                         // we can't create a InsetMathBig, since the argument
489                         // is missing.
490                         return MathAtom(new InsetMathUnknown(s));
491                 return MathAtom(new InsetMathSymbol(l));
492         }
493
494         if (s.size() == 2 && s[0] == '#' && s[1] >= '1' && s[1] <= '9')
495                 return MathAtom(new InsetMathMacroArgument(s[1] - '0'));
496         if (s.size() == 3 && s[0] == '\\' && s[1] == '#'
497                         && s[2] >= '1' && s[2] <= '9')
498                 return MathAtom(new InsetMathMacroArgument(s[2] - '0'));
499         if (s == "boxed")
500                 return MathAtom(new InsetMathBoxed(buf));
501         if (s == "fbox")
502                 return MathAtom(new InsetMathFBox(buf));
503         if (s == "framebox")
504                 return MathAtom(new InsetMathMakebox(buf, true));
505         if (s == "makebox")
506                 return MathAtom(new InsetMathMakebox(buf, false));
507         if (s.substr(0, 8) == "xymatrix") {
508                 char spacing_code = '\0';
509                 Length spacing;
510                 bool equal_spacing = false;
511                 size_t const len = s.length();
512                 size_t i = 8;
513                 if (i < len && s[i] == '@') {
514                         ++i;
515                         if (i < len && s[i] == '!') {
516                                 equal_spacing = true;
517                                 ++i;
518                                 if (i < len) {
519                                         switch (s[i]) {
520                                         case '0':
521                                         case 'R':
522                                         case 'C':
523                                                 spacing_code = static_cast<char>(s[i]);
524                                         }
525                                 }
526                         } else if (i < len) {
527                                 switch (s[i]) {
528                                 case 'R':
529                                 case 'C':
530                                 case 'M':
531                                 case 'W':
532                                 case 'H':
533                                 case 'L':
534                                         spacing_code = static_cast<char>(s[i]);
535                                         ++i;
536                                         break;
537                                 }
538                                 if (i < len && s[i] == '=') {
539                                         ++i;
540                                         spacing = Length(to_ascii(s.substr(i)));
541                                 }
542                         }
543                 }
544                 return MathAtom(new InsetMathXYMatrix(buf, spacing, spacing_code,
545                         equal_spacing));
546         }
547
548         if (s == "Diagram")
549                 return MathAtom(new InsetMathDiagram(buf));
550         if (s == "xrightarrow" || s == "xleftarrow" ||
551                 s == "xhookrightarrow" || s == "xhookleftarrow" ||
552                 s == "xRightarrow" || s == "xLeftarrow" ||
553                 s == "xleftrightarrow" || s == "xLeftrightarrow" ||
554                 s == "xrightharpoondown" || s == "xrightharpoonup" ||
555                 s == "xleftharpoondown" || s == "xleftharpoonup" ||
556                 s == "xleftrightharpoons" || s == "xrightleftharpoons" ||
557                 s == "xmapsto")
558                 return MathAtom(new InsetMathXArrow(buf, s));
559         if (s == "split" || s == "alignedat")
560                 return MathAtom(new InsetMathSplit(buf, s));
561         if (s == "cases")
562                 return MathAtom(new InsetMathCases(buf));
563         if (s == "substack")
564                 return MathAtom(new InsetMathSubstack(buf));
565         if (s == "subarray" || s == "array")
566                 return MathAtom(new InsetMathArray(buf, s, 1, 1));
567         if (s == "sqrt")
568                 return MathAtom(new InsetMathSqrt(buf));
569         if (s == "root")
570                 return MathAtom(new InsetMathRoot(buf));
571         if (s == "tabular")
572                 return MathAtom(new InsetMathTabular(buf, s, 1, 1));
573         if (s == "stackrel")
574                 return MathAtom(new InsetMathStackrel(buf, false));
575         // This string value is only for math toolbar use, no LaTeX name
576         if (s == "stackrelthree")
577                 return MathAtom(new InsetMathStackrel(buf, true));
578         if (s == "binom")
579                 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BINOM));
580         if (s == "dbinom")
581                 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::DBINOM));
582         if (s == "tbinom")
583                 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::TBINOM));
584         if (s == "choose")
585                 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::CHOOSE));
586         if (s == "brace")
587                 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BRACE));
588         if (s == "brack")
589                 return MathAtom(new InsetMathBinom(buf, InsetMathBinom::BRACK));
590         if (s == "frac")
591                 return MathAtom(new InsetMathFrac(buf));
592         if (s == "cfrac")
593                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRAC));
594         if (s == "dfrac")
595                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::DFRAC));
596         if (s == "tfrac")
597                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::TFRAC));
598         if (s == "over")
599                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::OVER));
600         if (s == "nicefrac")
601                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::NICEFRAC));
602         if (s == "unitfrac")
603                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC));
604         // These string values are only for math toolbar use, no LaTeX names
605         if (s == "unitfracthree")
606                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC, 3));
607         if (s == "unitone")
608                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT, 1));
609         if (s == "unittwo")
610                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT));
611         if (s == "cfracleft")
612                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACLEFT));
613         if (s == "cfracright")
614                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACRIGHT));
615         //if (s == "infer")
616         //      return MathAtom(new MathInferInset);
617         if (s == "atop")
618                 return MathAtom(new InsetMathFrac(buf, InsetMathFrac::ATOP));
619         if (s == "lefteqn")
620                 return MathAtom(new InsetMathLefteqn(buf));
621         if (s == "boldsymbol")
622                 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::AMS_BOLD));
623         if (s == "bm")
624                 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::BM_BOLD));
625         if (s == "heavysymbol" || s == "hm")
626                 return MathAtom(new InsetMathBoldSymbol(buf, InsetMathBoldSymbol::BM_HEAVY));
627         if (s == "color" || s == "normalcolor")
628                 return MathAtom(new InsetMathColor(buf, true));
629         if (s == "textcolor")
630                 return MathAtom(new InsetMathColor(buf, false));
631         if (s == "hphantom")
632                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::hphantom));
633         if (s == "phantom")
634                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::phantom));
635         if (s == "vphantom")
636                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::vphantom));
637         if (s == "cancel")
638                 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::cancel));
639         if (s == "bcancel")
640                 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::bcancel));
641         if (s == "xcancel")
642                 return MathAtom(new InsetMathCancel(buf, InsetMathCancel::xcancel));
643         if (s == "cancelto")
644                 return MathAtom(new InsetMathCancelto(buf));
645         if (s == "smash")
646                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smash));
647         // The following 2 string values are only for math toolbar use, no LaTeX names
648         if (s == "smashb")
649                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smashb));
650         if (s == "smasht")
651                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::smasht));
652         if (s == "mathclap")
653                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathclap));
654         if (s == "mathllap")
655                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathllap));
656         if (s == "mathrlap")
657                 return MathAtom(new InsetMathPhantom(buf, InsetMathPhantom::mathrlap));
658         if (s == "ensuremath")
659                 return MathAtom(new InsetMathEnsureMath(buf));
660         if (s == "sideset")
661                 return MathAtom(new InsetMathSideset(buf, true, true));
662         // The following 3 string values are only for math toolbar use, no LaTeX names
663         if (s == "sidesetr")
664                 return MathAtom(new InsetMathSideset(buf, false, true));
665         if (s == "sidesetl")
666                 return MathAtom(new InsetMathSideset(buf, true, false));
667         if (s == "sidesetn")
668                 return MathAtom(new InsetMathSideset(buf, false, false));
669         if (isSpecialChar(s))
670                 return MathAtom(new InsetMathSpecialChar(s));
671         if (s == " ")
672                 return MathAtom(new InsetMathSpace(" ", ""));
673         if (s == "regexp")
674                 return MathAtom(new InsetMathHull(buf, hullRegexp));
675
676         return MathAtom(new InsetMathMacro(buf, s));
677 }
678
679
680 bool createInsetMath_fromDialogStr(docstring const & str, MathData & ar)
681 {
682         // An example str:
683         // "ref LatexCommand ref\nreference \"sec:Title\"\n\\end_inset\n\n";
684         docstring name;
685         docstring body = split(str, name, ' ');
686
687         if (name == "ref") {
688                 InsetCommandParams icp(REF_CODE);
689                 // FIXME UNICODE
690                 InsetCommand::string2params(to_utf8(str), icp);
691                 Encoding const * const utf8 = encodings.fromLyXName("utf8");
692                 OutputParams op(utf8);
693                 mathed_parse_cell(ar, icp.getCommand(op));
694         } else if (name == "mathspace") {
695                 InsetSpaceParams isp(true);
696                 InsetSpace::string2params(to_utf8(str), isp);
697                 InsetSpace is(isp);
698                 odocstringstream ods;
699                 otexstream os(ods);
700                 Encoding const * const ascii = encodings.fromLyXName("ascii");
701                 OutputParams op(ascii);
702                 is.latex(os, op);
703                 mathed_parse_cell(ar, ods.str());
704                 if (ar.size() == 2) {
705                         // remove "{}"
706                         if (ar[1].nucleus()->asBraceInset())
707                                 ar.pop_back();
708                 }
709         } else
710                 return false;
711
712         if (ar.size() != 1)
713                 return false;
714
715         return ar[0].nucleus();
716 }
717
718
719 } // namespace lyx