Files
neovim/runtime/lua/vim/ui/clipboard/osc52.lua
Justin M. Keyes d9ed4c8566 refactor(tty): tty.request() #39489
Problem:
- Various `TermRequest` handlers which all do similar things.
- `tty.query` is specific to `XTGETTCAP DCS`, can't be reused for other kinds of terminal queries.

Solution:
Provide `tty.request()`.
2026-04-30 07:26:40 -04:00

71 lines
2.0 KiB
Lua

local M = {}
--- Return the OSC 52 escape sequence
---
--- @param clipboard string The clipboard to read from or write to
--- @param contents string The Base64 encoded contents to write to the clipboard, or '?' to read
--- from the clipboard
local function osc52(clipboard, contents)
return string.format('\027]52;%s;%s\027\\', clipboard, contents)
end
function M.copy(reg)
local clipboard = reg == '+' and 'c' or 'p'
return function(lines)
local s = table.concat(lines, '\n')
-- The data to be written here can be quite long.
vim.api.nvim_ui_send(osc52(clipboard, vim.base64.encode(s)))
end
end
function M.paste(reg)
local clipboard = reg == '+' and 'c' or 'p'
return function()
local contents = nil --- @type string?
-- timeout=0: we manage the staged 1s/9s timeout via vim.wait below.
local id = vim.tty.request(osc52(clipboard, '?'), { timeout = 0 }, function(resp)
local encoded = resp:match('\027%]52;%w?;([A-Za-z0-9+/=]*)')
if encoded then
contents = vim.base64.decode(encoded)
return true
end
end)
-- Wait 1s first for terminals that respond quickly
local ok, res = vim.wait(1000, function()
return contents ~= nil
end)
if res == -1 then
-- If no response was received after 1s, print a message and keep waiting
vim.api.nvim_echo(
{ { 'Waiting for OSC 52 response from the terminal. Press Ctrl-C to interrupt...' } },
false,
{}
)
ok, res = vim.wait(9000, function()
return contents ~= nil
end)
end
if not ok then
pcall(vim.api.nvim_del_autocmd, id)
if res == -1 then
vim.notify(
'Timed out waiting for a clipboard response from the terminal',
vim.log.levels.WARN
)
elseif res == -2 then
-- Clear message area
vim.api.nvim_echo({ { '' } }, false, {})
end
return 0
end
-- If we get here, contents should be non-nil
return vim.split(assert(contents), '\n')
end
end
return M