Public Member Functions | |
| final char | BeginToken () throws java.io.IOException |
| final char | readChar () throws java.io.IOException |
| final int | getColumn () |
| final int | getLine () |
| final int | getEndColumn () |
| final int | getEndLine () |
| final int | getBeginColumn () |
| final int | getBeginLine () |
| final void | backup (int amount) |
| InputCharStream (java.io.Reader dstream, int startline, int startcolumn, int buffersize) | |
| InputCharStream (java.io.Reader dstream, int startline, int startcolumn) | |
| InputCharStream (java.io.Reader dstream) | |
| void | ReInit (java.io.Reader dstream, int startline, int startcolumn, int buffersize) |
| void | ReInit (java.io.Reader dstream, int startline, int startcolumn) |
| void | ReInit (java.io.Reader dstream) |
| final String | GetImage () |
| final char[] | GetSuffix (int len) |
| void | Done () |
| void | adjustBeginLineColumn (int newLine, int newCol) |
Public Attributes | |
| int | bufpos = -1 |
Static Public Attributes | |
| static final boolean | staticFlag = false |
Package Attributes | |
| int | bufsize |
| int | available |
| int | tokenBegin |
An implementation of interface CharStream. Implements input character stream that maintains line and column number positions of the characters. It also has the capability to backup the stream to some extent.
The object of this class is constructed using java.io.Reader reader and it is left to constructor of the reader to set up character encoding correctly. This means that method <u><font color="blue">read</font></u> of the reader is used to get next characters, assuming it returns appropriate values. It is recommended to use class java.io.InputStreamReader as a reader, which allows to set desired character encoding. This class is an intermediate component between input character reader and the parser.
The code of this class is based on the class ASCII_CharStream - implementation of interface CharStream, that JavaCC would have generated with the following options set in a JavaCC grammar file:
JAVA_UNICODE_ESCAPE = false;
UNICODE_INPUT = false;
USER_CHAR_STREAM = false; Note that this class is not fully JavaCC generated.
| org.exolab.castor.xml.dtd.parser.InputCharStream.InputCharStream | ( | java.io.Reader | dstream, | |
| int | startline, | |||
| int | startcolumn, | |||
| int | buffersize | |||
| ) |
Constructor, allowing to specify start line and start column of the char stream, and buffer size as well.
References org.exolab.castor.xml.dtd.parser.InputCharStream.available, and org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize.
| org.exolab.castor.xml.dtd.parser.InputCharStream.InputCharStream | ( | java.io.Reader | dstream, | |
| int | startline, | |||
| int | startcolumn | |||
| ) |
Constructor, allowing to specify start line and start column of the char stream.
| org.exolab.castor.xml.dtd.parser.InputCharStream.InputCharStream | ( | java.io.Reader | dstream | ) |
Constructor, instantiating the char stream to begin at 1-st line and 1-st column of dstream.
| void org.exolab.castor.xml.dtd.parser.InputCharStream.adjustBeginLineColumn | ( | int | newLine, | |
| int | newCol | |||
| ) |
Method to adjust line and column numbers for the start of a token.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos, org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize, and org.exolab.castor.xml.dtd.parser.InputCharStream.tokenBegin.
| final void org.exolab.castor.xml.dtd.parser.InputCharStream.backup | ( | int | amount | ) | [virtual] |
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.
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos, and org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize.
| final char org.exolab.castor.xml.dtd.parser.InputCharStream.BeginToken | ( | ) | throws java.io.IOException [virtual] |
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.
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos, org.exolab.castor.xml.dtd.parser.InputCharStream.readChar(), and org.exolab.castor.xml.dtd.parser.InputCharStream.tokenBegin.
| void org.exolab.castor.xml.dtd.parser.InputCharStream.Done | ( | ) | [virtual] |
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.
Implements org.exolab.castor.xml.dtd.parser.CharStream.
| final int org.exolab.castor.xml.dtd.parser.InputCharStream.getBeginColumn | ( | ) | [virtual] |
Returns the column number of the first character for current token (being matched after the last call to BeginTOken).
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.tokenBegin.
| final int org.exolab.castor.xml.dtd.parser.InputCharStream.getBeginLine | ( | ) | [virtual] |
Returns the line number of the first character for current token (being matched after the last call to BeginTOken).
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.tokenBegin.
| final int org.exolab.castor.xml.dtd.parser.InputCharStream.getColumn | ( | ) | [virtual] |
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos.
| final int org.exolab.castor.xml.dtd.parser.InputCharStream.getEndColumn | ( | ) | [virtual] |
Returns the column number of the last character for current token (being matched after the last call to BeginTOken).
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos.
| final int org.exolab.castor.xml.dtd.parser.InputCharStream.getEndLine | ( | ) | [virtual] |
Returns the line number of the last character for current token (being matched after the last call to BeginTOken).
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos.
| final String org.exolab.castor.xml.dtd.parser.InputCharStream.GetImage | ( | ) | [virtual] |
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.
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos, org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize, and org.exolab.castor.xml.dtd.parser.InputCharStream.tokenBegin.
| final int org.exolab.castor.xml.dtd.parser.InputCharStream.getLine | ( | ) | [virtual] |
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos.
| final char [] org.exolab.castor.xml.dtd.parser.InputCharStream.GetSuffix | ( | int | len | ) | [virtual] |
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();
}
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos, and org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize.
| final char org.exolab.castor.xml.dtd.parser.InputCharStream.readChar | ( | ) | throws java.io.IOException [virtual] |
Returns the next character from the input stream. The only method whose implementation is different from its original in the ASCII_CharStream class.
Implements org.exolab.castor.xml.dtd.parser.CharStream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos, and org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize.
Referenced by org.exolab.castor.xml.dtd.parser.InputCharStream.BeginToken().
| void org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit | ( | java.io.Reader | dstream, | |
| int | startline, | |||
| int | startcolumn | |||
| ) |
Reinitialization of the char stream, allowing to specify start line and start column of the char stream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit().
| void org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit | ( | java.io.Reader | dstream | ) |
Reinitialization of the char stream, instantiating the char stream to begin at 1-st line and 1-st column of dstream.
References org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit().
| void org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit | ( | java.io.Reader | dstream, | |
| int | startline, | |||
| int | startcolumn, | |||
| int | buffersize | |||
| ) |
Reinitialization of the char stream, allowing to specify start line and start column of the char stream, and buffer size as well.
References org.exolab.castor.xml.dtd.parser.InputCharStream.available, org.exolab.castor.xml.dtd.parser.InputCharStream.bufpos, org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize, and org.exolab.castor.xml.dtd.parser.InputCharStream.tokenBegin.
Referenced by org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit().
Referenced by org.exolab.castor.xml.dtd.parser.InputCharStream.adjustBeginLineColumn(), org.exolab.castor.xml.dtd.parser.InputCharStream.backup(), org.exolab.castor.xml.dtd.parser.InputCharStream.BeginToken(), org.exolab.castor.xml.dtd.parser.InputCharStream.getColumn(), org.exolab.castor.xml.dtd.parser.InputCharStream.getEndColumn(), org.exolab.castor.xml.dtd.parser.InputCharStream.getEndLine(), org.exolab.castor.xml.dtd.parser.InputCharStream.GetImage(), org.exolab.castor.xml.dtd.parser.InputCharStream.getLine(), org.exolab.castor.xml.dtd.parser.InputCharStream.GetSuffix(), org.exolab.castor.xml.dtd.parser.InputCharStream.readChar(), and org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit().
int org.exolab.castor.xml.dtd.parser.InputCharStream.bufsize [package] |
Referenced by org.exolab.castor.xml.dtd.parser.InputCharStream.adjustBeginLineColumn(), org.exolab.castor.xml.dtd.parser.InputCharStream.backup(), org.exolab.castor.xml.dtd.parser.InputCharStream.GetImage(), org.exolab.castor.xml.dtd.parser.InputCharStream.GetSuffix(), org.exolab.castor.xml.dtd.parser.InputCharStream.InputCharStream(), org.exolab.castor.xml.dtd.parser.InputCharStream.readChar(), and org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit().
final boolean org.exolab.castor.xml.dtd.parser.InputCharStream.staticFlag = false [static] |
Referenced by org.exolab.castor.xml.dtd.parser.InputCharStream.adjustBeginLineColumn(), org.exolab.castor.xml.dtd.parser.InputCharStream.BeginToken(), org.exolab.castor.xml.dtd.parser.InputCharStream.getBeginColumn(), org.exolab.castor.xml.dtd.parser.InputCharStream.getBeginLine(), org.exolab.castor.xml.dtd.parser.InputCharStream.GetImage(), and org.exolab.castor.xml.dtd.parser.InputCharStream.ReInit().
1.7.0