mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-07-31 04:39:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(api): tab-local option scope #39811

Browse Source 
Problem:
2d795face6 added support for tab-local options ('cmdheight')
to `nvim_get_option_value`, but not to:

    nvim_get_option_info2()
    nvim_set_option_value(…, { tab = … })
    gettabwinvar()

Solution:
- Update `options.lua` to model tab-local options. Introduce `kOptScopeTab`.
- Handle tab scope in the options layer so it works for all options APIs.

Note:
- No change to `gettabvar()`. Not sure if needed/wanted.

fix https://github.com/neovim/neovim/issues/31140
This commit is contained in:
Justin M. Keyes
2026-05-17 10:24:46 -04:00
committed by GitHub
parent c55b6128f8
commit e572c9c80a
15 changed files with 297 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
src/nvim/eval.lua
View File

@@ -3593,22 +3593,25 @@ M.funcs = {
args = { 2, 3 },
base = 1,
desc = [=[
The result is the value of option or local buffer variable
{varname} in buffer {buf}. Note that the name without "b:"
must be used.
The {varname} argument is a string.
When {varname} is empty returns a |Dictionary| with all the
buffer-local variables.
When {varname} is equal to "&" returns a |Dictionary| with all
the buffer-local options.
Otherwise, when {varname} starts with "&" returns the value of
a buffer-local option.
This also works for a global or buffer-local option, but it
doesn't work for a global variable, window-local variable or
window-local option.
For the use of {buf}, see |bufname()| above.
When the buffer or variable doesn't exist {def} or an empty
string is returned, there is no error message.
Gets the value of a buffer-local variable or option {varname}
in buffer {buf}.
{varname} is a string:
- Name of the variable (without "b:").
- If empty, gets a |Dictionary| of all buffer-local variables.
- If "&", gets a |Dictionary| of all buffer-local options.
- If it starts with "&", gets the value of a buffer-local
option.
{buf} has the same form as in |bufname()|.
Also works for a global or buffer-local option. But not for
a global variable, window-local variable or window-local
option.
When the buffer or variable doesn't exist, {def} or an empty
string is returned; there is no error.
Examples: >vim
let bufmodified = getbufvar(1, "&mod")
echo "todo myvar = " .. getbufvar("todo", "myvar")
@@ -5006,29 +5009,34 @@ M.funcs = {
args = { 3, 4 },
base = 1,
desc = [=[
Get the value of window-local variable {varname} in window
{winnr} in tabpage {tabnr}.
The {varname} argument is a string. When {varname} is empty a
dictionary with all window-local variables is returned.
When {varname} is equal to "&" get the values of all
window-local options in a |Dictionary|.
Otherwise, when {varname} starts with "&" get the value of a
window-local option.
Note that {varname} must be the name without "w:".
Tabs are numbered starting with one. For the current tabpage
use |getwinvar()|.
{winnr} is a |window-number| or |window-ID|.
Gets the value of window-local variable {varname} in {winnr}
(|window-number| or |window-ID|) in |tabpage-number| {tabnr}.
{varname} is a string:
- Name of the variable (without "w:").
- If empty, gets a dictionary with all window-local variables.
- If "&", gets the values of all window-local options in
a |Dictionary|.
- If it starts with "&", gets the value of a window-local
option.
To get window-local variables in the current tabpage use
|getwinvar()|.
When {winnr} is zero the current window is used.
This also works for a global option, buffer-local option and
window-local option, but it doesn't work for a global variable
or buffer-local variable.
When the tab, window or variable doesn't exist {def} or an
empty string is returned, there is no error message.
Also works for a global option, buffer-local option,
window-local option, and tab-local option ('cmdheight').
But not for a global variable or buffer-local variable.
When the tab, window or variable doesn't exist, {def} or an
empty string is returned; there is no error.
Examples: >vim
let list_is_on = gettabwinvar(1, 2, '&list')
echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
<
To obtain all window-local variables use: >vim
To get all window-local variables: >vim
gettabwinvar({tabnr}, {winnr}, '&')
<
]=],