mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 03:18:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(keymap): return nil from an expr keymap

Browse Source 
For Lua callback expr keymaps, returning `nil` or `false` is equivalent
to an empty string
This commit is contained in:
Lewis Russell
2022-03-24 13:22:58 +00:00
parent 3b28bd57f9
commit 58140a9428
2 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
runtime/doc/lua.txt
View File

@@ -2007,7 +2007,9 @@ set({mode}, {lhs}, {rhs}, {opts}) *vim.keymap.set()*
create mapping on multiple modes. create mapping on multiple modes.
{lhs} string Left-hand side |{lhs}| of the mapping. {lhs} string Left-hand side |{lhs}| of the mapping.
{rhs} string|function Right-hand side |{rhs}| of the {rhs} string|function Right-hand side |{rhs}| of the
mapping. Can also be a Lua function. mapping. Can also be a Lua function. If a Lua
function and `opts.expr == true`, returning `nil`
or `false` is equivalent to an empty string.
{opts} table A table of |:map-arguments| such as {opts} table A table of |:map-arguments| such as
"silent". In addition to the options listed in "silent". In addition to the options listed in
|nvim_set_keymap()|, this table also accepts the |nvim_set_keymap()|, this table also accepts the

14
runtime/lua/vim/keymap.lua
View File

@@ -35,6 +35,8 @@ local keymap = {}
--- Can also be list of modes to create mapping on multiple modes. --- Can also be list of modes to create mapping on multiple modes.
---@param lhs string Left-hand side |{lhs}| of the mapping. ---@param lhs string Left-hand side |{lhs}| of the mapping.
---@param rhs string|function Right-hand side |{rhs}| of the mapping. Can also be a Lua function. ---@param rhs string|function Right-hand side |{rhs}| of the mapping. Can also be a Lua function.
--- If a Lua function and `opts.expr == true`, returning `nil` or `false`
--- is equivalent to an empty string.
-- --
---@param opts table A table of |:map-arguments| such as "silent". In addition to the options ---@param opts table A table of |:map-arguments| such as "silent". In addition to the options
--- listed in |nvim_set_keymap()|, this table also accepts the following keys: --- listed in |nvim_set_keymap()|, this table also accepts the following keys:
@@ -56,10 +58,18 @@ function keymap.set(mode, lhs, rhs, opts)
local is_rhs_luaref = type(rhs) == "function" local is_rhs_luaref = type(rhs) == "function"
mode = type(mode) == 'string' and {mode} or mode mode = type(mode) == 'string' and {mode} or mode
if is_rhs_luaref and opts.expr and opts.replace_keycodes ~= false then if is_rhs_luaref and opts.expr then
local user_rhs = rhs local user_rhs = rhs
rhs = function () rhs = function ()
return vim.api.nvim_replace_termcodes(user_rhs(), true, true, true) local res = user_rhs()
if not res then
-- TODO(lewis6991): Handle this in C?
return ''
elseif opts.replace_keycodes ~= false then
return vim.api.nvim_replace_termcodes(res, true, true, true)
else
return res
end
end end
end end
-- clear replace_keycodes from opts table -- clear replace_keycodes from opts table