3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
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:
20 \def\makeamptab{\catcode`\&=4\relax}
21 \def\makeampletter{\catcode`\&=11\relax}
22 \def\b{\makeampletter\expandafter\makeamptab\bi}
40 #include "MathParser.h"
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"
73 #include "BufferParams.h"
77 #include "support/convert.h"
78 #include "support/debug.h"
79 #include "support/docstream.h"
91 InsetMath::mode_type asMode(InsetMath::mode_type oldmode, docstring const & str)
93 //lyxerr << "handling mode: '" << str << "'" << endl;
94 if (str == "mathmode")
95 return InsetMath::MATH_MODE;
96 if (str == "textmode" || str == "forcetext")
97 return InsetMath::TEXT_MODE;
102 bool stared(docstring const & s)
104 size_t const n = s.size();
105 return n && s[n - 1] == '*';
109 docstring const repl(docstring const & oldstr, char_type const c,
110 docstring const & macro, bool textmode = false)
116 for (i = 0, j = 0; i < oldstr.size(); ++i) {
117 if (c == oldstr[i]) {
118 newstr.append(oldstr, j, i - j);
119 newstr.append(macro);
121 if (macro.size() > 2 && j < oldstr.size())
122 newstr += (textmode && oldstr[j] == ' ' ? '\\' : ' ');
130 newstr.append(oldstr, j, i - j);
135 docstring escapeSpecialChars(docstring const & str, bool textmode)
137 docstring const backslash = textmode ? from_ascii("\\textbackslash")
138 : from_ascii("\\backslash");
139 docstring const caret = textmode ? from_ascii("\\textasciicircum")
140 : from_ascii("\\mathcircumflex");
141 docstring const tilde = textmode ? from_ascii("\\textasciitilde")
142 : from_ascii("\\sim");
144 return repl(repl(repl(repl(repl(repl(repl(repl(repl(repl(str,
145 '\\', backslash, textmode),
146 '^', caret, textmode),
147 '~', tilde, textmode),
148 '_', from_ascii("\\_")),
149 '$', from_ascii("\\$")),
150 '#', from_ascii("\\#")),
151 '&', from_ascii("\\&")),
152 '%', from_ascii("\\%")),
153 '{', from_ascii("\\{")),
154 '}', from_ascii("\\}"));
159 * Add the row \p cellrow to \p grid.
160 * \returns whether the row could be added. Adding a row can fail for
161 * environments like "equation" that have a fixed number of rows.
163 bool addRow(InsetMathGrid & grid, row_type & cellrow,
164 docstring const & vskip, bool allow_newpage = true)
167 if (cellrow == grid.nrows()) {
168 //lyxerr << "adding row " << cellrow << endl;
169 grid.addRow(cellrow - 1);
170 if (cellrow == grid.nrows()) {
171 // We can't add a row to this grid, so let's
172 // append the content of this cell to the previous
174 // This does not happen in well formed .lyx files,
175 // but LyX versions 1.3.x and older could create
176 // such files and tex2lyx can still do that.
178 lyxerr << "ignoring extra row";
180 lyxerr << " with extra space " << to_utf8(vskip);
182 lyxerr << " with no page break allowed";
183 lyxerr << '.' << endl;
187 grid.vcrskip(Length(to_utf8(vskip)), cellrow - 1);
188 grid.rowinfo(cellrow - 1).allow_newpage = allow_newpage;
194 * Add the column \p cellcol to \p grid.
195 * \returns whether the column could be added. Adding a column can fail for
196 * environments like "eqnarray" that have a fixed number of columns.
198 bool addCol(InsetMathGrid & grid, col_type & cellcol)
201 if (cellcol == grid.ncols()) {
202 //lyxerr << "adding column " << cellcol << endl;
203 grid.addCol(cellcol);
204 if (cellcol == grid.ncols()) {
205 // We can't add a column to this grid, so let's
206 // append the content of this cell to the previous
208 // This does not happen in well formed .lyx files,
209 // but LyX versions 1.3.x and older could create
210 // such files and tex2lyx can still do that.
212 lyxerr << "ignoring extra column." << endl;
221 * Check whether the last row is empty and remove it if yes.
222 * Otherwise the following code
230 * will result in a grid with 3 rows (+ the dummy row that is always present),
231 * because the last '\\' opens a new row.
232 * Do never delete a row that contains a multicolumn, even if all cells empty,
233 * since the multicolumn information would get lost otherwise.
234 * Note that this is only needed for inner-hull grid types, such as array
235 * or aligned, but not for outer-hull grid types, such as eqnarray or align.
237 void delEmptyLastRow(InsetMathGrid & grid)
239 row_type const row = grid.nrows() - 1;
240 for (col_type col = 0; col < grid.ncols(); ++col) {
241 idx_type const idx = grid.index(row, col);
242 if (!grid.cell(idx).empty() ||
243 grid.cellinfo(idx).multi != InsetMathGrid::CELL_NORMAL)
246 // Copy the row information of the empty row (which would contain the
247 // last hline in the example above) to the dummy row and delete the
249 grid.rowinfo(row + 1) = grid.rowinfo(row);
255 * Tell whether the environment name corresponds to an inner-hull grid type.
257 bool innerHull(docstring const & name)
259 // For [bB]matrix, [vV]matrix, and pmatrix we can check the suffix only
260 return name == "array" || name == "cases" || name == "aligned"
261 || name == "alignedat" || name == "gathered" || name == "split"
262 || name == "subarray" || name == "tabular" || name == "matrix"
263 || name == "smallmatrix" || name.substr(1) == "matrix";
267 // These are TeX's catcodes
269 catEscape, // 0 backslash
279 catSpace, // 10 space
280 catLetter, // 11 a-zA-Z
281 catOther, // 12 none of the above
284 catInvalid // 15 <delete>
287 CatCode theCatcode[128];
290 inline CatCode catcode(char_type c)
292 /* The only characters that are not catOther lie in the pure ASCII
293 * range. Therefore theCatcode has only 128 entries.
294 * TeX itself deals with 8bit characters, so if needed this table
295 * could be enlarged to 256 entries.
296 * Any larger value does not make sense, since the fact that we use
297 * unicode internally does not change Knuth's TeX engine.
298 * Apart from that a table for the full 21bit UCS4 range would waste
299 * too much memory. */
303 return theCatcode[c];
308 FLAG_ALIGN = 1 << 0, // next & or \\ ends the parsing process
309 FLAG_BRACE_LAST = 1 << 1, // next closing brace ends the parsing
310 FLAG_RIGHT = 1 << 2, // next \\right ends the parsing process
311 FLAG_END = 1 << 3, // next \\end ends the parsing process
312 FLAG_BRACK_LAST = 1 << 4, // next closing bracket ends the parsing
313 FLAG_TEXTMODE = 1 << 5, // we are in a box
314 FLAG_ITEM = 1 << 6, // read a (possibly braced) token
315 FLAG_LEAVE = 1 << 7, // leave the loop at the end
316 FLAG_SIMPLE = 1 << 8, // next $ leaves the loop
317 FLAG_EQUATION = 1 << 9, // next \] leaves the loop
318 FLAG_SIMPLE2 = 1 << 10, // next \) leaves the loop
319 FLAG_OPTION = 1 << 11, // read [...] style option
320 FLAG_BRACED = 1 << 12 // read {...} style argument
325 // Helper class for parsing
331 Token() : cs_(), char_(0), cat_(catIgnore) {}
333 Token(char_type c, CatCode cat) : cs_(), char_(c), cat_(cat) {}
335 explicit Token(docstring const & cs) : cs_(cs), char_(0), cat_(catIgnore) {}
338 docstring const & cs() const { return cs_; }
340 CatCode cat() const { return cat_; }
342 char_type character() const { return char_; }
344 docstring asString() const { return !cs_.empty() ? cs_ : docstring(1, char_); }
346 docstring asInput() const { return !cs_.empty() ? '\\' + cs_ : docstring(1, char_); }
358 ostream & operator<<(ostream & os, Token const & t)
360 if (!t.cs().empty()) {
361 docstring const & cs = t.cs();
362 // FIXME: For some strange reason, the stream operator instantiate
363 // a new Token before outputting the contents of t.cs().
364 // Because of this the line
366 // below becomes recursive.
367 // In order to avoid that we return early:
370 os << '\\' << to_utf8(cs);
372 else if (t.cat() == catLetter)
373 os << static_cast<uint32_t>(t.character());
375 os << '[' << static_cast<uint32_t>(t.character()) << ',' << t.cat() << ']';
383 typedef InsetMath::mode_type mode_type;
385 typedef Parse::flags parse_mode;
388 Parser(Lexer & lex, parse_mode mode, Buffer * buf);
389 /// Only use this for reading from .lyx file format, for the reason
390 /// see Parser::tokenize(istream &).
391 Parser(istream & is, parse_mode mode, Buffer * buf);
393 Parser(docstring const & str, parse_mode mode, Buffer * buf);
396 bool parse(MathAtom & at);
398 bool parse(MathData & array, unsigned flags, mode_type mode);
400 bool parse1(InsetMathGrid & grid, unsigned flags, mode_type mode,
403 int lineno() const { return lineno_; }
406 /// store current position
408 /// restore previous position
410 /// forget last saved position
415 void parse2(MathAtom & at, unsigned flags, mode_type mode, bool numbered);
416 /// get arg delimited by 'left' and 'right'
417 docstring getArg(char_type left, char_type right);
421 void error(string const & msg);
422 void error(docstring const & msg) { error(to_utf8(msg)); }
423 /// dump contents to screen
425 /// Only use this for reading from .lyx file format (see
426 /// implementation for reason)
427 void tokenize(istream & is);
429 void tokenize(docstring const & s);
431 void skipSpaceTokens(idocstream & is, char_type c);
433 void push_back(Token const & t);
435 Token const & prevToken() const;
437 Token const & nextToken() const;
439 Token const & getToken();
440 /// skips spaces if any
443 void lex(docstring const & s);
447 docstring parse_verbatim_item();
449 docstring parse_verbatim_option();
454 vector<Token> tokens_;
458 std::vector<unsigned> positions_;
459 /// Stack of active environments
460 vector<docstring> environments_;
470 Parser::Parser(Lexer & lexer, parse_mode mode, Buffer * buf)
471 : lineno_(lexer.lineNumber()), pos_(0), mode_(mode), success_(true),
474 tokenize(lexer.getStream());
479 Parser::Parser(istream & is, parse_mode mode, Buffer * buf)
480 : lineno_(0), pos_(0), mode_(mode), success_(true), buffer_(buf)
486 Parser::Parser(docstring const & str, parse_mode mode, Buffer * buf)
487 : lineno_(0), pos_(0), mode_(mode), success_(true), buffer_(buf)
493 void Parser::push_back(Token const & t)
495 tokens_.push_back(t);
499 Token const & Parser::prevToken() const
501 static const Token dummy;
502 return pos_ > 0 ? tokens_[pos_ - 1] : dummy;
506 Token const & Parser::nextToken() const
508 static const Token dummy;
509 return good() ? tokens_[pos_] : dummy;
513 Token const & Parser::getToken()
515 static const Token dummy;
516 //lyxerr << "looking at token " << tokens_[pos_] << " pos: " << pos_ << endl;
517 return good() ? tokens_[pos_++] : dummy;
521 void Parser::skipSpaces()
523 while (nextToken().cat() == catSpace || nextToken().cat() == catNewline)
528 void Parser::putback()
534 void Parser::pushPosition()
536 positions_.push_back(pos_);
540 void Parser::popPosition()
542 pos_ = positions_.back();
543 positions_.pop_back();
547 void Parser::dropPosition()
549 positions_.pop_back();
553 bool Parser::good() const
555 return pos_ < tokens_.size();
559 char_type Parser::getChar()
562 error("The input stream is not well...");
565 return tokens_[pos_++].character();
569 docstring Parser::getArg(char_type left, char_type right)
577 char_type c = getChar();
582 while ((c = getChar()) != right && good())
589 void Parser::skipSpaceTokens(idocstream & is, char_type c)
591 // skip trailing spaces
592 while (catcode(c) == catSpace || catcode(c) == catNewline)
595 //lyxerr << "putting back: " << c << endl;
600 void Parser::tokenize(istream & is)
602 // eat everything up to the next \end_inset or end of stream
603 // and store it in s for further tokenization
608 if (s.size() >= 10 && s.substr(s.size() - 10) == "\\end_inset") {
609 s = s.substr(0, s.size() - 10);
613 // Remove the space after \end_inset
614 if (is.get(c) && c != ' ')
618 tokenize(from_utf8(s));
622 void Parser::tokenize(docstring const & buffer)
624 idocstringstream is((mode_ & Parse::VERBATIM)
625 ? escapeSpecialChars(buffer, mode_ & Parse::TEXTMODE)
626 : buffer, ios::in | ios::binary);
630 //lyxerr << "reading c: " << c << endl;
632 switch (catcode(c)) {
636 if (catcode(c) == catNewline)
637 ; //push_back(Token("par"));
639 push_back(Token('\n', catNewline));
647 while (is.get(c) && catcode(c) != catNewline)
657 error("unexpected end of input");
662 if (catcode(c) == catLetter) {
664 while (is.get(c) && catcode(c) == catLetter)
666 skipSpaceTokens(is, c);
675 push_back(Token(c, catcode(c)));
677 skipSpaceTokens(is, c);
682 if (!(mode_ & Parse::QUIET))
683 lyxerr << "ignoring a char: " << int(c) << endl;
688 push_back(Token(c, catcode(c)));
698 void Parser::dump() const
700 lyxerr << "\nTokens: ";
701 for (unsigned i = 0; i < tokens_.size(); ++i) {
704 lyxerr << tokens_[i];
706 lyxerr << " pos: " << pos_ << endl;
710 void Parser::error(string const & msg)
713 if (!(mode_ & Parse::QUIET)) {
714 lyxerr << "Line ~" << lineno_ << ": Math parse error: "
721 bool Parser::parse(MathAtom & at)
724 MathData ar(buffer_);
725 parse(ar, false, InsetMath::UNDECIDED_MODE);
726 if (ar.size() != 1 || ar.front()->getType() == hullNone) {
727 if (!(mode_ & Parse::QUIET))
728 lyxerr << "unusual contents found: " << ar << endl;
729 at = MathAtom(new InsetMathPar(buffer_, ar));
730 //if (at->nargs() > 0)
731 // at.nucleus()->cell(0) = ar;
733 // lyxerr << "unusual contents found: " << ar << endl;
741 docstring Parser::parse_verbatim_option()
745 if (nextToken().character() == '[') {
748 for (Token t = getToken(); t.character() != ']' && good(); t = getToken()) {
749 if (t.cat() == catBegin) {
751 res += '{' + parse_verbatim_item() + '}';
760 docstring Parser::parse_verbatim_item()
764 if (nextToken().cat() == catBegin) {
767 for (Token t = getToken(); t.cat() != catEnd && good(); t = getToken()) {
768 if (t.cat() == catBegin) {
770 res += '{' + parse_verbatim_item() + '}';
780 bool Parser::parse(MathData & array, unsigned flags, mode_type mode)
782 InsetMathGrid grid(buffer_, 1, 1);
783 parse1(grid, flags, mode, false);
784 array = grid.cell(0);
789 void Parser::parse2(MathAtom & at, const unsigned flags, const mode_type mode,
792 parse1(*(at.nucleus()->asGridInset()), flags, mode, numbered);
796 bool Parser::parse1(InsetMathGrid & grid, unsigned flags,
797 const mode_type mode, const bool numbered)
799 row_type cellrow = 0;
800 col_type cellcol = 0;
801 MathData * cell = &grid.cell(grid.index(cellrow, cellcol));
802 Buffer * buf = buffer_;
804 if (grid.asHullInset())
805 grid.asHullInset()->numbered(cellrow, numbered);
808 //lyxerr << " flags: " << flags << endl;
809 //lyxerr << " mode: " << mode << endl;
810 //lyxerr << "grid: " << grid << endl;
813 Token const & t = getToken();
816 lyxerr << "t: " << t << " flags: " << flags << endl;
817 lyxerr << "mode: " << mode << endl;
822 if (flags & FLAG_ITEM) {
824 if (t.cat() == catBegin) {
825 // skip the brace and collect everything to the next matching
827 parse1(grid, FLAG_BRACE_LAST, mode, numbered);
831 // handle only this single token, leave the loop if done
836 if (flags & FLAG_BRACED) {
837 if (t.cat() == catSpace)
840 if (t.cat() != catBegin) {
841 error("opening brace expected");
845 // skip the brace and collect everything to the next matching
847 flags = FLAG_BRACE_LAST;
851 if (flags & FLAG_OPTION) {
852 if (t.cat() == catOther && t.character() == '[') {
854 parse(ar, FLAG_BRACK_LAST, mode);
857 // no option found, put back token and we are done
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
877 // This is not an outer hull and display math is
878 // not allowed inside text mode environments.
879 error("bad math environment $$");
883 // simple $...$ stuff
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);
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);
896 else if (flags & FLAG_SIMPLE) {
897 // this is the end of the formula
902 Token const & n = getToken();
903 if (n.cat() == catMath) {
904 error("something strange in the parser");
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.
912 cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
913 parse(cell->back().nucleus()->cell(0), FLAG_SIMPLE, InsetMath::MATH_MODE);
918 else if (t.cat() == catLetter)
919 cell->push_back(MathAtom(new InsetMathChar(t.character())));
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())));
926 else if (t.cat() == catNewline && mode != InsetMath::MATH_MODE) {
927 if (cell->empty() || cell->back()->getChar() != ' ')
928 cell->push_back(MathAtom(new InsetMathChar(' ')));
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')));
938 cell->push_back(MathAtom(new InsetMathHash()));
941 else if (t.cat() == catActive)
942 cell->push_back(MathAtom(new InsetMathSpace(string(1, t.character()), "")));
944 else if (t.cat() == catBegin) {
946 parse(ar, FLAG_BRACE_LAST, mode);
947 // do not create a BraceInset if they were written by LyX
948 // this helps to keep the annoyance of "a choose b" to a minimum
949 if (ar.size() == 1 && ar[0]->extraBraces())
952 cell->push_back(MathAtom(new InsetMathBrace(ar)));
955 else if (t.cat() == catEnd) {
956 if (flags & FLAG_BRACE_LAST)
958 error("found '}' unexpectedly");
959 //LASSERT(false, /**/);
960 //add(cell, '}', LM_TC_TEX);
963 else if (t.cat() == catAlign) {
964 //lyxerr << " column now " << (cellcol + 1)
965 // << " max: " << grid.ncols() << endl;
966 if (flags & FLAG_ALIGN)
968 if (addCol(grid, cellcol))
969 cell = &grid.cell(grid.index(cellrow, cellcol));
972 else if (t.cat() == catSuper || t.cat() == catSub) {
973 bool up = (t.cat() == catSuper);
974 // we need no new script inset if the last thing was a scriptinset,
975 // which has that script already not the same script already
977 cell->push_back(MathAtom(new InsetMathScript(buf, up)));
978 else if (cell->back()->asScriptInset() &&
979 !cell->back()->asScriptInset()->has(up))
980 cell->back().nucleus()->asScriptInset()->ensure(up);
981 else if (cell->back()->asScriptInset())
982 cell->push_back(MathAtom(new InsetMathScript(buf, up)));
984 cell->back() = MathAtom(new InsetMathScript(buf, cell->back(), up));
985 InsetMathScript * p = cell->back().nucleus()->asScriptInset();
986 // special handling of {}-bases
987 // Here we could remove the brace inset for things
988 // like {a'}^2 and add the braces back in
989 // InsetMathScript::write().
990 // We do not do it, since it is not possible to detect
991 // reliably whether the braces are needed because the
992 // nucleus contains more than one symbol, or whether
993 // they are needed for unknown commands like \xx{a}_0
994 // or \yy{a}{b}_0. This was done in revision 14819
995 // in an unreliable way. See this thread
996 // http://www.mail-archive.com/lyx-devel%40lists.lyx.org/msg104917.html
998 // However, we remove empty braces because they look
999 // ugly on screen and we are sure that they were added
1000 // by the write() method (and will be re-added on save).
1001 if (p->nuc().size() == 1 &&
1002 p->nuc().back()->asBraceInset() &&
1003 p->nuc().back()->asBraceInset()->cell(0).empty())
1006 parse(p->cell(p->idxOfScript(up)), FLAG_ITEM, mode);
1009 else if (t.character() == ']' && (flags & FLAG_BRACK_LAST)) {
1010 //lyxerr << "finished reading option" << endl;
1014 else if (t.cat() == catOther) {
1015 char_type c = t.character();
1016 if (!Encodings::isUnicodeTextOnly(c)
1017 || mode_ & Parse::VERBATIM
1018 || !(mode_ & Parse::USETEXT)
1019 || mode == InsetMath::TEXT_MODE) {
1020 cell->push_back(MathAtom(new InsetMathChar(c)));
1022 MathAtom at = createInsetMath("text", buf);
1023 at.nucleus()->cell(0).push_back(MathAtom(new InsetMathChar(c)));
1024 while (nextToken().cat() == catOther
1025 && Encodings::isUnicodeTextOnly(nextToken().character())) {
1026 c = getToken().character();
1027 at.nucleus()->cell(0).push_back(MathAtom(new InsetMathChar(c)));
1029 cell->push_back(at);
1033 else if (t.cat() == catComment) {
1036 Token const & tt = getToken();
1037 if (tt.cat() == catNewline)
1041 cell->push_back(MathAtom(new InsetMathComment(buf, s)));
1046 // control sequences
1049 else if (t.cs() == "lyxlock") {
1051 cell->back().nucleus()->lock(true);
1054 else if ((t.cs() == "global" && nextToken().cs() == "def") ||
1056 if (t.cs() == "global")
1060 docstring name = getToken().cs();
1065 while (good() && nextToken().cat() != catBegin) {
1066 pars += getToken().cs();
1073 parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1075 // is a version for display attached?
1078 if (nextToken().cat() == catBegin)
1079 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1081 cell->push_back(MathAtom(new InsetMathMacroTemplate(buf,
1082 name, nargs, 0, MacroTypeDef,
1083 vector<MathData>(), def, display)));
1085 if (buf && (mode_ & Parse::TRACKMACRO))
1086 buf->usermacros.insert(name);
1089 else if (t.cs() == "newcommand" ||
1090 t.cs() == "renewcommand" ||
1091 t.cs() == "newlyxcommand") {
1093 if (getToken().cat() != catBegin) {
1094 error("'{' in \\newcommand expected (1) ");
1097 docstring name = getToken().cs();
1098 if (getToken().cat() != catEnd) {
1099 error("'}' in \\newcommand expected");
1104 docstring const arg = getArg('[', ']');
1107 nargs = convert<int>(arg);
1109 // optional argument given?
1112 vector<MathData> optionalValues;
1113 while (nextToken().character() == '[') {
1115 optionalValues.push_back(MathData());
1116 parse(optionalValues[optionals], FLAG_BRACK_LAST, mode);
1121 parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1123 // is a version for display attached?
1126 if (nextToken().cat() == catBegin)
1127 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1129 cell->push_back(MathAtom(new InsetMathMacroTemplate(buf,
1130 name, nargs, optionals, MacroTypeNewcommand,
1131 optionalValues, def, display)));
1133 if (buf && (mode_ & Parse::TRACKMACRO))
1134 buf->usermacros.insert(name);
1137 else if (t.cs() == "newcommandx" ||
1138 t.cs() == "renewcommandx") {
1139 // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
1142 if (nextToken().cat() == catBegin) {
1144 name = getToken().cs();
1145 if (getToken().cat() != catEnd) {
1146 error("'}' in \\newcommandx expected");
1150 name = getToken().cs();
1153 docstring const arg = getArg('[', ']');
1155 error("[num] in \\newcommandx expected");
1158 int nargs = convert<int>(arg);
1162 vector<MathData> optionalValues;
1163 if (nextToken().character() == '[') {
1167 // handle 'opt=value' options, separated by ','.
1169 while (nextToken().character() != ']' && good()) {
1170 if (nextToken().character() >= '1'
1171 && nextToken().character() <= '9') {
1172 // optional value -> get parameter number
1173 int n = getChar() - '0';
1175 error("Arity of \\newcommandx too low "
1176 "for given optional parameter.");
1181 if (getToken().character() != '=') {
1182 error("'=' and optional parameter value "
1183 "expected for \\newcommandx");
1188 int optNum = max(size_t(n), optionalValues.size());
1189 optionalValues.resize(optNum);
1190 optionalValues[n - 1].clear();
1191 while (nextToken().character() != ']'
1192 && nextToken().character() != ',') {
1194 parse(data, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1195 optionalValues[n - 1].append(data);
1197 optionals = max(n, optionals);
1198 } else if (nextToken().cat() == catLetter) {
1199 // we in fact ignore every non-optional
1204 while (nextToken().cat() == catLetter)
1210 if (nextToken().character() == '=') {
1212 while (nextToken().character() != ']'
1213 && nextToken().character() != ',')
1214 parse(value, FLAG_ITEM,
1215 InsetMath::UNDECIDED_MODE);
1218 error("option for \\newcommandx expected");
1224 if (nextToken().character() == ',') {
1227 } else if (nextToken().character() != ']') {
1228 error("Expecting ',' or ']' in options "
1229 "of \\newcommandx");
1242 parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1244 // is a version for display attached?
1247 if (nextToken().cat() == catBegin)
1248 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1250 cell->push_back(MathAtom(new InsetMathMacroTemplate(buf,
1251 name, nargs, optionals, MacroTypeNewcommandx,
1252 optionalValues, def, display)));
1254 if (buf && (mode_ & Parse::TRACKMACRO))
1255 buf->usermacros.insert(name);
1258 else if (t.cs() == "(") {
1259 if (mode == InsetMath::UNDECIDED_MODE) {
1260 cell->push_back(MathAtom(new InsetMathHull(buf, hullSimple)));
1261 parse2(cell->back(), FLAG_SIMPLE2, InsetMath::MATH_MODE, false);
1263 // Don't create nested math hulls (bug #5392)
1264 cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
1265 parse(cell->back().nucleus()->cell(0), FLAG_SIMPLE2, InsetMath::MATH_MODE);
1269 else if (t.cs() == "[") {
1270 if (mode != InsetMath::UNDECIDED_MODE) {
1271 error("bad math environment [");
1274 cell->push_back(MathAtom(new InsetMathHull(buf, hullEquation)));
1275 parse2(cell->back(), FLAG_EQUATION, InsetMath::MATH_MODE, false);
1278 else if (t.cs() == "protect")
1279 // ignore \\protect, will hopefully be re-added during output
1282 else if (t.cs() == "end") {
1283 if (flags & FLAG_END) {
1284 // eat environment name
1285 docstring const name = getArg('{', '}');
1286 if (environments_.empty())
1287 error("'found \\end{" + name +
1288 "}' without matching '\\begin{" +
1290 else if (name != environments_.back())
1291 error("'\\end{" + name +
1292 "}' does not match '\\begin{" +
1293 environments_.back() + "}'");
1295 environments_.pop_back();
1296 // Delete empty last row in matrix
1298 // If you abuse InsetMathGrid for
1299 // non-matrix like structures you
1300 // probably need to refine this test.
1301 // Right now we only have to test for
1302 // single line hull insets.
1303 if (grid.nrows() > 1 && innerHull(name))
1304 delEmptyLastRow(grid);
1308 error("found 'end' unexpectedly");
1311 else if (t.cs() == ")") {
1312 if (flags & FLAG_SIMPLE2)
1314 error("found '\\)' unexpectedly");
1317 else if (t.cs() == "]") {
1318 if (flags & FLAG_EQUATION)
1320 error("found '\\]' unexpectedly");
1323 else if (t.cs() == "\\") {
1324 if (flags & FLAG_ALIGN)
1326 bool starred = false;
1328 if (nextToken().asInput() == "*") {
1331 } else if (nextToken().asInput() == "[")
1332 arg = getArg('[', ']');
1334 error("missing token after \\\\");
1335 // skip "{}" added in front of "[" (the
1336 // counterpart is in InsetMathGrid::eolString())
1337 // skip spaces because formula could come from tex2lyx
1338 bool skipBraces = false;
1340 if (nextToken().cat() == catBegin) {
1342 if (nextToken().cat() == catEnd) {
1346 if (nextToken().asInput() == "[")
1355 bool const added = addRow(grid, cellrow, arg, !starred);
1358 if (grid.asHullInset())
1359 grid.asHullInset()->numbered(
1361 cell = &grid.cell(grid.index(cellrow,
1366 else if (t.cs() == "multicolumn" && grid.handlesMulticolumn()) {
1367 // if the columns are specified numerically,
1368 // extract column count and insert dummy cells,
1369 // otherwise parse it as an user macro
1371 parse(count, FLAG_ITEM, mode);
1373 // limit arbitrarily to 100 columns
1374 if (extractNumber(count, cols) && cols > 0 && cols < 100) {
1375 // resize the table if necessary
1376 size_t first = grid.index(cellrow, cellcol);
1377 for (int i = 1; i < cols; ++i) {
1378 if (addCol(grid, cellcol)) {
1379 size_t const idx = grid.index(cellrow, cellcol);
1380 grid.cellinfo(idx).multi =
1381 InsetMathGrid::CELL_PART_OF_MULTICOLUMN;
1385 // the first cell is the real thing, not a dummy
1386 cell = &grid.cell(first);
1387 grid.cellinfo(first).multi =
1388 InsetMathGrid::CELL_BEGIN_OF_MULTICOLUMN;
1390 // read special alignment
1392 parse(align, FLAG_ITEM, mode);
1393 grid.cellinfo(first).align = asString(align);
1395 // parse the remaining contents into the "real" cell
1396 parse(*cell, FLAG_ITEM, mode);
1398 MathAtom at = MathAtom(new InsetMathMacro(buf, t.cs()));
1399 cell->push_back(at);
1400 cell->push_back(MathAtom(new InsetMathBrace(count)));
1404 else if (t.cs() == "limits" || t.cs() == "nolimits") {
1406 cell->back()->limits(t.cs() == "limits" ? LIMITS : NO_LIMITS);
1408 MathAtom at = createInsetMath(t.cs(), buf);
1409 cell->push_back(at);
1413 // \notag is the same as \nonumber if amsmath is used
1414 else if ((t.cs() == "nonumber" || t.cs() == "notag") &&
1416 grid.asHullInset()->numbered(cellrow, false);
1418 else if (t.cs() == "number" && grid.asHullInset())
1419 grid.asHullInset()->numbered(cellrow, true);
1421 else if (t.cs() == "hline") {
1422 grid.rowinfo(cellrow).lines++;
1425 else if (t.cs() == "sqrt") {
1427 parse(ar, FLAG_OPTION, mode);
1429 cell->push_back(MathAtom(new InsetMathRoot(buf)));
1430 cell->back().nucleus()->cell(1) = ar;
1432 cell->push_back(MathAtom(new InsetMathSqrt(buf)));
1433 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1436 else if (t.cs() == "cancelto") {
1438 parse(ar, FLAG_ITEM, mode);
1439 cell->push_back(MathAtom(new InsetMathCancelto(buf)));
1440 cell->back().nucleus()->cell(1) = ar;
1441 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1444 else if (t.cs() == "unit") {
1445 // Allowed formats \unit[val]{unit}
1447 parse(ar, FLAG_OPTION, mode);
1449 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT)));
1450 cell->back().nucleus()->cell(0) = ar;
1451 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1453 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNIT, 1)));
1454 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1458 else if (t.cs() == "unitfrac") {
1459 // Here allowed formats are \unitfrac[val]{num}{denom}
1461 parse(ar, FLAG_OPTION, mode);
1463 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC, 3)));
1464 cell->back().nucleus()->cell(2) = ar;
1466 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::UNITFRAC)));
1468 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1469 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1472 else if (t.cs() == "cfrac") {
1473 // allowed formats are \cfrac[pos]{num}{denom}
1474 docstring const arg = getArg('[', ']');
1475 //lyxerr << "got so far: '" << arg << "'" << endl;
1477 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACLEFT)));
1478 else if (arg == "r")
1479 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRACRIGHT)));
1480 else if (arg.empty() || arg == "c")
1481 cell->push_back(MathAtom(new InsetMathFrac(buf, InsetMathFrac::CFRAC)));
1483 error("found invalid optional argument");
1486 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1487 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1490 else if (t.cs() == "sideset") {
1491 // Here allowed formats are \sideset{_{bl}^{tl}}{_{br}^{tr}}{operator}
1493 InsetMathScript * script[2] = {0, 0};
1494 for (int i = 0; i < 2; ++i) {
1495 parse(ar[i], FLAG_ITEM, mode);
1496 if (ar[i].size() == 1)
1497 script[i] = ar[i][0].nucleus()->asScriptInset();
1499 bool const hasscript[2] = {script[0] != nullptr, script[1] != nullptr};
1500 cell->push_back(MathAtom(new InsetMathSideset(buf, hasscript[0], hasscript[1])));
1502 if (script[0]->hasDown())
1503 cell->back().nucleus()->cell(1) = script[0]->down();
1504 if (script[0]->hasUp())
1505 cell->back().nucleus()->cell(2) = script[0]->up();
1507 cell->back().nucleus()->cell(1) = ar[0];
1509 if (script[1]->hasDown())
1510 cell->back().nucleus()->cell(2 + hasscript[0]) = script[1]->down();
1511 if (script[1]->hasUp())
1512 cell->back().nucleus()->cell(3 + hasscript[0]) = script[1]->up();
1514 cell->back().nucleus()->cell(2 + hasscript[0]) = ar[1];
1515 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1518 else if (t.cs() == "stackrel") {
1519 // Here allowed formats are \stackrel[subscript]{superscript}{operator}
1521 parse(ar, FLAG_OPTION, mode);
1522 cell->push_back(MathAtom(new InsetMathStackrel(buf, !ar.empty())));
1524 cell->back().nucleus()->cell(2) = ar;
1525 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1526 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1529 else if (t.cs() == "xrightarrow" || t.cs() == "xleftarrow") {
1530 cell->push_back(createInsetMath(t.cs(), buf));
1531 parse(cell->back().nucleus()->cell(1), FLAG_OPTION, mode);
1532 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1535 else if (t.cs() == "xhookrightarrow" || t.cs() == "xhookleftarrow" ||
1536 t.cs() == "xRightarrow" || t.cs() == "xLeftarrow" ||
1537 t.cs() == "xleftrightarrow" || t.cs() == "xLeftrightarrow" ||
1538 t.cs() == "xrightharpoondown" || t.cs() == "xrightharpoonup" ||
1539 t.cs() == "xleftharpoondown" || t.cs() == "xleftharpoonup" ||
1540 t.cs() == "xleftrightharpoons" || t.cs() == "xrightleftharpoons" ||
1541 t.cs() == "xmapsto") {
1542 cell->push_back(createInsetMath(t.cs(), buf));
1543 parse(cell->back().nucleus()->cell(1), FLAG_OPTION, mode);
1544 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1547 else if (t.cs() == "ref" || t.cs() == "eqref" || t.cs() == "prettyref"
1548 || t.cs() == "nameref" || t.cs() == "pageref"
1549 || t.cs() == "vpageref" || t.cs() == "vref"
1550 || t.cs() == "formatted" || t.cs() == "labelonly") {
1551 cell->push_back(MathAtom(new InsetMathRef(buf, t.cs())));
1552 docstring const opt = parse_verbatim_option();
1553 docstring const ref = parse_verbatim_item();
1555 cell->back().nucleus()->cell(1).push_back(
1556 MathAtom(new InsetMathString(opt)));
1558 cell->back().nucleus()->cell(0).push_back(
1559 MathAtom(new InsetMathString(ref)));
1562 else if (t.cs() == "left") {
1564 Token const & tl = getToken();
1565 // \| and \Vert are equivalent, and InsetMathDelim
1567 // FIXME: fix this in InsetMathDelim itself!
1568 docstring const l = tl.cs() == "|" ? from_ascii("Vert") : tl.asString();
1570 parse(ar, FLAG_RIGHT, mode);
1574 Token const & tr = getToken();
1575 docstring const r = tr.cs() == "|" ? from_ascii("Vert") : tr.asString();
1576 cell->push_back(MathAtom(new InsetMathDelim(buf, l, r, ar)));
1579 else if (t.cs() == "right") {
1580 if (flags & FLAG_RIGHT)
1582 //lyxerr << "got so far: '" << cell << "'" << endl;
1583 error("Unmatched right delimiter");
1587 else if (t.cs() == "begin") {
1588 docstring const name = getArg('{', '}');
1592 error("found invalid environment");
1596 environments_.push_back(name);
1598 if (name == "array" || name == "subarray") {
1599 docstring const valign = parse_verbatim_option() + 'c';
1600 docstring const halign = parse_verbatim_item();
1601 cell->push_back(MathAtom(new InsetMathArray(buf, name,
1602 InsetMathGrid::guessColumns(halign), 1, (char)valign[0], halign)));
1603 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, false);
1606 else if (name == "tabular") {
1607 docstring const valign = parse_verbatim_option() + 'c';
1608 docstring const halign = parse_verbatim_item();
1609 cell->push_back(MathAtom(new InsetMathTabular(buf, name,
1610 InsetMathGrid::guessColumns(halign), 1, (char)valign[0], halign)));
1611 parse2(cell->back(), FLAG_END, InsetMath::TEXT_MODE, false);
1614 else if (name == "split" || name == "cases") {
1615 cell->push_back(createInsetMath(name, buf));
1616 parse2(cell->back(), FLAG_END, mode, false);
1619 else if (name == "alignedat") {
1620 docstring const valign = parse_verbatim_option() + 'c';
1621 // ignore this for a while
1623 cell->push_back(MathAtom(new InsetMathSplit(buf, name, (char)valign[0])));
1624 parse2(cell->back(), FLAG_END, mode, false);
1627 else if (name == "math") {
1628 if (mode == InsetMath::UNDECIDED_MODE) {
1629 cell->push_back(MathAtom(new InsetMathHull(buf, hullSimple)));
1630 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, false);
1632 // Don't create nested math hulls (bug #5392)
1633 cell->push_back(MathAtom(new InsetMathEnsureMath(buf)));
1634 parse(cell->back().nucleus()->cell(0), FLAG_END, InsetMath::MATH_MODE);
1638 else if (name == "equation" || name == "equation*"
1639 || name == "displaymath") {
1640 if (mode != InsetMath::UNDECIDED_MODE) {
1641 error("bad math environment " + name);
1644 cell->push_back(MathAtom(new InsetMathHull(buf, hullEquation)));
1645 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, (name == "equation"));
1648 else if (name == "eqnarray" || name == "eqnarray*") {
1649 if (mode != InsetMath::UNDECIDED_MODE) {
1650 error("bad math environment " + name);
1653 cell->push_back(MathAtom(new InsetMathHull(buf, hullEqnArray)));
1654 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1657 else if (name == "align" || name == "align*") {
1658 if (mode == InsetMath::UNDECIDED_MODE) {
1659 cell->push_back(MathAtom(new InsetMathHull(buf, hullAlign)));
1660 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1662 cell->push_back(MathAtom(new InsetMathSplit(buf, name,
1663 'c', !stared(name))));
1664 parse2(cell->back(), FLAG_END, mode, !stared(name));
1668 else if (name == "flalign" || name == "flalign*") {
1669 if (mode != InsetMath::UNDECIDED_MODE) {
1670 error("bad math environment " + name);
1673 cell->push_back(MathAtom(new InsetMathHull(buf, hullFlAlign)));
1674 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1677 else if (name == "alignat" || name == "alignat*") {
1678 if (mode != InsetMath::UNDECIDED_MODE) {
1679 error("bad math environment " + name);
1682 // ignore this for a while
1684 cell->push_back(MathAtom(new InsetMathHull(buf, hullAlignAt)));
1685 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1688 else if (name == "xalignat" || name == "xalignat*") {
1689 if (mode != InsetMath::UNDECIDED_MODE) {
1690 error("bad math environment " + name);
1693 // ignore this for a while
1695 cell->push_back(MathAtom(new InsetMathHull(buf, hullXAlignAt)));
1696 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1699 else if (name == "xxalignat") {
1700 if (mode != InsetMath::UNDECIDED_MODE) {
1701 error("bad math environment " + name);
1704 // ignore this for a while
1706 cell->push_back(MathAtom(new InsetMathHull(buf, hullXXAlignAt)));
1707 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1710 else if (name == "multline" || name == "multline*") {
1711 if (mode != InsetMath::UNDECIDED_MODE) {
1712 error("bad math environment " + name);
1715 cell->push_back(MathAtom(new InsetMathHull(buf, hullMultline)));
1716 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1719 else if (name == "gather" || name == "gather*") {
1720 if (mode != InsetMath::UNDECIDED_MODE) {
1721 error("bad math environment " + name);
1724 cell->push_back(MathAtom(new InsetMathHull(buf, hullGather)));
1725 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1728 else if (latexkeys const * l = in_word_set(name)) {
1729 if (l->inset == "matrix") {
1730 cell->push_back(createInsetMath(name, buf));
1731 parse2(cell->back(), FLAG_END, mode, false);
1732 } else if (l->inset == "split") {
1733 docstring const valign = parse_verbatim_option() + 'c';
1734 cell->push_back(MathAtom(
1735 new InsetMathSplit(buf, name, (char)valign[0])));
1736 parse2(cell->back(), FLAG_END, mode, false);
1739 if (!(mode_ & Parse::QUIET)) {
1741 lyxerr << "found math environment `"
1743 << "' in symbols file with unsupported inset `"
1747 // create generic environment inset
1748 cell->push_back(MathAtom(new InsetMathEnv(buf, name)));
1749 parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1755 if (!(mode_ & Parse::QUIET) &&
1756 !(mode_ & Parse::TRACKMACRO)) {
1758 lyxerr << "found unknown math environment '"
1759 << to_utf8(name) << "'" << endl;
1761 // create generic environment inset
1762 cell->push_back(MathAtom(new InsetMathEnv(buf, name)));
1763 parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1767 else if (t.cs() == "kern" || t.cs() == "mkern") {
1772 Token const & tt = getToken();
1776 while (num_tokens--)
1780 s += tt.character();
1781 if (isValidLength(to_utf8(s)))
1785 cell->push_back(MathAtom(new InsetMathMacro(buf, t.cs())));
1787 cell->push_back(MathAtom(new InsetMathKern(s)));
1790 else if (t.cs() == "label") {
1791 // FIXME: This is swallowed in inline formulas
1792 docstring label = parse_verbatim_item();
1795 if (grid.asHullInset()) {
1796 grid.asHullInset()->label(cellrow, label);
1797 grid.asHullInset()->numbered(cellrow, true);
1799 cell->push_back(createInsetMath(t.cs(), buf));
1800 cell->push_back(MathAtom(new InsetMathBrace(ar)));
1804 else if (t.cs() == "choose" || t.cs() == "over"
1805 || t.cs() == "atop" || t.cs() == "brace"
1806 || t.cs() == "brack") {
1807 MathAtom at = createInsetMath(t.cs(), buf);
1808 at.nucleus()->cell(0) = *cell;
1810 parse(at.nucleus()->cell(1), flags, mode);
1811 cell->push_back(at);
1815 else if (t.cs() == "color") {
1816 docstring const color = parse_verbatim_item();
1817 cell->push_back(MathAtom(new InsetMathColor(buf, true, color)));
1818 parse(cell->back().nucleus()->cell(0), flags, mode);
1822 else if (t.cs() == "textcolor") {
1823 docstring const color = parse_verbatim_item();
1824 cell->push_back(MathAtom(new InsetMathColor(buf, false, color)));
1825 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1828 else if (t.cs() == "normalcolor") {
1829 cell->push_back(createInsetMath(t.cs(), buf));
1830 parse(cell->back().nucleus()->cell(0), flags, mode);
1834 else if (t.cs() == "substack") {
1835 cell->push_back(createInsetMath(t.cs(), buf));
1836 parse2(cell->back(), FLAG_ITEM, mode, false);
1837 // Delete empty last row if present
1838 InsetMathGrid & subgrid =
1839 *(cell->back().nucleus()->asGridInset());
1840 if (subgrid.nrows() > 1)
1841 delEmptyLastRow(subgrid);
1844 else if (t.cs() == "xymatrix") {
1845 odocstringstream os;
1846 while (good() && nextToken().cat() != catBegin)
1847 os << getToken().asInput();
1848 cell->push_back(createInsetMath(t.cs() + os.str(), buf));
1849 parse2(cell->back(), FLAG_ITEM, mode, false);
1850 // Delete empty last row if present
1851 InsetMathGrid & subgrid =
1852 *(cell->back().nucleus()->asGridInset());
1853 if (subgrid.nrows() > 1)
1854 delEmptyLastRow(subgrid);
1857 else if (t.cs() == "Diagram") {
1858 odocstringstream os;
1859 while (good() && nextToken().cat() != catBegin)
1860 os << getToken().asInput();
1861 cell->push_back(createInsetMath(t.cs() + os.str(), buf));
1862 parse2(cell->back(), FLAG_ITEM, mode, false);
1865 else if (t.cs() == "framebox" || t.cs() == "makebox") {
1866 cell->push_back(createInsetMath(t.cs(), buf));
1867 parse(cell->back().nucleus()->cell(0), FLAG_OPTION, InsetMath::TEXT_MODE);
1868 parse(cell->back().nucleus()->cell(1), FLAG_OPTION, InsetMath::TEXT_MODE);
1869 parse(cell->back().nucleus()->cell(2), FLAG_ITEM, InsetMath::TEXT_MODE);
1872 else if (t.cs() == "tag") {
1873 if (nextToken().character() == '*') {
1875 cell->push_back(createInsetMath(t.cs() + '*', buf));
1877 cell->push_back(createInsetMath(t.cs(), buf));
1878 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1881 else if (t.cs() == "hspace") {
1882 bool const prot = nextToken().character() == '*';
1885 docstring const & name = t.cs();
1886 docstring const arg = parse_verbatim_item();
1888 if (prot && arg == "\\fill")
1889 cell->push_back(MathAtom(new InsetMathSpace("hspace*{\\fill}", "")));
1890 else if (isValidLength(to_utf8(arg), &length))
1891 cell->push_back(MathAtom(new InsetMathSpace(length, prot)));
1893 // Since the Length class cannot use length variables
1894 // we must not create an InsetMathSpace.
1895 cell->push_back(MathAtom(new InsetMathMacro(buf, name)));
1897 mathed_parse_cell(ar, '{' + arg + '}', mode_);
1902 else if (t.cs() == "smash") {
1904 if (nextToken().asInput() == "[") {
1905 // Since the phantom inset cannot handle optional arguments
1906 // other than b and t, we must not create an InsetMathPhantom
1907 // if opt is different from b and t (bug 8967).
1908 docstring const opt = parse_verbatim_option();
1909 if (opt == "t" || opt == "b") {
1910 cell->push_back(createInsetMath(t.cs() + opt, buf));
1911 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1913 docstring const arg = parse_verbatim_item();
1914 cell->push_back(MathAtom(new InsetMathMacro(buf, t.cs())));
1916 mathed_parse_cell(ar, '[' + opt + ']', mode_);
1919 mathed_parse_cell(ar, '{' + arg + '}', mode_);
1924 cell->push_back(createInsetMath(t.cs(), buf));
1925 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1930 else if (t.cs() == "infer") {
1932 parse(ar, FLAG_OPTION, mode);
1933 cell->push_back(createInsetMath(t.cs(), buf));
1934 parse2(cell->back(), FLAG_ITEM, mode, false);
1938 else if (t.cs() == "lyxmathsym") {
1940 if (getToken().cat() != catBegin) {
1941 error("'{' expected in \\" + t.cs());
1946 CatCode cat = nextToken().cat();
1947 while (good() && (count || cat != catEnd)) {
1948 if (cat == catBegin)
1950 else if (cat == catEnd)
1952 cmd += getToken().asInput();
1953 cat = nextToken().cat();
1955 if (getToken().cat() != catEnd) {
1956 error("'}' expected in \\" + t.cs());
1962 cmd = Encodings::fromLaTeXCommand(cmd,
1963 Encodings::MATH_CMD | Encodings::TEXT_CMD,
1965 for (char_type c : cmd)
1966 cell->push_back(MathAtom(new InsetMathChar(c)));
1968 char_type c = rem[0];
1969 cell->push_back(MathAtom(new InsetMathChar(c)));
1970 cmd = rem.substr(1);
1974 } while (!cmd.empty());
1977 else if (!t.cs().empty()) {
1978 bool const no_mhchem =
1979 (t.cs() == "ce" || t.cs() == "cf")
1980 && buf && buf->params().use_package("mhchem") ==
1981 BufferParams::package_off;
1983 bool const is_user_macro = no_mhchem ||
1984 (buf && ((mode_ & Parse::TRACKMACRO)
1985 ? buf->usermacros.count(t.cs()) != 0
1986 : buf->getMacro(t.cs(), false) != 0));
1988 latexkeys const * l = in_word_set(t.cs());
1989 if (l && !is_user_macro) {
1990 if (l->inset == "big") {
1992 docstring const delim = getToken().asInput();
1993 if (InsetMathBig::isBigInsetDelim(delim))
1994 cell->push_back(MathAtom(
1995 new InsetMathBig(t.cs(), delim)));
1997 cell->push_back(createInsetMath(t.cs(), buf));
1998 // For some reason delim.empty()
1999 // is always false here
2005 else if (l->inset == "font") {
2006 cell->push_back(createInsetMath(t.cs(), buf));
2007 parse(cell->back().nucleus()->cell(0),
2008 FLAG_ITEM, asMode(mode, l->extra));
2011 else if (l->inset == "oldfont") {
2012 cell->push_back(createInsetMath(t.cs(), buf));
2013 parse(cell->back().nucleus()->cell(0),
2014 flags | FLAG_ALIGN, asMode(mode, l->extra));
2015 if (prevToken().cat() != catAlign &&
2016 prevToken().cs() != "\\")
2021 else if (l->inset == "style") {
2022 cell->push_back(createInsetMath(t.cs(), buf));
2023 parse(cell->back().nucleus()->cell(0),
2024 flags | FLAG_ALIGN, mode);
2025 if (prevToken().cat() != catAlign &&
2026 prevToken().cs() != "\\")
2031 else if (l->inset == "underset" || l->inset == "overset") {
2032 cell->push_back(createInsetMath(t.cs(), buf));
2033 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
2034 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
2038 MathAtom at = createInsetMath(t.cs(), buf);
2039 for (idx_type i = 0; i < at->nargs(); ++i)
2040 parse(at.nucleus()->cell(i),
2041 FLAG_ITEM, asMode(mode, l->extra));
2042 cell->push_back(at);
2047 bool is_unicode_symbol = false;
2048 if (mode == InsetMath::TEXT_MODE && !is_user_macro) {
2050 docstring cmd = prevToken().asInput();
2051 CatCode cat = nextToken().cat();
2052 if (cat == catBegin) {
2054 while (good() && (count || cat != catEnd)) {
2055 cat = nextToken().cat();
2056 cmd += getToken().asInput();
2058 if (cat == catBegin)
2060 else if (cat == catEnd)
2066 char_type c = Encodings::fromLaTeXCommand(cmd,
2067 Encodings::MATH_CMD | Encodings::TEXT_CMD,
2068 is_combining, termination);
2070 if (cat == catLetter)
2072 cmd += getToken().asInput();
2074 if (cat == catLetter)
2076 c = Encodings::fromLaTeXCommand(cmd,
2077 Encodings::MATH_CMD | Encodings::TEXT_CMD,
2078 is_combining, termination);
2080 if (c && buf && buf->params().encoding().encodable(c)) {
2082 if (nextToken().cat() == catBegin) {
2084 if (nextToken().cat() == catEnd) {
2089 while (nextToken().cat() == catSpace) {
2094 is_unicode_symbol = true;
2095 cell->push_back(MathAtom(new InsetMathChar(c)));
2097 while (num_tokens--)
2101 if (!is_unicode_symbol) {
2102 MathAtom at = is_user_macro ?
2103 MathAtom(new InsetMathMacro(buf, t.cs()))
2104 : createInsetMath(t.cs(), buf);
2105 InsetMath::mode_type m = mode;
2106 //if (m == InsetMath::UNDECIDED_MODE)
2107 //lyxerr << "default creation: m1: " << m << endl;
2108 if (at->currentMode() != InsetMath::UNDECIDED_MODE)
2109 m = at->currentMode();
2110 //lyxerr << "default creation: m2: " << m << endl;
2112 // this fails on \bigg[...\bigg]
2114 //parse(opt, FLAG_OPTION, InsetMath::VERBATIM_MODE);
2115 //if (!opt.empty()) {
2117 // at.nucleus()->cell(0) = opt;
2119 for (idx_type i = start; i < at->nargs(); ++i) {
2120 parse(at.nucleus()->cell(i), FLAG_ITEM, m);
2121 if (mode == InsetMath::MATH_MODE)
2124 cell->push_back(at);
2130 if (flags & FLAG_LEAVE) {
2139 } // anonymous namespace
2142 // FIXME This will likely need some work.
2143 char const * latexkeys::MathMLtype() const
2145 if (extra == "mathord")
2151 bool mathed_parse_cell(MathData & ar, docstring const & str, Parse::flags f)
2153 return Parser(str, f, ar.buffer()).parse(ar, 0, (f & Parse::TEXTMODE) ?
2154 InsetMath::TEXT_MODE : InsetMath::MATH_MODE);
2158 bool mathed_parse_cell(MathData & ar, istream & is, Parse::flags f)
2160 return Parser(is, f, ar.buffer()).parse(ar, 0, (f & Parse::TEXTMODE) ?
2161 InsetMath::TEXT_MODE : InsetMath::MATH_MODE);
2165 bool mathed_parse_normal(Buffer * buf, MathAtom & t, docstring const & str,
2168 return Parser(str, f, buf).parse(t);
2172 bool mathed_parse_normal(Buffer * buf, MathAtom & t, Lexer & lex,
2175 return Parser(lex, f, buf).parse(t);
2179 bool mathed_parse_normal(InsetMathGrid & grid, docstring const & str,
2182 return Parser(str, f, &grid.buffer()).parse1(grid, 0, (f & Parse::TEXTMODE) ?
2183 InsetMath::TEXT_MODE : InsetMath::MATH_MODE, false);
2189 fill(theCatcode, theCatcode + 128, catOther);
2190 fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
2191 fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
2193 theCatcode[int('\\')] = catEscape;
2194 theCatcode[int('{')] = catBegin;
2195 theCatcode[int('}')] = catEnd;
2196 theCatcode[int('$')] = catMath;
2197 theCatcode[int('&')] = catAlign;
2198 theCatcode[int('\n')] = catNewline;
2199 theCatcode[int('#')] = catParameter;
2200 theCatcode[int('^')] = catSuper;
2201 theCatcode[int('_')] = catSub;
2202 theCatcode[int(0x7f)] = catIgnore;
2203 theCatcode[int(' ')] = catSpace;
2204 theCatcode[int('\t')] = catSpace;
2205 theCatcode[int('\r')] = catNewline;
2206 theCatcode[int('~')] = catActive;
2207 theCatcode[int('%')] = catComment;