Merge pull request #680 from nickspoons/extend-scriptability

Extend scriptability

Author: nickspoons

autoload/OmniSharp/actions/codeactions.vim

@@ -21,11 +21,12 @@ set cpoptions&vim
 " \ 'CallbackCount': function('PlaceSign')
 " \}
 function! OmniSharp#actions#codeactions#Count(...) abort
-  let opts = a:0 && a:1 isnot 0 ? { 'Callback': a:1 } : {}
   if a:0 && type(a:1) == type(function('tr'))
     let opts = { 'CallbackCleanup': a:1 }
   elseif a:0 && type(a:1) == type({})
     let opts = a:1
+  else
+    let opts = {}
   endif
   if g:OmniSharp_server_stdio
     let Callback = function('s:CBCountCodeActions', [opts])

autoload/OmniSharp/actions/definition.vim

@@ -1,30 +1,45 @@
 let s:save_cpo = &cpoptions
 set cpoptions&vim
 
-" Accepts a Funcref callback argument, to be called after the response is
-" returned (synchronously or asynchronously) with a boolean 'found' result
+" Navigate to the definition of the symbol under the cursor.
+" Optional arguments:
+" Callback: When a callback is passed in, it is called after the response is
+"           returned (synchronously or asynchronously) with the found
+"           location and a flag for whether it is in a file in the project or
+"           from the metadata. This is done instead of navigating to the found
+"           location.
+" editcommand: The command to use to open buffers, e.g. 'split', 'vsplit',
+"              'tabedit' or 'edit' (default).
 function! OmniSharp#actions#definition#Find(...) abort
-  let opts = a:0 && a:1 isnot 0 ? { 'Callback': a:1 } : {}
-  if g:OmniSharp_server_stdio
+  if a:0 && type(a:1) == type(function('tr'))
+    let Callback = a:1
+  else
+    let opts = { 'editcommand': 'edit' }
+    if a:0 && type(a:1) == type('') && a:1 !=# ''
+      let opts.editcommand = a:1
+    endif
     let Callback = function('s:CBGotoDefinition', [opts])
+  endif
+
+  if g:OmniSharp_server_stdio
     call s:StdioFind(Callback)
   else
     let loc = OmniSharp#py#Eval('gotoDefinition()')
     if OmniSharp#py#CheckForError() | return 0 | endif
-    " Mock metadata info for old server based setups
-    return s:CBGotoDefinition(opts, loc, { 'MetadataSource': {}})
+    " We never come from metadata here
+    return Callback(loc, 0)
   endif
 endfunction
 
-function! OmniSharp#actions#definition#Preview(...) abort
-  let opts = a:0 && a:1 isnot 0 ? { 'Callback': a:1 } : {}
+function! OmniSharp#actions#definition#Preview() abort
   if g:OmniSharp_server_stdio
-    let Callback = function('s:CBPreviewDefinition', [opts])
+    let Callback = function('s:CBPreviewDefinition')
     call s:StdioFind(Callback)
   else
     let loc = OmniSharp#py#Eval('gotoDefinition()')
     if OmniSharp#py#CheckForError() | return 0 | endif
-    call s:CBPreviewDefinition({}, loc, {})
+    " We never come from metadata here
+    call s:CBPreviewDefinition(loc, 0)
   endif
 endfunction
 
@@ -42,45 +57,74 @@ function! s:StdioFindRH(Callback, response) abort
   if !a:response.Success | return | endif
   let body = a:response.Body
   if type(body) == type({}) && get(body, 'FileName', v:null) != v:null
