libc

nothrow @nogc void ts_set_allocator(void* function(ulong), void* function(ulong, ulong), void* function(void*, ulong), void function(void*));

Set the allocation functions used by the library.

By default, Tree-sitter uses the standard libc allocation functions, but aborts the process when an allocation fails. This function lets you supply alternative allocation functions at runtime.

If you pass NULL for any parameter, Tree-sitter will switch back to its default implementation of that function.

If you call this function after the library has already been used, then you must ensure that either:

1. All the existing objects have been freed.
2. The new allocator shares its state with the old one, so it is capable of freeing memory that was allocated by the old allocator.

nothrow @nogc uint ts_language_version(const(TSLanguage)*);

Get the ABI version number for this language. This version number is used to ensure that languages were generated by a compatible version of Tree-sitter.

See also ts_parser_set_language.

nothrow @nogc TSSymbolType ts_language_symbol_type(const(TSLanguage)*, ushort);

Check whether the given node type id belongs to named nodes, anonymous nodes, or a hidden nodes.

See also ts_node_is_named. Hidden nodes are never returned from the API.

nothrow @nogc ushort ts_language_field_id_for_name(const(TSLanguage)*, const(char)*, uint);

Get the numerical id for the given field name string.

nothrow @nogc const(char)* ts_language_field_name_for_id(const(TSLanguage)*, ushort);

Get the field name string for the given numerical id.

nothrow @nogc uint ts_language_field_count(const(TSLanguage)*);

Get the number of distinct field names in the language.

nothrow @nogc ushort ts_language_symbol_for_name(const(TSLanguage)*, const(char)*, uint, bool);

Get the numerical id for the given node type string.

nothrow @nogc const(char)* ts_language_symbol_name(const(TSLanguage)*, ushort);

Get a node type string for the given numerical id.

nothrow @nogc uint ts_language_symbol_count(const(TSLanguage)*);

Get the number of distinct node types in the language.

nothrow @nogc bool ts_query_cursor_next_capture(TSQueryCursor*, TSQueryMatch*, uint*);

Advance to the next capture of the currently running query.

If there is a capture, write its match to *match and its index within the matche's capture list to *capture_index. Otherwise, return false.

nothrow @nogc bool ts_query_cursor_next_match(TSQueryCursor*, TSQueryMatch*);

Advance to the next match of the currently running query.

If there is a match, write it to *match and return true. Otherwise, return false.

nothrow @nogc void ts_query_cursor_set_byte_range(TSQueryCursor*, uint, uint);

Set the range of bytes or (row, column) positions in which the query will be executed.

nothrow @nogc bool ts_query_cursor_did_exceed_match_limit(const(TSQueryCursor)*);

Manage the maximum number of in-progress matches allowed by this query cursor.

Query cursors have an optional maximum capacity for storing lists of in-progress captures. If this capacity is exceeded, then the earliest-starting match will silently be dropped to make room for further matches. This maximum capacity is optional — by default, query cursors allow any number of pending matches, dynamically allocating new space for them as needed as the query is executed.

nothrow @nogc void ts_query_cursor_exec(TSQueryCursor*, const(TSQuery)*, TSNode);

Start running a given query on a given node.

nothrow @nogc void ts_query_cursor_delete(TSQueryCursor*);

Delete a query cursor, freeing all of the memory that it used.

nothrow @nogc TSQueryCursor* ts_query_cursor_new();

Create a new cursor for executing a given query.

The cursor stores the state that is needed to iteratively search for matches. To use the query cursor, first call ts_query_cursor_exec to start running a given query on a given syntax node. Then, there are two options for consuming the results of the query:

1. Repeatedly call ts_query_cursor_next_match to iterate over all of the matches in the order that they were found. Each match contains the index of the pattern that matched, and an array of captures. Because multiple patterns can match the same set of nodes, one match may contain captures that appear before some of the captures from a previous match.
2. Repeatedly call ts_query_cursor_next_capture to iterate over all of the individual captures in the order that they appear. This is useful if don't care about which pattern matched, and just want a single ordered sequence of captures.

