X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxlex.h;h=dc16b52b1a7a7a19c3f1764d72dbb123e70c02fa;hb=65ca7003ba47b7348610393a9a0d2d309b4e9702;hp=8da47fb035bbec87b5aabcd344906430e3f42cbd;hpb=6bba977f42b0cde753ac2ffd26f3f9c6b32ba0b6;p=lyx.git diff --git a/src/lyxlex.h b/src/lyxlex.h index 8da47fb035..dc16b52b1a 100644 --- a/src/lyxlex.h +++ b/src/lyxlex.h @@ -1,41 +1,48 @@ // -*- C++ -*- +/** + * \file lyxlex.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. + * + * \author Alejandro Aguilar Sierra + * \author Lars Gullik Bjønnes + * + * Full author contact details are available in file CREDITS. + */ + // Generalized simple lexical analizer. // It can be used for simple syntax parsers, like lyxrc, -// texclass and others to come. [asierra30/03/96] -// -// Copyright 1996 Lyx Team. +// texclass and others to come. + #ifndef LYXLEX_H #define LYXLEX_H -#ifdef __GNUG__ -#pragma interface -#endif +#include #include +#include -#include "LString.h" /// 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(keyword_item *, int); /// ~LyXLex(); - + /// Lex basic codes enum { /// @@ -48,105 +55,122 @@ public: LEX_TOKEN = -4 }; - /// file is open and end of file is not reached - bool IsOK() const; + /// stream is open and end of stream is not reached + bool isOK() const; + /// stream is ok + operator void const *() const; + /// stream is not ok + bool operator!() const; /// return true if able to open file, else false - bool setFile(string const & filename); + bool setFile(std::string const & filename); /// - void setStream(std::istream & i); + void setStream(std::istream & is); /// std::istream & getStream(); /// Danger! Don't use it unless you know what you are doing. 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(); /// Push a token, that next token got from lyxlex. - void pushToken(string const &); - - /// - int GetLineNo() const; - - /// - int GetInteger() const; - /// - bool GetBool() const; + void pushToken(std::string const &); + /// - float GetFloat() const; + int getLineNo() const; + /// - 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 getLongString(string const & endtag); - + int getInteger() const; /// - bool EatLine(); + bool getBool() const; /// - int FindToken(char const * str[]); + double getFloat() const; /// - int CheckToken(char const * str[], int print_error); + std::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. + */ + std::string const getLongString(std::string const & endtag); /// - char const * text() const; + bool eatLine(); - /** Pushes a token list on a stack and replaces it with a new one. - */ + /// 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() - */ - void printError(string const & message) const; - - /** - Prints the current token table on the supplied ostream. - */ + and file name. If message contains the substring `$$Token', + it is replaced with the value of GetString() + */ + void printError(std::string const & message) const; + + /// Prints the current token table on the supplied ostream. void printTable(std::ostream &); + + /// extract string + LyXLex & operator>>(std::string &); + /// extract double + LyXLex & operator>>(double &); + /// extract integer + LyXLex & operator>>(int &); + /// extract unsigned integer + LyXLex & operator>>(unsigned int &); + /// extract bool + LyXLex & operator>>(bool &); + private: - struct Pimpl; + class Pimpl; + /// Pimpl * pimpl_; }; -// 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) -struct pushpophelper { +/** 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. + @author Lgb +*/ +class pushpophelper { +public: + /// 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