Inheritance diagram for antlr.CharScanner:

Public Member Functions
	CharScanner ()
	CharScanner (InputBuffer cb)
	CharScanner (LexerSharedInputState sharedState)
void	append (char c)
void	append (String s)
void	commit ()
void	consume () throws CharStreamException
void	consumeUntil (int c) throws CharStreamException
void	consumeUntil (BitSet set) throws CharStreamException
boolean	getCaseSensitive ()
final boolean	getCaseSensitiveLiterals ()
int	getColumn ()
void	setColumn (int c)
boolean	getCommitToPath ()
String	getFilename ()
InputBuffer	getInputBuffer ()
LexerSharedInputState	getInputState ()
void	setInputState (LexerSharedInputState state)
int	getLine ()
String	getText ()
Token	getTokenObject ()
char	LA (int i) throws CharStreamException
int	mark ()
void	match (char c) throws MismatchedCharException, CharStreamException
void	match (BitSet b) throws MismatchedCharException, CharStreamException
void	match (String s) throws MismatchedCharException, CharStreamException
void	matchNot (char c) throws MismatchedCharException, CharStreamException
void	matchRange (char c1, char c2) throws MismatchedCharException, CharStreamException
void	newline ()
void	tab ()
void	setTabSize (int size)
int	getTabSize ()
void	panic ()
void	panic (String s)
void	reportError (RecognitionException ex)
void	reportError (String s)
void	reportWarning (String s)
void	resetText ()
void	rewind (int pos)
void	setCaseSensitive (boolean t)
void	setCommitToPath (boolean commit)
void	setFilename (String f)
void	setLine (int line)
void	setText (String s)
void	setTokenObjectClass (String cl)
int	testLiteralsTable (int ttype)
int	testLiteralsTable (String text, int ttype)
char	toLower (char c)
void	traceIndent ()
void	traceIn (String rname) throws CharStreamException
void	traceOut (String rname) throws CharStreamException
void	uponEOF () throws TokenStreamException, CharStreamException
Static Public Attributes
static final char	EOF_CHAR = (char)-1
Protected Member Functions
Token	makeToken (int t)
Protected Attributes
ANTLRStringBuffer	text
boolean	saveConsumedInput = true
Class	tokenObjectClass
boolean	caseSensitive = true
boolean	caseSensitiveLiterals = true
Hashtable	literals
int	tabsize = 8
Token	_returnToken = null
ANTLRHashString	hashString
LexerSharedInputState	inputState
boolean	commitToPath = false
int	traceDepth = 0
Static Package Attributes
static final char	NO_CHAR = 0

Constructor & Destructor Documentation

antlr.CharScanner.CharScanner ( )

References antlr.CharScanner.hashString, antlr.CharScanner.setTokenObjectClass(), and antlr.CharScanner.text.

antlr.CharScanner.CharScanner ( InputBuffer cb )

References antlr.CharScanner.inputState.

antlr.CharScanner.CharScanner ( LexerSharedInputState sharedState )

References antlr.CharScanner.inputState.

Member Function Documentation

void antlr.CharScanner.append ( char c )

References antlr.ANTLRStringBuffer.append(), antlr.CharScanner.saveConsumedInput, and antlr.CharScanner.text.

Referenced by antlr.CharScanner.consume().

void antlr.CharScanner.append ( String s )

References antlr.ANTLRStringBuffer.append(), antlr.CharScanner.saveConsumedInput, and antlr.CharScanner.text.

void antlr.CharScanner.commit ( )

References antlr.InputBuffer.commit(), antlr.LexerSharedInputState.input, and antlr.CharScanner.inputState.

void antlr.CharScanner.consume ( ) throws CharStreamException

References antlr.CharScanner.append(), antlr.CharScanner.caseSensitive, antlr.LexerSharedInputState.column, antlr.InputBuffer.consume(), antlr.LexerSharedInputState.guessing, antlr.LexerSharedInputState.input, antlr.CharScanner.inputState, antlr.InputBuffer.LA(), antlr.CharScanner.LA(), and antlr.CharScanner.tab().

Referenced by antlr.CharScanner.consumeUntil(), antlr.CharScanner.match(), antlr.CharScanner.matchNot(), and antlr.CharScanner.matchRange().

void antlr.CharScanner.consumeUntil ( int c ) throws CharStreamException

Consume chars until one matches the given char

References antlr.CharScanner.consume(), antlr.CharScanner.EOF_CHAR, and antlr.CharScanner.LA().

