org.treesitter.TSTreeCursor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tree-sitter Show documentation
Next generation Tree Sitter Java binding
There is a newer version: 0.24.4
package org.treesitter;

import static org.treesitter.TSParser.*;

public class TSTreeCursor {
    private final long ptr;
    private static class TSTreeCursorCleanAction implements Runnable {
        private final long ptr;

        public TSTreeCursorCleanAction(long ptr) {
            this.ptr = ptr;
        }

        @Override
        public void run() {
            ts_tree_cursor_delete(ptr);
            free_cursor(ptr);
        }
    }

    private TSTreeCursor(long ptr) {
        this.ptr = ptr;
        CleanerRunner.register(this, new TSTreeCursorCleanAction(ptr));
    }
    /**
     * Create a new tree cursor starting from the given node.

     *
     * A tree cursor allows you to walk a syntax tree more efficiently than is
     * possible using the {@link TSNode} functions. It is a mutable object that is always
     * on a certain syntax node, and can be moved imperatively to different nodes.
     *
     * @param node The node to start the cursor at.
     */
    public TSTreeCursor(TSNode node) {
        this(TSParser.ts_tree_cursor_new(node));
    }

    /**
     * Re-initialize a tree cursor to start at a different node.
     *
     * @param node The node to start the cursor at.
     */
    public void reset(TSNode node){
        ts_tree_cursor_reset(ptr, node);
    }

    /**
     * Get the tree cursor's current node.
     *
     * @return The current node.
     */
    public TSNode currentNode(){
        return ts_tree_cursor_current_node(ptr);
    }

    /**
     * Get the field name of the tree cursor's current node.

     *
     * This returns null if the current node doesn't have a field.
     * See also {@link TSNode#getChildByFieldName(String) TSNode#getChildByFieldName}.
     *
     * @return The field name of the current node.
     */
    public String currentFieldName(){
        return ts_tree_cursor_current_field_name(ptr);
    }
    
    /**
     * Get the field id of the tree cursor's current node.

     *
     * This returns zero if the current node doesn't have a field.
     * See also {@link TSNode#getChildByFieldId(int) TSNode#getChildByFieldId}, {@link TSLanguage#fieldIdForName(String) TSLanguage#fieldIdForName}.
     *
     * @return The field id of the current node.
     */
    public int currentFieldId(){
        return ts_tree_cursor_current_field_id(ptr);
    }

    /**
     * Move the cursor to the parent of its current node.

     *
     * This returns true if the cursor successfully moved, and returns false
     * if there was no parent node (the cursor was already on the root node).
     *
     * @return Whether the cursor successfully moved to the parent.
     */
    public boolean gotoParent(){
        return ts_tree_cursor_goto_parent(ptr);
    }

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

     *
     * This returns true if the cursor successfully moved, and returns false
     * if there was no next sibling node.
     *
     * @return Whether the cursor successfully moved to the next sibling.
     */
    public boolean gotoNextSibling(){
        return ts_tree_cursor_goto_next_sibling(ptr);
    }

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

     *
     * This returns  true if the cursor successfully moved, and returns false
     * if there were no children.
     *
     * @return Whether the cursor successfully moved to the first child.
     */
    public boolean gotoFirstChild(){
        return ts_tree_cursor_goto_first_child(ptr);
    }

    /**
     * Move the cursor to the first child of its current node that extends beyond
     * the given byte offset.

     *
     * @param startByte The byte offset.
     *
     * @return The index of the child node if one was found, and returns -1 if no such child was found.
     */
    public int gotoFirstChildForByte(int startByte){
        return ts_tree_cursor_goto_first_child_for_byte(ptr, startByte);
    }

    /**
     * Move the cursor to the first child of its current node that extends beyond
     * the given byte point.

     *
     * @param startPoint The point offset.
     *
     * @return The index of the child node if one was found, and returns -1 if no such child was found.
     */
    public int gotoFirstChildForPoint(TSPoint startPoint){
        return ts_tree_cursor_goto_first_child_for_point(ptr, startPoint);
    }

    public TSTreeCursor copy(){
        return new TSTreeCursor(ts_tree_cursor_copy(ptr));
    }





}