antlr
Class Parser

java.lang.Object
  extended byantlr.Parser
Direct Known Subclasses:
LLkParser
public abstract class Parser
extends java.lang.Object

Constructor Summary
Parser()
           
Parser(ParserSharedInputState state)
           
 
Method Summary
 void addMessageListener(MessageListener l)
           
 void addParserListener(ParserListener l)
           
 void addParserMatchListener(ParserMatchListener l)
           
 void addParserTokenListener(ParserTokenListener l)
           
 void addSemanticPredicateListener(SemanticPredicateListener l)
           
 void addSyntacticPredicateListener(SyntacticPredicateListener l)
           
 void addTraceListener(TraceListener l)
           
abstract  void consume()
          Get another token object from the token stream
 void consumeUntil(BitSet set)
          Consume tokens until one matches the given token set
 void consumeUntil(int tokenType)
          Consume tokens until one matches the given token
 AST getAST()
          Get the AST return value squirreled away in the parser
 ASTFactory getASTFactory()
           
 java.lang.String getFilename()
           
 ParserSharedInputState getInputState()
           
 java.lang.String getTokenName(int num)
           
 java.lang.String[] getTokenNames()
           
 java.util.Hashtable getTokenTypeToASTClassMap()
          If the user specifies a tokens{} section with heterogeneous AST node types, then ANTLR generates code to fill this mapping.
 boolean isDebugMode()
           
abstract  int LA(int i)
          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).
