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>
35 /** Generalized simple lexical analizer.
36 It can be used for simple syntax parsers, like lyxrc,
37 texclass and others to come.
38 @see lyxrc.C for an example of usage.
40 class LyXLex : boost::noncopyable {
43 LyXLex(keyword_item *, int);
59 /// stream is open and end of stream is not reached
62 operator void const *() const;
64 bool operator!() const;
65 /// return true if able to open file, else false
66 bool setFile(std::string const & filename);
68 void setStream(std::istream & is);
70 std::istream & getStream();
71 /// Danger! Don't use it unless you know what you are doing.
72 void setLineNo(int l);
73 /// Change the character that begins a comment. Default is '#'
74 void setCommentChar(char c);
76 /// returns a lex code
79 /** Just read athe next word. If esc is true remember that
80 some chars might be escaped: "\ atleast
82 bool next(bool esc = false);
84 /** Read next token. This one is almost the same as next,
85 but it will consider " as a regular character and always
86 split a word if it contains a backslash.
89 /// Push a token, that next token got from lyxlex.
90 void pushToken(std::string const &);
93 int getLineNo() const;
96 int getInteger() const;
100 double getFloat() const;
102 std::string const getString() const;
105 lyx::docstring const getDocString() const;
107 /** Get a long string, ended by the tag `endtag'.
108 This string can span several lines. The first line
109 serves as a template for how many spaces the lines
110 are indented. This much white space is skipped from
111 each following line. This mechanism does not work
112 perfectly if you use tabs.
114 std::string const getLongString(std::string const & endtag);
119 /// Pushes a token list on a stack and replaces it with a new one.
120 void pushTable(keyword_item *, int);
122 /** Pops a token list into void and replaces it with the one now
127 /** Prints an error message with the corresponding line number
128 and file name. If message contains the substring `$$Token',
129 it is replaced with the value of GetString()
131 void printError(std::string const & message) const;
133 /// Prints the current token table on the supplied ostream.
134 void printTable(std::ostream &);
137 LyXLex & operator>>(std::string &);
139 LyXLex & operator>>(double &);
141 LyXLex & operator>>(int &);
142 /// extract unsigned integer
143 LyXLex & operator>>(unsigned int &);
145 LyXLex & operator>>(bool &);
147 /// Quotes a string so that reading it again with LyXLex::next(true)
148 /// gets the original string
149 static std::string const quoteString(std::string const &);
158 /** Use to enable multiple exit points.
159 This is needed to ensure that the pop is done upon exit from methods
160 with more than one exit point or that can return as a response to
164 class pushpophelper {
167 pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
177 /** Avoid wrong usage of pushpophelper.
178 To avoid wrong usage:
179 pushpophelper(...); // wrong
180 pushpophelper pph(...); // right
182 #define pushpophelper(x, y, z) unnamed_pushpophelper;
183 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal