src/lyxlex.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxlex.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Alejandro Aguilar Sierra
   8  * \author Lars Gullik Bjønnes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 //  Generalized simple lexical analizer.
  14 //  It can be used for simple syntax parsers, like lyxrc,
  15 //  texclass and others to come.
  16
  17 #ifndef LYXLEX_H
  18 #define LYXLEX_H
  19
  20 #include "support/docstring.h"
  21
  22 #include <boost/utility.hpp>
  23
  24 #include <iosfwd>
  25
  26
  27 namespace lyx {
  28
  29 namespace support { class FileName; }
  30
  31 ///
  32 struct keyword_item {
  33         ///
  34         char const * tag;
  35         ///
  36         int code;
  37 };
  38
  39 /** Generalized simple lexical analizer.
  40     It can be used for simple syntax parsers, like lyxrc,
  41     texclass and others to come.
  42     @see lyxrc.C for an example of usage.
  43   */
  44 class LyXLex : boost::noncopyable {
  45 public:
  46         ///
  47         LyXLex(keyword_item *, int);
  48         ///
  49         ~LyXLex();
  50
  51         /// Lex basic codes
  52         enum {
  53                 ///
  54                 LEX_UNDEF = -1,
  55                 ///
  56                 LEX_FEOF  = -2,
  57                 ///
  58                 LEX_DATA  = -3,
  59                 ///
  60                 LEX_TOKEN = -4
  61         };
  62
  63         /// stream is open and end of stream is not reached
  64         bool isOK() const;
  65         /// stream is ok
  66         operator void const *() const;
  67         /// stream is not ok
  68         bool operator!() const;
  69         /// return true if able to open file, else false
  70         bool setFile(support::FileName const & filename);
  71         ///
  72         void setStream(std::istream & is);
  73         ///
  74         std::istream & getStream();
  75         /// Danger! Don't use it unless you know what you are doing.
  76         void setLineNo(int l);
  77         /// Change the character that begins a comment. Default is '#'
  78         void setCommentChar(char c);
  79
  80         /// returns a lex code
  81         int lex();
  82
  83         /** Just read athe next word. If esc is true remember that
  84             some chars might be escaped: "\ atleast
  85         */
  86         bool next(bool esc = false);
  87
  88         /** Read next token. This one is almost the same as next,
  89             but it will consider " as a regular character and always
  90             split a word if it contains a backslash.
  91         */
  92         bool nextToken();
  93         /// Push a token, that next token got from lyxlex.
  94         void pushToken(std::string const &);
  95
  96         ///
  97         int getLineNo() const;
  98
  99         ///
 100         int getInteger() const;
 101         ///
 102         bool getBool() const;
 103         ///
 104         double getFloat() const;
 105         ///
 106         std::string const getString() const;
 107
 108         ///
 109         docstring const getDocString() const;
 110
 111         /** Get a long string, ended by the tag `endtag'.
 112             This string can span several lines. The first line
 113             serves as a template for how many spaces the lines
 114             are indented. This much white space is skipped from
 115             each following line. This mechanism does not work
 116             perfectly if you use tabs.
 117         */
 118         std::string const getLongString(std::string const & endtag);
 119
 120         ///
 121         bool eatLine();
 122
 123         /// Pushes a token list on a stack and replaces it with a new one.
 124         void pushTable(keyword_item *, int);
 125
 126         /** Pops a token list into void and replaces it with the one now
 127             on top of the stack.
 128         */
 129         void popTable();
 130
 131         /** Prints an error message with the corresponding line number
 132             and file name. If message contains the substring `$$Token',
 133             it is replaced with the value of GetString()
 134         */
 135         void printError(std::string const & message) const;
 136
 137         /// Prints the current token table on the supplied ostream.
 138         void printTable(std::ostream &);
 139
 140         /// extract string
 141         LyXLex & operator>>(std::string &);
 142         /// extract docstring
 143         LyXLex & operator>>(docstring &);
 144         /// extract double
 145         LyXLex & operator>>(double &);
 146         /// extract integer
 147         LyXLex & operator>>(int &);
 148         /// extract unsigned integer
 149         LyXLex & operator>>(unsigned int &);
 150         /// extract bool
 151         LyXLex & operator>>(bool &);
 152
 153         /// Quotes a string so that reading it again with LyXLex::next(true)
 154         /// gets the original string
 155         static std::string const quoteString(std::string const &);
 156
 157 private:
 158         class Pimpl;
 159         ///
 160         Pimpl * pimpl_;
 161 };
 162
 163
 164 /** Use to enable multiple exit points.
 165     This is needed to ensure that the pop is done upon exit from methods
 166     with more than one exit point or that can return as a response to
 167     exceptions.
 168     @author Lgb
 169 */
 170 class pushpophelper {
 171 public:
 172         ///
 173         pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
 174                 lex.pushTable(i, s);
 175         }
 176         ///
 177         ~pushpophelper() {
 178                 lex.popTable();
 179         }
 180         ///
 181         LyXLex & lex;
 182 };
 183 /** Avoid wrong usage of pushpophelper.
 184     To avoid wrong usage:
 185     pushpophelper(...); // wrong
 186     pushpophelper pph(...); // right
 187 */
 188 #define pushpophelper(x, y, z) unnamed_pushpophelper;
 189 // Tip gotten from Bobby Schmidt's column in C/C++ Users Journal
 190
 191
 192 } // namespace lyx
 193
 194 #endif