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                         // But create a BraceInset if a script follows (#9348)
 950                         InsetMathBrace const * mb;
 951                         if (ar.size() > 0)
 952                                 mb = ar[0]->asBraceInset();
 953                         if (ar.size() == 1 && (ar[0]->extraBraces()
 954                                                || (mb && mb->cell(0).size()
 955                                                    && !mb->cell(0)[0].nucleus()->asScriptInset())))
 956                                 cell->append(ar);
 957                         else
 958                                 cell->push_back(MathAtom(new InsetMathBrace(ar)));
 959                 }
 960
 961                 else if (t.cat() == catEnd) {
 962                         if (flags & FLAG_BRACE_LAST)
 963                                 return success_;
 964                         error("found '}' unexpectedly");
 965                         //LASSERT(false, /**/);
 966                         //add(cell, '}', LM_TC_TEX);
 967                 }
 968
 969                 else if (t.cat() == catAlign) {
 970                         //lyxerr << " column now " << (cellcol + 1)
 971                         //       << " max: " << grid.ncols() << endl;
 972                         if (flags & FLAG_ALIGN)
 973                                 return success_;
 974                         if (addCol(grid, cellcol))
 975                                 cell = &grid.cell(grid.index(cellrow, cellcol));
 976                 }
 977
 978                 else if (t.cat() == catSuper || t.cat() == catSub) {
 979                         bool up = (t.cat() == catSuper);
 980                         // we need no new script inset if the last thing was a scriptinset,
 981                         // which has that script already not the same script already
 982                         if (cell->empty())
 983                                 cell->push_back(MathAtom(new InsetMathScript(buf, up)));
 984                         else if (cell->back()->asScriptInset() &&
 985                                         !cell->back()->asScriptInset()->has(up))
 986                                 cell->back().nucleus()->asScriptInset()->ensure(up);
 987                         else if (cell->back()->asScriptInset())
 988                                 cell->push_back(MathAtom(new InsetMathScript(buf, up)));
 989                         else
 990                                 cell->back() = MathAtom(new InsetMathScript(buf, cell->back(), up));
 991                         InsetMathScript * p = cell->back().nucleus()->asScriptInset();
 992                         // special handling of {}-bases
 993                         // Here we could remove the brace inset for things
 994                         // like {a'}^2 and add the braces back in
 995                         // InsetMathScript::write().
 996                         // We do not do it, since it is not possible to detect
 997                         // reliably whether the braces are needed because the
 998                         // nucleus contains more than one symbol, or whether
 999                         // they are needed for unknown commands like \xx{a}_0
1000                         // or \yy{a}{b}_0. This was done in revision 14819
1001                         // in an unreliable way. See this thread
1002                         // http://www.mail-archive.com/lyx-devel%40lists.lyx.org/msg104917.html
1003                         // for more details.
1004                         // However, we remove empty braces because they look
1005                         // ugly on screen and we are sure that they were added
1006                         // by the write() method (and will be re-added on save).
1007                         if (p->nuc().size() == 1 &&
1008                             p->nuc().back()->asBraceInset() &&
1009                             p->nuc().back()->asBraceInset()->cell(0).empty())
1010                                 p->nuc().erase(0);
1011
1012                         parse(p->cell(p->idxOfScript(up)), FLAG_ITEM, mode);
1013                         if (limits) {
1014                                 p->limits(limits);
1015                                 limits = 0;
1016                         }
1017                 }
1018
1019                 else if (t.character() == ']' && (flags & FLAG_BRACK_LAST)) {
1020                         //lyxerr << "finished reading option" << endl;
1021                         return success_;
1022                 }
1023
1024                 else if (t.cat() == catOther) {
1025                         char_type c = t.character();
1026                         if (!Encodings::isUnicodeTextOnly(c)
1027                             || mode_ & Parse::VERBATIM
1028                             || !(mode_ & Parse::USETEXT)
1029                             || mode == InsetMath::TEXT_MODE) {
1030                                 cell->push_back(MathAtom(new InsetMathChar(c)));
1031                         } else {
1032                                 MathAtom at = createInsetMath("text", buf);
1033                                 at.nucleus()->cell(0).push_back(MathAtom(new InsetMathChar(c)));
1034                                 while (nextToken().cat() == catOther
1035                                        && Encodings::isUnicodeTextOnly(nextToken().character())) {
1036                                         c = getToken().character();
1037                                         at.nucleus()->cell(0).push_back(MathAtom(new InsetMathChar(c)));
1038                                 }
1039                                 cell->push_back(at);
1040                         }
1041                 }
1042
1043                 else if (t.cat() == catComment) {
1044                         docstring s;
1045                         while (good()) {
1046                                 Token const & tt = getToken();
1047                                 if (tt.cat() == catNewline)
1048                                         break;
1049                                 s += tt.asInput();
1050                         }
1051                         cell->push_back(MathAtom(new InsetMathComment(buf, s)));
1052                         skipSpaces();
1053                 }
1054
1055                 //
1056                 // control sequences
1057                 //
1058
1059                 else if (t.cs() == "lyxlock") {
1060                         if (!cell->empty())
1061                                 cell->back().nucleus()->lock(true);
1062                 }
1063
1064                 else if ((t.cs() == "global" && nextToken().cs() == "def") ||
1065                          t.cs() == "def") {
1066                         if (t.cs() == "global")
1067                                 getToken();
1068
1069                         // get name
1070                         docstring name = getToken().cs();
1071
1072                         // read parameters
1073                         int nargs = 0;
1074                         docstring pars;
1075                         while (good() && nextToken().cat() != catBegin) {
1076                                 pars += getToken().cs();
1077                                 ++nargs;
1078                         }
1079                         nargs /= 2;
1080
1081                         // read definition
1082                         MathData def;
1083                         parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1084
1085                         // is a version for display attached?
1086                         skipSpaces();
1087                         MathData display;
1088                         if (nextToken().cat() == catBegin)
1089                                 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1090
1091                         cell->push_back(MathAtom(new InsetMathMacroTemplate(buf,
1092                                 name, nargs, 0, MacroTypeDef,
1093                                 vector<MathData>(), def, display)));
1094
1095                         if (buf && (mode_ & Parse::TRACKMACRO))
1096                                 buf->usermacros.insert(name);
1097                 }
1098
1099                 else if (t.cs() == "newcommand" ||
1100                          t.cs() == "renewcommand" ||
1101                          t.cs() == "newlyxcommand") {
1102                         // get name
1103                         if (getToken().cat() != catBegin) {
1104                                 error("'{' in \\newcommand expected (1) ");
1105                                 return success_;
1106                         }
1107                         docstring name = getToken().cs();
1108                         if (getToken().cat() != catEnd) {
1109                                 error("'}' in \\newcommand expected");
1110                                 return success_;
1111                         }
1112
1113                         // get arity
1114                         docstring const arg = getArg('[', ']');
1115                         int nargs = 0;
1116                         if (!arg.empty())
1117                                 nargs = convert<int>(arg);
1118
1119                         // optional argument given?
1120                         skipSpaces();
1121                         int optionals = 0;
1122                         vector<MathData> optionalValues;
1123                         while (nextToken().character() == '[') {
1124                                 getToken();
1125                                 optionalValues.push_back(MathData());
1126                                 parse(optionalValues[optionals], FLAG_BRACK_LAST, mode);
1127                                 ++optionals;
1128                         }
1129
1130                         MathData def;
1131                         parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1132
1133                         // is a version for display attached?
1134                         skipSpaces();
1135                         MathData display;
1136                         if (nextToken().cat() == catBegin)
1137                                 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1138
1139                         cell->push_back(MathAtom(new InsetMathMacroTemplate(buf,
1140                                 name, nargs, optionals, MacroTypeNewcommand,
1141                                 optionalValues, def, display)));
1142
1143                         if (buf && (mode_ & Parse::TRACKMACRO))
1144                                 buf->usermacros.insert(name);
1145                 }
1146
1147                 else if (t.cs() == "newcommandx" ||
1148                          t.cs() == "renewcommandx") {
1149                         // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1150                         // get name
1151                         docstring name;
1152                         if (nextToken().cat() == catBegin) {
1153                                 getToken();
1154                                 name = getToken().cs();
1155                                 if (getToken().cat() != catEnd) {
1156                                         error("'}' in \\newcommandx expected");
1157                                         return success_;
1158                                 }
1159                         } else
1160                                 name = getToken().cs();
1161
1162                         // get arity
1163                         docstring const arg = getArg('[', ']');
1164                         if (arg.empty()) {
1165                                 error("[num] in \\newcommandx expected");
1166                                 return success_;
1167                         }
1168                         int nargs = convert<int>(arg);
1169
1170                         // get options
1171                         int optionals = 0;
1172                         vector<MathData> optionalValues;
1173                         if (nextToken().character() == '[') {
1174                                 // skip '['
1175                                 getToken();
1176
1177                                 // handle 'opt=value' options, separated by ','.
1178                                 skipSpaces();
1179                                 while (nextToken().character() != ']' && good()) {
1180                                         if (nextToken().character() >= '1'
1181                                             && nextToken().character() <= '9') {
1182                                                 // optional value -> get parameter number
1183                                                 int n = getChar() - '0';
1184                                                 if (n > nargs) {
1185                                                         error("Arity of \\newcommandx too low "
1186                                                               "for given optional parameter.");
1187                                                         return success_;
1188                                                 }
1189
1190                                                 // skip '='
1191                                                 if (getToken().character() != '=') {
1192                                                         error("'=' and optional parameter value "
1193                                                               "expected for \\newcommandx");
1194                                                         return success_;
1195                                                 }
1196
1197                                                 // get value
1198                                                 int optNum = max(size_t(n), optionalValues.size());
1199                                                 optionalValues.resize(optNum);
1200                                                 optionalValues[n - 1].clear();
1201                                                 while (nextToken().character() != ']'
1202                                                        && nextToken().character() != ',') {
1203                                                         MathData data;
1204                                                         parse(data, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1205                                                         optionalValues[n - 1].append(data);
1206                                                 }
1207                                                 optionals = max(n, optionals);
1208                                         } else if (nextToken().cat() == catLetter) {
1209                                                 // we in fact ignore every non-optional
1210                                                 // parameter
1211
1212                                                 // get option name
1213                                                 docstring opt;
1214                                                 while (nextToken().cat() == catLetter)
1215                                                         opt += getChar();
1216
1217                                                 // value?
1218                                                 skipSpaces();
1219                                                 MathData value;
1220                                                 if (nextToken().character() == '=') {
1221                                                         getToken();
1222                                                         while (nextToken().character() != ']'
1223                                                                 && nextToken().character() != ',')
1224                                                                 parse(value, FLAG_ITEM,
1225                                                                       InsetMath::UNDECIDED_MODE);
1226                                                 }
1227                                         } else {
1228                                                 error("option for \\newcommandx expected");
1229                                                 return success_;
1230                                         }
1231
1232                                         // skip komma
1233                                         skipSpaces();
1234                                         if (nextToken().character() == ',') {
1235                                                 getChar();
1236                                                 skipSpaces();
1237                                         } else if (nextToken().character() != ']') {
1238                                                 error("Expecting ',' or ']' in options "
1239                                                       "of \\newcommandx");
1240                                                 return success_;
1241                                         }
1242                                 }
1243
1244                                 // skip ']'
1245                                 if (!good())
1246                                         return success_;
1247                                 getToken();
1248                         }
1249
1250                         // get definition
1251                         MathData def;
1252                         parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1253
1254                         // is a version for display attached?
1255                         skipSpaces();
1256                         MathData display;
1257                         if (nextToken().cat() == catBegin)
1258                                 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1259
1260                         cell->push_back(MathAtom(new InsetMathMacroTemplate(buf,
1261                                 name, nargs, optionals, MacroTypeNewcommandx,
1262                                 optionalValues, def, display)));
1263
1264                         if (buf && (mode_ & Parse::TRACKMACRO))
1265                                 buf->usermacros.insert(name);
1266                 }
1267
1268                 else if (t.cs() == "(") {
1269                         if (mode == InsetMath::UNDECIDED_MODE) {
1270                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullSimple)));
1271                                 parse2(cell->back(), FLAG_SIMPLE2, InsetMath::MATH_MODE, false);
1272                         } else {
1273                                 // Don't create nested math hulls (bug #5392)
1274                                 cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
1275                                 parse(cell->back().nucleus()->cell(0), FLAG_SIMPLE2, InsetMath::MATH_MODE);
1276                         }
1277                 }
1278
1279                 else if (t.cs() == "[") {
1280                         if (mode != InsetMath::UNDECIDED_MODE) {
1281                                 error("bad math environment [");
1282                                 break;
1283                         }
1284                         cell->push_back(MathAtom(new InsetMathHull(buf, hullEquation)));
1285                         parse2(cell->back(), FLAG_EQUATION, InsetMath::MATH_MODE, false);
1286                 }
1287
1288                 else if (t.cs() == "protect")
1289                         // ignore \\protect, will hopefully be re-added during output
1290                         ;
1291
1292                 else if (t.cs() == "end") {
1293                         if (flags & FLAG_END) {
1294                                 // eat environment name
1295                                 docstring const name = getArg('{', '}');
1296                                 if (environments_.empty())
1297                                         error("'found \\end{" + name +
1298                                               "}' without matching '\\begin{" +
1299                                               name + "}'");
1300                                 else if (name != environments_.back())
1301                                         error("'\\end{" + name +
1302                                               "}' does not match '\\begin{" +
1303                                               environments_.back() + "}'");
1304                                 else {
1305                                         environments_.pop_back();
1306                                         // Delete empty last row in matrix
1307                                         // like insets.
1308                                         // If you abuse InsetMathGrid for
1309                                         // non-matrix like structures you
1310                                         // probably need to refine this test.
1311                                         // Right now we only have to test for
1312                                         // single line hull insets.
1313                                         if (grid.nrows() > 1 && innerHull(name))
1314                                                 delEmptyLastRow(grid);
1315                                         return success_;
1316                                 }
1317                         } else
1318                                 error("found 'end' unexpectedly");
1319                 }
1320
1321                 else if (t.cs() == ")") {
1322                         if (flags & FLAG_SIMPLE2)
1323                                 return success_;
1324                         error("found '\\)' unexpectedly");
1325                 }
1326
1327                 else if (t.cs() == "]") {
1328                         if (flags & FLAG_EQUATION)
1329                                 return success_;
1330                         error("found '\\]' unexpectedly");
1331                 }
1332
1333                 else if (t.cs() == "\\") {
1334                         if (flags & FLAG_ALIGN)
1335                                 return success_;
1336                         bool starred = false;
1337                         docstring arg;
1338                         if (nextToken().asInput() == "*") {
1339                                 getToken();
1340                                 starred = true;
1341                         } else if (nextToken().asInput() == "[")
1342                                 arg = getArg('[', ']');
1343                         else if (!good())
1344                                 error("missing token after \\\\");
1345                         // skip "{}" added in front of "[" (the
1346                         // counterpart is in InsetMathGrid::eolString())
1347                         // skip spaces because formula could come from tex2lyx
1348                         bool skipBraces = false;
1349                         pushPosition();
1350                         if (nextToken().cat() == catBegin) {
1351                                 getToken();
1352                                 if (nextToken().cat() == catEnd) {
1353                                         getToken();
1354                                         pushPosition();
1355                                         skipSpaces();
1356                                         if (nextToken().asInput() == "[")
1357                                                 skipBraces = true;
1358                                         popPosition();
1359                                 }
1360                         }
1361                         if (skipBraces)
1362                                 dropPosition();
1363                         else
1364                                 popPosition();
1365                         bool const added = addRow(grid, cellrow, arg, !starred);
1366                         if (added) {
1367                                 cellcol = 0;
1368                                 if (grid.asHullInset())
1369                                         grid.asHullInset()->numbered(
1370                                                         cellrow, numbered);
1371                                 cell = &grid.cell(grid.index(cellrow,
1372                                                              cellcol));
1373                         }
1374                 }
1375
1376                 else if (t.cs() == "multicolumn" && grid.handlesMulticolumn()) {
1377                         // if the columns are specified numerically,
1378                         // extract column count and insert dummy cells,
1379                         // otherwise parse it as an user macro
1380                         MathData count;
1381                         parse(count, FLAG_ITEM, mode);
1382                         int cols;
1383                         // limit arbitrarily to 100 columns
1384                         if (extractNumber(count, cols) && cols > 0 && cols < 100) {
1385                                 // resize the table if necessary
1386                                 size_t first = grid.index(cellrow, cellcol);
1387                                 for (int i = 1; i < cols; ++i) {
1388                                         if (addCol(grid, cellcol)) {
1389                                                 size_t const idx = grid.index(cellrow, cellcol);
1390                                                 grid.cellinfo(idx).multi_ =
1391                                                         InsetMathGrid::CELL_PART_OF_MULTICOLUMN;
1392                                         }
1393                                 }
1394
1395                                 // the first cell is the real thing, not a dummy
1396                                 cell = &grid.cell(first);
1397                                 grid.cellinfo(first).multi_ =
1398                                         InsetMathGrid::CELL_BEGIN_OF_MULTICOLUMN;
1399
1400                                 // read special alignment
1401                                 MathData align;
1402                                 parse(align, FLAG_ITEM, mode);
1403                                 grid.cellinfo(first).align_ = asString(align);
1404
1405                                 // parse the remaining contents into the "real" cell
1406                                 parse(*cell, FLAG_ITEM, mode);
1407                         } else {
1408                                 MathAtom at = MathAtom(new InsetMathMacro(buf, t.cs()));
1409                                 cell->push_back(at);
1410                                 cell->push_back(MathAtom(new InsetMathBrace(count)));
1411                         }
1412                 }
1413
1414                 else if (t.cs() == "limits" || t.cs() == "nolimits") {
1415                         CatCode const cat = nextToken().cat();
1416                         if (cat == catSuper || cat == catSub)
1417                                 limits = t.cs() == "limits" ? 1 : -1;
1418                         else {
1419                                 MathAtom at = createInsetMath(t.cs(), buf);
1420                                 cell->push_back(at);
1421                         }
1422                 }
1423
1424                 // \notag is the same as \nonumber if amsmath is used
1425                 else if ((t.cs() == "nonumber" || t.cs() == "notag") &&
1426                          grid.asHullInset())
1427                         grid.asHullInset()->numbered(cellrow, false);
1428
1429                 else if (t.cs() == "number" && grid.asHullInset())
1430                         grid.asHullInset()->numbered(cellrow, true);
1431
1432                 else if (t.cs() == "hline") {
1433                         grid.rowinfo(cellrow).lines_ ++;
1434                 }
1435
1436                 else if (t.cs() == "sqrt") {
1437                         MathData ar;
1438                         parse(ar, FLAG_OPTION, mode);
1439                         if (!ar.empty()) {
1440                                 cell->push_back(MathAtom(new InsetMathRoot(buf)));
1441                                 cell->back().nucleus()->cell(1) = ar;
1442                         } else
1443                                 cell->push_back(MathAtom(new InsetMathSqrt(buf)));
1444                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1445                 }
1446
1447                 else if (t.cs() == "cancelto") {
1448                         MathData ar;
1449                         parse(ar, FLAG_ITEM, mode);
1450                                 cell->push_back(MathAtom(new InsetMathCancelto(buf)));
1451                                 cell->back().nucleus()->cell(1) = ar;
1452                                 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1453                 }
1454
1455                 else if (t.cs() == "unit") {
1456                         // Allowed formats \unit[val]{unit}
1457                         MathData ar;
1458                         parse(ar, FLAG_OPTION, mode);
1459                         if (!ar.empty()) {
1460                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT)));
1461                                 cell->back().nucleus()->cell(0) = ar;
1462                                 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1463                         } else {
1464                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT, 1)));
1465                                 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1466                         }
1467                 }
1468
1469                 else if (t.cs() == "unitfrac") {
1470                         // Here allowed formats are \unitfrac[val]{num}{denom}
1471                         MathData ar;
1472                         parse(ar, FLAG_OPTION, mode);
1473                         if (!ar.empty()) {
1474                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC, 3)));
1475                                 cell->back().nucleus()->cell(2) = ar;
1476                         } else {
1477                                 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC)));
1478                         }
1479                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1480                         parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1481                 }
1482
1483                 else if (t.cs() == "cfrac") {
1484                         // allowed formats are \cfrac[pos]{num}{denom}
1485                         docstring const arg = getArg('[', ']');
1486                         //lyxerr << "got so far: '" << arg << "'" << endl;
1487                                 if (arg == "l")
1488                                         cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACLEFT)));
1489                                 else if (arg == "r")
1490                                         cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACRIGHT)));
1491                                 else if (arg.empty() || arg == "c")
1492                                         cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRAC)));
1493                                 else {
1494                                         error("found invalid optional argument");
1495                                         break;
1496                                 }
1497                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1498                         parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1499                 }
1500
1501                 else if (t.cs() == "sideset") {
1502                         // Here allowed formats are \sideset{_{bl}^{tl}}{_{br}^{tr}}{operator}
1503                         MathData ar[2];
1504                         InsetMathScript * script[2] = {0, 0};
1505                         for (int i = 0; i < 2; ++i) {
1506                                 parse(ar[i], FLAG_ITEM, mode);
1507                                 if (ar[i].size() == 1)
1508                                         script[i] = ar[i][0].nucleus()->asScriptInset();
1509                         }
1510                         bool const hasscript[2] = {script[0] ? true : false, script[1] ? true : false};
1511                         cell->push_back(MathAtom(new InsetMathSideset(buf, hasscript[0], hasscript[1])));
1512                         if (hasscript[0]) {
1513                                 if (script[0]->hasDown())
1514                                         cell->back().nucleus()->cell(1) = script[0]->down();
1515                                 if (script[0]->hasUp())
1516                                         cell->back().nucleus()->cell(2) = script[0]->up();
1517                         } else
1518                                 cell->back().nucleus()->cell(1) = ar[0];
1519                         if (hasscript[1]) {
1520                                 if (script[1]->hasDown())
1521                                         cell->back().nucleus()->cell(2 + hasscript[0]) = script[1]->down();
1522                                 if (script[1]->hasUp())
1523                                         cell->back().nucleus()->cell(3 + hasscript[0]) = script[1]->up();
1524                         } else
1525                                 cell->back().nucleus()->cell(2 + hasscript[0]) = ar[1];
1526                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1527                 }
1528
1529                 else if (t.cs() == "stackrel") {
1530                         // Here allowed formats are \stackrel[subscript]{superscript}{operator}
1531                         MathData ar;
1532                         parse(ar, FLAG_OPTION, mode);
1533                         cell->push_back(MathAtom(new InsetMathStackrel(buf, !ar.empty())));
1534                         if (!ar.empty())
1535                                 cell->back().nucleus()->cell(2) = ar;
1536                         parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1537                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1538                 }
1539
1540                 else if (t.cs() == "xrightarrow" || t.cs() == "xleftarrow") {
1541                         cell->push_back(createInsetMath(t.cs(), buf));
1542                         parse(cell->back().nucleus()->cell(1), FLAG_OPTION, mode);
1543                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1544                 }
1545
1546                 else if (t.cs() == "xhookrightarrow" || t.cs() == "xhookleftarrow" ||
1547                              t.cs() == "xRightarrow" || t.cs() == "xLeftarrow" ||
1548                                  t.cs() == "xleftrightarrow" || t.cs() == "xLeftrightarrow" ||
1549                                  t.cs() == "xrightharpoondown" || t.cs() == "xrightharpoonup" ||
1550                                  t.cs() == "xleftharpoondown" || t.cs() == "xleftharpoonup" ||
1551                                  t.cs() == "xleftrightharpoons" || t.cs() == "xrightleftharpoons" ||
1552                                  t.cs() == "xmapsto") {
1553                         cell->push_back(createInsetMath(t.cs(), buf));
1554                         parse(cell->back().nucleus()->cell(1), FLAG_OPTION, mode);
1555                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1556                 }
1557
1558                 else if (t.cs() == "ref" || t.cs() == "eqref" || t.cs() == "prettyref"
1559                           || t.cs() == "nameref" || t.cs() == "pageref"
1560                           || t.cs() == "vpageref" || t.cs() == "vref") {
1561                         cell->push_back(MathAtom(new InsetMathRef(buf, t.cs())));
1562                         docstring const opt = parse_verbatim_option();
1563                         docstring const ref = parse_verbatim_item();
1564                         if (!opt.empty()) {
1565                                 cell->back().nucleus()->cell(1).push_back(
1566                                         MathAtom(new InsetMathString(opt)));
1567                         }
1568                         cell->back().nucleus()->cell(0).push_back(
1569                                         MathAtom(new InsetMathString(ref)));
1570                 }
1571
1572                 else if (t.cs() == "left") {
1573                         skipSpaces();
1574                         Token const & tl = getToken();
1575                         // \| and \Vert are equivalent, and InsetMathDelim
1576                         // can't handle \|
1577                         // FIXME: fix this in InsetMathDelim itself!
1578                         docstring const l = tl.cs() == "|" ? from_ascii("Vert") : tl.asString();
1579                         MathData ar;
1580                         parse(ar, FLAG_RIGHT, mode);
1581                         if (!good())
1582                                 break;
1583                         skipSpaces();
1584                         Token const & tr = getToken();
1585                         docstring const r = tr.cs() == "|" ? from_ascii("Vert") : tr.asString();
1586                         cell->push_back(MathAtom(new InsetMathDelim(buf, l, r, ar)));
1587                 }
1588
1589                 else if (t.cs() == "right") {
1590                         if (flags & FLAG_RIGHT)
1591                                 return success_;
1592                         //lyxerr << "got so far: '" << cell << "'" << endl;
1593                         error("Unmatched right delimiter");
1594                         return success_;
1595                 }
1596
1597                 else if (t.cs() == "begin") {
1598                         docstring const name = getArg('{', '}');
1599
1600                         if (name.empty()) {
1601                                 success_ = false;
1602                                 error("found invalid environment");
1603                                 return success_;
1604                         }
1605
1606                         environments_.push_back(name);
1607
1608                         if (name == "array" || name == "subarray") {
1609                                 docstring const valign = parse_verbatim_option() + 'c';
1610                                 docstring const halign = parse_verbatim_item();
1611                                 cell->push_back(MathAtom(new InsetMathArray(buf, name,
1612                                         InsetMathGrid::guessColumns(halign), 1, (char)valign[0], halign)));
1613                                 parse2(cell->back(), FLAG_END, mode, false);
1614                         }
1615
1616                         else if (name == "tabular") {
1617                                 docstring const valign = parse_verbatim_option() + 'c';
1618                                 docstring const halign = parse_verbatim_item();
1619                                 cell->push_back(MathAtom(new InsetMathTabular(buf, name,
1620                                         InsetMathGrid::guessColumns(halign), 1, (char)valign[0], halign)));
1621                                 parse2(cell->back(), FLAG_END, InsetMath::TEXT_MODE, false);
1622                         }
1623
1624                         else if (name == "split" || name == "cases") {
1625                                 cell->push_back(createInsetMath(name, buf));
1626                                 parse2(cell->back(), FLAG_END, mode, false);
1627                         }
1628
1629                         else if (name == "alignedat") {
1630                                 docstring const valign = parse_verbatim_option() + 'c';
1631                                 // ignore this for a while
1632                                 getArg('{', '}');
1633                                 cell->push_back(MathAtom(new InsetMathSplit(buf, name, (char)valign[0])));
1634                                 parse2(cell->back(), FLAG_END, mode, false);
1635                         }
1636
1637                         else if (name == "math") {
1638                                 if (mode == InsetMath::UNDECIDED_MODE) {
1639                                         cell->push_back(MathAtom(new InsetMathHull(buf, hullSimple)));
1640                                         parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, false);
1641                                 } else {
1642                                         // Don't create nested math hulls (bug #5392)
1643                                         cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
1644                                         parse(cell->back().nucleus()->cell(0), FLAG_END, InsetMath::MATH_MODE);
1645                                 }
1646                         }
1647
1648                         else if (name == "equation" || name == "equation*"
1649                                         || name == "displaymath") {
1650                                 if (mode != InsetMath::UNDECIDED_MODE) {
1651                                         error("bad math environment " + name);
1652                                         break;
1653                                 }
1654                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullEquation)));
1655                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, (name == "equation"));
1656                         }
1657
1658                         else if (name == "eqnarray" || name == "eqnarray*") {
1659                                 if (mode != InsetMath::UNDECIDED_MODE) {
1660                                         error("bad math environment " + name);
1661                                         break;
1662                                 }
1663                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullEqnArray)));
1664                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1665                         }
1666
1667                         else if (name == "align" || name == "align*") {
1668                                 if (mode == InsetMath::UNDECIDED_MODE) {
1669                                         cell->push_back(MathAtom(new InsetMathHull(buf, hullAlign)));
1670                                         parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1671                                 } else {
1672                                         cell->push_back(MathAtom(new InsetMathSplit(buf, name,
1673                                                         'c', !stared(name))));
1674                                         parse2(cell->back(), FLAG_END, mode, !stared(name));
1675                                 }
1676                         }
1677
1678                         else if (name == "flalign" || name == "flalign*") {
1679                                 if (mode != InsetMath::UNDECIDED_MODE) {
1680                                         error("bad math environment " + name);
1681                                         break;
1682                                 }
1683                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullFlAlign)));
1684                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1685                         }
1686
1687                         else if (name == "alignat" || name == "alignat*") {
1688                                 if (mode != InsetMath::UNDECIDED_MODE) {
1689                                         error("bad math environment " + name);
1690                                         break;
1691                                 }
1692                                 // ignore this for a while
1693                                 getArg('{', '}');
1694                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullAlignAt)));
1695                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1696                         }
1697
1698                         else if (name == "xalignat" || name == "xalignat*") {
1699                                 if (mode != InsetMath::UNDECIDED_MODE) {
1700                                         error("bad math environment " + name);
1701                                         break;
1702                                 }
1703                                 // ignore this for a while
1704                                 getArg('{', '}');
1705                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullXAlignAt)));
1706                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1707                         }
1708
1709                         else if (name == "xxalignat") {
1710                                 if (mode != InsetMath::UNDECIDED_MODE) {
1711                                         error("bad math environment " + name);
1712                                         break;
1713                                 }
1714                                 // ignore this for a while
1715                                 getArg('{', '}');
1716                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullXXAlignAt)));
1717                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1718                         }
1719
1720                         else if (name == "multline" || name == "multline*") {
1721                                 if (mode != InsetMath::UNDECIDED_MODE) {
1722                                         error("bad math environment " + name);
1723                                         break;
1724                                 }
1725                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullMultline)));
1726                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1727                         }
1728
1729                         else if (name == "gather" || name == "gather*") {
1730                                 if (mode != InsetMath::UNDECIDED_MODE) {
1731                                         error("bad math environment " + name);
1732                                         break;
1733                                 }
1734                                 cell->push_back(MathAtom(new InsetMathHull(buf, hullGather)));
1735                                 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1736                         }
1737
1738                         else if (latexkeys const * l = in_word_set(name)) {
1739                                 if (l->inset == "matrix") {
1740                                         cell->push_back(createInsetMath(name, buf));
1741                                         parse2(cell->back(), FLAG_END, mode, false);
1742                                 } else if (l->inset == "split") {
1743                                         docstring const valign = parse_verbatim_option() + 'c';
1744                                         cell->push_back(MathAtom(
1745                                                 new InsetMathSplit(buf, name, (char)valign[0])));
1746                                         parse2(cell->back(), FLAG_END, mode, false);
1747                                 } else {
1748                                         success_ = false;
1749                                         if (!(mode_ & Parse::QUIET)) {
1750                                                 dump();
1751                                                 lyxerr << "found math environment `"
1752                                                        << to_utf8(name)
1753                                                        << "' in symbols file with unsupported inset `"
1754                                                        << l->inset
1755                                                        << "'." << endl;
1756                                         }
1757                                         // create generic environment inset
1758                                         cell->push_back(MathAtom(new InsetMathEnv(buf, name)));
1759                                         parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1760                                 }
1761                         }
1762
1763                         else {
1764                                 success_ = false;
1765                                 if (!(mode_ & Parse::QUIET) &&
1766                                     !(mode_ & Parse::TRACKMACRO)) {
1767                                         dump();
1768                                         lyxerr << "found unknown math environment '"
1769                                                << to_utf8(name) << "'" << endl;
1770                                 }
1771                                 // create generic environment inset
1772                                 cell->push_back(MathAtom(new InsetMathEnv(buf, name)));
1773                                 parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1774                         }
1775                 }
1776
1777                 else if (t.cs() == "kern" || t.cs() == "mkern") {
1778                         // FIXME: A hack...
1779                         docstring s;
1780                         int num_tokens = 0;
1781                         while (true) {
1782                                 Token const & tt = getToken();
1783                                 ++num_tokens;
1784                                 if (!good()) {
1785                                         s.clear();
1786                                         while (num_tokens--)
1787                                                 putback();
1788                                         break;
1789                                 }
1790                                 s += tt.character();
1791                                 if (isValidLength(to_utf8(s)))
1792                                         break;
1793                         }
1794                         if (s.empty())
1795                                 cell->push_back(MathAtom(new InsetMathMacro(buf, t.cs())));
1796                         else
1797                                 cell->push_back(MathAtom(new InsetMathKern(s)));
1798                 }
1799
1800                 else if (t.cs() == "label") {
1801                         // FIXME: This is swallowed in inline formulas
1802                         docstring label = parse_verbatim_item();
1803                         MathData ar;
1804                         asArray(label, ar);
1805                         if (grid.asHullInset()) {
1806                                 grid.asHullInset()->label(cellrow, label);
1807                                 grid.asHullInset()->numbered(cellrow, true);
1808                         } else {
1809                                 cell->push_back(createInsetMath(t.cs(), buf));
1810                                 cell->push_back(MathAtom(new InsetMathBrace(ar)));
1811                         }
1812                 }
1813
1814                 else if (t.cs() == "choose" || t.cs() == "over"
1815                                 || t.cs() == "atop" || t.cs() == "brace"
1816                                 || t.cs() == "brack") {
1817                         MathAtom at = createInsetMath(t.cs(), buf);
1818                         at.nucleus()->cell(0) = *cell;
1819                         cell->clear();
1820                         parse(at.nucleus()->cell(1), flags, mode);
1821                         cell->push_back(at);
1822                         return success_;
1823                 }
1824
1825                 else if (t.cs() == "color") {
1826                         docstring const color = parse_verbatim_item();
1827                         cell->push_back(MathAtom(new InsetMathColor(buf, true, color)));
1828                         parse(cell->back().nucleus()->cell(0), flags, mode);
1829                         return success_;
1830                 }
1831
1832                 else if (t.cs() == "textcolor") {
1833                         docstring const color = parse_verbatim_item();
1834                         cell->push_back(MathAtom(new InsetMathColor(buf, false, color)));
1835                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1836                 }
1837
1838                 else if (t.cs() == "normalcolor") {
1839                         cell->push_back(createInsetMath(t.cs(), buf));
1840                         parse(cell->back().nucleus()->cell(0), flags, mode);
1841                         return success_;
1842                 }
1843
1844                 else if (t.cs() == "substack") {
1845                         cell->push_back(createInsetMath(t.cs(), buf));
1846                         parse2(cell->back(), FLAG_ITEM, mode, false);
1847                         // Delete empty last row if present
1848                         InsetMathGrid & subgrid =
1849                                 *(cell->back().nucleus()->asGridInset());
1850                         if (subgrid.nrows() > 1)
1851                                 delEmptyLastRow(subgrid);
1852                 }
1853
1854                 else if (t.cs() == "xymatrix") {
1855                         odocstringstream os;
1856                         while (good() && nextToken().cat() != catBegin)
1857                                 os << getToken().asInput();
1858                         cell->push_back(createInsetMath(t.cs() + os.str(), buf));
1859                         parse2(cell->back(), FLAG_ITEM, mode, false);
1860                         // Delete empty last row if present
1861                         InsetMathGrid & subgrid =
1862                                 *(cell->back().nucleus()->asGridInset());
1863                         if (subgrid.nrows() > 1)
1864                                 delEmptyLastRow(subgrid);
1865                 }
1866
1867                 else if (t.cs() == "Diagram") {
1868                         odocstringstream os;
1869                         while (good() && nextToken().cat() != catBegin)
1870                                 os << getToken().asInput();
1871                         cell->push_back(createInsetMath(t.cs() + os.str(), buf));
1872                         parse2(cell->back(), FLAG_ITEM, mode, false);
1873                 }
1874
1875                 else if (t.cs() == "framebox" || t.cs() == "makebox") {
1876                         cell->push_back(createInsetMath(t.cs(), buf));
1877                         parse(cell->back().nucleus()->cell(0), FLAG_OPTION, InsetMath::TEXT_MODE);
1878                         parse(cell->back().nucleus()->cell(1), FLAG_OPTION, InsetMath::TEXT_MODE);
1879                         parse(cell->back().nucleus()->cell(2), FLAG_ITEM, InsetMath::TEXT_MODE);
1880                 }
1881
1882                 else if (t.cs() == "tag") {
1883                         if (nextToken().character() == '*') {
1884                                 getToken();
1885                                 cell->push_back(createInsetMath(t.cs() + '*', buf));
1886                         } else
1887                                 cell->push_back(createInsetMath(t.cs(), buf));
1888                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1889                 }
1890
1891                 else if (t.cs() == "hspace") {
1892                         bool const prot =  nextToken().character() == '*';
1893                         if (prot)
1894                                 getToken();
1895                         docstring const name = t.cs();
1896                         docstring const arg = parse_verbatim_item();
1897                         Length length;
1898                         if (prot && arg == "\\fill")
1899                                 cell->push_back(MathAtom(new InsetMathSpace("hspace*{\\fill}", "")));
1900                         else if (isValidLength(to_utf8(arg), &length))
1901                                 cell->push_back(MathAtom(new InsetMathSpace(length, prot)));
1902                         else {
1903                                 // Since the Length class cannot use length variables
1904                                 // we must not create an InsetMathSpace.
1905                                 cell->push_back(MathAtom(new InsetMathMacro(buf, name)));
1906                                 MathData ar;
1907                                 mathed_parse_cell(ar, '{' + arg + '}', mode_);
1908                                 cell->append(ar);
1909                         }
1910                 }
1911
1912                 else if (t.cs() == "smash") {
1913                         skipSpaces();
1914                         if (nextToken().asInput() == "[") {
1915                                 // Since the phantom inset cannot handle optional arguments
1916                                 // other than b and t, we must not create an InsetMathPhantom
1917                                 // if opt is different from b and t (bug 8967).
1918                                 docstring const opt = parse_verbatim_option();
1919                                 if (opt == "t" || opt == "b") {
1920                                         cell->push_back(createInsetMath(t.cs() + opt, buf));
1921                                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1922                                 } else {
1923                                         docstring const arg = parse_verbatim_item();
1924                                         cell->push_back(MathAtom(new InsetMathMacro(buf, t.cs())));
1925                                         MathData ar;
1926                                         mathed_parse_cell(ar, '[' + opt + ']', mode_);
1927                                         cell->append(ar);
1928                                         ar = MathData();
1929                                         mathed_parse_cell(ar, '{' + arg + '}', mode_);
1930                                         cell->append(ar);
1931                                 }
1932                         }
1933                         else {
1934                                 cell->push_back(createInsetMath(t.cs(), buf));
1935                                 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1936                         }
1937                 }
1938
1939 #if 0
1940                 else if (t.cs() == "infer") {
1941                         MathData ar;
1942                         parse(ar, FLAG_OPTION, mode);
1943                         cell->push_back(createInsetMath(t.cs(), buf));
1944                         parse2(cell->back(), FLAG_ITEM, mode, false);
1945                 }
1946 #endif
1947
1948                 else if (t.cs() == "lyxmathsym") {
1949                         skipSpaces();
1950                         if (getToken().cat() != catBegin) {
1951                                 error("'{' expected in \\" + t.cs());
1952                                 return success_;
1953                         }
1954                         int count = 0;
1955                         docstring cmd;
1956                         CatCode cat = nextToken().cat();
1957                         while (good() && (count || cat != catEnd)) {
1958                                 if (cat == catBegin)
1959                                         ++count;
1960                                 else if (cat == catEnd)
1961                                         --count;
1962                                 cmd += getToken().asInput();
1963                                 cat = nextToken().cat();
1964                         }
1965                         if (getToken().cat() != catEnd) {
1966                                 error("'}' expected in \\" + t.cs());
1967                                 return success_;
1968                         }
1969                         bool termination;
1970                         docstring rem;
1971                         do {
1972                                 cmd = Encodings::fromLaTeXCommand(cmd,
1973                                         Encodings::MATH_CMD | Encodings::TEXT_CMD,
1974                                         termination, rem);
1975                                 for (size_t i = 0; i < cmd.size(); ++i)
1976                                         cell->push_back(MathAtom(new InsetMathChar(cmd[i])));
1977                                 if (!rem.empty()) {
1978                                         char_type c = rem[0];
1979                                         cell->push_back(MathAtom(new InsetMathChar(c)));
1980                                         cmd = rem.substr(1);
1981                                         rem.clear();
1982                                 } else
1983                                         cmd.clear();
1984                         } while (!cmd.empty());
1985                 }
1986
1987                 else if (!t.cs().empty()) {
1988                         bool const no_mhchem =
1989                                 (t.cs() == "ce" || t.cs() == "cf")
1990                                 && buf && buf->params().use_package("mhchem") ==
1991                                                 BufferParams::package_off;
1992
1993                         bool const is_user_macro = no_mhchem ||
1994                                 (buf && (mode_ & Parse::TRACKMACRO
1995                                          ? buf->usermacros.count(t.cs()) != 0
1996                                          : buf->getMacro(t.cs(), false) != 0));
1997
1998                         latexkeys const * l = in_word_set(t.cs());
1999                         if (l && !is_user_macro) {
2000                                 if (l->inset == "big") {
2001                                         skipSpaces();
2002                                         docstring const delim = getToken().asInput();
2003                                         if (InsetMathBig::isBigInsetDelim(delim))
2004                                                 cell->push_back(MathAtom(
2005                                                         new InsetMathBig(t.cs(), delim)));
2006                                         else {
2007                                                 cell->push_back(createInsetMath(t.cs(), buf));
2008                                                 // For some reason delim.empty()
2009                                                 // is always false here
2010                                                 if (delim.at(0))
2011                                                         putback();
2012                                         }
2013                                 }
2014
2015                                 else if (l->inset == "font") {
2016                                         cell->push_back(createInsetMath(t.cs(), buf));
2017                                         parse(cell->back().nucleus()->cell(0),
2018                                                 FLAG_ITEM, asMode(mode, l->extra));
2019                                 }
2020
2021                                 else if (l->inset == "oldfont") {
2022                                         cell->push_back(createInsetMath(t.cs(), buf));
2023                                         parse(cell->back().nucleus()->cell(0),
2024                                                 flags | FLAG_ALIGN, asMode(mode, l->extra));
2025                                         if (prevToken().cat() != catAlign &&
2026                                             prevToken().cs() != "\\")
2027                                                 return success_;
2028                                         putback();
2029                                 }
2030
2031                                 else if (l->inset == "style") {
2032                                         cell->push_back(createInsetMath(t.cs(), buf));
2033                                         parse(cell->back().nucleus()->cell(0),
2034                                                 flags | FLAG_ALIGN, mode);
2035                                         if (prevToken().cat() != catAlign &&
2036                                             prevToken().cs() != "\\")
2037                                                 return success_;
2038                                         putback();
2039                                 }
2040
2041                                 else if (l->inset == "underset" || l->inset == "overset") {
2042                                         cell->push_back(createInsetMath(t.cs(), buf));
2043                                         parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
2044                                         parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
2045                                 }
2046
2047                                 else {
2048                                         MathAtom at = createInsetMath(t.cs(), buf);
2049                                         for (InsetMath::idx_type i = 0; i < at->nargs(); ++i)
2050                                                 parse(at.nucleus()->cell(i),
2051                                                         FLAG_ITEM, asMode(mode, l->extra));
2052                                         cell->push_back(at);
2053                                 }
2054                         }
2055
2056                         else {
2057                                 bool is_unicode_symbol = false;
2058                                 if (mode == InsetMath::TEXT_MODE && !is_user_macro) {
2059                                         int num_tokens = 0;
2060                                         docstring cmd = prevToken().asInput();
2061                                         CatCode cat = nextToken().cat();
2062                                         if (cat == catBegin) {
2063                                                 int count = 0;
2064                                                 while (good() && (count || cat != catEnd)) {
2065                                                         cat = nextToken().cat();
2066                                                         cmd += getToken().asInput();
2067                                                         ++num_tokens;
2068                                                         if (cat == catBegin)
2069                                                                 ++count;
2070                                                         else if (cat == catEnd)
2071                                                                 --count;
2072                                                 }
2073                                         }
2074                                         bool is_combining;
2075                                         bool termination;
2076                                         char_type c = Encodings::fromLaTeXCommand(cmd,
2077                                                 Encodings::MATH_CMD | Encodings::TEXT_CMD,
2078                                                 is_combining, termination);
2079                                         if (is_combining) {
2080                                                 if (cat == catLetter)
2081                                                         cmd += '{';
2082                                                 cmd += getToken().asInput();
2083                                                 ++num_tokens;
2084                                                 if (cat == catLetter)
2085                                                         cmd += '}';
2086                                                 c = Encodings::fromLaTeXCommand(cmd,
2087                                                         Encodings::MATH_CMD | Encodings::TEXT_CMD,
2088                                                         is_combining, termination);
2089                                         }
2090                                         if (c) {
2091                                                 if (termination) {
2092                                                         if (nextToken().cat() == catBegin) {
2093                                                                 getToken();
2094                                                                 if (nextToken().cat() == catEnd) {
2095                                                                         getToken();
2096                                                                         num_tokens += 2;
2097                                                                 } else
2098                                                                         putback();
2099                                                         } else {
2100                                                                 while (nextToken().cat() == catSpace) {
2101                                                                         getToken();
2102                                                                         ++num_tokens;
2103                                                                 }
2104                                                         }
2105                                                 }
2106                                                 is_unicode_symbol = true;
2107                                                 cell->push_back(MathAtom(new InsetMathChar(c)));
2108                                         } else {
2109                                                 while (num_tokens--)
2110                                                         putback();
2111                                         }
2112                                 }
2113                                 if (!is_unicode_symbol) {
2114                                         MathAtom at = is_user_macro ?
2115                                                 MathAtom(new InsetMathMacro(buf, t.cs()))
2116                                                 : createInsetMath(t.cs(), buf);
2117                                         InsetMath::mode_type m = mode;
2118                                         //if (m == InsetMath::UNDECIDED_MODE)
2119                                         //lyxerr << "default creation: m1: " << m << endl;
2120                                         if (at->currentMode() != InsetMath::UNDECIDED_MODE)
2121                                                 m = at->currentMode();
2122                                         //lyxerr << "default creation: m2: " << m << endl;
2123                                         InsetMath::idx_type start = 0;
2124                                         // this fails on \bigg[...\bigg]
2125                                         //MathData opt;
2126                                         //parse(opt, FLAG_OPTION, InsetMath::VERBATIM_MODE);
2127                                         //if (!opt.empty()) {
2128                                         //      start = 1;
2129                                         //      at.nucleus()->cell(0) = opt;
2130                                         //}
2131                                         for (InsetMath::idx_type i = start; i < at->nargs(); ++i) {
2132                                                 parse(at.nucleus()->cell(i), FLAG_ITEM, m);
2133                                                 if (mode == InsetMath::MATH_MODE)
2134                                                         skipSpaces();
2135                                         }
2136                                         cell->push_back(at);
2137                                 }
2138                         }
2139                 }
2140
2141
2142                 if (flags & FLAG_LEAVE) {
2143                         flags &= ~FLAG_LEAVE;
2144                         break;
2145                 }
2146         }
2147         return success_;
2148 }
2149
2150
2151
2152 } // anonymous namespace
2153
2154
2155 // FIXME This will likely need some work.
2156 char const * latexkeys::MathMLtype() const
2157 {
2158         if (extra == "mathord")
2159                 return "mi";
2160         return "mo";
2161 }
2162
2163
2164 bool mathed_parse_cell(MathData & ar, docstring const & str, Parse::flags f)
2165 {
2166         return Parser(str, f, ar.buffer()).parse(ar, 0, f & Parse::TEXTMODE ?
2167                                 InsetMath::TEXT_MODE : InsetMath::MATH_MODE);
2168 }
2169
2170
2171 bool mathed_parse_cell(MathData & ar, istream & is, Parse::flags f)
2172 {
2173         return Parser(is, f, ar.buffer()).parse(ar, 0, f & Parse::TEXTMODE ?
2174                                 InsetMath::TEXT_MODE : InsetMath::MATH_MODE);
2175 }
2176
2177
2178 bool mathed_parse_normal(Buffer * buf, MathAtom & t, docstring const & str,
2179                          Parse::flags f)
2180 {
2181         return Parser(str, f, buf).parse(t);
2182 }
2183
2184
2185 bool mathed_parse_normal(Buffer * buf, MathAtom & t, Lexer & lex,
2186                          Parse::flags f)
2187 {
2188         return Parser(lex, f, buf).parse(t);
2189 }
2190
2191
2192 bool mathed_parse_normal(InsetMathGrid & grid, docstring const & str,
2193                          Parse::flags f)
2194 {
2195         return Parser(str, f, &grid.buffer()).parse1(grid, 0, f & Parse::TEXTMODE ?
2196                         InsetMath::TEXT_MODE : InsetMath::MATH_MODE, false);
2197 }
2198
2199
2200 void initParser()
2201 {
2202         fill(theCatcode, theCatcode + 128, catOther);
2203         fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
2204         fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
2205
2206         theCatcode[int('\\')] = catEscape;
2207         theCatcode[int('{')]  = catBegin;
2208         theCatcode[int('}')]  = catEnd;
2209         theCatcode[int('$')]  = catMath;
2210         theCatcode[int('&')]  = catAlign;
2211         theCatcode[int('\n')] = catNewline;
2212         theCatcode[int('#')]  = catParameter;
2213         theCatcode[int('^')]  = catSuper;
2214         theCatcode[int('_')]  = catSub;
2215         theCatcode[int(0x7f)] = catIgnore;
2216         theCatcode[int(' ')]  = catSpace;
2217         theCatcode[int('\t')] = catSpace;
2218         theCatcode[int('\r')] = catNewline;
2219         theCatcode[int('~')]  = catActive;
2220         theCatcode[int('%')]  = catComment;
2221 }
2222
2223
2224 } // namespace lyx