Top Description Fields Methods

org.antlr.runtime

public Interface CharStream

Known Direct Implementers: org.antlr.runtime.ANTLRStringStream

A source of characters for an ANTLR lexer

Field Summary

Modifier and Type	Field and Description
public static final int	EOF

Method Summary

Modifier and Type	Method and Description
public int	getCharPositionInLine() The index of the character relative to the beginning of the line 0..n-1
public int	getLine() ANTLR tracks the line information automatically
public int	LT(int i) Get the ith character of lookahead.
public void	setCharPositionInLine(int pos)
public void	setLine(int line) Because this stream can rewind, we need to be able to reset the line
public String	substring(int start, int stop) For infinite streams, you don't need this; primarily I'm providing a useful interface for action code.

Inherited from org.antlr.runtime.IntStream:: consume getSourceName index LA mark release rewind rewind seek size

Field Detail

EOF	back to summary
public static final int EOF

Method Detail

getCharPositionInLine	back to summary
public int getCharPositionInLine() The index of the character relative to the beginning of the line 0..n-1

getLine	back to summary
public int getLine() ANTLR tracks the line information automatically

LT	back to summary
public int LT(int i) Get the ith character of lookahead. This is the same usually as LA(i). This will be used for labels in the generated lexer code. I'd prefer to return a char here type-wise, but it's probably better to be 32-bit clean and be consistent with LA.

setCharPositionInLine	back to summary
public void setCharPositionInLine(int pos)

setLine	back to summary
public void setLine(int line) Because this stream can rewind, we need to be able to reset the line

substring	back to summary
public String substring(int start, int stop) For infinite streams, you don't need this; primarily I'm providing a useful interface for action code. Just make sure actions don't use this on streams that don't support it.