-    call a:Callback(OmniSharp#locations#Parse([body])[0], body)
+    call a:Callback(OmniSharp#locations#Parse([body])[0], 0)
   else
-    call a:Callback(0, body)
+    if g:OmniSharp_lookup_metadata
+    \ && type(body) == type({})
+    \ && type(body.MetadataSource) == type({})
+      let Callback = function('s:CBMetadataFind', [a:Callback])
+      call s:StdioMetadataFind(Callback, body)
+    else
+      call a:Callback(0, 1)
+    endif
   endif
 endfunction
 
-function! s:CBGotoDefinition(opts, location, metadata) abort
-  let went_to_metadata = 0
+function! s:StdioMetadataFind(Callback, metadata) abort
+  let opts = {
+  \ 'ResponseHandler': function('s:StdioMetadataFindRH', [a:Callback, a:metadata]),
+  \ 'Parameters': a:metadata.MetadataSource
+  \}
+  call OmniSharp#stdio#Request('/metadata', opts)
+endfunction
+
+function! s:StdioMetadataFindRH(Callback, metadata, response) abort
+  if !a:response.Success || a:response.Body.Source == v:null | return 0 | endif
+  call a:Callback(a:response.Body, a:metadata)
+endfunction
+
+function! s:CBMetadataFind(Callback, response, metadata) abort
+  let host = OmniSharp#GetHost()
+  let metadata_filename = fnamemodify(
+  \ OmniSharp#util#TranslatePathForClient(a:response.SourceName), ':t')
+  let temp_file = OmniSharp#util#TempDir() . '/' . metadata_filename
+  let lines = split(a:response.Source, "\n", 1)
+  let lines = map(lines, {i,v -> substitute(v, '\r', '', 'g')})
+  call writefile(lines, temp_file, 'b')
+  let bufnr = bufadd(temp_file)
+  call setbufvar(bufnr, 'OmniSharp_host', host)
+  call setbufvar(bufnr, 'OmniSharp_metadata_filename', a:response.SourceName)
+  let location = {
+  \ 'filename': temp_file,
+  \ 'lnum': a:metadata.Line,
+  \ 'col': a:metadata.Column
+  \}
+  call a:Callback(location, 1)
+endfunction
+
+function! s:CBGotoDefinition(opts, location, fromMetadata) abort
   if type(a:location) != type({}) " Check whether a dict was returned
-    if g:OmniSharp_lookup_metadata
-    \ && type(a:metadata) == type({})
-    \ && type(a:metadata.MetadataSource) == type({})
-      let found = OmniSharp#actions#metadata#Find(0, a:metadata, a:opts)
-      let went_to_metadata = 1
-    else
-      echo 'Not found'
-      let found = 0
-    endif
+    echo 'Not found'
+    let found = 0
   else
-    let found = OmniSharp#locations#Navigate(a:location, 0)
-  endif
-  if has_key(a:opts, 'Callback') && !went_to_metadata
-    call a:opts.Callback(found)
+    let found = OmniSharp#locations#Navigate(a:location, get(a:opts, 'editcommand', 'edit'))
+    if found && a:fromMetadata
+      setlocal nomodifiable readonly
+    endif
   endif
   return found
 endfunction
 
-function! s:CBPreviewDefinition(opts, location, metadata) abort
+function! s:CBPreviewDefinition(location, fromMetadata) abort
   if type(a:location) != type({}) " Check whether a dict was returned
-    if g:OmniSharp_lookup_metadata
-    \ && type(a:metadata) == type({})
-    \ && type(a:metadata.MetadataSource) == type({})
-      let found = OmniSharp#actions#metadata#Find(1, a:metadata, a:opts)
-    else
-      echo 'Not found'
-    endif
+    echo 'Not found'
   else
+    let jumped_from_preview = &previewwindow
     call OmniSharp#locations#Preview(a:location)
-    echo fnamemodify(a:location.filename, ':.')
+    echo OmniSharp#locations#Modify(a:location).filename
+    if a:fromMetadata && !jumped_from_preview && &previewwindow
+      silent wincmd p
+    endif
   endif
 endfunction
 

autoload/OmniSharp/actions/implementations.vim

@@ -2,17 +2,22 @@ let s:save_cpo = &cpoptions
 set cpoptions&vim
 
 " Accepts a Funcref callback argument, to be called after the response is
-" returned (synchronously or asynchronously) with the number of implementations
+" returned (synchronously or asynchronously) with the list of found locations.
+" This is done instead of navigating to them or showing a quick-fix.
 function! OmniSharp#actions#implementations#Find(...) abort
-  let opts = a:0 && a:1 isnot 0 ? { 'Callback': a:1 } : {}
-  let target = expand('<cword>')
+  if a:0 && a:1 isnot 0
+    let Callback = a:1
+  else
+    let target = expand('<cword>')
+    let Callback = function('s:CBFindImplementations', [target])
+  endif
+
   if g:OmniSharp_server_stdio
-    let Callback = function('s:CBFindImplementations', [target, opts])
     call s:StdioFind(Callback)
   else
     let locs = OmniSharp#py#Eval('findImplementations()')
     if OmniSharp#py#CheckForError() | return | endif
-    return s:CBFindImplementations(target, opts, locs)
+    return Callback(locs)
   endif
 endfunction
 
@@ -44,33 +49,31 @@ function! s:StdioFindRH(Callback, response) abort
   endif
 endfunction
 
-function! s:CBFindImplementations(target, opts, locations) abort
+function! s:CBFindImplementations(target, locations) abort
   let numImplementations = len(a:locations)
   if numImplementations == 0
     echo 'No implementations found'
   elseif numImplementations == 1
-    call OmniSharp#locations#Navigate(a:locations[0], 0)
+    call OmniSharp#locations#Navigate(a:locations[0])
   else " numImplementations > 1
-    call OmniSharp#locations#SetQuickfix(a:locations,
+    let locations = OmniSharp#locations#Modify(a:locations)
+    call OmniSharp#locations#SetQuickfix(locations,
     \ 'Implementations: ' . a:target)
   endif
-  if has_key(a:opts, 'Callback')
-    call a:opts.Callback(numImplementations)
-  endif
   return numImplementations
 endfunction
 
-function! s:CBPreviewImplementation(locs, ...) abort
-    let numImplementations = len(a:locs)
+function! s:CBPreviewImplementation(locations, ...) abort
+    let numImplementations = len(a:locations)
     if numImplementations == 0
       echo 'No implementations found'
     else
-      call OmniSharp#locations#Preview(a:locs[0])
-      let fname = fnamemodify(a:locs[0].filename, ':.')
+      call OmniSharp#locations#Preview(a:locations[0])
+      let filename = OmniSharp#locations#Modify(a:locations[0]).filename
       if numImplementations == 1
-        echo fname
+        echo filename
       else
-        echo fname . ': Implementation 1 of ' . numImplementations
+        echo filename . ': Implementation 1 of ' . numImplementations
       endif
     endif
 endfunction

autoload/OmniSharp/actions/members.vim

@@ -2,15 +2,22 @@ let s:save_cpo = &cpoptions
 set cpoptions&vim
 
 " Accepts a Funcref callback argument, to be called after the response is
-" returned (synchronously or asynchronously) with the number of members
+" returned (synchronously or asynchronously) with the list of found locations
+" of members.
+" This is done instead of showing a quick-fix.
 function! OmniSharp#actions#members#Find(...) abort
-  let opts = a:0 && a:1 isnot 0 ? { 'Callback': a:1 } : {}
+  if a:0 && a:1 isnot 0
+    let Callback = a:1
+  else
+    let Callback = function('s:CBFindMembers')
+  endif
+
   if g:OmniSharp_server_stdio
-    call s:StdioFind(function('s:CBFindMembers', [opts]))
+    call s:StdioFind(Callback)
   else
     let locs = OmniSharp#py#Eval('findMembers()')
     if OmniSharp#py#CheckForError() | return | endif
-    return s:CBFindMembers(opts, locs)
+    return Callback(locs)
   endif
 endfunction
 
@@ -83,14 +90,11 @@ function! ReduceToOneCharacter(textBeforeDisplayName) abort
   return s:SingleCharacterSymbolByAccessModifier[accessModifier] . a:textBeforeDisplayName[accessModifierLen:]
 endfunction
 
-function! s:CBFindMembers(opts, locations) abort
+function! s:CBFindMembers(locations) abort
   let numMembers = len(a:locations)
   if numMembers > 0
     call OmniSharp#locations#SetQuickfixWithVerticalAlign(a:locations, 'Members')
   endif
-  if has_key(a:opts, 'Callback')
-    call a:opts.Callback(numMembers)
-  endif
   return numMembers
 endfunction
 

autoload/OmniSharp/actions/metadata.vim

@@ -1,30 +1,35 @@
 let s:save_cpo = &cpoptions
 set cpoptions&vim
 
-function! OmniSharp#actions#navigate#Down() abort
-  call s:Navigate(1)
+" Navigate to the next member definition in the class.
+" Optional arguments:
+" Callback: When a callback is passed in, it is called after the response is
+"           returned with the member location. No navigation is performed when a
+"           callback is passed in.
+function! OmniSharp#actions#navigate#Down(...) abort
+  call s:Navigate(1, a:0 ? a:1 : function('OmniSharp#locations#Navigate'))
 endfunction
 
-function! OmniSharp#actions#navigate#Up() abort
-  call s:Navigate(0)
+" See OmniSharp#actions#navigate#Down
+function! OmniSharp#actions#navigate#Up(...) abort
+  call s:Navigate(0, a:0 ? a:1 : function('OmniSharp#locations#Navigate'))
 endfunction
 
-function! s:Navigate(down) abort
+function! s:Navigate(down, Callback) abort
   if g:OmniSharp_server_stdio
-    let opts = {
-    \ 'ResponseHandler': function('s:NavigateRH')
-    \}
+    let RH = function('s:StdioNavigateRH', [a:Callback])
+    let opts = { 'ResponseHandler': RH }
     call OmniSharp#stdio#Request(a:down ? '/navigatedown' : '/navigateup', opts)
   else
-    call OmniSharp#py#Eval(a:down ? 'navigateDown()' : 'navigateUp()')
-    call OmniSharp#py#CheckForError()
+    let loc = OmniSharp#py#Eval(a:down ? 'navigateDown()' : 'navigateUp()')
+    if OmniSharp#py#CheckForError() | return | endif
+    call a:Callback(loc)
   endif
 endfunction
 
-function! s:NavigateRH(response) abort
+function! s:StdioNavigateRH(Callback, response) abort
   if !a:response.Success | return | endif
-  normal! m'
-  call cursor(a:response.Body.Line, a:response.Body.Column)
+  call a:Callback(OmniSharp#locations#Parse([a:response.Body])[0])
 endfunction
 
 let &cpoptions = s:save_cpo