// -*- 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]
-//
-// (C) 1996 Lyx Team.
+// texclass and others to come.
+
#ifndef LYXLEX_H
#define LYXLEX_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <boost/utility.hpp>
-#include <fstream>
-using std::filebuf;
+#include <iosfwd>
+#include <string>
-#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 {
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(istream & i);
+ void setStream(std::istream & is);
///
- 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; }
- ///
- int GetInteger() const;
- ///
- bool GetBool() const;
+ /// Push a token, that next token got from lyxlex.
+ void pushToken(std::string const &);
+
///
- float GetFloat() const;
+ int getLineNo() const;
+
///
- string GetString() const;
-
- /// get a long string, ended by the tag `endtag'
- string getLongString(string const & endtoken);
-
+ int getInteger() const;
///
- bool EatLine();
+ bool getBool() const;
///
- int FindToken(char const * string[]);
+ double getFloat() const;
///
- int CheckToken(char const * string[], 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 { return &buff[0]; }
+ 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 cerr.
- */
- void printTable();
-protected:
- ///
- 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
- filebuf fb__;
- /// the stream that we use.
- 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;
+ 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:
+ class Pimpl;
+ ///
+ 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)
-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;
};
+/** 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
#endif
projects / lyx.git / blobdiff