mirror of
https://github.com/neovim/neovim.git
synced 2025-10-26 12:27:24 +00:00
7589336120
The motivation for this update is Issue #15365, where background=light is not properly set for Nvim running from an Nvim :terminal. This can be encountered when e.g., opening a terminal to make git commits, which opens EDITOR=nvim in the nested terminal. Under the implementation of this commit, the OSC response always indicates a black or white foreground/background. While this may not reflect the actual foreground/background color, it permits 'background' to be retained for a nested Nvim instance running in the terminal emulator. The behaviour matches Vim.
469 lines
16 KiB
Lua
469 lines
16 KiB
Lua
--- Default mappings
|
|
do
|
|
--- Default maps for * and # in visual mode.
|
|
---
|
|
--- See |v_star-default| and |v_#-default|
|
|
do
|
|
local function region_chunks(region)
|
|
local chunks = {}
|
|
local maxcol = vim.v.maxcol
|
|
for line, cols in vim.spairs(region) do
|
|
local endcol = cols[2] == maxcol and -1 or cols[2]
|
|
local chunk = vim.api.nvim_buf_get_text(0, line, cols[1], line, endcol, {})[1]
|
|
table.insert(chunks, chunk)
|
|
end
|
|
return chunks
|
|
end
|
|
|
|
local function _visual_search(cmd)
|
|
assert(cmd == '/' or cmd == '?')
|
|
local region = vim.region(
|
|
0,
|
|
'.',
|
|
'v',
|
|
vim.api.nvim_get_mode().mode:sub(1, 1),
|
|
vim.o.selection == 'inclusive'
|
|
)
|
|
local chunks = region_chunks(region)
|
|
local esc_chunks = vim
|
|
.iter(chunks)
|
|
:map(function(v)
|
|
return vim.fn.escape(v, cmd == '/' and [[/\]] or [[?\]])
|
|
end)
|
|
:totable()
|
|
local esc_pat = table.concat(esc_chunks, [[\n]])
|
|
local search_cmd = ([[%s\V%s%s]]):format(cmd, esc_pat, '\n')
|
|
return '\27' .. search_cmd
|
|
end
|
|
|
|
vim.keymap.set('x', '*', function()
|
|
return _visual_search('/')
|
|
end, { desc = ':help v_star-default', expr = true, silent = true })
|
|
vim.keymap.set('x', '#', function()
|
|
return _visual_search('?')
|
|
end, { desc = ':help v_#-default', expr = true, silent = true })
|
|
end
|
|
|
|
--- Map Y to y$. This mimics the behavior of D and C. See |Y-default|
|
|
vim.keymap.set('n', 'Y', 'y$', { desc = ':help Y-default' })
|
|
|
|
--- Use normal! <C-L> to prevent inserting raw <C-L> when using i_<C-O>. #17473
|
|
---
|
|
--- See |CTRL-L-default|
|
|
vim.keymap.set('n', '<C-L>', '<Cmd>nohlsearch<Bar>diffupdate<Bar>normal! <C-L><CR>', {
|
|
desc = ':help CTRL-L-default',
|
|
})
|
|
|
|
--- Set undo points when deleting text in insert mode.
|
|
---
|
|
--- See |i_CTRL-U-default| and |i_CTRL-W-default|
|
|
vim.keymap.set('i', '<C-U>', '<C-G>u<C-U>', { desc = ':help i_CTRL-U-default' })
|
|
vim.keymap.set('i', '<C-W>', '<C-G>u<C-W>', { desc = ':help i_CTRL-W-default' })
|
|
|
|
--- Use the same flags as the previous substitution with &.
|
|
---
|
|
--- Use : instead of <Cmd> so that ranges are supported. #19365
|
|
---
|
|
--- See |&-default|
|
|
vim.keymap.set('n', '&', ':&&<CR>', { desc = ':help &-default' })
|
|
|
|
--- Use Q in visual mode to execute a macro on each line of the selection. #21422
|
|
---
|
|
--- Applies to @x and includes @@ too.
|
|
vim.keymap.set(
|
|
'x',
|
|
'Q',
|
|
':normal! @<C-R>=reg_recorded()<CR><CR>',
|
|
{ silent = true, desc = ':help v_Q-default' }
|
|
)
|
|
vim.keymap.set(
|
|
'x',
|
|
'@',
|
|
"':normal! @'.getcharstr().'<CR>'",
|
|
{ silent = true, expr = true, desc = ':help v_@-default' }
|
|
)
|
|
--- Map |gx| to call |vim.ui.open| on the identifier under the cursor
|
|
do
|
|
-- TODO: use vim.region() when it lands... #13896 #16843
|
|
local function get_visual_selection()
|
|
local save_a = vim.fn.getreginfo('a')
|
|
vim.cmd([[norm! "ay]])
|
|
local selection = vim.fn.getreg('a', 1)
|
|
vim.fn.setreg('a', save_a)
|
|
return selection
|
|
end
|
|
|
|
local function do_open(uri)
|
|
local _, err = vim.ui.open(uri)
|
|
if err then
|
|
vim.notify(err, vim.log.levels.ERROR)
|
|
end
|
|
end
|
|
|
|
local gx_desc =
|
|
'Opens filepath or URI under cursor with the system handler (file explorer, web browser, …)'
|
|
vim.keymap.set({ 'n' }, 'gx', function()
|
|
do_open(vim.fn.expand('<cfile>'))
|
|
end, { desc = gx_desc })
|
|
vim.keymap.set({ 'x' }, 'gx', function()
|
|
do_open(get_visual_selection())
|
|
end, { desc = gx_desc })
|
|
end
|
|
end
|
|
|
|
--- Default menus
|
|
do
|
|
--- Right click popup menu
|
|
-- TODO VimScript, no l10n
|
|
vim.cmd([[
|
|
aunmenu *
|
|
vnoremenu PopUp.Cut "+x
|
|
vnoremenu PopUp.Copy "+y
|
|
anoremenu PopUp.Paste "+gP
|
|
vnoremenu PopUp.Paste "+P
|
|
vnoremenu PopUp.Delete "_x
|
|
nnoremenu PopUp.Select\ All ggVG
|
|
vnoremenu PopUp.Select\ All gg0oG$
|
|
inoremenu PopUp.Select\ All <C-Home><C-O>VG
|
|
anoremenu PopUp.-1- <Nop>
|
|
anoremenu PopUp.How-to\ disable\ mouse <Cmd>help disable-mouse<CR>
|
|
]])
|
|
end
|
|
|
|
--- Default autocommands. See |default-autocmds|
|
|
do
|
|
local nvim_terminal_augroup = vim.api.nvim_create_augroup('nvim_terminal', {})
|
|
vim.api.nvim_create_autocmd('BufReadCmd', {
|
|
pattern = 'term://*',
|
|
group = nvim_terminal_augroup,
|
|
desc = 'Treat term:// buffers as terminal buffers',
|
|
nested = true,
|
|
command = "if !exists('b:term_title')|call termopen(matchstr(expand(\"<amatch>\"), '\\c\\mterm://\\%(.\\{-}//\\%(\\d\\+:\\)\\?\\)\\?\\zs.*'), {'cwd': expand(get(matchlist(expand(\"<amatch>\"), '\\c\\mterm://\\(.\\{-}\\)//'), 1, ''))})",
|
|
})
|
|
|
|
vim.api.nvim_create_autocmd({ 'TermClose' }, {
|
|
group = nvim_terminal_augroup,
|
|
desc = 'Automatically close terminal buffers when started with no arguments and exiting without an error',
|
|
callback = function(args)
|
|
if vim.v.event.status == 0 then
|
|
local info = vim.api.nvim_get_chan_info(vim.bo[args.buf].channel)
|
|
local argv = info.argv or {}
|
|
if #argv == 1 and argv[1] == vim.o.shell then
|
|
vim.cmd({ cmd = 'bdelete', args = { args.buf }, bang = true })
|
|
end
|
|
end
|
|
end,
|
|
})
|
|
|
|
vim.api.nvim_create_autocmd('TermRequest', {
|
|
group = nvim_terminal_augroup,
|
|
desc = 'Respond to OSC foreground/background color requests',
|
|
callback = function(args)
|
|
local fg_request = args.data == '\027]10;?'
|
|
local bg_request = args.data == '\027]11;?'
|
|
if fg_request or bg_request then
|
|
-- WARN: This does not return the actual foreground/background color,
|
|
-- but rather returns:
|
|
-- - fg=white/bg=black when Nvim option 'background' is 'dark'
|
|
-- - fg=black/bg=white when Nvim option 'background' is 'light'
|
|
local red, green, blue = 0, 0, 0
|
|
local bg_option_dark = vim.o.background == 'dark'
|
|
if (fg_request and bg_option_dark) or (bg_request and not bg_option_dark) then
|
|
red, green, blue = 65535, 65535, 65535
|
|
end
|
|
local command = fg_request and 10 or 11
|
|
local data = string.format('\027]%d;rgb:%04x/%04x/%04x\007', command, red, green, blue)
|
|
local channel = vim.bo[args.buf].channel
|
|
vim.api.nvim_chan_send(channel, data)
|
|
end
|
|
end,
|
|
})
|
|
|
|
vim.api.nvim_create_autocmd('CmdwinEnter', {
|
|
pattern = '[:>]',
|
|
desc = 'Limit syntax sync to maxlines=1 in the command window',
|
|
group = vim.api.nvim_create_augroup('nvim_cmdwin', {}),
|
|
command = 'syntax sync minlines=1 maxlines=1',
|
|
})
|
|
|
|
vim.api.nvim_create_autocmd('SwapExists', {
|
|
pattern = '*',
|
|
desc = 'Skip the swapfile prompt when the swapfile is owned by a running Nvim process',
|
|
group = vim.api.nvim_create_augroup('nvim_swapfile', {}),
|
|
callback = function()
|
|
local info = vim.fn.swapinfo(vim.v.swapname)
|
|
local user = vim.uv.os_get_passwd().username
|
|
local iswin = 1 == vim.fn.has('win32')
|
|
if info.error or info.pid <= 0 or (not iswin and info.user ~= user) then
|
|
vim.v.swapchoice = '' -- Show the prompt.
|
|
return
|
|
end
|
|
vim.v.swapchoice = 'e' -- Choose "(E)dit".
|
|
vim.notify(('W325: Ignoring swapfile from Nvim process %d'):format(info.pid))
|
|
end,
|
|
})
|
|
end
|
|
|
|
-- Only do the following when the TUI is attached
|
|
local tty = nil
|
|
for _, ui in ipairs(vim.api.nvim_list_uis()) do
|
|
if ui.chan == 1 and ui.stdout_tty then
|
|
tty = ui
|
|
break
|
|
end
|
|
end
|
|
|
|
if tty then
|
|
local group = vim.api.nvim_create_augroup('nvim_tty', {})
|
|
|
|
--- Set an option after startup (so that OptionSet is fired), but only if not
|
|
--- already set by the user.
|
|
---
|
|
--- @param option string Option name
|
|
--- @param value any Option value
|
|
local function setoption(option, value)
|
|
if vim.api.nvim_get_option_info2(option, {}).was_set then
|
|
-- Don't do anything if option is already set
|
|
return
|
|
end
|
|
|
|
-- Wait until Nvim is finished starting to set the option to ensure the
|
|
-- OptionSet event fires.
|
|
if vim.v.vim_did_enter == 1 then
|
|
vim.o[option] = value
|
|
else
|
|
vim.api.nvim_create_autocmd('VimEnter', {
|
|
group = group,
|
|
once = true,
|
|
nested = true,
|
|
callback = function()
|
|
setoption(option, value)
|
|
end,
|
|
})
|
|
end
|
|
end
|
|
|
|
--- Guess value of 'background' based on terminal color.
|
|
---
|
|
--- We write Operating System Command (OSC) 11 to the terminal to request the
|
|
--- terminal's background color. We then wait for a response. If the response
|
|
--- matches `rgba:RRRR/GGGG/BBBB/AAAA` where R, G, B, and A are hex digits, then
|
|
--- compute the luminance[1] of the RGB color and classify it as light/dark
|
|
--- accordingly. Note that the color components may have anywhere from one to
|
|
--- four hex digits, and require scaling accordingly as values out of 4, 8, 12,
|
|
--- or 16 bits. Also note the A(lpha) component is optional, and is parsed but
|
|
--- ignored in the calculations.
|
|
---
|
|
--- [1] https://en.wikipedia.org/wiki/Luma_%28video%29
|
|
do
|
|
--- Parse a string of hex characters as a color.
|
|
---
|
|
--- The string can contain 1 to 4 hex characters. The returned value is
|
|
--- between 0.0 and 1.0 (inclusive) representing the intensity of the color.
|
|
---
|
|
--- For instance, if only a single hex char "a" is used, then this function
|
|
--- returns 0.625 (10 / 16), while a value of "aa" would return 0.664 (170 /
|
|
--- 256).
|
|
---
|
|
--- @param c string Color as a string of hex chars
|
|
--- @return number? Intensity of the color
|
|
local function parsecolor(c)
|
|
if #c == 0 or #c > 4 then
|
|
return nil
|
|
end
|
|
|
|
local val = tonumber(c, 16)
|
|
if not val then
|
|
return nil
|
|
end
|
|
|
|
local max = tonumber(string.rep('f', #c), 16)
|
|
return val / max
|
|
end
|
|
|
|
--- Parse an OSC 11 response
|
|
---
|
|
--- Either of the two formats below are accepted:
|
|
---
|
|
--- OSC 11 ; rgb:<red>/<green>/<blue>
|
|
---
|
|
--- or
|
|
---
|
|
--- OSC 11 ; rgba:<red>/<green>/<blue>/<alpha>
|
|
---
|
|
--- where
|
|
---
|
|
--- <red>, <green>, <blue>, <alpha> := h | hh | hhh | hhhh
|
|
---
|
|
--- The alpha component is ignored, if present.
|
|
---
|
|
--- @param resp string OSC 11 response
|
|
--- @return string? Red component
|
|
--- @return string? Green component
|
|
--- @return string? Blue component
|
|
local function parseosc11(resp)
|
|
local r, g, b
|
|
r, g, b = resp:match('^\027%]11;rgb:(%x+)/(%x+)/(%x+)$')
|
|
if not r and not g and not b then
|
|
local a
|
|
r, g, b, a = resp:match('^\027%]11;rgba:(%x+)/(%x+)/(%x+)/(%x+)$')
|
|
if not a or #a > 4 then
|
|
return nil, nil, nil
|
|
end
|
|
end
|
|
|
|
if r and g and b and #r <= 4 and #g <= 4 and #b <= 4 then
|
|
return r, g, b
|
|
end
|
|
|
|
return nil, nil, nil
|
|
end
|
|
|
|
local timer = assert(vim.uv.new_timer())
|
|
|
|
local id = vim.api.nvim_create_autocmd('TermResponse', {
|
|
group = group,
|
|
nested = true,
|
|
callback = function(args)
|
|
local resp = args.data ---@type string
|
|
local r, g, b = parseosc11(resp)
|
|
if r and g and b then
|
|
local rr = parsecolor(r)
|
|
local gg = parsecolor(g)
|
|
local bb = parsecolor(b)
|
|
|
|
if rr and gg and bb then
|
|
local luminance = (0.299 * rr) + (0.587 * gg) + (0.114 * bb)
|
|
local bg = luminance < 0.5 and 'dark' or 'light'
|
|
setoption('background', bg)
|
|
end
|
|
|
|
return true
|
|
end
|
|
end,
|
|
})
|
|
|
|
local query = '\027]11;?\007'
|
|
|
|
-- tmux 3.3a and earlier do not query the parent terminal for background color. As of the
|
|
-- writing of this comment, 3.3a is the latest release, so a passthrough sequence is necessary.
|
|
-- The passthrough should be removed as soon as a tmux version later than 3.3a is released.
|
|
-- See: https://github.com/neovim/neovim/pull/26557
|
|
if os.getenv('TMUX') then
|
|
query = string.format('\027Ptmux;%s\027\\', query:gsub('\027', '\027\027'))
|
|
end
|
|
|
|
io.stdout:write(query)
|
|
|
|
timer:start(1000, 0, function()
|
|
-- Delete the autocommand if no response was received
|
|
vim.schedule(function()
|
|
-- Suppress error if autocommand has already been deleted
|
|
pcall(vim.api.nvim_del_autocmd, id)
|
|
end)
|
|
|
|
if not timer:is_closing() then
|
|
timer:close()
|
|
end
|
|
end)
|
|
end
|
|
|
|
--- If the TUI (term_has_truecolor) was able to determine that the host
|
|
--- terminal supports truecolor, enable 'termguicolors'. Otherwise, query the
|
|
--- terminal (using both XTGETTCAP and SGR + DECRQSS). If the terminal's
|
|
--- response indicates that it does support truecolor enable 'termguicolors',
|
|
--- but only if the user has not already disabled it.
|
|
do
|
|
if tty.rgb then
|
|
-- The TUI was able to determine truecolor support
|
|
setoption('termguicolors', true)
|
|
else
|
|
local caps = {} ---@type table<string, boolean>
|
|
require('vim.termcap').query({ 'Tc', 'RGB', 'setrgbf', 'setrgbb' }, function(cap, found)
|
|
if not found then
|
|
return
|
|
end
|
|
|
|
caps[cap] = true
|
|
if caps.Tc or caps.RGB or (caps.setrgbf and caps.setrgbb) then
|
|
setoption('termguicolors', true)
|
|
end
|
|
end)
|
|
|
|
local timer = assert(vim.uv.new_timer())
|
|
|
|
-- Arbitrary colors to set in the SGR sequence
|
|
local r = 1
|
|
local g = 2
|
|
local b = 3
|
|
|
|
local id = vim.api.nvim_create_autocmd('TermResponse', {
|
|
group = group,
|
|
nested = true,
|
|
callback = function(args)
|
|
local resp = args.data ---@type string
|
|
local decrqss = resp:match('^\027P1%$r([%d;:]+)m$')
|
|
|
|
if decrqss then
|
|
-- The DECRQSS SGR response first contains attributes separated by
|
|
-- semicolons, followed by the SGR itself with parameters separated
|
|
-- by colons. Some terminals include "0" in the attribute list
|
|
-- unconditionally; others do not. Our SGR sequence did not set any
|
|
-- attributes, so there should be no attributes in the list.
|
|
local attrs = vim.split(decrqss, ';')
|
|
if #attrs ~= 1 and (#attrs ~= 2 or attrs[1] ~= '0') then
|
|
return true
|
|
end
|
|
|
|
-- The returned SGR sequence should begin with 48:2
|
|
local sgr = attrs[#attrs]:match('^48:2:([%d:]+)$')
|
|
if not sgr then
|
|
return true
|
|
end
|
|
|
|
-- The remaining elements of the SGR sequence should be the 3 colors
|
|
-- we set. Some terminals also include an additional parameter
|
|
-- (which can even be empty!), so handle those cases as well
|
|
local params = vim.split(sgr, ':')
|
|
if #params ~= 3 and (#params ~= 4 or (params[1] ~= '' and params[1] ~= '1')) then
|
|
return true
|
|
end
|
|
|
|
if
|
|
tonumber(params[#params - 2]) == r
|
|
and tonumber(params[#params - 1]) == g
|
|
and tonumber(params[#params]) == b
|
|
then
|
|
setoption('termguicolors', true)
|
|
end
|
|
|
|
return true
|
|
end
|
|
end,
|
|
})
|
|
|
|
-- Write SGR followed by DECRQSS. This sets the background color then
|
|
-- immediately asks the terminal what the background color is. If the
|
|
-- terminal responds to the DECRQSS with the same SGR sequence that we
|
|
-- sent then the terminal supports truecolor.
|
|
local decrqss = '\027P$qm\027\\'
|
|
if os.getenv('TMUX') then
|
|
decrqss = string.format('\027Ptmux;%s\027\\', decrqss:gsub('\027', '\027\027'))
|
|
end
|
|
io.stdout:write(string.format('\027[48;2;%d;%d;%dm%s', r, g, b, decrqss))
|
|
|
|
timer:start(1000, 0, function()
|
|
-- Delete the autocommand if no response was received
|
|
vim.schedule(function()
|
|
-- Suppress error if autocommand has already been deleted
|
|
pcall(vim.api.nvim_del_autocmd, id)
|
|
end)
|
|
|
|
if not timer:is_closing() then
|
|
timer:close()
|
|
end
|
|
end)
|
|
end
|
|
end
|
|
end
|