Inheritance diagram for antlr.TokenStreamSelector:

Public Member Functions
	TokenStreamSelector ()
void	addInputStream (TokenStream stream, String key)
TokenStream	getCurrentStream ()
TokenStream	getStream (String sname)
Token	nextToken () throws TokenStreamException
TokenStream	pop ()
void	push (TokenStream stream)
void	push (String sname)
void	retry () throws TokenStreamRetryException
void	select (TokenStream stream)
void	select (String sname) throws IllegalArgumentException
String	getEntireText ()
TokenOffsetInfo	getOffsetInfo (Token token)
Protected Attributes
Hashtable	inputStreamNames
TokenStream	input
Stack	streamStack = new LList()

Detailed Description

A token stream MUX (multiplexor) knows about n token streams and can multiplex them onto the same channel for use by token stream consumer like a parser. This is a way to have multiple lexers break up the same input stream for a single parser. Or, you can have multiple instances of the same lexer handle multiple input streams; this works great for includes.

Constructor & Destructor Documentation

antlr.TokenStreamSelector.TokenStreamSelector ( )

References antlr.TokenStreamSelector.inputStreamNames.

Member Function Documentation

void antlr.TokenStreamSelector.addInputStream	(	TokenStream	stream,
		String	key
	)

References antlr.TokenStreamSelector.inputStreamNames.

Referenced by Main.main().

TokenStream antlr.TokenStreamSelector.getCurrentStream ( )

Return the stream from tokens are being pulled at the moment.

References antlr.TokenStreamSelector.input.

String antlr.TokenStreamSelector.getEntireText ( )

Returns the entire text input to the lexer.

Returns:: The entire text or null, if error occured or System.in was used.

Implements antlr.ASdebug.IASDebugStream.

References antlr.TokenStreamSelector.input.

TokenOffsetInfo antlr.TokenStreamSelector.getOffsetInfo ( Token token )

Returns the offset information for the token

Parameters:

token

the token whose information need to be retrieved

Returns:: offset info, or null

Implements antlr.ASdebug.IASDebugStream.

References antlr.TokenStreamSelector.input.

TokenStream antlr.TokenStreamSelector.getStream ( String sname )

References antlr.TokenStreamSelector.inputStreamNames.

Referenced by antlr.TokenStreamSelector.select().

Token antlr.TokenStreamSelector.nextToken ( ) throws TokenStreamException

References antlr.TokenStreamSelector.input, and antlr.TokenStream.nextToken().

TokenStream antlr.TokenStreamSelector.pop ( )

References antlr.collections.Stack.pop(), antlr.TokenStreamSelector.select(), and antlr.TokenStreamSelector.streamStack.

void antlr.TokenStreamSelector.push ( TokenStream stream )

References antlr.TokenStreamSelector.input, antlr.collections.Stack.push(), antlr.TokenStreamSelector.select(), and antlr.TokenStreamSelector.streamStack.

void antlr.TokenStreamSelector.push ( String sname )

References antlr.TokenStreamSelector.input, antlr.collections.Stack.push(), antlr.TokenStreamSelector.select(), and antlr.TokenStreamSelector.streamStack.

void antlr.TokenStreamSelector.retry ( ) throws TokenStreamRetryException

Abort recognition of current Token and try again. A stream can push a new stream (for include files for example, and then retry(), which will cause the current stream to abort back to this.nextToken(). this.nextToken() then asks for a token from the current stream, which is the new "substream."

void antlr.TokenStreamSelector.select ( String sname ) throws IllegalArgumentException

References antlr.TokenStreamSelector.getStream(), and antlr.TokenStreamSelector.input.

void antlr.TokenStreamSelector.select ( TokenStream stream )

Set the stream without pushing old stream

References antlr.TokenStreamSelector.input.

Referenced by Main.main(), antlr.TokenStreamSelector.pop(), and antlr.TokenStreamSelector.push().