NAME
Text::Treesitter::Query - represents a set of tree-sitter query patterns
SYNOPSIS
TODODESCRIPTION
Instances of this class represent a set of query patterns that can be performed against a node tree. Each pattern describes a shape of nodes in the tree by their type, and assigns certain nodes within that subtree to named captures. This is somewhat analogous to named captures in regexp matches.
Typically an application will load just one of these for the lifetime of its operation; or at least, just one per type of language being parsed and query being performed against it.
Queries are specified in a the form of a string containing a list of patterns expressed in S-expressions. The full format is described in the tree-sitter documentation at https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries
CONSTRUCTOR
new
$query = Text::Treesitter::Query->new( $lang, $src );Returns a new query instance associated with the given Text::Treesitter::Language instance, by reading query specifications from the given source string.
METHODS
pattern_count
$count = $query->pattern_count;Returns the number of query patterns defined by the query source.
capture_count
$count = $query->capture_count;Returns the number of capture names.
string_count
$count = $query->string_count;Returns the number of string values.
capture_name_for_id
$name = $query->capture_name_for_id( $id );Returns the name of the capture at the given capture index.
string_value_for_id
$value = $query->string_value_for_id( $id );Returns the value of a string at the given string index.
TODO
The following C library functions are currently unhandled:
ts_query_start_byte_for_pattern
ts_query_predicates_for_pattern
ts_query_is_pattern_rooted
ts_query_is_pattern_guaranteed_at_step
ts_query_capture_quantifier_for_id
ts_query_disable_capture
ts_query_disable_patternAUTHOR
Paul Evans <leonerd@leonerd.org.uk>