antlr3.TokenStream Class Reference

A stream of tokens accessing tokens from a TokenSource. More...

Inheritance diagram for antlr3.TokenStream:

Inheritance graph
[legend]
Collaboration diagram for antlr3.TokenStream:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def LT
 Get Token at current input pointer + i ahead where i=1 is next Token.
def get
 Get a token at an absolute index i; 0.
def getTokenSource
 Where is this stream pulling tokens from? This is not the name, but the object that provides Token objects.
def toString
 Return the text of all tokens from start to stop, inclusive.


Detailed Description

A stream of tokens accessing tokens from a TokenSource.

This is an abstract class that must be implemented by a subclass.

Definition at line 1192 of file antlr3.py.


Member Function Documentation

def antlr3.TokenStream.LT (   self,
  k 
)

Get Token at current input pointer + i ahead where i=1 is next Token.

i<0 indicates tokens in the past. So -1 is previous token and -2 is two tokens ago. LT(0) is undefined. For i>=n, return Token.EOFToken. Return null for LT(0) and any index that results in an absolute address that is negative.

Reimplemented in antlr3.CommonTokenStream.

Definition at line 1205 of file antlr3.py.

def antlr3.TokenStream.get (   self,
  i 
)

Get a token at an absolute index i; 0.

.n-1. This is really only needed for profiling and debugging and token stream rewriting. If you don't want to buffer up tokens, then this method makes no sense for you. Naturally you can't use the rewrite stream feature. I believe DebugTokenStream can easily be altered to not use this method, removing the dependency.

Reimplemented in antlr3.CommonTokenStream.

Definition at line 1219 of file antlr3.py.

def antlr3.TokenStream.getTokenSource (   self  ) 

Where is this stream pulling tokens from? This is not the name, but the object that provides Token objects.

Reimplemented in antlr3.CommonTokenStream.

Definition at line 1229 of file antlr3.py.

def antlr3.TokenStream.toString (   self,
  start = None,
  stop = None 
)

Return the text of all tokens from start to stop, inclusive.

If the stream does not buffer all the tokens then it can just return "" or null; Users should not access $ruleLabel.text in an action of course in that case.

Because the user is not required to use a token with an index stored in it, we must provide a means for two token objects themselves to indicate the start/end location. Most often this will just delegate to the other toString(int,int). This is also parallel with the TreeNodeStream.toString(Object,Object).

Reimplemented in antlr3.CommonTokenStream.

Definition at line 1247 of file antlr3.py.


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

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