traxys/tree-sitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make ts_tree_get_changed_ranges less confusing

Browse source
This commit is contained in:
Max Brunsfeld 2019-10-28 15:32:52 -07:00
parent 124ae30138
commit 42dfba29c6
2 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

10
lib/include/tree_sitter/api.h
View file

@ -355,14 +355,14 @@ const TSLanguage *ts_tree_language(const TSTree *);
void ts_tree_edit(TSTree *self, const TSInputEdit *edit);
/**
* Compare a new syntax tree to a previous syntax tree representing the same
* 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,
* passing in the new tree that was returned from `ts_parser_parse` and the old
* tree that was passed as a parameter.
* 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
@ -370,7 +370,7 @@ void ts_tree_edit(TSTree *self, const TSInputEdit *edit);
*/
TSRange *ts_tree_get_changed_ranges(
const TSTree *old_tree,
const TSTree *self,
const TSTree *new_tree,
uint32_t *length
);