void antlr.CharScanner.consumeUntil ( BitSet set ) throws CharStreamException

Consume chars until one matches the given set

References antlr.CharScanner.consume(), antlr.CharScanner.EOF_CHAR, and antlr.CharScanner.LA().

boolean antlr.CharScanner.getCaseSensitive ( )

References antlr.CharScanner.caseSensitive.

final boolean antlr.CharScanner.getCaseSensitiveLiterals ( )

References antlr.CharScanner.caseSensitiveLiterals.

Referenced by antlr.ANTLRHashString.equals(), and antlr.ANTLRHashString.hashCode().

int antlr.CharScanner.getColumn ( )

References antlr.LexerSharedInputState.column, and antlr.CharScanner.inputState.

boolean antlr.CharScanner.getCommitToPath ( )

References antlr.CharScanner.commitToPath.

String antlr.CharScanner.getFilename ( )

References antlr.LexerSharedInputState.filename, and antlr.CharScanner.inputState.

InputBuffer antlr.CharScanner.getInputBuffer ( )

References antlr.LexerSharedInputState.input, and antlr.CharScanner.inputState.

LexerSharedInputState antlr.CharScanner.getInputState ( )

References antlr.CharScanner.inputState.

int antlr.CharScanner.getLine ( )

References antlr.CharScanner.inputState, and antlr.LexerSharedInputState.line.

int antlr.CharScanner.getTabSize ( )

References antlr.CharScanner.tabsize.

String antlr.CharScanner.getText ( )

return a copy of the current text buffer

References antlr.CharScanner.text, and antlr.ANTLRStringBuffer.toString().

Referenced by antlr.ANTLRLexer.mACTION(), antlr.ANTLRLexer.mARG_ACTION(), antlr.actions.csharp.ActionLexer.mAST_ITEM(), antlr.actions.cpp.ActionLexer.mAST_ITEM(), antlr.actions.python.ActionLexer.mID_ELEMENT(), antlr.actions.java.ActionLexer.mID_ELEMENT(), antlr.actions.csharp.ActionLexer.mID_ELEMENT(), antlr.actions.cpp.ActionLexer.mID_ELEMENT(), antlr.preprocessor.PreprocessorLexer.mID_OR_KEYWORD(), antlr.actions.python.ActionLexer.mTREE_ELEMENT(), antlr.actions.java.ActionLexer.mTREE_ELEMENT(), antlr.actions.csharp.ActionLexer.mTREE_ELEMENT(), and antlr.actions.cpp.ActionLexer.mTREE_ELEMENT().

Token antlr.CharScanner.getTokenObject ( )

References antlr.CharScanner._returnToken.

char antlr.CharScanner.LA ( int i ) throws CharStreamException

References antlr.CharScanner.caseSensitive, antlr.LexerSharedInputState.input, antlr.CharScanner.inputState, antlr.InputBuffer.LA(), and antlr.CharScanner.toLower().

Token antlr.CharScanner.makeToken ( int t ) [protected]

References antlr.CharScanner.inputState, antlr.CharScanner.panic(), antlr.Token.setColumn(), antlr.Token.setLine(), antlr.Token.setType(), antlr.CharScanner.tokenObjectClass, antlr.LexerSharedInputState.tokenStartColumn, and antlr.LexerSharedInputState.tokenStartLine.

int antlr.CharScanner.mark ( )

References antlr.LexerSharedInputState.input, antlr.CharScanner.inputState, and antlr.InputBuffer.mark().

void antlr.CharScanner.match ( char c ) throws MismatchedCharException, CharStreamException

References antlr.CharScanner.consume(), and antlr.CharScanner.LA().

void antlr.CharScanner.match ( BitSet b ) throws MismatchedCharException, CharStreamException

References antlr.CharScanner.consume(), and antlr.CharScanner.LA().

void antlr.CharScanner.match ( String s ) throws MismatchedCharException, CharStreamException

References antlr.CharScanner.consume(), and antlr.CharScanner.LA().

void antlr.CharScanner.matchNot ( char c ) throws MismatchedCharException, CharStreamException

References antlr.CharScanner.consume(), and antlr.CharScanner.LA().

Referenced by antlr.preprocessor.PreprocessorLexer.mACTION(), antlr.preprocessor.PreprocessorLexer.mARG_ACTION(), antlr.preprocessor.PreprocessorLexer.mASSIGN_RHS(), antlr.actions.python.ActionLexer.mCHAR(), antlr.actions.java.ActionLexer.mCHAR(), antlr.actions.csharp.ActionLexer.mCHAR(), antlr.actions.cpp.ActionLexer.mCHAR(), antlr.preprocessor.PreprocessorLexer.mCHAR_LITERAL(), antlr.ANTLRLexer.mCHAR_LITERAL(), antlr.preprocessor.PreprocessorLexer.mCURLY_BLOCK_SCARF(), antlr.actions.cpp.ActionLexer.mID_ELEMENT(), antlr.preprocessor.PreprocessorLexer.mML_COMMENT(), antlr.actions.python.CodeLexer.mML_COMMENT(), antlr.ANTLRTokdefLexer.mML_COMMENT(), antlr.actions.python.ActionLexer.mML_COMMENT(), antlr.actions.java.ActionLexer.mML_COMMENT(), antlr.actions.csharp.ActionLexer.mML_COMMENT(), antlr.actions.cpp.ActionLexer.mML_COMMENT(), antlr.ANTLRLexer.mNESTED_ACTION(), antlr.ANTLRLexer.mNESTED_ARG_ACTION(), antlr.preprocessor.PreprocessorLexer.mSL_COMMENT(), antlr.actions.python.CodeLexer.mSL_COMMENT(), antlr.actions.python.ActionLexer.mSL_COMMENT(), antlr.actions.java.ActionLexer.mSL_COMMENT(), antlr.actions.csharp.ActionLexer.mSL_COMMENT(), antlr.actions.cpp.ActionLexer.mSL_COMMENT(), antlr.ANTLRTokdefLexer.mSTRING(), antlr.actions.python.ActionLexer.mSTRING(), antlr.actions.java.ActionLexer.mSTRING(), antlr.actions.csharp.ActionLexer.mSTRING(), antlr.actions.cpp.ActionLexer.mSTRING(), antlr.preprocessor.PreprocessorLexer.mSTRING_LITERAL(), and antlr.ANTLRLexer.mSTRING_LITERAL().

void antlr.CharScanner.matchRange	(	char	c1,
		char	c2
	)			throws MismatchedCharException, CharStreamException

References antlr.CharScanner.consume(), and antlr.CharScanner.LA().

Referenced by antlr.preprocessor.PreprocessorLexer.mDIGIT(), antlr.ANTLRTokdefLexer.mDIGIT(), antlr.ANTLRLexer.mDIGIT(), antlr.actions.python.ActionLexer.mDIGIT(), antlr.actions.java.ActionLexer.mDIGIT(), antlr.actions.csharp.ActionLexer.mDIGIT(), antlr.actions.cpp.ActionLexer.mDIGIT(), antlr.preprocessor.PreprocessorLexer.mESC(), antlr.ANTLRTokdefLexer.mESC(), antlr.ANTLRLexer.mESC(), antlr.actions.python.ActionLexer.mESC(), antlr.actions.java.ActionLexer.mESC(), antlr.actions.csharp.ActionLexer.mESC(), antlr.actions.cpp.ActionLexer.mESC(), PascalLexer.mEXPONENT(), antlr.preprocessor.PreprocessorLexer.mID(), antlr.ANTLRTokdefLexer.mID(), antlr.actions.python.ActionLexer.mID(), antlr.actions.java.ActionLexer.mID(), antlr.actions.csharp.ActionLexer.mID(), antlr.actions.cpp.ActionLexer.mID(), PascalLexer.mIDENT(), antlr.ANTLRLexer.mINT(), antlr.ANTLRLexer.mINTERNAL_RULE_REF(), PascalLexer.mNUM_INT(), antlr.ANTLRLexer.mTOKEN_REF(), antlr.preprocessor.PreprocessorLexer.mXDIGIT(), antlr.ANTLRTokdefLexer.mXDIGIT(), and antlr.ANTLRLexer.mXDIGIT().

void antlr.CharScanner.newline ( )

References antlr.LexerSharedInputState.column, antlr.CharScanner.inputState, and antlr.LexerSharedInputState.line.

Referenced by PascalLexer.mCOMMENT_1(), PascalLexer.mCOMMENT_2(), antlr.actions.python.CodeLexer.mML_COMMENT(), antlr.ANTLRTokdefLexer.mML_COMMENT(), antlr.ANTLRLexer.mML_COMMENT(), antlr.actions.python.ActionLexer.mML_COMMENT(), antlr.actions.java.ActionLexer.mML_COMMENT(), antlr.actions.csharp.ActionLexer.mML_COMMENT(), antlr.actions.cpp.ActionLexer.mML_COMMENT(), antlr.ANTLRLexer.mNESTED_ACTION(), antlr.ANTLRLexer.mNESTED_ARG_ACTION(), antlr.preprocessor.PreprocessorLexer.mNEWLINE(), antlr.actions.python.CodeLexer.mSL_COMMENT(), antlr.ANTLRTokdefLexer.mSL_COMMENT(), antlr.ANTLRLexer.mSL_COMMENT(), antlr.actions.python.ActionLexer.mSL_COMMENT(), antlr.actions.java.ActionLexer.mSL_COMMENT(), antlr.actions.csharp.ActionLexer.mSL_COMMENT(), antlr.actions.cpp.ActionLexer.mSL_COMMENT(), antlr.actions.python.CodeLexer.mSTUFF(), antlr.actions.python.ActionLexer.mSTUFF(), antlr.actions.java.ActionLexer.mSTUFF(), antlr.actions.csharp.ActionLexer.mSTUFF(), antlr.actions.cpp.ActionLexer.mSTUFF(), PascalLexer.mWS(), antlr.ANTLRTokdefLexer.mWS(), antlr.ANTLRLexer.mWS(), antlr.actions.python.ActionLexer.mWS(), antlr.actions.java.ActionLexer.mWS(), antlr.actions.csharp.ActionLexer.mWS(), and antlr.actions.cpp.ActionLexer.mWS().

void antlr.CharScanner.panic ( String s )

This method is executed by ANTLR internally when it detected an illegal state that cannot be recovered from. The default implementation of this method calls java.lang.System.exit(int) and writes directly to java.lang.System.err) , which is usually not appropriate when a translator is embedded into a larger application. It is highly recommended that this method be overridden to handle the error in a way appropriate for your application (e.g. throw an unchecked exception).

void antlr.CharScanner.panic ( )

See also:: panic(String)

Referenced by antlr.CharScanner.makeToken(), and antlr.CharScanner.setTokenObjectClass().

void antlr.CharScanner.reportError ( RecognitionException ex )

Parser error-reporting function can be overridden in subclass

void antlr.CharScanner.reportError ( String s )

Parser error-reporting function can be overridden in subclass

References antlr.CharScanner.getFilename().

void antlr.CharScanner.reportWarning ( String s )

Parser warning-reporting function can be overridden in subclass

References antlr.CharScanner.getFilename().

void antlr.CharScanner.resetText ( )

References antlr.LexerSharedInputState.column, antlr.CharScanner.inputState, antlr.LexerSharedInputState.line, antlr.ANTLRStringBuffer.setLength(), antlr.CharScanner.text, antlr.LexerSharedInputState.tokenStartColumn, and antlr.LexerSharedInputState.tokenStartLine.

Referenced by antlr.preprocessor.PreprocessorLexer.nextToken(), PascalLexer.nextToken(), antlr.actions.python.CodeLexer.nextToken(), antlr.ANTLRTokdefLexer.nextToken(), antlr.ANTLRLexer.nextToken(), antlr.actions.python.ActionLexer.nextToken(), antlr.actions.java.ActionLexer.nextToken(), antlr.actions.csharp.ActionLexer.nextToken(), antlr.actions.cpp.ActionLexer.nextToken(), and antlr.CharScanner.setText().

void antlr.CharScanner.rewind ( int pos )

References antlr.LexerSharedInputState.input, antlr.CharScanner.inputState, and antlr.InputBuffer.rewind().

void antlr.CharScanner.setCaseSensitive ( boolean t )

References antlr.CharScanner.caseSensitive.

Referenced by antlr.actions.python.ActionLexer.ActionLexer(), antlr.actions.java.ActionLexer.ActionLexer(), antlr.actions.csharp.ActionLexer.ActionLexer(), antlr.actions.cpp.ActionLexer.ActionLexer(), antlr.ANTLRLexer.ANTLRLexer(), antlr.ANTLRTokdefLexer.ANTLRTokdefLexer(), antlr.actions.python.CodeLexer.CodeLexer(), PascalLexer.PascalLexer(), and antlr.preprocessor.PreprocessorLexer.PreprocessorLexer().

void antlr.CharScanner.setColumn ( int c )

References antlr.LexerSharedInputState.column, and antlr.CharScanner.inputState.

Referenced by antlr.CharScanner.tab().

void antlr.CharScanner.setCommitToPath ( boolean commit )

References antlr.CharScanner.commitToPath.

void antlr.CharScanner.setFilename ( String f )

