Merge pull request #17806 from zeertzjq/win-close-float-fix

Fix some bugs with closing window or buffer when there are floating windows
This commit is contained in:
zeertzjq
2022-03-23 18:05:31 +08:00
committed by GitHub
5 changed files with 239 additions and 72 deletions

View File

@@ -150,7 +150,7 @@ Window nvim_open_win(Buffer buffer, Boolean enter, Dict(float_config) *config, E
if (!parse_float_config(config, &fconfig, false, true, err)) {
return 0;
}
win_T *wp = win_new_float(NULL, fconfig, err);
win_T *wp = win_new_float(NULL, false, fconfig, err);
if (!wp) {
return 0;
}
@@ -200,7 +200,7 @@ void nvim_win_set_config(Window window, Dict(float_config) *config, Error *err)
return;
}
if (new_float) {
if (!win_new_float(win, fconfig, err)) {
if (!win_new_float(win, false, fconfig, err)) {
return;
}
redraw_later(win, NOT_VALID);

View File

@@ -1042,6 +1042,10 @@ static int empty_curbuf(int close_others, int forceit, int action)
set_bufref(&bufref, buf);
if (close_others) {
if (curwin->w_floating) {
// Last window must be non-floating.
curwin = firstwin;
}
// Close any other windows on this buffer, then make it empty.
close_windows(buf, true);
}
@@ -1224,11 +1228,12 @@ int do_buffer(int action, int start, int dir, int count, int forceit)
}
// If the deleted buffer is the current one, close the current window
// (unless it's the only window). Repeat this so long as we end up in
// a window with this buffer.
// (unless it's the only non-floating window).
// When the autocommand window is involved win_close() may need to print an error message.
// Repeat this so long as we end up in a window with this buffer.
while (buf == curbuf
&& !(curwin->w_closing || curwin->w_buffer->b_locked > 0)
&& (!ONE_WINDOW || first_tabpage->tp_next != NULL)) {
&& (lastwin == aucmd_win || !last_window(curwin))) {
if (win_close(curwin, false, false) == FAIL) {
break;
}

View File

@@ -300,7 +300,7 @@ newwindow:
// move window to new tab page
case 'T':
if (one_window()) {
if (one_window(curwin)) {
msg(_(m_onlyone));
} else {
tabpage_T *oldtab = curtab;
@@ -560,7 +560,7 @@ wingotofile:
config.height = curwin->w_height;
config.external = true;
Error err = ERROR_INIT;
if (!win_new_float(curwin, config, &err)) {
if (!win_new_float(curwin, false, config, &err)) {
emsg(err.msg);
api_clear_error(&err);
beep_flush();
@@ -629,16 +629,18 @@ void win_set_buf(Window window, Buffer buffer, bool noautocmd, Error *err)
/// Create a new float.
///
/// if wp == NULL allocate a new window, otherwise turn existing window into a
/// float. It must then already belong to the current tabpage!
///
/// config must already have been validated!
win_T *win_new_float(win_T *wp, FloatConfig fconfig, Error *err)
/// @param wp if NULL, allocate a new window, otherwise turn existing window into a float.
/// It must then already belong to the current tabpage!
/// @param last make the window the last one in the window list.
/// Only used when allocating the autocommand window.
/// @param config must already have been validated!
win_T *win_new_float(win_T *wp, bool last, FloatConfig fconfig, Error *err)
{
if (wp == NULL) {
wp = win_alloc(lastwin_nofloating(), false);
wp = win_alloc(last ? lastwin : lastwin_nofloating(), false);
win_init(wp, curwin, 0);
} else {
assert(!last);
assert(!wp->w_floating);
if (firstwin == wp && lastwin_nofloating() == wp) {
// last non-float
@@ -2348,17 +2350,21 @@ void entering_window(win_T *const win)
}
}
/// Closes all windows for buffer `buf`.
/// Closes all windows for buffer `buf` until there is only one non-floating window.
///
/// @param keep_curwin don't close `curwin`
void close_windows(buf_T *buf, int keep_curwin)
/// @param keep_curwin don't close `curwin`, but caller must ensure `curwin` is non-floating.
void close_windows(buf_T *buf, bool keep_curwin)
{
tabpage_T *tp, *nexttp;
int h = tabline_height();
++RedrawingDisabled;
for (win_T *wp = firstwin; wp != NULL && !ONE_WINDOW;) {
assert(!keep_curwin || !curwin->w_floating);
// Start from lastwin to close floating windows with the same buffer first.
// When the autocommand window is involved win_close() may need to print an error message.
for (win_T *wp = lastwin; wp != NULL && (lastwin == aucmd_win || !one_window(wp));) {
if (wp->w_buffer == buf && (!keep_curwin || wp != curwin)
&& !(wp->w_closing || wp->w_buffer->b_locked > 0)) {
if (win_close(wp, false, false) == FAIL) {
@@ -2367,9 +2373,9 @@ void close_windows(buf_T *buf, int keep_curwin)
}
// Start all over, autocommands may change the window layout.
wp = firstwin;
wp = lastwin;
} else {
wp = wp->w_next;
wp = wp->w_prev;
}
}
@@ -2399,23 +2405,24 @@ void close_windows(buf_T *buf, int keep_curwin)
}
}
/// Check that current window is the last one.
/// Check that the specified window is the last one.
/// @param win counted even if floating
///
/// @return true if the current window is the only window that exists, false if
/// there is another, possibly in another tab page.
static bool last_window(void) FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT
/// @return true if the specified window is the only window that exists,
/// false if there is another, possibly in another tab page.
bool last_window(win_T *win) FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT
{
return one_window() && first_tabpage->tp_next == NULL;
return one_window(win) && first_tabpage->tp_next == NULL;
}
/// Check that current tab page contains no more then one window other than
/// "aucmd_win". Only counts floating window if it is current.
bool one_window(void) FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT
/// Check that current tab page contains no more then one window other than `aucmd_win`.
/// @param counted_float counted even if floating, but not if it is `aucmd_win`
bool one_window(win_T *counted_float) FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT
{
bool seen_one = false;
FOR_ALL_WINDOWS_IN_TAB(wp, curtab) {
if (wp != aucmd_win && (!wp->w_floating || wp == curwin)) {
if (wp != aucmd_win && (!wp->w_floating || wp == counted_float)) {
if (seen_one) {
return false;
}
@@ -2439,12 +2446,14 @@ bool last_nonfloat(win_T *wp) FUNC_ATTR_PURE FUNC_ATTR_WARN_UNUSED_RESULT
return wp != NULL && firstwin == wp && !(wp->w_next && !wp->w_floating);
}
/// Check if floating windows can be closed.
/// Check if floating windows in the current tab can be closed.
/// Do not call this when the autocommand window is in use!
///
/// @return true if all floating windows can be closed
static bool can_close_floating_windows(tabpage_T *tab)
static bool can_close_floating_windows(void)
{
FOR_ALL_WINDOWS_IN_TAB(wp, tab) {
assert(lastwin != aucmd_win);
for (win_T *wp = lastwin; wp->w_floating; wp = wp->w_prev) {
buf_T *buf = wp->w_buffer;
int need_hide = (bufIsChanged(buf) && buf->b_nwindows <= 1);
@@ -2530,7 +2539,7 @@ int win_close(win_T *win, bool free_buf, bool force)
frame_T *win_frame = win->w_floating ? NULL : win->w_frame->fr_parent;
const bool had_diffmode = win->w_p_diff;
if (last_window() && !win->w_floating) {
if (last_window(win)) {
emsg(_("E444: Cannot close last window"));
return FAIL;
}
@@ -2543,18 +2552,18 @@ int win_close(win_T *win, bool free_buf, bool force)
emsg(_(e_autocmd_close));
return FAIL;
}
if ((firstwin == aucmd_win || lastwin == aucmd_win) && one_window()) {
emsg(_("E814: Cannot close window, only autocmd window would remain"));
return FAIL;
}
if ((firstwin == win && lastwin_nofloating() == win)
&& lastwin->w_floating) {
if (force || can_close_floating_windows(curtab)) {
win_T *nextwp;
for (win_T *wpp = firstwin; wpp != NULL; wpp = nextwp) {
nextwp = wpp->w_next;
if (wpp->w_floating) {
win_close(wpp, free_buf, force);
if (lastwin->w_floating && one_window(win)) {
if (lastwin == aucmd_win) {
emsg(_("E814: Cannot close window, only autocmd window would remain"));
return FAIL;
}
if (force || can_close_floating_windows()) {
// close the last window until the there are no floating windows
while (lastwin->w_floating) {
// `force` flag isn't actually used when closing a floating window.
if (win_close(lastwin, free_buf, true) == FAIL) {
// If closing the window fails give up, to avoid looping forever.
return FAIL;
}
}
} else {
@@ -2605,7 +2614,7 @@ int win_close(win_T *win, bool free_buf, bool force)
return FAIL;
}
win->w_closing = false;
if (last_window()) {
if (last_window(win)) {
return FAIL;
}
}
@@ -2615,7 +2624,7 @@ int win_close(win_T *win, bool free_buf, bool force)
return FAIL;
}
win->w_closing = false;
if (last_window()) {
if (last_window(win)) {
return FAIL;
}
// autocmds may abort script processing
@@ -2684,7 +2693,7 @@ int win_close(win_T *win, bool free_buf, bool force)
}
if (only_one_window() && win_valid(win) && win->w_buffer == NULL
&& (last_window() || curtab != prev_curtab
&& (last_window(win) || curtab != prev_curtab
|| close_last_window_tabpage(win, free_buf, prev_curtab))
&& !win->w_floating) {
// Autocommands have closed all windows, quit now. Restore
@@ -2704,7 +2713,7 @@ int win_close(win_T *win, bool free_buf, bool force)
// Autocommands may have closed the window already, or closed the only
// other window or moved to another tab page.
if (!win_valid(win) || (!win->w_floating && last_window())
if (!win_valid(win) || (!win->w_floating && last_window(win))
|| close_last_window_tabpage(win, free_buf, prev_curtab)) {
return FAIL;
}
@@ -3743,7 +3752,7 @@ void close_others(int message, int forceit)
return;
}
if (one_window() && !lastwin->w_floating) {
if (one_nonfloat() && !lastwin->w_floating) {
if (message
&& !autocmd_busy) {
msg(_(m_onlyone));
@@ -3844,7 +3853,7 @@ void win_alloc_aucmd_win(void)
fconfig.width = Columns;
fconfig.height = 5;
fconfig.focusable = false;
aucmd_win = win_new_float(NULL, fconfig, &err);
aucmd_win = win_new_float(NULL, true, fconfig, &err);
aucmd_win->w_buffer->b_nwindows--;
RESET_BINDING(aucmd_win);
}
@@ -6498,7 +6507,7 @@ char_u *file_name_in_line(char_u *line, int col, int options, long count, char_u
void last_status(bool morewin)
{
// Don't make a difference between horizontal or vertical split.
last_status_rec(topframe, (p_ls == 2 || (p_ls == 1 && (morewin || !one_window()))),
last_status_rec(topframe, (p_ls == 2 || (p_ls == 1 && (morewin || !one_nonfloat()))),
global_stl_height() > 0);
}

View File

@@ -398,6 +398,25 @@ describe('autocmd', function()
]])
end)
describe('closing last non-floating window in tab from `aucmd_win`', function()
before_each(function()
command('edit Xa.txt')
command('tabnew Xb.txt')
command('autocmd BufAdd Xa.txt 1close')
end)
it('gives E814 when there are no other floating windows', function()
eq('Vim(close):E814: Cannot close window, only autocmd window would remain',
pcall_err(command, 'doautoall BufAdd'))
end)
it('gives E814 when there are other floating windows', function()
meths.open_win(0, true, {width = 10, height = 10, relative = 'editor', row = 10, col = 10})
eq('Vim(close):E814: Cannot close window, only autocmd window would remain',
pcall_err(command, 'doautoall BufAdd'))
end)
end)
it(':doautocmd does not warn "No matching autocommands" #10689', function()
local screen = Screen.new(32, 3)
screen:attach()

View File

@@ -8,6 +8,7 @@ local command, feed_command = helpers.command, helpers.feed_command
local eval = helpers.eval
local eq = helpers.eq
local neq = helpers.neq
local expect = helpers.expect
local exec_lua = helpers.exec_lua
local insert = helpers.insert
local meths = helpers.meths
@@ -417,26 +418,158 @@ describe('float window', function()
eq(winids, eval('winids'))
end)
it('closed when the last non-float window is closed', function()
local tabpage = exec_lua([[
vim.cmd('edit ./src/nvim/main.c')
vim.cmd('tabedit %')
describe('with only one tabpage', function()
local old_buf, old_win
local float_opts = {relative = 'editor', row = 1, col = 1, width = 1, height = 1}
before_each(function()
old_buf = meths.get_current_buf()
old_win = meths.get_current_win()
end)
describe('closing the last non-floating window gives E444', function()
before_each(function()
meths.open_win(old_buf, true, float_opts)
end)
it('if called from non-floating window', function()
meths.set_current_win(old_win)
eq('Vim:E444: Cannot close last window',
pcall_err(meths.win_close, old_win, false))
end)
it('if called from floating window', function()
eq('Vim:E444: Cannot close last window',
pcall_err(meths.win_close, old_win, false))
end)
end)
describe("deleting the last non-floating window's buffer", function()
before_each(function()
insert('foo')
end)
describe('when there is only one buffer leaves that window with an empty buffer', function()
before_each(function()
meths.open_win(old_buf, true, float_opts)
end)
it('if called from non-floating window', function()
meths.set_current_win(old_win)
meths.buf_delete(old_buf, {force = true})
eq(old_win, meths.get_current_win())
expect('')
eq(1, #meths.list_wins())
end)
it('if called from floating window', function()
meths.buf_delete(old_buf, {force = true})
eq(old_win, meths.get_current_win())
expect('')
eq(1, #meths.list_wins())
end)
end)
describe('when there are other buffers closes other windows with that buffer', function()
local other_buf, same_buf_win, other_buf_win
before_each(function()
same_buf_win = meths.open_win(old_buf, false, float_opts)
other_buf = meths.create_buf(true, false)
other_buf_win = meths.open_win(other_buf, true, float_opts)
insert('bar')
meths.set_current_win(old_win)
end)
it('if called from non-floating window', function()
meths.buf_delete(old_buf, {force = true})
eq(old_win, meths.get_current_win())
eq(other_buf, meths.get_current_buf())
expect('bar')
eq(2, #meths.list_wins())
end)
it('if called from floating window with the same buffer', function()
meths.set_current_win(same_buf_win)
meths.buf_delete(old_buf, {force = true})
eq(old_win, meths.get_current_win())
eq(other_buf, meths.get_current_buf())
expect('bar')
eq(2, #meths.list_wins())
end)
-- TODO: this case is too hard to deal with
pending('if called from floating window with another buffer', function()
meths.set_current_win(other_buf_win)
meths.buf_delete(old_buf, {force = true})
end)
end)
end)
end)
local buf = vim.api.nvim_create_buf(false, true)
local win = vim.api.nvim_open_win(buf, false, {
relative = 'win',
row = 1,
col = 1,
width = 10,
height = 2
})
vim.cmd('quit')
return vim.api.nvim_get_current_tabpage()
]])
eq(1, tabpage)
describe('with multiple tabpages', function()
local old_tabpage, old_buf, old_win
local float_opts = {relative = 'editor', row = 1, col = 1, width = 1, height = 1}
before_each(function()
old_tabpage = meths.get_current_tabpage()
insert('oldtab')
command('tabnew')
old_buf = meths.get_current_buf()
old_win = meths.get_current_win()
end)
describe('closing the last non-floating window', function()
describe('when all floating windows are closeable closes the tabpage', function()
before_each(function()
meths.open_win(old_buf, true, float_opts)
end)
it('if called from non-floating window', function()
meths.set_current_win(old_win)
meths.win_close(old_win, false)
eq(old_tabpage, meths.get_current_tabpage())
expect('oldtab')
eq(1, #meths.list_tabpages())
end)
it('if called from floating window', function()
meths.win_close(old_win, false)
eq(old_tabpage, meths.get_current_tabpage())
expect('oldtab')
eq(1, #meths.list_tabpages())
end)
end)
describe('when there are non-closeable floating windows gives E5601', function()
before_each(function()
command('set nohidden')
local other_buf = meths.create_buf(true, false)
meths.open_win(other_buf, true, float_opts)
insert('foo')
end)
it('if called from non-floating window', function()
meths.set_current_win(old_win)
eq('Vim:E5601: Cannot close window, only floating window would remain',
pcall_err(meths.win_close, old_win, false))
end)
it('if called from floating window', function()
eq('Vim:E5601: Cannot close window, only floating window would remain',
pcall_err(meths.win_close, old_win, false))
end)
end)
end)
describe("deleting the last non-floating window's buffer", function()
describe('when all floating windows are closeable closes the tabpage', function()
local other_buf, same_buf_win, other_buf_win
before_each(function()
same_buf_win = meths.open_win(old_buf, false, float_opts)
other_buf = meths.create_buf(true, false)
other_buf_win = meths.open_win(other_buf, true, float_opts)
meths.set_current_win(old_win)
end)
it('if called from non-floating window', function()
meths.buf_delete(old_buf, {force = false})
eq(old_tabpage, meths.get_current_tabpage())
expect('oldtab')
eq(1, #meths.list_tabpages())
end)
it('if called from floating window with the same buffer', function()
meths.set_current_win(same_buf_win)
meths.buf_delete(old_buf, {force = false})
eq(old_tabpage, meths.get_current_tabpage())
expect('oldtab')
eq(1, #meths.list_tabpages())
end)
-- TODO: this case is too hard to deal with
pending('if called from floating window with another buffer', function()
meths.set_current_win(other_buf_win)
meths.buf_delete(old_buf, {force = false})
end)
end)
end)
end)
local function with_ext_multigrid(multigrid)
@@ -5596,7 +5729,7 @@ describe('float window', function()
[2:----------------------------------------]|
[2:----------------------------------------]|
[2:----------------------------------------]|
{5:[No Name] [+] }|
[2:----------------------------------------]|
[3:----------------------------------------]|
## grid 2
x |
@@ -5604,6 +5737,7 @@ describe('float window', function()
{0:~ }|
{0:~ }|
{0:~ }|
{0:~ }|
## grid 3
:quit |
## grid 4
@@ -5619,7 +5753,7 @@ describe('float window', function()
{0:~ }{1:^y }{0: }|
{0:~ }{2:~ }{0: }|
{0:~ }|
{5:[No Name] [+] }|
{0:~ }|
:quit |
]])
end