mirror of
				https://github.com/neovim/neovim.git
				synced 2025-11-03 17:24:29 +00:00 
			
		
		
		
	Setting `vim.g.clipboard = false` will use the builtin clipboard providers. Closes https://github.com/neovim/neovim/issues/27698. Co-authored-by: Gregory Anders <greg@gpanders.com>
		
			
				
	
	
		
			257 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			VimL
		
	
	
	
	
	
			
		
		
	
	
			257 lines
		
	
	
		
			8.5 KiB
		
	
	
	
		
			VimL
		
	
	
	
	
	
" The clipboard provider uses shell commands to communicate with the clipboard.
 | 
						|
" The provider function will only be registered if a supported command is
 | 
						|
" available.
 | 
						|
 | 
						|
if exists('g:loaded_clipboard_provider')
 | 
						|
  finish
 | 
						|
endif
 | 
						|
" Default to 1.  provider#clipboard#Executable() may set 2.
 | 
						|
" To force a reload:
 | 
						|
"   :unlet g:loaded_clipboard_provider
 | 
						|
"   :runtime autoload/provider/clipboard.vim
 | 
						|
let g:loaded_clipboard_provider = 1
 | 
						|
 | 
						|
let s:copy = {}
 | 
						|
let s:paste = {}
 | 
						|
let s:clipboard = {}
 | 
						|
 | 
						|
" When caching is enabled, store the jobid of the xclip/xsel process keeping
 | 
						|
" ownership of the selection, so we know how long the cache is valid.
 | 
						|
let s:selection = { 'owner': 0, 'data': [], 'stderr_buffered': v:true }
 | 
						|
 | 
						|
function! s:selection.on_exit(jobid, data, event) abort
 | 
						|
  " At this point this nvim instance might already have launched
 | 
						|
  " a new provider instance. Don't drop ownership in this case.
 | 
						|
  if self.owner == a:jobid
 | 
						|
    let self.owner = 0
 | 
						|
  endif
 | 
						|
  " Don't print if exit code is >= 128 ( exit is 128+SIGNUM if by signal (e.g. 143 on SIGTERM))
 | 
						|
  if a:data > 0 && a:data < 128
 | 
						|
    echohl WarningMsg
 | 
						|
    echomsg 'clipboard: error invoking '.get(self.argv, 0, '?').': '.join(self.stderr)
 | 
						|
    echohl None
 | 
						|
  endif
 | 
						|
endfunction
 | 
						|
 | 
						|
let s:selections = { '*': s:selection, '+': copy(s:selection) }
 | 
						|
 | 
						|
function! s:try_cmd(cmd, ...) abort
 | 
						|
  let out = systemlist(a:cmd, (a:0 ? a:1 : ['']), 1)
 | 
						|
  if v:shell_error
 | 
						|
    if !exists('s:did_error_try_cmd')
 | 
						|
      echohl WarningMsg
 | 
						|
      echomsg "clipboard: error: ".(len(out) ? out[0] : v:shell_error)
 | 
						|
      echohl None
 | 
						|
      let s:did_error_try_cmd = 1
 | 
						|
    endif
 | 
						|
    return 0
 | 
						|
  endif
 | 
						|
  return out
 | 
						|
endfunction
 | 
						|
 | 
						|
" Returns TRUE if `cmd` exits with success, else FALSE.
 | 
						|
function! s:cmd_ok(cmd) abort
 | 
						|
  call system(a:cmd)
 | 
						|
  return v:shell_error == 0
 | 
						|
endfunction
 | 
						|
 | 
						|
function! s:split_cmd(cmd) abort
 | 
						|
  return (type(a:cmd) == v:t_string) ? split(a:cmd, " ") : a:cmd
 | 
						|
endfunction
 | 
						|
 | 
						|
let s:cache_enabled = 1
 | 
						|
let s:err = ''
 | 
						|
 | 
						|
