2 // Generalized simple lexical analizer.
3 // It can be used for simple syntax parsers, like lyxrc,
4 // texclass and others to come. [asierra30/03/96]
6 // Copyright 1996 Lyx Team.
17 #include <boost/utility.hpp>
27 /** Generalized simple lexical analizer.
28 It can be used for simple syntax parsers, like lyxrc,
29 texclass and others to come.
30 @see lyxrc.C for an example of usage.
32 class LyXLex : boost::noncopyable {
35 LyXLex (keyword_item *, int);
51 /// file is open and end of file is not reached
53 /// return true if able to open file, else false
54 bool setFile(string const & filename);
56 void setStream(std::istream & i);
58 std::istream & getStream();
59 /// Danger! Don't use it unless you know what you are doing.
60 void setLineNo(int l);
61 /// Change the character that begins a comment. Default is '#'
62 void setCommentChar(char c);
64 /// returns a lex code
67 /** Just read athe next word. If esc is true remember that
68 some chars might be escaped: "\ atleast
70 bool next(bool esc = false);
72 /** Read next token. This one is almost the same as next,
73 but it will consider " as a regular character and always
74 split a word if it contains a backslash.
77 /// Push a token, that next token got from lyxlex.
78 void pushToken(string const &);
81 int getLineNo() const;
84 int getInteger() const;
88 float getFloat() const;
90 string const getString() const;
92 /** Get a long string, ended by the tag `endtag'.
93 This string can span several lines. The first line
94 serves as a template for how many spaces the lines
95 are indented. This much white space is skipped from
96 each following line. This mechanism does not work
97 perfectly if you use tabs.
99 string const getLongString(string const & endtag);
104 int findToken(char const * str[]);
106 int checkToken(char const * str[], int print_error);
109 string const text() const;
111 /** Pushes a token list on a stack and replaces it with a new one.
113 void pushTable(keyword_item *, int);
115 /** Pops a token list into void and replaces it with the one now
120 /** Prints an error message with the corresponding line number
121 and file name. If message contains the substring `$$Token',
122 it is replaced with the value of GetString()
124 void printError(string const & message) const;
127 Prints the current token table on the supplied ostream.
129 void printTable(std::ostream &);
137 /** Use to enable multiple exit points.
138 This is needed to ensure that the pop is done upon exit from methods
139 with more than one exit point or that can return as a response to
143 struct pushpophelper {
145 pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
155 /** Avoid wrong usage of pushpophelper.
156 To avoid wrong usage:
157 pushpophelper(...); // wrong
158 pushpophelper pph(...); // right
160 #define pushpophelper(x, y, z) unnamed_pushpophelper;
161 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal