org.stekikun.dolmen.syntax

Class Extent

java.lang.Object

org.stekikun.dolmen.syntax.CExtent

org.stekikun.dolmen.syntax.Extent

Direct Known Subclasses:

PExtent

public class Extent
extends CExtent

Instances of this class describe ranges of characters in files, and are used to link parsed entities with their concrete representation in the original sources.

They represent a degenerate form of composite extents where no placeholder replacement is required and the extent stands for the contents of a simple character region of a file.

Author:

Stéphane Lescuyer

Field Summary

Fields

Modifier and Type	Field and Description
static Extent	DUMMY A dummy extent for convenience
int	endPos The offset of the last character in the extent (0-based)
String	filename The absolute filename where this extent should be interpreted
int	startCol The column where the extent starts, i.e. the offset of the starting character from the beginning of the line (0-based)
int	startLine The line where the extent starts (1-based)
int	startPos The starting character offset of the extent (0-based)

Constructor Summary

Constructors

Constructor and Description
Extent(String filename, int startPos, int endPos, int startLine, int startCol) Returns a new extent described by the given arguments

Method Summary

Modifier and Type	Method and Description
int	endPos()
boolean	equals(@Nullable Object obj)
String	filename()
String	find() The string must be of length CExtent.realLength().
SourceMapping.Origin	findOrigin(int offset, int length) Finding the origin in a composite extent amounts to finding the innermost extent, composite or not, whose instantiation covers the given region.
int	hashCode()
static Extent	inlined(String contents)
int	length()
int	realLength() The real length of an extent is the actual length of its representation once all place-holders have been replaced.
int	startCol()
int	startLine()
int	startPos()
String	toString()

Methods inherited from class org.stekikun.dolmen.syntax.CExtent

of

Methods inherited from class java.lang.Object

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

Field Detail

filename

public final String filename

The absolute filename where this extent should be interpreted

startPos

public final int startPos

The starting character offset of the extent (0-based)

endPos

public final int endPos

The offset of the last character in the extent (0-based)

startLine

public final int startLine

The line where the extent starts (1-based)

startCol

public final int startCol

The column where the extent starts, i.e. the offset of the starting character from the beginning of the line (0-based)

DUMMY

public static final Extent DUMMY

A dummy extent for convenience

Constructor Detail

Extent

public Extent(String filename,
              int startPos,
              int endPos,
              int startLine,
              int startCol)

Returns a new extent described by the given arguments

Parameters:

filename -

startPos -

endPos -

startLine -

startCol -

Method Detail

filename

public String filename()

Specified by:

filename in class CExtent

Returns:

the absolute filename where this extent should be interpreted

startPos

public int startPos()

Specified by:

startPos in class CExtent

Returns:

the starting character offset of the extent (0-based)

endPos

public int endPos()

Specified by:

endPos in class CExtent

Returns:

the offset of the last character in the extent (0-based)

startLine

public int startLine()

Specified by:

startLine in class CExtent

Returns:

the line where the extent starts (1-based)

startCol

public int startCol()

Specified by:

startCol in class CExtent

Returns:

the column where the extent starts, i.e. the offset of the starting character from the beginning of the line (0-based)

length

public int length()

Specified by:

length in class CExtent

Returns:

the length, in characters, of the described extent

realLength

public int realLength()

Description copied from class: CExtent

The real length of an extent is the actual length of its representation once all place-holders have been replaced.

It can be different from CExtent.length(), the length of the extent as it appeared uninstantiated in the original source.

Specified by:

realLength in class CExtent

Returns:

the real length of this extent

See Also:

CExtent.find()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

find

public String find()

Description copied from class: CExtent

The string must be of length CExtent.realLength().

Specified by:

find in class CExtent

Returns:

the string portion described by this extent

findOrigin

public SourceMapping.Origin findOrigin(int offset,
                                       int length)

Description copied from class: CExtent

Finding the origin in a composite extent amounts to finding the innermost extent, composite or not, whose instantiation covers the given region.

Specified by:

findOrigin in class CExtent

Parameters:

offset - relative offset from the start of this extent

Returns:

the origin of the region described by the relative offset and length

See Also:

SourceMapping.Origin

inlined

public static Extent inlined(String contents)

Parameters:

contents -

Returns:

an inlined extent with the given contents