function! provider#clipboard#Error() abort
 | 
						|
  return s:err
 | 
						|
endfunction
 | 
						|
 | 
						|
function! provider#clipboard#Executable() abort
 | 
						|
  " Setting g:clipboard to v:false explicitly opts-in to using the "builtin" clipboard providers below
 | 
						|
  if exists('g:clipboard') && g:clipboard isnot# v:false
 | 
						|
    if type({}) isnot# type(g:clipboard)
 | 
						|
          \ || type({}) isnot# type(get(g:clipboard, 'copy', v:null))
 | 
						|
          \ || type({}) isnot# type(get(g:clipboard, 'paste', v:null))
 | 
						|
      let s:err = 'clipboard: invalid g:clipboard'
 | 
						|
      return ''
 | 
						|
    endif
 | 
						|
 | 
						|
    let s:copy = {}
 | 
						|
    let s:copy['+'] = s:split_cmd(get(g:clipboard.copy, '+', v:null))
 | 
						|
    let s:copy['*'] = s:split_cmd(get(g:clipboard.copy, '*', v:null))
 | 
						|
 | 
						|
    let s:paste = {}
 | 
						|
    let s:paste['+'] = s:split_cmd(get(g:clipboard.paste, '+', v:null))
 | 
						|
    let s:paste['*'] = s:split_cmd(get(g:clipboard.paste, '*', v:null))
 | 
						|
 | 
						|
    let s:cache_enabled = get(g:clipboard, 'cache_enabled', 0)
 | 
						|
    return get(g:clipboard, 'name', 'g:clipboard')
 | 
						|
  elseif has('mac')
 | 
						|
    let s:copy['+'] = ['pbcopy']
 | 
						|
    let s:paste['+'] = ['pbpaste']
 | 
						|
    let s:copy['*'] = s:copy['+']
 | 
						|
    let s:paste['*'] = s:paste['+']
 | 
						|
    let s:cache_enabled = 0
 | 
						|
    return 'pbcopy'
 | 
						|
  elseif !empty($WAYLAND_DISPLAY) && executable('wl-copy') && executable('wl-paste')
 | 
						|
    let s:copy['+'] = ['wl-copy', '--type', 'text/plain']
 | 
						|
    let s:paste['+'] = ['wl-paste', '--no-newline']
 | 
						|
    let s:copy['*'] = ['wl-copy', '--primary', '--type', 'text/plain']
 | 
						|
    let s:paste['*'] = ['wl-paste', '--no-newline', '--primary']
 | 
						|
    return 'wl-copy'
 | 
						|
  elseif !empty($WAYLAND_DISPLAY) && executable('waycopy') && executable('waypaste')
 | 
						|
    let s:copy['+'] = ['waycopy', '-t', 'text/plain']
 | 
						|
    let s:paste['+'] = ['waypaste', '-t', 'text/plain']
 | 
						|
    let s:copy['*'] = s:copy['+']
 | 
						|
    let s:paste['*'] = s:paste['+']
 | 
						|
    return 'wayclip'
 | 
						|
  elseif !empty($DISPLAY) && executable('xsel') && s:cmd_ok('xsel -o -b')
 | 
						|
    let s:copy['+'] = ['xsel', '--nodetach', '-i', '-b']
 | 
						|
    let s:paste['+'] = ['xsel', '-o', '-b']
 | 
						|
    let s:copy['*'] = ['xsel', '--nodetach', '-i', '-p']
 | 
						|
    let s:paste['*'] = ['xsel', '-o', '-p']
 | 
						|
    return 'xsel'
 | 
						|
  elseif !empty($DISPLAY) && executable('xclip')
 | 
						|
    let s:copy['+'] = ['xclip', '-quiet', '-i', '-selection', 'clipboard']
 | 
						|
    let s:paste['+'] = ['xclip', '-o', '-selection', 'clipboard']
 | 
						|
    let s:copy['*'] = ['xclip', '-quiet', '-i', '-selection', 'primary']
 | 
						|
    let s:paste['*'] = ['xclip', '-o', '-selection', 'primary']
 | 
						|
    return 'xclip'
 | 
						|
  elseif executable('lemonade')
 | 
						|
    let s:copy['+'] = ['lemonade', 'copy']
 | 
						|
    let s:paste['+'] = ['lemonade', 'paste']
 | 
						|
    let s:copy['*'] = ['lemonade', 'copy']
 | 
						|
    let s:paste['*'] = ['lemonade', 'paste']
 | 
						|
    return 'lemonade'
 | 
						|
  elseif executable('doitclient')
 | 
						|
    let s:copy['+'] = ['doitclient', 'wclip']
 | 
						|
    let s:paste['+'] = ['doitclient', 'wclip', '-r']
 | 
						|
    let s:copy['*'] = s:copy['+']
 | 
						|
    let s:paste['*'] = s:paste['+']
 | 
						|
    return 'doitclient'
 | 
						|
  elseif executable('win32yank.exe')
 | 
						|
    if has('wsl') && getftype(exepath('win32yank.exe')) == 'link'
 | 
						|
      let win32yank = resolve(exepath('win32yank.exe'))
 | 
						|
    else
 | 
						|
      let win32yank = 'win32yank.exe'
 | 
						|
    endif
 | 
						|
    let s:copy['+'] = [win32yank, '-i', '--crlf']
 | 
						|
    let s:paste['+'] = [win32yank, '-o', '--lf']
 | 
						|
    let s:copy['*'] = s:copy['+']
 | 
						|
    let s:paste['*'] = s:paste['+']
 | 
						|
    return 'win32yank'
 | 
						|
  elseif executable('termux-clipboard-set')
 | 
						|
    let s:copy['+'] = ['termux-clipboard-set']
 | 
						|
    let s:paste['+'] = ['termux-clipboard-get']
 | 
						|
    let s:copy['*'] = s:copy['+']
 | 
						|
    let s:paste['*'] = s:paste['+']
 | 
						|
    return 'termux-clipboard'
 | 
						|
  elseif !empty($TMUX) && executable('tmux')
 | 
						|
    let tmux_v = v:lua.vim.version.parse(system(['tmux', '-V']))
 | 
						|
    if !empty(tmux_v) && !v:lua.vim.version.lt(tmux_v, [3,2,0])
 | 
						|
      let s:copy['+'] = ['tmux', 'load-buffer', '-w', '-']
 | 
						|
    else
 | 
						|
      let s:copy['+'] = ['tmux', 'load-buffer', '-']
 | 
						|
    endif
 | 
						|
    let s:paste['+'] = ['tmux', 'save-buffer', '-']
 | 
						|
    let s:copy['*'] = s:copy['+']
 | 
						|
    let s:paste['*'] = s:paste['+']
 | 
						|
    return 'tmux'
 | 
						|
  endif
 | 
						|
 | 
						|
  let s:err = 'clipboard: No clipboard tool. :help clipboard'
 | 
						|
  return ''
 | 
						|