If you don't care about consuming all of the results, you can stop calling ts_query_cursor_next_match or ts_query_cursor_next_capture at any point. You can then start executing another query on another node by calling ts_query_cursor_exec again.

nothrow @nogc void ts_query_disable_pattern(TSQuery*, uint);

Disable a certain pattern within a query.

This prevents the pattern from matching and removes most of the overhead associated with the pattern. Currently, there is no way to undo this.

nothrow @nogc void ts_query_disable_capture(TSQuery*, const(char)*, uint);

Disable a certain capture within a query.

This prevents the capture from being returned in matches, and also avoids any resource usage associated with recording the capture. Currently, there is no way to undo this.

nothrow @nogc TSQuantifier ts_query_capture_quantifier_for_id(const(TSQuery)*, uint, uint);

Get the quantifier of the query's captures. Each capture is * associated with a numeric id based on the order that it appeared in the query's source.

nothrow @nogc const(char)* ts_query_capture_name_for_id(const(TSQuery)*, uint, uint*);

Get the name and length of one of the query's captures, or one of the query's string literals. Each capture and string is associated with a numeric id based on the order that it appeared in the query's source.

nothrow @nogc const(TSQueryPredicateStep)* ts_query_predicates_for_pattern(const(TSQuery)*, uint, uint*);

Get all of the predicates for the given pattern in the query.

The predicates are represented as a single array of steps. There are three types of steps in this array, which correspond to the three legal values for the type field:

• TSQueryPredicateStepTypeCapture - Steps with this type represent names of captures. Their value_id can be used with the ts_query_capture_name_for_id function to obtain the name of the capture.
• TSQueryPredicateStepTypeString - Steps with this type represent literal strings. Their value_id can be used with the ts_query_string_value_for_id function to obtain their string value.
• TSQueryPredicateStepTypeDone - Steps with this type are sentinels that represent the end of an individual predicate. If a pattern has two predicates, then there will be two steps with this type in the array.

nothrow @nogc uint ts_query_start_byte_for_pattern(const(TSQuery)*, uint);

Get the byte offset where the given pattern starts in the query's source.

This can be useful when combining queries by concatenating their source code strings.

nothrow @nogc uint ts_query_pattern_count(const(TSQuery)*);

Get the number of patterns, captures, or string literals in the query.

nothrow @nogc void ts_query_delete(TSQuery*);

Delete a query, freeing all of the memory that it used.

nothrow @nogc TSQuery* ts_query_new(const(TSLanguage)*, const(char)*, uint, uint*, TSQueryError*);

Create a new query from a string containing one or more S-expression patterns. The query is associated with a particular language, and can only be run on syntax nodes parsed with that language.

If all of the given patterns are valid, this returns a TSQuery. If a pattern is invalid, this returns NULL, and provides two pieces of information about the problem:

1. The byte offset of the error is written to the error_offset parameter.
2. The type of error is written to the error_type parameter.

nothrow @nogc long ts_tree_cursor_goto_first_child_for_byte(TSTreeCursor*, uint);

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

This returns the index of the child node if one was found, and returns -1 if no such child was found.

nothrow @nogc bool ts_tree_cursor_goto_first_child(TSTreeCursor*);

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.

nothrow @nogc bool ts_tree_cursor_goto_next_sibling(TSTreeCursor*);

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.

nothrow @nogc bool ts_tree_cursor_goto_parent(TSTreeCursor*);

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).

nothrow @nogc ushort ts_tree_cursor_current_field_id(const(TSTreeCursor)*);

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 ts_node_child_by_field_id, ts_language_field_id_for_name.

nothrow @nogc const(char)* ts_tree_cursor_current_field_name(const(TSTreeCursor)*);

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 ts_node_child_by_field_name.

nothrow @nogc TSNode ts_tree_cursor_current_node(const(TSTreeCursor)*);

Get the tree cursor's current node.

nothrow @nogc void ts_tree_cursor_reset(TSTreeCursor*, TSNode);

