mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-05 19:08:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge #32810 docs

Browse Source
This commit is contained in:
Justin M. Keyes
2025-03-17 04:59:31 -07:00
committed by GitHub
parent d0cda9d6c5 f96606371c
commit 5440e59247
24 changed files with 425 additions and 382 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.editorconfig
View File

@@ -10,7 +10,7 @@ insert_final_newline = true
[*.{c,h,in,lua}] [*.{c,h,in,lua}]
max_line_length = 100 max_line_length = 100
[src/nvim/eval.lua] [src/nvim/{eval,vvars}.lua]
max_line_length = 68 max_line_length = 68
[*.py] [*.py]

101
runtime/doc/api.txt
View File

@@ -585,7 +585,7 @@ nvim_create_buf({listed}, {scratch}) *nvim_create_buf()*
buffer. buffer.
Return: ~ Return: ~
Buffer handle, or 0 on error Buffer id, or 0 on error
See also: ~ See also: ~
• buf_open_scratch • buf_open_scratch
@@ -835,7 +835,7 @@ nvim_get_current_buf() *nvim_get_current_buf()*
Since: 0.1.0 Since: 0.1.0
Return: ~ Return: ~
Buffer handle Buffer id
nvim_get_current_line() *nvim_get_current_line()* nvim_get_current_line() *nvim_get_current_line()*
Gets the current line. Gets the current line.
@@ -1087,7 +1087,7 @@ nvim_input_mouse({button}, {action}, {modifier}, {grid}, {row}, {col})
• {col} Mouse column-position (zero-based, like redraw events) • {col} Mouse column-position (zero-based, like redraw events)
nvim_list_bufs() *nvim_list_bufs()* nvim_list_bufs() *nvim_list_bufs()*
Gets the current list of buffer handles Gets the current list of buffers.
Includes unlisted (unloaded/deleted) buffers, like `:ls!`. Use Includes unlisted (unloaded/deleted) buffers, like `:ls!`. Use
|nvim_buf_is_loaded()| to check if a buffer is loaded. |nvim_buf_is_loaded()| to check if a buffer is loaded.
@@ -1096,7 +1096,7 @@ nvim_list_bufs() *nvim_list_bufs()*
Since: 0.1.0 Since: 0.1.0
Return: ~ Return: ~
List of buffer handles List of buffer ids
nvim_list_chans() *nvim_list_chans()* nvim_list_chans() *nvim_list_chans()*
Get information about all open channels. Get information about all open channels.
@@ -1147,7 +1147,7 @@ nvim_list_uis() *nvim_list_uis()*
• "chan" |channel-id| of remote UI • "chan" |channel-id| of remote UI
nvim_list_wins() *nvim_list_wins()* nvim_list_wins() *nvim_list_wins()*
Gets the current list of window handles. Gets the current list of all |window-ID|s in all tabpages.
Attributes: ~ Attributes: ~
Since: 0.1.0 Since: 0.1.0
@@ -1384,7 +1384,7 @@ nvim_set_current_buf({buffer}) *nvim_set_current_buf()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle • {buffer} Buffer id
nvim_set_current_dir({dir}) *nvim_set_current_dir()* nvim_set_current_dir({dir}) *nvim_set_current_dir()*
Changes the global working directory. Changes the global working directory.
@@ -1416,7 +1416,7 @@ nvim_set_current_tabpage({tabpage}) *nvim_set_current_tabpage()*
• {tabpage} |tab-ID| to focus • {tabpage} |tab-ID| to focus
nvim_set_current_win({window}) *nvim_set_current_win()* nvim_set_current_win({window}) *nvim_set_current_win()*
Sets the current window. Also changes tabpage, if necessary. Sets the current window (and tabpage, implicitly).
Attributes: ~ Attributes: ~
not allowed when |textlock| is active or in the |cmdwin| not allowed when |textlock| is active or in the |cmdwin|
@@ -1880,7 +1880,7 @@ nvim_buf_create_user_command({buffer}, {name}, {command}, {opts})
Since: 0.7.0 Since: 0.7.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer. • {buffer} Buffer id, or 0 for current buffer.
See also: ~ See also: ~
• nvim_create_user_command • nvim_create_user_command
@@ -1896,7 +1896,7 @@ nvim_buf_del_user_command({buffer}, {name})
Since: 0.7.0 Since: 0.7.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer. • {buffer} Buffer id, or 0 for current buffer.
• {name} Name of the command to delete. • {name} Name of the command to delete.
nvim_buf_get_commands({buffer}, {opts}) *nvim_buf_get_commands()* nvim_buf_get_commands({buffer}, {opts}) *nvim_buf_get_commands()*
@@ -1906,7 +1906,7 @@ nvim_buf_get_commands({buffer}, {opts}) *nvim_buf_get_commands()*
Since: 0.3.0 Since: 0.3.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {opts} Optional parameters. Currently not used. • {opts} Optional parameters. Currently not used.
Return: ~ Return: ~
@@ -2238,7 +2238,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
Since: 0.3.0 Since: 0.3.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {send_buffer} True if the initial notification should contain the • {send_buffer} True if the initial notification should contain the
whole buffer: first notification will be whole buffer: first notification will be
`nvim_buf_lines_event`. Else the first notification `nvim_buf_lines_event`. Else the first notification
@@ -2248,7 +2248,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
• on_lines: Lua callback invoked on change. Return a • on_lines: Lua callback invoked on change. Return a
truthy value (not `false` or `nil`) to detach. Args: truthy value (not `false` or `nil`) to detach. Args:
• the string "lines" • the string "lines"
• buffer handle • buffer id
• b:changedtick • b:changedtick
• first line that changed (zero-indexed) • first line that changed (zero-indexed)
• last line that was changed • last line that was changed
@@ -2261,7 +2261,7 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
change compared to on_lines. Return a truthy value change compared to on_lines. Return a truthy value
(not `false` or `nil`) to detach. Args: (not `false` or `nil`) to detach. Args:
• the string "bytes" • the string "bytes"
• buffer handle • buffer id
• b:changedtick • b:changedtick
• start row of the changed text (zero-indexed) • start row of the changed text (zero-indexed)
• start column of the changed text • start column of the changed text
@@ -2280,15 +2280,15 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
• on_changedtick: Lua callback invoked on changedtick • on_changedtick: Lua callback invoked on changedtick
increment without text change. Args: increment without text change. Args:
• the string "changedtick" • the string "changedtick"
• buffer handle • buffer id
• b:changedtick • b:changedtick
• on_detach: Lua callback invoked on detach. Args: • on_detach: Lua callback invoked on detach. Args:
• the string "detach" • the string "detach"
• buffer handle • buffer id
• on_reload: Lua callback invoked on reload. The entire • on_reload: Lua callback invoked on reload. The entire
buffer content should be considered changed. Args: buffer content should be considered changed. Args:
• the string "reload" • the string "reload"
• buffer handle • buffer id
• utf_sizes: include UTF-32 and UTF-16 size of the • utf_sizes: include UTF-32 and UTF-16 size of the
replaced region, as args to `on_lines`. replaced region, as args to `on_lines`.
• preview: also attach to command preview (i.e. • preview: also attach to command preview (i.e.
@@ -2320,7 +2320,7 @@ nvim_buf_call({buffer}, {fun}) *nvim_buf_call()*
Since: 0.5.0 Since: 0.5.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {fun} Function to call inside the buffer (currently Lua callable • {fun} Function to call inside the buffer (currently Lua callable
only) only)
@@ -2334,7 +2334,7 @@ nvim_buf_del_keymap({buffer}, {mode}, {lhs}) *nvim_buf_del_keymap()*
Since: 0.4.0 Since: 0.4.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
See also: ~ See also: ~
• |nvim_del_keymap()| • |nvim_del_keymap()|
@@ -2367,7 +2367,7 @@ nvim_buf_del_var({buffer}, {name}) *nvim_buf_del_var()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {name} Variable name • {name} Variable name
nvim_buf_delete({buffer}, {opts}) *nvim_buf_delete()* nvim_buf_delete({buffer}, {opts}) *nvim_buf_delete()*
@@ -2378,7 +2378,7 @@ nvim_buf_delete({buffer}, {opts}) *nvim_buf_delete()*
Since: 0.5.0 Since: 0.5.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {opts} Optional parameters. Keys: • {opts} Optional parameters. Keys:
• force: Force deletion and ignore unsaved changes. • force: Force deletion and ignore unsaved changes.
• unload: Unloaded only, do not delete. See |:bunload| • unload: Unloaded only, do not delete. See |:bunload|
@@ -2391,7 +2391,7 @@ nvim_buf_detach({buffer}) *nvim_buf_detach()*
Since: 0.3.0 Since: 0.3.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
Return: ~ Return: ~
False if detach failed (because the buffer isn't loaded); otherwise False if detach failed (because the buffer isn't loaded); otherwise
@@ -2408,7 +2408,7 @@ nvim_buf_get_changedtick({buffer}) *nvim_buf_get_changedtick()*
Since: 0.2.0 Since: 0.2.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
Return: ~ Return: ~
`b:changedtick` value. `b:changedtick` value.
@@ -2420,12 +2420,12 @@ nvim_buf_get_keymap({buffer}, {mode}) *nvim_buf_get_keymap()*
Since: 0.2.1 Since: 0.2.1
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {mode} Mode short-name ("n", "i", "v", ...) • {mode} Mode short-name ("n", "i", "v", ...)
Return: ~ Return: ~
Array of |maparg()|-like dictionaries describing mappings. The Array of |maparg()|-like dictionaries describing mappings. The
"buffer" key holds the associated buffer handle. "buffer" key holds the associated buffer id.
*nvim_buf_get_lines()* *nvim_buf_get_lines()*
nvim_buf_get_lines({buffer}, {start}, {end}, {strict_indexing}) nvim_buf_get_lines({buffer}, {start}, {end}, {strict_indexing})
@@ -2442,7 +2442,7 @@ nvim_buf_get_lines({buffer}, {start}, {end}, {strict_indexing})
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {start} First line index • {start} First line index
• {end} Last line index, exclusive • {end} Last line index, exclusive
• {strict_indexing} Whether out-of-bounds should be an error. • {strict_indexing} Whether out-of-bounds should be an error.
@@ -2450,6 +2450,9 @@ nvim_buf_get_lines({buffer}, {start}, {end}, {strict_indexing})
Return: ~ Return: ~
Array of lines, or empty array for unloaded buffer. Array of lines, or empty array for unloaded buffer.
See also: ~
• |nvim_buf_get_text()|
nvim_buf_get_mark({buffer}, {name}) *nvim_buf_get_mark()* nvim_buf_get_mark({buffer}, {name}) *nvim_buf_get_mark()*
Returns a `(row,col)` tuple representing the position of the named mark. Returns a `(row,col)` tuple representing the position of the named mark.
"End of line" column position is returned as |v:maxcol| (big number). See "End of line" column position is returned as |v:maxcol| (big number). See
@@ -2461,7 +2464,7 @@ nvim_buf_get_mark({buffer}, {name}) *nvim_buf_get_mark()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {name} Mark name • {name} Mark name
Return: ~ Return: ~
@@ -2479,7 +2482,7 @@ nvim_buf_get_name({buffer}) *nvim_buf_get_name()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
Return: ~ Return: ~
Buffer name Buffer name
@@ -2499,7 +2502,7 @@ nvim_buf_get_offset({buffer}, {index}) *nvim_buf_get_offset()*
Since: 0.3.2 Since: 0.3.2
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {index} Line index • {index} Line index
Return: ~ Return: ~
@@ -2508,10 +2511,8 @@ nvim_buf_get_offset({buffer}, {index}) *nvim_buf_get_offset()*
*nvim_buf_get_text()* *nvim_buf_get_text()*
nvim_buf_get_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col}, nvim_buf_get_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col},
{opts}) {opts})
Gets a range from the buffer. Gets a range from the buffer (may be partial lines, unlike
|nvim_buf_get_lines()|).
This differs from |nvim_buf_get_lines()| in that it allows retrieving only
portions of a line.
Indexing is zero-based. Row indices are end-inclusive, and column indices Indexing is zero-based. Row indices are end-inclusive, and column indices
are end-exclusive. are end-exclusive.
@@ -2522,7 +2523,7 @@ nvim_buf_get_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col},
Since: 0.7.0 Since: 0.7.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {start_row} First line index • {start_row} First line index
• {start_col} Starting column (byte offset) on first line • {start_col} Starting column (byte offset) on first line
• {end_row} Last line index, inclusive • {end_row} Last line index, inclusive
@@ -2539,7 +2540,7 @@ nvim_buf_get_var({buffer}, {name}) *nvim_buf_get_var()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {name} Variable name • {name} Variable name
Return: ~ Return: ~
@@ -2553,7 +2554,7 @@ nvim_buf_is_loaded({buffer}) *nvim_buf_is_loaded()*
Since: 0.3.2 Since: 0.3.2
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
Return: ~ Return: ~
true if the buffer is valid and loaded, false otherwise. true if the buffer is valid and loaded, false otherwise.
@@ -2569,7 +2570,7 @@ nvim_buf_is_valid({buffer}) *nvim_buf_is_valid()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
Return: ~ Return: ~
true if the buffer is valid, false otherwise. true if the buffer is valid, false otherwise.
@@ -2581,7 +2582,7 @@ nvim_buf_line_count({buffer}) *nvim_buf_line_count()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
Return: ~ Return: ~
Line count, or 0 for unloaded buffer. |api-buffer| Line count, or 0 for unloaded buffer. |api-buffer|
@@ -2594,7 +2595,7 @@ nvim_buf_set_keymap({buffer}, {mode}, {lhs}, {rhs}, {opts})
Since: 0.4.0 Since: 0.4.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
See also: ~ See also: ~
• |nvim_set_keymap()| • |nvim_set_keymap()|
@@ -2605,7 +2606,7 @@ nvim_buf_set_lines({buffer}, {start}, {end}, {strict_indexing}, {replacement})
Indexing is zero-based, end-exclusive. Negative indices are interpreted as Indexing is zero-based, end-exclusive. Negative indices are interpreted as
length+1+index: -1 refers to the index past the end. So to change or length+1+index: -1 refers to the index past the end. So to change or
delete the last element use start=-2 and end=-1. delete the last line use start=-2 and end=-1.
To insert lines at a given index, set `start` and `end` to the same index. To insert lines at a given index, set `start` and `end` to the same index.
To delete a range of lines, set `replacement` to an empty array. To delete a range of lines, set `replacement` to an empty array.
@@ -2618,7 +2619,7 @@ nvim_buf_set_lines({buffer}, {start}, {end}, {strict_indexing}, {replacement})
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {start} First line index • {start} First line index
• {end} Last line index, exclusive • {end} Last line index, exclusive
• {strict_indexing} Whether out-of-bounds should be an error. • {strict_indexing} Whether out-of-bounds should be an error.
@@ -2661,7 +2662,7 @@ nvim_buf_set_name({buffer}, {name}) *nvim_buf_set_name()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {name} Buffer name • {name} Buffer name
*nvim_buf_set_text()* *nvim_buf_set_text()*
@@ -2691,7 +2692,7 @@ nvim_buf_set_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col},
Since: 0.5.0 Since: 0.5.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {start_row} First line index • {start_row} First line index
• {start_col} Starting column (byte offset) on first line • {start_col} Starting column (byte offset) on first line
• {end_row} Last line index, inclusive • {end_row} Last line index, inclusive
@@ -2705,7 +2706,7 @@ nvim_buf_set_var({buffer}, {name}, {value}) *nvim_buf_set_var()*
Since: 0.1.0 Since: 0.1.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {name} Variable name • {name} Variable name
• {value} Variable value • {value} Variable value
@@ -2725,7 +2726,7 @@ nvim_buf_clear_namespace({buffer}, {ns_id}, {line_start}, {line_end})
Since: 0.3.2 Since: 0.3.2
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {ns_id} Namespace to clear, or -1 to clear all namespaces. • {ns_id} Namespace to clear, or -1 to clear all namespaces.
• {line_start} Start of range of lines to clear • {line_start} Start of range of lines to clear
• {line_end} End of range of lines to clear (exclusive) or -1 to • {line_end} End of range of lines to clear (exclusive) or -1 to
@@ -2738,7 +2739,7 @@ nvim_buf_del_extmark({buffer}, {ns_id}, {id}) *nvim_buf_del_extmark()*
Since: 0.5.0 Since: 0.5.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {ns_id} Namespace id from |nvim_create_namespace()| • {ns_id} Namespace id from |nvim_create_namespace()|
• {id} Extmark id • {id} Extmark id
@@ -2753,7 +2754,7 @@ nvim_buf_get_extmark_by_id({buffer}, {ns_id}, {id}, {opts})
Since: 0.5.0 Since: 0.5.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {ns_id} Namespace id from |nvim_create_namespace()| • {ns_id} Namespace id from |nvim_create_namespace()|
• {id} Extmark id • {id} Extmark id
• {opts} Optional parameters. Keys: • {opts} Optional parameters. Keys:
@@ -2806,7 +2807,7 @@ nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts})
Since: 0.5.0 Since: 0.5.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {ns_id} Namespace id from |nvim_create_namespace()| or -1 for all • {ns_id} Namespace id from |nvim_create_namespace()| or -1 for all
namespaces namespaces
• {start} Start of range: a 0-indexed (row, col) or valid extmark id • {start} Start of range: a 0-indexed (row, col) or valid extmark id
@@ -2849,7 +2850,7 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts})
Since: 0.5.0 Since: 0.5.0
Parameters: ~ Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer • {buffer} Buffer id, or 0 for current buffer
• {ns_id} Namespace id from |nvim_create_namespace()| • {ns_id} Namespace id from |nvim_create_namespace()|
• {line} Line where to place the mark, 0-based. |api-indexing| • {line} Line where to place the mark, 0-based. |api-indexing|
• {col} Column where to place the mark, 0-based. |api-indexing| • {col} Column where to place the mark, 0-based. |api-indexing|
@@ -3140,7 +3141,7 @@ nvim_win_get_buf({window}) *nvim_win_get_buf()*
• {window} |window-ID|, or 0 for current window • {window} |window-ID|, or 0 for current window
Return: ~ Return: ~
Buffer handle Buffer id
nvim_win_get_cursor({window}) *nvim_win_get_cursor()* nvim_win_get_cursor({window}) *nvim_win_get_cursor()*
Gets the (1,0)-indexed, buffer-relative cursor position for a given window Gets the (1,0)-indexed, buffer-relative cursor position for a given window
@@ -3268,7 +3269,7 @@ nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()*
Parameters: ~ Parameters: ~
• {window} |window-ID|, or 0 for current window • {window} |window-ID|, or 0 for current window
• {buffer} Buffer handle • {buffer} Buffer id
nvim_win_set_cursor({window}, {pos}) *nvim_win_set_cursor()* nvim_win_set_cursor({window}, {pos}) *nvim_win_set_cursor()*
Sets the (1,0)-indexed cursor position in the window. |api-indexing| This Sets the (1,0)-indexed cursor position in the window. |api-indexing| This

