org.stekikun.dolmen.syntax

Class Located<T>

java.lang.Object

org.stekikun.dolmen.syntax.Located<T>

Type Parameters:

T -

public final class Located<T>
extends Object

This class allows wrapping values of some type with a start and end positions as provided by the lexing engine. It only supports wrapping non-null values and the start and end positions must always specify the same source.

Warning: Equality test on located values is just forwarded to the values themselves; in other words, the actual positions are ignored when comparing instances of Located. Typically, this means one can use located values as keys in a map in an intermediate AST as if they were not located, but must be wary of potential duplicate keys at different spots during the parsing phase.

toString() is implemented in such a way that pairs of start/end positions are written in the following format:

 (`start source`[`start offset`, `start line`+`start column offset`]..
  `end source`[`end offset`, `end line`+`end column offset`])
 

Author:

Stéphane Lescuyer

Field Summary

Fields

Modifier and Type	Field and Description
LexBuffer.Position	end The end position of the value in the input file
LexBuffer.Position	start The start position of the value in the input file
T	val The value whose location is stored in this instance

Method Summary

Modifier and Type	Method and Description
static <T> Located<T>	dummy(T val)
boolean	equals(@Nullable Object o)
int	hashCode()
int	length()
static <T,U> Located<T>	like(T val, Located<U> loc)
static <T> Located<T>	of(T val, LexBuffer.Position start, LexBuffer.Position end)
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

val

public final T val

The value whose location is stored in this instance

start

public final LexBuffer.Position start

The start position of the value in the input file

end

public final LexBuffer.Position end

The end position of the value in the input file

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

toString

public @NonNull String toString()

Overrides:

toString in class Object

length

public int length()

Returns:

the length of this location

of

public static <T> Located<T> of(T val,
                                LexBuffer.Position start,
                                LexBuffer.Position end)

Parameters:

val -

start -

end -

Returns:

the given value val wrapped with the given start and end positions

dummy

public static <T> Located<T> dummy(T val)

Parameters:

val -

Returns:

the given value with a dummy start and end position, located at the beginning of an imaginary file called "<DUMMY>"

like

public static <T,U> Located<T> like(T val,
                                    Located<U> loc)

Parameters:

val -

loc -

Returns:

the valule val wrapped with the positions of loc