ANTLR Support Libraries 2.7.1+
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions

Parser Class Reference

#include <Parser.hpp>

Inheritance diagram for Parser:
Inheritance graph
[legend]
Collaboration diagram for Parser:
Collaboration graph
[legend]

List of all members.

Classes

class  Tracer

Public Member Functions

virtual ~Parser ()
virtual int LA (unsigned int i)=0
virtual RefToken LT (unsigned int i)=0
 Return the i-th token of lookahead.
virtual void setASTNodeFactory (ASTFactory *factory)
virtual void setASTFactory (ASTFactory *factory)
virtual ASTFactorygetASTFactory ()
virtual RefAST getAST ()=0
virtual std::string getFilename () const
 Return the filename of the input file.
virtual void setFilename (const std::string &f)
 Set the filename of the input file (used for error reporting).
virtual void setInputState (ParserSharedInputState state)
virtual ParserSharedInputState getInputState () const
virtual void consume ()=0
 Get another token object from the token stream.
virtual void consumeUntil (int tokenType)
 Consume tokens until one matches the given token.
virtual void consumeUntil (const BitSet &set)
 Consume tokens until one matches the given token set.
virtual void match (int t)
virtual void matchNot (int t)
virtual void match (const BitSet &b)
virtual unsigned int mark ()
virtual void rewind (unsigned int pos)
 rewind to a previously marked position
virtual void recover (const RecognitionException &ex, const BitSet &tokenSet)
virtual void reportError (const RecognitionException &ex)
 Parser error-reporting function can be overridden in subclass.
virtual void reportError (const std::string &s)
 Parser error-reporting function can be overridden in subclass.
virtual void reportWarning (const std::string &s)
 Parser warning-reporting function can be overridden in subclass.
virtual const char * getTokenName (int num) const =0
 get the token name for the token number 'num'
virtual const char *const getTokenNames () const =0
 get a vector with all token names
virtual int getNumTokens (void) const =0
virtual void traceIndent ()
virtual void traceIn (const char *rname)
virtual void traceOut (const char *rname)

Protected Member Functions

 Parser (TokenBuffer &input)
 Parser (TokenBuffer *input)
 Parser (const ParserSharedInputState &state)

Protected Attributes

ParserSharedInputState inputState
ASTFactoryastFactory
 AST support code; parser and treeparser delegate to this object.
int traceDepth

Private Member Functions

 Parser (const Parser &)
const Parseroperator= (const Parser &)

Detailed Description

A generic ANTLR parser (LL(k) for k>=1) containing a bunch of utility routines useful at any lookahead depth. We distinguish between the LL(1) and LL(k) parsers because of efficiency. This may not be necessary in the near future.

Each parser object contains the state of the parse including a lookahead cache (the form of which is determined by the subclass), whether or not the parser is in guess mode, where tokens come from, etc...

During guess mode, the current lookahead token(s) and token type(s) cache must be saved because the token stream may not have been informed to save the token (via mark) before the try block. Guessing is started by:

  1. saving the lookahead cache.
  2. marking the current position in the TokenBuffer.
  3. increasing the guessing level.

After guessing, the parser state is restored by:

  1. restoring the lookahead cache.
  2. rewinding the TokenBuffer.
  3. decreasing the guessing level.
See also:
antlr.Token
antlr.TokenBuffer
antlr.TokenStream
antlr.LL1Parser
antlr.LLkParser
Todo:
add constructors with ASTFactory.

Constructor & Destructor Documentation

Parser::Parser ( TokenBuffer input) [inline, protected]
Parser::Parser ( TokenBuffer input) [inline, protected]
Parser::Parser ( const ParserSharedInputState state) [inline, protected]
virtual Parser::~Parser ( ) [inline, virtual]
Parser::Parser ( const Parser ) [private]

Member Function Documentation

virtual void Parser::consume ( ) [pure virtual]

Get another token object from the token stream.

Implemented in LLkParser.

