mirror of
https://github.com/neovim/neovim.git
synced 2026-07-24 09:50:48 +00:00
b2bf7bcfb1
Problem:
cmdwin (the `:q` cmdline buffer) has various limitations which require
special-casing all over the codebase.
Besides complicating the code, it also breaks async plugins if they try
to create buffers/windows after some work is done, if the user happens
to open cmdwin at the wrong the moment:
Lua callback: …/guh.nvim/lua/guh/util.lua:531:
E11: Invalid in command-line window; <CR> executes, CTRL-C quits
stack traceback:
[C]: in function 'nvim_buf_delete'
…/guh.nvim/lua/guh/util.lua:531: in function <…/guh.nvim/lua/guh/util.lua:526>
Solution:
Just say no to "inception". Reimplement cmdwin as a normal buffer+window.
All of the cmdwin contortions (in both core, and innocent plugins) exist
literally only to support "inception": recursive
cmdwin-in-cmdline-things, like `<c-r>=`, `/`, search-during-substitute,
`:input()`, etc. So we just won't support that (though I have
a potential plan for that later, which I call "modal parking lot").
The benefit is that plugins, and core, no longer have to care about
cmdwin.
BONUS:
- mouse-drag on vertical separators works (it only worked for
horizontal/statusline before)
- inccommand-in-cmdwin now works correctly, for free (thus don't need
#40077).
POTENTIAL FOLLOWUPS
- Drop `CHECK_CMDWIN` ("E11: Invalid in command-line window"), allow chaos.
- Unify `BUFLOCK_OK` / `LOCK_OK` ?
DESIGN:
- Eliminate lots of C globals, `EX_CMDWIN`, etc.
- `text_locked()` no longer reports true for cmdwin.
- cmdwin = a normal window with 'winfixbuf', 'bufhidden=wipe',
'buftype=nofile'. Invariants come from those options rather than
special cases throughout the codebase.
- `nv_record` for q:/q//q? calls Lua
`nlua_call_vimfn("vim._core.cmdwin", …)`. No `K_CMDWIN`
/ cmdline-reader detour.
- `cedit_key` (`c_CTRL-F`) schedules a deferred event that calls
`vim._core.cmdwin.open(type, content, pos)` and returns `Ctrl_C` so
the in-flight cmdline cancels. Reader state is not serialized; instead
the captured `(type, line, col)` is replayed via
`nvim_feedkeys(type..line.."<CR>", "nt", …)` after user confirms.
- On confirm/cancel: `<CR>` / `<C-C>` calls into Lua which closes the
window and re-feeds the cmdline.
BREAKING CHANGES:
- Expression-register cmdline (`<C-R>=` from insert-mode) no longer
supports cmdwin. Same applies to `input()` / `inputlist()` (already
covered by `text_locked`).
- Usage of cmdwin in macros/mappings will probably break (assuming they
ever worked).
251 lines
10 KiB
Lua
251 lines
10 KiB
Lua
local t = require('test.testutil')
|
|
local n = require('test.functional.testnvim')()
|
|
local Screen = require('test.functional.ui.screen')
|
|
|
|
local clear = n.clear
|
|
local command = n.command
|
|
local eq = t.eq
|
|
local expect = n.expect
|
|
local eval = n.eval
|
|
local next_msg = n.next_msg
|
|
local feed = n.feed
|
|
local api = n.api
|
|
|
|
describe('cmdline autocommands', function()
|
|
local channel
|
|
before_each(function()
|
|
clear()
|
|
channel = api.nvim_get_chan_info(0).id
|
|
api.nvim_set_var('channel', channel)
|
|
command("autocmd CmdlineEnter * call rpcnotify(g:channel, 'CmdlineEnter', v:event)")
|
|
command("autocmd CmdlineLeave * call rpcnotify(g:channel, 'CmdlineLeave', v:event)")
|
|
command("autocmd CmdwinEnter * call rpcnotify(g:channel, 'CmdwinEnter', v:event)")
|
|
command("autocmd CmdwinLeave * call rpcnotify(g:channel, 'CmdwinLeave', v:event)")
|
|
end)
|
|
|
|
it('works', function()
|
|
feed(':')
|
|
eq({ 'notification', 'CmdlineEnter', { { cmdtype = ':', cmdlevel = 1 } } }, next_msg())
|
|
feed('redraw<cr>')
|
|
eq(
|
|
{ 'notification', 'CmdlineLeave', { { cmdtype = ':', cmdlevel = 1, abort = false } } },
|
|
next_msg()
|
|
)
|
|
|
|
feed(':')
|
|
eq({ 'notification', 'CmdlineEnter', { { cmdtype = ':', cmdlevel = 1 } } }, next_msg())
|
|
|
|
-- note: feed('bork<c-c>') might not consume 'bork'
|
|
-- due to out-of-band interrupt handling
|
|
feed('bork<esc>')
|
|
eq(
|
|
{ 'notification', 'CmdlineLeave', { { cmdtype = ':', cmdlevel = 1, abort = true } } },
|
|
next_msg()
|
|
)
|
|
end)
|
|
|
|
it('can abort cmdline', function()
|
|
command('autocmd CmdlineLeave * let v:event.abort= len(getcmdline())>15')
|
|
feed(":put! ='ok'<cr>")
|
|
expect([[
|
|
ok
|
|
]])
|
|
|
|
feed(":put! ='blah blah'<cr>")
|
|
expect([[
|
|
ok
|
|
]])
|
|
end)
|
|
|
|
it('handles errors correctly', function()
|
|
clear()
|
|
local screen = Screen.new(72, 8)
|
|
command("autocmd CmdlineEnter * echoerr 'FAIL'")
|
|
command("autocmd CmdlineLeave * echoerr 'very error'")
|
|
|
|
feed(':')
|
|
screen:expect([[
|
|
|
|
|
{1:~ }|*3
|
|
{3: }|
|
|
: |
|
|
{9:CmdlineEnter Autocommands for "*": Vim(echoerr):FAIL} |
|
|
:^ |
|
|
]])
|
|
|
|
feed("put ='lorem ipsum'<cr>")
|
|
screen:expect([[
|
|
|
|
|
{3: }|
|
|
: |
|
|
{9:CmdlineEnter Autocommands for "*": Vim(echoerr):FAIL} |
|
|
:put ='lorem ipsum' |
|
|
{9:CmdlineLeave Autocommands for "*": Vim(echoerr):very error} |
|
|
|
|
|
{6:Press ENTER or type command to continue}^ |
|
|
]])
|
|
|
|
-- cmdline was still executed
|
|
feed('<cr>')
|
|
screen:expect([[
|
|
|
|
|
^lorem ipsum |
|
|
{1:~ }|*5
|
|
|
|
|
]])
|
|
|
|
command("autocmd CmdlineChanged * echoerr 'change erreor'")
|
|
|
|
-- history recall still works
|
|
feed(':<c-p>')
|
|
screen:expect([[
|
|
|
|
|
lorem ipsum |
|
|
{3: }|
|
|
: |
|
|
{9:CmdlineEnter Autocommands for "*": Vim(echoerr):FAIL} |
|
|
:put ='lorem ipsum' |
|
|
{9:CmdlineChanged Autocommands for "*": Vim(echoerr):change erreor} |
|
|
:put ='lorem ipsum'^ |
|
|
]])
|
|
|
|
feed('<left>')
|
|
screen:expect([[
|
|
|
|
|
lorem ipsum |
|
|
{3: }|
|
|
: |
|
|
{9:CmdlineEnter Autocommands for "*": Vim(echoerr):FAIL} |
|
|
:put ='lorem ipsum' |
|
|
{9:CmdlineChanged Autocommands for "*": Vim(echoerr):change erreor} |
|
|
:put ='lorem ipsum^' |
|
|
]])
|
|
|
|
-- edit still works
|
|
feed('.')
|
|
screen:expect([[
|
|
{3: }|
|
|
: |
|
|
{9:CmdlineEnter Autocommands for "*": Vim(echoerr):FAIL} |
|
|
:put ='lorem ipsum' |
|
|
{9:CmdlineChanged Autocommands for "*": Vim(echoerr):change erreor} |
|
|
:put ='lorem ipsum.' |
|
|
{9:CmdlineChanged Autocommands for "*": Vim(echoerr):change erreor} |
|
|
:put ='lorem ipsum.^' |
|
|
]])
|
|
|
|
feed('<cr>')
|
|
screen:expect([[
|
|
:put ='lorem ipsum' |
|
|
{9:CmdlineChanged Autocommands for "*": Vim(echoerr):change erreor} |
|
|
:put ='lorem ipsum.' |
|
|
{9:CmdlineChanged Autocommands for "*": Vim(echoerr):change erreor} |
|
|
:put ='lorem ipsum.' |
|
|
{9:CmdlineLeave Autocommands for "*": Vim(echoerr):very error} |
|
|
|
|
|
{6:Press ENTER or type command to continue}^ |
|
|
]])
|
|
|
|
-- cmdline was still executed
|
|
feed('<cr>')
|
|
screen:expect([[
|
|
|
|
|
lorem ipsum |
|
|
^lorem ipsum. |
|
|
{1:~ }|*4
|
|
|
|
|
]])
|
|
end)
|
|
|
|
it('with nested cmdline', function()
|
|
-- Cmdwin is not supported in expr-register (<C-R>=) cmdline. #40312
|
|
feed(':')
|
|
eq({ 'notification', 'CmdlineEnter', { { cmdtype = ':', cmdlevel = 1 } } }, next_msg())
|
|
feed('<c-r>=')
|
|
eq({ 'notification', 'CmdlineEnter', { { cmdtype = '=', cmdlevel = 2 } } }, next_msg())
|
|
feed('1+2<cr>')
|
|
eq(
|
|
{ 'notification', 'CmdlineLeave', { { cmdtype = '=', cmdlevel = 2, abort = false } } },
|
|
next_msg()
|
|
)
|
|
feed('<cr>')
|
|
eq(
|
|
{ 'notification', 'CmdlineLeave', { { cmdtype = ':', cmdlevel = 1, abort = false } } },
|
|
next_msg()
|
|
)
|
|
end)
|
|
|
|
it('no crash with recursive use of v:event #19484', function()
|
|
command('autocmd CmdlineEnter * normal :')
|
|
feed(':')
|
|
eq({ 'notification', 'CmdlineEnter', { { cmdtype = ':', cmdlevel = 1 } } }, next_msg())
|
|
feed('<CR>')
|
|
eq(
|
|
{ 'notification', 'CmdlineLeave', { { cmdtype = ':', cmdlevel = 1, abort = false } } },
|
|
next_msg()
|
|
)
|
|
end)
|
|
|
|
it('supports CmdlineChanged', function()
|
|
command(
|
|
"autocmd CmdlineChanged * call rpcnotify(g:channel, 'CmdlineChanged', v:event, getcmdline())"
|
|
)
|
|
feed(':')
|
|
eq({ 'notification', 'CmdlineEnter', { { cmdtype = ':', cmdlevel = 1 } } }, next_msg())
|
|
feed('l')
|
|
eq({ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'l' } }, next_msg())
|
|
feed('e')
|
|
eq({ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'le' } }, next_msg())
|
|
feed('t')
|
|
eq({ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'let' } }, next_msg())
|
|
feed('<space>')
|
|
eq(
|
|
{ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'let ' } },
|
|
next_msg()
|
|
)
|
|
feed('x')
|
|
eq(
|
|
{ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'let x' } },
|
|
next_msg()
|
|
)
|
|
feed('<space>')
|
|
eq(
|
|
{ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'let x ' } },
|
|
next_msg()
|
|
)
|
|
feed('=')
|
|
eq(
|
|
{ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'let x =' } },
|
|
next_msg()
|
|
)
|
|
feed('<space>')
|
|
eq(
|
|
{ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'let x = ' } },
|
|
next_msg()
|
|
)
|
|
feed('<c-r>=')
|
|
eq({ 'notification', 'CmdlineEnter', { { cmdtype = '=', cmdlevel = 2 } } }, next_msg())
|
|
feed('1')
|
|
eq({ 'notification', 'CmdlineChanged', { { cmdtype = '=', cmdlevel = 2 }, '1' } }, next_msg())
|
|
feed('+')
|
|
eq({ 'notification', 'CmdlineChanged', { { cmdtype = '=', cmdlevel = 2 }, '1+' } }, next_msg())
|
|
feed('1')
|
|
eq({ 'notification', 'CmdlineChanged', { { cmdtype = '=', cmdlevel = 2 }, '1+1' } }, next_msg())
|
|
feed('<cr>')
|
|
eq(
|
|
{ 'notification', 'CmdlineLeave', { { cmdtype = '=', cmdlevel = 2, abort = false } } },
|
|
next_msg()
|
|
)
|
|
eq(
|
|
{ 'notification', 'CmdlineChanged', { { cmdtype = ':', cmdlevel = 1 }, 'let x = 2' } },
|
|
next_msg()
|
|
)
|
|
feed('<cr>')
|
|
eq(
|
|
{ 'notification', 'CmdlineLeave', { { cmdtype = ':', cmdlevel = 1, abort = false } } },
|
|
next_msg()
|
|
)
|
|
eq(2, eval('x'))
|
|
end)
|
|
end)
|