A generic ANTLR parser (LL(k) for k>=1) containing a bunch of utility routines useful at any lookahead depth. More...

#include <Parser.hpp>

Inheritance diagram for antlr::Parser:

Classes
class	Tracer
	Utility class which allows tracing to work even when exceptions are thrown. More...

Public Member Functions
virtual int	LA (unsigned int i)=0
	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).

virtual RefToken	LT (unsigned int i)=0
	Return the i-th token of lookahead.

virtual void	setASTNodeFactory (ASTFactory *factory)
	DEPRECATED! Specify the factory to be used during tree building.

virtual void	setASTFactory (ASTFactory *factory)
	Specify the factory to be used during tree building.

virtual ASTFactory *	getASTFactory ()
	Return a pointer to the ASTFactory used.

virtual RefAST	getAST ()=0
	Get the root AST node of the generated AST.

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)
	Make sure current lookahead symbol matches token type `t`.

virtual void	matchNot (int t)

virtual void	match (const BitSet &b)
	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 unsigned int	mark ()
	Mark a spot in the input and return the position.

virtual void	rewind (unsigned int pos)
	rewind to a previously marked position

virtual void	recover (const RecognitionException &, const BitSet &tokenSet)
	called by the generated parser to do error recovery, override to customize the behaviour.

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
	Get the number of tokens defined.

virtual void	traceIndent ()
	Set or change the input token buffer.

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

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

int	traceDepth

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:

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

After guessing, the parser state is restored by:

restoring the lookahead cache.
rewinding the TokenBuffer.
decreasing the guessing level.

See also: antlr.Token; antlr.TokenBuffer; antlr.TokenStream; antlr.LL1Parser; antlr.LLkParser

Todo: add constructors with ASTFactory.

Definition at line 64 of file Parser.hpp.

Constructor & Destructor Documentation

◆ Parser() [1/3]

antlr::Parser::Parser ( TokenBuffer & input )

inlineprotected

Definition at line 66 of file Parser.hpp.

◆ Parser() [2/3]

antlr::Parser::Parser ( TokenBuffer * input )

inlineprotected

Definition at line 70 of file Parser.hpp.

◆ Parser() [3/3]

antlr::Parser::Parser ( const ParserSharedInputState & state )

inlineprotected

Definition at line 74 of file Parser.hpp.

◆ ~Parser()

virtual antlr::Parser::~Parser ( )

inlinevirtual

Definition at line 79 of file Parser.hpp.

Member Function Documentation

◆ consume()

virtual void antlr::Parser::consume ( )

pure virtual

Get another token object from the token stream.

Implemented in antlr::LLkParser.

◆ consumeUntil() [1/2]

virtual void antlr::Parser::consumeUntil ( const BitSet & set )

inlinevirtual

Consume tokens until one matches the given token set.

Definition at line 151 of file Parser.hpp.

◆ consumeUntil() [2/2]

virtual void antlr::Parser::consumeUntil ( int tokenType )

inlinevirtual

Consume tokens until one matches the given token.

Definition at line 144 of file Parser.hpp.

◆ getAST()

virtual RefAST antlr::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.

◆ getASTFactory()

virtual ASTFactory * antlr::Parser::getASTFactory ( )

inlinevirtual

Return a pointer to the ASTFactory used.

So you might use it in subsequent treewalkers or to reload AST's from disk.

Definition at line 111 of file Parser.hpp.

◆ getFilename()

virtual std::string antlr::Parser::getFilename ( ) const

inlinevirtual

Return the filename of the input file.

Definition at line 122 of file Parser.hpp.

Referenced by reportError(), and reportWarning().

◆ getInputState()

virtual ParserSharedInputState antlr::Parser::getInputState ( ) const

inlinevirtual

Definition at line 136 of file Parser.hpp.

◆ getNumTokens()

virtual int antlr::Parser::getNumTokens ( void ) const

pure virtual

Get the number of tokens defined.

This one should be overridden in subclasses.

◆ LA()

virtual int antlr::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 antlr::LLkParser.

◆ LT()

virtual RefToken antlr::Parser::LT ( unsigned int i )

pure virtual

Return the i-th token of lookahead.

Implemented in antlr::LLkParser.

◆ mark()

virtual unsigned int antlr::Parser::mark ( )

inlinevirtual

Mark a spot in the input and return the position.

