]> git.lyx.org Git - lyx.git/blobdiff - src/tex2lyx/Parser.h
Remove 3rdparty/boost/Makefile.am
[lyx.git] / src / tex2lyx / Parser.h
index 3c55a7ebb093de8da33fe98983c6046f287334c6..d28036710e9e4503f2538f0b6cbe2b85afa20612 100644 (file)
@@ -67,7 +67,8 @@ enum {
        FLAG_OPTION     = 1 << 11, //  read [...] style option
        FLAG_BRACED     = 1 << 12, //  read {...} style argument
        FLAG_CELL       = 1 << 13, //  read table cell
-       FLAG_TABBING    = 1 << 14  //  We are inside a tabbing environment
+       FLAG_TABBING    = 1 << 14,  //  We are inside a tabbing environment
+       FLAG_RDELIM     = 1 << 15,  //  next right delimiter ends the parsing
 };
 
 
@@ -117,25 +118,37 @@ std::ostream & operator<<(std::ostream & os, Token const & t);
 extern void debugToken(std::ostream & os, Token const & t, unsigned int flags);
 #endif
 
-// A docstream version that supports putback even when not buffered
+/// A docstream version that supports putback even when not buffered
 class iparserdocstream
 {
 public:
-       iparserdocstream(idocstream & is) : is_(is) {};
+       typedef idocstream::int_type int_type;
 
-       operator bool() const { return is_; };
+       iparserdocstream(idocstream & is) : is_(is) {}
 
-       idocstream & docstream() { return is_; };
+       /// Like std::istream::operator bool()
+       /// Do not convert is_ implicitly to bool, since that is forbidden in C++11.
+       explicit operator bool() const { return s_.empty() ? !is_.fail() : true; }
+
+       /// change the encoding of the input stream to \p e (iconv name)
+       void setEncoding(std::string const & e);
 
        // add to the list of characters to read before actually reading
        // the stream
        void putback(char_type c);
 
-       // add before the list of characters to read before actually reading
+       // add to the list of characters to read before actually reading
        // the stream
-       void put_almost_back(docstring s);
+       void putback(const docstring &s);
 
+       /// Like std::istream::get()
        iparserdocstream & get(char_type &c);
+
+       /// Like std::istream::good()
+       bool good() const { return s_.empty() ? is_.good() : true; }
+
+       /// Like std::istream::peek()
+       int_type peek() const { return s_.empty() ? is_.peek() : s_[0]; }
 private:
        ///
        idocstream & is_;
@@ -161,7 +174,7 @@ class Parser {
        Parser & operator=(Parser const & p);
 public:
        ///
-       Parser(idocstream & is);
+       Parser(idocstream & is, std::string const & fixedenc);
        ///
        Parser(std::string const & s);
        ///
@@ -172,11 +185,11 @@ public:
         * re-reading. Useful when changing catcodes. */
        void deparse();
 
-       /// change the iconv encoding of the input stream
-       /// according to the latex encoding and package
-       void setEncoding(std::string const & encoding, int const & package);
-       /// change the iconv encoding of the input stream
-       void setEncoding(std::string const & encoding);
+       /// change the encoding of the input stream according to \p encoding
+       /// (latex name) and package \p package
+       bool setEncoding(std::string const & encoding, int package);
+       /// change the encoding of the input stream to \p encoding (iconv name)
+       bool setEncoding(std::string const & encoding);
        /// get the current iconv encoding of the input stream
        std::string getEncoding() const { return encoding_iconv_; }
 
@@ -195,11 +208,13 @@ public:
        void pushPosition();
        /// restore previous position
        void popPosition();
+       /// forget last saved position
+       void dropPosition();
        /// dump contents to screen
        void dump() const;
 
        /// Does an optional argument follow after the current token?
-       bool hasOpt();
+       bool hasOpt(std::string const & l = "[");
        ///
        typedef std::pair<bool, std::string> Arg;
        /*!
@@ -207,7 +222,7 @@ public:
         * If \p allow_escaping is true, a right delimiter escaped by a
         * backslash does not count as delimiter, but is included in the
         * argument.
-        * \returns wether an argument was found in \p Arg.first and the
+        * \returns whether an argument was found in \p Arg.first and the
         * argument in \p Arg.second. \see getArg().
         */
        Arg getFullArg(char left, char right, bool allow_escaping = true);
@@ -218,7 +233,7 @@ public:
         * argument.
         * \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
+        * getFullArg() if you need to know whether there was an empty
         * argument or no argument at all.
         */
        std::string getArg(char left, char right, bool allow_escaping = true);
@@ -226,7 +241,8 @@ public:
         * Like getOpt(), but distinguishes between a missing argument ""
         * and an empty argument "[]".
         */
-       std::string getFullOpt(bool keepws = false);
+       std::string getFullOpt(bool keepws = false,
+                              char left = '[', char right = ']');
        /*!
         * \returns getArg('[', ']') including the brackets or the
         * empty string if there is no such argument.
@@ -243,6 +259,8 @@ public:
         * empty string if there is no such argument.
         */
        std::string getFullParentheseArg();
+       /// Check if we have a list preamble
+       bool hasListPreamble(std::string const & itemcmd);
        /*!
         * \returns the contents of the environment \p name.
         * <tt>\begin{name}</tt> must be parsed already, <tt>\end{name}</tt>
@@ -262,14 +280,23 @@ public:
         * This function is designed to parse verbatim commands.
         */
        std::string const plainCommand(char left, char right, std::string const & name);
+       /*
+        * Returns everything before the main command argument.
+        * This is where the LaTeXParam value of a layout is output.
+        */
+       std::string const getCommandLatexParam();
        /*
         * Basically the same as plainEnvironment() but the parsing is
         * stopped at string \p end_string. Contrary to the other
         * methods, this uses proper catcode setting. This function is
         * designed to parse verbatim environments and command. The
-        * intention is to eventually replace all of its siblings.
+        * intention is to eventually replace all of its siblings. the
+        * member \p first of the result tells whether the arg was
+        * found and the member \p second is the value. If \p
+        * allow_linebreak is false, then the parsing is limited to one line
         */
-       std::string const verbatimStuff(std::string const & end_string);
+       Arg verbatimStuff(std::string const & end_string,
+                         bool allow_linebreak = true);
        /*
         * \returns the contents of the environment \p name.
         * <tt>\begin{name}</tt> must be parsed already,
@@ -283,14 +310,17 @@ public:
        ///
        std::string verbatimOption();
        ///
-       void error(std::string const & msg);
+       void error(std::string const & msg) const;
        /// The previous token.
        Token const prev_token() const;
        /// The current token.
        Token const curr_token() const;
-       /// The next token.
+       /// The next token. Caution: If this is called, an encoding change is
+       /// only possible again after get_token() has been called.
        Token const next_token();
-       /// The next but one token.
+       /// The next but one token. Caution: If this is called, an encoding
+       /// change is only possible again after get_token() has been called
+       /// twice.
        Token const next_next_token();
        /// Make the next token current and return that.
        Token const get_token();
@@ -301,8 +331,10 @@ public:
        bool skip_spaces(bool skip_comments = false);
        /// puts back spaces (and comments if \p skip_comments is true)
        void unskip_spaces(bool skip_comments = false);
-       ///
-       bool good();
+       /// Is any further input pending()? This is not like
+       /// std::istream::good(), which returns true if all available input
+       /// was read, and the next attempt to read would return EOF.
+       bool good() const;
        /// resets the parser to initial state
        void reset();
 
@@ -329,10 +361,12 @@ private:
        std::string encoding_iconv_;
        ///
        CatCode theCatcode_[256];
-       //
+       ///
        cat_type theCatcodesType_;
-       //
+       ///
        cat_type curr_cat_;
+       ///
+       bool fixed_enc_;
 };