Re-initialize a tree cursor to start at a different node.

nothrow @nogc void ts_tree_cursor_delete(TSTreeCursor*);

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

nothrow @nogc TSTreeCursor ts_tree_cursor_new(TSNode);

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 TSNode functions. It is a mutable object that is always on a certain syntax node, and can be moved imperatively to different nodes.

nothrow @nogc bool ts_node_eq(TSNode, TSNode);

Check if two nodes are identical.

nothrow @nogc void ts_node_edit(TSNode*, const(TSInputEdit)*);

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 ts_tree_edit function, all of the nodes that you retrieve from the tree afterward will already reflect the edit. You only need to use ts_node_edit when you have a TSNode instance that you want to keep and continue to use after an edit.

nothrow @nogc TSNode ts_node_named_descendant_for_byte_range(TSNode, uint, uint);

Get the smallest named node within this node that spans the given range of bytes or (row, column) positions.

nothrow @nogc TSNode ts_node_descendant_for_byte_range(TSNode, uint, uint);

Get the smallest node within this node that spans the given range of bytes or (row, column) positions.

nothrow @nogc TSNode ts_node_first_named_child_for_byte(TSNode, uint);

Get the node's first named child that extends beyond the given byte offset.

nothrow @nogc TSNode ts_node_first_child_for_byte(TSNode, uint);

Get the node's first child that extends beyond the given byte offset.

nothrow @nogc TSNode ts_node_next_named_sibling(TSNode);

Get the node's next / previous named sibling.

nothrow @nogc TSNode ts_node_next_sibling(TSNode);

Get the node's next / previous sibling.

nothrow @nogc TSNode ts_node_child_by_field_id(TSNode, ushort);

Get the node's child with the given numerical field id.

You can convert a field name to an id using the ts_language_field_id_for_name function.

nothrow @nogc TSNode ts_node_child_by_field_name(TSNode, const(char)*, uint);

Get the node's child with the given field name.

nothrow @nogc uint ts_node_named_child_count(TSNode);

Get the node's number of named children.

See also ts_node_is_named.

nothrow @nogc TSNode ts_node_named_child(TSNode, uint);

Get the node's named child at the given index.

See also ts_node_is_named.

nothrow @nogc uint ts_node_child_count(TSNode);

Get the node's number of children.

nothrow @nogc const(char)* ts_node_field_name_for_child(TSNode, uint);

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.

nothrow @nogc TSNode ts_node_child(TSNode, uint);

Get the node's child at the given index, where zero represents the first child.

nothrow @nogc TSNode ts_node_parent(TSNode);

Get the node's immediate parent.

nothrow @nogc bool ts_node_has_error(TSNode);

Check if the node is a syntax error or contains any syntax errors.

nothrow @nogc bool ts_node_has_changes(TSNode);

Check if a syntax node has been edited.

nothrow @nogc bool ts_node_is_extra(TSNode);

Check if the node is extra. Extra nodes represent things like comments, which are not required the grammar, but can appear anywhere.

nothrow @nogc bool ts_node_is_missing(TSNode);

Check if the node is missing. Missing nodes are inserted by the parser in order to recover from certain kinds of syntax errors.

nothrow @nogc bool ts_node_is_named(TSNode);

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.

nothrow @nogc bool ts_node_is_null(TSNode);

Check if the node is null. Functions like ts_node_child and ts_node_next_sibling will return a null node to indicate that no such node was found.

nothrow @nogc char* ts_node_string(TSNode);

Get an S-expression representing the node as a string.

This string is allocated with malloc and the caller is responsible for freeing it using free.

nothrow @nogc TSPoint ts_node_end_point(TSNode);

Get the node's end position in terms of rows and columns.

nothrow @nogc uint ts_node_end_byte(TSNode);

Get the node's end byte.

nothrow @nogc TSPoint ts_node_start_point(TSNode);

Get the node's start position in terms of rows and columns.

nothrow @nogc uint ts_node_start_byte(TSNode);

Get the node's start byte.

