org.stekikun.dolmen.syntax

Class PExtent

java.lang.Object

org.stekikun.dolmen.syntax.CExtent

org.stekikun.dolmen.syntax.Extent

org.stekikun.dolmen.syntax.PExtent

public class PExtent
extends Extent

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.

The differences with Extent is that instances of PExtent can contain special markers which are not Java code and represent special parameters which can be instantiated by typically other extents. These special markers are called holes and are introduced by a specific "magic" character.

An extent's holes are stored in order of appearance in the extent, and must never overlap. This is guaranteed by the associated PExtent.Builder class.

Author:

Stéphane Lescuyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PExtent.Builder Builder class for parameterized extends
static class	PExtent.Hole A PExtent.Hole represents a special part of an extent which is bound to some PExtent.Hole.name and can be instantiated later on.

Field Summary

Fields

Modifier and Type	Field and Description
static PExtent	DUMMY A dummy extent for convenience, with no holes
List<PExtent.Hole>	holes The (possibly empty) list of holes in this parameterized extent.

Fields inherited from class org.stekikun.dolmen.syntax.Extent

endPos, filename, startCol, startLine, startPos

Constructor Summary

Constructors

Constructor and Description
PExtent(PExtent ext) A copy constructor for parameterized extents

Method Summary

Modifier and Type	Method and Description
CExtent	compose(String ruleName, Map<String,CExtent> replacements) NB: Except in the special case where the receiver had no holes the returned Extent will be inlined, i.e. information about the original location in the source will be lost.
boolean	equals(@Nullable Object obj)
String	find() The string must be of length CExtent.realLength().
int	hashCode()
static PExtent	inlined(String contents) This is equivalent to ofExtent(Extent.inlined(contents)).
Extent	instantiate(Map<String,Extent> replacements) NB: Except in the special case where the receiver had no holes the returned Extent will be inlined, i.e. information about the original location in the source will be lost.
static PExtent	ofExtent(Extent extent)
String	toString()

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

endPos, filename, findOrigin, length, realLength, startCol, startLine, startPos

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

holes

public final List<PExtent.Hole> holes

The (possibly empty) list of holes in this parameterized extent.

The list must be strictly ordered in the sense that all holes appear in increasing order of offset, and that all the ranges described by the holes are disjoint.

DUMMY

public static final PExtent DUMMY

A dummy extent for convenience, with no holes

Constructor Detail

PExtent

public PExtent(PExtent ext)

A copy constructor for parameterized extents

Parameters:

ext -

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Extent

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Extent

toString

public String toString()

Overrides:

toString in class Extent

find

public String find()

Description copied from class: CExtent

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

Overrides:

find in class Extent

Returns:

the string portion described by this extent, with the holes as they were

ofExtent

public static PExtent ofExtent(Extent extent)

Parameters:

extent -

Returns:

the given extent as a PExtent, with no holes

inlined

public static PExtent inlined(String contents)

This is equivalent to ofExtent(Extent.inlined(contents)).

Parameters:

contents -

Returns:

a parameterized extent with the given contents, which must not contain any holes

instantiate

public Extent instantiate(Map<String,Extent> replacements)

NB: Except in the special case where the receiver had no holes the returned Extent will be inlined, i.e. information about the original location in the source will be lost. TODO This should be temporary as it should be possible to keep a tree of the original locations that led to a composite extent.

Parameters:

replacements -

Returns:

an extent representing the contents of this extent where all the holes are replaced to extents according to the replacement map replacements

Throws:

IllegalArgumentException - if the replacements map does not cover all the possible holes in the receiver

compose

public CExtent compose(String ruleName,
                       Map<String,CExtent> replacements)

NB: Except in the special case where the receiver had no holes the returned Extent will be inlined, i.e. information about the original location in the source will be lost. TODO This should be temporary as it should be possible to keep a tree of the original locations that led to a composite extent.

Parameters:

ruleName - the ground rule which triggered this instantiation

replacements -

Returns:

an extent representing the contents of this extent where all the holes are replaced to extents according to the replacement map replacements

Throws:

IllegalArgumentException - if the replacements map does not cover all the possible holes in the receiver