]> git.lyx.org Git - lyx.git/blobdiff - src/lyxlex.h
* support/qstring_helpers.h: erase ucs4_to_qstring() method.
[lyx.git] / src / lyxlex.h
index 41da5297898f521ada2011e0e6a43def3d9b9df3..0c1469a9eec86c6e541bbe803f6601f35992400f 100644 (file)
 #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 {
        ///
@@ -56,13 +61,17 @@ public:
        };
 
        /// stream is open and end of stream is not reached
+       /// FIXME: Rename to good() since this is the name of the
+       /// corresponding std::stream method.
        bool isOK() const;
        /// stream is ok
+       /// FIXME: This does not behave like the std::stream counterpart.
        operator void const *() const;
        /// stream is not ok
+       /// FIXME: This does not behave like the std::stream counterpart.
        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);
        ///
@@ -96,10 +105,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 +123,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 +143,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,8 +154,12 @@ 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_;
 };
@@ -155,9 +169,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 +192,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