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 enum cat_type {
  50         NORMAL_CATCODES,
  51         VERBATIM_CATCODES,
  52         UNDECIDED_CATCODES
  53 };
  54
  55
  56 enum {
  57         FLAG_BRACE_LAST = 1 << 1,  //  last closing brace ends the parsing
  58         FLAG_RIGHT      = 1 << 2,  //  next \\right ends the parsing process
  59         FLAG_END        = 1 << 3,  //  next \\end ends the parsing process
  60         FLAG_BRACK_LAST = 1 << 4,  //  next closing bracket ends the parsing
  61         FLAG_TEXTMODE   = 1 << 5,  //  we are in a box
  62         FLAG_ITEM       = 1 << 6,  //  read a (possibly braced token)
  63         FLAG_LEAVE      = 1 << 7,  //  leave the loop at the end
  64         FLAG_SIMPLE     = 1 << 8,  //  next $ leaves the loop
  65         FLAG_EQUATION   = 1 << 9,  //  next \] leaves the loop
  66         FLAG_SIMPLE2    = 1 << 10, //  next \) leaves the loop
  67         FLAG_OPTION     = 1 << 11, //  read [...] style option
  68         FLAG_BRACED     = 1 << 12, //  read {...} style argument
  69         FLAG_CELL       = 1 << 13, //  read table cell
  70         FLAG_TABBING    = 1 << 14  //  We are inside a tabbing environment
  71 };
  72
  73
  74
  75 //
  76 // Helper class for parsing
  77 //
  78
  79 class Token {
  80 public:
  81         ///
  82         Token() : cs_(), cat_(catIgnore) {}
  83         ///
  84         Token(docstring const & cs, CatCode cat) : cs_(to_utf8(cs)), cat_(cat) {}
  85
  86         /// Returns the token as string
  87         std::string const & cs() const { return cs_; }
  88         /// Returns the catcode of the token
  89         CatCode cat() const { return cat_; }
  90         /** Get the character of tokens that were constructed from a single
  91          * character input or a two character input and cat_ == catEscape.
  92          * FIXME: The intended usage is not clear. The Token class in
  93          *        ../mathed/MathParser.cpp (which is the anchestor of this
  94          *        class) uses a separate char member for this method. I
  95          *        believe that the intended usage is to not cover tokens with
  96          *        catEscape or catComment, e.g. \code
  97          *        return (cs_.empty() || cat_ == catEscape || cat_ == catComment) ? 0 : cs_[0];
  98          *        \endcode
  99          *        All usages of this method should be checked. gb 2011-01-05
 100          */
 101         char character() const { return cs_.empty() ? 0 : cs_[0]; }
 102         /// Returns the token verbatim
 103         std::string asInput() const;
 104         /// Is the token an alphanumerical character?
 105         bool isAlnumASCII() const;
 106
 107 private:
 108         ///
 109         std::string cs_;
 110         ///
 111         CatCode cat_;
 112 };
 113
 114 std::ostream & operator<<(std::ostream & os, Token const & t);
 115
 116 #ifdef FILEDEBUG
 117 extern void debugToken(std::ostream & os, Token const & t, unsigned int flags);
 118 #endif
 119
 120 /// A docstream version that supports putback even when not buffered
 121 class iparserdocstream
 122 {
 123 public:
 124         typedef idocstream::int_type int_type;
 125
 126         iparserdocstream(idocstream & is) : is_(is) {}
 127
 128         /// Like std::istream::operator bool()
 129         /// Do not convert is_ implicitly to bool, since that is forbidden in C++11.
 130         explicit operator bool() const { return s_.empty() ? !is_.fail() : true; }
 131
 132         /// change the encoding of the input stream to \p e (iconv name)
 133         void setEncoding(std::string const & e);
 134
 135         // add to the list of characters to read before actually reading
 136         // the stream
 137         void putback(char_type c);
 138
 139         // add to the list of characters to read before actually reading
 140         // the stream
 141         void putback(docstring s);
 142
 143         /// Like std::istream::get()
 144         iparserdocstream & get(char_type &c);
 145
 146         /// Like std::istream::good()
 147         bool good() const { return s_.empty() ? is_.good() : true; }
 148
 149         /// Like std::istream::peek()
 150         int_type peek() const { return s_.empty() ? is_.peek() : s_[0]; }
 151 private:
 152         ///
 153         idocstream & is_;
 154         /// characters to read before actually reading the stream
 155         docstring s_;
 156 };
 157
 158
 159 /*!
 160  * Actual parser class
 161  *
 162  * The parser parses every character of the inputstream into a token
 163  * and classifies the token.
 164  * The following transformations are done:
 165  * - Consecutive spaces are combined into one single token with CatCode catSpace
 166  * - Consecutive newlines are combined into one single token with CatCode catNewline
 167  * - Comments and %\n combinations are parsed into one token with CatCode catComment
 168  */
 169
 170 class Parser {
 171         /// noncopyable
 172         Parser(Parser const & p);
 173         Parser & operator=(Parser const & p);
 174 public:
 175         ///
 176         Parser(idocstream & is, std::string const & fixedenc);
 177         ///
 178         Parser(std::string const & s);
 179         ///
 180         ~Parser();
 181
 182         /** forget already parsed next tokens and put the
 183          * corresponding characters into the input stream for
 184          * re-reading. Useful when changing catcodes. */
 185         void deparse();
 186
 187         /// change the encoding of the input stream according to \p encoding
 188         /// (latex name) and package \p package
 189         bool setEncoding(std::string const & encoding, int const & package);
 190         /// change the encoding of the input stream to \p encoding (iconv name)
 191         bool setEncoding(std::string const & encoding);
 192         /// get the current iconv encoding of the input stream
 193         std::string getEncoding() const { return encoding_iconv_; }
 194
 195         ///
 196         CatCode catcode(char_type c) const;
 197         ///
 198         void setCatcode(char c, CatCode cat);
 199         /// set parser to normal or verbatim mode
 200         void setCatcodes(cat_type t);
 201
 202         ///
 203         int lineno() const { return lineno_; }
 204         ///
 205         void putback();
 206         /// store current position
 207         void pushPosition();
 208         /// restore previous position
 209         void popPosition();
 210         /// forget last saved position
 211         void dropPosition();
 212         /// dump contents to screen
 213         void dump() const;
 214
 215         /// Does an optional argument follow after the current token?
 216         bool hasOpt();
 217         ///
 218         typedef std::pair<bool, std::string> Arg;
 219         /*!
 220          * Get an argument enclosed by \p left and \p right.
 221          * If \p allow_escaping is true, a right delimiter escaped by a
 222          * backslash does not count as delimiter, but is included in the
 223          * argument.
 224          * \returns wether an argument was found in \p Arg.first and the
 225          * argument in \p Arg.second. \see getArg().
 226          */
 227         Arg getFullArg(char left, char right, bool allow_escaping = true);
 228         /*!
 229          * Get an argument enclosed by \p left and \p right.
 230          * If \p allow_escaping is true, a right delimiter escaped by a
 231          * backslash does not count as delimiter, but is included in the
 232          * argument.
 233          * \returns the argument (without \p left and \p right) or the empty
 234          * string if the next non-space token is not \p left. Use
 235          * getFullArg() if you need to know wether there was an empty
 236          * argument or no argument at all.
 237          */
 238         std::string getArg(char left, char right, bool allow_escaping = true);
 239         /*!
 240          * Like getOpt(), but distinguishes between a missing argument ""
 241          * and an empty argument "[]".
 242          */
 243         std::string getFullOpt(bool keepws = false);
 244         /*!
 245          * \returns getArg('[', ']') including the brackets or the
 246          * empty string if there is no such argument.
 247          * No whitespace is eaten if \p keepws is true and no optional
 248          * argument exists. This is important if an optional argument is
 249          * parsed that would go after a command in ERT: In this case the
 250          * whitespace is needed to separate the ERT from the subsequent
 251          * word. Without it, the ERT and the next word would be concatenated
 252          * during .tex export, thus creating an invalid command.
 253          */
 254         std::string getOpt(bool keepws = false);
 255         /*!
 256          * \returns getFullArg('(', ')') including the parentheses or the
 257          * empty string if there is no such argument.
 258          */
 259         std::string getFullParentheseArg();
 260         /*!
 261          * \returns the contents of the environment \p name.
 262          * <tt>\begin{name}</tt> must be parsed already, <tt>\end{name}</tt>
 263          * is parsed but not returned. This parses nested environments properly.
 264          */
 265         std::string const ertEnvironment(std::string const & name);
 266         /*
 267          * The same as ertEnvironment(std::string const & name) but
 268          * \begin and \end commands inside the name environment are not parsed.
 269          * This function is designed to parse verbatim environments.
 270          */
 271         std::string const plainEnvironment(std::string const & name);
 272         /*
 273          * Basically the same as plainEnvironment(std::string const & name) but
 274          * instead of \begin and \end commands the parsing is started/stopped
 275          * at given characters.
 276          * This function is designed to parse verbatim commands.
 277          */
 278         std::string const plainCommand(char left, char right, std::string const & name);
 279         /*
 280          * Basically the same as plainEnvironment() but the parsing is
 281          * stopped at string \p end_string. Contrary to the other
 282          * methods, this uses proper catcode setting. This function is
 283          * designed to parse verbatim environments and command. The
 284          * intention is to eventually replace all of its siblings. the
 285          * member \p first of the result tells whether the arg was
 286          * found and the member \p second is the value. If \p
 287          * allow_linebreak is false, then the parsing is limited to one line
 288          */
 289         Arg verbatimStuff(std::string const & end_string,
 290                           bool allow_linebreak = true);
 291         /*
 292          * \returns the contents of the environment \p name.
 293          * <tt>\begin{name}</tt> must be parsed already,
 294          * <tt>\end{name}</tt> is parsed but not returned. The string
 295          * is parsed with proper verbatim catcodes and one newline is
 296          * removed from head and tail of the string if applicable.
 297          */
 298         std::string const verbatimEnvironment(std::string const & end_string);
 299         ///
 300         std::string verbatim_item();
 301         ///
 302         std::string verbatimOption();
 303         ///
 304         void error(std::string const & msg);
 305         /// The previous token.
 306         Token const prev_token() const;
 307         /// The current token.
 308         Token const curr_token() const;
 309         /// The next token. Caution: If this is called, an encoding change is
 310         /// only possible again after get_token() has been called.
 311         Token const next_token();
 312         /// The next but one token. Caution: If this is called, an encoding
 313         /// change is only possible again after get_token() has been called
 314         /// twice.
 315         Token const next_next_token();
 316         /// Make the next token current and return that.
 317         Token const get_token();
 318         /// \return whether the current token starts a new paragraph
 319         bool isParagraph();
 320         /// skips spaces (and comments if \p skip_comments is true)
 321         /// \return whether whitespace was skipped (not comments)
 322         bool skip_spaces(bool skip_comments = false);
 323         /// puts back spaces (and comments if \p skip_comments is true)
 324         void unskip_spaces(bool skip_comments = false);
 325         /// Is any further input pending()? This is not like
 326         /// std::istream::good(), which returns true if all available input
 327         /// was read, and the next attempt to read would return EOF.
 328         bool good();
 329         /// resets the parser to initial state
 330         void reset();
 331
 332 private:
 333         /// Setup catcode table
 334         void catInit();
 335         /// Parses one token from \p is
 336         void tokenize_one();
 337         ///
 338         void push_back(Token const & t);
 339         ///
 340         int lineno_;
 341         ///
 342         std::vector<Token> tokens_;
 343         ///
 344         size_t pos_;
 345         ///
 346         std::vector<unsigned> positions_;
 347         ///
 348         idocstringstream * iss_;
 349         ///
 350         iparserdocstream is_;
 351         /// iconv name of the current encoding
 352         std::string encoding_iconv_;
 353         ///
 354         CatCode theCatcode_[256];
 355         ///
 356         cat_type theCatcodesType_;
 357         ///
 358         cat_type curr_cat_;
 359         ///
 360         bool fixed_enc_;
 361 };
 362
 363
 364
 365 } // namespace lyx
 366
 367 #endif