]> git.lyx.org Git - lyx.git/blobdiff - src/Lexer.h
Routines for calculating numerical labels for BibTeX citations.
[lyx.git] / src / Lexer.h
index 5419fab778afad6965a63863c24163cf4ba2c83c..ba085ed0e426e1528679cf852968da9ca9ca89be 100644 (file)
@@ -5,7 +5,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Alejandro Aguilar Sierra
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -111,7 +111,7 @@ public:
        int lex();
 
        /** Just read the next word. If esc is true remember that
-           some chars might be escaped: "\ atleast
+           some chars might be escaped: "\ at least
        */
        bool next(bool esc = false);
 
@@ -167,6 +167,8 @@ public:
 
        /// Prints the current token table on the supplied ostream.
        void printTable(std::ostream &);
+       /// Used to dispaly context information in case of errors.
+       void setContext(std::string const & functionName);
 
        /// extract string
        Lexer & operator>>(std::string &);
@@ -180,10 +182,20 @@ public:
        Lexer & operator>>(unsigned int &);
        /// extract bool
        Lexer & operator>>(bool &);
+       /// extract first char of the string
+       Lexer & operator>>(char &);
+
+       /// read and check a required token
+       Lexer & operator>>(char const * required);
+       /// check for an optional token and swallow it if present.
+       bool checkFor(char const * required);
 
        /// Quotes a string so that reading it again with Lexer::next(true)
        /// gets the original string
-       static std::string const quoteString(std::string const &);
+       static std::string quoteString(std::string const &);
+       /// Quotes a docstring so that reading it again with Lexer::next(true)
+       /// gets the original string
+       static docstring quoteString(docstring const &);
 
 private:
        /// noncopyable
@@ -206,6 +218,16 @@ private:
 };
 
 
+/// extract something constructable from a string, i.e. a LaTeX length
+template <class T>
+Lexer & operator>>(Lexer & lex, T & t)
+{
+       if (lex.next())
+               t = T(lex.getString());
+       return lex;
+}
+
+
 /** Use to enable multiple exit points.
     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