References antlr.LexerSharedInputState.filename, and antlr.CharScanner.inputState.

Referenced by antlr.actions.python.CodeLexer.CodeLexer(), and antlr.preprocessor.Hierarchy.readGrammarFile().

void antlr.CharScanner.setInputState ( LexerSharedInputState state )

References antlr.CharScanner.inputState.

void antlr.CharScanner.setLine ( int line )

References antlr.CharScanner.inputState, and antlr.LexerSharedInputState.line.

Referenced by antlr.actions.python.CodeLexer.CodeLexer(), antlr.actions.python.CodeLexer.setLineOffset(), antlr.actions.python.ActionLexer.setLineOffset(), antlr.actions.java.ActionLexer.setLineOffset(), antlr.actions.csharp.ActionLexer.setLineOffset(), and antlr.actions.cpp.ActionLexer.setLineOffset().

void antlr.CharScanner.setTabSize ( int size )

References antlr.CharScanner.tabsize.

void antlr.CharScanner.setText ( String s )

References antlr.ANTLRStringBuffer.append(), antlr.CharScanner.resetText(), and antlr.CharScanner.text.

Referenced by antlr.ANTLRLexer.mACTION(), and antlr.ANTLRLexer.mARG_ACTION().

void antlr.CharScanner.setTokenObjectClass ( String cl )

References antlr.CharScanner.panic(), and antlr.CharScanner.tokenObjectClass.

Referenced by antlr.CharScanner.CharScanner().

void antlr.CharScanner.tab ( )

advance the current column number by an appropriate amount according to tab size. This method is called from consume().

References antlr.CharScanner.getColumn(), antlr.CharScanner.setColumn(), and antlr.CharScanner.tabsize.

Referenced by antlr.CharScanner.consume().

int antlr.CharScanner.testLiteralsTable ( int ttype )

References antlr.ANTLRStringBuffer.getBuffer(), antlr.CharScanner.hashString, antlr.ANTLRStringBuffer.length, antlr.CharScanner.literals, antlr.ANTLRHashString.setBuffer(), and antlr.CharScanner.text.

Referenced by antlr.preprocessor.PreprocessorLexer.mID(), PascalLexer.mIDENT(), antlr.ANTLRLexer.mINTERNAL_RULE_REF(), antlr.ANTLRLexer.mTOKEN_REF(), and antlr.preprocessor.PreprocessorLexer.nextToken().

int antlr.CharScanner.testLiteralsTable	(	String	text,
		int	ttype
	)

Test the text passed in against the literals table Override this method to perform a different literals test This is used primarily when you want to test a portion of a token.

References antlr.CharScanner.literals.

char antlr.CharScanner.toLower ( char c )

Referenced by antlr.ANTLRHashString.equals(), antlr.ANTLRHashString.hashCode(), and antlr.CharScanner.LA().

void antlr.CharScanner.traceIn ( String rname ) throws CharStreamException

References antlr.CharScanner.LA(), antlr.CharScanner.traceDepth, and antlr.CharScanner.traceIndent().

void antlr.CharScanner.traceIndent ( )

References antlr.CharScanner.traceDepth.

Referenced by antlr.CharScanner.traceIn(), and antlr.CharScanner.traceOut().

void antlr.CharScanner.traceOut ( String rname ) throws CharStreamException

References antlr.CharScanner.LA(), antlr.CharScanner.traceDepth, and antlr.CharScanner.traceIndent().

void antlr.CharScanner.uponEOF ( ) throws TokenStreamException, CharStreamException

This method is called by YourLexer.nextToken() when the lexer has hit EOF condition. EOF is NOT a character. This method is not called if EOF is reached during syntactic predicate evaluation or during evaluation of normal lexical rules, which presumably would be an IOException. This traps the "normal" EOF condition.

uponEOF() is called after the complete evaluation of the previous token and only if your parser asks for another token beyond that last non-EOF token.

You might want to throw token or char stream exceptions like: "Heh, premature eof" or a retry stream exception ("I found the end of this file, go back to referencing file").

Referenced by antlr.preprocessor.PreprocessorLexer.nextToken(), PascalLexer.nextToken(), antlr.ANTLRTokdefLexer.nextToken(), antlr.ANTLRLexer.nextToken(), antlr.actions.python.ActionLexer.nextToken(), antlr.actions.java.ActionLexer.nextToken(), antlr.actions.csharp.ActionLexer.nextToken(), and antlr.actions.cpp.ActionLexer.nextToken().