com.oracle.truffle.api.source

Class SourceSection

java.lang.Object

com.oracle.truffle.api.source.SourceSection

public final class SourceSection
extends Object

Description of contiguous section of text within a Source of program code.; supports multiple modes of access to the text and its location.

Two available source sections are considered equal if their sources, start and length are equal. Unavailable source sections are compared by identity. Source sections can be used as keys in hash maps.

Since:

0.8 or earlier

See Also:

Source.createSection(int), Source.createSection(int, int), Source.createSection(int, int, int), Source.createUnavailableSection()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
CharSequence	getCharacters() Returns the source code fragment described by this section.
int	getCharEndIndex() Returns the index of the text position immediately following the last character in the section.
int	getCharIndex() Returns the 0-based index of the first character in this section.
int	getCharLength() Returns the length of this section in characters.
int	getEndColumn() Returns the 1-based column number of the last character in this section (inclusive).
int	getEndLine() Returns 1-based line number of the last character in this section (inclusive).
Source	getSource() Representation of the source program that contains this section.
int	getStartColumn() Returns the 1-based column number of the first character in this section (inclusive).
int	getStartLine() Returns 1-based line number of the first character in this section (inclusive).
int	hashCode()
boolean	isAvailable() Returns whether this is a special instance that signifies that source information is available.
String	toString() Returns an implementation-defined string representation of this source section to be used for debugging purposes only.

Methods inherited from class java.lang.Object

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

Method Detail

isAvailable

public boolean isAvailable()

Returns whether this is a special instance that signifies that source information is available. Unavailable source sections can be created using Source.createUnavailableSection(). Available source sections are never equal to unavailable source sections. Unavailable source sections return the same indices and lengths as empty source sections starting at character index 0.

Since:

0.18

See Also:

Source.createUnavailableSection()

getSource

public Source getSource()

Representation of the source program that contains this section.

Returns:

the source object

Since:

0.8 or earlier

getStartLine

public int getStartLine()

Returns 1-based line number of the first character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections. Please note that calling this method causes the code of the source to be loaded if it was not yet loaded.

Returns:

the starting line number

Since:

0.8 or earlier

getStartColumn

public int getStartColumn()

Returns the 1-based column number of the first character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections. Please note that calling this method causes the code of the source to be loaded if it was not yet loaded.

Returns:

the starting column number

Since:

0.8 or earlier

getEndLine

public int getEndLine()

Returns 1-based line number of the last character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections. Please note that calling this method causes the code of the source to be loaded if it was not yet loaded.

Returns:

the starting line number

Since:

0.8 or earlier

getEndColumn

public int getEndColumn()

Returns the 1-based column number of the last character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections. Please note that calling this method causes the code of the source to be loaded if it was not yet loaded.

Returns:

the starting column number

Since:

0.8 or earlier

getCharIndex

public int getCharIndex()

Returns the 0-based index of the first character in this section. Returns 0 for unavailable source sections. Please note that calling this method does not cause the code of the source to be loaded. The returned index might be out of bounds of the source code if assertions (-ea) are not enabled.

Returns:

the starting character index

Since:

0.8 or earlier

getCharLength

public int getCharLength()

Returns the length of this section in characters. Returns 0 for unavailable source sections. Please note that calling this method does not cause the code of the source to be loaded. The returned length might be out of bounds of the source code if assertions (-ea) are not enabled.

Returns:

the number of characters in the section

Since:

0.8 or earlier

getCharEndIndex

public int getCharEndIndex()

Returns the index of the text position immediately following the last character in the section. Returns 0 for unavailable source sections. Please note that calling this method does not cause the code of the source to be loaded. The returned index might be out of bounds of the source code if assertions (-ea) are not enabled.

Returns:

the end position of the section

Since:

0.8 or earlier

getCharacters

public CharSequence getCharacters()

Returns the source code fragment described by this section. Returns an empty character sequence for out of bounds or unavailable source sections. Please note that calling this method causes the code of the source to be loaded if it was not yet loaded.

Returns:

the code as a CharSequence

Since:

0.28

toString

public String toString()

Returns an implementation-defined string representation of this source section to be used for debugging purposes only.

Overrides:

toString in class Object

Since:

0.8 or earlier

See Also:

SourceSection.getCharacters()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

0.8 or earlier

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

0.8 or earlier