Multiple Definitions Returned

README.md

@@ -144,8 +144,15 @@ other reference to the currently highlighted element.
 ### Jump to definition
 
 While the cursor is on any identifier call `LSClientGoToDefinition` (`<C-]>` if
-using the default mappings) to jump to the location of the definition. If the
-cursor moves before the server responds the response will be ignored.
+using the default mappings) to jump to the location of the definition. When
+multiple definitions are available, the quickfix list will be opened.
+If the cursor moves before the server responds the response will be ignored.
+
+### Jump to declaration
+
+While the cursor is on any identifier call `LSClientGoToDeclaration` (`gd` if
+using the default mappings) to jump to the location of the declaration.
+If the cursor moves before the server responds the response will be ignored.
 
 ### Find references
 

autoload/lsc/config.vim

@@ -3,6 +3,8 @@ if !exists('s:initialized')
   let s:default_maps = {
       \ 'GoToDefinition': '<C-]>',
       \ 'GoToDefinitionSplit': ['<C-W>]', '<C-W><C-]>'],
+      \ 'GoToDeclaration': 'gd',
+      \ 'GoToDeclarationSplit': ['<C-W>]', '<C-W>gd'],
       \ 'FindReferences': 'gr',
       \ 'NextReference': '<C-n>',
       \ 'PreviousReference': '<C-p>',
@@ -54,6 +56,8 @@ function! lsc#config#mapKeys() abort
   for l:command in [
       \ 'GoToDefinition',
       \ 'GoToDefinitionSplit',
+      \ 'GoToDeclaration',
+      \ 'GoToDeclarationSplit',
       \ 'FindReferences',
       \ 'NextReference',
       \ 'PreviousReference',

autoload/lsc/reference.vim

@@ -1,45 +1,58 @@
 let s:popup_id = 0
 
+function! lsc#reference#goToDeclaration(mods, issplit) abort
+  call lsc#file#flushChanges()
+  call lsc#server#userCall('textDocument/declaration',
+      \ lsc#params#documentPosition(),
+      \ lsc#util#gateResult('GoTo',
+      \   function('<SID>GoTo', ['declaration', a:mods, a:issplit])))
+endfunction
+
 function! lsc#reference#goToDefinition(mods, issplit) abort
   call lsc#file#flushChanges()
   call lsc#server#userCall('textDocument/definition',
       \ lsc#params#documentPosition(),
-      \ lsc#util#gateResult('GoToDefinition',
-      \   function('<SID>GoToDefinition', [a:mods, a:issplit])))
+      \ lsc#util#gateResult('GoTo',
+      \   function('<SID>GoTo', ['definition', a:mods, a:issplit])))
 endfunction
 
-function! s:GoToDefinition(mods, issplit, result) abort
+function! s:GoTo(label, mods, issplit, result) abort
   if type(a:result) == type(v:null) ||
       \ (type(a:result) == type([]) && len(a:result) == 0)
-    call lsc#message#error('No definition found')
+    call lsc#message#error('No'. a:label .'found')
     return
   endif
-  if type(a:result) == type([])
+  if type(a:result) == type([]) && (a:label ==# 'declaration' || len(a:result) == 1)
     let l:location = a:result[0]
+  elseif type(a:result) == type([]) && len(a:result) > 1
+    call s:setQuickFixLocations('Definitions', a:result)
+    call copen()
   else
     let l:location = a:result
   endif
-  let l:file = lsc#uri#documentPath(l:location.uri)
-  let l:line = l:location.range.start.line + 1
-  let l:character = l:location.range.start.character + 1
-  let l:dotag = &tagstack && exists('*gettagstack') && exists('*settagstack')
-  if l:dotag
-    let l:from = [bufnr('%'), line('.'), col('.'), 0]
-    let l:tagname = expand('<cword>')
-    let l:stack = gettagstack()
-    if l:stack.curidx > 1
-      let l:stack.items = l:stack.items[0:l:stack.curidx-2]
-    else
-      let l:stack.items = []
+  if exists('l:location')
+    let l:file = lsc#uri#documentPath(l:location.uri)
+    let l:line = l:location.range.start.line + 1
+    let l:character = l:location.range.start.character + 1
+    let l:dotag = &tagstack && exists('*gettagstack') && exists('*settagstack')
+    if l:dotag
+      let l:from = [bufnr('%'), line('.'), col('.'), 0]
+      let l:tagname = expand('<cword>')
+      let l:stack = gettagstack()
+      if l:stack.curidx > 1
+        let l:stack.items = l:stack.items[0:l:stack.curidx-2]
+      else
+        let l:stack.items = []
+      endif
+      let l:stack.items += [{'from': l:from, 'tagname': l:tagname}]
+      let l:stack.curidx = len(l:stack.items)
+      call settagstack(win_getid(), l:stack)
+    endif
+    call s:goTo(l:file, l:line, l:character, a:mods, a:issplit)
+    if l:dotag
+      let l:curidx = gettagstack().curidx + 1
+      call settagstack(win_getid(), {'curidx': l:curidx})
     endif
-    let l:stack.items += [{'from': l:from, 'tagname': l:tagname}]
-    let l:stack.curidx = len(l:stack.items)
-    call settagstack(win_getid(), l:stack)
-  endif
-  call s:goTo(l:file, l:line, l:character, a:mods, a:issplit)
-  if l:dotag
-    let l:curidx = gettagstack().curidx + 1
-    call settagstack(win_getid(), {'curidx': l:curidx})
   endif
 endfunction
 

doc/lsc.txt

@@ -50,9 +50,10 @@ COMMANDS                                        *lsc-commands*
                                                 *:LSClientGoToDefinition*
 Jump to the location defining the element under the cursor. Sends a
 "textDocument/definition" request with the location set to the cursor's
-position. If the cursor is not in the same position when the server responds
-the jump will be canceled. With |lsc-default-map| this command is bound to
-`<c-]>`.
+position. When multiple definitions are returned, the quickfix list will
+be opened to prompt the user for choice.  If the cursor is not in the same
+position when the server responds the jump will be canceled.
+With |lsc-default-map| this command is bound to `<c-]>`.
 
 If this version of vim supports |settagstack| the tag stack will also be
 updated to include this jump. Jump back with `<c-t>` or |:pop|, it is not
@@ -75,6 +76,15 @@ will default to opening a vertical split, while >
 <
 will prefer a new tab.
 
+                                                *:LSClientGoToDeclaration*
+Similiar to |LSClientGoToDefinition| but expects only a single result when
+issuing the default binding `gd`.
+This is not compliant to the current protocol since it accepts multiple
+declaration results as well.
+
+                                                *:LSClientGoToDeclarationSplit*
+In accordance to |LSClientGoToDeclaration| and |LSClientGoToDefinitionSplit|.
+
                                                 *:LSClientFindReferences*
 Populate the |quickfix| with a list of location which reference the element
 under the cursor, including it's definition. Sends a "textDocument/references"

plugin/lsc.vim

@@ -25,6 +25,10 @@ command! LSClientGoToDefinitionSplit
     \ call lsc#reference#goToDefinition(<q-mods>, 1)
 command! LSClientGoToDefinition
     \ call lsc#reference#goToDefinition(<q-mods>, 0)
+command! LSClientGoToDeclarationSplit
+    \ call lsc#reference#goToDeclaration(<q-mods>, 1)
+command! LSClientGoToDeclaration
+    \ call lsc#reference#goToDeclaration(<q-mods>, 0)
 command! LSClientFindReferences call lsc#reference#findReferences()
 command! LSClientNextReference call lsc#reference#findNext(1)
 command! LSClientPreviousReference call lsc#reference#findNext(-1)

test/integration/test/vim_test.dart

@@ -35,6 +35,11 @@ void main() {
       expect(result, '2');
     });
 
+    test('loads plugin', () async {
+      final result = await vim.expr('exists(\':LSClientGoToDeclaration\')');
+      expect(result, '1');
+    });
+
     test('opens files, has filetype detection', () async {
       await vim.edit('foo.txt');
       expect(await vim.expr('&ft'), 'text');