org.stekikun.dolmen.codegen

Class SourceMapping.Origin

java.lang.Object

org.stekikun.dolmen.codegen.SourceMapping.Origin

Enclosing class:

SourceMapping

public static final class SourceMapping.Origin
extends Object

An instance of this class describes the origin of some region of generated code in terms of the source region from which it originated. In its simpler form, both regions have the same length and same contents, and the origin is characterized by its offset in the source file.

It is also possible that the generated code be the result of Expansion and instantiation of placeholders in parameterized semantic actions. In that case, the source region may contain placeholders and be of a different length than the mapped region. In that case the textual replacements to perform to obtain the contents of the region in generated code is given by replacements. The rule in the ground grammar which produced these instantiated actions is given in ruleName.

Author:

Stéphane Lescuyer

Field Summary

Fields

Modifier and Type	Field and Description
int	length The length of the source region
int	offset The starting offset of the source region
Map<String,String>	replacements The textual replacements for potential holes in the source region
@Nullable String	ruleName The name of the (possibly instantiated) rule which encloses this origin, if any, or null otherwise

Constructor Summary

Constructors

Constructor and Description
Origin(int offset, int length, @Nullable String ruleName, Map<String,String> replacements) Constructs an origin description from the given parameters

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable Object o)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

offset

public final int offset

The starting offset of the source region

length

public final int length

The length of the source region

ruleName

public final @Nullable String ruleName

The name of the (possibly instantiated) rule which encloses this origin, if any, or null otherwise

replacements

public final Map<String,String> replacements

The textual replacements for potential holes in the source region

Constructor Detail

Origin

public Origin(int offset,
              int length,
              @Nullable String ruleName,
              Map<String,String> replacements)

Constructs an origin description from the given parameters

Parameters:

offset - offset of the origin in source file (0-based)

length - length of the origin in source file

ruleName - name of the (ground) rule which encloses this origin

replacements - textual replacements for holes

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 String toString()

Overrides:

toString in class Object