trait CharStream extends AnyRef
This interface describes a character stream that maintains line and column number positions of the characters. It also has the capability to backup the stream to some extent. An implementation of this interface is used in the TokenManager implementation generated by JavaCCParser.
All the methods except backup can be implemented in any fashion. backup needs to be implemented correctly for the correct operation of the lexer. Rest of the methods are all used to get information like line number, column number and the String that constitutes a token and are not used by the lexer. Hence their implementation won't affect the generated lexer's operation.
- Alphabetic
- By Inheritance
- CharStream
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def BeginToken(): Char
Returns the next character that marks the beginning of the next token.
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.
- abstract def Done(): Unit
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.
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.
- abstract def GetImage(): String
Returns a string made up of characters from the marked token beginning to the current buffer position.
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.
- abstract def GetSuffix(len: Int): Array[Char]
Returns an array of characters that make up the suffix of length 'len' for the currently matched token.
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(); }
- abstract def backup(amount: Int): Unit
Backs up the input stream by amount steps.
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 implementation's responsibility to do this right.
- abstract def getBeginColumn(): Int
Returns the column number of the first character for current token (being matched after the last call to BeginTOken).
- abstract def getBeginLine(): Int
Returns the line number of the first character for current token (being matched after the last call to BeginTOken).
- abstract def getEndColumn(): Int
Returns the column number of the last character for current token (being matched after the last call to BeginTOken).
- abstract def getEndLine(): Int
Returns the line number of the last character for current token (being matched after the last call to BeginTOken).
- abstract def getTabSize(): Int
- abstract def getTrackLineColumn(): Boolean
- abstract def readChar(): Char
Returns the next character from the selected input.
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.
- abstract def setTabSize(i: Int): Unit
- abstract def setTrackLineColumn(trackLineColumn: Boolean): Unit
- abstract def getColumn(): Int
Returns the column position of the character last read.
Returns the column position of the character last read.
- Annotations
- @Deprecated
- Deprecated
- See also
#getEndColumn
- abstract def getLine(): Int
Returns the line number of the character last read.
Returns the line number of the character last read.
- Annotations
- @Deprecated
- Deprecated
- See also
#getEndLine
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated