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