]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/math_parser.C
fix typo that put too many include paths for most people
[lyx.git] / src / mathed / math_parser.C
index 92c33cf725ebd6c00124d25a52917cf69317cbb6..70e827a319868badc88672d0ae707cf61bb2e4d1 100644 (file)
@@ -1,7 +1,7 @@
 /*
  *  File:        math_parser.C
  *  Purpose:     Parser for mathed
- *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx> 
+ *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
  *  Created:     January 1996
  *  Description: Parse LaTeX2e math mode code.
  *
@@ -15,7 +15,7 @@
  *   the GNU General Public Licence version 2 or later.
  */
 
-/* 
+/*
 
 If someone desperately needs partial "structures" (such as a few cells of
 an array inset or similar) (s)he could uses the following hack as starting
@@ -53,6 +53,7 @@ point to write some macros:
 #include "math_inset.h"
 #include "math_arrayinset.h"
 #include "math_braceinset.h"
+#include "math_boxinset.h"
 #include "math_charinset.h"
 #include "math_deliminset.h"
 #include "math_factory.h"
@@ -73,7 +74,7 @@ point to write some macros:
 
 #include "lyxlex.h"
 #include "debug.h"
-
+#include "support/LAssert.h"
 #include "support/lstrings.h"
 
 #include <cctype>
@@ -86,6 +87,9 @@ using std::ios;
 using std::endl;
 using std::stack;
 using std::fill;
+using std::vector;
+
+//#define FILEDEBUG
 
 
 namespace {
@@ -105,7 +109,7 @@ void add(MathArray & ar, char c, MathTextCodes code)
 
 // These are TeX's catcodes
 enum CatCode {
-       catEscape,     // 0    backslash 
+       catEscape,     // 0    backslash
        catBegin,      // 1    {
        catEnd,        // 2    }
        catMath,       // 3    $
@@ -114,7 +118,7 @@ enum CatCode {
        catParameter,  // 6    #
        catSuper,      // 7    ^
        catSub,        // 8    _
-       catIgnore,     // 9       
+       catIgnore,     // 9
        catSpace,      // 10   space
        catLetter,     // 11   a-zA-Z
        catOther,      // 12   none of the above
@@ -123,7 +127,7 @@ enum CatCode {
        catInvalid     // 15   <delete>
 };
 
-CatCode theCatcode[256];  
+CatCode theCatcode[256];
 
 
 inline CatCode catcode(unsigned char c)
@@ -151,21 +155,21 @@ void catInit()
        fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
        fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
 
-       theCatcode['\\'] = catEscape;   
-       theCatcode['{']  = catBegin;    
-       theCatcode['}']  = catEnd;      
-       theCatcode['$']  = catMath;     
-       theCatcode['&']  = catAlign;    
-       theCatcode['\n'] = catNewline;  
-       theCatcode['#']  = catParameter;        
-       theCatcode['^']  = catSuper;    
-       theCatcode['_']  = catSub;      
-       theCatcode['\7f'] = catIgnore;    
-       theCatcode[' ']  = catSpace;    
-       theCatcode['\t'] = catSpace;    
-       theCatcode['\r'] = catSpace;    
-       theCatcode['~']  = catActive;   
-       theCatcode['%']  = catComment;  
+       theCatcode['\\'] = catEscape;
+       theCatcode['{']  = catBegin;
+       theCatcode['}']  = catEnd;
+       theCatcode['$']  = catMath;
+       theCatcode['&']  = catAlign;
+       theCatcode['\n'] = catNewline;
+       theCatcode['#']  = catParameter;
+       theCatcode['^']  = catSuper;
+       theCatcode['_']  = catSub;
+       theCatcode['\7f'] = catIgnore;
+       theCatcode[' ']  = catSpace;
+       theCatcode['\t'] = catSpace;
+       theCatcode['\r'] = catSpace;
+       theCatcode['~']  = catActive;
+       theCatcode['%']  = catComment;
 }
 
 
@@ -194,7 +198,7 @@ public:
        ///
        bool isCR() const;
 
-private:       
+private:
        ///
        string cs_;
        ///
@@ -217,7 +221,7 @@ string Token::asString() const
 //bool operator==(Token const & s, Token const & t)
 //{
 //     return s.character() == t.character()
-//             && s.cat() == t.cat() && s.cs() == t.cs(); 
+//             && s.cat() == t.cat() && s.cs() == t.cs();
 //}
 //
 //bool operator!=(Token const & s, Token const & t)
@@ -303,7 +307,7 @@ private:
        ///
        int lineno_;
        ///
-       std::vector<Token> tokens_;
+       vector<Token> tokens_;
        ///
        unsigned pos_;
        ///
@@ -422,17 +426,17 @@ char Parser::getChar()
 }
 
 
-string Parser::getArg(char lf, char rg)
+string Parser::getArg(char left, char right)
 {
        skipSpaces();
 
        string result;
        char c = getChar();
 
-       if (c != lf)  
+       if (c != left)
                putback();
-       else 
-               while ((c = getChar()) != rg && good())
+       else
+               while ((c = getChar()) != right && good())
                        result += c;
 
        return result;
@@ -472,7 +476,7 @@ void Parser::skipSpaceTokens(istream & is, char c)
 void Parser::tokenize(string const & buffer)
 {
        static bool init_done = false;
-       
+
        if (!init_done) {
                catInit();
                init_done = true;
@@ -486,13 +490,13 @@ void Parser::tokenize(string const & buffer)
 
                switch (catcode(c)) {
                        case catNewline: {
-                               ++lineno_; 
+                               ++lineno_;
                                is.get(c);
                                if (catcode(c) == catNewline)
                                        ; //push_back(Token("par"));
                                else {
                                        push_back(Token(' ', catSpace));
-                                       is.putback(c);  
+                                       is.putback(c);
                                }
                                break;
                        }
@@ -500,7 +504,7 @@ void Parser::tokenize(string const & buffer)
                        case catComment: {
                                while (is.get(c) && catcode(c) != catNewline)
                                        ;
-                               ++lineno_; 
+                               ++lineno_;
                                break;
                        }
 
@@ -515,7 +519,7 @@ void Parser::tokenize(string const & buffer)
                                                while (is.get(c) && catcode(c) == catLetter)
                                                        s += c;
                                                skipSpaceTokens(is, c);
-                                       }       
+                                       }
                                        push_back(Token(s));
                                }
                                break;
@@ -539,20 +543,25 @@ void Parser::tokenize(string const & buffer)
                }
        }
 
-       //dump();
+#ifdef FILEDEBUG
+       dump();
+#endif
 }
 
 
 void Parser::dump() const
 {
        lyxerr << "\nTokens: ";
-       for (unsigned i = 0; i < tokens_.size(); ++i)
+       for (unsigned i = 0; i < tokens_.size(); ++i) {
+               if (i == pos_)
+                       lyxerr << " <#> ";
                lyxerr << tokens_[i];
+       }
        lyxerr << "\n";
 }
 
 
-void Parser::error(string const & msg) 
+void Parser::error(string const & msg)
 {
        lyxerr << "Line ~" << lineno_ << ": Math parse error: " << msg << endl;
        dump();
@@ -562,7 +571,7 @@ void Parser::error(string const & msg)
 
 
 bool Parser::parse_lines(MathAtom & t, bool numbered, bool outmost)
-{      
+{
        MathGridInset * p = t->asGridInset();
        if (!p) {
                dump();
@@ -583,10 +592,16 @@ bool Parser::parse_lines(MathAtom & t, bool numbered, bool outmost)
                curr_label_.erase();
 
                // reading a row
-               for (MathInset::col_type col = 0; col < p->ncols(); ++col) {
-                       //lyxerr << "reading cell " << row << " " << col << "\n";
+               for (MathInset::col_type col = 0; true; ++col) {
+                       //lyxerr << "reading cell " << row << " " << col << " "
+                       // << p->ncols() << "\n";
                        //lyxerr << "ncols: " << p->ncols() << "\n";
-               
+
+                       if (col >= p->ncols()) {
+                               //lyxerr << "adding col " << col << "\n";
+                               p->addCol(p->ncols());
+                       }
+
                        MathArray & ar = p->cell(col + row * p->ncols());
                        parse_into(ar, FLAG_BLOCK);
                        // remove 'unnecessary' braces:
@@ -600,7 +615,7 @@ bool Parser::parse_lines(MathAtom & t, bool numbered, bool outmost)
                                //      << row << " " << col << "\n";
                                break;
                        }
-                       
+
                        // skip the ampersand
                        getToken();
                }
@@ -654,7 +669,7 @@ bool Parser::parse_lines(MathAtom & t, bool numbered, bool outmost)
 
 
 bool Parser::parse_lines2(MathAtom & t, bool braced)
-{      
+{
        MathGridInset * p = t->asGridInset();
        if (!p) {
                lyxerr << "error in Parser::parse_lines() 1\n";
@@ -665,7 +680,7 @@ bool Parser::parse_lines2(MathAtom & t, bool braced)
                // reading a row
                for (MathInset::col_type col = 0; true; ++col) {
                        //lyxerr << "reading cell " << row << " " << col << " " << p->ncols() << "\n";
-               
+
                        if (col >= p->ncols()) {
                                //lyxerr << "adding col " << col << "\n";
                                p->addCol(p->ncols());
@@ -679,7 +694,7 @@ bool Parser::parse_lines2(MathAtom & t, bool braced)
                                //lyxerr << "less cells read than normal in row/col: " << row << " " << col << "\n";
                                break;
                        }
-                       
+
                        // skip the ampersand
                        getToken();
                }
@@ -715,48 +730,82 @@ bool Parser::parse_lines2(MathAtom & t, bool braced)
 
 
 
+
 bool Parser::parse_macro(string & name)
 {
+       int nargs = 0;
        name = "{error}";
        skipSpaces();
 
-       if (getToken().cs() != "newcommand") {
-               lyxerr << "\\newcommand expected\n";
-               return false;
-       }
+       if (nextToken().cs() == "def") {
 
-       if (getToken().cat() != catBegin) {
-               lyxerr << "'{' in \\newcommand expected (1)\n";
-               return false;
-       }
+               getToken();
+               name = getToken().cs();
 
-       name = getToken().cs();
+               string pars;
+               while (good() && nextToken().cat() != catBegin)
+                       pars += getToken().cs();
+       
+               if (!good()) {
+                       lyxerr << "bad stream in parse_macro\n";
+                       dump();
+                       return false;
+               }
+                       
+               //lyxerr << "read \\def parameter list '" << pars << "'\n";
+               if (!pars.empty()) {
+                       lyxerr << "can't handle non-empty parameter lists\n";
+                       dump();
+                       return false;
+               }
 
-       if (getToken().cat() != catEnd) {
-               lyxerr << "'}' expected\n";
+       } else if (nextToken().cs() == "newcommand") {
+
+               getToken();
+
+               if (getToken().cat() != catBegin) {
+                       lyxerr << "'{' in \\newcommand expected (1) \n";
+                       dump();
+                       return false;
+               }
+
+               name = getToken().cs();
+
+               if (getToken().cat() != catEnd) {
+                       lyxerr << "'}' expected\n";
+                       return false;
+               }
+
+               string arg  = getArg('[', ']');
+               if (!arg.empty())
+                       nargs = atoi(arg.c_str());
+
+       } else { 
+               lyxerr << "\\newcommand or \\def  expected\n";
                return false;
        }
 
-       string    arg  = getArg('[', ']');
-       int       narg = arg.empty() ? 0 : atoi(arg.c_str()); 
 
        if (getToken().cat() != catBegin) {
-               lyxerr << "'{' in \\newcommand expected (2)\n";
+               lyxerr << "'{' in macro definition expected (2)\n";
                return false;
        }
 
-       MathArray ar;
-       parse_into(ar, FLAG_BRACE_LAST);
+       MathArray ar1;
+       parse_into(ar1, FLAG_BRACE_LAST);
 
        // we cannot handle recursive stuff at all
        MathArray test;
        test.push_back(createMathInset(name));
-       if (ar.contains(test)) {
+       if (ar1.contains(test)) {
                lyxerr << "we cannot handle recursive macros at all.\n";
                return false;
        }
 
-       MathMacroTable::create(name, narg, ar);
+       MathArray ar2;
+       parse_into(ar2, FLAG_ITEM);
+
+       MathMacroTable::create(name, nargs, ar1, ar2);
        return true;
 }
 
@@ -894,22 +943,27 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
 
        while (good()) {
                Token const & t = getToken();
-       
-               //lyxerr << "t: " << t << " flags: " << flags << "\n";
-               //array.dump(lyxerr);
-               //lyxerr << "\n";
+
+#ifdef FILEDEBUG
+               lyxerr << "t: " << t << " flags: " << flags << "\n";
+               //array.dump();
+               lyxerr << "\n";
+#endif
 
                if (flags & FLAG_ITEM) {
+                       if (t.cat() == catSpace)
+                               continue;
+
                        flags &= ~FLAG_ITEM;
-                       if (t.cat() == catBegin) { 
+                       if (t.cat() == catBegin) {
                                // skip the brace and collect everything to the next matching
                                // closing brace
                                flags |= FLAG_BRACE_LAST;
                                continue;
-                       } else {
-                               // handle only this single token, leave the loop if done
-                               flags |= FLAG_LEAVE;
                        }
+
+                       // handle only this single token, leave the loop if done
+                       flags |= FLAG_LEAVE;
                }
 
                if (flags & FLAG_BLOCK) {
@@ -961,7 +1015,7 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                        // ignore braces around simple items
                        if ((ar.size() == 1 && !ar.front()->needsBraces()
        || (ar.size() == 2 && !ar.front()->needsBraces()
-                                           && ar.back()->asScriptInset()))
+                                           && ar.back()->asScriptInset()))
        || (ar.size() == 0 && array.size() == 0))
                        {
                                array.push_back(ar);
@@ -974,21 +1028,23 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                else if (t.cat() == catEnd) {
                        if (flags & FLAG_BRACE_LAST)
                                return;
+                       dump();
                        lyxerr << "found '}' unexpectedly, array: '" << array << "'\n";
                        //lyxerr << "found '}' unexpectedly\n";
+                       lyx::Assert(0);
                        add(array, '}', LM_TC_TEX);
                }
-               
+
                else if (t.cat() == catAlign) {
                        lyxerr << "found tab unexpectedly, array: '" << array << "'\n";
                        //lyxerr << "found tab unexpectedly\n";
                        add(array, '&', LM_TC_TEX);
                }
-               
+
                else if (t.cat() == catSuper || t.cat() == catSub) {
                        bool up = (t.cat() == catSuper);
-                       MathScriptInset * p = 0; 
-                       if (array.size()) 
+                       MathScriptInset * p = 0;
+                       if (array.size())
                                p = array.back()->asScriptInset();
                        if (!p || p->has(up)) {
                                array.push_back(MathAtom(new MathScriptInset(up)));
@@ -1005,12 +1061,12 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
 
                else if (t.cat() == catOther)
                        add(array, t.character(), code);
-               
+
                //
                // control sequences
-               //      
+               //
                else if (t.cs() == "protect")
-                       // ignore \\protect, will be re-added during output 
+                       // ignore \\protect, will be re-added during output
                        ;
 
                else if (t.cs() == "end")
@@ -1028,13 +1084,13 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                        lyxerr << "found newline unexpectedly\n";
                        array.push_back(createMathInset("\\"));
                }
-       
+
                else if (t.cs() == "limits")
                        limits = 1;
-               
+
                else if (t.cs() == "nolimits")
                        limits = -1;
-               
+
                else if (t.cs() == "nonumber")
                        curr_num_ = false;
 
@@ -1053,7 +1109,7 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                                parse_into(array.back()->cell(0), FLAG_ITEM);
                        }
                }
-               
+
                else if (t.cs() == "left") {
                        string l = getToken().asString();
                        MathArray ar;
@@ -1063,7 +1119,7 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                        dl->cell(0) = ar;
                        array.push_back(dl);
                }
-               
+
                else if (t.cs() == "right") {
                        if (!(flags & FLAG_RIGHT)) {
                                //lyxerr << "got so far: '" << array << "'\n";
@@ -1073,23 +1129,24 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                }
 
                else if (t.cs() == "begin") {
-                       string const name = getArg('{', '}');   
-                       if (name == "array") {
+                       string const name = getArg('{', '}');
+                       if (name == "array" || name == "subarray") {
                                string const valign = getArg('[', ']') + 'c';
                                string const halign = getArg('{', '}');
-                               array.push_back(MathAtom(new MathArrayInset(valign[0], halign)));
+                               array.push_back(MathAtom(new MathArrayInset(name, valign[0], halign)));
                                parse_lines(array.back(), false, false);
-                       } else if (name == "split" || name == "cases") {
+                       } else if (name == "split" || name == "cases" ||
+                                        name == "gathered" || name == "aligned") {
                                array.push_back(createMathInset(name));
                                parse_lines(array.back(), false, false);
-                       } else if (name == "pmatrix" || name == "bmatrix" ||
-                                        name == "vmatrix" || name == "Vmatrix") {
+                       } else if (name == "matrix"  || name == "pmatrix" || name == "bmatrix" ||
+                                        name == "vmatrix" || name == "Vmatrix") {
                                array.push_back(createMathInset(name));
                                parse_lines2(array.back(), false);
-                       } else 
-                               lyxerr << "unknow math inset begin '" << name << "'\n"; 
+                       } else
+                               lyxerr << "unknow math inset begin '" << name << "'\n";
                }
-       
+
                else if (t.cs() == "kern") {
 #ifdef WITH_WARNINGS
 #warning A hack...
@@ -1098,7 +1155,7 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                        while (1) {
                                Token const & t = getToken();
                                if (!good()) {
-                                       putback();      
+                                       putback();
                                        break;
                                }
                                s += t.character();
@@ -1108,6 +1165,14 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                        array.push_back(MathAtom(new MathKernInset(s)));
                }
 
+/*
+               else if (t.cs() == "lyxkern") {
+                       MathAtom p = createMathInset(t.cs());
+                       parse_into(p->cell(0), flags, code);
+                       array.push_back(p);
+               }
+*/
+
                else if (t.cs() == "label") {
                        curr_label_ = getArg('{', '}');
                }
