// -*- 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 "support/docstring.h"
+
+#include <boost/utility.hpp>
#include <iosfwd>
-#include "LString.h"
+
+namespace lyx {
+
+namespace support { class FileName; }
///
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.
+ Use the method isOK() to check if there is still data available
+ for lexing. Use one of the the operators void* or ! to test if
+ the last reading operation was successful.
+
+ Example:
+
+ int readParam(LyxLex &lex) {
+ int param = 1; // default value
+ if (lex.isOK()) { // the lexer has data to read
+ int p; // temporary variable
+ lex >> p;
+ if (lex) param = p; // only use the input if reading was successful
+ }
+ return param;
+ }
+
+ @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 {
///
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
+ /// FIXME: test also if pushTok is not empty
+ /// FIXME: the method should be renamed to something like
+ /// dataAvailable(), in order to reflect the real behavior
+ bool isOK() const;
+ /// FIXME: The next two operators should be replaced by one method
+ /// called e.g. lastReadOk(), in order to reflect the real
+ /// behavior
+ /// last read operation was successful.
+ operator void const *() const;
+ /// last read operation was not successful
+ bool operator!() const;
/// return true if able to open file, else false
- bool setFile(string const & filename);
+ bool setFile(support::FileName 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 */
+ /** Just read the next word. If esc is true remember that
+ 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;
-
+ void pushToken(std::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'
- * 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);
-
- ///
- bool EatLine();
+ double getFloat() const;
///
- int FindToken(char const * str[]);
+ std::string const getString() const;
+
///
- int CheckToken(char const * str[], int print_error);
+ docstring const getDocString() 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 docstring
+ LyXLex & operator>>(docstring &);
+ /// extract double
+ LyXLex & operator>>(double &);
+ /// extract integer
+ LyXLex & operator>>(int &);
+ /// extract unsigned integer
+ LyXLex & operator>>(unsigned int &);
+ /// extract bool
+ LyXLex & operator>>(bool &);
+
+ /// Quotes a string so that reading it again with LyXLex::next(true)
+ /// gets the original string
+ static std::string const quoteString(std::string const &);
+
private:
- struct Pimpl;
+ class Pimpl;
+ ///
Pimpl * pimpl_;
+ ///
+ mutable bool lastReadOk_;
};
-// 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
+
+} // namespace lyx
+
#endif