antlr3.tree.TreeParser Class Reference

Baseclass for generated tree parsers. More...

Inheritance diagram for antlr3.tree.TreeParser:

Inheritance graph
[legend]
Collaboration diagram for antlr3.tree.TreeParser:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def reset
def setTreeNodeStream
 Set the input stream.
def getTreeNodeStream
def getSourceName
def getCurrentInputSymbol
def getMissingSymbol
def inContext
 Check if current node in input has a context.
def matchAny
 Match '.
def mismatch
 We have DOWN/UP nodes in the stream that have no line info; override.
def getErrorHeader
 Prefix error message with the grammar name because message is always intended for the programmer because the parser built the input tree not the user.
def getErrorMessage
 Tree parsers parse nodes they usually have a token object as payload.
def traceIn
def traceOut

Public Attributes

 input

Static Public Attributes

string dotdot = ".*[^.]\\.\\.[^.].*"
string doubleEtc = ".*\\.\\.\\.\\s+\\.\\.\\..*"
tuple dotdotPattern = re.compile(dotdot)
tuple doubleEtcPattern = re.compile(doubleEtc)

Private Member Functions

def _inContext
 The worker for inContext.
def _getAncestor
 Helper for static inContext.


Detailed Description

Baseclass for generated tree parsers.

A parser for a stream of tree nodes. "tree grammars" result in a subclass of this. All the error reporting and recovery is shared with Parser via the BaseRecognizer superclass.

Definition at line 2265 of file tree.py.


Member Function Documentation

def antlr3.tree.TreeParser.__init__ (   self,
  input,
  state = None 
)

Definition at line 2267 of file tree.py.

def antlr3.tree.TreeParser.reset (   self  ) 

Definition at line 2274 of file tree.py.

def antlr3.tree.TreeParser.setTreeNodeStream (   self,
  input 
)

Set the input stream.

Definition at line 2282 of file tree.py.

def antlr3.tree.TreeParser.getTreeNodeStream (   self  ) 

Definition at line 2287 of file tree.py.

def antlr3.tree.TreeParser.getSourceName (   self  ) 

Definition at line 2291 of file tree.py.

def antlr3.tree.TreeParser.getCurrentInputSymbol (   self,
  input 
)

Definition at line 2295 of file tree.py.

def antlr3.tree.TreeParser.getMissingSymbol (   self,
  input,
  e,
  expectedTokenType,
  follow 
)

Definition at line 2299 of file tree.py.

def antlr3.tree.TreeParser.inContext (   self,
  context,
  adaptor = None,
  tokenName = None,
  t = None 
)

Check if current node in input has a context.

Context means sequence of nodes towards root of tree. For example, you might say context is "MULT" which means my parent must be MULT. "CLASS VARDEF" says current node must be child of a VARDEF and whose parent is a CLASS node. You can use "..." to mean zero-or-more nodes. "METHOD ... VARDEF" means my parent is VARDEF and somewhere above that is a METHOD node. The first node in the context is not necessarily the root. The context matcher stops matching and returns true when it runs out of context. There is no way to force the first node to be the root.

Definition at line 2323 of file tree.py.

def antlr3.tree.TreeParser._inContext (   cls,
  adaptor,
  tokenNames,
  t,
  context 
) [private]

The worker for inContext.

It's static and full of parameters for testing purposes.

Definition at line 2335 of file tree.py.

def antlr3.tree.TreeParser._getAncestor (   adaptor,
  tokenNames,
  t,
  goal 
) [private]

Helper for static inContext.

Definition at line 2382 of file tree.py.

def antlr3.tree.TreeParser.matchAny (   self,
  ignore 
)

Match '.

' in tree parser has special meaning. Skip node or entire tree if node has children. If children, scan until corresponding UP node.

Definition at line 2398 of file tree.py.

def antlr3.tree.TreeParser.mismatch (   self,
  input,
  ttype,
  follow 
)

We have DOWN/UP nodes in the stream that have no line info; override.

plus we want to alter the exception type. Don't try to recover from tree parser errors inline...

Definition at line 2430 of file tree.py.

def antlr3.tree.TreeParser.getErrorHeader (   self,
  e 
)

Prefix error message with the grammar name because message is always intended for the programmer because the parser built the input tree not the user.

Definition at line 2441 of file tree.py.

def antlr3.tree.TreeParser.getErrorMessage (   self,
  e,
  tokenNames 
)

Tree parsers parse nodes they usually have a token object as payload.

Set the exception token and do the default behavior.

Definition at line 2456 of file tree.py.

def antlr3.tree.TreeParser.traceIn (   self,
  ruleName,
  ruleIndex 
)

Definition at line 2470 of file tree.py.

def antlr3.tree.TreeParser.traceOut (   self,
  ruleName,
  ruleIndex 
)

Definition at line 2474 of file tree.py.


Member Data Documentation

string antlr3.tree.TreeParser.dotdot = ".*[^.]\\.\\.[^.].*" [static]

Definition at line 2305 of file tree.py.

string antlr3.tree.TreeParser.doubleEtc = ".*\\.\\.\\.\\s+\\.\\.\\..*" [static]

Definition at line 2306 of file tree.py.

tuple antlr3.tree.TreeParser.dotdotPattern = re.compile(dotdot) [static]

Definition at line 2307 of file tree.py.

tuple antlr3.tree.TreeParser.doubleEtcPattern = re.compile(doubleEtc) [static]

Definition at line 2308 of file tree.py.

Definition at line 2270 of file tree.py.


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

Generated on Mon Nov 29 17:24:30 2010 for ANTLR Python API by  doxygen 1.5.5