11
runtime/doc/autocmd.txt
View File

@@ -743,6 +743,12 @@ InsertLeavePre Just before leaving Insert mode. Also when
*InsertLeave* *InsertLeave*
InsertLeave Just after leaving Insert mode. Also when InsertLeave Just after leaving Insert mode. Also when
using CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|. using CTRL-O |i_CTRL-O|. But not for |i_CTRL-C|.
LspAttach See |LspAttach|
LspDetach See |LspDetach|
LspNotify See |LspNotify|
LspProgress See |LspProgress|
LspRequest See |LspRequest|
LspTokenUpdate See |LspTokenUpdate|
*MenuPopup* *MenuPopup*
MenuPopup Just before showing the popup menu (under the MenuPopup Just before showing the popup menu (under the
right mouse button). Useful for adjusting the right mouse button). Useful for adjusting the
@@ -1128,9 +1134,8 @@ VimLeave Before exiting Vim, just after writing the
Not triggered if |v:dying| is 2 or more. Not triggered if |v:dying| is 2 or more.
*VimLeavePre* *VimLeavePre*
VimLeavePre Before exiting Vim, just before writing the VimLeavePre Before exiting Vim, just before writing the
.shada file. This is executed only once, |shada| file. Executed only once, if the
if there is a match with the name of what pattern matches the current buffer on exit.
happens to be the current buffer when exiting.
Mostly useful with a "*" pattern. > Mostly useful with a "*" pattern. >
:autocmd VimLeavePre * call CleanupStuff() :autocmd VimLeavePre * call CleanupStuff()
< Use |v:dying| to detect an abnormal exit. < Use |v:dying| to detect an abnormal exit.

2
runtime/doc/intro.txt
View File

@@ -451,7 +451,7 @@ CTRL-O in Insert mode you get a beep but you are still in Insert mode, type
> >
FROM mode TO mode FROM mode TO mode
Normal Visual Select Insert Replace Cmd-line Ex > Normal Visual Select Insert Replace Cmd-line Ex >
Normal v V ^V *4 *1 R gR : / ? ! Q Normal v V ^V *4 *1 R gR : / ? ! gQ
Visual *2 ^G c C -- : -- Visual *2 ^G c C -- : --
Select *5 ^O ^G *6 -- -- -- Select *5 ^O ^G *6 -- -- --
Insert <Esc> -- -- <Insert> -- -- Insert <Esc> -- -- <Insert> -- --

215
runtime/doc/lsp.txt
View File

