feat(ui): don't show unfocusable windows in :tabs, 'tabline' #27984

Problem:  Floating windows with focusable set to false can reasonably be
          expected to be UI elements but are listed in some outputs that
          should contain only regular windows.
Solution: Hide unfocusable floating windows from the default tabline and
          :tabs.
This commit is contained in:
luukvbaal 2024-11-17 00:32:36 +01:00 committed by GitHub
parent 29ded88957
commit f85bc41c80
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 49 additions and 5 deletions

View File

@ -3196,7 +3196,7 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
• focusable: Enable focus by user actions (wincmds, mouse
events). Defaults to true. Non-focusable windows can be
entered by |nvim_set_current_win()|, or, when the `mouse`
field is set to true, by mouse events.
field is set to true, by mouse events. See |focusable|.
• mouse: Specify how this window interacts with mouse
events. Defaults to `focusable` value.
• If false, mouse events pass through this window.

View File

@ -69,7 +69,8 @@ If a window is focusable, it is part of the "navigation stack", that is,
editor commands such as :windo, |CTRL-W|, etc., will consider the window as
one that can be made the "current window". A non-focusable window will be
skipped by such commands (though it can be explicitly focused by
|nvim_set_current_win()|).
|nvim_set_current_win()|). Non-focusable windows are not listed by |:tabs|, and
are not counted by the default 'tabline'.
Windows (especially floating windows) can have many other |api-win_config|
properties such as "hide" and "fixed" which also affect behavior.

View File

@ -1768,7 +1768,7 @@ function vim.api.nvim_open_term(buffer, opts) end
--- - focusable: Enable focus by user actions (wincmds, mouse events).
--- Defaults to true. Non-focusable windows can be entered by
--- `nvim_set_current_win()`, or, when the `mouse` field is set to true,
--- by mouse events.
--- by mouse events. See `focusable`.
--- - mouse: Specify how this window interacts with mouse events.
--- Defaults to `focusable` value.
--- - If false, mouse events pass through this window.

View File

@ -130,7 +130,7 @@
/// - focusable: Enable focus by user actions (wincmds, mouse events).
/// Defaults to true. Non-focusable windows can be entered by
/// |nvim_set_current_win()|, or, when the `mouse` field is set to true,
/// by mouse events.
/// by mouse events. See |focusable|.
/// - mouse: Specify how this window interacts with mouse events.
/// Defaults to `focusable` value.
/// - If false, mouse events pass through this window.

View File

@ -5507,6 +5507,8 @@ static void ex_tabs(exarg_T *eap)
FOR_ALL_WINDOWS_IN_TAB(wp, tp) {
if (got_int) {
break;
} else if (!wp->w_config.focusable) {
continue;
}
msg_putchar('\n');

View File

@ -760,7 +760,9 @@ void draw_tabline(void)
bool modified = false;
for (wincount = 0; wp != NULL; wp = wp->w_next, wincount++) {
if (bufIsChanged(wp->w_buffer)) {
if (!wp->w_config.focusable) {
wincount--;
} else if (bufIsChanged(wp->w_buffer)) {
modified = true;
}
}

View File

@ -214,4 +214,43 @@ describe('tabline', function()
api.nvim_input_mouse('middle', 'press', '', 0, 0, 1)
eq({ 1, 1 }, api.nvim_eval('[tabpagenr(), tabpagenr("$")]'))
end)
it('does not show floats with focusable=false', function()
screen:set_default_attr_ids({
[1] = { background = Screen.colors.Plum1 },
[2] = { underline = true, background = Screen.colors.LightGrey },
[3] = { bold = true },
[4] = { reverse = true },
[5] = { bold = true, foreground = Screen.colors.Blue1 },
[6] = { foreground = Screen.colors.Fuchsia, bold = true },
[7] = { foreground = Screen.colors.SeaGreen, bold = true },
})
command('tabnew')
api.nvim_open_win(0, false, {
focusable = false,
relative = 'editor',
height = 1,
width = 1,
row = 0,
col = 0,
})
screen:expect {
grid = [[
{1: }{2:[No Name] }{3: [No Name] }{4: }{2:X}|
^ |
{5:~ }|*2
|
]],
}
command('tabs')
screen:expect {
grid = [[
{6:Tab page 1} |
# [No Name] |
{6:Tab page 2} |
> [No Name] |
{7:Press ENTER or type command to continue}^ |
]],
}
end)
end)