X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxlex.h;h=dc16b52b1a7a7a19c3f1764d72dbb123e70c02fa;hb=65ca7003ba47b7348610393a9a0d2d309b4e9702;hp=143a88d087547bf7e04d0dc7560ec3b01ccab01c;hpb=8283e978f8d621041c432b9b88a476bfd567385c;p=lyx.git diff --git a/src/lyxlex.h b/src/lyxlex.h index 143a88d087..dc16b52b1a 100644 --- a/src/lyxlex.h +++ b/src/lyxlex.h @@ -1,20 +1,27 @@ // -*- 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" -#include /// struct keyword_item { @@ -32,7 +39,7 @@ struct keyword_item { class LyXLex : boost::noncopyable { public: /// - LyXLex (keyword_item *, int); + LyXLex(keyword_item *, int); /// ~LyXLex(); @@ -48,12 +55,16 @@ public: LEX_TOKEN = -4 }; - /// file is open and end of file is not reached + /// 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. @@ -75,7 +86,7 @@ public: */ bool nextToken(); /// Push a token, that next token got from lyxlex. - void pushToken(string const &); + void pushToken(std::string const &); /// int getLineNo() const; @@ -85,9 +96,9 @@ public: /// bool getBool() const; /// - float getFloat() const; + double getFloat() const; /// - string const getString() const; + std::string const getString() const; /** Get a long string, ended by the tag `endtag'. This string can span several lines. The first line @@ -96,18 +107,12 @@ public: each following line. This mechanism does not work perfectly if you use tabs. */ - string const getLongString(string const & endtag); + std::string const getLongString(std::string const & endtag); /// bool eatLine(); - /// - int findToken(char const * str[]); - /// - string const text() const; - - /** 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 @@ -119,14 +124,24 @@ public: and file name. If message contains the substring `$$Token', it is replaced with the value of GetString() */ - void printError(string const & message) const; + void printError(std::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 &); + + /// 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_; }; @@ -136,9 +151,10 @@ private: 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 + @author Lgb */ -struct pushpophelper { +class pushpophelper { +public: /// pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) { lex.pushTable(i, s);