procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* doc/lispref/parsing.texi (Retrieving Nodes): Improve documentation.

Browse source 
Update optional arguments 'predicate' and 'include-node'
of 'treesit-node-top-level'.
This commit is contained in:
Juri Linkov 2024-02-04 19:22:21 +02:00
parent d0673ea0d4
commit 4749699370
2 changed files with 15 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

25
doc/lispref/parsing.texi
View file

@ -785,7 +785,7 @@ that comes after it in the buffer position order, i.e., nodes with
start positions greater than the end position of @var{start}. start positions greater than the end position of @var{start}.
In the tree shown above, @code{treesit-search-subtree} traverses node In the tree shown above, @code{treesit-search-subtree} traverses node
@samp{S} (@var{start}) and nodes marked with @code{o}, where this @samp{S} (@var{start}) and nodes marked with @code{o}, whereas this
function traverses the nodes marked with numbers. This function is function traverses the nodes marked with numbers. This function is
useful for answering questions like ``what is the first node after useful for answering questions like ``what is the first node after
@var{start} in the buffer that satisfies some condition?'' @var{start} in the buffer that satisfies some condition?''
@ -860,32 +860,35 @@ nodes.
@defun treesit-parent-until node predicate &optional include-node @defun treesit-parent-until node predicate &optional include-node
This function repeatedly finds the parents of @var{node}, and returns This function repeatedly finds the parents of @var{node}, and returns
the parent that satisfies @var{pred}, a function that takes a node as the parent that satisfies @var{predicate}, a function that takes a node as
argument and returns a boolean that indicates a match. If no parent argument and returns a boolean that indicates a match. If no parent
satisfies @var{pred}, this function returns @code{nil}. satisfies @var{predicate}, this function returns @code{nil}.
Normally this function only looks at the parents of @var{node} but not Normally this function only looks at the parents of @var{node} but not
@var{node} itself. But if @var{include-node} is non-@code{nil}, this @var{node} itself. But if @var{include-node} is non-@code{nil}, this
function returns @var{node} if @var{node} satisfies @var{pred}. function returns @var{node} if @var{node} satisfies @var{predicate}.
@end defun @end defun
@defun treesit-parent-while node pred @defun treesit-parent-while node predicate
This function goes up the tree starting from @var{node}, and keeps This function goes up the tree starting from @var{node}, and keeps
doing so as long as the nodes satisfy @var{pred}, a function that doing so as long as the nodes satisfy @var{predicate}, a function that
takes a node as argument. That is, this function returns the highest takes a node as argument. That is, this function returns the highest
parent of @var{node} that still satisfies @var{pred}. Note that if parent of @var{node} that still satisfies @var{predicate}. Note that if
@var{node} satisfies @var{pred} but its immediate parent doesn't, @var{node} satisfies @var{predicate} but its immediate parent doesn't,
@var{node} itself is returned. @var{node} itself is returned.
@end defun @end defun
@defun treesit-node-top-level node &optional type @defun treesit-node-top-level node &optional predicate include-node
This function returns the highest parent of @var{node} that has the This function returns the highest parent of @var{node} that has the
same type as @var{node}. If no such parent exists, it returns same type as @var{node}. If no such parent exists, it returns
@code{nil}. Therefore this function is also useful for testing @code{nil}. Therefore this function is also useful for testing
whether @var{node} is top-level. whether @var{node} is top-level.
If @var{type} is non-@code{nil}, this function matches each parent's If @var{predicate} is @code{nil}, this function uses @var{node}'s type
type with @var{type} as a regexp, rather than using @var{node}'s type. to find the parent. If @var{predicate} is non-@code{nil}, this
function searches the parent that satisfies @var{predicate}. If
@var{include-node} is non-@code{nil}, this function returns @var{node}
if @var{node} satisfies @var{predicate}.
@end defun @end defun
@node Accessing Node Information @node Accessing Node Information

2
test/src/treesit-tests.el
View file

@ -243,7 +243,7 @@
(should (eq nil (treesit-node-text (should (eq nil (treesit-node-text
(treesit-search-subtree (treesit-search-subtree
subarray "\\[")))) subarray "\\["))))
;; If ALL=nil, searching for number should still find the ;; If ALL=t, searching for number should still find the
;; numbers. ;; numbers.
(should (equal "1" (treesit-node-text (should (equal "1" (treesit-node-text
(treesit-search-subtree (treesit-search-subtree