]> git.lyx.org Git - lyx.git/blobdiff - src/tex2lyx/texparser.C
Fix bug 2667
[lyx.git] / src / tex2lyx / texparser.C
index a638b93890d05f2e52cc0e13491d299b481360cf..bdfea89a5357358bb9bc5f4ff6e4495f985adbec 100644 (file)
@@ -1,31 +1,90 @@
-#include "parser.h"
+/**
+ * \file texparser.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
+#include <config.h>
+
+#include "texparser.h"
+
+#include <iostream>
+#include <sstream>
 
 using std::cerr;
 using std::endl;
 using std::fill;
-using std::ios;
 using std::istream;
 using std::istringstream;
+using std::ostringstream;
 using std::ostream;
 using std::string;
 
 
-// 
-// catcodes
-//
+namespace {
+
+CatCode theCatcode[256];
 
-mode_type asMode(mode_type oldmode, string const & str)
+void catInit()
 {
-       if (str == "mathmode")
-               return MATH_MODE;
-       if (str == "textmode" || str == "forcetext")
-               return TEXT_MODE;
-       return oldmode;
+       fill(theCatcode, theCatcode + 256, catOther);
+       fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
+       fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
+
+       theCatcode[int('\\')] = catEscape;
+       theCatcode[int('{')]  = catBegin;
+       theCatcode[int('}')]  = catEnd;
+       theCatcode[int('$')]  = catMath;
+       theCatcode[int('&')]  = catAlign;
+       theCatcode[int('\n')] = catNewline;
+       theCatcode[int('#')]  = catParameter;
+       theCatcode[int('^')]  = catSuper;
+       theCatcode[int('_')]  = catSub;
+       theCatcode[0x7f]      = catIgnore;
+       theCatcode[int(' ')]  = catSpace;
+       theCatcode[int('\t')] = catSpace;
+       theCatcode[int('\r')] = catNewline;
+       theCatcode[int('~')]  = catActive;
+       theCatcode[int('%')]  = catComment;
+
+       // This is wrong!
+       theCatcode[int('@')]  = catLetter;
 }
 
 
-CatCode theCatcode[256];
+/*!
+ * Translate a line ending to '\n'.
+ * \p c must have catcode catNewline, and it must be the last character read
+ * from \p is.
+ */
+char getNewline(istream & is, char c)
+{
+       // we have to handle 3 different line endings:
+       // - UNIX (\n)
+       // - MAC  (\r)
+       // - DOS  (\r\n)
+       if (c == '\r') {
+               // MAC or DOS
+               if (is.get(c) && c != '\n') {
+                       // MAC
+                       is.putback(c);
+               }
+               return '\n';
+       }
+       // UNIX
+       return c;
+}
+
+}
+
 
+//
+// catcodes
+//
 
 CatCode catcode(unsigned char c)
 {
@@ -33,29 +92,6 @@ CatCode catcode(unsigned char c)
 }
 
 
-void catInit()
-{
-       fill(theCatcode, theCatcode + 256, catOther);
-       fill(theCatcode + 'a', theCatcode + 'z' + 1, catLetter);
-       fill(theCatcode + 'A', theCatcode + 'Z' + 1, catLetter);
-
-       theCatcode['\\'] = catEscape;
-       theCatcode['{']  = catBegin;
-       theCatcode['}']  = catEnd;
-       theCatcode['$']  = cat;
-       theCatcode['&']  = catAlign;
-       theCatcode['\n'] = catNewline;
-       theCatcode['#']  = catParameter;
-       theCatcode['^']  = catSuper;
-       theCatcode['_']  = catSub;
-       theCatcode['\7f'] = catIgnore;
-       theCatcode[' ']  = catSpace;
-       theCatcode['\t'] = catSpace;
-       theCatcode['\r'] = catNewline;
-       theCatcode['~']  = catActive;
-       theCatcode['%']  = catComment;
-}
-
 
 //
 // Token
