diff options
Diffstat (limited to 'doc/lispref/parsing.texi')
| -rw-r--r-- | doc/lispref/parsing.texi | 50 |
1 files changed, 49 insertions, 1 deletions
diff --git a/doc/lispref/parsing.texi b/doc/lispref/parsing.texi index cba323d3a56..38c9ec8c2f0 100644 --- a/doc/lispref/parsing.texi +++ b/doc/lispref/parsing.texi @@ -849,6 +849,53 @@ Each node in the returned tree looks like @heading More convenience functions +@defun treesit-node-get node instructions +This is a convenience function that chains together multiple node +accessor functions together. For example, to get @var{node}'s +parent's next sibling's second child's text: + +@example +@group +(treesit-node-get node + '((parent 1) + (sibling 1 nil) + (child 1 nil) + (text nil))) +@end group +@end example + +@var{instruction} is a list of INSTRUCTIONs of the form +@w{@code{(@var{fn} @var{arg}...)}}. The following @var{fn}'s are +supported: + +@table @code +@item (child @var{idx} @var{named}) +Get the @var{idx}'th child. + +@item (parent @var{n}) +Go to parent @var{n} times. + +@item (field-name) +Get the field name of the current node. + +@item (type) +Get the type of the current node. + +@item (text @var{no-property}) +Get the text of the current node. + +@item (children @var{named}) +Get a list of children. + +@item (sibling @var{step} @var{named}) +Get the nth prev/next sibling, negative @var{step} means prev sibling, +positive means next sibling. +@end table + +Note that arguments like @var{named} and @var{no-property} can't be +omitted, unlike in their original functions. +@end defun + @defun treesit-filter-child node predicate &optional named This function finds immediate children of @var{node} that satisfy @var{predicate}. @@ -1311,7 +1358,8 @@ matches regular expression @var{regexp}. Matching is case-sensitive. @deffn Predicate pred fn &rest nodes Matches if function @var{fn} returns non-@code{nil} when passed each -node in @var{nodes} as arguments. +node in @var{nodes} as arguments. The function runs with the current +buffer set to the buffer of node being queried. @end deffn Note that a predicate can only refer to capture names that appear in |