endfunction
 | 
						|
 | 
						|
function! s:clipboard.get(reg) abort
 | 
						|
  if type(s:paste[a:reg]) == v:t_func
 | 
						|
    return s:paste[a:reg]()
 | 
						|
  elseif s:selections[a:reg].owner > 0
 | 
						|
    return s:selections[a:reg].data
 | 
						|
  end
 | 
						|
 | 
						|
  let clipboard_data = s:try_cmd(s:paste[a:reg])
 | 
						|
  if match(&clipboard, '\v(unnamed|unnamedplus)') >= 0
 | 
						|
        \ && type(clipboard_data) == v:t_list
 | 
						|
        \ && get(s:selections[a:reg].data, 0, []) ==# clipboard_data
 | 
						|
    " When system clipboard return is same as our cache return the cache
 | 
						|
    " as it contains regtype information
 | 
						|
    return s:selections[a:reg].data
 | 
						|
  end
 | 
						|
  return clipboard_data
 | 
						|
endfunction
 | 
						|
 | 
						|
function! s:clipboard.set(lines, regtype, reg) abort
 | 
						|
  if a:reg == '"'
 | 
						|
    call s:clipboard.set(a:lines,a:regtype,'+')
 | 
						|
    if s:copy['*'] != s:copy['+']
 | 
						|
      call s:clipboard.set(a:lines,a:regtype,'*')
 | 
						|
    end
 | 
						|
    return 0
 | 
						|
  end
 | 
						|
 | 
						|
  if type(s:copy[a:reg]) == v:t_func
 | 
						|
    call s:copy[a:reg](a:lines, a:regtype)
 | 
						|
    return 0
 | 
						|
  end
 | 
						|
 | 
						|
  if s:cache_enabled == 0
 | 
						|
    call s:try_cmd(s:copy[a:reg], a:lines)
 | 
						|
    "Cache it anyway we can compare it later to get regtype of the yank
 | 
						|
    let s:selections[a:reg] = copy(s:selection)
 | 
						|
    let s:selections[a:reg].data = [a:lines, a:regtype]
 | 
						|
    return 0
 | 
						|
  end
 | 
						|
 | 
						|
  if s:selections[a:reg].owner > 0
 | 
						|
    let prev_job = s:selections[a:reg].owner
 | 
						|
  end
 | 
						|
  let s:selections[a:reg] = copy(s:selection)
 | 
						|
  let selection = s:selections[a:reg]
 | 
						|
  let selection.data = [a:lines, a:regtype]
 | 
						|
  let selection.argv = s:copy[a:reg]
 | 
						|
  let selection.detach = s:cache_enabled
 | 
						|
  let selection.cwd = "/"
 | 
						|
  let jobid = jobstart(selection.argv, selection)
 | 
						|
  if jobid > 0
 | 
						|
    call jobsend(jobid, a:lines)
 | 
						|
    call jobclose(jobid, 'stdin')
 | 
						|
    " xclip does not close stdout when receiving input via stdin
 | 
						|
    if selection.argv[0] ==# 'xclip'
 | 
						|
      call jobclose(jobid, 'stdout')
 | 
						|
    endif
 | 
						|
    let selection.owner = jobid
 | 
						|
    let ret = 1
 | 
						|
  else
 | 
						|
    echohl WarningMsg
 | 
						|
    echomsg 'clipboard: failed to execute: '.(s:copy[a:reg])
 | 
						|
    echohl None
 | 
						|
    let ret = 1
 | 
						|
  endif
 | 
						|
 | 
						|
  " The previous provider instance should exit when the new one takes
 | 
						|
  " ownership, but kill it to be sure we don't fill up the job table.
 | 
						|
  if exists('prev_job')
 | 
						|
    call timer_start(1000, {... ->
 | 
						|
          \ jobwait([prev_job], 0)[0] == -1
 | 
						|
          \ && jobstop(prev_job)})
 | 
						|
  endif
 | 
						|
 | 
						|
  return ret
 | 
						|
endfunction
 | 
						|
 | 
						|
function! provider#clipboard#Call(method, args) abort
 | 
						|
  if get(s:, 'here', v:false)  " Clipboard provider must not recurse. #7184
 | 
						|
    return 0
 | 
						|
  endif
 | 
						|
  let s:here = v:true
 | 
						|
  try
 | 
						|
    return call(s:clipboard[a:method],a:args,s:clipboard)
 | 
						|
  finally
 | 
						|
    let s:here = v:false
 | 
						|
  endtry
 | 
						|
endfunction
 | 
						|
 | 
						|
" eval_has_provider() decides based on this variable.
 | 
						|
let g:loaded_clipboard_provider = empty(provider#clipboard#Executable()) ? 1 : 2
 |