@@ -63,14 +99,38 @@ void catInit()
 
 ostream & operator<<(ostream & os, Token const & t)
 {
-       if (t.cs().size())
-               os << '\\' << t.cs();
+       if (t.cat() == catComment)
+               os << '%' << t.cs() << '\n';
+       else if (t.cat() == catSpace)
+               os << t.cs();
+       else if (t.cat() == catEscape)
+               os << '\\' << t.cs() << ' ';
+       else if (t.cat() == catLetter)
+               os << t.character();
+       else if (t.cat() == catNewline)
+               os << "[" << t.cs().size() << "\\n," << t.cat() << "]\n";
        else
                os << '[' << t.character() << ',' << t.cat() << ']';
        return os;
 }
 
 
+string Token::asString() const
+{
+       return cs_.size() ? cs_ : string(1, char_);
+}
+
+
+string Token::asInput() const
+{
+       if (cat_ == catComment)
+               return '%' + cs_ + '\n';
+       if (cat_ == catSpace || cat_ == catNewline)
+               return cs_;
+       return char_ ? string(1, char_) : '\\' + cs_;
+}
+
+
 //
 // Parser
 //
@@ -83,6 +143,14 @@ Parser::Parser(istream & is)
 }
 
 
+Parser::Parser(string const & s)
+       : lineno_(0), pos_(0)
+{
+       istringstream is(s);
+       tokenize(is);
+}
+
+
 void Parser::push_back(Token const & t)
 {
        tokens_.push_back(t);
@@ -95,21 +163,28 @@ void Parser::pop_back()
 }
 
 
-Token const & Parser::prevToken() const
+Token const & Parser::prev_token() const
+{
+       static const Token dummy;
+       return pos_ > 1 ? tokens_[pos_ - 2] : dummy;
+}
+
+
+Token const & Parser::curr_token() const
 {
        static const Token dummy;
        return pos_ > 0 ? tokens_[pos_ - 1] : dummy;
 }
 
 
-Token const & Parser::nextToken() const
+Token const & Parser::next_token() const
 {
        static const Token dummy;
        return good() ? tokens_[pos_] : dummy;
 }
 
 
-Token const & Parser::getToken()
+Token const & Parser::get_token()
 {
        static const Token dummy;
        //cerr << "looking at token " << tokens_[pos_] << " pos: " << pos_ << '\n';
@@ -117,10 +192,63 @@ Token const & Parser::getToken()
 }
 
 
-void Parser::skipSpaces()
+bool Parser::isParagraph() const
 {
-       while (nextToken().cat() == catSpace || nextToken().cat() == catNewline)
-               getToken();
+       // A new paragraph in TeX ist started
+       // - either by a newline, following any amount of whitespace
+       //   characters (including zero), and another newline
+       // - or the token \par
+       if (curr_token().cat() == catNewline &&
+           (curr_token().cs().size() > 1 ||
+            (next_token().cat() == catSpace &&
+             pos_ < tokens_.size() - 1 &&
+             tokens_[pos_ + 1].cat() == catNewline)))
+               return true;
+       if (curr_token().cat() == catEscape && curr_token().cs() == "par")
+               return true;
+       return false;
+}
+
+
+void Parser::skip_spaces(bool skip_comments)
+{
+       // We just silently return if we have no more tokens.
+       // skip_spaces() should be callable at any time,
+       // the caller must check p::good() anyway.
+       while (good()) {
+               get_token();
+               if (isParagraph()) {
+                       putback();
+                       break;
+               }
+               if ( curr_token().cat() == catSpace ||
+                    curr_token().cat() == catNewline ||
+                   (curr_token().cat() == catComment && curr_token().cs().empty()))
+                       continue;
+               if (skip_comments && curr_token().cat() == catComment)
+                       cerr << "  Ignoring comment: " << curr_token().asInput();
+               else {
+                       putback();
+                       break;
+               }
+       }
+}
+
+
+void Parser::unskip_spaces(bool skip_comments)
+{
+       while (pos_ > 0) {
+               if ( curr_token().cat() == catSpace ||
+                   (curr_token().cat() == catNewline && curr_token().cs().size() == 1))
+                       putback();
+               else if (skip_comments && curr_token().cat() == catComment) {
+                       // TODO: Get rid of this
+                       cerr << "Unignoring comment: " << curr_token().asInput();
+                       putback();
+               }
+               else
+                       break;
+       }
 }
 
 