nothrow @nogc ushort ts_node_symbol(TSNode);

Get the node's type as a numerical id.

nothrow @nogc const(char)* ts_node_type(TSNode);

Get the node's type as a null-terminated string.

nothrow @nogc void ts_tree_print_dot_graph(const(TSTree)*, _iobuf*);

Write a DOT graph describing the syntax tree to the given file.

nothrow @nogc TSRange* ts_tree_get_changed_ranges(const(TSTree)*, const(TSTree)*, uint*);

Compare an old edited syntax tree to a new syntax tree representing the same document, returning an array of ranges whose syntactic structure has changed.

For this to work correctly, the old syntax tree must have been edited such that its ranges match up to the new tree. Generally, you'll want to call this function right after calling one of the ts_parser_parse functions. You need to pass the old tree that was passed to parse, as well as the new tree that was returned from that function.

The returned array is allocated using malloc and the caller is responsible for freeing it using free. The length of the array will be written to the given length pointer.

nothrow @nogc void ts_tree_edit(TSTree*, const(TSInputEdit)*);

Edit the syntax tree to keep it in sync with source code that has been edited.

You must describe the edit both in terms of byte offsets and in terms of (row, column) coordinates.

nothrow @nogc const(TSLanguage)* ts_tree_language(const(TSTree)*);

Get the language that was used to parse the syntax tree.

nothrow @nogc TSNode ts_tree_root_node(const(TSTree)*);

Get the root node of the syntax tree.

nothrow @nogc void ts_tree_delete(TSTree*);

Delete the syntax tree, freeing all of the memory that it used.

nothrow @nogc TSTree* ts_tree_copy(const(TSTree)*);

Create a shallow copy of the syntax tree. This is very fast.

You need to copy a syntax tree in order to use it on more than one thread at a time, as syntax trees are not thread safe.

nothrow @nogc void ts_parser_print_dot_graphs(TSParser*, int);

Set the file descriptor to which the parser should write debugging graphs during parsing. The graphs are formatted in the DOT language. You may want to pipe these graphs directly to a dot(1) process in order to generate SVG output. You can turn off this logging by passing a negative number.

nothrow @nogc TSLogger ts_parser_logger(const(TSParser)*);

Get the parser's current logger.

nothrow @nogc void ts_parser_set_logger(TSParser*, TSLogger);

Set the logger that a parser should use during parsing.

The parser does not take ownership over the logger payload. If a logger was previously assigned, the caller is responsible for releasing any memory owned by the previous logger.

nothrow @nogc const(ulong)* ts_parser_cancellation_flag(const(TSParser)*);

Get the parser's current cancellation flag pointer.

nothrow @nogc void ts_parser_set_cancellation_flag(TSParser*, const(ulong)*);

Set the parser's current cancellation flag pointer.

If a non-null pointer is assigned, then the parser will periodically read from this pointer during parsing. If it reads a non-zero value, it will halt early, returning NULL. See ts_parser_parse for more information.

nothrow @nogc ulong ts_parser_timeout_micros(const(TSParser)*);

Get the duration in microseconds that parsing is allowed to take.

nothrow @nogc void ts_parser_set_timeout_micros(TSParser*, ulong);

Set the maximum duration in microseconds that parsing should be allowed to take before halting.

If parsing takes longer than this, it will halt early, returning NULL. See ts_parser_parse for more information.

nothrow @nogc void ts_parser_reset(TSParser*);

Instruct the parser to start the next parse from the beginning.

If the parser previously failed because of a timeout or a cancellation, then by default, it will resume where it left off on the next call to ts_parser_parse or other parsing functions. If you don't want to resume, and instead intend to use this parser to parse some other document, you must call ts_parser_reset first.

nothrow @nogc TSTree* ts_parser_parse_string_encoding(TSParser*, const(TSTree)*, const(char)*, uint, TSInputEncoding);

Use the parser to parse some source code stored in one contiguous buffer with a given encoding. The first four parameters work the same as in the ts_parser_parse_string method above. The final parameter indicates whether the text is encoded as UTF8 or UTF16.

