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 "InsetMathChar.h"
46 #include "InsetMathColor.h"
47 #include "InsetMathComment.h"
48 #include "InsetMathDelim.h"
49 #include "InsetMathEnv.h"
50 #include "InsetMathFrac.h"
51 #include "InsetMathKern.h"
52 #include "MathMacro.h"
53 #include "InsetMathPar.h"
54 #include "InsetMathRef.h"
55 #include "InsetMathRoot.h"
56 #include "InsetMathScript.h"
57 #include "InsetMathSplit.h"
58 #include "InsetMathSqrt.h"
59 #include "InsetMathTabular.h"
60 #include "MathMacroTemplate.h"
61 #include "MathFactory.h"
62 #include "MathMacroArgument.h"
63 #include "MathSupport.h"
67 #include "support/debug.h"
68 #include "support/convert.h"
69 #include "support/docstream.h"
81 InsetMath::mode_type asMode(InsetMath::mode_type oldmode, docstring const & str)
83 //lyxerr << "handling mode: '" << str << "'" << endl;
84 if (str == "mathmode")
85 return InsetMath::MATH_MODE;
86 if (str == "textmode" || str == "forcetext")
87 return InsetMath::TEXT_MODE;
92 bool stared(docstring const & s)
94 size_t const n = s.size();
95 return n && s[n - 1] == '*';
100 * Add the row \p cellrow to \p grid.
101 * \returns wether the row could be added. Adding a row can fail for
102 * environments like "equation" that have a fixed number of rows.
104 bool addRow(InsetMathGrid & grid, InsetMathGrid::row_type & cellrow,
105 docstring const & vskip, bool allow_newpage_ = true)
108 if (cellrow == grid.nrows()) {
109 //lyxerr << "adding row " << cellrow << endl;
110 grid.addRow(cellrow - 1);
111 if (cellrow == grid.nrows()) {
112 // We can't add a row to this grid, so let's
113 // append the content of this cell to the previous
115 // This does not happen in well formed .lyx files,
116 // but LyX versions 1.3.x and older could create
117 // such files and tex2lyx can still do that.
119 lyxerr << "ignoring extra row";
121 lyxerr << " with extra space " << to_utf8(vskip);
123 lyxerr << " with no page break allowed";
124 lyxerr << '.' << endl;
128 grid.vcrskip(Length(to_utf8(vskip)), cellrow - 1);
129 grid.rowinfo(cellrow - 1).allow_newpage_ = allow_newpage_;
135 * Add the column \p cellcol to \p grid.
136 * \returns wether the column could be added. Adding a column can fail for
137 * environments like "eqnarray" that have a fixed number of columns.
139 bool addCol(InsetMathGrid & grid, InsetMathGrid::col_type & cellcol)
142 if (cellcol == grid.ncols()) {
143 //lyxerr << "adding column " << cellcol << endl;
144 grid.addCol(cellcol);
145 if (cellcol == grid.ncols()) {
146 // We can't add a column to this grid, so let's
147 // append the content of this cell to the previous
149 // This does not happen in well formed .lyx files,
150 // but LyX versions 1.3.x and older could create
151 // such files and tex2lyx can still do that.
153 lyxerr << "ignoring extra column." << endl;
162 * Check wether the last row is empty and remove it if yes.
163 * Otherwise the following code
171 * will result in a grid with 3 rows (+ the dummy row that is always present),
172 * because the last '\\' opens a new row.
174 void delEmptyLastRow(InsetMathGrid & grid)
176 InsetMathGrid::row_type const row = grid.nrows() - 1;
177 for (InsetMathGrid::col_type col = 0; col < grid.ncols(); ++col) {
178 if (!grid.cell(grid.index(row, col)).empty())
181 // Copy the row information of the empty row (which would contain the
182 // last hline in the example above) to the dummy row and delete the
184 grid.rowinfo(row + 1) = grid.rowinfo(row);
189 // These are TeX's catcodes
191 catEscape, // 0 backslash
201 catSpace, // 10 space
202 catLetter, // 11 a-zA-Z
203 catOther, // 12 none of the above
206 catInvalid // 15 <delete>
209 CatCode theCatcode[128];
212 inline CatCode catcode(char_type c)
214 /* The only characters that are not catOther lie in the pure ASCII
215 * range. Therefore theCatcode has only 128 entries.
216 * TeX itself deals with 8bit characters, so if needed this table
217 * could be enlarged to 256 entries.
218 * Any larger value does not make sense, since the fact that we use
219 * unicode internally does not change Knuth's TeX engine.
220 * Apart from that a table for the full 21bit UCS4 range would waste
221 * too much memory. */
225 return theCatcode[c];
230 FLAG_ALIGN = 1 << 0, // next & or \\ ends the parsing process
231 FLAG_BRACE_LAST = 1 << 1, // next closing brace ends the parsing
232 FLAG_RIGHT = 1 << 2, // next \\right ends the parsing process
233 FLAG_END = 1 << 3, // next \\end ends the parsing process
234 FLAG_BRACK_LAST = 1 << 4, // next closing bracket ends the parsing
235 FLAG_TEXTMODE = 1 << 5, // we are in a box
236 FLAG_ITEM = 1 << 6, // read a (possibly braced) token
237 FLAG_LEAVE = 1 << 7, // leave the loop at the end
238 FLAG_SIMPLE = 1 << 8, // next $ leaves the loop
239 FLAG_EQUATION = 1 << 9, // next \] leaves the loop
240 FLAG_SIMPLE2 = 1 << 10, // next \) leaves the loop
241 FLAG_OPTION = 1 << 11, // read [...] style option
242 FLAG_BRACED = 1 << 12 // read {...} style argument
247 // Helper class for parsing
253 Token() : cs_(), char_(0), cat_(catIgnore) {}
255 Token(char_type c, CatCode cat) : cs_(), char_(c), cat_(cat) {}
257 explicit Token(docstring const & cs) : cs_(cs), char_(0), cat_(catIgnore) {}
260 docstring const & cs() const { return cs_; }
262 CatCode cat() const { return cat_; }
264 char_type character() const { return char_; }
266 docstring asString() const { return cs_.size() ? cs_ : docstring(1, char_); }
268 docstring asInput() const { return cs_.size() ? '\\' + cs_ : docstring(1, char_); }
280 ostream & operator<<(ostream & os, Token const & t)
283 docstring const & cs = t.cs();
284 // FIXME: For some strange reason, the stream operator instanciate
285 // a new Token before outputting the contents of t.cs().
286 // Because of this the line
288 // below becomes recursive.
289 // In order to avoid that we return early:
292 os << '\\' << to_utf8(cs);
294 else if (t.cat() == catLetter)
297 os << '[' << t.character() << ',' << t.cat() << ']';
305 typedef InsetMath::mode_type mode_type;
309 /// Only use this for reading from .lyx file format, for the reason
310 /// see Parser::tokenize(istream &).
311 Parser(istream & is);
313 Parser(docstring const & str);
316 bool parse(MathAtom & at);
318 void parse(MathData & array, unsigned flags, mode_type mode);
320 void parse1(InsetMathGrid & grid, unsigned flags, mode_type mode,
323 MathData parse(unsigned flags, mode_type mode);
325 int lineno() const { return lineno_; }
331 void parse2(MathAtom & at, unsigned flags, mode_type mode, bool numbered);
332 /// get arg delimited by 'left' and 'right'
333 docstring getArg(char_type left, char_type right);
337 void error(string const & msg);
338 void error(docstring const & msg) { error(to_utf8(msg)); }
339 /// dump contents to screen
341 /// Only use this for reading from .lyx file format (see
342 /// implementation for reason)
343 void tokenize(istream & is);
345 void tokenize(docstring const & s);
347 void skipSpaceTokens(idocstream & is, char_type c);
349 void push_back(Token const & t);
353 Token const & prevToken() const;
355 Token const & nextToken() const;
357 Token const & getToken();
358 /// skips spaces if any
361 void lex(docstring const & s);
365 docstring parse_verbatim_item();
367 docstring parse_verbatim_option();
372 vector<Token> tokens_;
375 /// Stack of active environments
376 vector<docstring> environments_;
380 Parser::Parser(Lexer & lexer)
381 : lineno_(lexer.getLineNo()), pos_(0)
383 tokenize(lexer.getStream());
388 Parser::Parser(istream & is)
389 : lineno_(0), pos_(0)
395 Parser::Parser(docstring const & str)
396 : lineno_(0), pos_(0)
402 void Parser::push_back(Token const & t)
404 tokens_.push_back(t);
408 void Parser::pop_back()
414 Token const & Parser::prevToken() const
416 static const Token dummy;
417 return pos_ > 0 ? tokens_[pos_ - 1] : dummy;
421 Token const & Parser::nextToken() const
423 static const Token dummy;
424 return good() ? tokens_[pos_] : dummy;
428 Token const & Parser::getToken()
430 static const Token dummy;
431 //lyxerr << "looking at token " << tokens_[pos_] << " pos: " << pos_ << endl;
432 return good() ? tokens_[pos_++] : dummy;
436 void Parser::skipSpaces()
438 while (nextToken().cat() == catSpace || nextToken().cat() == catNewline)
443 void Parser::putback()
449 bool Parser::good() const
451 return pos_ < tokens_.size();
455 char_type Parser::getChar()
458 error("The input stream is not well...");
462 return tokens_[pos_++].character();
466 docstring Parser::getArg(char_type left, char_type right)
471 char_type c = getChar();
476 while ((c = getChar()) != right && good())
483 void Parser::skipSpaceTokens(idocstream & is, char_type c)
485 // skip trailing spaces
486 while (catcode(c) == catSpace || catcode(c) == catNewline)
489 //lyxerr << "putting back: " << c << endl;
494 void Parser::tokenize(istream & is)
496 // eat everything up to the next \end_inset or end of stream
497 // and store it in s for further tokenization
502 if (s.size() >= 10 && s.substr(s.size() - 10) == "\\end_inset") {
503 s = s.substr(0, s.size() - 10);
507 // Remove the space after \end_inset
508 if (is.get(c) && c != ' ')
512 tokenize(from_utf8(s));
516 void Parser::tokenize(docstring const & buffer)
518 idocstringstream is(buffer, ios::in | ios::binary);
522 //lyxerr << "reading c: " << c << endl;
524 switch (catcode(c)) {
528 if (catcode(c) == catNewline)
529 ; //push_back(Token("par"));
531 push_back(Token('\n', catNewline));
539 while (is.get(c) && catcode(c) != catNewline)
549 error("unexpected end of input");
552 if (catcode(c) == catLetter) {
554 while (is.get(c) && catcode(c) == catLetter)
556 skipSpaceTokens(is, c);
565 push_back(Token(c, catcode(c)));
567 skipSpaceTokens(is, c);
572 lyxerr << "ignoring a char: " << int(c) << endl;
577 push_back(Token(c, catcode(c)));
587 void Parser::dump() const
589 lyxerr << "\nTokens: ";
590 for (unsigned i = 0; i < tokens_.size(); ++i) {
593 lyxerr << tokens_[i];
595 lyxerr << " pos: " << pos_ << endl;
599 void Parser::error(string const & msg)
601 lyxerr << "Line ~" << lineno_ << ": Math parse error: " << msg << endl;
607 bool Parser::parse(MathAtom & at)
611 parse(ar, false, InsetMath::UNDECIDED_MODE);
612 if (ar.size() != 1 || ar.front()->getType() == hullNone) {
613 lyxerr << "unusual contents found: " << ar << endl;
614 at = MathAtom(new InsetMathPar(ar));
615 //if (at->nargs() > 0)
616 // at.nucleus()->cell(0) = ar;
618 // lyxerr << "unusual contents found: " << ar << endl;
626 docstring Parser::parse_verbatim_option()
630 if (nextToken().character() == '[') {
631 Token t = getToken();
632 for (Token t = getToken(); t.character() != ']' && good(); t = getToken()) {
633 if (t.cat() == catBegin) {
635 res += '{' + parse_verbatim_item() + '}';
644 docstring Parser::parse_verbatim_item()
648 if (nextToken().cat() == catBegin) {
649 Token t = getToken();
650 for (Token t = getToken(); t.cat() != catEnd && good(); t = getToken()) {
651 if (t.cat() == catBegin) {
653 res += '{' + parse_verbatim_item() + '}';
663 MathData Parser::parse(unsigned flags, mode_type mode)
666 parse(ar, flags, mode);
671 void Parser::parse(MathData & array, unsigned flags, mode_type mode)
673 InsetMathGrid grid(1, 1);
674 parse1(grid, flags, mode, false);
675 array = grid.cell(0);
679 void Parser::parse2(MathAtom & at, const unsigned flags, const mode_type mode,
682 parse1(*(at.nucleus()->asGridInset()), flags, mode, numbered);
686 void Parser::parse1(InsetMathGrid & grid, unsigned flags,
687 const mode_type mode, const bool numbered)
690 InsetMathGrid::row_type cellrow = 0;
691 InsetMathGrid::col_type cellcol = 0;
692 MathData * cell = &grid.cell(grid.index(cellrow, cellcol));
694 if (grid.asHullInset())
695 grid.asHullInset()->numbered(cellrow, numbered);
698 //lyxerr << " flags: " << flags << endl;
699 //lyxerr << " mode: " << mode << endl;
700 //lyxerr << "grid: " << grid << endl;
703 Token const & t = getToken();
706 lyxerr << "t: " << t << " flags: " << flags << endl;
707 lyxerr << "mode: " << mode << endl;
712 if (flags & FLAG_ITEM) {
714 if (t.cat() == catBegin) {
715 // skip the brace and collect everything to the next matching
717 parse1(grid, FLAG_BRACE_LAST, mode, numbered);
721 // handle only this single token, leave the loop if done
726 if (flags & FLAG_BRACED) {
727 if (t.cat() == catSpace)
730 if (t.cat() != catBegin) {
731 error("opening brace expected");
735 // skip the brace and collect everything to the next matching
737 flags = FLAG_BRACE_LAST;
741 if (flags & FLAG_OPTION) {
742 if (t.cat() == catOther && t.character() == '[') {
744 parse(ar, FLAG_BRACK_LAST, mode);
747 // no option found, put back token and we are done
756 if (t.cat() == catMath) {
757 if (mode != InsetMath::MATH_MODE) {
758 // we are inside some text mode thingy, so opening new math is allowed
759 Token const & n = getToken();
760 if (n.cat() == catMath) {
761 // TeX's $$...$$ syntax for displayed math
762 cell->push_back(MathAtom(new InsetMathHull(hullEquation)));
763 parse2(cell->back(), FLAG_SIMPLE, InsetMath::MATH_MODE, false);
764 getToken(); // skip the second '$' token
766 // simple $...$ stuff
768 cell->push_back(MathAtom(new InsetMathHull(hullSimple)));
769 parse2(cell->back(), FLAG_SIMPLE, InsetMath::MATH_MODE, false);
773 else if (flags & FLAG_SIMPLE) {
774 // this is the end of the formula
779 error("something strange in the parser");
784 else if (t.cat() == catLetter)
785 cell->push_back(MathAtom(new InsetMathChar(t.character())));
787 else if (t.cat() == catSpace && mode != InsetMath::MATH_MODE) {
788 if (cell->empty() || cell->back()->getChar() != ' ')
789 cell->push_back(MathAtom(new InsetMathChar(t.character())));
792 else if (t.cat() == catNewline && mode != InsetMath::MATH_MODE) {
793 if (cell->empty() || cell->back()->getChar() != ' ')
794 cell->push_back(MathAtom(new InsetMathChar(' ')));
797 else if (t.cat() == catParameter) {
798 Token const & n = getToken();
799 cell->push_back(MathAtom(new MathMacroArgument(n.character()-'0')));
802 else if (t.cat() == catActive)
803 cell->push_back(MathAtom(new InsetMathChar(t.character())));
805 else if (t.cat() == catBegin) {
807 parse(ar, FLAG_BRACE_LAST, mode);
808 // do not create a BraceInset if they were written by LyX
809 // this helps to keep the annoyance of "a choose b" to a minimum
810 if (ar.size() == 1 && ar[0]->extraBraces())
813 cell->push_back(MathAtom(new InsetMathBrace(ar)));
816 else if (t.cat() == catEnd) {
817 if (flags & FLAG_BRACE_LAST)
819 error("found '}' unexpectedly");
820 //BOOST_ASSERT(false);
821 //add(cell, '}', LM_TC_TEX);
824 else if (t.cat() == catAlign) {
825 //lyxerr << " column now " << (cellcol + 1)
826 // << " max: " << grid.ncols() << endl;
827 if (flags & FLAG_ALIGN)
829 if (addCol(grid, cellcol))
830 cell = &grid.cell(grid.index(cellrow, cellcol));
833 else if (t.cat() == catSuper || t.cat() == catSub) {
834 bool up = (t.cat() == catSuper);
835 // we need no new script inset if the last thing was a scriptinset,
836 // which has that script already not the same script already
838 cell->push_back(MathAtom(new InsetMathScript(up)));
839 else if (cell->back()->asScriptInset() &&
840 !cell->back()->asScriptInset()->has(up))
841 cell->back().nucleus()->asScriptInset()->ensure(up);
842 else if (cell->back()->asScriptInset())
843 cell->push_back(MathAtom(new InsetMathScript(up)));
845 cell->back() = MathAtom(new InsetMathScript(cell->back(), up));
846 InsetMathScript * p = cell->back().nucleus()->asScriptInset();
847 // special handling of {}-bases
848 // Here we could remove the brace inset for things
849 // like {a'}^2 and add the braces back in
850 // InsetMathScript::write().
851 // We do not do it, since it is not possible to detect
852 // reliably whether the braces are needed because the
853 // nucleus contains more than one symbol, or whether
854 // they are needed for unknown commands like \xx{a}_0
855 // or \yy{a}{b}_0. This was done in revision 14819
856 // in an unreliable way. See this thread
857 // http://www.mail-archive.com/lyx-devel%40lists.lyx.org/msg104917.html
859 parse(p->cell(p->idxOfScript(up)), FLAG_ITEM, mode);
866 else if (t.character() == ']' && (flags & FLAG_BRACK_LAST)) {
867 //lyxerr << "finished reading option" << endl;
871 else if (t.cat() == catOther)
872 cell->push_back(MathAtom(new InsetMathChar(t.character())));
874 else if (t.cat() == catComment) {
877 Token const & t = getToken();
878 if (t.cat() == catNewline)
882 cell->push_back(MathAtom(new InsetMathComment(s)));
890 else if (t.cs() == "lyxlock") {
892 cell->back().nucleus()->lock(true);
895 else if ((t.cs() == "global" && nextToken().cs() == "def") ||
897 if (t.cs() == "global")
901 docstring name = getToken().cs();
906 while (good() && nextToken().cat() != catBegin) {
907 pars += getToken().cs();
914 parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
916 // is a version for display attached?
919 if (nextToken().cat() == catBegin)
920 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
922 cell->push_back(MathAtom(new MathMacroTemplate(name, nargs,
923 0, MacroTypeDef, vector<MathData>(), def, display)));
926 else if (t.cs() == "newcommand" ||
927 t.cs() == "renewcommand" ||
928 t.cs() == "newlyxcommand") {
930 if (getToken().cat() != catBegin) {
931 error("'{' in \\newcommand expected (1) ");
934 docstring name = getToken().cs();
935 if (getToken().cat() != catEnd) {
936 error("'}' in \\newcommand expected");
941 docstring const arg = getArg('[', ']');
944 nargs = convert<int>(arg);
946 // optional argument given?
949 vector<MathData> optionalValues;
950 while (nextToken().character() == '[') {
952 optionalValues.push_back(MathData());
953 parse(optionalValues[optionals], FLAG_BRACK_LAST, mode);
958 parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
960 // is a version for display attached?
963 if (nextToken().cat() == catBegin)
964 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
966 cell->push_back(MathAtom(new MathMacroTemplate(name, nargs,
967 optionals, MacroTypeNewcommand, optionalValues, def, display)));
971 else if (t.cs() == "newcommandx" ||
972 t.cs() == "renewcommandx") {
973 // \newcommandx{\foo}[2][usedefault, addprefix=\global,1=default]{#1,#2}
976 if (nextToken().cat() == catBegin) {
978 name = getToken().cs();
979 if (getToken().cat() != catEnd) {
980 error("'}' in \\newcommandx expected");
984 name = getToken().cs();
987 docstring const arg = getArg('[', ']');
989 error("[num] in \\newcommandx expected");
992 int nargs = convert<int>(arg);
996 vector<MathData> optionalValues;
997 if (nextToken().character() == '[') {
1001 // handle 'opt=value' options, separated by ','.
1003 while (nextToken().character() != ']' && good()) {
1004 if (nextToken().character() >= '1'
1005 && nextToken().character() <= '9') {
1006 // optional value -> get parameter number
1007 int n = getChar() - '0';
1009 error("Arity of \\newcommandx too low "
1010 "for given optional parameter.");
1015 if (getToken().character() != '=') {
1016 error("'=' and optional parameter value "
1017 "expected for \\newcommandx");
1022 int optNum = max(size_t(n), optionalValues.size());
1023 optionalValues.resize(optNum);
1024 optionalValues[n - 1].clear();
1025 while (nextToken().character() != ']'
1026 && nextToken().character() != ',') {
1028 parse(data, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1029 optionalValues[n - 1].append(data);
1031 optionals = max(n, optionals);
1032 } else if (nextToken().cat() == catLetter) {
1033 // we in fact ignore every non-optional
1038 while (nextToken().cat() == catLetter)
1044 if (nextToken().character() == '=') {
1046 while (nextToken().character() != ']'
1047 && nextToken().character() != ',')
1048 parse(value, FLAG_ITEM,
1049 InsetMath::UNDECIDED_MODE);
1052 error("option for \\newcommandx expected");
1058 if (nextToken().character() == ',') {
1061 } else if (nextToken().character() != ']') {
1062 error("Expecting ',' or ']' in options "
1063 "of \\newcommandx");
1076 parse(def, FLAG_ITEM, InsetMath::UNDECIDED_MODE);
1078 // is a version for display attached?
1081 if (nextToken().cat() == catBegin)
1082 parse(display, FLAG_ITEM, InsetMath::MATH_MODE);
1084 cell->push_back(MathAtom(new MathMacroTemplate(name, nargs,
1085 optionals, MacroTypeNewcommandx, optionalValues, def,
1089 else if (t.cs() == "(") {
1090 cell->push_back(MathAtom(new InsetMathHull(hullSimple)));
1091 parse2(cell->back(), FLAG_SIMPLE2, InsetMath::MATH_MODE, false);
1094 else if (t.cs() == "[") {
1095 cell->push_back(MathAtom(new InsetMathHull(hullEquation)));
1096 parse2(cell->back(), FLAG_EQUATION, InsetMath::MATH_MODE, false);
1099 else if (t.cs() == "protect")
1100 // ignore \\protect, will hopefully be re-added during output
1103 else if (t.cs() == "end") {
1104 if (flags & FLAG_END) {
1105 // eat environment name
1106 docstring const name = getArg('{', '}');
1107 if (environments_.empty())
1108 error("'found \\end{" + name +
1109 "}' without matching '\\begin{" +
1111 else if (name != environments_.back())
1112 error("'\\end{" + name +
1113 "}' does not match '\\begin{" +
1114 environments_.back() + "}'");
1116 environments_.pop_back();
1117 // Delete empty last row in matrix
1119 // If you abuse InsetMathGrid for
1120 // non-matrix like structures you
1121 // probably need to refine this test.
1122 // Right now we only have to test for
1123 // single line hull insets.
1124 if (grid.nrows() > 1)
1125 delEmptyLastRow(grid);
1129 error("found 'end' unexpectedly");
1132 else if (t.cs() == ")") {
1133 if (flags & FLAG_SIMPLE2)
1135 error("found '\\)' unexpectedly");
1138 else if (t.cs() == "]") {
1139 if (flags & FLAG_EQUATION)
1141 error("found '\\]' unexpectedly");
1144 else if (t.cs() == "\\") {
1145 if (flags & FLAG_ALIGN)
1148 if (nextToken().asInput() == "*") {
1150 added = addRow(grid, cellrow, docstring(), false);
1152 added = addRow(grid, cellrow, getArg('[', ']'));
1154 error("missing token after \\\\");
1157 if (grid.asHullInset())
1158 grid.asHullInset()->numbered(
1160 cell = &grid.cell(grid.index(cellrow,
1166 else if (t.cs() == "multicolumn") {
1167 // extract column count and insert dummy cells
1169 parse(count, FLAG_ITEM, mode);
1171 if (!extractNumber(count, cols)) {
1172 lyxerr << " can't extract number of cells from " << count << endl;
1174 // resize the table if necessary
1175 for (int i = 0; i < cols; ++i) {
1176 if (addCol(grid, cellcol)) {
1177 cell = &grid.cell(grid.index(
1179 // mark this as dummy
1180 grid.cellinfo(grid.index(
1181 cellrow, cellcol)).dummy_ = true;
1184 // the last cell is the real thing, not a dummy
1185 grid.cellinfo(grid.index(cellrow, cellcol)).dummy_ = false;
1187 // read special alignment
1189 parse(align, FLAG_ITEM, mode);
1190 //grid.cellinfo(grid.index(cellrow, cellcol)).align_ = extractString(align);
1192 // parse the remaining contents into the "real" cell
1193 parse(*cell, FLAG_ITEM, mode);
1197 else if (t.cs() == "limits")
1200 else if (t.cs() == "nolimits")
1203 else if (t.cs() == "nonumber") {
1204 if (grid.asHullInset())
1205 grid.asHullInset()->numbered(cellrow, false);
1208 else if (t.cs() == "number") {
1209 if (grid.asHullInset())
1210 grid.asHullInset()->numbered(cellrow, true);
1213 else if (t.cs() == "hline") {
1214 grid.rowinfo(cellrow).lines_ ++;
1217 else if (t.cs() == "sqrt") {
1219 parse(ar, FLAG_OPTION, mode);
1221 cell->push_back(MathAtom(new InsetMathRoot));
1222 cell->back().nucleus()->cell(0) = ar;
1223 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1225 cell->push_back(MathAtom(new InsetMathSqrt));
1226 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1230 else if (t.cs() == "unit") {
1231 // Allowed formats \unit[val]{unit}
1233 parse(ar, FLAG_OPTION, mode);
1235 cell->push_back(MathAtom(new InsetMathFrac(InsetMathFrac::UNIT)));
1236 cell->back().nucleus()->cell(0) = ar;
1237 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1239 cell->push_back(MathAtom(new InsetMathFrac(InsetMathFrac::UNIT, 1)));
1240 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1243 else if (t.cs() == "unitfrac") {
1244 // Here allowed formats are \unitfrac[val]{num}{denom}
1246 parse(ar, FLAG_OPTION, mode);
1248 cell->push_back(MathAtom(new InsetMathFrac(InsetMathFrac::UNITFRAC, 3)));
1249 cell->back().nucleus()->cell(2) = ar;
1251 cell->push_back(MathAtom(new InsetMathFrac(InsetMathFrac::UNITFRAC)));
1253 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1254 parse(cell->back().nucleus()->cell(1), FLAG_ITEM, mode);
1257 else if (t.cs() == "xrightarrow" || t.cs() == "xleftarrow") {
1258 cell->push_back(createInsetMath(t.cs()));
1259 parse(cell->back().nucleus()->cell(1), FLAG_OPTION, mode);
1260 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1263 else if (t.cs() == "ref" || t.cs() == "prettyref" ||
1264 t.cs() == "pageref" || t.cs() == "vpageref" || t.cs() == "vref") {
1265 cell->push_back(MathAtom(new InsetMathRef(t.cs())));
1266 parse(cell->back().nucleus()->cell(1), FLAG_OPTION, mode);
1267 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, mode);
1270 else if (t.cs() == "left") {
1272 Token const & tl = getToken();
1273 // \| and \Vert are equivalent, and InsetMathDelim
1275 // FIXME: fix this in InsetMathDelim itself!
1276 docstring const l = tl.cs() == "|" ? from_ascii("Vert") : tl.asString();
1278 parse(ar, FLAG_RIGHT, mode);
1282 Token const & tr = getToken();
1283 docstring const r = tr.cs() == "|" ? from_ascii("Vert") : tr.asString();
1284 cell->push_back(MathAtom(new InsetMathDelim(l, r, ar)));
1287 else if (t.cs() == "right") {
1288 if (flags & FLAG_RIGHT)
1290 //lyxerr << "got so far: '" << cell << "'" << endl;
1291 error("Unmatched right delimiter");
1295 else if (t.cs() == "begin") {
1296 docstring const name = getArg('{', '}');
1297 environments_.push_back(name);
1299 if (name == "array" || name == "subarray") {
1300 docstring const valign = parse_verbatim_option() + 'c';
1301 docstring const halign = parse_verbatim_item();
1302 cell->push_back(MathAtom(new InsetMathArray(name, (char)valign[0], halign)));
1303 parse2(cell->back(), FLAG_END, mode, false);
1306 else if (name == "tabular") {
1307 docstring const valign = parse_verbatim_option() + 'c';
1308 docstring const halign = parse_verbatim_item();
1309 cell->push_back(MathAtom(new InsetMathTabular(name, (char)valign[0], halign)));
1310 parse2(cell->back(), FLAG_END, InsetMath::TEXT_MODE, false);
1313 else if (name == "split" || name == "cases") {
1314 cell->push_back(createInsetMath(name));
1315 parse2(cell->back(), FLAG_END, mode, false);
1318 else if (name == "alignedat") {
1319 docstring const valign = parse_verbatim_option() + 'c';
1320 // ignore this for a while
1322 cell->push_back(MathAtom(new InsetMathSplit(name, (char)valign[0])));
1323 parse2(cell->back(), FLAG_END, mode, false);
1326 else if (name == "math") {
1327 cell->push_back(MathAtom(new InsetMathHull(hullSimple)));
1328 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, true);
1331 else if (name == "equation" || name == "equation*"
1332 || name == "displaymath") {
1333 cell->push_back(MathAtom(new InsetMathHull(hullEquation)));
1334 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, (name == "equation"));
1337 else if (name == "eqnarray" || name == "eqnarray*") {
1338 cell->push_back(MathAtom(new InsetMathHull(hullEqnArray)));
1339 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1342 else if (name == "align" || name == "align*") {
1343 cell->push_back(MathAtom(new InsetMathHull(hullAlign)));
1344 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1347 else if (name == "flalign" || name == "flalign*") {
1348 cell->push_back(MathAtom(new InsetMathHull(hullFlAlign)));
1349 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1352 else if (name == "alignat" || name == "alignat*") {
1353 // ignore this for a while
1355 cell->push_back(MathAtom(new InsetMathHull(hullAlignAt)));
1356 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1359 else if (name == "xalignat" || name == "xalignat*") {
1360 // ignore this for a while
1362 cell->push_back(MathAtom(new InsetMathHull(hullXAlignAt)));
1363 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1366 else if (name == "xxalignat") {
1367 // ignore this for a while
1369 cell->push_back(MathAtom(new InsetMathHull(hullXXAlignAt)));
1370 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1373 else if (name == "multline" || name == "multline*") {
1374 cell->push_back(MathAtom(new InsetMathHull(hullMultline)));
1375 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1378 else if (name == "gather" || name == "gather*") {
1379 cell->push_back(MathAtom(new InsetMathHull(hullGather)));
1380 parse2(cell->back(), FLAG_END, InsetMath::MATH_MODE, !stared(name));
1383 else if (latexkeys const * l = in_word_set(name)) {
1384 if (l->inset == "matrix") {
1385 cell->push_back(createInsetMath(name));
1386 parse2(cell->back(), FLAG_END, mode, false);
1387 } else if (l->inset == "split") {
1388 docstring const valign = parse_verbatim_option() + 'c';
1389 cell->push_back(MathAtom(new InsetMathSplit(name, (char)valign[0])));
1390 parse2(cell->back(), FLAG_END, mode, false);
1393 lyxerr << "found math environment `" << to_utf8(name)
1394 << "' in symbols file with unsupported inset `"
1395 << to_utf8(l->inset) << "'." << endl;
1396 // create generic environment inset
1397 cell->push_back(MathAtom(new InsetMathEnv(name)));
1398 parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1404 lyxerr << "found unknown math environment '" << to_utf8(name)
1406 // create generic environment inset
1407 cell->push_back(MathAtom(new InsetMathEnv(name)));
1408 parse(cell->back().nucleus()->cell(0), FLAG_END, mode);
1412 else if (t.cs() == "kern") {
1416 Token const & t = getToken();
1422 if (isValidLength(to_utf8(s)))
1425 cell->push_back(MathAtom(new InsetMathKern(s)));
1428 else if (t.cs() == "label") {
1429 // FIXME: This is swallowed in inline formulas
1430 docstring label = parse_verbatim_item();
1433 if (grid.asHullInset()) {
1434 grid.asHullInset()->label(cellrow, label);
1436 cell->push_back(createInsetMath(t.cs()));
1437 cell->push_back(MathAtom(new InsetMathBrace(ar)));
1441 else if (t.cs() == "choose" || t.cs() == "over" || t.cs() == "atop") {
1442 MathAtom at = createInsetMath(t.cs());
1443 at.nucleus()->cell(0) = *cell;
1445 parse(at.nucleus()->cell(1), flags, mode);
1446 cell->push_back(at);
1450 else if (t.cs() == "color") {
1451 docstring const color = parse_verbatim_item();
1452 cell->push_back(MathAtom(new InsetMathColor(true, color)));
1453 parse(cell->back().nucleus()->cell(0), flags, mode);
1457 else if (t.cs() == "textcolor") {
1458 docstring const color = parse_verbatim_item();
1459 cell->push_back(MathAtom(new InsetMathColor(false, color)));
1460 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1463 else if (t.cs() == "normalcolor") {
1464 cell->push_back(createInsetMath(t.cs()));
1465 parse(cell->back().nucleus()->cell(0), flags, mode);
1469 else if (t.cs() == "substack") {
1470 cell->push_back(createInsetMath(t.cs()));
1471 parse2(cell->back(), FLAG_ITEM, mode, false);
1474 else if (t.cs() == "xymatrix") {
1475 odocstringstream os;
1476 while (good() && nextToken().cat() != catBegin)
1477 os << getToken().asInput();
1478 cell->push_back(createInsetMath(t.cs() + os.str()));
1479 parse2(cell->back(), FLAG_ITEM, mode, false);
1482 else if (t.cs() == "framebox" || t.cs() == "makebox") {
1483 cell->push_back(createInsetMath(t.cs()));
1484 parse(cell->back().nucleus()->cell(0), FLAG_OPTION, InsetMath::TEXT_MODE);
1485 parse(cell->back().nucleus()->cell(1), FLAG_OPTION, InsetMath::TEXT_MODE);
1486 parse(cell->back().nucleus()->cell(2), FLAG_ITEM, InsetMath::TEXT_MODE);
1489 else if (t.cs() == "tag") {
1490 if (nextToken().character() == '*') {
1492 cell->push_back(createInsetMath(t.cs() + '*'));
1494 cell->push_back(createInsetMath(t.cs()));
1495 parse(cell->back().nucleus()->cell(0), FLAG_ITEM, InsetMath::TEXT_MODE);
1499 else if (t.cs() == "infer") {
1501 parse(ar, FLAG_OPTION, mode);
1502 cell->push_back(createInsetMath(t.cs()));
1503 parse2(cell->back(), FLAG_ITEM, mode, false);
1507 else if (1 && t.cs() == "ar") {
1508 auto_ptr<InsetMathXYArrow> p(new InsetMathXYArrow);
1509 // try to read target
1510 parse(p->cell(0), FLAG_OTPTION, mode);
1511 // try to read label
1512 if (nextToken().cat() == catSuper || nextToken().cat() == catSub) {
1513 p->up_ = nextToken().cat() == catSuper;
1515 parse(p->cell(1), FLAG_ITEM, mode);
1516 //lyxerr << "read label: " << p->cell(1) << endl;
1519 cell->push_back(MathAtom(p.release()));
1520 //lyxerr << "read cell: " << cell << endl;
1524 else if (t.cs().size()) {
1525 latexkeys const * l = in_word_set(t.cs());
1527 if (l->inset == "big") {
1529 docstring const delim = getToken().asInput();
1530 if (InsetMathBig::isBigInsetDelim(delim))
1531 cell->push_back(MathAtom(
1532 new InsetMathBig(t.cs(), delim)));
1534 cell->push_back(createInsetMath(t.cs()));
1539 else if (l->inset == "font") {
1540 cell->push_back(createInsetMath(t.cs()));
1541 parse(cell->back().nucleus()->cell(0),
1542 FLAG_ITEM, asMode(mode, l->extra));
1545 else if (l->inset == "oldfont") {
1546 cell->push_back(createInsetMath(t.cs()));
1547 parse(cell->back().nucleus()->cell(0),
1548 flags | FLAG_ALIGN, asMode(mode, l->extra));
1549 if (prevToken().cat() != catAlign &&
1550 prevToken().cs() != "\\")
1555 else if (l->inset == "style") {
1556 cell->push_back(createInsetMath(t.cs()));
1557 parse(cell->back().nucleus()->cell(0),
1558 flags | FLAG_ALIGN, mode);
1559 if (prevToken().cat() != catAlign &&
1560 prevToken().cs() != "\\")
1566 MathAtom at = createInsetMath(t.cs());
1567 for (InsetMath::idx_type i = 0; i < at->nargs(); ++i)
1568 parse(at.nucleus()->cell(i),
1569 FLAG_ITEM, asMode(mode, l->extra));
1570 cell->push_back(at);
1575 MathAtom at = createInsetMath(t.cs());
1576 InsetMath::mode_type m = mode;
1577 //if (m == InsetMath::UNDECIDED_MODE)
1578 //lyxerr << "default creation: m1: " << m << endl;
1579 if (at->currentMode() != InsetMath::UNDECIDED_MODE)
1580 m = at->currentMode();
1581 //lyxerr << "default creation: m2: " << m << endl;
1582 InsetMath::idx_type start = 0;
1583 // this fails on \bigg[...\bigg]
1585 //parse(opt, FLAG_OPTION, InsetMath::VERBATIM_MODE);
1588 // at.nucleus()->cell(0) = opt;
1590 for (InsetMath::idx_type i = start; i < at->nargs(); ++i) {
1591 parse(at.nucleus()->cell(i), FLAG_ITEM, m);
1594 cell->push_back(at);
1599 if (flags & FLAG_LEAVE) {
1600 flags &= ~FLAG_LEAVE;
1608 } // anonymous namespace
1611 void mathed_parse_cell(MathData & ar, docstring const & str)
1613 Parser(str).parse(ar, 0, InsetMath::MATH_MODE);
1617 void mathed_parse_cell(MathData & ar, istream & is)
1619 Parser(is).parse(ar, 0, InsetMath::MATH_MODE);
1623 bool mathed_parse_normal(MathAtom & t, docstring const & str)
1625 return Parser(str).parse(t);
1629 bool mathed_parse_normal(MathAtom & t, Lexer & lex)
1631 return Parser(lex).parse(t);
1635 void mathed_parse_normal(InsetMathGrid & grid, docstring const & str)
1637 Parser(str).parse1(grid, 0, InsetMath::MATH_MODE, false);
1643 fill(theCatcode, theCatcode + 128, catOther);
1644 fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
1645 fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
1647 theCatcode[int('\\')] = catEscape;
1648 theCatcode[int('{')] = catBegin;
1649 theCatcode[int('}')] = catEnd;
1650 theCatcode[int('$')] = catMath;
1651 theCatcode[int('&')] = catAlign;
1652 theCatcode[int('\n')] = catNewline;
1653 theCatcode[int('#')] = catParameter;
1654 theCatcode[int('^')] = catSuper;
1655 theCatcode[int('_')] = catSub;
1656 theCatcode[int(0x7f)] = catIgnore;
1657 theCatcode[int(' ')] = catSpace;
1658 theCatcode[int('\t')] = catSpace;
1659 theCatcode[int('\r')] = catNewline;
1660 theCatcode[int('~')] = catActive;
1661 theCatcode[int('%')] = catComment;