edu.umn.cs.melt.copper.runtime.engines.semantics

Class VirtualLocation

java.lang.Object

edu.umn.cs.melt.copper.runtime.engines.semantics.VirtualLocation

All Implemented Interfaces:

Location, java.lang.Comparable<Location>

public class VirtualLocation
extends java.lang.Object
implements Location

Holds a "virtual" location -- a location that may not represent a "real" location in an input file (e.g., a location specified in C preprocessor tags).

Author:

August Schwerdfeger <schwerdf@cs.umn.edu>

Field Summary

Fields

Modifier and Type	Field and Description
protected int	column The column number pertaining to the location.
protected java.lang.String	fileName The filename pertaining to the location.
protected int	line The line number pertaining to the location.
protected int	tabStop The character width of a tab in this context; defaults to 8.

Constructor Summary

Constructors

Constructor and Description
VirtualLocation(java.lang.String fileName, int line, int column) Creates a new virtual location.
VirtualLocation(VirtualLocation original)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Location l)
Pair<java.lang.Integer,java.lang.Integer>	countNewlines(int column, java.lang.String lexeme) Counts the number of newlines in a given lexeme, and the column number at the end of the lexeme.
void	defaultUpdate(java.lang.String lexeme) Performs a "default update" -- i.e., moves this virtual location past a given lexeme.
void	defaultUpdateAutomatic(java.lang.String lexeme) This function is meant to be called automatically from the parser.
int	getColumn() The column the parser has reached.
java.lang.String	getFileName() The name of the file being parsed.
java.lang.String	getHash() Generates and returns a string representation of the location.
int	getLine() The line the parser has reached.
long	getPos() The position in the file (makes sense only for real locations -- virtual locations should return a dummy value).
int	getTabStop()
boolean	isModified() Determines whether this virtual location has been modified since its construction or its last "default update."
void	setColumn(int column)
void	setFileName(java.lang.String fileName)
void	setLine(int line)
void	setTabStop(int tabStop)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

tabStop

protected int tabStop

The character width of a tab in this context; defaults to 8.

line

protected int line

The line number pertaining to the location.

column

protected int column

The column number pertaining to the location.

fileName

protected java.lang.String fileName

The filename pertaining to the location.

Constructor Detail

VirtualLocation

public VirtualLocation(java.lang.String fileName,
                       int line,
                       int column)

Creates a new virtual location.

Parameters:

fileName - The filename pertaining to the location.

line - The line number pertaining to the location.

column - The column number pertaining to the location.

VirtualLocation

public VirtualLocation(VirtualLocation original)

Method Detail

getColumn

public int getColumn()

Description copied from interface: Location

The column the parser has reached.

Specified by:

getColumn in interface Location

See Also:

column

setColumn

public void setColumn(int column)

See Also:

column

getFileName

public java.lang.String getFileName()

Description copied from interface: Location

The name of the file being parsed.

Specified by:

getFileName in interface Location

See Also:

fileName

setFileName

public void setFileName(java.lang.String fileName)

See Also:

fileName

getLine

public int getLine()

Description copied from interface: Location

The line the parser has reached.

Specified by:

getLine in interface Location

See Also:

line

setLine

public void setLine(int line)

See Also:

line

getPos

public 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

getTabStop

public int getTabStop()

See Also:

tabStop

setTabStop

public void setTabStop(int tabStop)

See Also:

tabStop

getHash

public java.lang.String getHash()

Generates and returns a string representation of the location.

Returns:

The string representation of the location, in the format [filename]:[line].[column].

isModified

public boolean isModified()

Determines whether this virtual location has been modified since its construction or its last "default update."

See Also:

defaultUpdate(String)

defaultUpdateAutomatic

public void defaultUpdateAutomatic(java.lang.String lexeme)

This function is meant to be called automatically from the parser.

defaultUpdate

public void defaultUpdate(java.lang.String lexeme)

Performs a "default update" -- i.e., moves this virtual location past a given lexeme. For example, a virtual location starting at line 4, column 5, called on the lexeme "abc\nde", will be reset to line 5, column 2.

Parameters:

lexeme - The lexeme to move past.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(Location l)

Specified by:

compareTo in interface java.lang.Comparable<Location>

countNewlines

public Pair<java.lang.Integer,java.lang.Integer> countNewlines(int column,
                                                               java.lang.String lexeme)

Counts the number of newlines in a given lexeme, and the column number at the end of the lexeme.

Parameters:

column - The column number of the location at the beginning of the lexeme.

lexeme - The lexeme.

Returns:

A pair of integers, of which the first is the count of newlines in the lexeme and the second is the column number at the end of the lexeme.