@@ -1120,6 +1185,12 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                        return;
                }
 
+               else if (t.cs() == "substack") {
+                       array.push_back(createMathInset(t.cs()));
+                       skipBegin();
+                       parse_lines2(array.back(), true);
+               }
+
                else if (t.cs() == "xymatrix") {
                        array.push_back(createMathInset(t.cs()));
                        skipBegin();
@@ -1151,17 +1222,20 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                        array.push_back(MathAtom(p));
                        //lyxerr << "read array: " << array << "\n";
                }
+#endif
 
-               else if (t.cs() == "mbox") {
-                       array.push_back(createMathInset(t.cs()));
+#if 0
+               else if (t.cs() == "mbox" || t.cs() == "text") {
+                       //array.push_back(createMathInset(t.cs()));
+                       array.push_back(MathAtom(new MathBoxInset(t.cs())));
                        // slurp in the argument of mbox
-       
+
                        MathBoxInset * p = array.back()->asBoxInset();
                        //lyx::assert(p);
                }
 #endif
 
-       
+
                else if (t.cs().size()) {
                        latexkeys const * l = in_word_set(t.cs());
                        if (l) {
@@ -1169,8 +1243,8 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
                                        //lyxerr << "starting font\n";
                                        //CatCode catSpaceSave = theCatcode[' '];
                                        //if (l->id == LM_TC_TEXTRM) {
-                                       //      // temporarily change catcode   
-                                       //      theCatcode[' '] = catLetter;    
+                                       //      // temporarily change catcode
+                                       //      theCatcode[' '] = catLetter;
                                        //}
 
                                        MathArray ar;
@@ -1201,7 +1275,7 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
 
                                else {
                                        MathAtom p = createMathInset(t.cs());
-                                       for (MathInset::idx_type i = 0; i < p->nargs(); ++i) 
+                                       for (MathInset::idx_type i = 0; i < p->nargs(); ++i)
                                                parse_into(p->cell(i), FLAG_ITEM);
                                        array.push_back(p);
                                }
@@ -1224,7 +1298,7 @@ void Parser::parse_into1(MathArray & array, unsigned flags, MathTextCodes code)
 
        if (panic) {
                lyxerr << " Math Panic, expect problems!\n";
-               //   Search for the end command. 
+               //   Search for the end command.
                Token t;
                do {
                        t = getToken();