// It can be used for simple syntax parsers, like lyxrc,
// texclass and others to come. [asierra30/03/96]
//
-// (C) 1996 Lyx Team.
-#ifndef _LYXLEX_H
-#define _LYXLEX_H
+// Copyright 1996 Lyx Team.
+#ifndef LYXLEX_H
+#define LYXLEX_H
#ifdef __GNUG__
#pragma interface
#endif
-#include <stdio.h>
+#include <iosfwd>
+
#include "LString.h"
+#include <boost/utility.hpp>
///
struct keyword_item {
///
- char const* tag;
+ 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() { if (file && owns_file) fclose(file); };
+ ~LyXLex();
/// Lex basic codes
enum {
};
/// file is open and end of file is not reached
- bool IsOK();
+ bool isOK() const;
/// return true if able to open file, else false
bool setFile(string const & filename);
- /// if file is already read from, line numbers will be wrong.
- // should be removed
- void setFile(FILE *f);
///
- // should be removed
- FILE *getFile() { return file; }
+ void setStream(std::istream & i);
+ ///
+ 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() { return lineno; }
+ /// Push a token, that next token got from lyxlex.
+ void pushToken(string const &);
+
///
- int GetInteger();
+ int getLineNo() const;
+
///
- bool GetBool();
+ int getInteger() const;
///
- float GetFloat();
+ bool getBool() const;
///
- string GetString() const;
-
- /// get a long string, ended by the tag `endtag'
- string getLongString(string const &endtoken);
-
+ float getFloat() const;
///
- bool EatLine();
+ 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 const getLongString(string const & endtag);
+
///
- int FindToken(char const* string[]);
+ bool eatLine();
///
- int CheckToken(char const* string[], int print_error);
+ int findToken(char const * str[]);
///
- char const *text() const { return &buff[0]; }
+ string const text() const;
/** Pushes a token list on a stack and replaces it with a new one.
*/
- void pushTable(keyword_item*, int);
+ 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);
+ 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 stderr.
- */
- void printTable();
-protected:
- ///
- enum {
+ Prints the current token table on the supplied ostream.
+ */
+ void printTable(std::ostream &);
+private:
+ struct Pimpl;
///
- LEX_MAX_BUFF = 2048
- };
+ Pimpl * pimpl_;
+};
- ///
- struct pushed_table {
- ///
- pushed_table(){
- next=0;
- table_elem=0;
- }
- ///
- pushed_table *next;
- ///
- keyword_item *table_elem;
- ///
- int table_siz;
- };
+/** 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.
+ @autor Lgb
+*/
+struct pushpophelper {
///
- FILE *file;
- ///
- bool owns_file;
- ///
- string name;
- ///
- int lineno;
+ pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
+ lex.pushTable(i, s);
+ }
///
- keyword_item *table;
+ ~pushpophelper() {
+ lex.popTable();
+ }
///
- int no_items;
- ///
- char buff[LEX_MAX_BUFF];
- ///
- pushed_table *pushed;
- ///
- int search_kw(char const * const) const;
- ///
- short status;
+ LyXLex & lex;
};
-
-
-inline
-bool LyXLex::IsOK()
-{
- return (file && !feof(file));
-}
+/** 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