]> git.lyx.org Git - features.git/blob - src/mathed/math_parser.C
binom is binom is binom and choose is choose is choose ...
[features.git] / src / mathed / math_parser.C
1 /** The math parser
2     \author André Pönitz (2001)
3  */
4
5 /*
6
7 If someone desperately needs partial "structures" (such as a few
8 cells of an array inset or similar) (s)he could uses the
9 following hack as starting point to write some macros:
10
11   \newif\ifcomment
12   \commentfalse
13   \ifcomment
14           \def\makeamptab{\catcode`\&=4\relax}
15           \def\makeampletter{\catcode`\&=11\relax}
16     \def\b{\makeampletter\expandafter\makeamptab\bi}
17     \long\def\bi#1\e{}
18   \else
19     \def\b{}\def\e{}
20   \fi
21
22   ...
23
24   \[\begin{array}{ccc}
25    1 & 2\b & 3^2\\
26    4 & 5\e & 6\\
27    7 & 8 & 9
28   \end{array}\]
29
30 */
31
32
33 #include <config.h>
34
35 #ifdef __GNUG__
36 #pragma implementation
37 #endif
38
39 #include "math_parser.h"
40 #include "math_inset.h"
41 #include "math_arrayinset.h"
42 #include "math_braceinset.h"
43 #include "math_boxinset.h"
44 #include "math_charinset.h"
45 #include "math_deliminset.h"
46 #include "math_extern.h"
47 #include "math_factory.h"
48 #include "math_kerninset.h"
49 #include "math_macro.h"
50 #include "math_macrotable.h"
51 #include "math_macrotemplate.h"
52 #include "math_hullinset.h"
53 #include "math_rootinset.h"
54 #include "math_sizeinset.h"
55 #include "math_sqrtinset.h"
56 #include "math_scriptinset.h"
57 #include "math_sqrtinset.h"
58 #include "math_support.h"
59 #include "math_xyarrowinset.h"
60
61 #include "ref_inset.h"
62
63 #include "lyxlex.h"
64 #include "debug.h"
65 #include "support/LAssert.h"
66 #include "support/lstrings.h"
67
68 #include <cctype>
69 #include <stack>
70 #include <algorithm>
71
72 using std::istream;
73 using std::ostream;
74 using std::ios;
75 using std::endl;
76 using std::stack;
77 using std::fill;
78 using std::vector;
79 using std::atoi;
80
81
82 //#define FILEDEBUG
83
84
85 namespace {
86
87 bool stared(string const & s)
88 {
89         string::size_type const n = s.size();
90         return n && s[n - 1] == '*';
91 }
92
93
94 // These are TeX's catcodes
95 enum CatCode {
96         catEscape,     // 0    backslash
97         catBegin,      // 1    {
98         catEnd,        // 2    }
99         catMath,       // 3    $
100         catAlign,      // 4    &
101         catNewline,    // 5    ^^M
102         catParameter,  // 6    #
103         catSuper,      // 7    ^
104         catSub,        // 8    _
105         catIgnore,     // 9
106         catSpace,      // 10   space
107         catLetter,     // 11   a-zA-Z
108         catOther,      // 12   none of the above
109         catActive,     // 13   ~
110         catComment,    // 14   %
111         catInvalid     // 15   <delete>
112 };
113
114 CatCode theCatcode[256];
115
116
117 inline CatCode catcode(unsigned char c)
118 {
119         return theCatcode[c];
120 }
121
122
123 enum {
124         FLAG_BRACE_LAST = 1 << 1,  //  last closing brace ends the parsing
125         FLAG_RIGHT      = 1 << 2,  //  next \\right ends the parsing process
126         FLAG_END        = 1 << 3,  //  next \\end ends the parsing process
127         FLAG_BRACK_END  = 1 << 4,  //  next closing bracket ends the parsing
128         FLAG_TEXTMODE   = 1 << 5,  //  we are in a box
129         FLAG_ITEM       = 1 << 6,  //  read a (possibly braced token)
130         FLAG_LEAVE      = 1 << 7,  //  leave the loop at the end
131         FLAG_SIMPLE     = 1 << 8,  //  next $ leaves the loop
132         FLAG_EQUATION   = 1 << 9,  //  next \] leaves the loop
133         FLAG_SIMPLE2    = 1 << 10  //  next \) leaves the loop
134 };
135
136
137 void catInit()
138 {
139         fill(theCatcode, theCatcode + 256, catOther);
140         fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
141         fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
142
143         theCatcode['\\'] = catEscape;
144         theCatcode['{']  = catBegin;
145         theCatcode['}']  = catEnd;
146         theCatcode['$']  = catMath;
147         theCatcode['&']  = catAlign;
148         theCatcode['\n'] = catNewline;
149         theCatcode['#']  = catParameter;
150         theCatcode['^']  = catSuper;
151         theCatcode['_']  = catSub;
152         theCatcode['\7f'] = catIgnore;
153         theCatcode[' ']  = catSpace;
154         theCatcode['\t'] = catSpace;
155         theCatcode['\r'] = catSpace;
156         theCatcode['~']  = catActive;
157         theCatcode['%']  = catComment;
158 }
159
160
161
162 //
163 // Helper class for parsing
164 //
165
166 class Token {
167 public:
168         ///
169         Token() : cs_(), char_(0), cat_(catIgnore) {}
170         ///
171         Token(char c, CatCode cat) : cs_(), char_(c), cat_(cat) {}
172         ///
173         Token(string const & cs) : cs_(cs), char_(0), cat_(catIgnore) {}
174
175         ///
176         string const & cs() const { return cs_; }
177         ///
178         CatCode cat() const { return cat_; }
179         ///
180         char character() const { return char_; }
181         ///
182         string asString() const;
183         ///
184         bool isCR() const;
185
186 private:
187         ///
188         string cs_;
189         ///
190         char char_;
191         ///
192         CatCode cat_;
193 };
194
195 bool Token::isCR() const
196 {
197         return cs_ == "\\" || cs_ == "cr" || cs_ == "crcr";
198 }
199
200 string Token::asString() const
201 {
202         return cs_.size() ? cs_ : string(1, char_);
203 }
204
205 ostream & operator<<(ostream & os, Token const & t)
206 {
207         if (t.cs().size())
208                 os << "\\" << t.cs();
209         else
210                 os << "[" << t.character() << "," << t.cat() << "]";
211         return os;
212 }
213
214
215 class Parser {
216
217 public:
218         ///
219         Parser(LyXLex & lex);
220         ///
221         Parser(istream & is);
222
223         ///
224         bool parse_macro(string & name);
225         ///
226         bool parse_normal(MathAtom & at);
227         ///
228         void parse_into(MathArray & array, unsigned flags, bool mathmode);
229         ///
230         int lineno() const { return lineno_; }
231         ///
232         void putback();
233
234 private:
235         ///
236         void parse_into1(MathGridInset & grid, unsigned flags, bool mathmode, bool numbered);
237         ///
238         void parse_into2(MathAtom & at, unsigned flags, bool mathmode, bool numbered);
239         /// get arg delimited by 'left' and 'right'
240         string getArg(char left, char right);
241         ///
242         char getChar();
243         ///
244         void error(string const & msg);
245         /// dump contents to screen
246         void dump() const;
247
248 private:
249         ///
250         void tokenize(istream & is);
251         ///
252         void tokenize(string const & s);
253         ///
254         void skipSpaceTokens(istream & is, char c);
255         ///
256         void push_back(Token const & t);
257         ///
258         void pop_back();
259         ///
260         Token const & prevToken() const;
261         ///
262         Token const & nextToken() const;
263         ///
264         Token const & getToken();
265         /// skips spaces if any
266         void skipSpaces();
267         ///
268         void lex(string const & s);
269         ///
270         bool good() const;
271
272         ///
273         int lineno_;
274         ///
275         vector<Token> tokens_;
276         ///
277         unsigned pos_;
278 };
279
280
281 Parser::Parser(LyXLex & lexer)
282         : lineno_(lexer.getLineNo()), pos_(0)
283 {
284         tokenize(lexer.getStream());
285         lexer.eatLine();
286 }
287
288
289 Parser::Parser(istream & is)
290         : lineno_(0), pos_(0)
291 {
292         tokenize(is);
293 }
294
295
296 void Parser::push_back(Token const & t)
297 {
298         tokens_.push_back(t);
299 }
300
301
302 void Parser::pop_back()
303 {
304         tokens_.pop_back();
305 }
306
307
308 Token const & Parser::prevToken() const
309 {
310         static const Token dummy;
311         return pos_ > 0 ? tokens_[pos_ - 1] : dummy;
312 }
313
314
315 Token const & Parser::nextToken() const
316 {
317         static const Token dummy;
318         return good() ? tokens_[pos_] : dummy;
319 }
320
321
322 Token const & Parser::getToken()
323 {
324         static const Token dummy;
325         //lyxerr << "looking at token " << tokens_[pos_] << " pos: " << pos_ << '\n';
326         return good() ? tokens_[pos_++] : dummy;
327 }
328
329
330 void Parser::skipSpaces()
331 {
332         while (nextToken().cat() == catSpace)
333                 getToken();
334 }
335
336
337 void Parser::putback()
338 {
339         --pos_;
340 }
341
342
343 bool Parser::good() const
344 {
345         return pos_ < tokens_.size();
346 }
347
348
349 char Parser::getChar()
350 {
351         if (!good())
352                 error("The input stream is not well...");
353         return tokens_[pos_++].character();
354 }
355
356
357 string Parser::getArg(char left, char right)
358 {
359         skipSpaces();
360
361         string result;
362         char c = getChar();
363
364         if (c != left)
365                 putback();
366         else
367                 while ((c = getChar()) != right && good())
368                         result += c;
369
370         return result;
371 }
372
373
374 void Parser::tokenize(istream & is)
375 {
376         // eat everything up to the next \end_inset or end of stream
377         // and store it in s for further tokenization
378         string s;
379         char c;
380         while (is.get(c)) {
381                 s += c;
382                 if (s.size() >= 10 && s.substr(s.size() - 10) == "\\end_inset") {
383                         s = s.substr(0, s.size() - 10);
384                         break;
385                 }
386         }
387
388         // tokenize buffer
389         tokenize(s);
390 }
391
392
393 void Parser::skipSpaceTokens(istream & is, char c)
394 {
395         // skip trailing spaces
396         while (catcode(c) == catSpace || catcode(c) == catNewline)
397                 if (!is.get(c))
398                         break;
399         //lyxerr << "putting back: " << c << "\n";
400         is.putback(c);
401 }
402
403
404 void Parser::tokenize(string const & buffer)
405 {
406         static bool init_done = false;
407
408         if (!init_done) {
409                 catInit();
410                 init_done = true;
411         }
412
413         istringstream is(buffer.c_str(), ios::in | ios::binary);
414
415         char c;
416         while (is.get(c)) {
417                 //lyxerr << "reading c: " << c << "\n";
418
419                 switch (catcode(c)) {
420                         case catNewline: {
421                                 ++lineno_;
422                                 is.get(c);
423                                 if (catcode(c) == catNewline)
424                                         ; //push_back(Token("par"));
425                                 else {
426                                         push_back(Token(' ', catSpace));
427                                         is.putback(c);
428                                 }
429                                 break;
430                         }
431
432                         case catComment: {
433                                 while (is.get(c) && catcode(c) != catNewline)
434                                         ;
435                                 ++lineno_;
436                                 break;
437                         }
438
439                         case catEscape: {
440                                 is.get(c);
441                                 if (!is) {
442                                         error("unexpected end of input");
443                                 } else {
444                                         string s(1, c);
445                                         if (catcode(c) == catLetter) {
446                                                 // collect letters
447                                                 while (is.get(c) && catcode(c) == catLetter)
448                                                         s += c;
449                                                 skipSpaceTokens(is, c);
450                                         }
451                                         push_back(Token(s));
452                                 }
453                                 break;
454                         }
455
456                         case catSuper:
457                         case catSub: {
458                                 push_back(Token(c, catcode(c)));
459                                 is.get(c);
460                                 skipSpaceTokens(is, c);
461                                 break;
462                         }
463
464                         case catIgnore: {
465                                 lyxerr << "ignoring a char: " << int(c) << "\n";
466                                 break;
467                         }
468
469                         default:
470                                 push_back(Token(c, catcode(c)));
471                 }
472         }
473
474 #ifdef FILEDEBUG
475         dump();
476 #endif
477 }
478
479
480 void Parser::dump() const
481 {
482         lyxerr << "\nTokens: ";
483         for (unsigned i = 0; i < tokens_.size(); ++i) {
484                 if (i == pos_)
485                         lyxerr << " <#> ";
486                 lyxerr << tokens_[i];
487         }
488         lyxerr << " pos: " << pos_ << "\n";
489 }
490
491
492 void Parser::error(string const & msg)
493 {
494         lyxerr << "Line ~" << lineno_ << ": Math parse error: " << msg << endl;
495         dump();
496         //exit(1);
497 }
498
499
500 bool Parser::parse_macro(string & name)
501 {
502         int nargs = 0;
503         name = "{error}";
504         skipSpaces();
505
506         if (nextToken().cs() == "def") {
507
508                 getToken();
509                 name = getToken().cs();
510
511                 string pars;
512                 while (good() && nextToken().cat() != catBegin)
513                         pars += getToken().cs();
514
515                 if (!good()) {
516                         error("bad stream in parse_macro\n");
517                         return false;
518                 }
519
520                 //lyxerr << "read \\def parameter list '" << pars << "'\n";
521                 if (!pars.empty()) {
522                         error("can't handle non-empty parameter lists\n");
523                         return false;
524                 }
525
526         } else if (nextToken().cs() == "newcommand") {
527
528                 getToken();
529
530                 if (getToken().cat() != catBegin) {
531                         error("'{' in \\newcommand expected (1) \n");
532                         return false;
533                 }
534
535                 name = getToken().cs();
536
537                 if (getToken().cat() != catEnd) {
538                         error("'}' expected\n");
539                         return false;
540                 }
541
542                 string arg  = getArg('[', ']');
543                 if (!arg.empty())
544                         nargs = atoi(arg.c_str());
545
546         } else {
547                 lyxerr << "\\newcommand or \\def  expected\n";
548                 return false;
549         }
550
551
552         if (getToken().cat() != catBegin) {
553                 error("'{' in macro definition expected (2)\n");
554                 return false;
555         }
556
557         MathArray ar1;
558         parse_into(ar1, FLAG_BRACE_LAST, true);
559
560         // we cannot handle recursive stuff at all
561         MathArray test;
562         test.push_back(createMathInset(name));
563         if (ar1.contains(test)) {
564                 error("we cannot handle recursive macros at all.\n");
565                 return false;
566         }
567
568         // is a version for display attached?
569         MathArray ar2;
570         parse_into(ar2, FLAG_ITEM, true);
571
572         MathMacroTable::create(name, nargs, ar1, ar2);
573         return true;
574 }
575
576
577 bool Parser::parse_normal(MathAtom & at)
578 {
579         skipSpaces();
580         MathArray ar;
581         parse_into(ar, false, false);
582         if (ar.size() != 1) {
583                 lyxerr << "Unusual contents found: " << ar << endl;
584                 at.reset(new MathParInset);
585                 if (at->nargs() > 0)
586                         at->cell(0) = ar;
587                 else
588                         lyxerr << "Unusual contents found: " << ar << endl;
589                 return true;
590         }
591         at = ar[0];
592         return true;
593 }
594
595
596 void Parser::parse_into(MathArray & array, unsigned flags, bool mathmode)
597 {
598         MathGridInset grid(1, 1);
599         parse_into1(grid, flags, mathmode, false);
600         array = grid.cell(0);
601 }
602
603
604 void Parser::parse_into2(MathAtom & at, unsigned flags,
605         bool mathmode, bool numbered)
606 {
607         parse_into1(*(at->asGridInset()), flags, mathmode, numbered);
608 }
609
610
611 void Parser::parse_into1(MathGridInset & grid, unsigned flags,
612         bool mathmode, bool numbered)
613 {
614         int  limits = 0;
615         MathGridInset::row_type cellrow = 0;
616         MathGridInset::col_type cellcol = 0;
617         MathArray * cell = &grid.cell(grid.index(cellrow, cellcol));
618
619         if (grid.asHullInset())
620                 grid.asHullInset()->numbered(cellrow, numbered);
621
622         //dump();
623         //lyxerr << "grid: " << grid << endl;
624
625         while (good()) {
626                 Token const & t = getToken();
627
628 #ifdef FILEDEBUG
629                 lyxerr << "t: " << t << " flags: " << flags << "\n";
630                 //cell->dump();
631                 lyxerr << "\n";
632 #endif
633
634                 if (flags & FLAG_ITEM) {
635                         if (t.cat() == catSpace)
636                                 continue;
637
638                         flags &= ~FLAG_ITEM;
639                         if (t.cat() == catBegin) {
640                                 // skip the brace and collect everything to the next matching
641                                 // closing brace
642                                 flags |= FLAG_BRACE_LAST;
643                                 continue;
644                         }
645
646                         // handle only this single token, leave the loop if done
647                         flags |= FLAG_LEAVE;
648                 }
649
650                 //
651                 // cat codes
652                 //
653                 if (t.cat() == catMath) {
654                         if (!mathmode) {
655                                 // we are inside some text mode thingy, so opening new math is allowed
656                                 Token const & n = getToken();
657                                 if (n.cat() == catMath) {
658                                         // TeX's $$...$$ syntax for displayed math
659                                         cell->push_back(MathAtom(new MathHullInset("equation")));
660                                         parse_into2(cell->back(), FLAG_SIMPLE, true, false);
661                                         getToken(); // skip the second '$' token
662                                 } else {
663                                         // simple $...$  stuff
664                                         putback();
665                                         cell->push_back(MathAtom(new MathHullInset("simple")));
666                                         parse_into2(cell->back(), FLAG_SIMPLE, true, false);
667                                 }
668                         }
669
670                         else if (flags & FLAG_SIMPLE) {
671                                 // this is the end of the formula
672                                 return;
673                         }
674
675                         else {
676                                 error("something strange in the parser\n");
677                                 break;
678                         }
679                 }
680
681                 else if (t.cat() == catLetter)
682                         cell->push_back(MathAtom(new MathCharInset(t.character())));
683
684                 else if (t.cat() == catSpace && !mathmode)
685                         cell->push_back(MathAtom(new MathCharInset(t.character())));
686
687                 else if (t.cat() == catParameter) {
688                         Token const & n = getToken();
689                         cell->push_back(MathAtom(new MathMacroArgument(n.character()-'0')));
690                 }
691
692                 else if (t.cat() == catBegin) {
693                         MathArray ar;
694                         parse_into(ar, FLAG_BRACE_LAST, mathmode);
695                         // reduce multiple nesting levels to a single one
696                         // this helps to keep the annoyance of  "a choose b"  to a minimum
697                         if (ar.size() && ar.front()->asBraceInset())
698                                 ar = ar.front()->asBraceInset()->cell(0);
699                         cell->push_back(MathAtom(new MathBraceInset));
700                         cell->back()->cell(0).swap(ar);
701                 }
702
703                 else if (t.cat() == catEnd) {
704                         if (flags & FLAG_BRACE_LAST)
705                                 return;
706                         error("found '}' unexpectedly");
707                         //lyx::Assert(0);
708                         //add(cell, '}', LM_TC_TEX);
709                 }
710
711                 else if (t.cat() == catAlign) {
712                         ++cellcol;
713                         //lyxerr << " column now " << cellcol << " max: " << grid.ncols() << "\n";
714                         if (cellcol == grid.ncols()) {
715                                 lyxerr << "adding column " << cellcol << "\n";
716                                 grid.addCol(cellcol - 1);
717                         }
718                         cell = &grid.cell(grid.index(cellrow, cellcol));
719                 }
720
721                 else if (t.cat() == catSuper || t.cat() == catSub) {
722                         bool up = (t.cat() == catSuper);
723                         MathScriptInset * p = 0;
724                         if (cell->size())
725                                 p = cell->back()->asScriptInset();
726                         if (!p || p->has(up)) {
727                                 cell->push_back(MathAtom(new MathScriptInset(up)));
728                                 p = cell->back()->asScriptInset();
729                         }
730                         p->ensure(up);
731                         parse_into(p->cell(up), FLAG_ITEM, mathmode);
732                         p->limits(limits);
733                         limits = 0;
734                 }
735
736                 else if (t.character() == ']' && (flags & FLAG_BRACK_END))
737                         return;
738
739                 else if (t.cat() == catOther)
740                         cell->push_back(MathAtom(new MathCharInset(t.character())));
741
742                 //
743                 // control sequences
744                 //
745                 else if (t.cs() == "(") {
746                         cell->push_back(MathAtom(new MathHullInset("simple")));
747                         parse_into2(cell->back(), FLAG_SIMPLE2, true, false);
748                 }
749
750                 else if (t.cs() == "[") {
751                         cell->push_back(MathAtom(new MathHullInset("equation")));
752                         parse_into2(cell->back(), FLAG_EQUATION, true, false);
753                 }
754
755                 else if (t.cs() == "protect")
756                         // ignore \\protect, will hopefully be re-added during output
757                         ;
758
759                 else if (t.cs() == "end") {
760                         if (flags & FLAG_END) {
761                                 // eat environment name
762                                 //string const name =
763                                 getArg('{', '}');
764                                 // FIXME: check that we ended the correct environment
765                                 return;
766                         }
767                         error("found 'end' unexpectedly");
768                 }
769
770                 else if (t.cs() == ")") {
771                         if (flags & FLAG_SIMPLE2)
772                                 return;
773                         error("found '\\)' unexpectedly");
774                 }
775
776                 else if (t.cs() == "]") {
777                         if (flags & FLAG_EQUATION)
778                                 return;
779                         error("found '\\]' unexpectedly");
780                 }
781
782                 else if (t.cs() == "\\") {
783                         grid.vcrskip(LyXLength(getArg('[', ']')), cellrow);
784                         ++cellrow;
785                         cellcol = 0;
786                         if (cellrow == grid.nrows())
787                                 grid.addRow(cellrow - 1);
788                         if (grid.asHullInset())
789                                 grid.asHullInset()->numbered(cellrow, numbered);
790                         cell = &grid.cell(grid.index(cellrow, cellcol));
791                 }
792
793 #if 1
794                 else if (t.cs() == "multicolumn") {
795                         // extract column count and insert dummy cells
796                         MathArray count;
797                         parse_into(count, FLAG_ITEM, mathmode);
798                         int cols = 1;
799                         if (!extractNumber(count, cols)) {
800                                 lyxerr << " can't extract number of cells from " << count << "\n";
801                         }
802                         // resize the table if necessary
803                         for (int i = 0; i < cols; ++i) {
804                                 ++cellcol;
805                                 if (cellcol == grid.ncols()) {
806                                         lyxerr << "adding column " << cellcol << "\n";
807                                         grid.addCol(cellcol - 1);
808                                 }
809                                 cell = &grid.cell(grid.index(cellrow, cellcol));
810                                 // mark this as dummy
811                                 grid.cellinfo(grid.index(cellrow, cellcol)).dummy_ = true;
812                         }
813                         // the last cell is the real thng, not a dummy
814                         grid.cellinfo(grid.index(cellrow, cellcol)).dummy_ = false;
815
816                         // read special alignment
817                         MathArray align;
818                         parse_into(align, FLAG_ITEM, mathmode);
819                         //grid.cellinfo(grid.index(cellrow, cellcol)).align_ = extractString(align);
820
821                         // parse the remaining contents into the "real" cell
822                         parse_into(*cell, FLAG_ITEM, mathmode);
823                 }
824 #endif
825
826                 else if (t.cs() == "limits")
827                         limits = 1;
828
829                 else if (t.cs() == "nolimits")
830                         limits = -1;
831
832                 else if (t.cs() == "nonumber") {
833                         if (grid.asHullInset())
834                                 grid.asHullInset()->numbered(cellrow, false);
835                 }
836
837                 else if (t.cs() == "number") {
838                         if (grid.asHullInset())
839                                 grid.asHullInset()->numbered(cellrow, true);
840                 }
841
842                 else if (t.cs() == "hline") {
843                         if (grid.asHullInset())
844                                 grid.asHullInset()->rowinfo(cellrow + 1);
845                 }
846
847                 else if (t.cs() == "sqrt") {
848                         char c = getChar();
849                         if (c == '[') {
850                                 cell->push_back(MathAtom(new MathRootInset));
851                                 parse_into(cell->back()->cell(0), FLAG_BRACK_END, mathmode);
852                                 parse_into(cell->back()->cell(1), FLAG_ITEM, mathmode);
853                         } else {
854                                 putback();
855                                 cell->push_back(MathAtom(new MathSqrtInset));
856                                 parse_into(cell->back()->cell(0), FLAG_ITEM, mathmode);
857                         }
858                 }
859
860                 else if (t.cs() == "ref") {
861                         cell->push_back(MathAtom(new RefInset));
862                         char c = getChar();
863                         if (c == '[') 
864                                 parse_into(cell->back()->cell(1), FLAG_BRACK_END, mathmode);
865                         else 
866                                 putback();
867                         parse_into(cell->back()->cell(0), FLAG_ITEM, mathmode);
868                 }
869
870                 else if (t.cs() == "left") {
871                         string l = getToken().asString();
872                         MathArray ar;
873                         parse_into(ar, FLAG_RIGHT, mathmode);
874                         string r = getToken().asString();
875                         cell->push_back(MathAtom(new MathDelimInset(l, r, ar)));
876                 }
877
878                 else if (t.cs() == "right") {
879                         if (flags & FLAG_RIGHT)
880                                 return;
881                         //lyxerr << "got so far: '" << cell << "'\n";
882                         error("Unmatched right delimiter");
883                         return;
884                 }
885
886                 else if (t.cs() == "begin") {
887                         string const name = getArg('{', '}');
888                         if (name == "array" || name == "subarray") {
889                                 string const valign = getArg('[', ']') + 'c';
890                                 string const halign = getArg('{', '}');
891                                 cell->push_back(MathAtom(new MathArrayInset(name, valign[0], halign)));
892                                 parse_into2(cell->back(), FLAG_END, mathmode, false);
893                         }
894
895                         else if (name == "split" || name == "cases" ||
896                                          name == "gathered" || name == "aligned") {
897                                 cell->push_back(createMathInset(name));
898                                 parse_into2(cell->back(), FLAG_END, mathmode, false);
899                         }
900
901                         else if (name == "math") {
902                                 cell->push_back(MathAtom(new MathHullInset("simple")));
903                                 parse_into2(cell->back(), FLAG_SIMPLE, true, true);
904                         }
905
906                         else if (name == "equation" || name == "equation*"
907                                         || name == "displaymath") {
908                                 cell->push_back(MathAtom(new MathHullInset("equation")));
909                                 parse_into2(cell->back(), FLAG_END, true, (name == "equation"));
910                         }
911
912                         else if (name == "eqnarray" || name == "eqnarray*") {
913                                 cell->push_back(MathAtom(new MathHullInset("eqnarray")));
914                                 parse_into2(cell->back(), FLAG_END, true, !stared(name));
915                         }
916
917                         else if (name == "align" || name == "align*") {
918                                 cell->push_back(MathAtom(new MathHullInset("align")));
919                                 parse_into2(cell->back(), FLAG_END, true, !stared(name));
920                         }
921
922                         else if (name == "alignat" || name == "alignat*") {
923                                 // ignore this for a while
924                                 getArg('{', '}');
925                                 cell->push_back(MathAtom(new MathHullInset("alignat")));
926                                 parse_into2(cell->back(), FLAG_END, true, !stared(name));
927                         }
928
929                         else if (name == "xalignat" || name == "xalignat*") {
930                                 // ignore this for a while
931                                 getArg('{', '}');
932                                 cell->push_back(MathAtom(new MathHullInset("xalignat")));
933                                 parse_into2(cell->back(), FLAG_END, true, !stared(name));
934                         }
935
936                         else if (name == "xxalignat") {
937                                 // ignore this for a while
938                                 getArg('{', '}');
939                                 cell->push_back(MathAtom(new MathHullInset("xxalignat")));
940                                 parse_into2(cell->back(), FLAG_END, true, !stared(name));
941                         }
942
943                         else if (name == "multline" || name == "multline*") {
944                                 cell->push_back(MathAtom(new MathHullInset("multline")));
945                                 parse_into2(cell->back(), FLAG_END, true, !stared(name));
946                         }
947
948                         else if (name == "gather" || name == "gather*") {
949                                 cell->push_back(MathAtom(new MathHullInset("gather")));
950                                 parse_into2(cell->back(), FLAG_END, true, !stared(name));
951                         }
952
953                         else {
954                                 latexkeys const * l = in_word_set(name);
955                                 if (l) {
956                                         if (l->inset == "matrix") {
957                                                 cell->push_back(createMathInset(name));
958                                                 parse_into2(cell->back(), FLAG_END, mathmode, false);
959                                         }
960                                 } else {
961                                         lyxerr << "unknow math inset begin '" << name << "'\n";
962                                 }
963                         }
964                 }
965
966                 else if (t.cs() == "kern") {
967 #ifdef WITH_WARNINGS
968 #warning A hack...
969 #endif
970                         string s;
971                         while (1) {
972                                 Token const & t = getToken();
973                                 if (!good()) {
974                                         putback();
975                                         break;
976                                 }
977                                 s += t.character();
978                                 if (isValidLength(s))
979                                         break;
980                         }
981                         cell->push_back(MathAtom(new MathKernInset(s)));
982                 }
983
984                 else if (t.cs() == "label") {
985                         if (grid.asHullInset())
986                                 grid.asHullInset()->label(cellrow, getArg('{', '}'));
987                 }
988
989                 else if (t.cs() == "choose" || t.cs() == "over" || t.cs() == "atop") {
990                         MathAtom p = createMathInset(t.cs());
991                         cell->swap(p->cell(0));
992                         parse_into(p->cell(1), flags, mathmode);
993                         cell->push_back(p);
994                         return;
995                 }
996
997                 else if (t.cs() == "substack") {
998                         cell->push_back(createMathInset(t.cs()));
999                         parse_into2(cell->back(), FLAG_ITEM, mathmode, false);
1000                 }
1001
1002                 else if (t.cs() == "xymatrix") {
1003                         cell->push_back(createMathInset(t.cs()));
1004                         parse_into2(cell->back(), FLAG_ITEM, mathmode, false);
1005                 }
1006
1007 #if 0
1008                 // Disabled
1009                 else if (1 && t.cs() == "ar") {
1010                         MathXYArrowInset * p = new MathXYArrowInset;
1011
1012                         // try to read target
1013                         char c = getChar();
1014                         if (c == '[') {
1015                                 parse_into(p->cell(0), FLAG_BRACK_END, mathmode);
1016                                 //lyxerr << "read target: " << p->cell(0) << "\n";
1017                         } else {
1018                                 putback();
1019                         }
1020
1021                         // try to read label
1022                         if (nextToken().cat() == catSuper || nextToken().cat() == catSub) {
1023                                 p->up_ = nextToken().cat() == catSuper;
1024                                 getToken();
1025                                 parse_into(p->cell(1), FLAG_ITEM, mathmode);
1026                                 //lyxerr << "read label: " << p->cell(1) << "\n";
1027                         }
1028
1029                         cell->push_back(MathAtom(p));
1030                         //lyxerr << "read cell: " << cell << "\n";
1031                 }
1032 #endif
1033
1034                 else if (t.cs().size()) {
1035                         latexkeys const * l = in_word_set(t.cs());
1036                         if (l) {
1037                                 if (l->inset == "font") {
1038                                         lyxerr << "starting font " << t.cs() << "\n";
1039                                         MathAtom p = createMathInset(t.cs());
1040                                         bool textmode = (t.cs()[0] == 't');
1041                                         parse_into(p->cell(0), FLAG_ITEM, !textmode);
1042                                         cell->push_back(p);
1043                                         //lyxerr << "ending font\n";
1044                                 }
1045
1046                                 else if (l->inset == "oldfont") {
1047                                         cell->push_back(createMathInset(t.cs()));
1048                                         parse_into(cell->back()->cell(0), flags, l->extra == "mathmode");
1049                                         return;
1050                                 }
1051
1052                                 else if (l->inset == "box") {
1053                                         // switch to text mode
1054                                         cell->push_back(createMathInset(t.cs()));
1055                                         parse_into(cell->back()->cell(0), FLAG_ITEM, mathmode);
1056                                 }
1057
1058                                 else if (l->inset == "style") {
1059                                         cell->push_back(createMathInset(t.cs()));
1060                                         parse_into(cell->back()->cell(0), flags, mathmode);
1061                                         return;
1062                                 }
1063
1064                                 else {
1065                                         MathAtom p = createMathInset(t.cs());
1066                                         for (MathInset::idx_type i = 0; i < p->nargs(); ++i)
1067                                                 parse_into(p->cell(i), FLAG_ITEM, l->extra == "mathmode");
1068                                         cell->push_back(p);
1069                                 }
1070                         }
1071
1072                         else {
1073                                 MathAtom p = createMathInset(t.cs());
1074                                 for (MathInset::idx_type i = 0; i < p->nargs(); ++i)
1075                                         parse_into(p->cell(i), FLAG_ITEM, mathmode);
1076                                 cell->push_back(p);
1077                         }
1078                 }
1079
1080
1081                 if (flags & FLAG_LEAVE) {
1082                         flags &= ~FLAG_LEAVE;
1083                         break;
1084                 }
1085         }
1086 }
1087
1088
1089
1090 } // anonymous namespace
1091
1092
1093 void mathed_parse_cell(MathArray & ar, string const & str)
1094 {
1095         istringstream is(str.c_str());
1096         mathed_parse_cell(ar, is);
1097 }
1098
1099
1100 void mathed_parse_cell(MathArray & ar, istream & is)
1101 {
1102         Parser(is).parse_into(ar, 0, true);
1103 }
1104
1105
1106
1107 bool mathed_parse_macro(string & name, string const & str)
1108 {
1109         istringstream is(str.c_str());
1110         Parser parser(is);
1111         return parser.parse_macro(name);
1112 }
1113
1114 bool mathed_parse_macro(string & name, istream & is)
1115 {
1116         Parser parser(is);
1117         return parser.parse_macro(name);
1118 }
1119
1120 bool mathed_parse_macro(string & name, LyXLex & lex)
1121 {
1122         Parser parser(lex);
1123         return parser.parse_macro(name);
1124 }
1125
1126
1127
1128 bool mathed_parse_normal(MathAtom & t, string const & str)
1129 {
1130         istringstream is(str.c_str());
1131         Parser parser(is);
1132         return parser.parse_normal(t);
1133 }
1134
1135 bool mathed_parse_normal(MathAtom & t, istream & is)
1136 {
1137         Parser parser(is);
1138         return parser.parse_normal(t);
1139 }
1140
1141 bool mathed_parse_normal(MathAtom & t, LyXLex & lex)
1142 {
1143         Parser parser(lex);
1144         return parser.parse_normal(t);
1145 }