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.
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.
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);
62 /// returns a lex code
65 /** Just read athe next word. If esc is true remember that
66 some chars might be escaped: "\ atleast */
67 bool next(bool esc = false);
69 /** Read next token. This one is almost the same as next,
70 but it will consider " as a regular character and always
71 split a word if it contains a backslash.
74 /// Push a token, that next token got from lyxlex.
75 void pushToken(string const &);
78 int GetLineNo() const;
81 int GetInteger() const;
85 float GetFloat() const;
87 string const GetString() const;
89 /// get a long string, ended by the tag `endtag'
90 string getLongString(string const & endtag);
95 int FindToken(char const * str[]);
97 int CheckToken(char const * str[], int print_error);
100 char const * text() const;
102 /** Pushes a token list on a stack and replaces it with a new one.
104 void pushTable(keyword_item *, int);
106 /** Pops a token list into void and replaces it with the one now
111 /** Prints an error message with the corresponding line number
112 and file name. If message contains the substring `$$Token',
113 it is replaced with the value of GetString()
115 void printError(string const & message) const;
118 Prints the current token table on the supplied ostream.
120 void printTable(std::ostream &);
127 // This is needed to ensure that the pop is done upon exit from methods
128 // with more than one exit point or that can return as a response to
130 struct pushpophelper {
131 pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
139 // To avoid wrong usage:
140 // pushpophelper(...); // wrong
141 // pushpophelper pph(...); // right
142 // we add this macro:
143 #define pushpophelper(x, y, z) unnamed_pushpophelper;
144 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal