mirror of
				https://github.com/neovim/neovim.git
				synced 2025-10-26 12:27:24 +00:00 
			
		
		
		
	 35e5307af2
			
		
	
	35e5307af2
	
	
	
		
			
			When a plugin registers a TermRequest handler there is currently no way for the handler to know where the terminal's cursor position was when the sequence was received. This is often useful information, e.g. for OSC 133 sequences which are used to annotate shell prompts. Modify the event data for the TermRequest autocommand to be a table instead of just a string. The "sequence" field of the table contains the sequence string and the "cursor" field contains the cursor position when the sequence was received. To maintain consistency between TermRequest and TermResponse (and to future proof the latter), TermResponse's event data is also updated to be a table with a "sequence" field. BREAKING CHANGE: event data for TermRequest and TermResponse is now a table
		
			
				
	
	
		
			78 lines
		
	
	
		
			2.1 KiB
		
	
	
	
		
			Lua
		
	
	
	
	
	
			
		
		
	
	
			78 lines
		
	
	
		
			2.1 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.
 | |
|     -- Use nvim_chan_send() as io.stdout:write() doesn't handle EAGAIN. #26688
 | |
|     vim.api.nvim_chan_send(2, osc52(clipboard, vim.base64.encode(s)))
 | |
|   end
 | |
| end
 | |
| 
 | |
| function M.paste(reg)
 | |
|   local clipboard = reg == '+' and 'c' or 'p'
 | |
|   return function()
 | |
|     local contents = nil
 | |
|     local id = vim.api.nvim_create_autocmd('TermResponse', {
 | |
|       callback = function(args)
 | |
|         local resp = args.data.sequence ---@type string
 | |
|         local encoded = resp:match('\027%]52;%w?;([A-Za-z0-9+/=]*)')
 | |
|         if encoded then
 | |
|           contents = vim.base64.decode(encoded)
 | |
|           return true
 | |
|         end
 | |
|       end,
 | |
|     })
 | |
| 
 | |
|     io.stdout:write(osc52(clipboard, '?'))
 | |
| 
 | |
|     local ok, res
 | |
| 
 | |
|     -- Wait 1s first for terminals that respond quickly
 | |
|     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
 | |
|       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
 |