Parser.hpp
上传用户:afrynkmhm
上传日期:2007-01-06
资源大小:1262k
文件大小:6k
源码类别:

编译器/解释器

开发平台:

Others

  1. #ifndef INC_Parser_hpp__
  2. #define INC_Parser_hpp__
  3. /**
  4.  * <b>SOFTWARE RIGHTS</b>
  5.  * <p>
  6.  * ANTLR 2.6.0 MageLang Insitute, 1999
  7.  * <p>
  8.  * We reserve no legal rights to the ANTLR--it is fully in the
  9.  * public domain. An individual or company may do whatever
  10.  * they wish with source code distributed with ANTLR or the
  11.  * code generated by ANTLR, including the incorporation of
  12.  * ANTLR, or its output, into commerical software.
  13.  * <p>
  14.  * We encourage users to develop software with ANTLR. However,
  15.  * we do ask that credit is given to us for developing
  16.  * ANTLR. By "credit", we mean that if you use ANTLR or
  17.  * incorporate any source code into one of your programs
  18.  * (commercial product, research project, or otherwise) that
  19.  * you acknowledge this fact somewhere in the documentation,
  20.  * research report, etc... If you like ANTLR and have
  21.  * developed a nice tool with the output, please mention that
  22.  * you developed it using ANTLR. In addition, we ask that the
  23.  * headers remain intact in our source code. As long as these
  24.  * guidelines are kept, we expect to continue enhancing this
  25.  * system and expect to make other tools available as they are
  26.  * completed.
  27.  * <p>
  28.  * The ANTLR gang:
  29.  * @version ANTLR 2.6.0 MageLang Insitute, 1999
  30.  * @author Terence Parr, <a href=http://www.MageLang.com>MageLang Institute</a>
  31.  * @author <br>John Lilley, <a href=http://www.Empathy.com>Empathy Software</a>
  32.  * @author <br><a href="mailto:pete@yamuna.demon.co.uk">Pete Wells</a>
  33.  */
  34. #include "antlr/config.hpp"
  35. #include "antlr/BitSet.hpp"
  36. #include "antlr/TokenBuffer.hpp"
  37. #include "antlr/RecognitionException.hpp"
  38. #include "antlr/ASTFactory.hpp"
  39. #include "antlr/ParserSharedInputState.hpp"
  40. ANTLR_BEGIN_NAMESPACE(antlr)
  41. /**A generic ANTLR parser (LL(k) for k>=1) containing a bunch of
  42.  * utility routines useful at any lookahead depth.  We distinguish between
  43.  * the LL(1) and LL(k) parsers because of efficiency.  This may not be
  44.  * necessary in the near future.
  45.  *
  46.  * Each parser object contains the state of the parse including a lookahead
  47.  * cache (the form of which is determined by the subclass), whether or
  48.  * not the parser is in guess mode, where tokens come from, etc...
  49.  *
  50.  * <p>
  51.  * During <b>guess</b> mode, the current lookahead token(s) and token type(s)
  52.  * cache must be saved because the token stream may not have been informed
  53.  * to save the token (via <tt>mark</tt>) before the <tt>try</tt> block.
  54.  * Guessing is started by:
  55.  * <ol>
  56.  * <li>saving the lookahead cache.
  57.  * <li>marking the current position in the TokenBuffer.
  58.  * <li>increasing the guessing level.
  59.  * </ol>
  60.  *
  61.  * After guessing, the parser state is restored by:
  62.  * <ol>
  63.  * <li>restoring the lookahead cache.
  64.  * <li>rewinding the TokenBuffer.
  65.  * <li>decreasing the guessing level.
  66.  * </ol>
  67.  *
  68.  * @see antlr.Token
  69.  * @see antlr.TokenBuffer
  70.  * @see antlr.TokenStream
  71.  * @see antlr.LL1Parser
  72.  * @see antlr.LLkParser
  73.  */
  74. extern bool DEBUG_PARSER;
  75. class Parser {
  76. protected:
  77. ParserSharedInputState inputState;
  78. /** Nesting level of registered handlers */
  79. // int exceptionLevel;
  80. /** Table of token type to token names */
  81. ANTLR_USE_NAMESPACE(std)vector<ANTLR_USE_NAMESPACE(std)string> tokenNames;
  82. /** AST return value for a rule is squirreled away here */
  83. RefAST returnAST;
  84. /** AST support code; parser and treeparser delegate to this object */
  85. ASTFactory astFactory;
  86. // Parser();
  87. Parser(TokenBuffer& input_);
  88. Parser(TokenBuffer* input_);
  89. Parser(const ParserSharedInputState& state);
  90. public:
  91. virtual ~Parser();
  92. protected:
  93. void setTokenNames(const char** tokenNames_);
  94. public:
  95. /**Get another token object from the token stream */
  96. virtual void consume()=0;
  97. /** Consume tokens until one matches the given token */
  98. void consumeUntil(int tokenType);
  99. /** Consume tokens until one matches the given token set */
  100. void consumeUntil(const BitSet& set);
  101. /** Get the AST return value squirreled away in the parser */
  102. RefAST getAST();
  103. ASTFactory& getASTFactory();
  104. ANTLR_USE_NAMESPACE(std)string getFilename() const;
  105. virtual ParserSharedInputState getInputState() const;
  106. ANTLR_USE_NAMESPACE(std)string getTokenName(int num) const;
  107. ANTLR_USE_NAMESPACE(std)vector<ANTLR_USE_NAMESPACE(std)string> getTokenNames() const;
  108. /** Return the token type of the ith token of lookahead where i=1
  109.  * is the current token being examined by the parser (i.e., it
  110.  * has not been matched yet).
  111.  */
  112. virtual int LA(int i)=0;
  113. /**Return the ith token of lookahead */
  114. virtual RefToken LT(int i)=0;
  115. // Forwarded to TokenBuffer
  116. virtual int mark();
  117. /**Make sure current lookahead symbol matches token type <tt>t</tt>.
  118.  * Throw an exception upon mismatch, which is catch by either the
  119.  * error handler or by the syntactic predicate.
  120.  */
  121. void match(int t);
  122. /**Make sure current lookahead symbol matches the given set
  123.  * Throw an exception upon mismatch, which is catch by either the
  124.  * error handler or by the syntactic predicate.
  125.  */
  126. void match(const BitSet& b);
  127. void matchNot(int t);
  128. static void panic();
  129. /** Parser error-reporting function can be overridden in subclass */
  130. virtual void reportError(const RecognitionException& ex);
  131. /** Parser error-reporting function can be overridden in subclass */
  132. virtual void reportError(const ANTLR_USE_NAMESPACE(std)string& s);
  133. /** Parser warning-reporting function can be overridden in subclass */
  134. virtual void reportWarning(const ANTLR_USE_NAMESPACE(std)string& s);
  135. virtual void rewind(int pos);
  136. /** Set the object used to generate ASTs */
  137. // void setASTFactory(ASTFactory astFactory_);
  138. /** Specify the type of node to create during tree building */
  139. void setASTNodeFactory(ASTFactory::factory_type factory);
  140. void setFilename(const ANTLR_USE_NAMESPACE(std)string& f);
  141. void setInputState(ParserSharedInputState state);
  142. /** Set or change the input token buffer */
  143. // void setTokenBuffer(TokenBuffer<Token>* t);
  144. virtual void traceIn(const ANTLR_USE_NAMESPACE(std)string& rname);
  145. virtual void traceOut(const ANTLR_USE_NAMESPACE(std)string& rname);
  146. protected:
  147. class Tracer {
  148. private:
  149. Parser* parser;
  150. ANTLR_USE_NAMESPACE(std)string text;
  151. public:
  152. Tracer(Parser* p,const ANTLR_USE_NAMESPACE(std)string& t)
  153. : parser(p), text(t) { parser->traceIn(text); }
  154. ~Tracer()
  155. { parser->traceOut(text); }
  156. };
  157. private:
  158. Parser(const Parser&);
  159. const Parser& operator=(const Parser&);
  160. };
  161. ANTLR_END_NAMESPACE
  162. #endif //INC_Parser_hpp__