edu.umn.cs.melt.copper.runtime.io

Class InputPosition

java.lang.Object

edu.umn.cs.melt.copper.runtime.io.InputPosition

All Implemented Interfaces:

Location, Serializable, Comparable<Location>

public abstract class InputPosition
extends Object
implements Location

Represents the position of a parser in its input.

Author:

August Schwerdfeger <schw0709@umn.edu>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InputPosition()

Method Summary

Modifier and Type	Method and Description
static InputPosition	advance(InputPosition curPos, char pastChar) Returns a position one character past the given.
static InputPosition	advance(InputPosition curPos, int offset, String stringToPass)
abstract int	compareTo(Location ref)
static InputPosition	copy(InputPosition i)
static Pair<Integer,Integer>	countNewlines(String lexeme)
abstract int	diff(InputPosition ref) Calculates the offset from one position to another.
abstract boolean	equals(Object rhs)
static InputPosition	fromSAXLocator(InputPosition pos, Locator locator) Builds a position based on information from a Locator object.
abstract int	getColumn() The column the parser has reached.
abstract String	getFileName() The name of the file being parsed.
abstract int	getLine() The line the parser has reached.
abstract long	getPos() The position in the file (makes sense only for real locations -- virtual locations should return a dummy value).
abstract int	hashCode()
static InputPosition	initialPos() Returns a reference position for the "initial" point in a stream.
static InputPosition	initialPos(String fileName) Returns a reference position for the "initial" point in a file stream.
abstract boolean	isAfter(InputPosition rhs) Tests whether this position is after another.
abstract boolean	isBefore(InputPosition rhs) Tests whether this position is before another.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputPosition

public InputPosition()

Method Detail

isBefore

public abstract boolean isBefore(InputPosition rhs)

Tests whether this position is before another.

Parameters:

rhs - The position against which to test.

Returns:

true iff this falls before rhs.

isAfter

public abstract boolean isAfter(InputPosition rhs)

Tests whether this position is after another.

Parameters:

rhs - The position against which to test.

Returns:

true iff this falls after rhs.

diff

public abstract int diff(InputPosition ref)

Calculates the offset from one position to another.

Parameters:

ref - The reference position.

Returns:

The offset of this position from ref.

compareTo

public abstract int compareTo(Location ref)

Specified by:

compareTo in interface Comparable<Location>

equals

public abstract boolean equals(Object rhs)

Overrides:

equals in class Object

getFileName

public abstract String getFileName()

Description copied from interface: Location

The name of the file being parsed.

Specified by:

getFileName in interface Location

getLine

public abstract int getLine()

Description copied from interface: Location

The line the parser has reached.

Specified by:

getLine in interface Location

getColumn

public abstract int getColumn()

Description copied from interface: Location

The column the parser has reached.

Specified by:

getColumn in interface Location

getPos

public abstract long getPos()

Description copied from interface: Location

The position in the file (makes sense only for real locations -- virtual locations should return a dummy value).

Specified by:

getPos in interface Location

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

initialPos

public static InputPosition initialPos()

Returns a reference position for the "initial" point in a stream.

Returns:

The reference position.

initialPos

public static InputPosition initialPos(String fileName)

Returns a reference position for the "initial" point in a file stream.

Parameters:

fileName - The name of the file.

Returns:

The reference position.

fromSAXLocator

public static InputPosition fromSAXLocator(InputPosition pos,
                                           Locator locator)

Builds a position based on information from a Locator object.

Parameters:

pos - An input position at the beginning of the file being parsed.

locator - A locator passed from the SAX parser to indicate where the parser is located.

Returns:

An InputPosition object set to the location indicated by the Locator.

copy

public static InputPosition copy(InputPosition i)

advance

public static InputPosition advance(InputPosition curPos,
                                    char pastChar)

Returns a position one character past the given.

Parameters:

curPos - A reference position.

pastChar - The character that will be passed.

Returns:

A position one character past curPos.

advance

public static InputPosition advance(InputPosition curPos,
                                    int offset,
                                    String stringToPass)

countNewlines

public static Pair<Integer,Integer> countNewlines(String lexeme)