fix bug 1750

[lyx.git] / src / tex2lyx / texparser.h

diff --git a/src/tex2lyx/texparser.h b/src/tex2lyx/texparser.h
index 67ba3e2e6caadcdad9d35560b98d8b1c11241500..0fc250e14f11a29b0c1aa463705c4b968b6d194a 100644 (file)
--- a/src/tex2lyx/texparser.h
+++ b/src/tex2lyx/texparser.h
@@ -14,6 +14,7 @@
 
 #include <vector>
 #include <string>
+#include <utility>
 
 
 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE, MATHTEXT_MODE, TABLE_MODE};
@@ -75,17 +76,17 @@ public:
        ///
        Token(char c, CatCode cat) : cs_(), char_(c), cat_(cat) {}
        ///
-       Token(std::string const & cs) : cs_(cs), char_(0), cat_(catIgnore) {}
+       Token(std::string const & cs, CatCode cat) : cs_(cs), char_(0), cat_(cat) {}
 
        ///
        std::string const & cs() const { return cs_; }
-       ///
+       /// Returns the catcode of the token
        CatCode cat() const { return cat_; }
        ///
        char character() const { return char_; }
-       ///
+       /// Returns the token as string
        std::string asString() const;
-       ///
+       /// Returns the token verbatim
        std::string asInput() const;
 
 private:
@@ -100,9 +101,16 @@ private:
 std::ostream & operator<<(std::ostream & os, Token const & t);
 
 
-//
-// Actual parser class
-//
+/*!
+ * Actual parser class
+ *
+ * The parser parses every character of the inputstream into a token
+ * and classifies the token.
+ * The following transformations are done:
+ * - Consecutive spaces are combined into one single token with CatCode catSpace
+ * - Consecutive newlines are combined into one single token with CatCode catNewline
+ * - Comments and %\n combinations are parsed into one token with CatCode catComment
+ */
 
 class Parser {
 
@@ -120,27 +128,52 @@ public:
        void dump() const;
 
        ///
+       typedef std::pair<bool, std::string> Arg;
+       /*!
+        * Get an argument enclosed by \p left and \p right.
+        * \returns wether an argument was found in \p Arg.first and the
+        * argument in \p Arg.second. \see getArg().
+        */
+       Arg getFullArg(char left, char right);
+       /*!
+        * Get an argument enclosed by \p left and \p right.
+        * \returns the argument (without \p left and \p right) or the empty
+        * string if the next non-space token is not \p left. Use
+        * getFullArg() if you need to know wether there was an empty
+        * argument or no argument at all.
+        */
        std::string getArg(char left, char right);
-       /// getArg('[', ']') including the brackets
+       /*!
+        * \returns getFullArg('[', ']') including the brackets or the
+        * empty string if no argument was found.
+        */
+       std::string getFullOpt();
+       /// \returns getArg('[', ']') including the brackets
        std::string getOpt();
-       ///
+       /// Returns the character of the current token and increments the token position.
        char getChar();
        ///
        void error(std::string const & msg);
-       ///
+       /// Parses \p is into tokens
        void tokenize(std::istream & is);
        ///
        void push_back(Token const & t);
        ///
        void pop_back();
-       ///
+       /// The previous token.
        Token const & prev_token() const;
-       ///
+       /// The current token.
+       Token const & curr_token() const;
+       /// The next token.
        Token const & next_token() const;
-       ///
+       /// Make the next token current and return that.
        Token const & get_token();
-       /// skips spaces if any
-       void skip_spaces();
+       /// \return whether the current token starts a new paragraph
+       bool isParagraph() const;
+       /// skips spaces (and comments if \p skip_comments is true)
+       void skip_spaces(bool skip_comments = false);
+       /// puts back spaces (and comments if \p skip_comments is true)
+       void unskip_spaces(bool skip_comments = false);
        ///
        void lex(std::string const & s);
        ///
@@ -156,7 +189,7 @@ public:
        ///
        CatCode getCatCode(char c) const;
 
-//private:
+private:
        ///
        int lineno_;
        ///