diff options
| author | Christian Clason <c.clason@uni-graz.at> | 2022-09-06 08:50:06 +0200 |
|---|---|---|
| committer | Christian Clason <c.clason@uni-graz.at> | 2022-09-06 10:15:23 +0200 |
| commit | 95fd1ad83e24bbb14cc084fb001251939de6c0a9 (patch) | |
| tree | 1cee4c32523e3c3f46e4c70719603de93340967a /runtime/doc | |
| parent | ffe98531b9a6a90a7f4a7ae2105b3c50ad9332fd (diff) | |
| download | rneovim-95fd1ad83e24bbb14cc084fb001251939de6c0a9.tar.gz rneovim-95fd1ad83e24bbb14cc084fb001251939de6c0a9.tar.bz2 rneovim-95fd1ad83e24bbb14cc084fb001251939de6c0a9.zip | |
refactor(treesitter): get_{nodes,captures}_at_{position,cursor}
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/treesitter.txt | 39 |
1 files changed, 36 insertions, 3 deletions
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index 8d5e494601..afbece1088 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -370,6 +370,15 @@ attribute: > ============================================================================== Lua module: vim.treesitter *lua-treesitter-core* +get_captures_at_cursor({winnr}) *get_captures_at_cursor()* + Gets a list of captures under the cursor + + Parameters: ~ + {winnr} (number|nil) Window handle or 0 for current window (default) + + Return: ~ + (table) Named node under the cursor + *get_captures_at_position()* get_captures_at_position({bufnr}, {row}, {col}) Gets a list of captures for a given cursor position @@ -380,7 +389,31 @@ get_captures_at_position({bufnr}, {row}, {col}) {col} (number) Position column Return: ~ - (table) A table of captures + (table) Table of captures + +get_node_at_cursor({winnr}) *get_node_at_cursor()* + Gets the smallest named node under the cursor + + Parameters: ~ + {winnr} (number|nil) Window handle or 0 for current window (default) + + Return: ~ + (string) Named node under the cursor + + *get_node_at_position()* +get_node_at_position({bufnr}, {row}, {col}, {opts}) + Gets the smallest named node at position + + Parameters: ~ + {bufnr} (number) Buffer number (0 for current buffer) + {row} (number) Position row + {col} (number) Position column + {opts} (table) Optional keyword arguments: + • ignore_injections boolean Ignore injected languages + (default true) + + Return: ~ + (table) Named node under the cursor get_node_range({node_or_range}) *get_node_range()* Get the node's range or unpack a range table @@ -389,7 +422,7 @@ get_node_range({node_or_range}) *get_node_range()* {node_or_range} (table) Return: ~ - start_row, start_col, end_row, end_col + (table) start_row, start_col, end_row, end_col get_parser({bufnr}, {lang}, {opts}) *get_parser()* Gets the parser for this bufnr / ft combination. @@ -398,7 +431,7 @@ get_parser({bufnr}, {lang}, {opts}) *get_parser()* callback Parameters: ~ - {bufnr} (number|nil) Buffer the parser should be tied to: (default + {bufnr} (number|nil) Buffer the parser should be tied to (default: current buffer) {lang} (string) |nil Filetype of this parser (default: buffer filetype) |