src/tex2lyx/Parser.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Parser.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author André Pönitz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef PARSER_H
  13 #define PARSER_H
  14
  15 #include <string>
  16 #include <utility>
  17 #include <vector>
  18
  19 #include "support/docstream.h"
  20
  21 namespace lyx {
  22
  23
  24 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE, MATHTEXT_MODE, TABLE_MODE};
  25
  26 mode_type asMode(mode_type oldmode, std::string const & str);
  27
  28
  29 // These are TeX's catcodes
  30 enum CatCode {
  31         catEscape,     // 0    backslash
  32         catBegin,      // 1    {
  33         catEnd,        // 2    }
  34         catMath,       // 3    $
  35         catAlign,      // 4    &
  36         catNewline,    // 5    ^^M
  37         catParameter,  // 6    #
  38         catSuper,      // 7    ^
  39         catSub,        // 8    _
  40         catIgnore,     // 9
  41         catSpace,      // 10   space
  42         catLetter,     // 11   a-zA-Z
  43         catOther,      // 12   none of the above
  44         catActive,     // 13   ~
  45         catComment,    // 14   %
  46         catInvalid     // 15   <delete>
  47 };
  48
  49
  50 enum {
  51         FLAG_BRACE_LAST = 1 << 1,  //  last closing brace ends the parsing
  52         FLAG_RIGHT      = 1 << 2,  //  next \\right ends the parsing process
  53         FLAG_END        = 1 << 3,  //  next \\end ends the parsing process
  54         FLAG_BRACK_LAST = 1 << 4,  //  next closing bracket ends the parsing
  55         FLAG_TEXTMODE   = 1 << 5,  //  we are in a box
  56         FLAG_ITEM       = 1 << 6,  //  read a (possibly braced token)
  57         FLAG_LEAVE      = 1 << 7,  //  leave the loop at the end
  58         FLAG_SIMPLE     = 1 << 8,  //  next $ leaves the loop
  59         FLAG_EQUATION   = 1 << 9,  //  next \] leaves the loop
  60         FLAG_SIMPLE2    = 1 << 10, //  next \) leaves the loop
  61         FLAG_OPTION     = 1 << 11, //  read [...] style option
  62         FLAG_BRACED     = 1 << 12, //  read {...} style argument
  63         FLAG_CELL       = 1 << 13, //  read table cell
  64         FLAG_TABBING    = 1 << 14  //  We are inside a tabbing environment
  65 };
  66
  67
  68
  69 //
  70 // Helper class for parsing
  71 //
  72
  73 class Token {
  74 public:
  75         ///
  76         Token() : cs_(), cat_(catIgnore) {}
  77         ///
  78         Token(docstring const & cs, CatCode cat) : cs_(to_utf8(cs)), cat_(cat) {}
  79
  80         ///
  81         std::string const & cs() const { return cs_; }
  82         /// Returns the catcode of the token
  83         CatCode cat() const { return cat_; }
  84         ///
  85         char character() const { return cs_.empty() ? 0 : cs_[0]; }
  86         /// Returns the token as string
  87         std::string asString() const;
  88         /// Returns the token verbatim
  89         std::string asInput() const;
  90
  91 private:
  92         ///
  93         std::string cs_;
  94         ///
  95         CatCode cat_;
  96 };
  97
  98 std::ostream & operator<<(std::ostream & os, Token const & t);
  99
 100
 101 /*!
 102  * Actual parser class
 103  *
 104  * The parser parses every character of the inputstream into a token
 105  * and classifies the token.
 106  * The following transformations are done:
 107  * - Consecutive spaces are combined into one single token with CatCode catSpace
 108  * - Consecutive newlines are combined into one single token with CatCode catNewline
 109  * - Comments and %\n combinations are parsed into one token with CatCode catComment
 110  */
 111
 112 class Parser {
 113
 114 public:
 115         ///
 116         Parser(idocstream & is);
 117         ///
 118         Parser(std::string const & s);
 119         ///
 120         ~Parser();
 121
 122         /// change the encoding of the input stream
 123         void setEncoding(std::string const & encoding);
 124
 125         ///
 126         int lineno() const { return lineno_; }
 127         ///
 128         void putback();
 129         /// dump contents to screen
 130         void dump() const;
 131
 132         ///
 133         typedef std::pair<bool, std::string> Arg;
 134         /*!
 135          * Get an argument enclosed by \p left and \p right.
 136          * \returns wether an argument was found in \p Arg.first and the
 137          * argument in \p Arg.second. \see getArg().
 138          */
 139         Arg getFullArg(char left, char right);
 140         /*!
 141          * Get an argument enclosed by \p left and \p right.
 142          * \returns the argument (without \p left and \p right) or the empty
 143          * string if the next non-space token is not \p left. Use
 144          * getFullArg() if you need to know wether there was an empty
 145          * argument or no argument at all.
 146          */
 147         std::string getArg(char left, char right);
 148         /*!
 149          * \returns getFullArg('[', ']') including the brackets or the
 150          * empty string if there is no such argument.
 151          */
 152         std::string getFullOpt();
 153         /*!
 154          * \returns getArg('[', ']') including the brackets or the
 155          * empty string if there is no such argument.
 156          */
 157         std::string getOpt();
 158         /*!
 159          * \returns getFullArg('(', ')') including the parentheses or the
 160          * empty string if there is no such argument.
 161          */
 162         std::string getFullParentheseArg();
 163         /*!
 164          * \returns the contents of the environment \p name.
 165          * <tt>\begin{name}</tt> must be parsed already, <tt>\end{name}</tt>
 166          * is parsed but not returned.
 167          */
 168         std::string const verbatimEnvironment(std::string const & name);
 169         /*!
 170          * Returns the character of the current token and increments
 171          * the token position.
 172          */
 173         char getChar();
 174         ///
 175         void error(std::string const & msg);
 176         /// Parses one token from \p is
 177         void tokenize_one();
 178         ///
 179         void push_back(Token const & t);
 180         /// The previous token.
 181         Token const & prev_token() const;
 182         /// The current token.
 183         Token const & curr_token() const;
 184         /// The next token.
 185         Token const & next_token();
 186         /// Make the next token current and return that.
 187         Token const & get_token();
 188         /// \return whether the current token starts a new paragraph
 189         bool isParagraph();
 190         /// skips spaces (and comments if \p skip_comments is true)
 191         void skip_spaces(bool skip_comments = false);
 192         /// puts back spaces (and comments if \p skip_comments is true)
 193         void unskip_spaces(bool skip_comments = false);
 194         ///
 195         void lex(std::string const & s);
 196         ///
 197         bool good();
 198         ///
 199         std::string verbatim_item();
 200         ///
 201         std::string verbatimOption();
 202         /// resets the parser to initial state
 203         void reset();
 204         ///
 205         void setCatCode(char c, CatCode cat);
 206         ///
 207         CatCode getCatCode(char c) const;
 208
 209 private:
 210         ///
 211         int lineno_;
 212         ///
 213         std::vector<Token> tokens_;
 214         ///
 215         unsigned pos_;
 216         ///
 217         idocstringstream * iss_;
 218         ///
 219         idocstream & is_;
 220 };
 221
 222
 223
 224 } // namespace lyx
 225
 226 #endif