scriptinterface

Interface ReaderInterface

All Known Implementing Classes:

DotReader, genscript.parse.IndexReader, genscript.defaultreaders.ScanTokenizer, genscript.syntax.tokens.Tokenizer

public interface ReaderInterface

An abstract layer for a script code reader.

Author:

Andreas Fender

Method Summary

Methods

Modifier and Type	Method and Description
int	getBufferSize()
int	getErrorPosition() If an error occured while parsing, this method will afterwards return the position of the error.
java.lang.String	getFilename()
int	getPosition()
boolean	hasErrorPosition()
boolean	isEndOfBuffer()
Index	read() Returns the next index in the source code and moves the marker.
void	setPosition(int position) Sets the marker to the given position.
SourcePosition	toTextPosition(int position) Returns the position of the readable input source code.

Method Detail

read

Index read()
           throws ParseExceptionInterface

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

Returns:

the next index

Throws:

ParseExceptionInterface - if the next index cannot be read

getPosition

int getPosition()

Returns:

the current position of the marker

getFilename

java.lang.String getFilename()

Returns:

the filename of the source code.

getBufferSize

int getBufferSize()

Returns:

the number of tokens/bytes of the buffer

isEndOfBuffer

boolean isEndOfBuffer()

Returns:

true, if and only if the marker is at the end of the buffer

setPosition

void setPosition(int position)

Sets the marker to the given position.

Parameters:

position - the position to set the marker

toTextPosition

SourcePosition toTextPosition(int position)

Returns the position of the readable input source code.

Parameters:

position - the position to transform into the text position

Returns:

the text position

getErrorPosition

int getErrorPosition()

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

Returns:

the position of the error

hasErrorPosition

boolean hasErrorPosition()

Returns:

true, if and only if an error position is set