Inheritance diagram for antlr.TokenStreamHiddenTokenFilter:

Public Member Functions
	TokenStreamHiddenTokenFilter (TokenStream input)
BitSet	getDiscardMask ()
CommonHiddenStreamToken	getHiddenAfter (CommonHiddenStreamToken t)
CommonHiddenStreamToken	getHiddenBefore (CommonHiddenStreamToken t)
BitSet	getHideMask ()
CommonHiddenStreamToken	getInitialHiddenToken ()
void	hide (int m)
void	hide (BitSet mask)
Token	nextToken () throws TokenStreamException
Protected Member Functions
void	consume () throws TokenStreamException
CommonHiddenStreamToken	LA (int i)
Protected Attributes
BitSet	hideMask
CommonHiddenStreamToken	nextMonitoredToken
CommonHiddenStreamToken	lastHiddenToken
CommonHiddenStreamToken	firstHidden = null

Detailed Description

This object filters a token stream coming from a lexer or another TokenStream so that only certain token channels get transmitted to the parser.

Any of the channels can be filtered off as "hidden" channels whose tokens can be accessed from the parser.

Constructor & Destructor Documentation

antlr.TokenStreamHiddenTokenFilter.TokenStreamHiddenTokenFilter ( TokenStream input )

References antlr.TokenStreamHiddenTokenFilter.hideMask.

Member Function Documentation

void antlr.TokenStreamHiddenTokenFilter.consume ( ) throws TokenStreamException [protected]

References antlr.TokenStreamBasicFilter.input, antlr.TokenStreamHiddenTokenFilter.nextMonitoredToken, and antlr.TokenStream.nextToken().

Referenced by antlr.TokenStreamHiddenTokenFilter.nextToken().

BitSet antlr.TokenStreamHiddenTokenFilter.getDiscardMask ( )

References antlr.TokenStreamBasicFilter.discardMask.

CommonHiddenStreamToken antlr.TokenStreamHiddenTokenFilter.getHiddenAfter ( CommonHiddenStreamToken t )

Return a ptr to the hidden token appearing immediately after token t in the input stream.

References antlr.CommonHiddenStreamToken.getHiddenAfter().

CommonHiddenStreamToken antlr.TokenStreamHiddenTokenFilter.getHiddenBefore ( CommonHiddenStreamToken t )

Return a ptr to the hidden token appearing immediately before token t in the input stream.

References antlr.CommonHiddenStreamToken.getHiddenBefore().

BitSet antlr.TokenStreamHiddenTokenFilter.getHideMask ( )

References antlr.TokenStreamHiddenTokenFilter.hideMask.

CommonHiddenStreamToken antlr.TokenStreamHiddenTokenFilter.getInitialHiddenToken ( )

Return the first hidden token if one appears before any monitored token.

References antlr.TokenStreamHiddenTokenFilter.firstHidden.

void antlr.TokenStreamHiddenTokenFilter.hide ( int m )

References antlr.collections.impl.BitSet.add(), and antlr.TokenStreamHiddenTokenFilter.hideMask.

Referenced by InstrMain.main().

void antlr.TokenStreamHiddenTokenFilter.hide ( BitSet mask )

References antlr.TokenStreamHiddenTokenFilter.hideMask.

CommonHiddenStreamToken antlr.TokenStreamHiddenTokenFilter.LA ( int i ) [protected]

References antlr.TokenStreamHiddenTokenFilter.nextMonitoredToken.

Referenced by antlr.TokenStreamHiddenTokenFilter.nextToken().

Token antlr.TokenStreamHiddenTokenFilter.nextToken ( ) throws TokenStreamException

Return the next monitored token. Test the token following the monitored token. If following is another monitored token, save it for the next invocation of nextToken (like a single lookahead token) and return it then. If following is unmonitored, nondiscarded (hidden) channel token, add it to the monitored token.

Note: EOF must be a monitored Token.

Implements antlr.TokenStream.

References antlr.TokenStreamHiddenTokenFilter.consume(), antlr.TokenStreamBasicFilter.discardMask, antlr.TokenStreamHiddenTokenFilter.hideMask, antlr.TokenStreamHiddenTokenFilter.LA(), antlr.TokenStreamHiddenTokenFilter.lastHiddenToken, antlr.collections.impl.BitSet.member(), antlr.CommonHiddenStreamToken.setHiddenAfter(), and antlr.CommonHiddenStreamToken.setHiddenBefore().