abstract  Token LT(int i)
          Return the ith token of lookahead
 int mark()
           
 void match(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.
 void match(int t)
          Make sure current lookahead symbol matches token type t.
 void matchNot(int t)
           
static void panic()
          Deprecated. as of 2.7.2. This method calls System.exit() and writes directly to stderr, which is usually not appropriate when a parser is embedded into a larger application. Since the method is static, it cannot be overridden to avoid these problems. ANTLR no longer uses this method internally or in generated code.
 void removeMessageListener(MessageListener l)
           
 void removeParserListener(ParserListener l)
           
 void removeParserMatchListener(ParserMatchListener l)
           
 void removeParserTokenListener(ParserTokenListener l)
           
 void removeSemanticPredicateListener(SemanticPredicateListener l)
           
 void removeSyntacticPredicateListener(SyntacticPredicateListener l)
           
 void removeTraceListener(TraceListener l)
           
 void reportError(RecognitionException ex)
          Parser error-reporting function can be overridden in subclass
 void reportError(java.lang.String s)
          Parser error-reporting function can be overridden in subclass
 void reportWarning(java.lang.String s)
          Parser warning-reporting function can be overridden in subclass
 void rewind(int pos)
           
 void setASTFactory(ASTFactory f)
          Specify an object with support code (shared by Parser and TreeParser.
 void setASTNodeClass(java.lang.String cl)
           
 void setASTNodeType(java.lang.String nodeType)
          Deprecated. since 2.7.1
 void setDebugMode(boolean debugMode)
           
 void setFilename(java.lang.String f)
           
 void setIgnoreInvalidDebugCalls(boolean value)
           
 void setInputState(ParserSharedInputState state)
           
 void setTokenBuffer(TokenBuffer t)
          Set or change the input token buffer
 void traceIn(java.lang.String rname)
           
 void traceIndent()
           
 void traceOut(java.lang.String rname)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Parser

public Parser()

Parser

public Parser(ParserSharedInputState state)
Method Detail

getTokenTypeToASTClassMap

public java.util.Hashtable getTokenTypeToASTClassMap()
If the user specifies a tokens{} section with heterogeneous AST node types, then ANTLR generates code to fill this mapping.

addMessageListener

public void addMessageListener(MessageListener l)

addParserListener

public void addParserListener(ParserListener l)

addParserMatchListener

public void addParserMatchListener(ParserMatchListener l)

addParserTokenListener

public void addParserTokenListener(ParserTokenListener l)

addSemanticPredicateListener

public void addSemanticPredicateListener(SemanticPredicateListener l)

addSyntacticPredicateListener

public void addSyntacticPredicateListener(SyntacticPredicateListener l)

addTraceListener

public void addTraceListener(TraceListener l)

consume

public abstract void consume()
                      throws TokenStreamException
Get another token object from the token stream

Throws:
TokenStreamException

consumeUntil

public void consumeUntil(int tokenType)
                  throws TokenStreamException
Consume tokens until one matches the given token

Throws:
TokenStreamException

consumeUntil

public void consumeUntil(BitSet set)
                  throws TokenStreamException
Consume tokens until one matches the given token set

Throws:
TokenStreamException

getAST

public AST getAST()
Get the AST return value squirreled away in the parser

getASTFactory

public ASTFactory getASTFactory()

getFilename

public java.lang.String getFilename()

getInputState

public ParserSharedInputState getInputState()

setInputState

public void setInputState(ParserSharedInputState state)

getTokenName

public java.lang.String getTokenName(int num)

getTokenNames

public java.lang.String[] getTokenNames()

isDebugMode

public boolean isDebugMode()

LA

public abstract int LA(int i)
                throws TokenStreamException
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).

Throws:
TokenStreamException

LT

public abstract Token LT(int i)
                  throws TokenStreamException
Return the ith token of lookahead

Throws:
TokenStreamException

mark

public int mark()

match

public void match(int t)
           throws MismatchedTokenException,
                  TokenStreamException
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.

Throws:
MismatchedTokenException
TokenStreamException

match

public void match(BitSet b)
           throws MismatchedTokenException,
                  TokenStreamException
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.

Throws:
MismatchedTokenException
TokenStreamException

matchNot

public void matchNot(int t)
              throws MismatchedTokenException,
                     TokenStreamException
Throws:
MismatchedTokenException
TokenStreamException

panic

public static void panic()
Deprecated. as of 2.7.2. This method calls System.exit() and writes directly to stderr, which is usually not appropriate when a parser is embedded into a larger application. Since the method is static, it cannot be overridden to avoid these problems. ANTLR no longer uses this method internally or in generated code.

removeMessageListener

public void removeMessageListener(MessageListener l)

removeParserListener

public void removeParserListener(ParserListener l)

removeParserMatchListener

public void removeParserMatchListener(ParserMatchListener l)

removeParserTokenListener

public void removeParserTokenListener(ParserTokenListener l)

removeSemanticPredicateListener

public void removeSemanticPredicateListener(SemanticPredicateListener l)

removeSyntacticPredicateListener

public void removeSyntacticPredicateListener(SyntacticPredicateListener l)

removeTraceListener

public void removeTraceListener(TraceListener l)

reportError

public void reportError(RecognitionException ex)
Parser error-reporting function can be overridden in subclass

reportError

public void reportError(java.lang.String s)
Parser error-reporting function can be overridden in subclass

reportWarning

public void reportWarning(java.lang.String s)
Parser warning-reporting function can be overridden in subclass

rewind

public void rewind(int pos)

setASTFactory

public void setASTFactory(ASTFactory f)
Specify an object with support code (shared by Parser and TreeParser. Normally, the programmer does not play with this, using setASTNodeType instead.

setASTNodeClass

public void setASTNodeClass(java.lang.String cl)

setASTNodeType

public void setASTNodeType(java.lang.String nodeType)
Deprecated. since 2.7.1

Specify the type of node to create during tree building; use setASTNodeClass now to be consistent with Token Object Type accessor.

setDebugMode

public void setDebugMode(boolean debugMode)

setFilename

public void setFilename(java.lang.String f)

setIgnoreInvalidDebugCalls

public void setIgnoreInvalidDebugCalls(boolean value)

setTokenBuffer

public void setTokenBuffer(TokenBuffer t)
Set or change the input token buffer

traceIndent

public void traceIndent()

traceIn

public void traceIn(java.lang.String rname)
             throws TokenStreamException
Throws:
TokenStreamException

traceOut

public void traceOut(java.lang.String rname)
              throws TokenStreamException
Throws:
TokenStreamException