Closing and focusing floating preview (nvim)

Author: jerdna-regeiz

autoload/lsp/ui/vim/output.vim

@@ -1,16 +1,41 @@
 let s:supports_floating = exists('*nvim_open_win') || has('patch-8.1.1517')
 let s:win = v:false
+let s:prevwin = v:false
 
 function! lsp#ui#vim#output#closepreview() abort
   if win_getid() == s:win
     " Don't close if window got focus
     return
   endif
-  pclose
+  "closing floats in vim8.1 must use popup_close() (nvim could use nvim_win_close but pclose
+  "works)
+  if s:supports_floating && s:win && g:lsp_preview_float && !has('nvim')
+    " TODO: 
+    call popup_close(s:win)
+  else
+    pclose 
+  endif
   let s:win = v:false
   autocmd! lsp_float_preview_close CursorMoved,CursorMovedI,VimResized *
 endfunction
 
+function! lsp#ui#vim#output#focuspreview() abort
+  " This does not work for vim8.1 popup but will work for nvim and old preview
+  if s:win
+    if win_getid() != s:win
+      let s:prevwin = win_getid()
+      call win_gotoid(s:win)
+    elseif s:prevwin
+      " Temporarily disable hooks
+      " TODO: remove this when closing logic is able to distinguish different move directions
+      autocmd! lsp_float_preview_close CursorMoved,CursorMovedI,VimResized *
+      call win_gotoid(s:prevwin)
+      call s:add_float_closing_hooks()
+      let s:prevwin = v:false
+    endif
+  endif
+endfunction
+
 function! s:bufwidth() abort
   let width = winwidth(0)
   let numberwidth = max([&numberwidth, strlen(line('$'))+1])
@@ -83,13 +108,13 @@ function! lsp#ui#vim#output#floatingpreview(data) abort
     call nvim_win_set_option(s:win, 'cursorline', v:false)
     " Enable closing the preview with esc, but map only in the scratch buffer
     nmap <buffer><silent> <esc> :pclose<cr>
-    return s:win
   else