@@ -144,57 +272,89 @@ char Parser::getChar()
 }
 
 
-string Parser::getArg(char left, char right)
+Parser::Arg Parser::getFullArg(char left, char right)
 {
-       skipSpaces();
+       skip_spaces(true);
+
+       // This is needed if a partial file ends with a command without arguments,
+       // e. g. \medskip
+       if (! good())
+               return std::make_pair(false, string());
 
        string result;
        char c = getChar();
 
-       if (c != left)
+       if (c != left) {
                putback();
-       else
-               while ((c = getChar()) != right && good())
-                       result += c;
+               return std::make_pair(false, string());
+       } else
+               while ((c = getChar()) != right && good()) {
+                       // Ignore comments
+                       if (curr_token().cat() == catComment) {
+                               if (!curr_token().cs().empty())
+                                       cerr << "Ignoring comment: " << curr_token().asInput();
+                       }
+                       else
+                               result += curr_token().asInput();
+               }
 
-       return result;
+       return std::make_pair(true, result);
 }
 
 
-void Parser::skipSpaceTokens(istream & is, char c)
+string Parser::getArg(char left, char right)
 {
-       // skip trailing spaces
-       while (catcode(c) == catSpace || catcode(c) == catNewline)
-               if (!is.get(c))
-                       break;
-       //cerr << "putting back: " << c << "\n";
-       is.putback(c);
+       return getFullArg(left, right).second;
 }
 
 
-void Parser::tokenize(istream & is)
+string Parser::getFullOpt()
 {
-       // eat everything up to the next \end_inset or end of stream
-       // and store it in s for further tokenization
-       string s;
-       char c;
-       while (is.get(c)) {
-               s += c;
-               if (s.size() >= 10 && s.substr(s.size() - 10) == "\\end_inset") {
-                       s = s.substr(0, s.size() - 10);
-                       break;
-               }
-       }
-       // Remove the space after \end_inset
-       if (is.get(c) && c != ' ')
-               is.unget();
+       Arg arg = getFullArg('[', ']');
+       if (arg.first)
+               return '[' + arg.second + ']';
+       return arg.second;
+}
+
 
-       // tokenize buffer
-       tokenize(s);
+string Parser::getOpt()
+{
+       string const res = getArg('[', ']');
+       return res.empty() ? string() : '[' + res + ']';
 }
 
 
-void Parser::tokenize(string const & buffer)
+string const Parser::verbatimEnvironment(string const & name)
+{
+       if (!good())
+               return string();
+
+       ostringstream os;
+       for (Token t = get_token(); good(); t = get_token()) {
+               if (t.cat() == catBegin) {
+                       putback();
+                       os << '{' << verbatim_item() << '}';
+               } else if (t.asInput() == "\\begin") {
+                       string const env = getArg('{', '}');
+                       os << "\\begin{" << env << '}'
+                          << verbatimEnvironment(env)
+                          << "\\end{" << env << '}';
+               } else if (t.asInput() == "\\end") {
+                       string const end = getArg('{', '}');
+                       if (end != name)
+                               cerr << "\\end{" << end
+                                    << "} does not match \\begin{" << name
+                                    << "}." << endl;
+                       return os.str();
+               } else
+                       os << t.asInput();
+       }
+       cerr << "unexpected end of input" << endl;
+       return os.str();
+}
+
+
+void Parser::tokenize(istream & is)
 {
        static bool init_done = false;
 
@@ -203,33 +363,49 @@ void Parser::tokenize(string const & buffer)
                init_done = true;
        }
 