Forwarded to TokenBuffer.

Definition at line 230 of file Parser.hpp.

◆ match() [1/2]

virtual void antlr::Parser::match ( const BitSet & b )

inlinevirtual

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.

Definition at line 202 of file Parser.hpp.

◆ match() [2/2]

virtual void antlr::Parser::match ( int t )

inlinevirtual

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.

Definition at line 161 of file Parser.hpp.

◆ matchNot()

virtual void antlr::Parser::matchNot ( int t )

inlinevirtual

Definition at line 184 of file Parser.hpp.

◆ recover()

virtual void antlr::Parser::recover	(	const RecognitionException &	,
		const BitSet &	tokenSet )

inlinevirtual

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

Definition at line 242 of file Parser.hpp.

◆ reportError() [1/2]

void antlr::Parser::reportError ( const RecognitionException & ex )

virtual

Parser error-reporting function can be overridden in subclass.

Definition at line 53 of file Parser.cpp.

References antlr::RecognitionException::toString().

◆ reportError() [2/2]

void antlr::Parser::reportError ( const std ::string & s )

virtual

Parser error-reporting function can be overridden in subclass.

Definition at line 59 of file Parser.cpp.

References getFilename().

◆ reportWarning()

void antlr::Parser::reportWarning ( const std ::string & s )

virtual

Parser warning-reporting function can be overridden in subclass.

Definition at line 68 of file Parser.cpp.

References getFilename().

◆ rewind()

virtual void antlr::Parser::rewind ( unsigned int pos )

inlinevirtual

rewind to a previously marked position

Definition at line 235 of file Parser.hpp.

◆ setASTFactory()

virtual void antlr::Parser::setASTFactory ( ASTFactory * factory )

inlinevirtual

Specify the factory to be used during tree building.

(Compulsory) Setting the factory is nowadays compulsory.

Definition at line 103 of file Parser.hpp.

◆ setASTNodeFactory()

virtual void antlr::Parser::setASTNodeFactory ( ASTFactory * factory )

inlinevirtual

DEPRECATED! Specify the factory to be used during tree building.

(Compulsory) Setting the factory is nowadays compulsory.

See also: setASTFactory

Definition at line 96 of file Parser.hpp.

◆ setFilename()

virtual void antlr::Parser::setFilename ( const std ::string & f )

inlinevirtual

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

Definition at line 127 of file Parser.hpp.

◆ setInputState()

virtual void antlr::Parser::setInputState ( ParserSharedInputState state )

inlinevirtual

Definition at line 132 of file Parser.hpp.

◆ traceIn()

void antlr::Parser::traceIn ( const char * rname )

virtual

Definition at line 85 of file Parser.cpp.

◆ traceIndent()

void antlr::Parser::traceIndent ( )

virtual

Set or change the input token buffer.

Definition at line 79 of file Parser.cpp.

◆ traceOut()

void antlr::Parser::traceOut ( const char * rname )

virtual

Definition at line 98 of file Parser.cpp.

Member Data Documentation

◆ astFactory

ASTFactory* antlr::Parser::astFactory

protected

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

Definition at line 279 of file Parser.hpp.

◆ inputState

ParserSharedInputState antlr::Parser::inputState

protected

Definition at line 273 of file Parser.hpp.

◆ traceDepth

int antlr::Parser::traceDepth

protected

Definition at line 282 of file Parser.hpp.

The documentation for this class was generated from the following files:

antlr/Parser.hpp
antlr/Parser.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Parser() [1/3]

◆ Parser() [2/3]

◆ Parser() [3/3]

◆ ~Parser()

Member Function Documentation

◆ consume()

◆ consumeUntil() [1/2]

◆ consumeUntil() [2/2]

◆ getAST()

◆ getASTFactory()

◆ getFilename()

◆ getInputState()

◆ getNumTokens()

◆ LA()

◆ LT()

◆ mark()

◆ match() [1/2]

◆ match() [2/2]

◆ matchNot()

◆ recover()

◆ reportError() [1/2]

◆ reportError() [2/2]

◆ reportWarning()

◆ rewind()

◆ setASTFactory()

◆ setASTNodeFactory()

◆ setFilename()

◆ setInputState()

◆ traceIn()

◆ traceIndent()

◆ traceOut()

Member Data Documentation

◆ astFactory

◆ inputState

◆ traceDepth