-    return popup_atcursor('...', {
+    let s:win = popup_atcursor('...', {
         \  'moved': 'any',
 		    \  'border': [1, 1, 1, 1],
 		\})
   endif
+  return s:win
 endfunction
 
 function! s:setcontent(lines, ft) abort
@@ -116,10 +141,12 @@ function! s:adjust_float_placement(bufferlines, maxwidth) abort
 endfunction
 
 function! s:add_float_closing_hooks() abort
+    if g:lsp_preview_autoclose
       augroup lsp_float_preview_close
         autocmd! lsp_float_preview_close CursorMoved,CursorMovedI,VimResized *
         autocmd CursorMoved,CursorMovedI,VimResized * call lsp#ui#vim#output#closepreview()
       augroup END
+    endif
 endfunction
 
 function! lsp#ui#vim#output#preview(data) abort

doc/vim-lsp.txt

@@ -14,6 +14,7 @@ CONTENTS                                                  *vim-lsp-contents*
       g:lsp_auto_enable                     |g:lsp_auto_enable|
       g:lsp_preview_keep_focus              |g:lsp_preview_keep_focus|
       g:lsp_preview_float		    |g:lsp_preview_float|
+      g:lsp_preview_autoclose		    |g:lsp_preview_autoclose|
       g:lsp_insert_text_enabled             |g:lsp_insert_text_enabled|
       g:lsp_text_edit_enabled               |g:lsp_text_edit_enabled|
       g:lsp_diagnostics_echo_cursor         |g:lsp_diagnostics_echo_cursor|
@@ -54,6 +55,9 @@ CONTENTS                                                  *vim-lsp-contents*
     Autocommands                          |vim-lsp-autocommands|
       lsp_complete_done                     |lsp_complete_done|
     Mappings                              |vim-lsp-mappings|
+       <plug>(lsp-preview-close)            |<plug>(lsp-preview-close)|
+       <plug>(lsp-preview-focus)            |<plug>(lsp-preview-focus)|
+
     Autocomplete                          |vim-lsp-autocomplete|
       omnifunc                              |vim-lsp-omnifunc|
       asyncomplete.vim                      |vim-lsp-asyncomplete|
@@ -172,6 +176,23 @@ g:lsp_preview_float                         *g:lsp_preview_float*
 	" Opens preview windows as normal windows
 	let g:lsp_preview_float = 0
 
+g:lsp_preview_autoclose                         *g:lsp_preview_autoclose*
+    Type: |Number|
+    Default: `1`
+
+    Indicates if an opened floating preview shall be automatically closed upon
+    movement of the cursor. If set to 1, the window will close automatically if
+    the cursor is moved and the preview is not focused. If set to 0, it will
+    remain open until explicitly closed (e.g. with <plug>(lsp-preview-close),
+    or <ESC> when focused).
+
+    Example:
+	" Preview closes on cursor move
+	let g:lsp_preview_autoclose = 1
+
+	" Preview remains open and waits for an explicit call
+	let g:lsp_preview_autoclose = 0
+
 g:lsp_insert_text_enabled                       *g:lsp_insert_text_enabled*
     Type: |Number|
     Default: `1`
@@ -661,6 +682,8 @@ Available plug mappings are following:
   (lsp-hover)
   (lsp-next-error)
   (lsp-next-reference)
+  (lsp-preview-close)
+  (lsp-preview-focus)
   (lsp-previous-error)
   (lsp-previous-reference)
   (lsp-references)
@@ -674,6 +697,16 @@ Available plug mappings are following:
 
 See also |vim-lsp-commands|
 
+<plug>(lsp-preview-close)	         	     *<plug>(lsp-preview-close)*
+
+Closes an opened preview window
+
+<plug>(lsp-preview-focus)	         	     *<plug>(lsp-preview-focus)*
+
+Transfers focus to an opened preview window or back to the previous window if
+focus is already on the preview window.
+
+  
 ===============================================================================
 Autocomplete                                          *vim-lsp-autocomplete*
 

plugin/lsp.vim

@@ -26,6 +26,7 @@ let g:lsp_insert_text_enabled= get(g:, 'lsp_insert_text_enabled', 1)
 let g:lsp_text_edit_enabled = get(g:, 'lsp_text_edit_enabled', has('patch-8.0.1493'))
 let g:lsp_highlight_references_enabled = get(g:, 'lsp_highlight_references_enabled', 1)
 let g:lsp_preview_float = get(g:, 'lsp_preview_float', 1)
+let g:lsp_preview_autoclose = get(g:, 'lsp_preview_autoclose', 1)
 
 let g:lsp_get_vim_completion_item = get(g:, 'lsp_get_vim_completion_item', [function('lsp#omni#default_get_vim_completion_item')])
 let g:lsp_get_supported_capabilities = get(g:, 'lsp_get_supported_capabilities', [function('lsp#default_get_supported_capabilities')])
@@ -65,6 +66,8 @@ nnoremap <plug>(lsp-definition) :<c-u>call lsp#ui#vim#definition()<cr>
 nnoremap <plug>(lsp-document-symbol) :<c-u>call lsp#ui#vim#document_symbol()<cr>
 nnoremap <plug>(lsp-document-diagnostics) :<c-u>call lsp#ui#vim#diagnostics#document_diagnostics()<cr>
 nnoremap <plug>(lsp-hover) :<c-u>call lsp#ui#vim#hover#get_hover_under_cursor()<cr>
+nnoremap <plug>(lsp-preview-close) :<c-u>call lsp#ui#vim#output#closepreview()<cr>
+nnoremap <plug>(lsp-preview-focus) :<c-u>call lsp#ui#vim#output#focuspreview()<cr>
 nnoremap <plug>(lsp-next-error) :<c-u>call lsp#ui#vim#diagnostics#next_error()<cr>
 nnoremap <plug>(lsp-previous-error) :<c-u>call lsp#ui#vim#diagnostics#previous_error()<cr>
 nnoremap <plug>(lsp-references) :<c-u>call lsp#ui#vim#references()<cr>