genscript.parse

Class IndexReader

java.lang.Object

genscript.parse.ReaderStack

genscript.parse.IndexReader

All Implemented Interfaces:

ReaderInterface

Direct Known Subclasses:

SourceReader, Tokenizer

public abstract class IndexReader
extends ReaderStack
implements ReaderInterface

Constructor Summary

Constructors

Constructor and Description
IndexReader()

Method Summary

Modifier and Type	Method and Description
boolean	canStepBack()
void	clear() Deletes all the read information.
int	getBottomLevelIntervalStartPos()
int	getBottomLevelPosition()
abstract int	getBottomLevelPosition(int topLevelPosition)
abstract IndexReader	getBottomLevelSource()
abstract int	getBufferSize()
int	getErrorPosition() If an error occured while parsing, this method will afterwards return the position of the error.
abstract java.lang.String	getFilename()
abstract int	getIntervalEndPos()
abstract int	getIntervalStartPos()
abstract int	getPosition()
boolean	hasErrorPosition()
java.lang.String	intervalToString()
abstract java.lang.String	intervalToString(int startShift, int endShift)
abstract boolean	isEndOfBuffer()
abstract IndexReader	newReader() Clones this Reader without copying the buffer itself
void	parseStart(NTProductions startParser)
abstract Index	read() Returns the next index in the source code and moves the marker.
void	setErrorPosition(int pos)
abstract void	setIntervalEndPos(int endPos)
void	setIntervalPositions(int startPos, int endPos)
abstract void	setIntervalStartPos(int startPos)
abstract void	setPosition(int position) Sets the Position of the inner Buffer.
abstract void	skipSpace()
abstract void	stepBack() Makes one step back in the buffer.
void	switchParser(NTProductions newParser)
abstract SourcePosition	toTextPosition(int position) Returns the position of the readable input source code.

Methods inherited from class genscript.parse.ReaderStack

getMarkedStackSize, getResultStackSize, getStackMark, popResult, pushResult, resetStack, resultStackToString, setStackMark

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexReader

public IndexReader()

Method Detail

read

public abstract Index read()
                    throws ParseException

Description copied from interface: ReaderInterface

Returns the next index in the source code and moves the marker.

Specified by:

read in interface ReaderInterface

Returns:

the next index

Throws:

ParseException

getPosition

public abstract int getPosition()

Specified by:

getPosition in interface ReaderInterface

Returns:

the current position of the marker

setPosition

public abstract void setPosition(int position)

Sets the Position of the inner Buffer. The next read() call will start from the set position.

Specified by:

setPosition in interface ReaderInterface

Parameters:

position - the position to set the marker

getBottomLevelPosition

public abstract int getBottomLevelPosition(int topLevelPosition)

intervalToString

public abstract java.lang.String intervalToString(int startShift,
                                                  int endShift)

toTextPosition

public abstract SourcePosition toTextPosition(int position)

Description copied from interface: ReaderInterface

Returns the position of the readable input source code.

Specified by:

toTextPosition in interface ReaderInterface

Parameters:

position - the position to transform into the text position

Returns:

the text position

skipSpace

public abstract void skipSpace()

getFilename

public abstract java.lang.String getFilename()

Specified by:

getFilename in interface ReaderInterface

Returns:

the filename of the source code.

getBufferSize

public abstract int getBufferSize()

Specified by:

getBufferSize in interface ReaderInterface

Returns:

the number of tokens/bytes of the buffer

getIntervalStartPos

public abstract int getIntervalStartPos()

setIntervalStartPos

public abstract void setIntervalStartPos(int startPos)

getIntervalEndPos

public abstract int getIntervalEndPos()

setIntervalEndPos

public abstract void setIntervalEndPos(int endPos)

getBottomLevelSource

public abstract IndexReader getBottomLevelSource()

isEndOfBuffer

public abstract boolean isEndOfBuffer()

Specified by:

isEndOfBuffer in interface ReaderInterface

Returns:

True, if and only if the end of the inner Buffer is reached

stepBack

public abstract void stepBack()

Makes one step back in the buffer.

newReader

public abstract IndexReader newReader()

Clones this Reader without copying the buffer itself

intervalToString

public java.lang.String intervalToString()

setIntervalPositions

public void setIntervalPositions(int startPos,
                                 int endPos)

getBottomLevelPosition

public final int getBottomLevelPosition()

getBottomLevelIntervalStartPos

public final int getBottomLevelIntervalStartPos()

parseStart

public void parseStart(NTProductions startParser)
                throws ParseException

Throws:

ParseException

switchParser

public void switchParser(NTProductions newParser)
                  throws ParseException

Throws:

ParseException

clear

public void clear()

Deletes all the read information. The read position remains the same.

getErrorPosition

public int getErrorPosition()

Description copied from interface: ReaderInterface

If an error occured while parsing, this method will afterwards return the position of the error.

Specified by:

getErrorPosition in interface ReaderInterface

Returns:

the position of the error

setErrorPosition

public void setErrorPosition(int pos)

hasErrorPosition

public boolean hasErrorPosition()

Specified by:

hasErrorPosition in interface ReaderInterface

Returns:

true, if and only if an error position is set

canStepBack

public boolean canStepBack()