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 05ab00ad25358221d5d41b5baa7ebd3b950a7b9e..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 {
@@ -55,14 +74,20 @@ public:
                LEX_TOKEN = -4
        };
 
-       /// straem is open and end of straem is not reached
+       /// 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
-       operator void *() const;
-       /// stream is not 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;
+       /// 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);
@@ -96,10 +121,13 @@ public:
        ///
        bool getBool() const;
        ///
-       float getFloat() const;
+       double getFloat() const;
        ///
        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
@@ -111,8 +139,6 @@ public:
 
        ///
        bool eatLine();
-       ///
-       int findToken(char const * str[]);
 
        /// Pushes a token list on a stack and replaces it with a new one.
        void pushTable(keyword_item *, int);
@@ -133,8 +159,8 @@ public:
 
        /// extract string
        LyXLex & operator>>(std::string &);
-       /// extract float
-       LyXLex & operator>>(float &);
+       /// extract docstring
+       LyXLex & operator>>(docstring &);
        /// extract double
        LyXLex & operator>>(double &);
        /// extract integer
@@ -144,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:
-       struct Pimpl;
+       class Pimpl;
        ///
        Pimpl * pimpl_;
+       ///
+       mutable bool lastReadOk_;
 };
 
 
@@ -155,9 +187,10 @@ private:
     This is needed to ensure that the pop is done upon exit from methods
     with more than one exit point or that can return as a response to
     exceptions.
-    @autor Lgb
+    @author Lgb
 */
-struct pushpophelper {
+class pushpophelper {
+public:
        ///
        pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
                lex.pushTable(i, s);
@@ -177,4 +210,7 @@ struct pushpophelper {
 #define pushpophelper(x, y, z) unnamed_pushpophelper;
 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
 
+
+} // namespace lyx
+
 #endif