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         iparserdocstream(idocstream & is) : is_(is) {};
 125
 126         operator bool() const { return is_; };
 127
 128         idocstream & docstream() { return is_; };
 129
 130         // add to the list of characters to read before actually reading
 131         // the stream
 132         void putback(char_type c);
 133
 134         // add before the list of characters to read before actually reading
 135         // the stream
 136         void put_almost_back(docstring s);
 137
 138         iparserdocstream & get(char_type &c);
 139 private:
 140         ///
 141         idocstream & is_;
 142         /// characters to read before actually reading the stream
 143         docstring s_;
 144 };
 145
 146
 147 /*!
 148  * Actual parser class
 149  *
 150  * The parser parses every character of the inputstream into a token
 151  * and classifies the token.
 152  * The following transformations are done:
 153  * - Consecutive spaces are combined into one single token with CatCode catSpace
 154  * - Consecutive newlines are combined into one single token with CatCode catNewline
 155  * - Comments and %\n combinations are parsed into one token with CatCode catComment
 156  */
 157
 158 class Parser {
 159         /// noncopyable
 160         Parser(Parser const & p);
 161         Parser & operator=(Parser const & p);
 162 public:
 163         ///
 164         Parser(idocstream & is);
 165         ///
 166         Parser(std::string const & s);
 167         ///
 168         ~Parser();
 169
 170         /** forget already parsed next tokens and put the
 171          * corresponding characters into the input stream for
 172          * re-reading. Useful when changing catcodes. */
 173         void deparse();
 174
 175         /// change the iconv encoding of the input stream
 176         /// according to the latex encoding and package
 177         void setEncoding(std::string const & encoding, int const & package);
 178         /// change the iconv encoding of the input stream
 179         void setEncoding(std::string const & encoding);
 180         /// get the current iconv encoding of the input stream
 181         std::string getEncoding() const { return encoding_iconv_; }
 182
 183         ///
 184         CatCode catcode(char_type c) const;
 185         ///
 186         void setCatcode(char c, CatCode cat);
 187         /// set parser to normal or verbatim mode
 188         void setCatcodes(cat_type t);
 189
 190         ///
 191         int lineno() const { return lineno_; }
 192         ///
 193         void putback();
 194         /// store current position
 195         void pushPosition();
 196         /// restore previous position
 197         void popPosition();
 198         /// dump contents to screen
 199         void dump() const;
 200
 201         /// Does an optional argument follow after the current token?
 202         bool hasOpt();
 203         ///
 204         typedef std::pair<bool, std::string> Arg;
 205         /*!
 206          * Get an argument enclosed by \p left and \p right.
 207          * If \p allow_escaping is true, a right delimiter escaped by a
 208          * backslash does not count as delimiter, but is included in the
 209          * argument.
 210          * \returns wether an argument was found in \p Arg.first and the
 211          * argument in \p Arg.second. \see getArg().
 212          */
 213         Arg getFullArg(char left, char right, bool allow_escaping = true);
 214         /*!
 215          * Get an argument enclosed by \p left and \p right.
 216          * If \p allow_escaping is true, a right delimiter escaped by a
 217          * backslash does not count as delimiter, but is included in the
 218          * argument.
 219          * \returns the argument (without \p left and \p right) or the empty
 220          * string if the next non-space token is not \p left. Use
 221          * getFullArg() if you need to know wether there was an empty
 222          * argument or no argument at all.
 223          */
 224         std::string getArg(char left, char right, bool allow_escaping = true);
 225         /*!
 226          * Like getOpt(), but distinguishes between a missing argument ""
 227          * and an empty argument "[]".
 228          */
 229         std::string getFullOpt(bool keepws = false);
 230         /*!
 231          * \returns getArg('[', ']') including the brackets or the
 232          * empty string if there is no such argument.
 233          * No whitespace is eaten if \p keepws is true and no optional
 234          * argument exists. This is important if an optional argument is
 235          * parsed that would go after a command in ERT: In this case the
 236          * whitespace is needed to separate the ERT from the subsequent
 237          * word. Without it, the ERT and the next word would be concatenated
 238          * during .tex export, thus creating an invalid command.
 239          */
 240         std::string getOpt(bool keepws = false);
 241         /*!
 242          * \returns getFullArg('(', ')') including the parentheses or the
 243          * empty string if there is no such argument.
 244          */
 245         std::string getFullParentheseArg();
 246         /*!
 247          * \returns the contents of the environment \p name.
 248          * <tt>\begin{name}</tt> must be parsed already, <tt>\end{name}</tt>
 249          * is parsed but not returned. This parses nested environments properly.
 250          */
 251         std::string const ertEnvironment(std::string const & name);
 252         /*
 253          * The same as ertEnvironment(std::string const & name) but
 254          * \begin and \end commands inside the name environment are not parsed.
 255          * This function is designed to parse verbatim environments.
 256          */
 257         std::string const plainEnvironment(std::string const & name);
 258         /*
 259          * Basically the same as plainEnvironment(std::string const & name) but
 260          * instead of \begin and \end commands the parsing is started/stopped
 261          * at given characters.
 262          * This function is designed to parse verbatim commands.
 263          */
 264         std::string const plainCommand(char left, char right, std::string const & name);
 265         /*
 266          * Basically the same as plainEnvironment() but the parsing is
 267          * stopped at string \p end_string. Contrary to the other
 268          * methods, this uses proper catcode setting. This function is
 269          * designed to parse verbatim environments and command. The
 270          * intention is to eventually replace all of its siblings.
 271          */
 272         std::string const verbatimStuff(std::string const & end_string);
 273         /*
 274          * \returns the contents of the environment \p name.
 275          * <tt>\begin{name}</tt> must be parsed already,
 276          * <tt>\end{name}</tt> is parsed but not returned. The string
 277          * is parsed with proper verbatim catcodes and one newline is
 278          * removed from head and tail of the string if applicable.
 279          */
 280         std::string const verbatimEnvironment(std::string const & end_string);
 281         ///
 282         std::string verbatim_item();
 283         ///
 284         std::string verbatimOption();
 285         ///
 286         void error(std::string const & msg);
 287         /// The previous token.
 288         Token const prev_token() const;
 289         /// The current token.
 290         Token const curr_token() const;
 291         /// The next token.
 292         Token const next_token();
 293         /// The next but one token.
 294         Token const next_next_token();
 295         /// Make the next token current and return that.
 296         Token const get_token();
 297         /// \return whether the current token starts a new paragraph
 298         bool isParagraph();
 299         /// skips spaces (and comments if \p skip_comments is true)
 300         /// \return whether whitespace was skipped (not comments)
 301         bool skip_spaces(bool skip_comments = false);
 302         /// puts back spaces (and comments if \p skip_comments is true)
 303         void unskip_spaces(bool skip_comments = false);
 304         ///
 305         bool good();
 306         /// resets the parser to initial state
 307         void reset();
 308
 309 private:
 310         /// Setup catcode table
 311         void catInit();
 312         /// Parses one token from \p is
 313         void tokenize_one();
 314         ///
 315         void push_back(Token const & t);
 316         ///
 317         int lineno_;
 318         ///
 319         std::vector<Token> tokens_;
 320         ///
 321         size_t pos_;
 322         ///
 323         std::vector<unsigned> positions_;
 324         ///
 325         idocstringstream * iss_;
 326         ///
 327         iparserdocstream is_;
 328         /// iconv name of the current encoding
 329         std::string encoding_iconv_;
 330         ///
 331         CatCode theCatcode_[256];
 332         //
 333         cat_type theCatcodesType_;
 334         //
 335         cat_type curr_cat_;
 336 };
 337
 338
 339
 340 } // namespace lyx
 341
 342 #endif