Package ch.usi.si.seart.treesitter

Class OffsetTreeCursor

java.lang.Object

ch.usi.si.seart.treesitter.TreeCursor

ch.usi.si.seart.treesitter.OffsetTreeCursor

All Implemented Interfaces:

AutoCloseable

public class OffsetTreeCursor
extends TreeCursor

Specialization of TreeCursor that applies a positional offset to visited nodes. Retrieving nodes by either getCurrentNode() or getCurrentTreeCursorNode() applies the offset to a copy of the original node, meaning that the tree is not mutated during traversal.

So what exactly is the purpose of this cursor? Imagine a scenario in which we need to print out the node positions of a source code file that begins with n blank lines. Rather than modifying the original file, we can just use this cursor with a positional offset of new Position(-n, 0). Likewise, when printing node positions of an indented function, the n spaces of indentation can be negated with a positional offset of new Position(0, -n). Row and column offsets can be combined with various positive and negative arrangements.

Since:

1.2.0

Author:

Ozren Dabić

Constructor Summary

Constructors

Constructor	Description
OffsetTreeCursor(@NotNull Node node, @NotNull Point offset)

Method Summary

Modifier and Type	Method	Description
void	close()	Delete the tree cursor, freeing all the memory that it used.
boolean	equals(Object obj)
String	getCurrentFieldName()
Node	getCurrentNode()
TreeCursorNode	getCurrentTreeCursorNode()
boolean	gotoFirstChild()	Move the cursor to the first child of its current node.
boolean	gotoNextSibling()	Move the cursor to the next sibling of its current node.
boolean	gotoParent()	Move the cursor to the parent of its current node.
int	hashCode()
boolean	isNull()
void	preorderTraversal(@NotNull Consumer<Node> callback)	Iteratively traverse over the parse tree, applying a callback to the nodes before they are visited.

Methods inherited from class ch.usi.si.seart.treesitter.TreeCursor

toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OffsetTreeCursor

public OffsetTreeCursor(@NotNull
                        @NotNull Node node,
                        @NotNull
                        @NotNull Point offset)

Method Detail

close

public void close()

Description copied from class: TreeCursor

Delete the tree cursor, freeing all the memory that it used.

Specified by:

close in interface AutoCloseable

Overrides:

close in class TreeCursor

getCurrentFieldName

public String getCurrentFieldName()

Overrides:

getCurrentFieldName in class TreeCursor

Returns:

The field name of the tree cursor's current node, null if the current node doesn't have a field

gotoFirstChild

public boolean gotoFirstChild()

Description copied from class: TreeCursor

Move the cursor to the first child of its current node.

Overrides:

gotoFirstChild in class TreeCursor

Returns:

true if the cursor successfully moved, and false if there were no children

gotoNextSibling

public boolean gotoNextSibling()

Description copied from class: TreeCursor

Move the cursor to the next sibling of its current node.

Overrides:

gotoNextSibling in class TreeCursor

Returns:

true if the cursor successfully moved, and false if there was no next sibling node

gotoParent

public boolean gotoParent()

Description copied from class: TreeCursor

Move the cursor to the parent of its current node.

Overrides:

gotoParent in class TreeCursor

Returns:

true if the cursor successfully moved, and false if there was no parent node (the cursor was already on the root node)

preorderTraversal

public void preorderTraversal(@NotNull
                              @NotNull Consumer<Node> callback)

Description copied from class: TreeCursor

Iteratively traverse over the parse tree, applying a callback to the nodes before they are visited.

Overrides:

preorderTraversal in class TreeCursor

Parameters:

callback - The callback consumer which will execute upon visiting a node

getCurrentNode

public Node getCurrentNode()

Overrides:

getCurrentNode in class TreeCursor

Returns:

The tree cursor's current node

getCurrentTreeCursorNode

public TreeCursorNode getCurrentTreeCursorNode()

Overrides:

getCurrentTreeCursorNode in class TreeCursor

Returns:

The tree cursor's current node

isNull

public final boolean isNull()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object