kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-23 20:55:18 -07:00
Code Issues Packages Projects Releases Wiki Activity

fix(treesitter): add opts to iter_captures

Browse Source
This commit is contained in:
Danielkonge 2024-06-02 00:28:53 +02:00
parent 7a8f42dc03
commit f2109fba34
2 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/doc/treesitter.txt
View File

@ -1151,7 +1151,7 @@ parse({lang}, {query}) *vim.treesitter.query.parse()*
• |vim.treesitter.query.get()|
*Query:iter_captures()*
Query:iter_captures({node}, {source}, {start}, {stop})
Query:iter_captures({node}, {source}, {start}, {stop}, {opts})
Iterate over all captures from all matches inside {node}
{source} is needed if the query contains predicates; then the caller must
@ -1185,6 +1185,12 @@ Query:iter_captures({node}, {source}, {start}, {stop})
`node:start()`.
• {stop} (`integer?`) Stopping line for the search (end-exclusive).
Defaults to `node:end_()`.
• {opts} (`table?`) Optional keyword arguments:
• max_start_depth (integer) if non-zero, sets the maximum
start depth for each match. This is used to prevent
traversing too deep into a tree.
• match_limit (integer) Set the maximum number of
in-progress matches (Default: 256).
Return: ~
(`fun(end_line: integer?): integer, TSNode, vim.treesitter.query.TSMetadata, TSQueryMatch`)

11
runtime/lua/vim/treesitter/query.lua
View File

@ -847,19 +847,26 @@ end
---@param source (integer|string) Source buffer or string to extract text from
---@param start? integer Starting line for the search. Defaults to `node:start()`.
---@param stop? integer Stopping line for the search (end-exclusive). Defaults to `node:end_()`.
---@param opts? table Optional keyword arguments:
--- - max_start_depth (integer) if non-zero, sets the maximum start depth
--- for each match. This is used to prevent traversing too deep into a tree.
--- - match_limit (integer) Set the maximum number of in-progress matches (Default: 256).
---
---@return (fun(end_line: integer|nil): integer, TSNode, vim.treesitter.query.TSMetadata, TSQueryMatch):
--- capture id, capture node, metadata, match
---
---@note Captures are only returned if the query pattern of a specific capture contained predicates.
function Query:iter_captures(node, source, start, stop)
function Query:iter_captures(node, source, start, stop, opts)
opts = opts or {}
opts.match_limit = opts.match_limit or 256
if type(source) == 'number' and source == 0 then
source = api.nvim_get_current_buf()
end
start, stop = value_or_node_range(start, stop, node)
local cursor = vim._create_ts_querycursor(node, self.query, start, stop, { match_limit = 256 })
local cursor = vim._create_ts_querycursor(node, self.query, start, stop, opts)
local apply_directives = memoize(match_id_hash, self.apply_directives, true)
local match_preds = memoize(match_id_hash, self.match_preds, true)