Token streams TokenStream +- CommonTokenStream \- TokenRewriteStream. More...

Inheritance diagram for rve_interface_gen.antlr3.streams.CommonTokenStream:

Public Member Functions
def	__init__
def	consume
def	discardTokenType
def	fillBuffer
def	get
def	getSourceName
def	getTokens
def	getTokenSource
def	index
def	LA
def	LB
def	LT
def	mark
def	release
def	reset
def	rewind
def	seek
def	setTokenSource
def	setTokenTypeChannel
def	size
def	skipOffTokenChannels
def	skipOffTokenChannelsReverse
def	toString
Public Attributes
	channel
	channelOverrideMap
	discardOffChannelTokens
	discardSet
	lastMarker
	p
	tokens
	tokenSource

Detailed Description

Token streams TokenStream +- CommonTokenStream \- TokenRewriteStream.

@brief The most common stream of tokens

The most common stream of tokens is one where every token is buffered up
and tokens are prefiltered for a certain channel (the parser will only
see these tokens and cannot change the filter channel number during the
parse).

Definition at line 598 of file streams.py.

Constructor & Destructor Documentation

def rve_interface_gen.antlr3.streams.CommonTokenStream.__init__	(	self,
		tokenSource = `None`,
		channel = `DEFAULT_CHANNEL`
	)

@param tokenSource A TokenSource instance (usually a Lexer) to pull
    the tokens from.

@param channel Skip tokens on any channel but this one; this is how we
    skip whitespace...

Reimplemented in rve_interface_gen.antlr3.streams.TokenRewriteStream.

Definition at line 608 of file streams.py.

Member Function Documentation

def rve_interface_gen.antlr3.streams.CommonTokenStream.consume ( self )

Move the input pointer to the next incoming token.  The stream
must become active with LT(1) available.  consume() simply
moves the input pointer so that LT(1) points at the next
input symbol. Consume at least one token.

Walk past any token not on the channel the parser is listening to.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 705 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.discardTokenType	(	self,
		ttype
	)

Definition at line 756 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.fillBuffer ( self )

Load all tokens from the token source and put in tokens.
This is done upon first LT request because you might want to
set some token type / channel overrides before filling buffer.

Definition at line 660 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.get	(	self,
		i
	)

Return absolute token i; ignore which channel the tokens are on;
that is, count all tokens not just on-channel tokens.

Reimplemented from rve_interface_gen.antlr3.streams.TokenStream.

Definition at line 849 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.getSourceName ( self )

Where are you getting symbols from?  Normally, implementations will
pass the buck all the way to the lexer who can ask its input stream
for the file name or whatever.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 895 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.getTokens	(	self,
		start = `None`,
		stop = `None`,
		types = `None`
	)

Given a start and stop index, return a list of all tokens in
the token type set.  Return None if no tokens were found.  This
method looks at both on and off channel tokens.

Definition at line 760 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.getTokenSource ( self )

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

Reimplemented from rve_interface_gen.antlr3.streams.TokenStream.

Definition at line 891 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.index ( self )

Return the current input symbol index 0..n where n indicates the
last symbol has been read.  The index is the symbol about to be
read not the most recently read symbol.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 876 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.LA	(	self,
		i
	)

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

Negative indexes are allowed.  LA(-1) is previous token (token
just matched).  LA(-i) where i is before first token should
yield -1, invalid char / EOF.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 858 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.LB	(	self,
		k
	)

Look backwards k tokens on-channel tokens

Definition at line 823 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.LT	(	self,
		k
	)

Get the ith token from the current position 1..n where k=1 is the
first symbol of lookahead.

Reimplemented from rve_interface_gen.antlr3.streams.TokenStream.

Definition at line 794 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.mark ( self )

Tell the stream to start buffering if it hasn't already.  Return
current input position, index(), or some other marker so that
when passed to rewind() you get back to the same spot.
rewind(mark()) should not affect the input cursor.  The Lexer
track line/col info as well as input index so its markers are
not pure input indexes.  Same for tree node streams.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 862 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.release	(	self,
		marker = `None`
	)

You may want to commit to a backtrack but don't want to force the
stream to keep bookkeeping objects around for a marker that is
no longer necessary.  This will have the same behavior as
rewind() except it releases resources without the backward seek.
This must throw away resources for all markers back to the marker
argument.  So if you're nested 5 levels of mark(), and then release(2)
you have to release resources for depths 2..5.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 867 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.reset ( self )

Definition at line 655 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.rewind	(	self,
		marker = `None`
	)

Reset the stream so that next call to index would return marker.
The marker will usually be index() but it doesn't have to be.  It's
just a marker to indicate what state the stream was in.  This is
essentially calling release() and seek().  If there are markers
created after this marker argument, this routine must unroll them
like a stack.  Assume the state the stream was in when this marker
was created.

If marker is None:
Rewind to the input position of the last marker.
Used currently only after a cyclic DFA and just
before starting a sem/syn predicate to get the
input position back to the start of the decision.
Do not "pop" the marker off the state.  mark(i)
and rewind(i) should balance still. It is
like invoking rewind(last marker) but it should not "pop"
the marker off.  It's like seek(last marker's input position).

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 880 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.seek	(	self,
		index
	)

Set the input cursor to the position indicated by index.  This is
normally used to seek ahead in the input stream.  No buffering is
required to do this unless you know your stream will use seek to
move backwards such as when backtracking.

This is different from rewind in its multi-directional
requirement and in that its argument is strictly an input cursor
(index).

For char streams, seeking forward must update the stream state such
as line number.  For seeking backwards, you will be presumably
backtracking using the mark/rewind mechanism that restores state and
so this method does not need to update state when seeking backwards.

Currently, this method is only used for efficient backtracking using
memoization, but in the future it may be used for incremental parsing.

The index is 0..n-1.  A seek to position i means that LA(1) will
return the ith symbol.  So, seeking to 0 means LA(1) will return the
first element in the stream.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 887 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.setTokenSource	(	self,
		tokenSource
	)

Reset this token stream by setting its token source.

Definition at line 646 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.setTokenTypeChannel	(	self,
		ttype,
		channel
	)

A simple filter mechanism whereby you can tell this token stream
to force all tokens of type ttype to be on channel.  For example,
when interpreting, we cannot exec actions so we need to tell
the stream to force all WS and NEWLINE to be a different, ignored
channel.

Definition at line 744 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.size ( self )

Only makes sense for streams that buffer everything up probably, but
might be useful to display the entire stream or for testing.  This
value includes a single EOF.

Reimplemented from rve_interface_gen.antlr3.streams.IntStream.

Definition at line 872 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.skipOffTokenChannels	(	self,
		i
	)

Given a starting index, return the index of the first on-channel
token.

Definition at line 721 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.skipOffTokenChannelsReverse	(	self,
		i
	)

Definition at line 737 of file streams.py.

def rve_interface_gen.antlr3.streams.CommonTokenStream.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 from rve_interface_gen.antlr3.streams.TokenStream.

Definition at line 899 of file streams.py.