/ 
Text-Treesitter-0.01
River stage zero No dependents
/ Text::Treesitter::Node

NAME

Text::Treesitter::Node - an element of a tree-sitter parse result

SYNOPSIS

TODO

DESCRIPTION

The result of a parse operation is a tree of nodes represented by instances of this class, which are all stored in an instance of Text::Treesitter::Tree. Most of the work of handling the result of a parse operation is done by operating on these tree nodes.

METHODS

type

$type = $node->type;

Returns a description string giving the name of the grammar rule (or directly an input string for anonymous nodes).

start_byte

$pos = $node->start_byte;

Returns the offset into the input string where this node's extent begins

end_byte

$pos = $node->end_byte;

Returns the offset into the input string just past where this node's extent finishes (i.e. the first byte of the input string that is not part of this node).

start_point

( $line, $col ) = $node->start_point;

Returns the position in the input text where this node's extent begins, split into a line and column number (both 0-based; the string is considered to start at position (0, 0)).

end_point

( $line, $col ) = $node->start_point;

Returns the position in the input text just past where this node's extent finishes, split into a line and column number (both 0-based).

is_named

$bool = $node->is_named;

Returns true if the node represents a named rule in the grammar.

is_missing

$bool = $node->is_missing;

Returns true if the node was inserted by the parser to recover from certain kinds of syntax error.

is_extra

$bool = $node->is_extra;

Returns true if the node represents something which is not required by the grammar but could appear anywhere (for example, a comment).

has_error

$bool = $node->has_error;

Returns true if the node or any of its descendents represents a syntax error.

parent

$parent = $node->parent;

Returns the node's immediate parent; the node from which this node was obtained.

child_count

$count = $node->child_count;

Returns the number of child nodes contained by this one.

child_nodes

@nodes = $node->child_nodes;

Returns a list of child nodes. The length of the returned list will the size given by "child_count".

field_names_with_child_nodes

@kvlist = $node->field_names_with_child_nodes;

Returns an even-length key/value list containing field names associated with child nodes. The list will be twice as long as the size given by "child_count" and consist of pairs. In each pair, the first value is either a field name or undef if the node has no field name, and the second is the child node itself.

On Perl version 5.36 or above, the multi-variable foreach list syntax may be useful to handle these:

foreach my ($name, $child) ($node->field_names_with_child_nodes) {
   ...
}

On earlier version, the List::Util pair functions such as pairs might be used instead:

use List::Util 'pairs';

foreach (pairs $node->field_names_with_child_nodes) {
   my ($name, $child) = @$_;
   ...
}

TODO

The following C library functions are currently unhandled:

ts_node_child_by_field_name
ts_node_child_by_field_id
ts_node_next_sibling
ts_node_prev_sibling
ts_node_next_named_sibling
ts_node_prev_named_sibling
ts_node_first_child_for_byte
ts_node_first_named_child_for_byte
ts_node_descendant_for_byte_range
ts_node_descendant_for_point_range
ts_node_named_descendant_for_byte_range
ts_node_named_descendant_for_point_range
ts_node_edit
ts_node_eq

AUTHOR

Paul Evans <leonerd@leonerd.org.uk>