Add LspPeekDefinition

README.md

@@ -63,7 +63,7 @@ For more information, refer to the readme and documentation of the respective pl
 |--|--|
 |`:LspCodeAction`| Gets a list of possible commands that can be applied to a file so it can be fixed (quick fix) |
 |`:LspDeclaration`| Go to declaration |
-|`:LspDefinition`| Go to definition |
+|`:LspDefinition`| Go to the definition of the word under the cursor, and open in the current window |
 |`:LspDocumentDiagnostics`| Get current document diagnostics information |
 |`:LspDocumentFormat`| Format entire document |
 |`:LspDocumentRangeFormat`| Format document selection |
@@ -72,6 +72,7 @@ For more information, refer to the readme and documentation of the respective pl
 |`:LspImplementation` | Show implementation of interface |
 |`:LspNextError`| jump to next error |
 |`:LspNextReference`| jump to next reference to the symbol under cursor |
+|`:LspPeekDefinition`| Go to the definition of the word under the cursor, but open in preview window |
 |`:LspPreviousError`| jump to previous error |
 |`:LspPreviousReference`| jump to previous reference to the symbol under cursor |
 |`:LspReferences`| Find references |

autoload/lsp/ui/vim.vim

@@ -13,7 +13,7 @@ function! lsp#ui#vim#implementation() abort
         call s:not_supported('Retrieving implementation')
         return
     endif
-    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1 }
+    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1, 'in_preview': 0 }
     for l:server in l:servers
         call lsp#send_request(l:server, {
             \ 'method': 'textDocument/implementation',
@@ -37,7 +37,7 @@ function! lsp#ui#vim#type_definition() abort
         call s:not_supported('Retrieving type definition')
         return
     endif
-    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1 }
+    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1, 'in_preview': 0 }
     for l:server in l:servers
         call lsp#send_request(l:server, {
             \ 'method': 'textDocument/typeDefinition',
@@ -62,7 +62,7 @@ function! lsp#ui#vim#declaration() abort
         return
     endif
 
-    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1 }
+    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1, 'in_preview': 0 }
     for l:server in l:servers
         call lsp#send_request(l:server, {
             \ 'method': 'textDocument/declaration',
@@ -77,7 +77,7 @@ function! lsp#ui#vim#declaration() abort
     echo 'Retrieving declaration ...'
 endfunction
 
-function! lsp#ui#vim#definition() abort
+function! lsp#ui#vim#definition(in_preview) abort
     let l:servers = filter(lsp#get_whitelisted_servers(), 'lsp#capabilities#has_definition_provider(v:val)')
     let s:last_req_id = s:last_req_id + 1
     call setqflist([])
@@ -87,7 +87,7 @@ function! lsp#ui#vim#definition() abort
         return
     endif
 
-    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1 }
+    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 1, 'in_preview': a:in_preview }
     for l:server in l:servers
         call lsp#send_request(l:server, {
             \ 'method': 'textDocument/definition',
@@ -108,7 +108,7 @@ function! lsp#ui#vim#references() abort
 
     call setqflist([])
 
-    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 0 }
+    let l:ctx = { 'counter': len(l:servers), 'list':[], 'last_req_id': s:last_req_id, 'jump_if_one': 0, 'in_preview': 0 }
     if len(l:servers) == 0
         call s:not_supported('Retrieving references')
         return
@@ -418,7 +418,7 @@ function! s:handle_symbol(server, last_req_id, type, data) abort
     endif
 endfunction
 
-function! s:handle_location(ctx, server, type, data) abort "ctx = {counter, list, jump_if_one, last_req_id}
+function! s:handle_location(ctx, server, type, data) abort "ctx = {counter, list, jump_if_one, last_req_id, in_preview}
     if a:ctx['last_req_id'] != s:last_req_id
         return
     endif
@@ -435,9 +435,10 @@ function! s:handle_location(ctx, server, type, data) abort "ctx = {counter, list
         if empty(a:ctx['list'])
             call lsp#utils#error('No ' . a:type .' found')
         else
