4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
8 * \author Lars Gullik Bjønnes
10 * Full author contact details are available in file CREDITS.
13 // Generalized simple lexical analizer.
14 // It can be used for simple syntax parsers, like lyxrc,
15 // texclass and others to come.
20 #include "support/docstring.h"
22 #include <boost/utility.hpp>
29 namespace support { class FileName; }
39 /** Generalized simple lexical analizer.
40 It can be used for simple syntax parsers, like lyxrc,
41 texclass and others to come.
42 @see lyxrc.C for an example of usage.
44 class LyXLex : boost::noncopyable {
47 LyXLex(keyword_item *, int);
63 /// stream is open and end of stream is not reached
64 /// FIXME: Rename to good() since this is the name of the
65 /// corresponding std::stream method.
68 /// FIXME: This does not behave like the std::stream counterpart.
69 operator void const *() const;
71 /// FIXME: This does not behave like the std::stream counterpart.
72 bool operator!() const;
73 /// return true if able to open file, else false
74 bool setFile(support::FileName const & filename);
76 void setStream(std::istream & is);
78 std::istream & getStream();
79 /// Danger! Don't use it unless you know what you are doing.
80 void setLineNo(int l);
81 /// Change the character that begins a comment. Default is '#'
82 void setCommentChar(char c);
84 /// returns a lex code
87 /** Just read athe next word. If esc is true remember that
88 some chars might be escaped: "\ atleast
90 bool next(bool esc = false);
92 /** Read next token. This one is almost the same as next,
93 but it will consider " as a regular character and always
94 split a word if it contains a backslash.
97 /// Push a token, that next token got from lyxlex.
98 void pushToken(std::string const &);
101 int getLineNo() const;
104 int getInteger() const;
106 bool getBool() const;
108 double getFloat() const;
110 std::string const getString() const;
113 docstring const getDocString() const;
115 /** Get a long string, ended by the tag `endtag'.
116 This string can span several lines. The first line
117 serves as a template for how many spaces the lines
118 are indented. This much white space is skipped from
119 each following line. This mechanism does not work
120 perfectly if you use tabs.
122 std::string const getLongString(std::string const & endtag);
127 /// Pushes a token list on a stack and replaces it with a new one.
128 void pushTable(keyword_item *, int);
130 /** Pops a token list into void and replaces it with the one now
135 /** Prints an error message with the corresponding line number
136 and file name. If message contains the substring `$$Token',
137 it is replaced with the value of GetString()
139 void printError(std::string const & message) const;
141 /// Prints the current token table on the supplied ostream.
142 void printTable(std::ostream &);
145 LyXLex & operator>>(std::string &);
146 /// extract docstring
147 LyXLex & operator>>(docstring &);
149 LyXLex & operator>>(double &);
151 LyXLex & operator>>(int &);
152 /// extract unsigned integer
153 LyXLex & operator>>(unsigned int &);
155 LyXLex & operator>>(bool &);
157 /// Quotes a string so that reading it again with LyXLex::next(true)
158 /// gets the original string
159 static std::string const quoteString(std::string const &);
168 /** Use to enable multiple exit points.
169 This is needed to ensure that the pop is done upon exit from methods
170 with more than one exit point or that can return as a response to
174 class pushpophelper {
177 pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
187 /** Avoid wrong usage of pushpophelper.
188 To avoid wrong usage:
189 pushpophelper(...); // wrong
190 pushpophelper pph(...); // right
192 #define pushpophelper(x, y, z) unnamed_pushpophelper;
193 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal