]> git.lyx.org Git - lyx.git/blob - src/mathed/MathParser.cpp
Fix #7549, due to a problem in exporting to plaintext a
[lyx.git] / src / mathed / MathParser.cpp
1 /**
2  * \file MathParser.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 /*
12
13 If someone desperately needs partial "structures" (such as a few
14 cells of an array inset or similar) (s)he could uses the
15 following hack as starting point to write some macros:
16
17   \newif\ifcomment
18   \commentfalse
19   \ifcomment
20           \def\makeamptab{\catcode`\&=4\relax}
21           \def\makeampletter{\catcode`\&=11\relax}
22     \def\b{\makeampletter\expandafter\makeamptab\bi}
23     \long\def\bi#1\e{}
24   \else
25     \def\b{}\def\e{}
26   \fi
27   ...
28
29   \[\begin{array}{ccc}
30 1
31 &
32
33   \end{array}\]
34
35 */
36
37
38 #include <config.h>
39
40 #include "MathParser.h"
41
42 #include "InsetMathArray.h"
43 #include "InsetMathBig.h"
44 #include "InsetMathBrace.h"
45 #include "InsetMathChar.h"
46 #include "InsetMathColor.h"
47 #include "InsetMathComment.h"
48 #include "InsetMathDelim.h"
49 #include "InsetMathEnsureMath.h"
50 #include "InsetMathEnv.h"
51 #include "InsetMathFrac.h"
52 #include "InsetMathKern.h"
53 #include "MathMacro.h"
54 #include "InsetMathPar.h"
55 #include "InsetMathRef.h"
56 #include "InsetMathRoot.h"
57 #include "InsetMathScript.h"
58 #include "InsetMathSpace.h"
59 #include "InsetMathSplit.h"
60 #include "InsetMathSqrt.h"
61 #include "InsetMathString.h"
62 #include "InsetMathTabular.h"
63 #include "MathMacroTemplate.h"
64 #include "MathFactory.h"
65 #include "MathMacroArgument.h"
66 #include "MathSupport.h"
67
68 #include "Buffer.h"
69 #include "BufferParams.h"
70 #include "Encoding.h"
71 #include "Lexer.h"
72
73 #include "support/debug.h"
74 #include "support/convert.h"
75 #include "support/docstream.h"
76
77 #include <sstream>
78
79 //#define FILEDEBUG
80
81 using namespace std;
82
83 namespace lyx {
84
85 namespace {
86
87 InsetMath::mode_type asMode(InsetMath::mode_type oldmode, docstring const & str)
88 {
89         //lyxerr << "handling mode: '" << str << "'" << endl;
90         if (str == "mathmode")
91                 return InsetMath::MATH_MODE;
92         if (str == "textmode" || str == "forcetext")
93                 return InsetMath::TEXT_MODE;
94         return oldmode;
95 }
96
97
98 bool stared(docstring const & s)
99 {
100         size_t const n = s.size();
101         return n && s[n - 1] == '*';
102 }
103
104
105 docstring const repl(docstring const & oldstr, char_type const c,
106                      docstring const & macro, bool textmode = false)
107 {
108         docstring newstr;
109         size_t i;
110         size_t j;
111
112         for (i = 0, j = 0; i < oldstr.size(); ++i) {
113                 if (c == oldstr[i]) {
114                         newstr.append(oldstr, j, i - j);
115                         newstr.append(macro);
116                         j = i + 1;
117                         if (macro.size() > 2 && j < oldstr.size())
118                                 newstr += (textmode && oldstr[j] == ' ' ? '\\' : ' ');
119                 }
120         }
121
122         // Any substitution?
123         if (j == 0)
124                 return oldstr;
125
126         newstr.append(oldstr, j, i - j);
127         return newstr;
128 }
129
130
131 docstring escapeSpecialChars(docstring const & str, bool textmode)
132 {
133         docstring const backslash = textmode ? from_ascii("\\textbackslash")
134                                              : from_ascii("\\backslash");
135         docstring const caret = textmode ? from_ascii("\\textasciicircum")
136                                          : from_ascii("\\mathcircumflex");
137         docstring const tilde = textmode ? from_ascii("\\textasciitilde")
138                                          : from_ascii("\\sim");
139
140         return repl(repl(repl(repl(repl(repl(repl(repl(repl(repl(str,
141                         '\\', backslash, textmode),
142                         '^', caret, textmode),
143                         '~', tilde, textmode),
144                         '_', from_ascii("\\_")),
145                         '$', from_ascii("\\$")),
146                         '#', from_ascii("\\#")),
147                         '&', from_ascii("\\&")),
148                         '%', from_ascii("\\%")),
149                         '{', from_ascii("\\{")),
150                         '}', from_ascii("\\}"));
151 }
152
153
154 /*!
155  * Add the row \p cellrow to \p grid.
156  * \returns wether the row could be added. Adding a row can fail for
157  * environments like "equation" that have a fixed number of rows.
158  */
159 bool addRow(InsetMathGrid & grid, InsetMathGrid::row_type & cellrow,
160             docstring const & vskip, bool allow_newpage_ = true)
161 {
162         ++cellrow;
163         if (cellrow == grid.nrows()) {
164                 //lyxerr << "adding row " << cellrow << endl;
165                 grid.addRow(cellrow - 1);
166                 if (cellrow == grid.nrows()) {
167                         // We can't add a row to this grid, so let's
168                         // append the content of this cell to the previous
169                         // one.
170                         // This does not happen in well formed .lyx files,
171                         // but LyX versions 1.3.x and older could create
172                         // such files and tex2lyx can still do that.
173                         --cellrow;
174                         lyxerr << "ignoring extra row";
175                         if (!vskip.empty())
176                                 lyxerr << " with extra space " << to_utf8(vskip);
177                         if (!allow_newpage_)
178                                 lyxerr << " with no page break allowed";
179                         lyxerr << '.' << endl;
180                         return false;
181                 }
182         }
183         grid.vcrskip(Length(to_utf8(vskip)), cellrow - 1);
184         grid.rowinfo(cellrow - 1).allow_newpage_ = allow_newpage_;
185         return true;
186 }
187
188
189 /*!
190  * Add the column \p cellcol to \p grid.
191  * \returns wether the column could be added. Adding a column can fail for
192  * environments like "eqnarray" that have a fixed number of columns.
193  */
194 bool addCol(InsetMathGrid & grid, InsetMathGrid::col_type & cellcol)
195 {
196         ++cellcol;
197         if (cellcol == grid.ncols()) {
198                 //lyxerr << "adding column " << cellcol << endl;
199                 grid.addCol(cellcol);
200                 if (cellcol == grid.ncols()) {
201                         // We can't add a column to this grid, so let's
202                         // append the content of this cell to the previous
203                         // one.
204                         // This does not happen in well formed .lyx files,
205                         // but LyX versions 1.3.x and older could create
206                         // such files and tex2lyx can still do that.
207                         --cellcol;
208                         lyxerr << "ignoring extra column." << endl;
209                         return false;
210                 }
211         }
212         return true;
213 }
214
215
216 /*!
217  * Check whether the last row is empty and remove it if yes.
218  * Otherwise the following code
219  * \verbatim
220 \begin{array}{|c|c|}
221 \hline
222 1 & 2 \\ \hline
223 3 & 4 \\ \hline
224 \end{array}
225  * \endverbatim
226  * will result in a grid with 3 rows (+ the dummy row that is always present),
227  * because the last '\\' opens a new row.
228  * Note that this is only needed for inner-hull grid types, such as array
229  * or aligned, but not for outer-hull grid types, such as eqnarray or align.
230  */
231 void delEmptyLastRow(InsetMathGrid & grid)
232 {
233         InsetMathGrid::row_type const row = grid.nrows() - 1;
234         for (InsetMathGrid::col_type col = 0; col < grid.ncols(); ++col) {
235                 if (!grid.cell(grid.index(row, col)).empty())
236                         return;
237         }
238         // Copy the row information of the empty row (which would contain the
239         // last hline in the example above) to the dummy row and delete the
240         // empty row.
241         grid.rowinfo(row + 1) = grid.rowinfo(row);
242         grid.delRow(row);
243 }
244
245
246 /*!
247  * Tell whether the environment name corresponds to an inner-hull grid type.
248  */
249 bool innerHull(docstring const & name)
250 {
251         // For [bB]matrix, [vV]matrix, and pmatrix we can check the suffix only
252         return name == "array" || name == "cases" || name == "aligned"
253                 || name == "alignedat" || name == "gathered" || name == "split"
254                 || name == "subarray" || name == "tabular" || name == "matrix"
255                 || name == "smallmatrix" || name.substr(1) == "matrix";
256 }
257
258
259 // These are TeX's catcodes
260 enum CatCode {
261         catEscape,     // 0    backslash
262         catBegin,      // 1    {
263         catEnd,        // 2    }
264         catMath,       // 3    $
265         catAlign,      // 4    &
266         catNewline,    // 5    ^^M
267         catParameter,  // 6    #
268         catSuper,      // 7    ^
269         catSub,        // 8    _
270         catIgnore,     // 9
271         catSpace,      // 10   space
272         catLetter,     // 11   a-zA-Z
273         catOther,      // 12   none of the above
274         catActive,     // 13   ~
275         catComment,    // 14   %
276         catInvalid     // 15   <delete>
277 };
278
279 CatCode theCatcode[128];
280
281
282 inline CatCode catcode(char_type c)
283 {
284         /* The only characters that are not catOther lie in the pure ASCII
285          * range. Therefore theCatcode has only 128 entries.
286          * TeX itself deals with 8bit characters, so if needed this table
287          * could be enlarged to 256 entries.
288          * Any larger value does not make sense, since the fact that we use
289          * unicode internally does not change Knuth's TeX engine.
290          * Apart from that a table for the full 21bit UCS4 range would waste
291          * too much memory. */
292         if (c >= 128)
293                 return catOther;
294
295         return theCatcode[c];
296 }
297
298
299 enum {
300         FLAG_ALIGN      = 1 << 0,  //  next & or \\ ends the parsing process
301         FLAG_BRACE_LAST = 1 << 1,  //  next closing brace ends the parsing
302         FLAG_RIGHT      = 1 << 2,  //  next \\right ends the parsing process
303         FLAG_END        = 1 << 3,  //  next \\end ends the parsing process
304         FLAG_BRACK_LAST = 1 << 4,  //  next closing bracket ends the parsing
305         FLAG_TEXTMODE   = 1 << 5,  //  we are in a box
306         FLAG_ITEM       = 1 << 6,  //  read a (possibly braced) token
307         FLAG_LEAVE      = 1 << 7,  //  leave the loop at the end
308         FLAG_SIMPLE     = 1 << 8,  //  next $ leaves the loop
309         FLAG_EQUATION   = 1 << 9,  //  next \] leaves the loop
310         FLAG_SIMPLE2    = 1 << 10, //  next \) leaves the loop
311         FLAG_OPTION     = 1 << 11, //  read [...] style option
312         FLAG_BRACED     = 1 << 12  //  read {...} style argument
313 };
314
315
316 //
317 // Helper class for parsing
318 //
319
320 class Token {
321 public:
322         ///
323         Token() : cs_(), char_(0), cat_(catIgnore) {}
324         ///
325         Token(char_type c, CatCode cat) : cs_(), char_(c), cat_(cat) {}
326         ///
327         explicit Token(docstring const & cs) : cs_(cs), char_(0), cat_(catIgnore) {}
328
329         ///
330         docstring const & cs() const { return cs_; }
331         ///
332         CatCode cat() const { return cat_; }
333         ///
334         char_type character() const { return char_; }
335         ///
336         docstring asString() const { return cs_.size() ? cs_ : docstring(1, char_); }
337         ///
338         docstring asInput() const { return cs_.size() ? '\\' + cs_ : docstring(1, char_); }
339
340 private:
341         ///
342         docstring cs_;
343         ///
344         char_type char_;
345         ///
346         CatCode cat_;
347 };
348
349
350 ostream & operator<<(ostream & os, Token const & t)
351 {
352         if (t.cs().size()) {
353                 docstring const & cs = t.cs();
354                 // FIXME: For some strange reason, the stream operator instanciate
355                 // a new Token before outputting the contents of t.cs().
356                 // Because of this the line
357                 //     os << '\\' << cs;
358                 // below becomes recursive.
359                 // In order to avoid that we return early:
360                 if (cs == "\\")
361                         return os;
362                 os << '\\' << to_utf8(cs);
363         }
364         else if (t.cat() == catLetter)
365                 os << t.character();
366         else
367                 os << '[' << t.character() << ',' << t.cat() << ']';
368         return os;
369 }
370
371
372 class Parser {
373 public:
374         ///
375         typedef  InsetMath::mode_type mode_type;
376         ///
377         typedef  Parse::flags parse_mode;
378
379         ///
380         Parser(Lexer & lex, parse_mode mode, Buffer * buf);
381         /// Only use this for reading from .lyx file format, for the reason
382         /// see Parser::tokenize(istream &).
383         Parser(istream & is, parse_mode mode, Buffer * buf);
384         ///
385         Parser(docstring const & str, parse_mode mode, Buffer * buf);
386
387         ///
388         bool parse(MathAtom & at);
389         ///
390         bool parse(MathData & array, unsigned flags, mode_type mode);
391         ///
392         bool parse1(InsetMathGrid & grid, unsigned flags, mode_type mode,
393                 bool numbered);
394         ///
395         MathData parse(unsigned flags, mode_type mode);
396         ///
397         int lineno() const { return lineno_; }
398         ///
399         void putback();
400
401 private:
402         ///
403         void parse2(MathAtom & at, unsigned flags, mode_type mode, bool numbered);
404         /// get arg delimited by 'left' and 'right'
405         docstring getArg(char_type left, char_type right);
406         ///
407         char_type getChar();
408         ///
409         void error(string const & msg);
410         void error(docstring const & msg) { error(to_utf8(msg)); }
411         /// dump contents to screen
412         void dump() const;
413         /// Only use this for reading from .lyx file format (see
414         /// implementation for reason)
415         void tokenize(istream & is);
416         ///
417         void tokenize(docstring const & s);
418         ///
419         void skipSpaceTokens(idocstream & is, char_type c);
420         ///
421         void push_back(Token const & t);
422         ///
423         void pop_back();
424         ///
425         Token const & prevToken() const;
426         ///
427         Token const & nextToken() const;
428         ///
429         Token const & getToken();
430         /// skips spaces if any
431         void skipSpaces();
432         ///
433         void lex(docstring const & s);
434         ///
435         bool good() const;
436         ///
437         docstring parse_verbatim_item();
438         ///
439         docstring parse_verbatim_option();
440
441         ///
442         int lineno_;
443         ///
444         vector<Token> tokens_;
445         ///
446         unsigned pos_;
447         /// Stack of active environments
448         vector<docstring> environments_;
449         ///
450         parse_mode mode_;
451         ///
452         bool success_;
453         ///
454         Buffer * buffer_;
455 };
456
457
458 Parser::Parser(Lexer & lexer, parse_mode mode, Buffer * buf)
459         : lineno_(lexer.lineNumber()), pos_(0), mode_(mode), success_(true),
460           buffer_(buf)
461 {
462         tokenize(lexer.getStream());
463         lexer.eatLine();
464 }
465
466
467 Parser::Parser(istream & is, parse_mode mode, Buffer * buf)
468         : lineno_(0), pos_(0), mode_(mode), success_(true), buffer_(buf)
469 {
470         tokenize(is);
471 }
472
473
474 Parser::Parser(docstring const & str, parse_mode mode, Buffer * buf)
475         : lineno_(0), pos_(0), mode_(mode), success_(true), buffer_(buf)
476 {
477         tokenize(str);
478 }
479
480
481 void Parser::push_back(Token const & t)
482 {
483         tokens_.push_back(t);
484 }
485
486
487 void Parser::pop_back()
488 {
489         tokens_.pop_back();
490 }
491
492
493 Token const & Parser::prevToken() const
494 {
495         static const Token dummy;
496         return pos_ > 0 ? tokens_[pos_ - 1] : dummy;
497 }
498
499
500 Token const & Parser::nextToken() const
501 {
502         static const Token dummy;
503         return good() ? tokens_[pos_] : dummy;
504 }
505
506
507 Token const & Parser::getToken()
508 {
509         static const Token dummy;
510         //lyxerr << "looking at token " << tokens_[pos_] << " pos: " << pos_ << endl;
511         return good() ? tokens_[pos_++] : dummy;
512 }
513
514
515 void Parser::skipSpaces()
516 {
517         while (nextToken().cat() == catSpace || nextToken().cat() == catNewline)
518                 getToken();
519 }
520
521
522 void Parser::putback()
523 {
524         --pos_;
525 }
526
527
528 bool Parser::good() const
529 {
530         return pos_ < tokens_.size();
531 }
532
533
534 char_type Parser::getChar()
535 {
536         if (!good()) {
537                 error("The input stream is not well...");
538                 putback();
539                 return 0;
540         }
541         return tokens_[pos_++].character();
542 }
543
544
545 docstring Parser::getArg(char_type left, char_type right)
546 {
547         skipSpaces();
548
549         docstring result;
550         char_type c = getChar();
551
552         if (c != left)
553                 putback();
554         else
555                 while ((c = getChar()) != right && good())
556                         result += c;
557
558         return result;
559 }
560
561
562 void Parser::skipSpaceTokens(idocstream & is, char_type c)
563 {
564         // skip trailing spaces
565         while (catcode(c) == catSpace || catcode(c) == catNewline)
566                 if (!is.get(c))
567                         break;
568         //lyxerr << "putting back: " << c << endl;
569         is.putback(c);
570 }
571
572
573 void Parser::tokenize(istream & is)
574 {
575         // eat everything up to the next \end_inset or end of stream
576         // and store it in s for further tokenization
577         string s;
578         char c;
579         while (is.get(c)) {
580                 s += c;
581                 if (s.size() >= 10 && s.substr(s.size() - 10) == "\\end_inset") {
582                         s = s.substr(0, s.size() - 10);
583                         break;
584                 }
585         }
586         // Remove the space after \end_inset
587         if (is.get(c) && c != ' ')
588                 is.unget();
589
590         // tokenize buffer
591         tokenize(from_utf8(s));
592 }
593
594
595 void Parser::tokenize(docstring const & buffer)
596 {
597         idocstringstream is(mode_ & Parse::VERBATIM
598                         ? escapeSpecialChars(buffer, mode_ & Parse::TEXTMODE)
599                         : buffer, ios::in | ios::binary);
600
601         char_type c;
602         while (is.get(c)) {
603                 //lyxerr << "reading c: " << c << endl;
604
605                 switch (catcode(c)) {
606                         case catNewline: {
607                                 ++lineno_;
608                                 is.get(c);
609                                 if (catcode(c) == catNewline)
610                                         ; //push_back(Token("par"));
611                                 else {
612                                         push_back(Token('\n', catNewline));
613                                         is.putback(c);
614                                 }
615                                 break;
616                         }
617
618 /*
619                         case catComment: {
620                                 while (is.get(c) && catcode(c) != catNewline)
621                                         ;
622                                 ++lineno_;
623                                 break;
624                         }
625 */
626
627                         case catEscape: {
628                                 is.get(c);
629                                 if (!is) {
630                                         error("unexpected end of input");
631                                 } else {
632                                         if (c == '\n')
633                                                 c = ' ';
634                                         docstring s(1, c);
635                                         if (catcode(c) == catLetter) {
636                                                 // collect letters
637                                                 while (is.get(c) && catcode(c) == catLetter)
638                                                         s += c;
639                                                 skipSpaceTokens(is, c);
640                                         }
641                                         push_back(Token(s));
642                                 }
643                                 break;
644                         }
645
646                         case catSuper:
647                         case catSub: {
648                                 push_back(Token(c, catcode(c)));
649                                 is.get(c);
650                                 skipSpaceTokens(is, c);
651                                 break;
652                         }
653
654                         case catIgnore: {
655                                 if (!(mode_ & Parse::QUIET))
656                                         lyxerr << "ignoring a char: " << int(c) << endl;
657                                 break;
658                         }
659
660                         default:
661                                 push_back(Token(c, catcode(c)));
662                 }
663         }
664
665 #ifdef FILEDEBUG
666         dump();
667 #endif
668 }
669
670
671 void Parser::dump() const
672 {
673         lyxerr << "\nTokens: ";
674         for (unsigned i = 0; i < tokens_.size(); ++i) {
675                 if (i == pos_)
676                         lyxerr << " <#> ";
677                 lyxerr << tokens_[i];
678         }
679         lyxerr << " pos: " << pos_ << endl;
680 }
681
682
683 void Parser::error(string const & msg)
684 {
685         success_ = false;
686         if (!(mode_ & Parse::QUIET)) {
687                 lyxerr << "Line ~" << lineno_ << ": Math parse error: "
688                        << msg << endl;
689                 dump();
690         }
691 }
692
693
694 bool Parser::parse(MathAtom & at)
695 {
696         skipSpaces();
697         MathData ar(buffer_);
698         parse(ar, false, InsetMath::UNDECIDED_MODE);
699         if (ar.size() != 1 || ar.front()->getType() == hullNone) {
700                 if (!(mode_ & Parse::QUIET))
701                         lyxerr << "unusual contents found: " << ar << endl;
702                 at = MathAtom(new InsetMathPar(buffer_, ar));
703                 //if (at->nargs() > 0)
704                 //      at.nucleus()->cell(0) = ar;
705                 //else
706                 //      lyxerr << "unusual contents found: " << ar << endl;
707                 success_ = false;
708         } else
709                 at = ar[0];
710         return success_;
711 }
712
713
714 docstring Parser::parse_verbatim_option()
715 {
716         skipSpaces();
717         docstring res;
718         if (nextToken().character() == '[') {
719                 Token t = getToken();
720                 for (Token t = getToken(); t.character() != ']' && good(); t = getToken()) {
721                         if (t.cat() == catBegin) {
722                                 putback();
723                                 res += '{' + parse_verbatim_item() + '}';
724                         } else
725                                 res += t.asInput();
726                 }
727         }
728         return res;
729 }
730
731
732 docstring Parser::parse_verbatim_item()
733 {
734         skipSpaces();
735         docstring res;
736         if (nextToken().cat() == catBegin) {
737                 Token t = getToken();
738                 for (Token t = getToken(); t.cat() != catEnd && good(); t = getToken()) {
739                         if (t.cat() == catBegin) {
740                                 putback();
741                                 res += '{' + parse_verbatim_item() + '}';
742                         }
743                         else
744                                 res += t.asInput();
745                 }
746         }
747         return res;
748 }
749
750
751 MathData Parser::parse(unsigned flags, mode_type mode)
752 {
753         MathData ar(buffer_);
754         parse(ar, flags, mode);
755         return ar;
756 }
757
758
759 bool Parser::parse(MathData & array, unsigned flags, mode_type mode)
760 {
761         InsetMathGrid grid(buffer_, 1, 1);
762         parse1(grid, flags, mode, false);
763         array = grid.cell(0);
764         return success_;
765 }
766
767
768 void Parser::parse2(MathAtom & at, const unsigned flags, const mode_type mode,
769         const bool numbered)
770 {
771         parse1(*(at.nucleus()->asGridInset()), flags, mode, numbered);
772 }
773
774
775 bool Parser::parse1(InsetMathGrid & grid, unsigned flags,
776         const mode_type mode, const bool numbered)
777 {
778         int limits = 0;
779         InsetMathGrid::row_type cellrow = 0;
780         InsetMathGrid::col_type cellcol = 0;
781         MathData * cell = &grid.cell(grid.index(cellrow, cellcol));
782         Buffer * buf = buffer_;
783
784         if (grid.asHullInset())
785                 grid.asHullInset()->numbered(cellrow, numbered);
786
787         //dump();
788         //lyxerr << " flags: " << flags << endl;
789         //lyxerr << " mode: " << mode  << endl;
790         //lyxerr << "grid: " << grid << endl;
791
792         while (good()) {
793                 Token const & t = getToken();
794
795 #ifdef FILEDEBUG
796                 lyxerr << "t: " << t << " flags: " << flags << endl;
797                 lyxerr << "mode: " << mode  << endl;
798                 cell->dump();
799                 lyxerr << endl;
800 #endif
801
802                 if (flags & FLAG_ITEM) {
803
804                         if (t.cat() == catBegin) {
805                                 // skip the brace and collect everything to the next matching
806                                 // closing brace
807                                 parse1(grid, FLAG_BRACE_LAST, mode, numbered);
808                                 return success_;
809                         }
810
811                         // handle only this single token, leave the loop if done
812                         flags = FLAG_LEAVE;
813                 }
814
815
816                 if (flags & FLAG_BRACED) {
817                         if (t.cat() == catSpace)
818                                 continue;
819
820                         if (t.cat() != catBegin) {
821                                 error("opening brace expected");
822                                 return success_;
823                         }
824
825                         // skip the brace and collect everything to the next matching
826                         // closing brace
827                         flags = FLAG_BRACE_LAST;
828                 }
829
830
831                 if (flags & FLAG_OPTION) {
832                         if (t.cat() == catOther && t.character() == '[') {
833                                 MathData ar;
834                                 parse(ar, FLAG_BRACK_LAST, mode);
835                                 cell->append(ar);
836                         } else {
837                                 // no option found, put back token and we are done
838                                 putback();
839                         }
840                         return success_;
841                 }
842
843                 //
844                 // cat codes
845                 //
846                 if (t.cat() == catMath) {
847                         if (mode != InsetMath::MATH_MODE) {
848                                 // we are inside some text mode thingy, so opening new math is allowed
849                                 Token const & n = getToken();
850                                 if (n.cat() == catMath) {
851                                         // TeX's $$...$$ syntax for displayed math
852                                         if (mode == InsetMath::UNDECIDED_MODE) {
853                                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullEquation)));
854                                                 parse2(cell->back(), FLAG_SIMPLE, InsetMath::MATH_MODE, false);
855                                                 getToken(); // skip the second '$' token
856                                         } else {
857                                                 // This is not an outer hull and display math is
858                                                 // not allowed inside text mode environments.
859                                                 error("bad math environment");
860                                                 break;
861                                         }
862                                 } else {
863                                         // simple $...$  stuff
864                                         putback();
865                                         if (mode == InsetMath::UNDECIDED_MODE) {
866                                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullSimple)));
867                                                 parse2(cell->back(), FLAG_SIMPLE, InsetMath::MATH_MODE, false);
868                                         } else {
869                                                 // Don't create nested math hulls (bug #5392)
870                                                 cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
871                                                 parse(cell->back().nucleus()->cell(0), FLAG_SIMPLE, InsetMath::MATH_MODE);
872                                         }
873                                 }
874                         }
875
876                         else if (flags & FLAG_SIMPLE) {
877                                 // this is the end of the formula
878                                 return success_;
879                         }
880
881                         else {
882                                 Token const & n = getToken();
883                                 if (n.cat() == catMath) {
884                                         error("something strange in the parser");
885                                         break;
886                                 } else {
887                                         // This is inline math ($...$), but the parser thinks we are
888                                         // already in math mode and latex would issue an error, unless we
889                                         // are inside a text mode user macro. We have no way to tell, so
890                                         // let's play safe by using \ensuremath, as it will work in any case.
891                                         putback();
892                                         cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
893                                         parse(cell->back().nucleus()->cell(0), FLAG_SIMPLE, InsetMath::MATH_MODE);
894                                 }
895                         }
896                 }
897
898                 else if (t.cat() == catLetter)
899                         cell->push_back(MathAtom(new InsetMathChar(t.character())));
900
901                 else if (t.cat() == catSpace && mode != InsetMath::MATH_MODE) {
902                         if (cell->empty() || cell->back()->getChar() != ' ')
903                                 cell->push_back(MathAtom(new InsetMathChar(t.character())));
904                 }
905
906                 else if (t.cat() == catNewline && mode != InsetMath::MATH_MODE) {
907                         if (cell->empty() || cell->back()->getChar() != ' ')
908                                 cell->push_back(MathAtom(new InsetMathChar(' ')));
909                 }
910
911                 else if (t.cat() == catParameter) {
912                         Token const & n = getToken();
913                         cell->push_back(MathAtom(new MathMacroArgument(n.character()-'0')));
914                 }
915
916                 else if (t.cat() == catActive)
917                         cell->push_back(MathAtom(new InsetMathChar(t.character())));
918
919                 else if (t.cat() == catBegin) {
920                         MathData ar;
921                         parse(ar, FLAG_BRACE_LAST, mode);
922                         // do not create a BraceInset if they were written by LyX
923                         // this helps to keep the annoyance of  "a choose b"  to a minimum
924                         if (ar.size() == 1 && ar[0]->extraBraces())
925                                 cell->append(ar);
926                         else
927                                 cell->push_back(MathAtom(new InsetMathBrace(ar)));
928                 }
929
930                 else if (t.cat() == catEnd) {
931                         if (flags & FLAG_BRACE_LAST)
932                                 return success_;
933                         error("found '}' unexpectedly");
934                         //LASSERT(false, /**/);
935                         //add(cell, '}', LM_TC_TEX);
936                 }
937
938                 else if (t.cat() == catAlign) {
939                         //lyxerr << " column now " << (cellcol + 1)
940                         //       << " max: " << grid.ncols() << endl;
941                         if (flags & FLAG_ALIGN)
942                                 return success_;
943                         if (addCol(grid, cellcol))
944                                 cell = &grid.cell(grid.index(cellrow, cellcol));
945                 }
946
947                 else if (t.cat() == catSuper || t.cat() == catSub) {
948                         bool up = (t.cat() == catSuper);
949                         // we need no new script inset if the last thing was a scriptinset,
950                         // which has that script already not the same script already
951                         if (!cell->size())
952                                 cell->push_back(MathAtom(new InsetMathScript(buf, up)));
953                         else if (cell->back()->asScriptInset() &&
954                                         !cell->back()->asScriptInset()->has(up))
955                                 cell->back().nucleus()->asScriptInset()->ensure(up);
956                         else if (cell->back()->asScriptInset())
957                                 cell->push_back(MathAtom(new InsetMathScript(buf, up)));
958                         else
959                                 cell->back() = MathAtom(new InsetMathScript(buf, cell->back(), up));
960                         InsetMathScript * p = cell->back().nucleus()->asScriptInset();
961                         // special handling of {}-bases
962                         // Here we could remove the brace inset for things
963                         // like {a'}^2 and add the braces back in
964                         // InsetMathScript::write().
965                         // We do not do it, since it is not possible to detect
966                         // reliably whether the braces are needed because the
967                         // nucleus contains more than one symbol, or whether
968                         // they are needed for unknown commands like \xx{a}_0
969                         // or \yy{a}{b}_0. This was done in revision 14819
970                         // in an unreliable way. See this thread
971                         // http://www.mail-archive.com/lyx-devel%40lists.lyx.org/msg104917.html
972                         // for more details.
973                         // However, we remove empty braces because they look
974                         // ugly on screen and we are sure that they were added
975                         // by the write() method (and will be re-added on save).
976                         if (p->nuc().size() == 1 &&
977                             p->nuc().back()->asBraceInset() &&
978                             p->nuc().back()->asBraceInset()->cell(0).empty())
979                                 p->nuc().erase(0);
980
981                         parse(p->cell(p->idxOfScript(up)), FLAG_ITEM, mode);
982                         if (limits) {
983                                 p->limits(limits);
984                                 limits = 0;
985                         }
986                 }
987
988                 else if (t.character() == ']' && (flags & FLAG_BRACK_LAST)) {
989                         //lyxerr << "finished reading option" << endl;
990                         return success_;
991                 }
992
993                 else if (t.cat() == catOther) {
994                         char_type c = t.character();
995                         if (isAsciiOrMathAlpha(c)
996                             || mode_ & Parse::VERBATIM
997                             || !(mode_ & Parse::USETEXT)
998                             || mode == InsetMath::TEXT_MODE) {
999                                 cell->push_back(MathAtom(new InsetMathChar(c)));
1000                         } else {
1001                                 MathAtom at = createInsetMath("text", buf);
1002                                 at.nucleus()->cell(0).push_back(MathAtom(new InsetMathChar(c)));
1003                                 while (nextToken().cat() == catOther
1004                                        && !isAsciiOrMathAlpha(nextToken().character())) {
1005                                         c = getToken().character();
1006                                         at.nucleus()->cell(0).push_back(MathAtom(new InsetMathChar(c)));
1007                                 }
1008                                 cell->push_back(at);
1009                         }
1010                 }
1011
1012                 else if (t.cat() == catComment) {
1013                         docstring s;
1014                         while (good()) {
1015                                 Token const & t = getToken();
1016                                 if (t.cat() == catNewline)
1017                                         break;
1018                                 s += t.asString();
1019                         }
1020                         cell->push_back(MathAtom(new InsetMathComment(buf, s)));
1021                         skipSpaces();
1022                 }
1023
1024                 //
1025                 // control sequences
1026                 //
1027
1028                 else if (t.cs() == "lyxlock") {
1029                         if (cell->size())
1030                                 cell->back().nucleus()->lock(true);
1031                 }
1032
1033                 else if ((t.cs() == "global" && nextToken().cs() == "def") ||
1034                          t.cs() == "def") {
1035                         if (t.cs() == "global")
1036                                 getToken();
1037                         
1038                         // get name
1039                         docstring name = getToken().cs();
1040                         
1041                         // read parameters
1042                         int nargs = 0;
1043                         docstring pars;
1044                         while (good() && nextToken().cat() != catBegin) {
1045                                 pars += getToken().cs();
1046                                 ++nargs;
1047                         }
1048                         nargs /= 2;
1049                         
1050                         // read definition
1051                         MathData def;
1052                         parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1053                         
1054                         // is a version for display attached?
1055                         skipSpaces();
1056                         MathData display;
1057                         if (nextToken().cat() == catBegin)
1058                                 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1059                         
1060                         cell->push_back(MathAtom(new MathMacroTemplate(buf,
1061                                 name, nargs, 0, MacroTypeDef,
1062                                 vector<MathData>(), def, display)));
1063
1064                         if (buf && (mode_ & Parse::TRACKMACRO))
1065                                 buf->usermacros.insert(name);
1066                 }
1067                 
1068                 else if (t.cs() == "newcommand" ||
1069                          t.cs() == "renewcommand" ||
1070                          t.cs() == "newlyxcommand") {
1071                         // get name
1072                         if (getToken().cat() != catBegin) {
1073                                 error("'{' in \\newcommand expected (1) ");
1074                                 return success_;
1075                         }
1076                         docstring name = getToken().cs();
1077                         if (getToken().cat() != catEnd) {
1078                                 error("'}' in \\newcommand expected");
1079                                 return success_;
1080                         }
1081                                 
1082                         // get arity
1083                         docstring const arg = getArg('[', ']');
1084                         int nargs = 0;
1085                         if (!arg.empty())
1086                                 nargs = convert<int>(arg);
1087                                 
1088                         // optional argument given?
1089                         skipSpaces();
1090                         int optionals = 0;
1091                         vector<MathData> optionalValues;
1092                         while (nextToken().character() == '[') {
1093                                 getToken();
1094                                 optionalValues.push_back(MathData());
1095                                 parse(optionalValues[optionals], FLAG_BRACK_LAST, mode);
1096                                 ++optionals;
1097                         }
1098                         
1099                         MathData def;
1100                         parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1101                         
1102                         // is a version for display attached?
1103                         skipSpaces();
1104                         MathData display;
1105                         if (nextToken().cat() == catBegin)
1106                                 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1107                         
1108                         cell->push_back(MathAtom(new MathMacroTemplate(buf,
1109                                 name, nargs, optionals, MacroTypeNewcommand,
1110                                 optionalValues, def, display)));
1111
1112                         if (buf && (mode_ & Parse::TRACKMACRO))
1113                                 buf->usermacros.insert(name);
1114                 }
1115                 
1116                 else if (t.cs() == "newcommandx" ||
1117                          t.cs() == "renewcommandx") {
1118                         // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1119                         // get name
1120                         docstring name;
1121                         if (nextToken().cat() == catBegin) {
1122                                 getToken();
1123                                 name = getToken().cs();
1124                                 if (getToken().cat() != catEnd) {
1125                                         error("'}' in \\newcommandx expected");
1126                                         return success_;
1127                                 }
1128                         } else
1129                                 name = getToken().cs();
1130                                 
1131                         // get arity
1132                         docstring const arg = getArg('[', ']');
1133                         if (arg.empty()) {
1134                                 error("[num] in \\newcommandx expected");
1135                                 return success_;
1136                         }
1137                         int nargs = convert<int>(arg);
1138                         
1139                         // get options
1140                         int optionals = 0;
1141                         vector<MathData> optionalValues;
1142                         if (nextToken().character() == '[') {
1143                                 // skip '['
1144                                 getToken();
1145                                         
1146                                 // handle 'opt=value' options, separated by ','.
1147                                 skipSpaces();
1148                                 while (nextToken().character() != ']' && good()) {
1149                                         if (nextToken().character() >= '1'
1150                                             && nextToken().character() <= '9') {
1151                                                 // optional value -> get parameter number
1152                                                 int n = getChar() - '0';
1153                                                 if (n > nargs) {
1154                                                         error("Arity of \\newcommandx too low "
1155                                                               "for given optional parameter.");
1156                                                         return success_;
1157                                                 }
1158                                                 
1159                                                 // skip '='
1160                                                 if (getToken().character() != '=') {
1161                                                         error("'=' and optional parameter value "
1162                                                               "expected for \\newcommandx");
1163                                                         return success_;
1164                                                 }
1165                                                 
1166                                                 // get value
1167                                                 int optNum = max(size_t(n), optionalValues.size());
1168                                                 optionalValues.resize(optNum);
1169                                                 optionalValues[n - 1].clear();
1170                                                 while (nextToken().character() != ']'
1171                                                        && nextToken().character() != ',') {
1172                                                         MathData data;
1173                                                         parse(data, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1174                                                         optionalValues[n - 1].append(data);
1175                                                 }
1176                                                 optionals = max(n, optionals);
1177                                         } else if (nextToken().cat() == catLetter) {
1178                                                 // we in fact ignore every non-optional
1179                                                 // parameter
1180                                                 
1181                                                 // get option name
1182                                                 docstring opt;
1183                                                 while (nextToken().cat() == catLetter)
1184                                                         opt += getChar();
1185                                         
1186                                                 // value?
1187                                                 skipSpaces();
1188                                                 MathData value;
1189                                                 if (nextToken().character() == '=') {
1190                                                         getToken();
1191                                                         while (nextToken().character() != ']'
1192                                                                 && nextToken().character() != ',')
1193                                                                 parse(value, FLAG_ITEM, 
1194                                                                       InsetMath::UNDECIDED_MODE);
1195                                                 }
1196                                         } else {
1197                                                 error("option for \\newcommandx expected");
1198                                                 return success_;
1199                                         }
1200                                         
1201                                         // skip komma
1202                                         skipSpaces();
1203                                         if (nextToken().character() == ',') {
1204                                                 getChar();
1205                                                 skipSpaces();
1206                                         } else if (nextToken().character() != ']') {
1207                                                 error("Expecting ',' or ']' in options "
1208                                                       "of \\newcommandx");
1209                                                 return success_;
1210                                         }
1211                                 }
1212                                 
1213                                 // skip ']'
1214                                 if (!good())
1215                                         return success_;
1216                                 getToken();
1217                         }
1218
1219                         // get definition
1220                         MathData def;
1221                         parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1222
1223                         // is a version for display attached?
1224                         skipSpaces();
1225                         MathData display;
1226                         if (nextToken().cat() == catBegin)
1227                                 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1228
1229                         cell->push_back(MathAtom(new MathMacroTemplate(buf,
1230                                 name, nargs, optionals, MacroTypeNewcommandx,
1231                                 optionalValues, def, display)));
1232
1233                         if (buf && (mode_ & Parse::TRACKMACRO))
1234                                 buf->usermacros.insert(name);
1235                 }
1236
1237                 else if (t.cs() == "(") {
1238                         cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
1239                         parse(cell->back().nucleus()->cell(0), FLAG_SIMPLE2, InsetMath::MATH_MODE);
1240                 }
1241
1242                 else if (t.cs() == "[") {
1243                         if (mode != InsetMath::UNDECIDED_MODE) {
1244                                 error("bad math environment");
1245                                 break;
1246                         }
1247                         cell->push_back(MathAtom(new InsetMathHull(buf, hullEquation)));
1248                         parse2(cell->back(), FLAG_EQUATION, InsetMath::MATH_MODE, false);
1249                 }
1250
1251                 else if (t.cs() == "protect")
1252                         // ignore \\protect, will hopefully be re-added during output
1253                         ;
1254
1255                 else if (t.cs() == "end") {
1256                         if (flags & FLAG_END) {
1257                                 // eat environment name
1258                                 docstring const name = getArg('{', '}');
1259                                 if (environments_.empty())
1260                                         error("'found \\end{" + name +
1261                                               "}' without matching '\\begin{" +
1262                                               name + "}'");
1263                                 else if (name != environments_.back())
1264                                         error("'\\end{" + name +
1265                                               "}' does not match '\\begin{" +
1266                                               environments_.back() + "}'");
1267                                 else {
1268                                         environments_.pop_back();
1269                                         // Delete empty last row in matrix
1270                                         // like insets.
1271                                         // If you abuse InsetMathGrid for
1272                                         // non-matrix like structures you
1273                                         // probably need to refine this test.
1274                                         // Right now we only have to test for
1275                                         // single line hull insets.
1276                                         if (grid.nrows() > 1 && innerHull(name))
1277                                                 delEmptyLastRow(grid);
1278                                         return success_;
1279                                 }
1280                         } else
1281                                 error("found 'end' unexpectedly");
1282                 }
1283
1284                 else if (t.cs() == ")") {
1285                         if (flags & FLAG_SIMPLE2)
1286                                 return success_;
1287                         error("found '\\)' unexpectedly");
1288                 }
1289
1290                 else if (t.cs() == "]") {
1291                         if (flags & FLAG_EQUATION)
1292                                 return success_;
1293                         error("found '\\]' unexpectedly");
1294                 }
1295
1296                 else if (t.cs() == "\\") {
1297                         if (flags & FLAG_ALIGN)
1298                                 return success_;
1299                         bool added = false;
1300                         if (nextToken().asInput() == "*") {
1301                                 getToken();
1302                                 added = addRow(grid, cellrow, docstring(), false);
1303                         } else if (good())
1304                                 added = addRow(grid, cellrow, getArg('[', ']'));
1305                         else
1306                                 error("missing token after \\\\");
1307                         if (added) {
1308                                 cellcol = 0;
1309                                 if (grid.asHullInset())
1310                                         grid.asHullInset()->numbered(
1311                                                         cellrow, numbered);
1312                                 cell = &grid.cell(grid.index(cellrow,
1313                                                              cellcol));
1314                         }
1315                 }
1316
1317 #if 0
1318                 else if (t.cs() == "multicolumn") {
1319                         // extract column count and insert dummy cells
1320                         MathData count;
1321                         parse(count, FLAG_ITEM, mode);
1322                         int cols = 1;
1323                         if (!extractNumber(count, cols)) {
1324                                 success_ = false;
1325                                 lyxerr << " can't extract number of cells from " << count << endl;
1326                         }
1327                         // resize the table if necessary
1328                         for (int i = 0; i < cols; ++i) {
1329                                 if (addCol(grid, cellcol)) {
1330                                         cell = &grid.cell(grid.index(
1331                                                         cellrow, cellcol));
1332                                         // mark this as dummy
1333                                         grid.cellinfo(grid.index(
1334                                                 cellrow, cellcol)).dummy_ = true;
1335                                 }
1336                         }
1337                         // the last cell is the real thing, not a dummy
1338                         grid.cellinfo(grid.index(cellrow, cellcol)).dummy_ = false;
1339
1340                         // read special alignment
1341                         MathData align;
1342                         parse(align, FLAG_ITEM, mode);
1343                         //grid.cellinfo(grid.index(cellrow, cellcol)).align_ = extractString(align);
1344
1345                         // parse the remaining contents into the "real" cell
1346                         parse(*cell, FLAG_ITEM, mode);
1347                 }
1348 #endif
1349
1350                 else if (t.cs() == "limits" || t.cs() == "nolimits") {
1351                         CatCode const cat = nextToken().cat();
1352                         if (cat == catSuper || cat == catSub)
1353                                 limits = t.cs() == "limits" ? 1 : -1;
1354                         else {
1355                                 MathAtom at = createInsetMath(t.cs(), buf);
1356                                 cell->push_back(at);
1357                         }
1358                 }
1359
1360                 else if (t.cs() == "nonumber") {
1361                         if (grid.asHullInset())
1362                                 grid.asHullInset()->numbered(cellrow, false);
1363                 }
1364
1365                 else if (t.cs() == "number") {
1366                         if (grid.asHullInset())
1367                                 grid.asHullInset()->numbered(cellrow, true);
1368                 }
1369
1370                 else if (t.cs() == "hline") {
1371                         grid.rowinfo(cellrow).lines_ ++;
1372                 }
1373
1374                 else if (t.cs() == "sqrt") {
1375                         MathData ar;
1376                         parse(ar, FLAG_OPTION, mode);
1377                         if (ar.size()) {
1378                                 cell->push_back(MathAtom(new InsetMathRoot(buf)));
1379                                 cell->back().nucleus()->cell(0) = ar;
1380                                 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1381                         } else {
1382                                 cell->push_back(MathAtom(new InsetMathSqrt(buf)));
1383                                 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1384                         }
1385                 }
1386
1387                 else if (t.cs() == "unit") {
1388                         // Allowed formats \unit[val]{unit}
1389                         MathData ar;
1390                         parse(ar, FLAG_OPTION, mode);
1391                         if (ar.size()) {
1392                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT)));
1393                                 cell->back().nucleus()->cell(0) = ar;
1394                                 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1395                         } else {
1396                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT, 1)));
1397                                 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1398                         }
1399                 }
1400
1401                 else if (t.cs() == "unitfrac") {
1402                         // Here allowed formats are \unitfrac[val]{num}{denom}
1403                         MathData ar;
1404                         parse(ar, FLAG_OPTION, mode);
1405                         if (ar.size()) {
1406                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC, 3)));
1407                                 cell->back().nucleus()->cell(2) = ar;
1408                         } else {
1409                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC)));
1410                         }
1411                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1412                         parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1413                 }
1414
1415                 else if (t.cs() == "cfrac") {
1416                         // allowed formats are \cfrac[pos]{num}{denom}
1417                         docstring const arg = getArg('[', ']');
1418                         //lyxerr << "got so far: '" << arg << "'" << endl;                              
1419                                 if (arg == "l")
1420                                         cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACLEFT)));
1421                                 else if (arg == "r")
1422                                         cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACRIGHT)));
1423                                 else if (arg.empty() || arg == "c")
1424                                         cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRAC)));
1425                                 else {
1426                                         error("found invalid optional argument");
1427                                         break;
1428                                 }
1429                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1430                         parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1431                 }
1432
1433                 else if (t.cs() == "xrightarrow" || t.cs() == "xleftarrow") {
1434                         cell->push_back(createInsetMath(t.cs(), buf));
1435                         parse(cell->back().nucleus()->cell(1), FLAG_OPTION, mode);
1436                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1437                 }
1438
1439                 else if (t.cs() == "ref" || t.cs() == "eqref" || t.cs() == "prettyref"
1440                           || t.cs() == "pageref" || t.cs() == "vpageref" || t.cs() == "vref") {
1441                         cell->push_back(MathAtom(new InsetMathRef(buf, t.cs())));
1442                         docstring const opt = parse_verbatim_option();
1443                         docstring const ref = parse_verbatim_item();
1444                         if (!opt.empty()) {
1445                                 cell->back().nucleus()->cell(1).push_back(
1446                                         MathAtom(new InsetMathString(opt)));
1447                         }
1448                         cell->back().nucleus()->cell(0).push_back(
1449                                         MathAtom(new InsetMathString(ref)));
1450                 }
1451
1452                 else if (t.cs() == "left") {
1453                         skipSpaces();
1454                         Token const & tl = getToken();
1455                         // \| and \Vert are equivalent, and InsetMathDelim
1456                         // can't handle \|
1457                         // FIXME: fix this in InsetMathDelim itself!
1458                         docstring const l = tl.cs() == "|" ? from_ascii("Vert") : tl.asString();
1459                         MathData ar;
1460                         parse(ar, FLAG_RIGHT, mode);
1461                         if (!good())
1462                                 break;
1463                         skipSpaces();
1464                         Token const & tr = getToken();
1465                         docstring const r = tr.cs() == "|" ? from_ascii("Vert") : tr.asString();
1466                         cell->push_back(MathAtom(new InsetMathDelim(buf, l, r, ar)));
1467                 }
1468
1469                 else if (t.cs() == "right") {
1470                         if (flags & FLAG_RIGHT)
1471                                 return success_;
1472                         //lyxerr << "got so far: '" << cell << "'" << endl;
1473                         error("Unmatched right delimiter");
1474                         return success_;
1475                 }
1476
1477                 else if (t.cs() == "begin") {
1478                         docstring const name = getArg('{', '}');
1479                         environments_.push_back(name);
1480
1481                         if (name == "array" || name == "subarray") {
1482                                 docstring const valign = parse_verbatim_option() + 'c';
1483                                 docstring const halign = parse_verbatim_item();
1484                                 cell->push_back(MathAtom(new InsetMathArray(buf, name,
1485                                         InsetMathGrid::guessColumns(halign), 1, (char)valign[0], halign)));
1486                                 parse2(cell->back(), FLAG_END, mode, false);
1487                         }
1488
1489                         else if (name == "tabular") {
1490                                 docstring const valign = parse_verbatim_option() + 'c';
1491                                 docstring const halign = parse_verbatim_item();
1492                                 cell->push_back(MathAtom(new InsetMathTabular(buf, name,
1493                                         InsetMathGrid::guessColumns(halign), 1, (char)valign[0], halign)));
1494                                 parse2(cell->back(), FLAG_END, InsetMath::TEXT_MODE, false);
1495                         }
1496
1497                         else if (name == "split" || name == "cases") {
1498                                 cell->push_back(createInsetMath(name, buf));
1499                                 parse2(cell->back(), FLAG_END, mode, false);
1500                         }
1501
1502                         else if (name == "alignedat") {
1503                                 docstring const valign = parse_verbatim_option() + 'c';
1504                                 // ignore this for a while
1505                                 getArg('{', '}');
1506                                 cell->push_back(MathAtom(new InsetMathSplit(buf, name, (char)valign[0])));
1507                                 parse2(cell->back(), FLAG_END, mode, false);
1508                         }
1509
1510                         else if (name == "math") {
1511                                 cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
1512                                 parse(cell->back().nucleus()->cell(0), FLAG_END, InsetMath::MATH_MODE);
1513                         }
1514
1515                         else if (name == "equation" || name == "equation*"
1516                                         || name == "displaymath") {
1517                                 if (mode != InsetMath::UNDECIDED_MODE) {
1518                                         error("bad math environment");
1519                                         break;
1520                                 }
1521                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullEquation)));
1522                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, (name == "equation"));
1523                         }
1524
1525                         else if (name == "eqnarray" || name == "eqnarray*") {
1526                                 if (mode != InsetMath::UNDECIDED_MODE) {
1527                                         error("bad math environment");
1528                                         break;
1529                                 }
1530                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullEqnArray)));
1531                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1532                         }
1533
1534                         else if (name == "align" || name == "align*") {
1535                                 if (mode != InsetMath::UNDECIDED_MODE) {
1536                                         error("bad math environment");
1537                                         break;
1538                                 }
1539                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullAlign)));
1540                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1541                         }
1542
1543                         else if (name == "flalign" || name == "flalign*") {
1544                                 if (mode != InsetMath::UNDECIDED_MODE) {
1545                                         error("bad math environment");
1546                                         break;
1547                                 }
1548                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullFlAlign)));
1549                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1550                         }
1551
1552                         else if (name == "alignat" || name == "alignat*") {
1553                                 if (mode != InsetMath::UNDECIDED_MODE) {
1554                                         error("bad math environment");
1555                                         break;
1556                                 }
1557                                 // ignore this for a while
1558                                 getArg('{', '}');
1559                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullAlignAt)));
1560                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1561                         }
1562
1563                         else if (name == "xalignat" || name == "xalignat*") {
1564                                 if (mode != InsetMath::UNDECIDED_MODE) {
1565                                         error("bad math environment");
1566                                         break;
1567                                 }
1568                                 // ignore this for a while
1569                                 getArg('{', '}');
1570                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullXAlignAt)));
1571                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1572                         }
1573
1574                         else if (name == "xxalignat") {
1575                                 if (mode != InsetMath::UNDECIDED_MODE) {
1576                                         error("bad math environment");
1577                                         break;
1578                                 }
1579                                 // ignore this for a while
1580                                 getArg('{', '}');
1581                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullXXAlignAt)));
1582                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1583                         }
1584
1585                         else if (name == "multline" || name == "multline*") {
1586                                 if (mode != InsetMath::UNDECIDED_MODE) {
1587                                         error("bad math environment");
1588                                         break;
1589                                 }
1590                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullMultline)));
1591                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1592                         }
1593
1594                         else if (name == "gather" || name == "gather*") {
1595                                 if (mode != InsetMath::UNDECIDED_MODE) {
1596                                         error("bad math environment");
1597                                         break;
1598                                 }
1599                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullGather)));
1600                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1601                         }
1602
1603                         else if (latexkeys const * l = in_word_set(name)) {
1604                                 if (l->inset == "matrix") {
1605                                         cell->push_back(createInsetMath(name, buf));
1606                                         parse2(cell->back(), FLAG_END, mode, false);
1607                                 } else if (l->inset == "split") {
1608                                         docstring const valign = parse_verbatim_option() + 'c';
1609                                         cell->push_back(MathAtom(
1610                                                 new InsetMathSplit(buf, name, (char)valign[0])));
1611                                         parse2(cell->back(), FLAG_END, mode, false);
1612                                 } else {
1613                                         success_ = false;
1614                                         if (!(mode_ & Parse::QUIET)) {
1615                                                 dump();
1616                                                 lyxerr << "found math environment `"
1617                                                        << to_utf8(name)
1618                                                        << "' in symbols file with unsupported inset `"
1619                                                        << to_utf8(l->inset)
1620                                                        << "'." << endl;
1621                                         }
1622                                         // create generic environment inset
1623                                         cell->push_back(MathAtom(new InsetMathEnv(buf, name)));
1624                                         parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1625                                 }
1626                         }
1627
1628                         else {
1629                                 success_ = false;
1630                                 if (!(mode_ & Parse::QUIET)) {
1631                                         dump();
1632                                         lyxerr << "found unknown math environment '"
1633                                                << to_utf8(name) << "'" << endl;
1634                                 }
1635                                 // create generic environment inset
1636                                 cell->push_back(MathAtom(new InsetMathEnv(buf, name)));
1637                                 parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1638                         }
1639                 }
1640
1641                 else if (t.cs() == "kern") {
1642                         // FIXME: A hack...
1643                         docstring s;
1644                         int num_tokens = 0;
1645                         while (true) {
1646                                 Token const & t = getToken();
1647                                 ++num_tokens;
1648                                 if (!good()) {
1649                                         s.clear();
1650                                         while (num_tokens--)
1651                                                 putback();
1652                                         break;
1653                                 }
1654                                 s += t.character();
1655                                 if (isValidLength(to_utf8(s)))
1656                                         break;
1657                         }
1658                         if (s.empty())
1659                                 cell->push_back(MathAtom(new InsetMathKern));
1660                         else
1661                                 cell->push_back(MathAtom(new InsetMathKern(s)));
1662                 }
1663
1664                 else if (t.cs() == "label") {
1665                         // FIXME: This is swallowed in inline formulas
1666                         docstring label = parse_verbatim_item();
1667                         MathData ar;
1668                         asArray(label, ar);
1669                         if (grid.asHullInset()) {
1670                                 grid.asHullInset()->label(cellrow, label);
1671                         } else {
1672                                 cell->push_back(createInsetMath(t.cs(), buf));
1673                                 cell->push_back(MathAtom(new InsetMathBrace(ar)));
1674                         }
1675                 }
1676
1677                 else if (t.cs() == "choose" || t.cs() == "over"
1678                                 || t.cs() == "atop" || t.cs() == "brace"
1679                                 || t.cs() == "brack") {
1680                         MathAtom at = createInsetMath(t.cs(), buf);
1681                         at.nucleus()->cell(0) = *cell;
1682                         cell->clear();
1683                         parse(at.nucleus()->cell(1), flags, mode);
1684                         cell->push_back(at);
1685                         return success_;
1686                 }
1687
1688                 else if (t.cs() == "color") {
1689                         docstring const color = parse_verbatim_item();
1690                         cell->push_back(MathAtom(new InsetMathColor(buf, true, color)));
1691                         parse(cell->back().nucleus()->cell(0), flags, mode);
1692                         return success_;
1693                 }
1694
1695                 else if (t.cs() == "textcolor") {
1696                         docstring const color = parse_verbatim_item();
1697                         cell->push_back(MathAtom(new InsetMathColor(buf, false, color)));
1698                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1699                 }
1700
1701                 else if (t.cs() == "normalcolor") {
1702                         cell->push_back(createInsetMath(t.cs(), buf));
1703                         parse(cell->back().nucleus()->cell(0), flags, mode);
1704                         return success_;
1705                 }
1706
1707                 else if (t.cs() == "substack") {
1708                         cell->push_back(createInsetMath(t.cs(), buf));
1709                         parse2(cell->back(), FLAG_ITEM, mode, false);
1710                         // Delete empty last row if present
1711                         InsetMathGrid & subgrid =
1712                                 *(cell->back().nucleus()->asGridInset());
1713                         if (subgrid.nrows() > 1)
1714                                 delEmptyLastRow(subgrid);
1715                 }
1716
1717                 else if (t.cs() == "xymatrix") {
1718                         odocstringstream os;
1719                         while (good() && nextToken().cat() != catBegin)
1720                                 os << getToken().asInput();
1721                         cell->push_back(createInsetMath(t.cs() + os.str(), buf));
1722                         parse2(cell->back(), FLAG_ITEM, mode, false);
1723                         // Delete empty last row if present
1724                         InsetMathGrid & subgrid =
1725                                 *(cell->back().nucleus()->asGridInset());
1726                         if (subgrid.nrows() > 1)
1727                                 delEmptyLastRow(subgrid);
1728                 }
1729
1730                 else if (t.cs() == "Diagram") {
1731                         odocstringstream os;
1732                         while (good() && nextToken().cat() != catBegin)
1733                                 os << getToken().asInput();
1734                         cell->push_back(createInsetMath(t.cs() + os.str(), buf));
1735                         parse2(cell->back(), FLAG_ITEM, mode, false);
1736                 }
1737
1738                 else if (t.cs() == "framebox" || t.cs() == "makebox") {
1739                         cell->push_back(createInsetMath(t.cs(), buf));
1740                         parse(cell->back().nucleus()->cell(0), FLAG_OPTION, InsetMath::TEXT_MODE);
1741                         parse(cell->back().nucleus()->cell(1), FLAG_OPTION, InsetMath::TEXT_MODE);
1742                         parse(cell->back().nucleus()->cell(2), FLAG_ITEM, InsetMath::TEXT_MODE);
1743                 }
1744
1745                 else if (t.cs() == "tag") {
1746                         if (nextToken().character() == '*') {
1747                                 getToken();
1748                                 cell->push_back(createInsetMath(t.cs() + '*', buf));
1749                         } else
1750                                 cell->push_back(createInsetMath(t.cs(), buf));
1751                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1752                 }
1753
1754                 else if (t.cs() == "hspace" && nextToken().character() != '*') {
1755                         docstring const name = t.cs();
1756                         docstring const arg = parse_verbatim_item();
1757                         Length length;
1758                         if (isValidLength(to_utf8(arg), &length))
1759                                 cell->push_back(MathAtom(new InsetMathSpace(length)));
1760                         else {
1761                                 // Since the Length class cannot use length variables
1762                                 // we must not create an InsetMathSpace.
1763                                 cell->push_back(MathAtom(new MathMacro(buf, name)));
1764                                 MathData ar;
1765                                 mathed_parse_cell(ar, '{' + arg + '}', mode_);
1766                                 cell->append(ar);
1767                         }
1768                 }
1769
1770 #if 0
1771                 else if (t.cs() == "infer") {
1772                         MathData ar;
1773                         parse(ar, FLAG_OPTION, mode);
1774                         cell->push_back(createInsetMath(t.cs(), buf));
1775                         parse2(cell->back(), FLAG_ITEM, mode, false);
1776                 }
1777
1778                 // Disabled
1779                 else if (1 && t.cs() == "ar") {
1780                         auto_ptr<InsetMathXYArrow> p(new InsetMathXYArrow);
1781                         // try to read target
1782                         parse(p->cell(0), FLAG_OTPTION, mode);
1783                         // try to read label
1784                         if (nextToken().cat() == catSuper || nextToken().cat() == catSub) {
1785                                 p->up_ = nextToken().cat() == catSuper;
1786                                 getToken();
1787                                 parse(p->cell(1), FLAG_ITEM, mode);
1788                                 //lyxerr << "read label: " << p->cell(1) << endl;
1789                         }
1790
1791                         cell->push_back(MathAtom(p.release()));
1792                         //lyxerr << "read cell: " << cell << endl;
1793                 }
1794 #endif
1795
1796                 else if (t.cs() == "lyxmathsym") {
1797                         skipSpaces();
1798                         if (getToken().cat() != catBegin) {
1799                                 error("'{' expected in \\" + t.cs());
1800                                 return success_;
1801                         }
1802                         int count = 0;
1803                         docstring cmd;
1804                         CatCode cat = nextToken().cat();
1805                         while (good() && (count || cat != catEnd)) {
1806                                 if (cat == catBegin)
1807                                         ++count;
1808                                 else if (cat == catEnd)
1809                                         --count;
1810                                 cmd += getToken().asInput();
1811                                 cat = nextToken().cat();
1812                         }
1813                         if (getToken().cat() != catEnd) {
1814                                 error("'}' expected in \\" + t.cs());
1815                                 return success_;
1816                         }
1817                         docstring rem;
1818                         do {
1819                                 cmd = Encodings::fromLaTeXCommand(cmd, rem);
1820                                 for (size_t i = 0; i < cmd.size(); ++i)
1821                                         cell->push_back(MathAtom(new InsetMathChar(cmd[i])));
1822                                 if (rem.size()) {
1823                                         char_type c = rem[0];
1824                                         cell->push_back(MathAtom(new InsetMathChar(c)));
1825                                         cmd = rem.substr(1);
1826                                         rem.clear();
1827                                 } else
1828                                         cmd.clear();
1829                         } while (cmd.size());
1830                 }
1831
1832                 else if (t.cs().size()) {
1833                         bool const no_mhchem =
1834                                 (t.cs() == "ce" || t.cs() == "cf")
1835                                 && buf && buf->params().use_mhchem ==
1836                                                 BufferParams::package_off;
1837
1838                         bool const is_user_macro = no_mhchem ||
1839                                 (buf && (mode_ & Parse::TRACKMACRO
1840                                          ? buf->usermacros.count(t.cs()) != 0
1841                                          : buf->getMacro(t.cs(), false) != 0));
1842
1843                         latexkeys const * l = in_word_set(t.cs());
1844                         if (l && !is_user_macro) {
1845                                 if (l->inset == "big") {
1846                                         skipSpaces();
1847                                         docstring const delim = getToken().asInput();
1848                                         if (InsetMathBig::isBigInsetDelim(delim))
1849                                                 cell->push_back(MathAtom(
1850                                                         new InsetMathBig(t.cs(), delim)));
1851                                         else {
1852                                                 cell->push_back(createInsetMath(t.cs(), buf));
1853                                                 putback();
1854                                         }
1855                                 }
1856
1857                                 else if (l->inset == "font") {
1858                                         cell->push_back(createInsetMath(t.cs(), buf));
1859                                         parse(cell->back().nucleus()->cell(0),
1860                                                 FLAG_ITEM, asMode(mode, l->extra));
1861                                 }
1862
1863                                 else if (l->inset == "oldfont") {
1864                                         cell->push_back(createInsetMath(t.cs(), buf));
1865                                         parse(cell->back().nucleus()->cell(0),
1866                                                 flags | FLAG_ALIGN, asMode(mode, l->extra));
1867                                         if (prevToken().cat() != catAlign &&
1868                                             prevToken().cs() != "\\")
1869                                                 return success_;
1870                                         putback();
1871                                 }
1872
1873                                 else if (l->inset == "style") {
1874                                         cell->push_back(createInsetMath(t.cs(), buf));
1875                                         parse(cell->back().nucleus()->cell(0),
1876                                                 flags | FLAG_ALIGN, mode);
1877                                         if (prevToken().cat() != catAlign &&
1878                                             prevToken().cs() != "\\")
1879                                                 return success_;
1880                                         putback();
1881                                 }
1882
1883                                 else {
1884                                         MathAtom at = createInsetMath(t.cs(), buf);
1885                                         for (InsetMath::idx_type i = 0; i < at->nargs(); ++i)
1886                                                 parse(at.nucleus()->cell(i),
1887                                                         FLAG_ITEM, asMode(mode, l->extra));
1888                                         cell->push_back(at);
1889                                 }
1890                         }
1891
1892                         else {
1893                                 bool is_unicode_symbol = false;
1894                                 if (mode == InsetMath::TEXT_MODE && !is_user_macro) {
1895                                         int num_tokens = 0;
1896                                         docstring cmd = prevToken().asInput();
1897                                         CatCode cat = nextToken().cat();
1898                                         if (cat == catBegin) {
1899                                                 int count = 0;
1900                                                 while (good() && (count || cat != catEnd)) {
1901                                                         cat = nextToken().cat();
1902                                                         cmd += getToken().asInput();
1903                                                         ++num_tokens;
1904                                                         if (cat == catBegin)
1905                                                                 ++count;
1906                                                         else if (cat == catEnd)
1907                                                                 --count;
1908                                                 }
1909                                         }
1910                                         bool is_combining;
1911                                         char_type c =
1912                                                 Encodings::fromLaTeXCommand(cmd, is_combining);
1913                                         if (is_combining) {
1914                                                 if (cat == catLetter)
1915                                                         cmd += '{';
1916                                                 cmd += getToken().asInput();
1917                                                 ++num_tokens;
1918                                                 if (cat == catLetter)
1919                                                         cmd += '}';
1920                                                 c = Encodings::fromLaTeXCommand(cmd, is_combining);
1921                                         }
1922                                         if (c) {
1923                                                 is_unicode_symbol = true;
1924                                                 cell->push_back(MathAtom(new InsetMathChar(c)));
1925                                         } else {
1926                                                 while (num_tokens--)
1927                                                         putback();
1928                                         }
1929                                 }
1930                                 if (!is_unicode_symbol) {
1931                                         MathAtom at = is_user_macro ?
1932                                                 MathAtom(new MathMacro(buf, t.cs()))
1933                                                 : createInsetMath(t.cs(), buf);
1934                                         InsetMath::mode_type m = mode;
1935                                         //if (m == InsetMath::UNDECIDED_MODE)
1936                                         //lyxerr << "default creation: m1: " << m << endl;
1937                                         if (at->currentMode() != InsetMath::UNDECIDED_MODE)
1938                                                 m = at->currentMode();
1939                                         //lyxerr << "default creation: m2: " << m << endl;
1940                                         InsetMath::idx_type start = 0;
1941                                         // this fails on \bigg[...\bigg]
1942                                         //MathData opt;
1943                                         //parse(opt, FLAG_OPTION, InsetMath::VERBATIM_MODE);
1944                                         //if (opt.size()) {
1945                                         //      start = 1;
1946                                         //      at.nucleus()->cell(0) = opt;
1947                                         //}
1948                                         for (InsetMath::idx_type i = start; i < at->nargs(); ++i) {
1949                                                 parse(at.nucleus()->cell(i), FLAG_ITEM, m);
1950                                                 skipSpaces();
1951                                         }
1952                                         cell->push_back(at);
1953                                 }
1954                         }
1955                 }
1956
1957
1958                 if (flags & FLAG_LEAVE) {
1959                         flags &= ~FLAG_LEAVE;
1960                         break;
1961                 }
1962         }
1963         return success_;
1964 }
1965
1966
1967
1968 } // anonymous namespace
1969
1970
1971 bool mathed_parse_cell(MathData & ar, docstring const & str, Parse::flags f)
1972 {
1973         return Parser(str, f, ar.buffer()).parse(ar, 0, f & Parse::TEXTMODE ?
1974                                 InsetMath::TEXT_MODE : InsetMath::MATH_MODE);
1975 }
1976
1977
1978 bool mathed_parse_cell(MathData & ar, istream & is, Parse::flags f)
1979 {
1980         return Parser(is, f, ar.buffer()).parse(ar, 0, f & Parse::TEXTMODE ?
1981                                 InsetMath::TEXT_MODE : InsetMath::MATH_MODE);
1982 }
1983
1984
1985 bool mathed_parse_normal(Buffer * buf, MathAtom & t, docstring const & str,
1986                          Parse::flags f)
1987 {
1988         return Parser(str, f, buf).parse(t);
1989 }
1990
1991
1992 bool mathed_parse_normal(Buffer * buf, MathAtom & t, Lexer & lex,
1993                          Parse::flags f)
1994 {
1995         return Parser(lex, f, buf).parse(t);
1996 }
1997
1998
1999 bool mathed_parse_normal(InsetMathGrid & grid, docstring const & str,
2000                          Parse::flags f)
2001 {
2002         return Parser(str, f, &grid.buffer()).parse1(grid, 0, f & Parse::TEXTMODE ?
2003                         InsetMath::TEXT_MODE : InsetMath::MATH_MODE, false);
2004 }
2005
2006
2007 void initParser()
2008 {
2009         fill(theCatcode, theCatcode + 128, catOther);
2010         fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
2011         fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
2012
2013         theCatcode[int('\\')] = catEscape;
2014         theCatcode[int('{')]  = catBegin;
2015         theCatcode[int('}')]  = catEnd;
2016         theCatcode[int('$')]  = catMath;
2017         theCatcode[int('&')]  = catAlign;
2018         theCatcode[int('\n')] = catNewline;
2019         theCatcode[int('#')]  = catParameter;
2020         theCatcode[int('^')]  = catSuper;
2021         theCatcode[int('_')]  = catSub;
2022         theCatcode[int(0x7f)] = catIgnore;
2023         theCatcode[int(' ')]  = catSpace;
2024         theCatcode[int('\t')] = catSpace;
2025         theCatcode[int('\r')] = catNewline;
2026         theCatcode[int('~')]  = catActive;
2027         theCatcode[int('%')]  = catComment;
2028 }
2029
2030
2031 } // namespace lyx