-            if len(a:ctx['list']) == 1 && a:ctx['jump_if_one']
+            let l:loc = a:ctx['list'][0]
+
+            if len(a:ctx['list']) == 1 && a:ctx['jump_if_one'] && !a:ctx['in_preview']
                 normal! m'
-                let l:loc = a:ctx['list'][0]
                 let l:buffer = bufnr(l:loc['filename'])
                 if &modified && !&hidden
                     let l:cmd = l:buffer !=# -1 ? 'sb ' . l:buffer : 'split ' . fnameescape(l:loc['filename'])
@@ -447,10 +448,17 @@ function! s:handle_location(ctx, server, type, data) abort "ctx = {counter, list
                 execute l:cmd . ' | call cursor('.l:loc['lnum'].','.l:loc['col'].')'
                 echo 'Retrieved ' . a:type
                 redraw
-            else
+            elseif !a:ctx['in_preview']
                 call setqflist(a:ctx['list'])
                 echo 'Retrieved ' . a:type
                 botright copen
+            else
+                let l:lines = readfile(fnameescape(l:loc['filename']))
+                call lsp#ui#vim#output#preview(l:lines, {
+                            \   'statusline': ' LSP Peek ' . a:type,
+                            \   'cursor': { 'line': l:loc['lnum'], 'col': l:loc['col'], 'align': 'center' },
+                            \   'filetype': &filetype
+                            \ })
             endif
         endif
     endif

autoload/lsp/ui/vim/hover.vim

@@ -35,7 +35,7 @@ function! s:handle_hover(server, data) abort
     endif
 
     if !empty(a:data['response']['result']) && !empty(a:data['response']['result']['contents'])
-        call lsp#ui#vim#output#preview(a:data['response']['result']['contents'])
+        call lsp#ui#vim#output#preview(a:data['response']['result']['contents'], {'statusline': ' LSP Hover'})
         return
     else
         call lsp#utils#error('No hover information found')

autoload/lsp/ui/vim/output.vim

@@ -2,8 +2,13 @@ let s:supports_floating = exists('*nvim_open_win') || has('patch-8.1.1517')
 let s:winid = v:false
 let s:prevwin = v:false
 let s:preview_data = v:false
+let s:suppress_close = v:false
 
 function! lsp#ui#vim#output#closepreview() abort
+  if s:suppress_close
+    return
+  endif
+
   if win_getid() == s:winid
     " Don't close if window got focus
     return
@@ -91,7 +96,7 @@ function! s:get_float_positioning(height, width) abort
     return l:opts
 endfunction
 
-function! lsp#ui#vim#output#floatingpreview(data) abort
+function! lsp#ui#vim#output#floatingpreview(data, options) abort
   if has('nvim')
     let l:buf = nvim_create_buf(v:false, v:true)
     call setbufvar(l:buf, '&signcolumn', 'no')
@@ -110,13 +115,32 @@ function! lsp#ui#vim#output#floatingpreview(data) abort
     call nvim_win_set_option(s:winid, 'number', v:false)
     call nvim_win_set_option(s:winid, 'relativenumber', v:false)
     call nvim_win_set_option(s:winid, 'cursorline', v:false)
+
     " Enable closing the preview with esc, but map only in the scratch buffer
     nmap <buffer><silent> <esc> :pclose<cr>
   else
-    let s:winid = popup_atcursor('...', {
-        \  'moved': 'any',
-		    \  'border': [1, 1, 1, 1],
-		\})
+    let l:options = {
+                \ 'moved': 'any',
+                \ 'border': [1, 1, 1, 1],
+                \ }
+
+    if has_key(a:options, 'cursor')
+      if has_key(a:options['cursor'], 'align')
+          let l:align = a:options['cursor']['align']
+
+          if l:align ==? 'top'
+              let l:options['firstline'] = a:options['cursor']['line']
+          elseif l:align ==? 'center'
+              " TODO
+              let l:options['firstline'] = a:options['cursor']['line']
+          elseif l:align ==? 'bottom'
+              " TODO
+              let l:options['firstline'] = a:options['cursor']['line']
+          endif
+      endif
+    endif
+
+    let s:winid = popup_atcursor('...', l:options)
   endif
   return s:winid
 endfunction
@@ -167,17 +191,31 @@ function! lsp#ui#vim#output#getpreviewwinid() abort
     return s:winid
 endfunction
 
-function! s:open_preview(data) abort
+function! s:open_preview(data, options) abort
     if s:supports_floating && g:lsp_preview_float
-      let l:winid = lsp#ui#vim#output#floatingpreview(a:data)
+      let l:winid = lsp#ui#vim#output#floatingpreview(a:data, a:options)
     else
       execute &previewheight.'new'
       let l:winid = win_getid()
     endif
     return l:winid
 endfunction
 
-function! lsp#ui#vim#output#preview(data) abort
+function! s:align_preview(options) abort
+    if has_key(a:options['cursor'], 'align')
+        let l:align = a:options['cursor']['align']
+
+        if l:align ==? 'top'
+            normal! zt
+        elseif l:align ==? 'center'
+            normal! zz
+        elseif l:align ==? 'bottom'
+            normal! zb
+        endif
+    endif
+endfunction
+
+function! lsp#ui#vim#output#preview(data, options) abort
     if s:winid && type(s:preview_data) == type(a:data)
        \ && s:preview_data == a:data
        \ && type(g:lsp_preview_doubletap) == 3
@@ -191,17 +229,38 @@ function! lsp#ui#vim#output#preview(data) abort
 
     let l:current_window_id = win_getid()
 
-    let s:winid = s:open_preview(a:data)
+    let s:winid = s:open_preview(a:data, a:options)
 
     let s:preview_data = a:data
     let l:lines = []
     let l:ft = s:append(a:data, l:lines)
+
+    if has_key(a:options, 'filetype')
+        let l:ft = a:options['filetype']
+    endif
+
     call s:setcontent(l:lines, l:ft)
 
     " Get size information while still having the buffer active
     let l:bufferlines = line('$')
     let l:maxwidth = max(map(getline(1, '$'), 'strdisplaywidth(v:val)'))
 
+    if !s:supports_floating || !g:lsp_preview_float
+        " Don't use 'scrolloff', it might mess up the cursor's position
+        let &l:scrolloff = 0
+
+        " Set options of preview window
+        if has_key(a:options, 'statusline')
+            let &l:statusline = a:options['statusline']
+        endif
+
+        if has_key(a:options, 'cursor')
+            execute printf('call cursor(%d, %d)', a:options['cursor']['line'], a:options['cursor']['col'])
+            call s:align_preview(a:options)
+        endif
+    endif
+
+    " Go to the previous window to adjust positioning
     if g:lsp_preview_keep_focus
       " restore focus to the previous window
       call win_gotoid(l:current_window_id)
@@ -213,9 +272,28 @@ function! lsp#ui#vim#output#preview(data) abort
       if has('nvim')
         call s:adjust_float_placement(l:bufferlines, l:maxwidth)
         call s:add_float_closing_hooks()
+
+        if has_key(a:options, 'cursor')
+          let s:suppress_close = v:true
+
+          " Go back to the preview window to set the cursor
+          call win_gotoid(s:winid)
+          let l:old_scrolloff = &scrolloff
+          let &scrolloff = 0
+
+          call nvim_win_set_cursor(s:winid, [a:options['cursor']['line'], a:options['cursor']['col']])
+          call s:align_preview(a:options)
+
+          " Finally, go back to the original window
+          call win_gotoid(l:current_window_id)
+
+          let &scrolloff = l:old_scrolloff
+          let s:suppress_close = v:false
+        endif
       endif
       doautocmd User lsp_float_opened
     endif
+
     return ''
 endfunction
 
@@ -227,7 +305,7 @@ function! s:append(data, lines) abort
 
         return 'markdown'
     elseif type(a:data) == type('')
