src/mathed/MathParser.cpp

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