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