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