Class VelocityCharStream
- All Implemented Interfaces:
CharStream
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).
NOTE : This class was originally an ASCII_CharStream autogenerated by Javacc. It was then modified via changing class name with appropriate fixes for CTORS, and mods to readChar().
This is safe because we *always* use Reader with this class, and never a InputStream. This guarantees that we have a correct stream of 16-bit chars - all encoding transformations have been done elsewhere, so we believe that there is no risk in doing this. Time will tell :)
-
Field Summary
-
Constructor Summary
ConstructorDescriptionVelocityCharStream
(InputStream dstream, int startline, int startcolumn) VelocityCharStream
(InputStream dstream, int startline, int startcolumn, int buffersize) VelocityCharStream
(Reader dstream, int startline, int startcolumn) VelocityCharStream
(Reader dstream, int startline, int startcolumn, int buffersize) -
Method Summary
Modifier and TypeMethodDescriptionvoid
adjustBeginLineColumn
(int newLine, int newCol) Method to adjust line and column numbers for the start of a token.final void
backup
(int amount) Backs up the input stream by amount steps.final char
Returns the next character that marks the beginning of the next token.void
Done()
The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class.final int
Returns the column number of the first character for current token (being matched after the last call to BeginTOken).final int
Returns the line number of the first character for current token (being matched after the last call to BeginTOken).final int
Returns the column number of the last character for current token (being matched after the last call to BeginTOken).final int
Returns the line number of the last character for current token (being matched after the last call to BeginTOken).final String
GetImage()
Returns a string made up of characters from the marked token beginning to the current buffer position.final char[]
GetSuffix
(int len) Returns an array of characters that make up the suffix of length 'len' for the currently matched token.final char
readChar()
Returns the next character from the selected input.void
ReInit
(InputStream dstream, int startline, int startcolumn) void
ReInit
(InputStream dstream, int startline, int startcolumn, int buffersize) void
void
-
Field Details
-
staticFlag
public static final boolean staticFlag- See Also:
-
bufpos
public int bufpos
-
-
Constructor Details
-
VelocityCharStream
- Parameters:
dstream
-startline
-startcolumn
-buffersize
-
-
VelocityCharStream
- Parameters:
dstream
-startline
-startcolumn
-
-
VelocityCharStream
- Parameters:
dstream
-startline
-startcolumn
-buffersize
-
-
VelocityCharStream
- Parameters:
dstream
-startline
-startcolumn
-
-
-
Method Details
-
BeginToken
Description copied from interface:CharStream
Returns the next character that marks the beginning of the next token. All characters must remain in the buffer between two successive calls to this method to implement backup correctly.- Specified by:
BeginToken
in interfaceCharStream
- Returns:
- next token start char
- Throws:
IOException
- See Also:
-
readChar
Description copied from interface:CharStream
Returns the next character from the selected input. The method of selecting the input is the responsibility of the class implementing this interface. Can throw any java.io.IOException.- Specified by:
readChar
in interfaceCharStream
- Returns:
- read char
- Throws:
IOException
- See Also:
-
getEndColumn
public final int getEndColumn()Description copied from interface:CharStream
Returns the column number of the last character for current token (being matched after the last call to BeginTOken).- Specified by:
getEndColumn
in interfaceCharStream
- Returns:
- ending column number
- See Also:
-
getEndLine
public final int getEndLine()Description copied from interface:CharStream
Returns the line number of the last character for current token (being matched after the last call to BeginTOken).- Specified by:
getEndLine
in interfaceCharStream
- Returns:
- ending line number
- See Also:
-
getBeginColumn
public final int getBeginColumn()Description copied from interface:CharStream
Returns the column number of the first character for current token (being matched after the last call to BeginTOken).- Specified by:
getBeginColumn
in interfaceCharStream
- Returns:
- starting column number
- See Also:
-
getBeginLine
public final int getBeginLine()Description copied from interface:CharStream
Returns the line number of the first character for current token (being matched after the last call to BeginTOken).- Specified by:
getBeginLine
in interfaceCharStream
- Returns:
- starting line number
- See Also:
-
backup
public final void backup(int amount) Description copied from interface:CharStream
Backs up the input stream by amount steps. Lexer calls this method if it had already read some characters, but could not use them to match a (longer) token. So, they will be used again as the prefix of the next token and it is the implemetation's responsibility to do this right.- Specified by:
backup
in interfaceCharStream
- Parameters:
amount
-- See Also:
-
ReInit
- Parameters:
dstream
-startline
-startcolumn
-buffersize
-
-
ReInit
- Parameters:
dstream
-startline
-startcolumn
-
-
ReInit
- Parameters:
dstream
-startline
-startcolumn
-buffersize
-
-
ReInit
- Parameters:
dstream
-startline
-startcolumn
-
-
GetImage
Description copied from interface:CharStream
Returns a string made up of characters from the marked token beginning to the current buffer position. Implementations have the choice of returning anything that they want to. For example, for efficiency, one might decide to just return null, which is a valid implementation.- Specified by:
GetImage
in interfaceCharStream
- Returns:
- token image
- See Also:
-
GetSuffix
public final char[] GetSuffix(int len) Description copied from interface:CharStream
Returns an array of characters that make up the suffix of length 'len' for the currently matched token. This is used to build up the matched string for use in actions in the case of MORE. A simple and inefficient implementation of this is as follows :
{ String t = GetImage(); return t.substring(t.length() - len, t.length()).toCharArray(); }
- Specified by:
GetSuffix
in interfaceCharStream
- Parameters:
len
- suffix len- Returns:
- suffix
- See Also:
-
Done
public void Done()Description copied from interface:CharStream
The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class. Again, the body of this function can be just empty and it will not affect the lexer's operation.- Specified by:
Done
in interfaceCharStream
- See Also:
-
adjustBeginLineColumn
public void adjustBeginLineColumn(int newLine, int newCol) Method to adjust line and column numbers for the start of a token.- Parameters:
newLine
-newCol
-
-