nothrow @nogc TSTree* ts_parser_parse_string(TSParser*, const(TSTree)*, const(char)*, uint);

Use the parser to parse some source code stored in one contiguous buffer. The first two parameters are the same as in the ts_parser_parse function above. The second two parameters indicate the location of the buffer and its length in bytes.

nothrow @nogc TSTree* ts_parser_parse(TSParser*, const(TSTree)*, TSInput);

Use the parser to parse some source code and create a syntax tree.

If you are parsing this document for the first time, pass NULL for the old_tree parameter. Otherwise, if you have already parsed an earlier version of this document and the document has since been edited, pass the previous syntax tree so that the unchanged parts of it can be reused. This will save time and memory. For this to work correctly, you must have already edited the old syntax tree using the ts_tree_edit function in a way that exactly matches the source code changes.

The TSInput parameter lets you specify how to read the text. It has the following three fields:

1. read: A function to retrieve a chunk of text at a given byte offset and (row, column) position. The function should return a pointer to the text and write its length to the bytes_read pointer. The parser does not take ownership of this buffer; it just borrows it until it has finished reading it. The function should write a zero value to the bytes_read pointer to indicate the end of the document.
2. payload: An arbitrary pointer that will be passed to each invocation of the read function.
3. encoding: An indication of how the text is encoded. Either TSInputEncodingUTF8 or TSInputEncodingUTF16.

This function returns a syntax tree on success, and NULL on failure. There are three possible reasons for failure:

1. The parser does not have a language assigned. Check for this using the ts_parser_language function.
2. Parsing was cancelled due to a timeout that was set by an earlier call to the ts_parser_set_timeout_micros function. You can resume parsing from where the parser left out by calling ts_parser_parse again with the same arguments. Or you can start parsing from scratch by first calling ts_parser_reset.
3. Parsing was cancelled using a cancellation flag that was set by an earlier call to ts_parser_set_cancellation_flag. You can resume parsing from where the parser left out by calling ts_parser_parse again with the same arguments.

nothrow @nogc const(TSRange)* ts_parser_included_ranges(const(TSParser)*, uint*);

Get the ranges of text that the parser will include when parsing.

The returned pointer is owned by the parser. The caller should not free it or write to it. The length of the array will be written to the given length pointer.

nothrow @nogc bool ts_parser_set_included_ranges(TSParser*, const(TSRange)*, uint);

Set the ranges of text that the parser should include when parsing.

By default, the parser will always include entire documents. This function allows you to parse only a portion of a document but still return a syntax tree whose ranges match up with the document as a whole. You can also pass multiple disjoint ranges.

The second and third parameters specify the location and length of an array of ranges. The parser does not take ownership of these ranges; it copies the data, so it doesn't matter how these ranges are allocated.

If length is zero, then the entire document will be parsed. Otherwise, the given ranges must be ordered from earliest to latest in the document, and they must not overlap. That is, the following must hold for all i < length - 1: ranges[i].end_byte <= ranges[i + 1].start_byte

If this requirement is not satisfied, the operation will fail, the ranges will not be assigned, and this function will return false. On success, this function returns true

nothrow @nogc const(TSLanguage)* ts_parser_language(const(TSParser)*);

Get the parser's current language.

nothrow @nogc bool ts_parser_set_language(TSParser*, const(TSLanguage)*);

Set the language that the parser should use for parsing.

Returns a boolean indicating whether or not the language was successfully assigned. True means assignment succeeded. False means there was a version mismatch: the language was generated with an incompatible version of the Tree-sitter CLI. Check the language's version using ts_language_version and compare it to this library's TREE_SITTER_LANGUAGE_VERSION and TREE_SITTER_MIN_COMPATIBLE_LANGUAGE_VERSION constants.

nothrow @nogc void ts_parser_delete(TSParser*);

Delete the parser, freeing all of the memory that it used.

nothrow @nogc TSParser* ts_parser_new();

Create a new parser.

alias TSSymbol = ushort;