X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxlex.h;h=143a88d087547bf7e04d0dc7560ec3b01ccab01c;hb=dab43e77955e5b21fa556f53143d42e09e439f40;hp=f2cab3d0938010bf12ed046a783e13e5ff0a491c;hpb=fa6aa115e72e5fdefddeb2d1e364a062d46d0437;p=lyx.git

diff --git a/src/lyxlex.h b/src/lyxlex.h
index f2cab3d093..143a88d087 100644
--- a/src/lyxlex.h
+++ b/src/lyxlex.h
@@ -14,28 +14,28 @@
 #include <iosfwd>
 
 #include "LString.h"
+#include <boost/utility.hpp>
 
 ///
 struct keyword_item {
 	///
 	char const * tag;
 	///
-	short code;
+	int code;
 };
 
-/*@Doc:
-  Generalized simple lexical analizer.
-  It can be used for simple syntax parsers, like lyxrc,
-  texclass and others to come.
-  See lyxrc.C for an example of usage.
+/** Generalized simple lexical analizer.
+    It can be used for simple syntax parsers, like lyxrc,
+    texclass and others to come.
+    @see lyxrc.C for an example of usage.
   */
-class LyXLex { 
+class LyXLex : boost::noncopyable {
 public:
 	///
 	LyXLex (keyword_item *, int);
 	///
 	~LyXLex();
-	
+
 	/// Lex basic codes
 	enum {
 		///
@@ -49,7 +49,7 @@ public:
 	};
 
 	/// file is open and end of file is not reached
-	bool IsOK() const;
+	bool isOK() const;
 	/// return true if able to open file, else false
 	bool setFile(string const & filename);
 	///
@@ -58,88 +58,103 @@ public:
 	std::istream & getStream();
 	/// Danger! Don't use it unless you know what you are doing.
 	void setLineNo(int l);
-	
+	/// Change the character that begins a comment. Default is '#'
+	void setCommentChar(char c);
+
 	/// returns a lex code
 	int lex();
 
 	/** Just read athe next word. If esc is true remember that
-	  some chars might be escaped: "\ atleast */
+	    some chars might be escaped: "\ atleast
+	*/
 	bool next(bool esc = false);
 
 	/** Read next token. This one is almost the same as next,
-	  but it will consider " as a regular character and always
-	  split a word if it contains a backslash.
-	  */
+	    but it will consider " as a regular character and always
+	    split a word if it contains a backslash.
+	*/
 	bool nextToken();
 	/// Push a token, that next token got from lyxlex.
 	void pushToken(string const &);
-	
-	/// 
-	int GetLineNo() const;
-	
+
 	///
-	int GetInteger() const;
+	int getLineNo() const;
+
 	///
-	bool GetBool() const;
+	int getInteger() const;
 	///
-	float GetFloat() const;
+	bool getBool() const;
 	///
-	string const GetString() const;
-	
-	/// get a long string, ended by the tag `endtag'
-	string getLongString(string const & endtag);
-	
+	float getFloat() const;
 	///
-	bool EatLine();
+	string const getString() 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
+	    are indented. This much white space is skipped from
+	    each following line. This mechanism does not work
+	    perfectly if you use tabs.
+	*/
+	string const getLongString(string const & endtag);
+
 	///
-	int FindToken(char const * str[]);
+	bool eatLine();
 	///
-	int CheckToken(char const * str[], int print_error);
+	int findToken(char const * str[]);
 
 	///
-	char const * text() const;
+	string const text() const;
 
 	/** 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
-	  on top of the stack.
-	  */
+	    on top of the stack.
+	*/
 	void popTable();
 
 	/** Prints an error message with the corresponding line number
-	  and file name. If message contains the substring `$$Token',
-	  it is replaced with the value of GetString()
-	  */
+	    and file name. If message contains the substring `$$Token',
+	    it is replaced with the value of GetString()
+	*/
 	void printError(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 &);
 private:
 	struct Pimpl;
+	///
 	Pimpl * pimpl_;
 };
 
 
-// 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. (Lgb)
+/** 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
+    exceptions.
+    @autor Lgb
+*/
 struct pushpophelper {
+	///
 	pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
 		lex.pushTable(i, s);
 	}
+	///
 	~pushpophelper() {
 		lex.popTable();
 	}
+	///
 	LyXLex & lex;
 };
-// To avoid wrong usage:
-// pushpophelper(...); // wrong
-// pushpophelper pph(...); // right
-// we add this macro:
+/** Avoid wrong usage of pushpophelper.
+    To avoid wrong usage:
+    pushpophelper(...); // wrong
+    pushpophelper pph(...); // right
+*/
 #define pushpophelper(x, y, z) unnamed_pushpophelper;
 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal