org.treesitter.TSNode 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
Show all versions of tree-sitter Show documentation
Next generation Tree Sitter Java binding
package org.treesitter;
import static org.treesitter.TSParser.*;
public class TSNode {
private int context0;
private int context1;
private int context2;
private int context3;
private long idPtr;
private long treePtr;
private void asserNotNull(){
if(isNull()){
throw new TSException("Node is a null node");
}
}
/**
* Get the node's number of children.
*
* @return The number of children.
*/
public int getChildCount() {
asserNotNull();
return ts_node_child_count(this);
}
/**
* Get the node's number of *named* children.
*
* See also {@link #isNamed()}.
*
* @return The number of named children.
*/
public int getNamedChildCount(){
asserNotNull();
return ts_node_named_child_count(this);
}
/**
* Get the node's *named* child at the given index.
*
* See also {@link #isNamed()}.
*
* @param index The index of the named child to get.
*
* @return The named child at the given index.
*/
public TSNode getNamedChild(int index) {
asserNotNull();
return ts_node_named_child(this, index);
}
/**
* Get the node's type as a string.
*
* @return The node's type.
*/
public String getType(){
asserNotNull();
return ts_node_type(this);
}
/**
* Get the node's type as a numerical id.
*
* @return The node's type id.
*/
public int getSymbol(){
asserNotNull();
return ts_node_symbol(this);
}
/**
* Check if the node is null. Functions like {@link #getChild(int) getChild()} and
* {@link #getNextSibling()} will return a null node to indicate that no such node
* was found.
*
* @return True if the node is a null node.
*/
public boolean isNull(){
return TSParser.ts_node_is_null(this);
}
/**
* Check if the node is *named*. Named nodes correspond to named rules in the
* grammar, whereas *anonymous* nodes correspond to string literals in the
* grammar.
*
* @return True if the node is a named node.
*/
public boolean isNamed(){
asserNotNull();
return ts_node_is_named(this);
}
/**
* Check if the node is *missing*. Missing nodes are inserted by the parser in
* order to recover from certain kinds of syntax errors.
*
* @return True if the node is a missing node.
*/
public boolean isMissing(){
asserNotNull();
return ts_node_is_missing(this);
}
/**
* Check if the node is *extra*. Extra nodes represent things like comments,
* which are not required the grammar, but can appear anywhere.
*
* @return True if the node is an extra node.
*/
public boolean isExtra(){
asserNotNull();
return ts_node_is_extra(this);
}
/**
* Check if a syntax node has been edited.
*
* @return True if the node has been edited.
*/
public boolean hasChanges(){
asserNotNull();
return ts_node_has_changes(this);
}
/**
* Check if the node is a syntax error or contains any syntax errors.
*
* @return True if the node is a syntax error.
*/
public boolean hasError(){
asserNotNull();
return ts_node_has_error(this);
}
/**
* Get the node's start byte.
*
* @return The node's start byte.
*/
public int getStartByte(){
asserNotNull();
return ts_node_start_byte(this);
}
/**
* Get the node's end byte.
*
* @return The node's end byte.
*/
public int getEndByte(){
asserNotNull();
return ts_node_end_byte(this);
}
/**
* Get the node's start position in terms of rows and columns.
*
* @return The node's start position.
*/
public TSPoint getStartPoint(){
asserNotNull();
return ts_node_start_point(this);
}
/**
* Get the node's end position in terms of rows and columns.
*
* @return The node's end position.
*/
public TSPoint getEndPoint(){
asserNotNull();
return ts_node_end_point(this);
}
/**
* Get the node's immediate parent.
*
* @return The node's parent.
*/
public TSNode getParent(){
asserNotNull();
return ts_node_parent(this);
}
/**
* Get the node's child at the given index, where zero represents the first
* child.
*
* @param index The index of the child to get.
*
* @return The node's child at the given index.
*/
public TSNode getChild(int index){
asserNotNull();
return ts_node_child(this, index);
}
/**
* Get the field name for node's child at the given index, where zero represents
* the first child. Returns null, if no field is found.
*
* @param index The index of the child to get.
*
* @return The field name for the node's child at the given index.
*/
public String getFieldNameForChild(int index){
asserNotNull();
return ts_node_field_name_for_child(this, index);
}
/**
* Get the node's next *named* sibling.
*
* @return The node's next *named* sibling.
*/
public TSNode getNextNamedSibling(){
asserNotNull();
return ts_node_next_named_sibling(this);
}
/**
* Get the node's previous *named* sibling.
*
* @return The node's previous *named* sibling.
*/
public TSNode getPrevNamedSibling(){
asserNotNull();
return ts_node_prev_named_sibling(this);
}
/**
* Get the node's next sibling.
*
* @return The node's next sibling.
*/
public TSNode getNextSibling(){
asserNotNull();
return ts_node_next_sibling(this);
}
/**
* Get the node's previous sibling.
*
* @return the node's previous sibling.
*/
public TSNode getPrevSibling(){
asserNotNull();
return ts_node_prev_sibling(this);
}
/**
* Get the node's child with the given field name.
*
* @param fieldName The field name of the child to get.
*
* @return The node's child with the given field name.
*/
public TSNode getChildByFieldName(String fieldName){
asserNotNull();
return ts_node_child_by_field_name(this, fieldName);
}
/**
* Get the node's child with the given numerical field id.
*
* You can convert a field name to an id using the
* {@link TSLanguage#fieldIdForName(String) fieldIdForName()} function.
*
* @param fieldId The field id of the child to get.
*
* @return The node's child with the given field id.
*/
public TSNode getChildByFieldId(int fieldId){
asserNotNull();
return ts_node_child_by_field_id(this, fieldId);
}
/**
* Get the node's first child that extends beyond the given byte offset.
*
* @param startByte The byte offset to search.
*
* @return The node's first child that beyond the given byte offset.
*/
public TSNode getFirstChildForByte(int startByte){
asserNotNull();
return ts_node_first_child_for_byte(this, startByte);
}
/**
* Get the node's first named child that extends beyond the given byte offset.
*
* @param startByte The byte offset to search.
*
* @return The node's first named child that beyond the given byte offset.
*/
public TSNode getFirstNamedChildForByte(int startByte){
asserNotNull();
return ts_node_first_named_child_for_byte(this, startByte);
}
/**
* Get the smallest node within this node that spans the given range of bytes.
*
* @param startByte The start byte offset to search.
* @param endByte The end byte offset to search.
*
* @return The smallest node within this node that spans the given range of bytes.
*/
public TSNode getDescendantForByteRange(int startByte, int endByte){
asserNotNull();
return ts_node_descendant_for_byte_range(this, startByte, endByte);
}
/**
* Get the smallest node within this node that spans the given (row, column) positions.
*
* @param startPoint the start point to search.
* @param endPoint the end point to search.
*
* @return The smallest node within this node that spans the given range of positions.
*/
public TSNode getDescendantForPointRange(TSPoint startPoint, TSPoint endPoint){
asserNotNull();
return ts_node_descendant_for_point_range(this, startPoint, endPoint);
}
/**
* Get the smallest named node within this node that spans the given range of
* bytes.
*
* @param startByte the start byte to search.
* @param endByte the end byte to search.
*
* @return The smallest named node within this node that spans the given range of bytes.
*/
public TSNode getNamedDescendantForByteRange(int startByte, int endByte){
asserNotNull();
return ts_node_named_descendant_for_byte_range(this, startByte, endByte);
}
/**
* Get the smallest named node within this node that spans the given range of
* (row, column) positions.
* @param startPoint the start point to search.
* @param endPoint the end point to search.
*
* @return The smallest named node within this node that spans the given range of positions.
*/
public TSNode getNamedDescendantForPointRange(TSPoint startPoint, TSPoint endPoint){
asserNotNull();
return ts_node_named_descendant_for_point_range(this, startPoint, endPoint);
}
/**
* Edit the node to keep it in-sync with source code that has been edited.
*
* This function is only rarely needed. When you edit a syntax tree with the
* {@link TSTree#edit(TSInputEdit) TStree#edit()} function, all the nodes that you retrieve from the tree
* afterward will already reflect the edit. You only need to use this function
* when you have a {@link TSNode} instance that you want to keep and continue to use
* after an edit.
*
* @param inputEdit the edit to apply to the node.
*/
public void edit(TSInputEdit inputEdit){
asserNotNull();
TSNode tsNode = ts_node_edit(this, inputEdit);
context0 = tsNode.context0;
context1 = tsNode.context1;
context2 = tsNode.context2;
context3 = tsNode.context3;
idPtr = tsNode.idPtr;
treePtr = tsNode.treePtr;
}
/**
* Check if two nodes are identical.
*
* @param a The first node to compare.
* @param b The second node to compare.
*
* @return Whether the two nodes are identical.
*/
public static boolean eq(TSNode a, TSNode b){
if(a.isNull() || b.isNull()){
return false;
}
return ts_node_eq(a, b);
}
/**
* Get an S-expression representing the node as a string.
*/
@Override
public String toString() {
if(isNull()){
return "null";
}
return TSParser.ts_node_string(this);
}
/**
* Get the node's type as it appears in the grammar ignoring aliases as a string.
*
* @return Node grammar type
*/
public String getGrammarType(){
asserNotNull();
return TSParser.ts_node_grammar_type(this);
}
/**
* Get the node's type as a numerical id as it appears in the grammar ignoring
* aliases. This should be used in {@link TSLanguage#nextState(int, int)} instead of {@link TSNode#getSymbol()}
*
* @return Node grammar symbol
*/
public int getGrammarSymbol(){
asserNotNull();
return TSParser.ts_node_grammar_symbol(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy