remove redundant lyxerr.debugging checks; macro LYXERR already checks whether the...

[lyx.git] / src / lyxlex.h

diff --git a/src/lyxlex.h b/src/lyxlex.h
index dc16b52b1a7a7a19c3f1764d72dbb123e70c02fa..155aa380f0cb4bf1cec07ef6fd0ed33a2195ef17 100644 (file)
--- a/src/lyxlex.h
+++ b/src/lyxlex.h
@@ -17,12 +17,17 @@
 #ifndef LYXLEX_H
 #define LYXLEX_H
 
+#include "support/docstring.h"
+
 #include <boost/utility.hpp>
 
 #include <iosfwd>
-#include <string>
 
 
+namespace lyx {
+
+namespace support { class FileName; }
+
 ///
 struct keyword_item {
        ///
@@ -32,8 +37,22 @@ struct keyword_item {
 };
 
 /** Generalized simple lexical analizer.
-    It can be used for simple syntax parsers, like lyxrc,
-    texclass and others to come.
+       Use the method isOK() to check if there is still data available 
+       for lexing. Use one of the the operators void* or ! to test if
+       the last reading operation was successful.
+       
+       Example:
+
+       int readParam(LyxLex &lex) {
+               int param = 1; // default value
+               if (lex.isOK()) { // the lexer has data to read
+                       int p;    // temporary variable
+                       lex >> p;
+                       if (lex) param = p; // only use the input if reading was successful
+               }
+               return param;
+       } 
+
     @see lyxrc.C for an example of usage.
   */
 class LyXLex : boost::noncopyable {
@@ -56,13 +75,19 @@ public:
        };
 
        /// stream is open and end of stream is not reached
+       /// FIXME: test also if pushTok is not empty
+       /// FIXME: the method should be renamed to something like 
+       ///        dataAvailable(), in order to reflect the real behavior
        bool isOK() const;
-       /// stream is ok
+       /// FIXME: The next two operators should be replaced by one method
+       ///        called e.g. lastReadOk(), in order to reflect the real 
+       ///        behavior
+       /// last read operation was successful.
        operator void const *() const;
-       /// stream is not ok
+       /// last read operation was not successful
        bool operator!() const;
        /// return true if able to open file, else false
-       bool setFile(std::string const & filename);
+       bool setFile(support::FileName const & filename);
        ///
        void setStream(std::istream & is);
        ///
@@ -75,7 +100,7 @@ public:
        /// returns a lex code
        int lex();
 
-       /** Just read athe next word. If esc is true remember that
+       /** Just read the next word. If esc is true remember that
            some chars might be escaped: "\ atleast
        */
        bool next(bool esc = false);
@@ -100,6 +125,9 @@ public:
        ///
        std::string const getString() const;
 
+       ///
+       docstring const getDocString() const;
+
        /** Get a long string, ended by the tag `endtag'.
            This string can span several lines. The first line
            serves as a template for how many spaces the lines
@@ -131,6 +159,8 @@ public:
 
        /// extract string
        LyXLex & operator>>(std::string &);
+       /// extract docstring
+       LyXLex & operator>>(docstring &);
        /// extract double
        LyXLex & operator>>(double &);
        /// extract integer
@@ -140,10 +170,16 @@ public:
        /// extract bool
        LyXLex & operator>>(bool &);
 
+       /// Quotes a string so that reading it again with LyXLex::next(true)
+       /// gets the original string
+       static std::string const quoteString(std::string const &);
+
 private:
        class Pimpl;
        ///
        Pimpl * pimpl_;
+       ///
+       mutable bool lastReadOk_;
 };
 
 
@@ -174,4 +210,7 @@ public:
 #define pushpophelper(x, y, z) unnamed_pushpophelper;
 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
 
+
+} // namespace lyx
+
 #endif