src/lyxlex.h

   1 // -*- C++ -*-
   2 //  Generalized simple lexical analizer.
   3 //  It can be used for simple syntax parsers, like lyxrc,
   4 //  texclass and others to come.   [asierra30/03/96]
   5 //
   6 //   Copyright 1996 Lyx Team.
   7 #ifndef LYXLEX_H
   8 #define LYXLEX_H
   9
  10 #ifdef __GNUG__
  11 #pragma interface
  12 #endif
  13
  14 #include <iosfwd>
  15
  16 #include "LString.h"
  17 #include "support/utility.hpp"
  18
  19 ///
  20 struct keyword_item {
  21         ///
  22         char const * tag;
  23         ///
  24         short code;
  25 };
  26
  27 /** Generalized simple lexical analizer.
  28     It can be used for simple syntax parsers, like lyxrc,
  29     texclass and others to come.
  30     @see lyxrc.C for an example of usage.
  31   */
  32 class LyXLex : public noncopyable {
  33 public:
  34         ///
  35         LyXLex (keyword_item *, int);
  36         ///
  37         ~LyXLex();
  38
  39         /// Lex basic codes
  40         enum {
  41                 ///
  42                 LEX_UNDEF = -1,
  43                 ///
  44                 LEX_FEOF  = -2,
  45                 ///
  46                 LEX_DATA  = -3,
  47                 ///
  48                 LEX_TOKEN = -4
  49         };
  50
  51         /// file is open and end of file is not reached
  52         bool IsOK() const;
  53         /// return true if able to open file, else false
  54         bool setFile(string const & filename);
  55         ///
  56         void setStream(std::istream & i);
  57         ///
  58         std::istream & getStream();
  59         /// Danger! Don't use it unless you know what you are doing.
  60         void setLineNo(int l);
  61
  62         /// returns a lex code
  63         int lex();
  64
  65         /** Just read athe next word. If esc is true remember that
  66             some chars might be escaped: "\ atleast
  67         */
  68         bool next(bool esc = false);
  69
  70         /** Read next token. This one is almost the same as next,
  71             but it will consider " as a regular character and always
  72             split a word if it contains a backslash.
  73         */
  74         bool nextToken();
  75         /// Push a token, that next token got from lyxlex.
  76         void pushToken(string const &);
  77
  78         ///
  79         int GetLineNo() const;
  80
  81         ///
  82         int GetInteger() const;
  83         ///
  84         bool GetBool() const;
  85         ///
  86         float GetFloat() const;
  87         ///
  88         string const GetString() const;
  89
  90         /** Get a long string, ended by the tag `endtag'.
  91             This string can span several lines. The first line
  92             serves as a template for how many spaces the lines
  93             are indented. This much white space is skipped from
  94             each following line. This mechanism does not work
  95             perfectly if you use tabs.
  96         */
  97         string const getLongString(string const & endtag);
  98
  99         ///
 100         bool EatLine();
 101         ///
 102         int FindToken(char const * str[]);
 103         ///
 104         int CheckToken(char const * str[], int print_error);
 105
 106         ///
 107         char const * const text() const;
 108
 109         /** Pushes a token list on a stack and replaces it with a new one.
 110          */
 111         void pushTable(keyword_item *, int);
 112
 113         /** Pops a token list into void and replaces it with the one now
 114             on top of the stack.
 115         */
 116         void popTable();
 117
 118         /** Prints an error message with the corresponding line number
 119             and file name. If message contains the substring `$$Token',
 120             it is replaced with the value of GetString()
 121         */
 122         void printError(string const & message) const;
 123
 124         /**
 125            Prints the current token table on the supplied ostream.
 126         */
 127         void printTable(std::ostream &);
 128 private:
 129         struct Pimpl;
 130         ///
 131         Pimpl * pimpl_;
 132 };
 133
 134
 135 /** Use to enable multipe exit points.
 136     This is needed to ensure that the pop is done upon exit from methods
 137     with more than one exit point or that can return as a response to
 138     exceptions.
 139     @autor Lgb
 140 */
 141 struct pushpophelper {
 142         pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
 143                 lex.pushTable(i, s);
 144         }
 145         ~pushpophelper() {
 146                 lex.popTable();
 147         }
 148         LyXLex & lex;
 149 };
 150 /** Avoid wrong usage of pushpophelper.
 151     To avoid wrong usage:
 152     pushpophelper(...); // wrong
 153     pushpophelper pph(...); // right
 154 */
 155 #define pushpophelper(x, y, z) unnamed_pushpophelper;
 156 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
 157
 158 #endif