virtual void Parser::consumeUntil ( int  tokenType) [inline, virtual]

Consume tokens until one matches the given token.

virtual void Parser::consumeUntil ( const BitSet set) [inline, virtual]

Consume tokens until one matches the given token set.

virtual RefAST Parser::getAST ( ) [pure virtual]

Get the root AST node of the generated AST. When using a custom AST type or heterogenous AST's, you'll have to convert it to the right type yourself.

virtual ASTFactory* Parser::getASTFactory ( ) [inline, virtual]

Return a pointer to the ASTFactory used. So you might use it in subsequent treewalkers or to reload AST's from disk.

virtual std ::string Parser::getFilename ( ) const [inline, virtual]

Return the filename of the input file.

virtual ParserSharedInputState Parser::getInputState ( ) const [inline, virtual]
virtual int Parser::getNumTokens ( void  ) const [pure virtual]

Get the number of tokens defined. This one should be overridden in subclasses.

virtual const char* Parser::getTokenName ( int  num) const [pure virtual]

get the token name for the token number 'num'

virtual const char* const Parser::getTokenNames ( ) const [pure virtual]

get a vector with all token names

virtual int Parser::LA ( unsigned int  i) [pure virtual]

Return the token type of the ith token of lookahead where i=1 is the current token being examined by the parser (i.e., it has not been matched yet).

Implemented in LLkParser.

virtual RefToken Parser::LT ( unsigned int  i) [pure virtual]

Return the i-th token of lookahead.

Implemented in LLkParser.

virtual unsigned int Parser::mark ( ) [inline, virtual]

Mark a spot in the input and return the position. Forwarded to TokenBuffer.

virtual void Parser::match ( const BitSet b) [inline, virtual]

Make sure current lookahead symbol matches the given set Throw an exception upon mismatch, which is catch by either the error handler or by the syntactic predicate.

virtual void Parser::match ( int  t) [inline, virtual]

Make sure current lookahead symbol matches token type t. Throw an exception upon mismatch, which is catch by either the error handler or by the syntactic predicate.

virtual void Parser::matchNot ( int  t) [inline, virtual]
const Parser& Parser::operator= ( const Parser ) [private]
virtual void Parser::recover ( const RecognitionException &  ex,
const BitSet tokenSet 
) [inline, virtual]

called by the generated parser to do error recovery, override to customize the behaviour.

void Parser::reportError ( const RecognitionException &  ex) [virtual]

Parser error-reporting function can be overridden in subclass.

Parser error-reporting function can be overridden in subclass

void Parser::reportError ( const std::string &  s) [virtual]

Parser error-reporting function can be overridden in subclass.

Parser error-reporting function can be overridden in subclass

void Parser::reportWarning ( const std::string &  s) [virtual]

Parser warning-reporting function can be overridden in subclass.

Parser warning-reporting function can be overridden in subclass

virtual void Parser::rewind ( unsigned int  pos) [inline, virtual]

rewind to a previously marked position

virtual void Parser::setASTFactory ( ASTFactory factory) [inline, virtual]

Specify the factory to be used during tree building. (Compulsory) Setting the factory is nowadays compulsory.

virtual void Parser::setASTNodeFactory ( ASTFactory factory) [inline, virtual]

DEPRECATED! Specify the factory to be used during tree building. (Compulsory) Setting the factory is nowadays compulsory.

See also:
setASTFactory
virtual void Parser::setFilename ( const std::string &  f) [inline, virtual]

Set the filename of the input file (used for error reporting).

virtual void Parser::setInputState ( ParserSharedInputState  state) [inline, virtual]
void Parser::traceIn ( const char *  rname) [virtual]

Reimplemented in LLkParser.

void Parser::traceIndent ( ) [virtual]

Set or change the input token buffer

void Parser::traceOut ( const char *  rname) [virtual]

Reimplemented in LLkParser.


Member Data Documentation

AST support code; parser and treeparser delegate to this object.

int Parser::traceDepth [protected]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Friends Defines