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         /// Returns the token as string
  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 verbatim
  87         std::string asInput() const;
  88         /// Is the token an alphanumerical character?
  89         bool isAlnumASCII() 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 latex encoding of the input stream
 123         void setEncoding(std::string const & encoding);
 124         /// get the current latex encoding of the input stream
 125         std::string getEncoding() const { return encoding_latex_; }
 126
 127         ///
 128         int lineno() const { return lineno_; }
 129         ///
 130         void putback();
 131         /// dump contents to screen
 132         void dump() const;
 133
 134         /// Does an optional argument follow after the current token?
 135         bool hasOpt();
 136         ///
 137         typedef std::pair<bool, std::string> Arg;
 138         /*!
 139          * Get an argument enclosed by \p left and \p right.
 140          * \returns wether an argument was found in \p Arg.first and the
 141          * argument in \p Arg.second. \see getArg().
 142          */
 143         Arg getFullArg(char left, char right);
 144         /*!
 145          * Get an argument enclosed by \p left and \p right.
 146          * \returns the argument (without \p left and \p right) or the empty
 147          * string if the next non-space token is not \p left. Use
 148          * getFullArg() if you need to know wether there was an empty
 149          * argument or no argument at all.
 150          */
 151         std::string getArg(char left, char right);
 152         /*!
 153          * \returns getFullArg('[', ']') including the brackets or the
 154          * empty string if there is no such argument.
 155          */
 156         std::string getFullOpt();
 157         /*!
 158          * \returns getArg('[', ']') including the brackets or the
 159          * empty string if there is no such argument.
 160          * No whitespace is eaten if \p keepws is true and no optional
 161          * argument exists. This is important if an optional argument is
 162          * parsed that would go after a command in ERT: In this case the
 163          * whitespace is needed to separate the ERT from the subsequent
 164          * word. Without it, the ERT and the next word would be concatenated
 165          * during .tex export, thus creating an invalid command.
 166          */
 167         std::string getOpt(bool keepws = false);
 168         /*!
 169          * the same as getOpt but without the brackets
 170          */
 171         std::string getOptContent();
 172         /*!
 173          * \returns getFullArg('(', ')') including the parentheses or the
 174          * empty string if there is no such argument.
 175          */
 176         std::string getFullParentheseArg();
 177         /*!
 178          * \returns the contents of the environment \p name.
 179          * <tt>\begin{name}</tt> must be parsed already, <tt>\end{name}</tt>
 180          * is parsed but not returned.
 181          */
 182         std::string const verbatimEnvironment(std::string const & name);
 183         /*!
 184          * Returns the character of the current token and increments
 185          * the token position.
 186          */
 187         char getChar();
 188         ///
 189         void error(std::string const & msg);
 190         /// Parses one token from \p is
 191         void tokenize_one();
 192         ///
 193         void push_back(Token const & t);
 194         /// The previous token.
 195         Token const prev_token() const;
 196         /// The current token.
 197         Token const curr_token() const;
 198         /// The next token.
 199         Token const next_token();
 200         /// Make the next token current and return that.
 201         Token const get_token();
 202         /// \return whether the current token starts a new paragraph
 203         bool isParagraph();
 204         /// skips spaces (and comments if \p skip_comments is true)
 205         /// \return whether whitespace was skipped (not comments)
 206         bool skip_spaces(bool skip_comments = false);
 207         /// puts back spaces (and comments if \p skip_comments is true)
 208         void unskip_spaces(bool skip_comments = false);
 209         ///
 210         void lex(std::string const & s);
 211         ///
 212         bool good();
 213         ///
 214         std::string verbatim_item();
 215         ///
 216         std::string verbatimOption();
 217         /// resets the parser to initial state
 218         void reset();
 219         ///
 220         void setCatCode(char c, CatCode cat);
 221         ///
 222         CatCode getCatCode(char c) const;
 223
 224 private:
 225         ///
 226         int lineno_;
 227         ///
 228         std::vector<Token> tokens_;
 229         ///
 230         unsigned pos_;
 231         ///
 232         idocstringstream * iss_;
 233         ///
 234         idocstream & is_;
 235         /// latex name of the current encoding
 236         std::string encoding_latex_;
 237 };
 238
 239
 240
 241 } // namespace lyx
 242
 243 #endif