-        call extend(a:lines, split(a:data, "\n"))
+        call extend(a:lines, split(a:data, "\n", v:true))
 
         return 'markdown'
     elseif type(a:data) == type({}) && has_key(a:data, 'language')
@@ -237,7 +315,7 @@ function! s:append(data, lines) abort
 
         return 'markdown'
     elseif type(a:data) == type({}) && has_key(a:data, 'kind')
-        call extend(a:lines, split(a:data.value, '\n'))
+        call extend(a:lines, split(a:data.value, '\n', v:true))
 
         return a:data.kind ==? 'plaintext' ? 'text' : a:data.kind
     endif

doc/vim-lsp.txt

@@ -48,6 +48,7 @@ CONTENTS                                                  *vim-lsp-contents*
       LspHover                              |LspHover|
       LspNextError                          |LspNextError|
       LspNextReference                      |LspNextReference|
+      LspPeekDefinition                     |LspPeekDefinition|
       LspPreviousError                      |LspPreviousError|
       LspPreviousReference                  |LspPreviousReference|
       LspImplementation                     |LspImplementation|
@@ -620,6 +621,8 @@ LspDefinition						     *LspDefinition*
 
 Go to definition.
 
+Also see |LspPeekDefinition|.
+
 LspDocumentFormat					 *LspDocumentFormat*
 
 Format the entire document.
@@ -662,6 +665,11 @@ LspNextReference                                          *LspNextReference*
 
 Jump to the next reference of the symbol under cursor.
 
+LspPeekDefinition                                        *LspPeekDefinition*
+
+Like |LspDefinition|, but opens the definition in the |preview-window| instead
+of the current window.
+
 LspPreviousError					 *LspPreviousError*
 
 Jump to Previous err diagnostics
@@ -721,6 +729,7 @@ Available plug mappings are following:
   (lsp-code-action)
   (lsp-declaration)
   (lsp-definition)
+  (lsp-peek-definition)
   (lsp-document-symbol)
   (lsp-document-diagnostics)
   (lsp-hover)

ftplugin/lsp-hover.vim

@@ -7,13 +7,13 @@ else
   setlocal previewwindow buftype=nofile bufhidden=wipe noswapfile nobuflisted
 endif
 setlocal nocursorline nofoldenable
+setlocal nonumber norelativenumber
 
 if has('syntax')
     setlocal nospell
 endif
 
-let &l:statusline = ' LSP Hover'
-
 let b:undo_ftplugin = 'setlocal pvw< bt< bh< swf< bl< cul< fen<' .
             \ (has('syntax') ? ' spell<' : '') .
+            \ ' number< relativenumber<' .
             \ ' | unlet! g:markdown_fenced_languages'

plugin/lsp.vim

@@ -41,7 +41,8 @@ endif
 
 command! -range LspCodeAction call lsp#ui#vim#code_action()
 command! LspDeclaration call lsp#ui#vim#declaration()
-command! LspDefinition call lsp#ui#vim#definition()
+command! LspDefinition call lsp#ui#vim#definition(0)
+command! LspPeekDefinition call lsp#ui#vim#definition(1)
 command! LspDocumentSymbol call lsp#ui#vim#document_symbol()
 command! LspDocumentDiagnostics call lsp#ui#vim#diagnostics#document_diagnostics()
 command! -nargs=? -complete=customlist,lsp#utils#empty_complete LspHover call lsp#ui#vim#hover#get_hover_under_cursor()
@@ -63,7 +64,8 @@ command! LspPreviousReference call lsp#ui#vim#references#jump(-1)
 
 nnoremap <plug>(lsp-code-action) :<c-u>call lsp#ui#vim#code_action()<cr>
 nnoremap <plug>(lsp-declaration) :<c-u>call lsp#ui#vim#declaration()<cr>
-nnoremap <plug>(lsp-definition) :<c-u>call lsp#ui#vim#definition()<cr>
+nnoremap <plug>(lsp-definition) :<c-u>call lsp#ui#vim#definition(0)<cr>
+nnoremap <plug>(lsp-peek-definition) :<c-u>call lsp#ui#vim#definition(1)<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>