-       istringstream is(buffer.c_str(), ios::in | ios::binary);
-
        char c;
        while (is.get(c)) {
                //cerr << "reading c: " << c << "\n";
 
                switch (catcode(c)) {
+                       case catSpace: {
+                               string s(1, c);
+                               while (is.get(c) && catcode(c) == catSpace)
+                                       s += c;
+                               if (catcode(c) != catSpace)
+                                       is.putback(c);
+                               push_back(Token(s, catSpace));
+                               break;
+                       }
+
                        case catNewline: {
                                ++lineno_;
-                               is.get(c);
-                               if (catcode(c) == catNewline)
-                                       push_back(Token("par"));
-                               else {
-                                       push_back(Token('\n', catNewline));
-                                       is.putback(c);
+                               string s(1, getNewline(is, c));
+                               while (is.get(c) && catcode(c) == catNewline) {
+                                       ++lineno_;
+                                       s += getNewline(is, c);
                                }
+                               if (catcode(c) != catNewline)
+                                       is.putback(c);
+                               push_back(Token(s, catNewline));
                                break;
                        }
 
-/*
                        case catComment: {
+                               // We don't treat "%\n" combinations here specially because
+                               // we want to preserve them in the preamble
+                               string s;
                                while (is.get(c) && catcode(c) != catNewline)
-                                       ;
+                                       s += c;
+                               // handle possible DOS line ending
+                               if (catcode(c) == catNewline)
+                                       c = getNewline(is, c);
+                               // Note: The '%' at the beginning and the '\n' at the end
+                               // of the comment are not stored.
                                ++lineno_;
+                               push_back(Token(s, catComment));
                                break;
                        }
-*/
 
                        case catEscape: {
                                is.get(c);
@@ -241,21 +417,14 @@ void Parser::tokenize(string const & buffer)
                                                // collect letters
                                                while (is.get(c) && catcode(c) == catLetter)
                                                        s += c;
-                                               skipSpaceTokens(is, c);
+                                               if (catcode(c) != catLetter)
+                                                       is.putback(c);
                                        }
-                                       push_back(Token(s));
+                                       push_back(Token(s, catEscape));
                                }
                                break;
                        }
 
-                       case catSuper:
-                       case catSub: {
-                               push_back(Token(c, catcode(c)));
-                               is.get(c);
-                               skipSpaceTokens(is, c);
-                               break;
-                       }
-
                        case catIgnore: {
                                cerr << "ignoring a char: " << int(c) << "\n";
                                break;
@@ -265,10 +434,6 @@ void Parser::tokenize(string const & buffer)
                                push_back(Token(c, catcode(c)));
                }
        }
-
-#ifdef FILEDEBUG
-       dump();
-#endif
 }
 
 
@@ -295,12 +460,12 @@ void Parser::error(string const & msg)
 string Parser::verbatimOption()
 {
        string res;
-       if (nextToken().character() == '[') {
-               Token t = getToken();
-               for (Token t = getToken(); t.character() != ']' && good(); t = getToken()) {
+       if (next_token().character() == '[') {
+               Token t = get_token();
+               for (Token t = get_token(); t.character() != ']' && good(); t = get_token()) {
                        if (t.cat() == catBegin) {
                                putback();
-                               res += '{' + verbatimItem() + '}';
+                               res += '{' + verbatim_item() + '}';
                        } else
                                res += t.asString();
                }
@@ -309,19 +474,41 @@ string Parser::verbatimOption()
 }
 
 
-string Parser::verbatimItem()
+string Parser::verbatim_item()
 {
-       string res;
-       if (nextToken().cat() == catBegin) {
-               Token t = getToken();
-               for (Token t = getToken(); t.cat() != catEnd && good(); t = getToken()) {
+       if (!good())
+               error("stream bad");
+       skip_spaces();
+       if (next_token().cat() == catBegin) {
+               Token t = get_token(); // skip brace
+               string res;
+               for (Token t = get_token(); t.cat() != catEnd && good(); t = get_token()) {
                        if (t.cat() == catBegin) {
                                putback();
-                               res += '{' + verbatimItem() + '}';
+                               res += '{' + verbatim_item() + '}';
                        }
                        else
-                               res += t.asString();
+                               res += t.asInput();
                }
+               return res;
        }
-       return res;
+       return get_token().asInput();
+}
+
+
+void Parser::reset()
+{
+       pos_ = 0;
+}
+
+
+void Parser::setCatCode(char c, CatCode cat)
+{
+       theCatcode[(unsigned char)c] = cat;
+}
+
+
+CatCode Parser::getCatCode(char c) const
+{
+       return theCatcode[(unsigned char)c];
 }