X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxlex.h;h=143a88d087547bf7e04d0dc7560ec3b01ccab01c;hb=8a5d04fd84e344a1ba1cfd3f5cce67d41874cfa3;hp=332f711c5f2a2881634fe400ccc1e0daff94036f;hpb=77e706c44175f3cf71473a42d5db890c77b3b7b3;p=lyx.git diff --git a/src/lyxlex.h b/src/lyxlex.h index 332f711c5f..143a88d087 100644 --- a/src/lyxlex.h +++ b/src/lyxlex.h @@ -12,28 +12,29 @@ #endif #include -#include #include "LString.h" +#include /// struct keyword_item { /// char const * tag; /// - short code; + int code; }; -/*@Doc: - Generalized simple lexical analizer. - It can be used for simple syntax parsers, like lyxrc, - texclass and others to come. - See lyxrc.C for an example of usage. +/** Generalized simple lexical analizer. + It can be used for simple syntax parsers, like lyxrc, + texclass and others to come. + @see lyxrc.C for an example of usage. */ -class LyXLex { +class LyXLex : boost::noncopyable { public: /// LyXLex (keyword_item *, int); + /// + ~LyXLex(); /// Lex basic codes enum { @@ -48,139 +49,112 @@ public: }; /// file is open and end of file is not reached - bool IsOK() const; + bool isOK() const; /// return true if able to open file, else false bool setFile(string const & filename); /// void setStream(std::istream & i); /// - std::istream & getStream() { return is; } + std::istream & getStream(); /// Danger! Don't use it unless you know what you are doing. - void setLineNo(int l) { lineno = l; } + void setLineNo(int l); + /// Change the character that begins a comment. Default is '#' + void setCommentChar(char c); + /// returns a lex code int lex(); /** Just read athe next word. If esc is true remember that - some chars might be escaped: "\ atleast */ + some chars might be escaped: "\ atleast + */ bool next(bool esc = false); /** Read next token. This one is almost the same as next, - but it will consider " as a regular character and always - split a word if it contains a backslash. - */ + but it will consider " as a regular character and always + split a word if it contains a backslash. + */ bool nextToken(); - - /// - int GetLineNo() const { return lineno; } + /// Push a token, that next token got from lyxlex. + void pushToken(string const &); + /// - int GetInteger() const; + int getLineNo() const; + /// - bool GetBool() const; + int getInteger() const; /// - float GetFloat() const; + bool getBool() const; /// - string GetString() const; - - /// get a long string, ended by the tag `endtag' - string getLongString(string const & endtag); - + float getFloat() const; /// - bool EatLine(); + string const getString() const; + + /** Get a long string, ended by the tag `endtag'. + This string can span several lines. The first line + serves as a template for how many spaces the lines + are indented. This much white space is skipped from + each following line. This mechanism does not work + perfectly if you use tabs. + */ + string const getLongString(string const & endtag); + /// - int FindToken(char const * str[]); + bool eatLine(); /// - int CheckToken(char const * str[], int print_error); + int findToken(char const * str[]); /// - char const * text() const { return &buff[0]; } + string const text() const; /** Pushes a token list on a stack and replaces it with a new one. */ void pushTable(keyword_item *, int); /** Pops a token list into void and replaces it with the one now - on top of the stack. - */ + on top of the stack. + */ void popTable(); /** Prints an error message with the corresponding line number - and file name. If message contains the substring `$$Token', - it is replaced with the value of GetString() - */ + and file name. If message contains the substring `$$Token', + it is replaced with the value of GetString() + */ void printError(string const & message) const; /** - Prints the current token table on the supplied ostream. - */ + Prints the current token table on the supplied ostream. + */ void printTable(std::ostream &); -protected: +private: + struct Pimpl; /// - enum { - /// - LEX_MAX_BUFF = 2048 - }; - - /// - struct pushed_table { - /// - pushed_table(){ - next= 0; - table_elem= 0; - } - /// - pushed_table * next; - /// - keyword_item * table_elem; - /// - int table_siz; - }; - - /// fb__ is only used to open files, the stream is accessed through is - std::filebuf fb__; - /// the stream that we use. - std::istream is; - /// - string name; - /// - int lineno; - /// - keyword_item * table; - /// - int no_items; - /// - char buff[LEX_MAX_BUFF]; - /// - pushed_table * pushed; - /// - int search_kw(char const * const) const; - /// - short status; + Pimpl * pimpl_; }; -inline -bool LyXLex::IsOK() const -{ - return is.good(); -} - - -// This is needed to ensure that the pop is done upon exit from methods -// with more than one exit point or that can return as a response to -// exceptions. (Lgb) +/** Use to enable multiple exit points. + This is needed to ensure that the pop is done upon exit from methods + with more than one exit point or that can return as a response to + exceptions. + @autor Lgb +*/ struct pushpophelper { + /// pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) { lex.pushTable(i, s); } + /// ~pushpophelper() { lex.popTable(); } + /// LyXLex & lex; }; -// To avoid wrong usage: -// pushpophelper(...); // wrong -// pushpophelper pph(...); // right -// we add this macro: +/** Avoid wrong usage of pushpophelper. + To avoid wrong usage: + pushpophelper(...); // wrong + pushpophelper pph(...); // right +*/ #define pushpophelper(x, y, z) unnamed_pushpophelper; // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal