LPEX
3.6.7

com.ibm.lpex.cc
Interface UCode_CharStream

All Known Implementing Classes:
LpexCharStream

public interface UCode_CharStream

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. All the methods except backup can be implemented in any fashion. Method backup() needs to be implemented correctly for the correct operation of the generated lexers. The 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 generated lexers. Therefore, their implementation won't affect the operation of these lexers. LPEX's implementation of this interface is com.ibm.lpex.core.LpexCharStream.


Field Summary
static boolean staticFlag
           
 
Method Summary
 void backup(int amount)
          Backs up the input stream by amount steps.
 char BeginToken()
          Returns the next character that marks the beginning of the next token.
 void Done()
          The generated lexer calls this function to indicate that it is done with the stream, so implementations can free any resources held by this class.
 int getBeginColumn()
          Returns the column number of the first character for the current token (being matched after the last call to BeginToken).
 int getBeginLine()
          Returns the line number of the first character for the current token (being matched after the last call to BeginToken).
 int getEndColumn()
          Returns the column number of the last character for the current token (being matched after the last call to BeginToken).
 int getEndLine()
          Returns the line number of the last character for the current token (being matched after the last call to BeginToken).
 String GetImage()
          Returns a string made up of characters from the marked token beginning to the current buffer position.
 char[] GetSuffix(int len)
          Returns an array of characters that make up the suffix of length 'len' for the currently matched token.
 char readChar()
          Returns the next character from the selected input.
 

Field Detail

staticFlag

static final boolean staticFlag
See Also:
Constant Field Values
Method Detail

readChar

char readChar()
              throws IOException
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.

Throws:
IOException

getEndColumn

int getEndColumn()
Returns the column number of the last character for the current token (being matched after the last call to BeginToken).


getEndLine

int getEndLine()
Returns the line number of the last character for the current token (being matched after the last call to BeginToken).


getBeginColumn

int getBeginColumn()
Returns the column number of the first character for the current token (being matched after the last call to BeginToken).


getBeginLine

int getBeginLine()
Returns the line number of the first character for the current token (being matched after the last call to BeginToken).


backup

void backup(int amount)
Backs up the input stream by amount steps. The 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.


BeginToken

char BeginToken()
                throws IOException
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.

Throws:
IOException

GetImage

String GetImage()
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.


GetSuffix

char[] GetSuffix(int len)
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();
   } 


Done

void Done()
The generated lexer calls this function to indicate that it is done with the stream, so 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.


LPEX
3.6.7

Copyright © 2012 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.