X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLexer.h;h=149cc7ddf2962bca6daaa6e3e131f1560ae51201;hb=b4f4f87dabff4f6ea4cd663321ef6b219ab5cf6a;hp=3324bdcad60b078b5b57366e1fb91ea3c9ea5306;hpb=193c25946baa53f69e5dea54b9dc4e706cabf95e;p=lyx.git diff --git a/src/Lexer.h b/src/Lexer.h index 3324bdcad6..149cc7ddf2 100644 --- a/src/Lexer.h +++ b/src/Lexer.h @@ -5,7 +5,7 @@ * Licence details can be found in the file COPYING. * * \author Alejandro Aguilar Sierra - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * * Full author contact details are available in file CREDITS. */ @@ -18,7 +18,7 @@ #define LEXER_H #include "support/strfwd.h" - +#include namespace lyx { @@ -27,7 +27,7 @@ namespace support { class FileName; } class PushPopHelper; /** A helper structure to describe a keyword for the Lexer. - Usually used bundled in C style arrays and passed to the + Usually used bundled in C style arrays and passed to the Lexer using a LexerKeywordTable object. */ struct LexerKeyword @@ -64,10 +64,10 @@ class Lexer { public: /// initialize Lexer with no special keywords. - Lexer(); + Lexer(); /// initialize Lexer with a bunch of keywords template Lexer(LexerKeyword (&table)[N]) - : pimpl_(0) { init(table, N); } + : pimpl_(0), lastReadOk_(false) { init(table, N); } /// ~Lexer(); @@ -110,16 +110,20 @@ public: /// returns a lex code int lex(); - /** Just read the next word. If esc is true remember that - some chars might be escaped: "\ atleast - */ + /// Read the next string, as delimited by double quotes or + /// whitespace. If esc is true, then we remember that some chars + /// might be escaped: \" at least. 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. - */ + /// 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. bool nextToken(); + + /// Puts the rest of the line in the buffer, where it will + /// be available via getString() or getDocString(). + bool eatLine(); + /// Push a token, that next token got from lyxlex. void pushToken(std::string const &); @@ -133,11 +137,9 @@ public: /// double getFloat() const; /// - std::string const getString() const; - + std::string const getString(bool trim = false) const; /// - docstring const getDocString() const; - + docstring const getDocString(bool trim = false) 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 @@ -145,10 +147,7 @@ public: each following line. This mechanism does not work perfectly if you use tabs. */ - std::string const getLongString(std::string const & endtag); - - /// - bool eatLine(); + docstring getLongString(docstring const & endtag); /// Pushes a token list on a stack and replaces it with a new one. template void pushTable(LexerKeyword (&table)[N]) @@ -182,13 +181,20 @@ public: Lexer & operator>>(unsigned int &); /// extract bool Lexer & operator>>(bool &); + /// extract first char of the string + Lexer & operator>>(char &); /// read and check a required token Lexer & operator>>(char const * required); + /// check for an optional token and swallow it if present. + bool checkFor(char const * required); /// Quotes a string so that reading it again with Lexer::next(true) /// gets the original string static std::string quoteString(std::string const &); + /// Quotes a docstring so that reading it again with Lexer::next(true) + /// gets the original string + static docstring quoteString(docstring const &); private: /// noncopyable