@@ -65,74 +65,9 @@ Follow these steps to get LSP features:
5. (Optional) Configure keymaps and autocommands to use LSP features. 5. (Optional) Configure keymaps and autocommands to use LSP features.
|lsp-attach| |lsp-attach|
*lsp-config* ==============================================================================
DEFAULTS *lsp-defaults*
Configurations for LSP clients is done via |vim.lsp.config()|.
When an LSP client starts, it resolves a configuration by merging
configurations, in increasing priority, from the following:
1. Configuration defined for the `'*'` name.
2. Configuration from the result of merging all tables returned by
`lsp/<name>.lua` files in 'runtimepath' for a server of name `name`.
3. Configurations defined anywhere else.
Note: The merge semantics of configurations follow the behaviour of
|vim.tbl_deep_extend()|.
Example:
Given: >lua
-- Defined in init.lua
vim.lsp.config('*', {
capabilities = {
textDocument = {
semanticTokens = {
multilineTokenSupport = true,
}
}
},
root_markers = { '.git' },
})
-- Defined in ../lsp/clangd.lua
return {
cmd = { 'clangd' },
root_markers = { '.clangd', 'compile_commands.json' },
filetypes = { 'c', 'cpp' },
}
-- Defined in init.lua
vim.lsp.config('clangd', {
filetypes = { 'c' },
})
<
Results in the configuration: >lua
{
-- From the clangd configuration in <rtp>/lsp/clangd.lua
cmd = { 'clangd' },
-- From the clangd configuration in <rtp>/lsp/clangd.lua
-- Overrides the * configuration in init.lua
root_markers = { '.clangd', 'compile_commands.json' },
-- From the clangd configuration in init.lua
-- Overrides the clangd configuration in <rtp>/lsp/clangd.lua
filetypes = { 'c' },
-- From the * configuration in init.lua
capabilities = {
textDocument = {
semanticTokens = {
multilineTokenSupport = true,
}
}
}
}
<
*lsp-defaults*
When the Nvim LSP client starts it enables diagnostics |vim.diagnostic| (see When the Nvim LSP client starts it enables diagnostics |vim.diagnostic| (see
|vim.diagnostic.config()| to customize). It also sets various default options, |vim.diagnostic.config()| to customize). It also sets various default options,
listed below, if (1) the language server supports the functionality and (2) listed below, if (1) the language server supports the functionality and (2)
@@ -176,27 +111,96 @@ To override or delete any of the above defaults, set or unset the options on
vim.keymap.del('n', 'K', { buffer = args.buf }) vim.keymap.del('n', 'K', { buffer = args.buf })
end, end,
}) })
<
==============================================================================
CONFIG *lsp-config*
You can configure LSP behavior statically via vim.lsp.config(), and
dynamically via |lsp-attach| or |Client:on_attach()|.
Use |vim.lsp.config()| to define, and selectively enable, LSP configurations.
This is basically a wrapper around |vim.lsp.start()| which allows you to share
and merge configs (which may be provided by Nvim or third-party plugins).
When an LSP client starts, it resolves its configuration by merging from the
following (in increasing priority):
1. Configuration defined for the `'*'` name.
2. Configuration from the result of merging all tables returned by
`lsp/<name>.lua` files in 'runtimepath' for a server of name `name`.
3. Configurations defined anywhere else.
Note: The merge semantics of configurations follow the behaviour of
|vim.tbl_deep_extend()|.
Example: given the following configs... >lua
-- Defined in init.lua
vim.lsp.config('*', {
capabilities = {
textDocument = {
semanticTokens = {
multilineTokenSupport = true,
}
}
},
root_markers = { '.git' },
})
-- Defined in <rtp>/lsp/clangd.lua
return {
cmd = { 'clangd' },
root_markers = { '.clangd', 'compile_commands.json' },
filetypes = { 'c', 'cpp' },
}
-- Defined in init.lua
vim.lsp.config('clangd', {
filetypes = { 'c' },
})
<
...the merged result is: >lua
{
-- From the clangd configuration in <rtp>/lsp/clangd.lua
cmd = { 'clangd' },
-- From the clangd configuration in <rtp>/lsp/clangd.lua
-- Overrides the "*" configuration in init.lua
root_markers = { '.clangd', 'compile_commands.json' },
-- From the clangd configuration in init.lua
-- Overrides the clangd configuration in <rtp>/lsp/clangd.lua
filetypes = { 'c' },
-- From the "*" configuration in init.lua
capabilities = {
textDocument = {
semanticTokens = {
multilineTokenSupport = true,
}
}
}
}
< <
*lsp-attach* *lsp-attach*
To use other LSP features, set keymaps and other buffer options on To use LSP features beyond those provided by Nvim (see |lsp-buf|), you can set
|LspAttach|. Not all language servers provide the same capabilities. Use keymaps and options on |Client:on_attach()| or |LspAttach|. Not all language
capability checks to ensure you only use features supported by the language servers provide the same capabilities; check `supports_method()` in your
server. Example: >lua LspAttach handler. Example: >lua
vim.api.nvim_create_autocmd('LspAttach', { vim.api.nvim_create_autocmd('LspAttach', {
callback = function(args) callback = function(args)
local client = vim.lsp.get_client_by_id(args.data.client_id) local client = vim.lsp.get_client_by_id(args.data.client_id)
if client:supports_method('textDocument/implementation') then if client:supports_method('textDocument/implementation') then
-- Create a keymap for vim.lsp.buf.implementation -- Create a keymap for vim.lsp.buf.implementation ...
end end
-- Enable auto-completion.
if client:supports_method('textDocument/completion') then if client:supports_method('textDocument/completion') then
-- Enable auto-completion
vim.lsp.completion.enable(true, client.id, args.buf, {autotrigger = true}) vim.lsp.completion.enable(true, client.id, args.buf, {autotrigger = true})
end end
-- Format the current buffer on save.
if client:supports_method('textDocument/formatting') then if client:supports_method('textDocument/formatting') then
-- Format the current buffer on save
vim.api.nvim_create_autocmd('BufWritePre', { vim.api.nvim_create_autocmd('BufWritePre', {
buffer = args.buf, buffer = args.buf,
callback = function() callback = function()
@@ -207,13 +211,10 @@ server. Example: >lua
end, end,
}) })
< <
To learn what capabilities are available you can run the following command in To see the capabilities for a given server, try this in a LSP-enabled buffer: >vim
a buffer with a started LSP client: >vim
:lua =vim.lsp.get_clients()[1].server_capabilities :lua =vim.lsp.get_clients()[1].server_capabilities
Full list of features provided by default can be found in |lsp-buf|.
================================================================================ ================================================================================
FAQ *lsp-faq* FAQ *lsp-faq*
@@ -537,14 +538,31 @@ the exact definition):
EVENTS *lsp-events* EVENTS *lsp-events*
LspAttach *LspAttach* LspAttach *LspAttach*
After an LSP client attaches to a buffer. The |autocmd-pattern| is the After an LSP client performs "initialize" and attaches to a buffer. The
name of the buffer. When used from Lua, the client ID is passed to the |autocmd-pattern| is the buffer name. The client ID is passed in the
callback in the "data" table. See |lsp-attach| for an example. Lua handler |event-data| argument.
Note: If the LSP server performs dynamic registration, capabilities may be
registered any time _after_ LspAttach. In that case you may want to handle
the "registerCapability" event. Example: >lua
vim.lsp.handlers['client/registerCapability'] = (function(overridden)
return function(err, res, ctx)
local result = overridden(err, res, ctx)
local client = vim.lsp.get_client_by_id(ctx.client_id)
if not client then
return
end
-- Call your custom on_attach logic...
-- my_on_attach(client, vim.api.nvim_get_current_buf())
return result
end
end)(vim.lsp.handlers['client/registerCapability'])
LspDetach *LspDetach* LspDetach *LspDetach*
Just before an LSP client detaches from a buffer. The |autocmd-pattern| Just before an LSP client detaches from a buffer. The |autocmd-pattern| is
is the name of the buffer. When used from Lua, the client ID is passed the buffer name. The client ID is passed in the Lua handler |event-data|
to the callback in the "data" table. Example: >lua argument. Example: >lua
vim.api.nvim_create_autocmd('LspDetach', { vim.api.nvim_create_autocmd('LspDetach', {
callback = function(args) callback = function(args)
@@ -566,8 +584,8 @@ LspNotify *LspNotify*
This event is triggered after each successful notification sent to an This event is triggered after each successful notification sent to an
LSP server. LSP server.
When used from Lua, the client_id, LSP method, and parameters are sent The client_id, LSP method, and parameters are sent in the Lua handler
in the "data" table. Example: >lua |event-data| table argument. Example: >lua
vim.api.nvim_create_autocmd('LspNotify', { vim.api.nvim_create_autocmd('LspNotify', {
callback = function(args) callback = function(args)
@@ -592,9 +610,9 @@ LspProgress *LspProgress*
If the server sends a "work done progress", the `pattern` is set to `kind` If the server sends a "work done progress", the `pattern` is set to `kind`
(one of `begin`, `report` or `end`). (one of `begin`, `report` or `end`).
When used from Lua, the event contains a `data` table with `client_id` and The Lua handler |event-data| argument has `client_id` and `params`
`params` properties. `params` will contain the request params sent by the properties, where `params` is the request params sent by the server (see
server (see `lsp.ProgressParams`). `lsp.ProgressParams`).
Example: >vim Example: >vim
autocmd LspProgress * redrawstatus autocmd LspProgress * redrawstatus
@@ -611,11 +629,10 @@ LspRequest *LspRequest*
is requested using `client.cancel_request(request_id)`, then this event is requested using `client.cancel_request(request_id)`, then this event
will trigger with {type} == `cancel`. will trigger with {type} == `cancel`.
When used from Lua, the client ID, request ID, and request are sent in The Lua handler |event-data| argument has the client ID, request ID, and
the "data" table. See {requests} in |vim.lsp.Client| for details on the request (described at |vim.lsp.Client|, {requests} field). If the request
{request} value. If the request type is `complete`, the request will be type is `complete`, the request will be deleted from the client's pending
deleted from the client's pending requests table immediately after requests table after processing the event handlers. Example: >lua
calling the event's callbacks. Example: >lua
vim.api.nvim_create_autocmd('LspRequest', { vim.api.nvim_create_autocmd('LspRequest', {
callback = function(args) callback = function(args)
@@ -641,11 +658,9 @@ LspRequest *LspRequest*
LspTokenUpdate *LspTokenUpdate* LspTokenUpdate *LspTokenUpdate*
When a visible semantic token is sent or updated by the LSP server, or When a visible semantic token is sent or updated by the LSP server, or
when an existing token becomes visible for the first time. The when an existing token becomes visible for the first time. The
|autocmd-pattern| is the name of the buffer. When used from Lua, the |autocmd-pattern| is the buffer name. The Lua handler |event-data|
token and client ID are passed to the callback in the "data" table. The argument has the client ID and token (see
token fields are documented in |vim.lsp.semantic_tokens.get_at_pos()|. |vim.lsp.semantic_tokens.get_at_pos()|). Example: >lua
Example:
>lua
vim.api.nvim_create_autocmd('LspTokenUpdate', { vim.api.nvim_create_autocmd('LspTokenUpdate', {
callback = function(args) callback = function(args)
@@ -1842,6 +1857,8 @@ activate "auto-completion" when you type any of the server-defined
`triggerCharacters`. `triggerCharacters`.
Example: activate LSP-driven auto-completion: >lua Example: activate LSP-driven auto-completion: >lua
-- Works best with completeopt=noselect.
vim.cmd[[set completeopt+=menuone,noselect,popup]]
vim.lsp.start({ vim.lsp.start({
name = 'ts_ls', name = 'ts_ls',
cmd = …, cmd = …,

2
runtime/doc/motion.txt
View File

@@ -852,7 +852,7 @@ unrelated.
'a - 'z lowercase marks, valid within one file 'a - 'z lowercase marks, valid within one file
'A - 'Z uppercase marks, also called file marks, valid between files 'A - 'Z uppercase marks, also called file marks, valid between files
'0 - '9 numbered marks, set from .shada file '0 - '9 numbered marks, set from |shada| file
Lowercase marks 'a to 'z are remembered as long as the file remains in the Lowercase marks 'a to 'z are remembered as long as the file remains in the
buffer list. If you remove the file from the buffer list, all its marks are buffer list. If you remove the file from the buffer list, all its marks are

9
runtime/doc/options.txt
View File

@@ -2349,12 +2349,13 @@ A jump table for the options with a short description can be found at |Q_op|.
when 'autoindent' is on. To insert a real tab when 'expandtab' is when 'autoindent' is on. To insert a real tab when 'expandtab' is
on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
*'exrc'* *'ex'* *'noexrc'* *'noex'* *'exrc'* *'ex'* *'noexrc'* *'noex'* *project-config* *workspace-config*
'exrc' 'ex' boolean (default off) 'exrc' 'ex' boolean (default off)
global global
Automatically execute .nvim.lua, .nvimrc, and .exrc files in the Enables project-local configuration. Nvim will execute any .nvim.lua,
current directory, if the file is in the |trust| list. Use |:trust| to .nvimrc, or .exrc file found in the |current-directory|, if the file is
manage trusted files. See also |vim.secure.read()|. in the |trust| list. Use |:trust| to manage trusted files. See also
|vim.secure.read()|.
Compare 'exrc' to |editorconfig|: Compare 'exrc' to |editorconfig|:
- 'exrc' can execute any code; editorconfig only specifies settings. - 'exrc' can execute any code; editorconfig only specifies settings.

2
runtime/doc/quickref.txt
View File

@@ -842,7 +842,7 @@ Short explanation of each option: *option-list*
'selection' 'sel' what type of selection to use 'selection' 'sel' what type of selection to use
'selectmode' 'slm' when to use Select mode instead of Visual mode 'selectmode' 'slm' when to use Select mode instead of Visual mode
'sessionoptions' 'ssop' options for |:mksession| 'sessionoptions' 'ssop' options for |:mksession|
'shada' 'sd' use .shada file upon startup and exiting 'shada' 'sd' use |shada| file upon startup and exiting
'shell' 'sh' name of shell to use for external commands 'shell' 'sh' name of shell to use for external commands
'shellcmdflag' 'shcf' flag to shell to execute one command 'shellcmdflag' 'shcf' flag to shell to execute one command
'shellpipe' 'sp' string to put output of ":make" in error file 'shellpipe' 'sp' string to put output of ":make" in error file

8
runtime/doc/terminal.txt
View File

@@ -198,21 +198,19 @@ doesn't interfere).
- fish: https://fishshell.com/docs/current/relnotes.html#improved-terminal-support - fish: https://fishshell.com/docs/current/relnotes.html#improved-terminal-support
- kitty: https://sw.kovidgoyal.net/kitty/shell-integration/ - kitty: https://sw.kovidgoyal.net/kitty/shell-integration/
- powershell: https://learn.microsoft.com/en-us/windows/terminal/tutorials/shell-integration#powershell-pwshexe
- vscode: https://code.visualstudio.com/docs/terminal/shell-integration - vscode: https://code.visualstudio.com/docs/terminal/shell-integration
To configure bash to mark the start/end of each prompt, set $PROMPT_COMMAND To configure bash to mark the start of each prompt, set $PROMPT_COMMAND: >bash
and $PS1 as follows: >bash
# Prompt start: # Prompt start:
PROMPT_COMMAND='printf "\033]133;A\007"' PROMPT_COMMAND='printf "\033]133;A\007"'
# Prompt end:
PS1="$PS1"'\033]133;B\007'
< <
*terminal_]]* *terminal_[[* *terminal_]]* *terminal_[[*
The |]]| and |[[| motions jump to the next/previous prompts, if your shell The |]]| and |[[| motions jump to the next/previous prompts, if your shell
emits OSC 133 as described above. emits OSC 133 as described above.
*terminal-shell-prompt-signs* *shell-prompt-signs*
To annotate each terminal prompt with a sign, call |nvim_buf_set_extmark()| To annotate each terminal prompt with a sign, call |nvim_buf_set_extmark()|
from a |TermRequest| handler: >lua from a |TermRequest| handler: >lua

36
runtime/doc/ui.txt
View File

@@ -272,9 +272,9 @@ Grid Events (line-based) *ui-linegrid*
Activated by the `ext_linegrid` |ui-option|. Recommended for all new UIs. Activated by the `ext_linegrid` |ui-option|. Recommended for all new UIs.
Deactivates |ui-grid-old| implicitly. Deactivates |ui-grid-old| implicitly.
The biggest change compared to |ui-grid-old| is to use a single `grid_line` Unlike |ui-grid-old|, this UI extension emits a single `grid_line` event to
event to update the contents of a screen line (whereas the old protocol used update a screen-line (whereas the old protocol emitted separate cursor,
a combination of cursor, highlight and text events) highlight and text events per screen-line).
Most of these events take a `grid` index as first parameter. Grid 1 is the Most of these events take a `grid` index as first parameter. Grid 1 is the
global grid used by default for the entire editor screen state. The global grid used by default for the entire editor screen state. The
@@ -351,8 +351,7 @@ numerical highlight ids to the actual attributes.
affected by redefined ids, so UIs do not need to keep track of this affected by redefined ids, so UIs do not need to keep track of this
themselves. themselves.
`info` is an empty array by default, and will be used by the `info` is an empty array unless |ui-hlstate| is enabled.
|ui-hlstate| extension explained below.
["hl_group_set", name, hl_id] ~ ["hl_group_set", name, hl_id] ~
The built-in highlight group `name` was set to use the attributes `hl_id` The built-in highlight group `name` was set to use the attributes `hl_id`
@@ -540,20 +539,23 @@ is not active. New UIs should implement |ui-linegrid| instead.
+-------------------------+ +-------------------------+
< <
============================================================================== ==============================================================================
Detailed highlight state Extension *ui-hlstate* Highlight Events *ui-hlstate*
Activated by the `ext_hlstate` |ui-option|. Activated by the `ext_hlstate` |ui-option|.
Activates |ui-linegrid| implicitly. Activates |ui-linegrid| implicitly.
By default Nvim will only describe grid cells using the final calculated If `ext_hlstate` is enabled, Nvim will emit detailed highlight state in
highlight attributes, as described by the dict keys in |ui-event-highlight_set|. |ui-linegrid| events. Otherwise (by default) Nvim only describes grid cells
The `ext_hlstate` extension allows to the UI to also receive a semantic using the final calculated highlight attributes described at
description of the highlights active in a cell. In this mode highlights will be |ui-event-highlight_set|.
predefined in a table, see |ui-event-hl_attr_define| and |ui-event-grid_line|.
The `info` parameter in `hl_attr_define` will contain a semantic description `ext_hlstate` provides a semantic description of active highlights for each
of the highlights. As highlight groups can be combined, this will be an array grid cell. Highlights are predefined in a table, see |ui-event-hl_attr_define|
of items, with the item with highest priority last. Each item is a dictionary and |ui-event-grid_line|.
with the following possible keys:
The `info` parameter in `hl_attr_define` contains a semantic description of
the highlights. Because highlight groups can be combined, this is an array
where the highest-priority item is last. Each item is a dict with these keys:
`kind`: always present. One of the following values: `kind`: always present. One of the following values:
"ui": Builtin UI highlight. |highlight-groups| "ui": Builtin UI highlight. |highlight-groups|
@@ -671,6 +673,10 @@ Activated by the `ext_popupmenu` |ui-option|.
This UI extension delegates presentation of the |popupmenu-completion| and This UI extension delegates presentation of the |popupmenu-completion| and
command-line 'wildmenu'. command-line 'wildmenu'.
The UI decides how to present the menu. For example, depending on the last
`mode_change` event, command-line wildmenu may be presented horizontally,
while insert-mode completion would show a vertical popupmenu.
["popupmenu_show", items, selected, row, col, grid] ~ ["popupmenu_show", items, selected, row, col, grid] ~
Show |popupmenu-completion|. `items` is an array of completion items Show |popupmenu-completion|. `items` is an array of completion items
to show; each item is an array of the form [word, kind, menu, info] as to show; each item is an array of the form [word, kind, menu, info] as

58
runtime/doc/vvars.txt
View File

@@ -153,45 +153,43 @@ v:event
an aborting condition (e.g. |c_Esc| or an aborting condition (e.g. |c_Esc| or
|c_CTRL-C| for |CmdlineLeave|). |c_CTRL-C| for |CmdlineLeave|).
chan |channel-id| chan |channel-id|
info Dict of arbitrary event data. changed_window Is |v:true| if the event fired while
changing window (or tab) on |DirChanged|.
cmdlevel Level of cmdline. cmdlevel Level of cmdline.
cmdtype Type of cmdline, |cmdline-char|. cmdtype Type of cmdline, |cmdline-char|.
col Column count of popup menu on |CompleteChanged|,
relative to screen.
complete_type See |complete_info_mode|
complete_word The selected word, or empty if completion
was abandoned/discarded.
completed_item Current selected item on |CompleteChanged|,
or `{}` if no item selected.
cwd Current working directory. cwd Current working directory.
height Height of popup menu on |CompleteChanged|
inclusive Motion is |inclusive|, else exclusive. inclusive Motion is |inclusive|, else exclusive.
scope Event-specific scope name. info Dict of arbitrary event data.
operator Current |operator|. Also set for Ex operator Current |operator|. Also set for Ex
commands (unlike |v:operator|). For commands (unlike |v:operator|). For
example if |TextYankPost| is triggered example if |TextYankPost| is triggered
by the |:yank| Ex command then by the |:yank| Ex command then
`v:event.operator` is "y". `v:event.operator` is "y".
reason |CompleteDone| reason.
regcontents Text stored in the register as a regcontents Text stored in the register as a
|readfile()|-style list of lines. |readfile()|-style list of lines.
regname Requested register (e.g "x" for "xyy) regname Requested register (e.g "x" for "xyy), or
or the empty string for an unnamed empty string for an unnamed operation.
operation.
regtype Type of register as returned by regtype Type of register as returned by
|getregtype()|. |getregtype()|.
visual Selection is visual (as opposed to,
e.g., via motion).
completed_item Current selected complete item on
|CompleteChanged|, Is `{}` when no complete
item selected.
height Height of popup menu on |CompleteChanged|
width Width of popup menu on |CompleteChanged|
row Row count of popup menu on |CompleteChanged|, row Row count of popup menu on |CompleteChanged|,
relative to screen. relative to screen.
col Col count of popup menu on |CompleteChanged|, scope Event-specific scope name.
relative to screen. scrollbar |v:true| if popup menu has a scrollbar, or
|v:false| if not.
size Total number of completion items on size Total number of completion items on
|CompleteChanged|. |CompleteChanged|.
scrollbar Is |v:true| if popup menu have scrollbar, or
|v:false| if not.
changed_window Is |v:true| if the event fired while
changing window (or tab) on |DirChanged|.
status Job status or exit code, -1 means "unknown". |TermClose| status Job status or exit code, -1 means "unknown". |TermClose|
reason Reason for completion being done. |CompleteDone| visual Selection is visual (as opposed to e.g. a motion range).
complete_word The word that was selected, empty if abandoned complete. width Width of popup menu on |CompleteChanged|
complete_type See |complete_info_mode|
windows List of window IDs that changed on |WinResized| windows List of window IDs that changed on |WinResized|
*v:exception* *exception-variable* *v:exception* *exception-variable*
@@ -567,13 +565,19 @@ v:servername
*$NVIM* *$NVIM*
$NVIM is set by |terminal| and |jobstart()|, and is thus $NVIM is set by |terminal| and |jobstart()|, and is thus
a hint that the current environment is a subprocess of Nvim. a hint that the current environment is a subprocess of Nvim.
Example: >vim
if $NVIM
echo nvim_get_chan_info(v:parent)
endif
<
Note the contents of $NVIM may change in the future. Example: a child Nvim process can detect and make requests to
its parent Nvim: >lua
if vim.env.NVIM then
local ok, chan = pcall(vim.fn.sockconnect, 'pipe', vim.env.NVIM, {rpc=true})
if ok and chan then
local client = vim.api.nvim_get_chan_info(chan).client
local rv = vim.rpcrequest(chan, 'nvim_exec_lua', [[return ... + 1]], { 41 })
vim.print(('got "%s" from parent Nvim'):format(rv))
end
end
<
*v:shell_error* *shell_error-variable* *v:shell_error* *shell_error-variable*
v:shell_error v:shell_error

97
runtime/lua/vim/_meta/api.lua generated
View File

@@ -176,7 +176,7 @@ function vim.api.nvim_buf_add_highlight(buffer, ns_id, hl_group, line, col_start
--- ---
--- @see vim.api.nvim_buf_detach --- @see vim.api.nvim_buf_detach
--- @see `:help api-buffer-updates-lua` --- @see `:help api-buffer-updates-lua`
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param send_buffer boolean True if the initial notification should contain the --- @param send_buffer boolean True if the initial notification should contain the
--- whole buffer: first notification will be `nvim_buf_lines_event`. --- whole buffer: first notification will be `nvim_buf_lines_event`.
--- Else the first notification will be `nvim_buf_changedtick_event`. --- Else the first notification will be `nvim_buf_changedtick_event`.
@@ -185,7 +185,7 @@ function vim.api.nvim_buf_add_highlight(buffer, ns_id, hl_group, line, col_start
--- - on_lines: Lua callback invoked on change. --- - on_lines: Lua callback invoked on change.
--- Return a truthy value (not `false` or `nil`) to detach. Args: --- Return a truthy value (not `false` or `nil`) to detach. Args:
--- - the string "lines" --- - the string "lines"
--- - buffer handle --- - buffer id
--- - b:changedtick --- - b:changedtick
--- - first line that changed (zero-indexed) --- - first line that changed (zero-indexed)
--- - last line that was changed --- - last line that was changed
@@ -198,7 +198,7 @@ function vim.api.nvim_buf_add_highlight(buffer, ns_id, hl_group, line, col_start
--- change compared to on_lines. --- change compared to on_lines.
--- Return a truthy value (not `false` or `nil`) to detach. Args: --- Return a truthy value (not `false` or `nil`) to detach. Args:
--- - the string "bytes" --- - the string "bytes"
--- - buffer handle --- - buffer id
--- - b:changedtick --- - b:changedtick
--- - start row of the changed text (zero-indexed) --- - start row of the changed text (zero-indexed)
--- - start column of the changed text --- - start column of the changed text
@@ -215,15 +215,15 @@ function vim.api.nvim_buf_add_highlight(buffer, ns_id, hl_group, line, col_start
--- - on_changedtick: Lua callback invoked on changedtick --- - on_changedtick: Lua callback invoked on changedtick
--- increment without text change. Args: --- increment without text change. Args:
--- - the string "changedtick" --- - the string "changedtick"
--- - buffer handle --- - buffer id
--- - b:changedtick --- - b:changedtick
--- - on_detach: Lua callback invoked on detach. Args: --- - on_detach: Lua callback invoked on detach. Args:
--- - the string "detach" --- - the string "detach"
--- - buffer handle --- - buffer id
--- - on_reload: Lua callback invoked on reload. The entire buffer --- - on_reload: Lua callback invoked on reload. The entire buffer
--- content should be considered changed. Args: --- content should be considered changed. Args:
--- - the string "reload" --- - the string "reload"
--- - buffer handle --- - buffer id
--- - utf_sizes: include UTF-32 and UTF-16 size of the replaced --- - utf_sizes: include UTF-32 and UTF-16 size of the replaced
--- region, as args to `on_lines`. --- region, as args to `on_lines`.
--- - preview: also attach to command preview (i.e. 'inccommand') --- - preview: also attach to command preview (i.e. 'inccommand')
@@ -244,7 +244,7 @@ function vim.api.nvim_buf_attach(buffer, send_buffer, opts) end
--- This is useful e.g. to call Vimscript functions that only work with the --- This is useful e.g. to call Vimscript functions that only work with the
--- current buffer/window currently, like `jobstart(…, {'term': v:true})`. --- current buffer/window currently, like `jobstart(…, {'term': v:true})`.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param fun function Function to call inside the buffer (currently Lua callable --- @param fun function Function to call inside the buffer (currently Lua callable
--- only) --- only)
--- @return any # Return value of function. --- @return any # Return value of function.
@@ -263,7 +263,7 @@ function vim.api.nvim_buf_clear_highlight(buffer, ns_id, line_start, line_end) e
--- Lines are 0-indexed. `api-indexing` To clear the namespace in the entire --- Lines are 0-indexed. `api-indexing` To clear the namespace in the entire
--- buffer, specify line_start=0 and line_end=-1. --- buffer, specify line_start=0 and line_end=-1.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param ns_id integer Namespace to clear, or -1 to clear all namespaces. --- @param ns_id integer Namespace to clear, or -1 to clear all namespaces.
--- @param line_start integer Start of range of lines to clear --- @param line_start integer Start of range of lines to clear
--- @param line_end integer End of range of lines to clear (exclusive) or -1 to clear --- @param line_end integer End of range of lines to clear (exclusive) or -1 to clear
@@ -273,7 +273,7 @@ function vim.api.nvim_buf_clear_namespace(buffer, ns_id, line_start, line_end) e
--- Creates a buffer-local command `user-commands`. --- Creates a buffer-local command `user-commands`.
--- ---
--- @see vim.api.nvim_create_user_command --- @see vim.api.nvim_create_user_command
--- @param buffer integer Buffer handle, or 0 for current buffer. --- @param buffer integer Buffer id, or 0 for current buffer.
--- @param name string --- @param name string
--- @param command any --- @param command any
--- @param opts vim.api.keyset.user_command --- @param opts vim.api.keyset.user_command
@@ -281,7 +281,7 @@ function vim.api.nvim_buf_create_user_command(buffer, name, command, opts) end
--- Removes an `extmark`. --- Removes an `extmark`.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param ns_id integer Namespace id from `nvim_create_namespace()` --- @param ns_id integer Namespace id from `nvim_create_namespace()`
--- @param id integer Extmark id --- @param id integer Extmark id
--- @return boolean # true if the extmark was found, else false --- @return boolean # true if the extmark was found, else false
@@ -291,7 +291,7 @@ function vim.api.nvim_buf_del_extmark(buffer, ns_id, id) end
--- ---
--- ---
--- @see vim.api.nvim_del_keymap --- @see vim.api.nvim_del_keymap
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param mode string --- @param mode string
--- @param lhs string --- @param lhs string
function vim.api.nvim_buf_del_keymap(buffer, mode, lhs) end function vim.api.nvim_buf_del_keymap(buffer, mode, lhs) end
@@ -314,19 +314,19 @@ function vim.api.nvim_buf_del_mark(buffer, name) end
--- Only commands created with `:command-buffer` or --- Only commands created with `:command-buffer` or
--- `nvim_buf_create_user_command()` can be deleted with this function. --- `nvim_buf_create_user_command()` can be deleted with this function.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer. --- @param buffer integer Buffer id, or 0 for current buffer.
--- @param name string Name of the command to delete. --- @param name string Name of the command to delete.
function vim.api.nvim_buf_del_user_command(buffer, name) end function vim.api.nvim_buf_del_user_command(buffer, name) end
--- Removes a buffer-scoped (b:) variable --- Removes a buffer-scoped (b:) variable
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param name string Variable name --- @param name string Variable name
function vim.api.nvim_buf_del_var(buffer, name) end function vim.api.nvim_buf_del_var(buffer, name) end
--- Deletes the buffer. See `:bwipeout` --- Deletes the buffer. See `:bwipeout`
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param opts vim.api.keyset.buf_delete Optional parameters. Keys: --- @param opts vim.api.keyset.buf_delete Optional parameters. Keys:
--- - force: Force deletion and ignore unsaved changes. --- - force: Force deletion and ignore unsaved changes.
--- - unload: Unloaded only, do not delete. See `:bunload` --- - unload: Unloaded only, do not delete. See `:bunload`
@@ -334,20 +334,20 @@ function vim.api.nvim_buf_delete(buffer, opts) end
--- Gets a changed tick of a buffer --- Gets a changed tick of a buffer
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @return integer # `b:changedtick` value. --- @return integer # `b:changedtick` value.
function vim.api.nvim_buf_get_changedtick(buffer) end function vim.api.nvim_buf_get_changedtick(buffer) end
--- Gets a map of buffer-local `user-commands`. --- Gets a map of buffer-local `user-commands`.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param opts vim.api.keyset.get_commands Optional parameters. Currently not used. --- @param opts vim.api.keyset.get_commands Optional parameters. Currently not used.
--- @return table<string,any> # Map of maps describing commands. --- @return table<string,any> # Map of maps describing commands.
function vim.api.nvim_buf_get_commands(buffer, opts) end function vim.api.nvim_buf_get_commands(buffer, opts) end
--- Gets the position (0-indexed) of an `extmark`. --- Gets the position (0-indexed) of an `extmark`.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param ns_id integer Namespace id from `nvim_create_namespace()` --- @param ns_id integer Namespace id from `nvim_create_namespace()`
--- @param id integer Extmark id --- @param id integer Extmark id
--- @param opts vim.api.keyset.get_extmark Optional parameters. Keys: --- @param opts vim.api.keyset.get_extmark Optional parameters. Keys:
@@ -397,7 +397,7 @@ function vim.api.nvim_buf_get_extmark_by_id(buffer, ns_id, id, opts) end
--- vim.print(ms) --- vim.print(ms)
--- ``` --- ```
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param ns_id integer Namespace id from `nvim_create_namespace()` or -1 for all namespaces --- @param ns_id integer Namespace id from `nvim_create_namespace()` or -1 for all namespaces
--- @param start any Start of range: a 0-indexed (row, col) or valid extmark id --- @param start any Start of range: a 0-indexed (row, col) or valid extmark id
--- (whose position defines the bound). `api-indexing` --- (whose position defines the bound). `api-indexing`
@@ -415,10 +415,10 @@ function vim.api.nvim_buf_get_extmarks(buffer, ns_id, start, end_, opts) end
--- Gets a list of buffer-local `mapping` definitions. --- Gets a list of buffer-local `mapping` definitions.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param mode string Mode short-name ("n", "i", "v", ...) --- @param mode string Mode short-name ("n", "i", "v", ...)
--- @return vim.api.keyset.get_keymap[] # Array of |maparg()|-like dictionaries describing mappings. --- @return vim.api.keyset.get_keymap[] # Array of |maparg()|-like dictionaries describing mappings.
--- The "buffer" key holds the associated buffer handle. --- The "buffer" key holds the associated buffer id.
function vim.api.nvim_buf_get_keymap(buffer, mode) end function vim.api.nvim_buf_get_keymap(buffer, mode) end
--- Gets a line-range from the buffer. --- Gets a line-range from the buffer.
@@ -430,7 +430,9 @@ function vim.api.nvim_buf_get_keymap(buffer, mode) end
--- Out-of-bounds indices are clamped to the nearest valid value, unless --- Out-of-bounds indices are clamped to the nearest valid value, unless
--- `strict_indexing` is set. --- `strict_indexing` is set.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer ---
--- @see vim.api.nvim_buf_get_text
--- @param buffer integer Buffer id, or 0 for current buffer
--- @param start integer First line index --- @param start integer First line index
--- @param end_ integer Last line index, exclusive --- @param end_ integer Last line index, exclusive
--- @param strict_indexing boolean Whether out-of-bounds should be an error. --- @param strict_indexing boolean Whether out-of-bounds should be an error.
@@ -445,7 +447,7 @@ function vim.api.nvim_buf_get_lines(buffer, start, end_, strict_indexing) end
--- ---
--- @see vim.api.nvim_buf_set_mark --- @see vim.api.nvim_buf_set_mark
--- @see vim.api.nvim_buf_del_mark --- @see vim.api.nvim_buf_del_mark
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param name string Mark name --- @param name string Mark name
--- @return integer[] # (row, col) tuple, (0, 0) if the mark is not set, or is an --- @return integer[] # (row, col) tuple, (0, 0) if the mark is not set, or is an
--- uppercase/file mark set in another buffer. --- uppercase/file mark set in another buffer.
@@ -453,7 +455,7 @@ function vim.api.nvim_buf_get_mark(buffer, name) end
--- Gets the full file name for the buffer --- Gets the full file name for the buffer
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @return string # Buffer name --- @return string # Buffer name
function vim.api.nvim_buf_get_name(buffer) end function vim.api.nvim_buf_get_name(buffer) end
@@ -472,7 +474,7 @@ function vim.api.nvim_buf_get_number(buffer) end
--- Unlike `line2byte()`, throws error for out-of-bounds indexing. --- Unlike `line2byte()`, throws error for out-of-bounds indexing.
--- Returns -1 for unloaded buffer. --- Returns -1 for unloaded buffer.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param index integer Line index --- @param index integer Line index
--- @return integer # Integer byte offset, or -1 for unloaded buffer. --- @return integer # Integer byte offset, or -1 for unloaded buffer.
function vim.api.nvim_buf_get_offset(buffer, index) end function vim.api.nvim_buf_get_offset(buffer, index) end
@@ -483,17 +485,14 @@ function vim.api.nvim_buf_get_offset(buffer, index) end
--- @return any --- @return any
function vim.api.nvim_buf_get_option(buffer, name) end function vim.api.nvim_buf_get_option(buffer, name) end
--- Gets a range from the buffer. --- Gets a range from the buffer (may be partial lines, unlike `nvim_buf_get_lines()`).
---
--- This differs from `nvim_buf_get_lines()` in that it allows retrieving only
--- portions of a line.
--- ---
--- Indexing is zero-based. Row indices are end-inclusive, and column indices --- Indexing is zero-based. Row indices are end-inclusive, and column indices
--- are end-exclusive. --- are end-exclusive.
--- ---
--- Prefer `nvim_buf_get_lines()` when retrieving entire lines. --- Prefer `nvim_buf_get_lines()` when retrieving entire lines.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param start_row integer First line index --- @param start_row integer First line index
--- @param start_col integer Starting column (byte offset) on first line --- @param start_col integer Starting column (byte offset) on first line
--- @param end_row integer Last line index, inclusive --- @param end_row integer Last line index, inclusive
@@ -504,7 +503,7 @@ function vim.api.nvim_buf_get_text(buffer, start_row, start_col, end_row, end_co
--- Gets a buffer-scoped (b:) variable. --- Gets a buffer-scoped (b:) variable.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param name string Variable name --- @param name string Variable name
--- @return any # Variable value --- @return any # Variable value
function vim.api.nvim_buf_get_var(buffer, name) end function vim.api.nvim_buf_get_var(buffer, name) end
@@ -512,7 +511,7 @@ function vim.api.nvim_buf_get_var(buffer, name) end
--- Checks if a buffer is valid and loaded. See `api-buffer` for more info --- Checks if a buffer is valid and loaded. See `api-buffer` for more info
--- about unloaded buffers. --- about unloaded buffers.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @return boolean # true if the buffer is valid and loaded, false otherwise. --- @return boolean # true if the buffer is valid and loaded, false otherwise.
function vim.api.nvim_buf_is_loaded(buffer) end function vim.api.nvim_buf_is_loaded(buffer) end
@@ -523,13 +522,13 @@ function vim.api.nvim_buf_is_loaded(buffer) end
--- for more info about unloaded buffers. --- for more info about unloaded buffers.
--- ---
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @return boolean # true if the buffer is valid, false otherwise. --- @return boolean # true if the buffer is valid, false otherwise.
function vim.api.nvim_buf_is_valid(buffer) end function vim.api.nvim_buf_is_valid(buffer) end
--- Returns the number of lines in the given buffer. --- Returns the number of lines in the given buffer.
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @return integer # Line count, or 0 for unloaded buffer. |api-buffer| --- @return integer # Line count, or 0 for unloaded buffer. |api-buffer|
function vim.api.nvim_buf_line_count(buffer) end function vim.api.nvim_buf_line_count(buffer) end
@@ -549,7 +548,7 @@ function vim.api.nvim_buf_line_count(buffer) end
--- An earlier end position is not an error, but then it behaves like an empty --- An earlier end position is not an error, but then it behaves like an empty
--- range (no highlighting). --- range (no highlighting).
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param ns_id integer Namespace id from `nvim_create_namespace()` --- @param ns_id integer Namespace id from `nvim_create_namespace()`
--- @param line integer Line where to place the mark, 0-based. `api-indexing` --- @param line integer Line where to place the mark, 0-based. `api-indexing`
--- @param col integer Column where to place the mark, 0-based. `api-indexing` --- @param col integer Column where to place the mark, 0-based. `api-indexing`
@@ -685,7 +684,7 @@ function vim.api.nvim_buf_set_extmark(buffer, ns_id, line, col, opts) end
--- ---
--- ---
--- @see vim.api.nvim_set_keymap --- @see vim.api.nvim_set_keymap
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param mode string --- @param mode string
--- @param lhs string --- @param lhs string
--- @param rhs string --- @param rhs string
@@ -696,7 +695,7 @@ function vim.api.nvim_buf_set_keymap(buffer, mode, lhs, rhs, opts) end
--- ---
--- Indexing is zero-based, end-exclusive. Negative indices are interpreted --- Indexing is zero-based, end-exclusive. Negative indices are interpreted
--- as length+1+index: -1 refers to the index past the end. So to change --- as length+1+index: -1 refers to the index past the end. So to change
--- or delete the last element use start=-2 and end=-1. --- or delete the last line use start=-2 and end=-1.
--- ---
--- To insert lines at a given index, set `start` and `end` to the same index. --- To insert lines at a given index, set `start` and `end` to the same index.
--- To delete a range of lines, set `replacement` to an empty array. --- To delete a range of lines, set `replacement` to an empty array.
@@ -706,7 +705,7 @@ function vim.api.nvim_buf_set_keymap(buffer, mode, lhs, rhs, opts) end
--- ---
--- ---
--- @see vim.api.nvim_buf_set_text --- @see vim.api.nvim_buf_set_text
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param start integer First line index --- @param start integer First line index
--- @param end_ integer Last line index, exclusive --- @param end_ integer Last line index, exclusive
--- @param strict_indexing boolean Whether out-of-bounds should be an error. --- @param strict_indexing boolean Whether out-of-bounds should be an error.
@@ -734,7 +733,7 @@ function vim.api.nvim_buf_set_mark(buffer, name, line, col, opts) end
--- Sets the full file name for a buffer, like `:file_f` --- Sets the full file name for a buffer, like `:file_f`
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param name string Buffer name --- @param name string Buffer name
function vim.api.nvim_buf_set_name(buffer, name) end function vim.api.nvim_buf_set_name(buffer, name) end
@@ -762,7 +761,7 @@ function vim.api.nvim_buf_set_option(buffer, name, value) end
--- Prefer |nvim_paste()| or |nvim_put()| to insert (instead of replace) text at cursor. --- Prefer |nvim_paste()| or |nvim_put()| to insert (instead of replace) text at cursor.
--- ---
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param start_row integer First line index --- @param start_row integer First line index
--- @param start_col integer Starting column (byte offset) on first line --- @param start_col integer Starting column (byte offset) on first line
--- @param end_row integer Last line index, inclusive --- @param end_row integer Last line index, inclusive
@@ -772,7 +771,7 @@ function vim.api.nvim_buf_set_text(buffer, start_row, start_col, end_row, end_co
--- Sets a buffer-scoped (b:) variable --- Sets a buffer-scoped (b:) variable
--- ---
--- @param buffer integer Buffer handle, or 0 for current buffer --- @param buffer integer Buffer id, or 0 for current buffer
--- @param name string Variable name --- @param name string Variable name
--- @param value any Variable value --- @param value any Variable value
function vim.api.nvim_buf_set_var(buffer, name, value) end function vim.api.nvim_buf_set_var(buffer, name, value) end
@@ -964,7 +963,7 @@ function vim.api.nvim_create_autocmd(event, opts) end
--- @param listed boolean Sets 'buflisted' --- @param listed boolean Sets 'buflisted'
--- @param scratch boolean Creates a "throwaway" `scratch-buffer` for temporary work --- @param scratch boolean Creates a "throwaway" `scratch-buffer` for temporary work
--- (always 'nomodified'). Also sets 'nomodeline' on the buffer. --- (always 'nomodified'). Also sets 'nomodeline' on the buffer.
--- @return integer # Buffer handle, or 0 on error --- @return integer # Buffer id, or 0 on error
--- ---
function vim.api.nvim_create_buf(listed, scratch) end function vim.api.nvim_create_buf(listed, scratch) end
@@ -1331,7 +1330,7 @@ function vim.api.nvim_get_context(opts) end
--- Gets the current buffer. --- Gets the current buffer.
--- ---
--- @return integer # Buffer handle --- @return integer # Buffer id
function vim.api.nvim_get_current_buf() end function vim.api.nvim_get_current_buf() end
--- Gets the current line. --- Gets the current line.
@@ -1580,12 +1579,12 @@ function vim.api.nvim_input(keys) end
--- @param col integer Mouse column-position (zero-based, like redraw events) --- @param col integer Mouse column-position (zero-based, like redraw events)
function vim.api.nvim_input_mouse(button, action, modifier, grid, row, col) end function vim.api.nvim_input_mouse(button, action, modifier, grid, row, col) end
--- Gets the current list of buffer handles --- Gets the current list of buffers.
--- ---
--- Includes unlisted (unloaded/deleted) buffers, like `:ls!`. --- Includes unlisted (unloaded/deleted) buffers, like `:ls!`.
--- Use `nvim_buf_is_loaded()` to check if a buffer is loaded. --- Use `nvim_buf_is_loaded()` to check if a buffer is loaded.
--- ---
--- @return integer[] # List of buffer handles --- @return integer[] # List of buffer ids
function vim.api.nvim_list_bufs() end function vim.api.nvim_list_bufs() end
--- Get information about all open channels. --- Get information about all open channels.
@@ -1622,7 +1621,7 @@ function vim.api.nvim_list_tabpages() end
--- - "chan" |channel-id| of remote UI --- - "chan" |channel-id| of remote UI
function vim.api.nvim_list_uis() end function vim.api.nvim_list_uis() end
--- Gets the current list of window handles. --- Gets the current list of all `window-ID`s in all tabpages.
--- ---
--- @return integer[] # List of |window-ID|s --- @return integer[] # List of |window-ID|s
function vim.api.nvim_list_wins() end function vim.api.nvim_list_wins() end
@@ -2069,7 +2068,7 @@ function vim.api.nvim_select_popupmenu_item(item, insert, finish, opts) end
--- Sets the current window's buffer to `buffer`. --- Sets the current window's buffer to `buffer`.
--- ---
--- @param buffer integer Buffer handle --- @param buffer integer Buffer id
function vim.api.nvim_set_current_buf(buffer) end function vim.api.nvim_set_current_buf(buffer) end
--- Changes the global working directory. --- Changes the global working directory.
@@ -2087,7 +2086,7 @@ function vim.api.nvim_set_current_line(line) end
--- @param tabpage integer `tab-ID` to focus --- @param tabpage integer `tab-ID` to focus
function vim.api.nvim_set_current_tabpage(tabpage) end function vim.api.nvim_set_current_tabpage(tabpage) end
--- Sets the current window. Also changes tabpage, if necessary. --- Sets the current window (and tabpage, implicitly).
--- ---
--- @param window integer `window-ID` to focus --- @param window integer `window-ID` to focus
function vim.api.nvim_set_current_win(window) end function vim.api.nvim_set_current_win(window) end
@@ -2361,7 +2360,7 @@ function vim.api.nvim_win_del_var(window, name) end
--- Gets the current buffer in a window --- Gets the current buffer in a window
--- ---
--- @param window integer `window-ID`, or 0 for current window --- @param window integer `window-ID`, or 0 for current window
--- @return integer # Buffer handle --- @return integer # Buffer id
function vim.api.nvim_win_get_buf(window) end function vim.api.nvim_win_get_buf(window) end
--- Gets window configuration. --- Gets window configuration.
@@ -2446,7 +2445,7 @@ function vim.api.nvim_win_is_valid(window) end
--- Sets the current buffer in a window, without side effects --- Sets the current buffer in a window, without side effects
--- ---
--- @param window integer `window-ID`, or 0 for current window --- @param window integer `window-ID`, or 0 for current window
--- @param buffer integer Buffer handle --- @param buffer integer Buffer id
function vim.api.nvim_win_set_buf(window, buffer) end function vim.api.nvim_win_set_buf(window, buffer) end
--- Configures window layout. Cannot be used to move the last window in a --- Configures window layout. Cannot be used to move the last window in a

7
runtime/lua/vim/_meta/options.lua generated
View File

@@ -2010,9 +2010,10 @@ vim.o.et = vim.o.expandtab
vim.bo.expandtab = vim.o.expandtab vim.bo.expandtab = vim.o.expandtab
vim.bo.et = vim.bo.expandtab vim.bo.et = vim.bo.expandtab
--- Automatically execute .nvim.lua, .nvimrc, and .exrc files in the --- Enables project-local configuration. Nvim will execute any .nvim.lua,
--- current directory, if the file is in the `trust` list. Use `:trust` to --- .nvimrc, or .exrc file found in the `current-directory`, if the file is
--- manage trusted files. See also `vim.secure.read()`. --- in the `trust` list. Use `:trust` to manage trusted files. See also
--- `vim.secure.read()`.
--- ---
--- Compare 'exrc' to `editorconfig`: --- Compare 'exrc' to `editorconfig`:
--- - 'exrc' can execute any code; editorconfig only specifies settings. --- - 'exrc' can execute any code; editorconfig only specifies settings.

60
runtime/lua/vim/_meta/vvars.lua generated
View File

@@ -160,45 +160,43 @@ vim.v.errors = ...
--- an aborting condition (e.g. `c_Esc` or --- an aborting condition (e.g. `c_Esc` or
--- `c_CTRL-C` for `CmdlineLeave`). --- `c_CTRL-C` for `CmdlineLeave`).
--- chan `channel-id` --- chan `channel-id`
--- info Dict of arbitrary event data. --- changed_window Is `v:true` if the event fired while
--- changing window (or tab) on `DirChanged`.
--- cmdlevel Level of cmdline. --- cmdlevel Level of cmdline.
--- cmdtype Type of cmdline, `cmdline-char`. --- cmdtype Type of cmdline, `cmdline-char`.
--- col Column count of popup menu on `CompleteChanged`,
--- relative to screen.
--- complete_type See `complete_info_mode`
--- complete_word The selected word, or empty if completion
--- was abandoned/discarded.
--- completed_item Current selected item on `CompleteChanged`,
--- or `{}` if no item selected.
--- cwd Current working directory. --- cwd Current working directory.
--- height Height of popup menu on `CompleteChanged`
--- inclusive Motion is `inclusive`, else exclusive. --- inclusive Motion is `inclusive`, else exclusive.
--- scope Event-specific scope name. --- info Dict of arbitrary event data.
--- operator Current `operator`. Also set for Ex --- operator Current `operator`. Also set for Ex
--- commands (unlike `v:operator`). For --- commands (unlike `v:operator`). For
--- example if `TextYankPost` is triggered --- example if `TextYankPost` is triggered
--- by the `:yank` Ex command then --- by the `:yank` Ex command then
--- `v:event.operator` is "y". --- `v:event.operator` is "y".
--- reason `CompleteDone` reason.
--- regcontents Text stored in the register as a --- regcontents Text stored in the register as a
--- `readfile()`-style list of lines. --- `readfile()`-style list of lines.
--- regname Requested register (e.g "x" for "xyy) --- regname Requested register (e.g "x" for "xyy), or
--- or the empty string for an unnamed --- empty string for an unnamed operation.
--- operation.
--- regtype Type of register as returned by --- regtype Type of register as returned by
--- `getregtype()`. --- `getregtype()`.
--- visual Selection is visual (as opposed to,
--- e.g., via motion).
--- completed_item Current selected complete item on
--- `CompleteChanged`, Is `{}` when no complete
--- item selected.
--- height Height of popup menu on `CompleteChanged`
--- width Width of popup menu on `CompleteChanged`
--- row Row count of popup menu on `CompleteChanged`, --- row Row count of popup menu on `CompleteChanged`,
--- relative to screen. --- relative to screen.
--- col Col count of popup menu on `CompleteChanged`, --- scope Event-specific scope name.
--- relative to screen. --- scrollbar `v:true` if popup menu has a scrollbar, or
--- `v:false` if not.
--- size Total number of completion items on --- size Total number of completion items on
--- `CompleteChanged`. --- `CompleteChanged`.
--- scrollbar Is `v:true` if popup menu have scrollbar, or
--- `v:false` if not.
--- changed_window Is `v:true` if the event fired while
--- changing window (or tab) on `DirChanged`.
--- status Job status or exit code, -1 means "unknown". `TermClose` --- status Job status or exit code, -1 means "unknown". `TermClose`
--- reason Reason for completion being done. `CompleteDone` --- visual Selection is visual (as opposed to e.g. a motion range).
--- complete_word The word that was selected, empty if abandoned complete. --- width Width of popup menu on `CompleteChanged`
--- complete_type See `complete_info_mode`
--- windows List of window IDs that changed on `WinResized` --- windows List of window IDs that changed on `WinResized`
--- @type vim.v.event --- @type vim.v.event
vim.v.event = ... vim.v.event = ...
@@ -590,15 +588,21 @@ vim.v.searchforward = ...
--- *$NVIM* --- *$NVIM*
--- $NVIM is set by `terminal` and `jobstart()`, and is thus --- $NVIM is set by `terminal` and `jobstart()`, and is thus
--- a hint that the current environment is a subprocess of Nvim. --- a hint that the current environment is a subprocess of Nvim.
--- Example:
--- ---
--- ```vim --- Example: a child Nvim process can detect and make requests to
--- if $NVIM --- its parent Nvim:
--- echo nvim_get_chan_info(v:parent) ---
--- endif --- ```lua
---
--- if vim.env.NVIM then
--- local ok, chan = pcall(vim.fn.sockconnect, 'pipe', vim.env.NVIM, {rpc=true})
--- if ok and chan then
--- local client = vim.api.nvim_get_chan_info(chan).client
--- local rv = vim.rpcrequest(chan, 'nvim_exec_lua', [[return ... + 1]], { 41 })
--- vim.print(('got "%s" from parent Nvim'):format(rv))
--- end
--- end
--- ``` --- ```
---
--- Note the contents of $NVIM may change in the future.
--- @type string --- @type string
vim.v.servername = ... vim.v.servername = ...

2
runtime/lua/vim/lsp/completion.lua
View File

@@ -6,6 +6,8 @@
--- ---
--- Example: activate LSP-driven auto-completion: --- Example: activate LSP-driven auto-completion:
--- ```lua --- ```lua
--- -- Works best with completeopt=noselect.
--- vim.cmd[[set completeopt+=menuone,noselect,popup]]
--- vim.lsp.start({ --- vim.lsp.start({
--- name = 'ts_ls', --- name = 'ts_ls',
--- cmd = …, --- cmd = …,

65
src/nvim/api/buffer.c
View File

@@ -67,7 +67,7 @@
/// Returns the number of lines in the given buffer. /// Returns the number of lines in the given buffer.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Line count, or 0 for unloaded buffer. |api-buffer| /// @return Line count, or 0 for unloaded buffer. |api-buffer|
Integer nvim_buf_line_count(Buffer buffer, Error *err) Integer nvim_buf_line_count(Buffer buffer, Error *err)
@@ -105,7 +105,7 @@ Integer nvim_buf_line_count(Buffer buffer, Error *err)
/// @see |api-buffer-updates-lua| /// @see |api-buffer-updates-lua|
/// ///
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param send_buffer True if the initial notification should contain the /// @param send_buffer True if the initial notification should contain the
/// whole buffer: first notification will be `nvim_buf_lines_event`. /// whole buffer: first notification will be `nvim_buf_lines_event`.
/// Else the first notification will be `nvim_buf_changedtick_event`. /// Else the first notification will be `nvim_buf_changedtick_event`.
@@ -114,7 +114,7 @@ Integer nvim_buf_line_count(Buffer buffer, Error *err)
/// - on_lines: Lua callback invoked on change. /// - on_lines: Lua callback invoked on change.
/// Return a truthy value (not `false` or `nil`) to detach. Args: /// Return a truthy value (not `false` or `nil`) to detach. Args:
/// - the string "lines" /// - the string "lines"
/// - buffer handle /// - buffer id
/// - b:changedtick /// - b:changedtick
/// - first line that changed (zero-indexed) /// - first line that changed (zero-indexed)
/// - last line that was changed /// - last line that was changed
@@ -127,7 +127,7 @@ Integer nvim_buf_line_count(Buffer buffer, Error *err)
/// change compared to on_lines. /// change compared to on_lines.
/// Return a truthy value (not `false` or `nil`) to detach. Args: /// Return a truthy value (not `false` or `nil`) to detach. Args:
/// - the string "bytes" /// - the string "bytes"
/// - buffer handle /// - buffer id
/// - b:changedtick /// - b:changedtick
/// - start row of the changed text (zero-indexed) /// - start row of the changed text (zero-indexed)
/// - start column of the changed text /// - start column of the changed text
@@ -144,15 +144,15 @@ Integer nvim_buf_line_count(Buffer buffer, Error *err)
/// - on_changedtick: Lua callback invoked on changedtick /// - on_changedtick: Lua callback invoked on changedtick
/// increment without text change. Args: /// increment without text change. Args:
/// - the string "changedtick" /// - the string "changedtick"
/// - buffer handle /// - buffer id
/// - b:changedtick /// - b:changedtick
/// - on_detach: Lua callback invoked on detach. Args: /// - on_detach: Lua callback invoked on detach. Args:
/// - the string "detach" /// - the string "detach"
/// - buffer handle /// - buffer id
/// - on_reload: Lua callback invoked on reload. The entire buffer /// - on_reload: Lua callback invoked on reload. The entire buffer
/// content should be considered changed. Args: /// content should be considered changed. Args:
/// - the string "reload" /// - the string "reload"
/// - buffer handle /// - buffer id
/// - utf_sizes: include UTF-32 and UTF-16 size of the replaced /// - utf_sizes: include UTF-32 and UTF-16 size of the replaced
/// region, as args to `on_lines`. /// region, as args to `on_lines`.
/// - preview: also attach to command preview (i.e. 'inccommand') /// - preview: also attach to command preview (i.e. 'inccommand')
@@ -212,7 +212,7 @@ Boolean nvim_buf_attach(uint64_t channel_id, Buffer buffer, Boolean send_buffer,
/// @see |api-lua-detach| for detaching Lua callbacks /// @see |api-lua-detach| for detaching Lua callbacks
/// ///
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return False if detach failed (because the buffer isn't loaded); /// @return False if detach failed (because the buffer isn't loaded);
/// otherwise True. /// otherwise True.
@@ -238,8 +238,10 @@ Boolean nvim_buf_detach(uint64_t channel_id, Buffer buffer, Error *err)
/// Out-of-bounds indices are clamped to the nearest valid value, unless /// Out-of-bounds indices are clamped to the nearest valid value, unless
/// `strict_indexing` is set. /// `strict_indexing` is set.
/// ///
/// @see |nvim_buf_get_text()|
///
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param start First line index /// @param start First line index
/// @param end Last line index, exclusive /// @param end Last line index, exclusive
/// @param strict_indexing Whether out-of-bounds should be an error. /// @param strict_indexing Whether out-of-bounds should be an error.
@@ -294,7 +296,7 @@ ArrayOf(String) nvim_buf_get_lines(uint64_t channel_id,
/// ///
/// Indexing is zero-based, end-exclusive. Negative indices are interpreted /// Indexing is zero-based, end-exclusive. Negative indices are interpreted
/// as length+1+index: -1 refers to the index past the end. So to change /// as length+1+index: -1 refers to the index past the end. So to change
/// or delete the last element use start=-2 and end=-1. /// or delete the last line use start=-2 and end=-1.
/// ///
/// To insert lines at a given index, set `start` and `end` to the same index. /// To insert lines at a given index, set `start` and `end` to the same index.
/// To delete a range of lines, set `replacement` to an empty array. /// To delete a range of lines, set `replacement` to an empty array.
@@ -305,7 +307,7 @@ ArrayOf(String) nvim_buf_get_lines(uint64_t channel_id,
/// @see |nvim_buf_set_text()| /// @see |nvim_buf_set_text()|
/// ///
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param start First line index /// @param start First line index
/// @param end Last line index, exclusive /// @param end Last line index, exclusive
/// @param strict_indexing Whether out-of-bounds should be an error. /// @param strict_indexing Whether out-of-bounds should be an error.
@@ -463,7 +465,7 @@ void nvim_buf_set_lines(uint64_t channel_id, Buffer buffer, Integer start, Integ
/// @note Prefer |nvim_paste()| or |nvim_put()| to insert (instead of replace) text at cursor. /// @note Prefer |nvim_paste()| or |nvim_put()| to insert (instead of replace) text at cursor.
/// ///
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param start_row First line index /// @param start_row First line index
/// @param start_col Starting column (byte offset) on first line /// @param start_col Starting column (byte offset) on first line
/// @param end_row Last line index, inclusive /// @param end_row Last line index, inclusive
@@ -685,10 +687,7 @@ void nvim_buf_set_text(uint64_t channel_id, Buffer buffer, Integer start_row, In
}); });
} }
/// Gets a range from the buffer. /// Gets a range from the buffer (may be partial lines, unlike |nvim_buf_get_lines()|).
///
/// This differs from |nvim_buf_get_lines()| in that it allows retrieving only
/// portions of a line.
/// ///
/// Indexing is zero-based. Row indices are end-inclusive, and column indices /// Indexing is zero-based. Row indices are end-inclusive, and column indices
/// are end-exclusive. /// are end-exclusive.
@@ -696,7 +695,7 @@ void nvim_buf_set_text(uint64_t channel_id, Buffer buffer, Integer start_row, In
/// Prefer |nvim_buf_get_lines()| when retrieving entire lines. /// Prefer |nvim_buf_get_lines()| when retrieving entire lines.
/// ///
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param start_row First line index /// @param start_row First line index
/// @param start_col Starting column (byte offset) on first line /// @param start_col Starting column (byte offset) on first line
/// @param end_row Last line index, inclusive /// @param end_row Last line index, inclusive
@@ -790,7 +789,7 @@ end:
/// Unlike |line2byte()|, throws error for out-of-bounds indexing. /// Unlike |line2byte()|, throws error for out-of-bounds indexing.
/// Returns -1 for unloaded buffer. /// Returns -1 for unloaded buffer.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param index Line index /// @param index Line index
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Integer byte offset, or -1 for unloaded buffer. /// @return Integer byte offset, or -1 for unloaded buffer.
@@ -816,7 +815,7 @@ Integer nvim_buf_get_offset(Buffer buffer, Integer index, Error *err)
/// Gets a buffer-scoped (b:) variable. /// Gets a buffer-scoped (b:) variable.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Variable name /// @param name Variable name
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Variable value /// @return Variable value
@@ -834,7 +833,7 @@ Object nvim_buf_get_var(Buffer buffer, String name, Arena *arena, Error *err)
/// Gets a changed tick of a buffer /// Gets a changed tick of a buffer
/// ///
/// @param[in] buffer Buffer handle, or 0 for current buffer /// @param[in] buffer Buffer id, or 0 for current buffer
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// ///
/// @return `b:changedtick` value. /// @return `b:changedtick` value.
@@ -852,11 +851,11 @@ Integer nvim_buf_get_changedtick(Buffer buffer, Error *err)
/// Gets a list of buffer-local |mapping| definitions. /// Gets a list of buffer-local |mapping| definitions.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param mode Mode short-name ("n", "i", "v", ...) /// @param mode Mode short-name ("n", "i", "v", ...)
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @returns Array of |maparg()|-like dictionaries describing mappings. /// @returns Array of |maparg()|-like dictionaries describing mappings.
/// The "buffer" key holds the associated buffer handle. /// The "buffer" key holds the associated buffer id.
ArrayOf(Dict) nvim_buf_get_keymap(Buffer buffer, String mode, Arena *arena, Error *err) ArrayOf(Dict) nvim_buf_get_keymap(Buffer buffer, String mode, Arena *arena, Error *err)
FUNC_API_SINCE(3) FUNC_API_SINCE(3)
{ {
@@ -873,7 +872,7 @@ ArrayOf(Dict) nvim_buf_get_keymap(Buffer buffer, String mode, Arena *arena, Erro
/// ///
/// @see |nvim_set_keymap()| /// @see |nvim_set_keymap()|
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
void nvim_buf_set_keymap(uint64_t channel_id, Buffer buffer, String mode, String lhs, String rhs, void nvim_buf_set_keymap(uint64_t channel_id, Buffer buffer, String mode, String lhs, String rhs,
Dict(keymap) *opts, Error *err) Dict(keymap) *opts, Error *err)
FUNC_API_SINCE(6) FUNC_API_SINCE(6)
@@ -885,7 +884,7 @@ void nvim_buf_set_keymap(uint64_t channel_id, Buffer buffer, String mode, String
/// ///
/// @see |nvim_del_keymap()| /// @see |nvim_del_keymap()|
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
void nvim_buf_del_keymap(uint64_t channel_id, Buffer buffer, String mode, String lhs, Error *err) void nvim_buf_del_keymap(uint64_t channel_id, Buffer buffer, String mode, String lhs, Error *err)
FUNC_API_SINCE(6) FUNC_API_SINCE(6)
{ {
@@ -895,7 +894,7 @@ void nvim_buf_del_keymap(uint64_t channel_id, Buffer buffer, String mode, String
/// Sets a buffer-scoped (b:) variable /// Sets a buffer-scoped (b:) variable
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Variable name /// @param name Variable name
/// @param value Variable value /// @param value Variable value
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
@@ -913,7 +912,7 @@ void nvim_buf_set_var(Buffer buffer, String name, Object value, Error *err)
/// Removes a buffer-scoped (b:) variable /// Removes a buffer-scoped (b:) variable
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Variable name /// @param name Variable name
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
void nvim_buf_del_var(Buffer buffer, String name, Error *err) void nvim_buf_del_var(Buffer buffer, String name, Error *err)
@@ -930,7 +929,7 @@ void nvim_buf_del_var(Buffer buffer, String name, Error *err)
/// Gets the full file name for the buffer /// Gets the full file name for the buffer
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Buffer name /// @return Buffer name
String nvim_buf_get_name(Buffer buffer, Error *err) String nvim_buf_get_name(Buffer buffer, Error *err)
@@ -948,7 +947,7 @@ String nvim_buf_get_name(Buffer buffer, Error *err)
/// Sets the full file name for a buffer, like |:file_f| /// Sets the full file name for a buffer, like |:file_f|
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Buffer name /// @param name Buffer name
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
void nvim_buf_set_name(Buffer buffer, String name, Error *err) void nvim_buf_set_name(Buffer buffer, String name, Error *err)
@@ -992,7 +991,7 @@ void nvim_buf_set_name(Buffer buffer, String name, Error *err)
/// Checks if a buffer is valid and loaded. See |api-buffer| for more info /// Checks if a buffer is valid and loaded. See |api-buffer| for more info
/// about unloaded buffers. /// about unloaded buffers.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @return true if the buffer is valid and loaded, false otherwise. /// @return true if the buffer is valid and loaded, false otherwise.
Boolean nvim_buf_is_loaded(Buffer buffer) Boolean nvim_buf_is_loaded(Buffer buffer)
FUNC_API_SINCE(5) FUNC_API_SINCE(5)
@@ -1005,7 +1004,7 @@ Boolean nvim_buf_is_loaded(Buffer buffer)
/// Deletes the buffer. See |:bwipeout| /// Deletes the buffer. See |:bwipeout|
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param opts Optional parameters. Keys: /// @param opts Optional parameters. Keys:
/// - force: Force deletion and ignore unsaved changes. /// - force: Force deletion and ignore unsaved changes.
/// - unload: Unloaded only, do not delete. See |:bunload| /// - unload: Unloaded only, do not delete. See |:bunload|
@@ -1040,7 +1039,7 @@ void nvim_buf_delete(Buffer buffer, Dict(buf_delete) *opts, Error *err)
/// @note Even if a buffer is valid it may have been unloaded. See |api-buffer| /// @note Even if a buffer is valid it may have been unloaded. See |api-buffer|
/// for more info about unloaded buffers. /// for more info about unloaded buffers.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @return true if the buffer is valid, false otherwise. /// @return true if the buffer is valid, false otherwise.
Boolean nvim_buf_is_valid(Buffer buffer) Boolean nvim_buf_is_valid(Buffer buffer)
FUNC_API_SINCE(1) FUNC_API_SINCE(1)
@@ -1131,7 +1130,7 @@ Boolean nvim_buf_set_mark(Buffer buffer, String name, Integer line, Integer col,
/// ///
/// Marks are (1,0)-indexed. |api-indexing| /// Marks are (1,0)-indexed. |api-indexing|
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Mark name /// @param name Mark name
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return (row, col) tuple, (0, 0) if the mark is not set, or is an /// @return (row, col) tuple, (0, 0) if the mark is not set, or is an
@@ -1187,7 +1186,7 @@ ArrayOf(Integer, 2) nvim_buf_get_mark(Buffer buffer, String name, Arena *arena,
/// This is useful e.g. to call Vimscript functions that only work with the /// This is useful e.g. to call Vimscript functions that only work with the
/// current buffer/window currently, like `jobstart(…, {'term': v:true})`. /// current buffer/window currently, like `jobstart(…, {'term': v:true})`.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param fun Function to call inside the buffer (currently Lua callable /// @param fun Function to call inside the buffer (currently Lua callable
/// only) /// only)
/// @param[out] err Error details, if any /// @param[out] err Error details, if any

6
src/nvim/api/command.c
View File

@@ -897,7 +897,7 @@ void nvim_del_user_command(String name, Error *err)
/// Creates a buffer-local command |user-commands|. /// Creates a buffer-local command |user-commands|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer. /// @param buffer Buffer id, or 0 for current buffer.
/// @param[out] err Error details, if any. /// @param[out] err Error details, if any.
/// @see nvim_create_user_command /// @see nvim_create_user_command
void nvim_buf_create_user_command(uint64_t channel_id, Buffer buffer, String name, Object command, void nvim_buf_create_user_command(uint64_t channel_id, Buffer buffer, String name, Object command,
@@ -920,7 +920,7 @@ void nvim_buf_create_user_command(uint64_t channel_id, Buffer buffer, String nam
/// Only commands created with |:command-buffer| or /// Only commands created with |:command-buffer| or
/// |nvim_buf_create_user_command()| can be deleted with this function. /// |nvim_buf_create_user_command()| can be deleted with this function.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer. /// @param buffer Buffer id, or 0 for current buffer.
/// @param name Name of the command to delete. /// @param name Name of the command to delete.
/// @param[out] err Error details, if any. /// @param[out] err Error details, if any.
void nvim_buf_del_user_command(Buffer buffer, String name, Error *err) void nvim_buf_del_user_command(Buffer buffer, String name, Error *err)
@@ -1178,7 +1178,7 @@ Dict nvim_get_commands(Dict(get_commands) *opts, Arena *arena, Error *err)
/// Gets a map of buffer-local |user-commands|. /// Gets a map of buffer-local |user-commands|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param opts Optional parameters. Currently not used. /// @param opts Optional parameters. Currently not used.
/// @param[out] err Error details, if any. /// @param[out] err Error details, if any.
/// ///

28
src/nvim/api/deprecated.c
View File

@@ -69,7 +69,7 @@ Object nvim_execute_lua(String code, Array args, Arena *arena, Error *err)
/// ///
/// @deprecated The buffer number now is equal to the object id /// @deprecated The buffer number now is equal to the object id
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Buffer number /// @return Buffer number
Integer nvim_buf_get_number(Buffer buffer, Error *err) Integer nvim_buf_get_number(Buffer buffer, Error *err)
@@ -100,7 +100,7 @@ static uint32_t src2ns(Integer *src_id)
/// ///
/// @deprecated use |nvim_buf_clear_namespace()|. /// @deprecated use |nvim_buf_clear_namespace()|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param ns_id Namespace to clear, or -1 to clear all. /// @param ns_id Namespace to clear, or -1 to clear all.
/// @param line_start Start of range of lines to clear /// @param line_start Start of range of lines to clear
/// @param line_end End of range of lines to clear (exclusive) or -1 to clear /// @param line_end End of range of lines to clear (exclusive) or -1 to clear
@@ -131,7 +131,7 @@ void nvim_buf_clear_highlight(Buffer buffer, Integer ns_id, Integer line_start,
/// supported for backwards compatibility, new code should use /// supported for backwards compatibility, new code should use
/// |nvim_create_namespace()| to create a new empty namespace. /// |nvim_create_namespace()| to create a new empty namespace.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param ns_id namespace to use or -1 for ungrouped highlight /// @param ns_id namespace to use or -1 for ungrouped highlight
/// @param hl_group Name of the highlight group to use /// @param hl_group Name of the highlight group to use
/// @param line Line to highlight (zero-indexed) /// @param line Line to highlight (zero-indexed)
@@ -207,7 +207,7 @@ Integer nvim_buf_add_highlight(Buffer buffer, Integer ns_id, String hl_group, In
/// As a shorthand, `ns_id = 0` can be used to create a new namespace for the /// As a shorthand, `ns_id = 0` can be used to create a new namespace for the
/// virtual text, the allocated id is then returned. /// virtual text, the allocated id is then returned.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param src_id Namespace to use or 0 to create a namespace, /// @param src_id Namespace to use or 0 to create a namespace,
/// or -1 for a ungrouped annotation /// or -1 for a ungrouped annotation
/// @param line Line to annotate with virtual text (zero-indexed) /// @param line Line to annotate with virtual text (zero-indexed)
@@ -309,7 +309,7 @@ Dict nvim_get_hl_by_name(String name, Boolean rgb, Arena *arena, Error *err)
/// ///
/// @deprecated use nvim_buf_set_lines(buffer, lnum, lnum, true, lines) /// @deprecated use nvim_buf_set_lines(buffer, lnum, lnum, true, lines)
/// ///
/// @param buffer Buffer handle /// @param buffer Buffer id
/// @param lnum Insert the lines after `lnum`. If negative, appends to /// @param lnum Insert the lines after `lnum`. If negative, appends to
/// the end of the buffer. /// the end of the buffer.
/// @param lines Array of lines /// @param lines Array of lines
@@ -330,7 +330,7 @@ void buffer_insert(Buffer buffer, Integer lnum, ArrayOf(String) lines, Arena *ar
/// for negative indices use /// for negative indices use
/// "nvim_buf_get_lines(buffer, index-1, index, true)" /// "nvim_buf_get_lines(buffer, index-1, index, true)"
/// ///
/// @param buffer Buffer handle /// @param buffer Buffer id
/// @param index Line index /// @param index Line index
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Line string /// @return Line string
@@ -357,7 +357,7 @@ String buffer_get_line(Buffer buffer, Integer index, Arena *arena, Error *err)
/// for negative indices use /// for negative indices use
/// "nvim_buf_set_lines(buffer, index-1, index, true, [line])" /// "nvim_buf_set_lines(buffer, index-1, index, true, [line])"
/// ///
/// @param buffer Buffer handle /// @param buffer Buffer id
/// @param index Line index /// @param index Line index
/// @param line Contents of the new line /// @param line Contents of the new line
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
@@ -377,7 +377,7 @@ void buffer_set_line(Buffer buffer, Integer index, String line, Arena *arena, Er
/// "nvim_buf_set_lines(buffer, index, index+1, true, [])" /// "nvim_buf_set_lines(buffer, index, index+1, true, [])"
/// for negative indices use /// for negative indices use
/// "nvim_buf_set_lines(buffer, index-1, index, true, [])" /// "nvim_buf_set_lines(buffer, index-1, index, true, [])"
/// @param buffer buffer handle /// @param buffer buffer id
/// @param index line index /// @param index line index
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
void buffer_del_line(Buffer buffer, Integer index, Arena *arena, Error *err) void buffer_del_line(Buffer buffer, Integer index, Arena *arena, Error *err)
@@ -394,7 +394,7 @@ void buffer_del_line(Buffer buffer, Integer index, Arena *arena, Error *err)
/// where newstart = start + int(not include_start) - int(start < 0) /// where newstart = start + int(not include_start) - int(start < 0)
/// newend = end + int(include_end) - int(end < 0) /// newend = end + int(include_end) - int(end < 0)
/// int(bool) = 1 if bool is true else 0 /// int(bool) = 1 if bool is true else 0
/// @param buffer Buffer handle /// @param buffer Buffer id
/// @param start First line index /// @param start First line index
/// @param end Last line index /// @param end Last line index
/// @param include_start True if the slice includes the `start` parameter /// @param include_start True if the slice includes the `start` parameter
@@ -422,7 +422,7 @@ ArrayOf(String) buffer_get_line_slice(Buffer buffer,
/// newend = end + int(include_end) + int(end < 0) /// newend = end + int(include_end) + int(end < 0)
/// int(bool) = 1 if bool is true else 0 /// int(bool) = 1 if bool is true else 0
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param start First line index /// @param start First line index
/// @param end Last line index /// @param end Last line index
/// @param include_start True if the slice includes the `start` parameter /// @param include_start True if the slice includes the `start` parameter
@@ -444,7 +444,7 @@ void buffer_set_line_slice(Buffer buffer, Integer start, Integer end, Boolean in
/// ///
/// @deprecated /// @deprecated
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Variable name /// @param name Variable name
/// @param value Variable value /// @param value Variable value
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
@@ -468,7 +468,7 @@ Object buffer_set_var(Buffer buffer, String name, Object value, Arena *arena, Er
/// ///
/// @deprecated /// @deprecated
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Variable name /// @param name Variable name
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Old value /// @return Old value
@@ -641,7 +641,7 @@ Object nvim_get_option(String name, Error *err)
/// Gets a buffer option value /// Gets a buffer option value
/// ///
/// @deprecated /// @deprecated
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Option name /// @param name Option name
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Option value /// @return Option value
@@ -664,7 +664,7 @@ Object nvim_buf_get_option(Buffer buffer, String name, Error *err)
/// ///
/// @deprecated /// @deprecated
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param name Option name /// @param name Option name
/// @param value Option value /// @param value Option value
/// @param[out] err Error details, if any /// @param[out] err Error details, if any

10
src/nvim/api/extmark.c
View File

@@ -192,7 +192,7 @@ static Array extmark_to_array(MTPair extmark, bool id, bool add_dict, bool hl_na
/// Gets the position (0-indexed) of an |extmark|. /// Gets the position (0-indexed) of an |extmark|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param ns_id Namespace id from |nvim_create_namespace()| /// @param ns_id Namespace id from |nvim_create_namespace()|
/// @param id Extmark id /// @param id Extmark id
/// @param opts Optional parameters. Keys: /// @param opts Optional parameters. Keys:
@@ -269,7 +269,7 @@ ArrayOf(Integer) nvim_buf_get_extmark_by_id(Buffer buffer, Integer ns_id,
/// vim.print(ms) /// vim.print(ms)
/// ``` /// ```
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param ns_id Namespace id from |nvim_create_namespace()| or -1 for all namespaces /// @param ns_id Namespace id from |nvim_create_namespace()| or -1 for all namespaces
/// @param start Start of range: a 0-indexed (row, col) or valid extmark id /// @param start Start of range: a 0-indexed (row, col) or valid extmark id
/// (whose position defines the bound). |api-indexing| /// (whose position defines the bound). |api-indexing|
@@ -374,7 +374,7 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
/// An earlier end position is not an error, but then it behaves like an empty /// An earlier end position is not an error, but then it behaves like an empty
/// range (no highlighting). /// range (no highlighting).
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param ns_id Namespace id from |nvim_create_namespace()| /// @param ns_id Namespace id from |nvim_create_namespace()|
/// @param line Line where to place the mark, 0-based. |api-indexing| /// @param line Line where to place the mark, 0-based. |api-indexing|
/// @param col Column where to place the mark, 0-based. |api-indexing| /// @param col Column where to place the mark, 0-based. |api-indexing|
@@ -922,7 +922,7 @@ error:
/// Removes an |extmark|. /// Removes an |extmark|.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param ns_id Namespace id from |nvim_create_namespace()| /// @param ns_id Namespace id from |nvim_create_namespace()|
/// @param id Extmark id /// @param id Extmark id
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
@@ -948,7 +948,7 @@ Boolean nvim_buf_del_extmark(Buffer buffer, Integer ns_id, Integer id, Error *er
/// Lines are 0-indexed. |api-indexing| To clear the namespace in the entire /// Lines are 0-indexed. |api-indexing| To clear the namespace in the entire
/// buffer, specify line_start=0 and line_end=-1. /// buffer, specify line_start=0 and line_end=-1.
/// ///
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer id, or 0 for current buffer
/// @param ns_id Namespace to clear, or -1 to clear all namespaces. /// @param ns_id Namespace to clear, or -1 to clear all namespaces.
/// @param line_start Start of range of lines to clear /// @param line_start Start of range of lines to clear
/// @param line_end End of range of lines to clear (exclusive) or -1 to clear /// @param line_end End of range of lines to clear (exclusive) or -1 to clear

2
src/nvim/api/private/helpers.c
View File

@@ -472,7 +472,7 @@ int64_t normalize_index(buf_T *buf, int64_t index, bool end_exclusive, bool *oob
/// Returns a substring of a buffer line /// Returns a substring of a buffer line
/// ///
/// @param buf Buffer handle /// @param buf Buffer id
/// @param lnum Line number (1-based) /// @param lnum Line number (1-based)
/// @param start_col Starting byte offset into line (0-based) /// @param start_col Starting byte offset into line (0-based)
/// @param end_col Ending byte offset into line (0-based, exclusive) /// @param end_col Ending byte offset into line (0-based, exclusive)

14
src/nvim/api/vim.c
View File

@@ -790,12 +790,12 @@ error:
hl_msg_free(hl_msg); hl_msg_free(hl_msg);
} }
/// Gets the current list of buffer handles /// Gets the current list of buffers.
/// ///
/// Includes unlisted (unloaded/deleted) buffers, like `:ls!`. /// Includes unlisted (unloaded/deleted) buffers, like `:ls!`.
/// Use |nvim_buf_is_loaded()| to check if a buffer is loaded. /// Use |nvim_buf_is_loaded()| to check if a buffer is loaded.
/// ///
/// @return List of buffer handles /// @return List of buffer ids
ArrayOf(Buffer) nvim_list_bufs(Arena *arena) ArrayOf(Buffer) nvim_list_bufs(Arena *arena)
FUNC_API_SINCE(1) FUNC_API_SINCE(1)
{ {
@@ -816,7 +816,7 @@ ArrayOf(Buffer) nvim_list_bufs(Arena *arena)
/// Gets the current buffer. /// Gets the current buffer.
/// ///
/// @return Buffer handle /// @return Buffer id
Buffer nvim_get_current_buf(void) Buffer nvim_get_current_buf(void)
FUNC_API_SINCE(1) FUNC_API_SINCE(1)
{ {
@@ -825,7 +825,7 @@ Buffer nvim_get_current_buf(void)
/// Sets the current window's buffer to `buffer`. /// Sets the current window's buffer to `buffer`.
/// ///
/// @param buffer Buffer handle /// @param buffer Buffer id
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
void nvim_set_current_buf(Buffer buffer, Error *err) void nvim_set_current_buf(Buffer buffer, Error *err)
FUNC_API_SINCE(1) FUNC_API_SINCE(1)
@@ -842,7 +842,7 @@ void nvim_set_current_buf(Buffer buffer, Error *err)
}); });
} }
/// Gets the current list of window handles. /// Gets the current list of all |window-ID|s in all tabpages.
/// ///
/// @return List of |window-ID|s /// @return List of |window-ID|s
ArrayOf(Window) nvim_list_wins(Arena *arena) ArrayOf(Window) nvim_list_wins(Arena *arena)
@@ -872,7 +872,7 @@ Window nvim_get_current_win(void)
return curwin->handle; return curwin->handle;
} }
/// Sets the current window. Also changes tabpage, if necessary. /// Sets the current window (and tabpage, implicitly).
/// ///
/// @param window |window-ID| to focus /// @param window |window-ID| to focus
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
@@ -897,7 +897,7 @@ void nvim_set_current_win(Window window, Error *err)
/// @param scratch Creates a "throwaway" |scratch-buffer| for temporary work /// @param scratch Creates a "throwaway" |scratch-buffer| for temporary work
/// (always 'nomodified'). Also sets 'nomodeline' on the buffer. /// (always 'nomodified'). Also sets 'nomodeline' on the buffer.
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Buffer handle, or 0 on error /// @return Buffer id, or 0 on error
/// ///
/// @see buf_open_scratch /// @see buf_open_scratch
Buffer nvim_create_buf(Boolean listed, Boolean scratch, Error *err) Buffer nvim_create_buf(Boolean listed, Boolean scratch, Error *err)

4
src/nvim/api/window.c
View File

@@ -34,7 +34,7 @@
/// ///
/// @param window |window-ID|, or 0 for current window /// @param window |window-ID|, or 0 for current window
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
/// @return Buffer handle /// @return Buffer id
Buffer nvim_win_get_buf(Window window, Error *err) Buffer nvim_win_get_buf(Window window, Error *err)
FUNC_API_SINCE(1) FUNC_API_SINCE(1)
{ {
@@ -50,7 +50,7 @@ Buffer nvim_win_get_buf(Window window, Error *err)
/// Sets the current buffer in a window, without side effects /// Sets the current buffer in a window, without side effects
/// ///
/// @param window |window-ID|, or 0 for current window /// @param window |window-ID|, or 0 for current window
/// @param buffer Buffer handle /// @param buffer Buffer id
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
void nvim_win_set_buf(Window window, Buffer buffer, Error *err) void nvim_win_set_buf(Window window, Buffer buffer, Error *err)
FUNC_API_SINCE(5) FUNC_API_SINCE(5)

8
src/nvim/options.lua
View File

@@ -2663,9 +2663,10 @@ local options = {
abbreviation = 'ex', abbreviation = 'ex',
defaults = false, defaults = false,
desc = [=[ desc = [=[
Automatically execute .nvim.lua, .nvimrc, and .exrc files in the Enables project-local configuration. Nvim will execute any .nvim.lua,
current directory, if the file is in the |trust| list. Use |:trust| to .nvimrc, or .exrc file found in the |current-directory|, if the file is
manage trusted files. See also |vim.secure.read()|. in the |trust| list. Use |:trust| to manage trusted files. See also
|vim.secure.read()|.
Compare 'exrc' to |editorconfig|: Compare 'exrc' to |editorconfig|:
- 'exrc' can execute any code; editorconfig only specifies settings. - 'exrc' can execute any code; editorconfig only specifies settings.
@@ -2678,6 +2679,7 @@ local options = {
scope = { 'global' }, scope = { 'global' },
secure = true, secure = true,
short_desc = N_('read .nvimrc and .exrc in the current directory'), short_desc = N_('read .nvimrc and .exrc in the current directory'),
tags = { 'project-config', 'workspace-config' },
type = 'boolean', type = 'boolean',
varname = 'p_exrc', varname = 'p_exrc',
}, },

58
src/nvim/vvars.lua
View File

@@ -175,45 +175,43 @@ M.vars = {
an aborting condition (e.g. |c_Esc| or an aborting condition (e.g. |c_Esc| or
|c_CTRL-C| for |CmdlineLeave|). |c_CTRL-C| for |CmdlineLeave|).
chan |channel-id| chan |channel-id|
info Dict of arbitrary event data. changed_window Is |v:true| if the event fired while
changing window (or tab) on |DirChanged|.
cmdlevel Level of cmdline. cmdlevel Level of cmdline.
cmdtype Type of cmdline, |cmdline-char|. cmdtype Type of cmdline, |cmdline-char|.
col Column count of popup menu on |CompleteChanged|,
relative to screen.
complete_type See |complete_info_mode|
complete_word The selected word, or empty if completion
was abandoned/discarded.
completed_item Current selected item on |CompleteChanged|,
or `{}` if no item selected.
cwd Current working directory. cwd Current working directory.
height Height of popup menu on |CompleteChanged|
inclusive Motion is |inclusive|, else exclusive. inclusive Motion is |inclusive|, else exclusive.
scope Event-specific scope name. info Dict of arbitrary event data.
operator Current |operator|. Also set for Ex operator Current |operator|. Also set for Ex
commands (unlike |v:operator|). For commands (unlike |v:operator|). For
example if |TextYankPost| is triggered example if |TextYankPost| is triggered
by the |:yank| Ex command then by the |:yank| Ex command then
`v:event.operator` is "y". `v:event.operator` is "y".
reason |CompleteDone| reason.
regcontents Text stored in the register as a regcontents Text stored in the register as a
|readfile()|-style list of lines. |readfile()|-style list of lines.
regname Requested register (e.g "x" for "xyy) regname Requested register (e.g "x" for "xyy), or
or the empty string for an unnamed empty string for an unnamed operation.
operation.
regtype Type of register as returned by regtype Type of register as returned by
|getregtype()|. |getregtype()|.
visual Selection is visual (as opposed to,
e.g., via motion).
completed_item Current selected complete item on
|CompleteChanged|, Is `{}` when no complete
item selected.
height Height of popup menu on |CompleteChanged|
width Width of popup menu on |CompleteChanged|
row Row count of popup menu on |CompleteChanged|, row Row count of popup menu on |CompleteChanged|,
relative to screen. relative to screen.
col Col count of popup menu on |CompleteChanged|, scope Event-specific scope name.
relative to screen. scrollbar |v:true| if popup menu has a scrollbar, or
|v:false| if not.
size Total number of completion items on size Total number of completion items on
|CompleteChanged|. |CompleteChanged|.
scrollbar Is |v:true| if popup menu have scrollbar, or
|v:false| if not.
changed_window Is |v:true| if the event fired while
changing window (or tab) on |DirChanged|.
status Job status or exit code, -1 means "unknown". |TermClose| status Job status or exit code, -1 means "unknown". |TermClose|
reason Reason for completion being done. |CompleteDone| visual Selection is visual (as opposed to e.g. a motion range).
complete_word The word that was selected, empty if abandoned complete. width Width of popup menu on |CompleteChanged|
complete_type See |complete_info_mode|
windows List of window IDs that changed on |WinResized| windows List of window IDs that changed on |WinResized|
]=], ]=],
}, },
@@ -678,13 +676,19 @@ M.vars = {
*$NVIM* *$NVIM*
$NVIM is set by |terminal| and |jobstart()|, and is thus $NVIM is set by |terminal| and |jobstart()|, and is thus
a hint that the current environment is a subprocess of Nvim. a hint that the current environment is a subprocess of Nvim.
Example: >vim
if $NVIM
echo nvim_get_chan_info(v:parent)
endif
<
Note the contents of $NVIM may change in the future. Example: a child Nvim process can detect and make requests to
its parent Nvim: >lua
if vim.env.NVIM then
local ok, chan = pcall(vim.fn.sockconnect, 'pipe', vim.env.NVIM, {rpc=true})
if ok and chan then
local client = vim.api.nvim_get_chan_info(chan).client
local rv = vim.rpcrequest(chan, 'nvim_exec_lua', [[return ... + 1]], { 41 })
vim.print(('got "%s" from parent Nvim'):format(rv))
end
end
<
]=], ]=],
}, },
shell_error = { shell_error = {