X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxlex.h;h=0c1469a9eec86c6e541bbe803f6601f35992400f;hb=8765ab59cdddad67284007813ef25934ea0042ce;hp=f78a653c9cc3f512108c61107d89c6a115e374f8;hpb=e25012ddfad9b27467bb1af49f3e6bfcd863b408;p=lyx.git

diff --git a/src/lyxlex.h b/src/lyxlex.h
index f78a653c9c..0c1469a9ee 100644
--- a/src/lyxlex.h
+++ b/src/lyxlex.h
@@ -1,17 +1,33 @@
 // -*- C++ -*-
+/**
+ * \file lyxlex.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Alejandro Aguilar Sierra
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 //  Generalized simple lexical analizer.
 //  It can be used for simple syntax parsers, like lyxrc,
-//  texclass and others to come.   [asierra30/03/96]
-//
-//   Copyright 1996 Lyx Team.
+//  texclass and others to come.
+
 #ifndef LYXLEX_H
 #define LYXLEX_H
 
-#include <iosfwd>
+#include "support/docstring.h"
 
-#include "LString.h"
 #include <boost/utility.hpp>
 
+#include <iosfwd>
+
+
+namespace lyx {
+
+namespace support { class FileName; }
+
 ///
 struct keyword_item {
 	///
@@ -28,7 +44,7 @@ struct keyword_item {
 class LyXLex : boost::noncopyable {
 public:
 	///
-	LyXLex (keyword_item *, int);
+	LyXLex(keyword_item *, int);
 	///
 	~LyXLex();
 
@@ -44,10 +60,18 @@ public:
 		LEX_TOKEN = -4
 	};
 
-	/// file is open and end of file is not reached
+	/// 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(string const & filename);
+	bool setFile(support::FileName const & filename);
 	///
 	void setStream(std::istream & is);
 	///
@@ -71,7 +95,7 @@ public:
 	*/
 	bool nextToken();
 	/// Push a token, that next token got from lyxlex.
-	void pushToken(string const &);
+	void pushToken(std::string const &);
 
 	///
 	int getLineNo() const;
@@ -81,9 +105,12 @@ public:
 	///
 	bool getBool() const;
 	///
-	float getFloat() const;
+	double getFloat() const;
 	///
-	string const getString() 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
@@ -92,15 +119,12 @@ public:
 	    each following line. This mechanism does not work
 	    perfectly if you use tabs.
 	*/
-	string const getLongString(string const & endtag);
+	std::string const getLongString(std::string const & endtag);
 
 	///
 	bool eatLine();
-	///
-	int findToken(char const * str[]);
 
-	/** Pushes a token list on a stack and replaces it with a new one.
-	 */
+	/// Pushes a token list on a stack and replaces it with a new one.
 	void pushTable(keyword_item *, int);
 
 	/** Pops a token list into void and replaces it with the one now
@@ -112,14 +136,30 @@ public:
 	    and file name. If message contains the substring `$$Token',
 	    it is replaced with the value of GetString()
 	*/
-	void printError(string const & message) const;
+	void printError(std::string const & message) const;
 
-	/**
-	   Prints the current token table on the supplied ostream.
-	*/
+	/// Prints the current token table on the supplied ostream.
 	void printTable(std::ostream &);
+
+	/// extract string
+	LyXLex & operator>>(std::string &);
+	/// extract docstring
+	LyXLex & operator>>(docstring &);
+	/// extract double
+	LyXLex & operator>>(double &);
+	/// extract integer
+	LyXLex & operator>>(int &);
+	/// extract unsigned integer
+	LyXLex & operator>>(unsigned int &);
+	/// 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_;
 };
@@ -129,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);
@@ -151,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