Merge pull request #738 from nickspoons/update-on-change

Update buffer on change

Author: nickspoons

autoload/OmniSharp/actions/buffer.vim

@@ -1,32 +1,34 @@
 let s:save_cpo = &cpoptions
 set cpoptions&vim
 
-" Optional arguments:
-" - callback: funcref to be called after the response is returned (synchronously
+" Synchronize the buffer contents with the server. By default, contents are only
+" sent when there have been changes since the last run.
+" Optional argument: A dict containing the following optional items:
+"  Callback: funcref to be called after the response is returned (synchronously
 "   or asynchronously)
-" - initializing: flag indicating that this is the first request for this buffer
-" - sendBuffer: flag indicating that the buffer contents should be sent,
+"  Initializing: flag indicating that this is the first request for this buffer
+"  SendBuffer: flag indicating that the buffer contents should be sent,
 "   regardless of &modified status or b:changedtick
 function! OmniSharp#actions#buffer#Update(...) abort
-  let cb = a:0 && type(a:1) == type(function('tr')) ? { 'Callback': a:1 } : {}
-  let initializing = a:0 > 1 && a:2 is 1
-  let sendBuffer = initializing || (a:0 > 2 ? a:3 : 0)
+  let opts = a:0 ? a:1 : {}
+  let opts.Initializing = get(opts, 'Initializing', 0)
+  let opts.SendBuffer = opts.Initializing || get(opts, 'SendBuffer', 0)
   if bufname('%') ==# '' || OmniSharp#FugitiveCheck() | return | endif
   let lasttick = get(b:, 'OmniSharp_UpdateChangeTick', -1)
-  if initializing || sendBuffer || b:changedtick != lasttick
+  if opts.SendBuffer || b:changedtick != lasttick
     let b:OmniSharp_UpdateChangeTick = b:changedtick
     if g:OmniSharp_server_stdio
-      let opts = {
-      \ 'ResponseHandler': function('s:StdioUpdateRH', [cb]),
-      \ 'Initializing': initializing
+      let requestOpts = {
+      \ 'ResponseHandler': function('s:StdioUpdateRH', [opts]),
+      \ 'Initializing': opts.Initializing
       \}
-      call OmniSharp#stdio#Request('/updatebuffer', opts)
+      call OmniSharp#stdio#Request('/updatebuffer', requestOpts)
     else
       if !OmniSharp#IsServerRunning() | return | endif
       call OmniSharp#py#Eval('updateBuffer()')
       call OmniSharp#py#CheckForError()
-      if has_key(cb, 'Callback')
-        call cb.Callback()
+      if has_key(opts, 'Callback')
+        call opts.Callback()
       endif
     endif
   endif

autoload/OmniSharp/actions/diagnostics.vim

@@ -51,9 +51,13 @@ endfunction
 " directly from autoload/ale/sources/OmniSharp.vim so requires a full autoload
 " function name.
 function! OmniSharp#actions#diagnostics#StdioCheck(bufnr, Callback) abort
+  " OmniSharp#actions#buffer#Update only updates the server state when the
+  " buffer has been modified since the last server update
+  call OmniSharp#actions#buffer#Update()
   let opts = {
   \ 'ResponseHandler': function('s:StdioCheckRH', [a:Callback]),
   \ 'BufNum': a:bufnr,
+  \ 'SendBuffer': 0,
   \ 'ReplayOnLoad': 1
   \}
   call OmniSharp#stdio#Request('/codecheck', opts)

autoload/OmniSharp/actions/signature.vim

@@ -97,7 +97,7 @@ function! s:StdioSignatureHelpRH(Callback, seq, opts, response) abort
   if has_key(a:opts, 'ForCompleteMethod') && !g:OmniSharp_want_snippet
     " Because of our 'falsified' request with an extra '(', re-synchronise the
     " server's version of the buffer with the actual buffer contents.
-    call OmniSharp#actions#buffer#Update(0, 0, 1)
+    call OmniSharp#actions#buffer#Update({'SendBuffer': 1})
   endif
   call a:Callback(a:response.Body)
 endfunction

autoload/OmniSharp/buffer.vim

@@ -10,8 +10,10 @@ function! OmniSharp#buffer#Initialize(job, bufnr, command, opts) abort
   let a:job.pending_requests[a:bufnr][a:command] = a:opts
   if has_key(OmniSharp#GetHost(a:bufnr), 'initializing') | return | endif
   let host.initializing = 1
-  let Callback = function('s:CBInitialize', [a:job, a:bufnr, host])
-  call OmniSharp#actions#buffer#Update(Callback, 1)
+  call OmniSharp#actions#buffer#Update({
+  \ 'Callback': function('s:CBInitialize', [a:job, a:bufnr, host]),
+  \ 'Initializing': 1
+  \})
 endfunction
 
 function! s:CBInitialize(job, bufnr, host) abort

autoload/OmniSharp/stdio.vim

@@ -174,18 +174,6 @@ function! OmniSharp#stdio#Request(command, opts) abort
     \ fnamemodify(bufname(bufnr), ':p'))
     let send_buffer = get(a:opts, 'SendBuffer', 1)
   endif
-  let lines = getbufline(bufnr, 1, '$')
-  if has_key(a:opts, 'OverrideBuffer')
-    let lines[a:opts.OverrideBuffer.LineNr - 1] = a:opts.OverrideBuffer.Line
-    let cnum = a:opts.OverrideBuffer.Col
-  endif
-  let tmp = join(lines, '')
-  " Unique string separator which must not exist in the buffer
-  let sep = '@' . matchstr(reltimestr(reltime()), '\v\.@<=\d+') . '@'
-  while stridx(tmp, sep) >= 0
-    let sep = '@' . matchstr(reltimestr(reltime()), '\v\.@<=\d+') . '@'
-  endwhile
-  let buffer = join(lines, sep)
 
   let body = {
   \ 'Arguments': {
@@ -195,10 +183,23 @@ function! OmniSharp#stdio#Request(command, opts) abort
   \ }
   \}
   if send_buffer
-    let body.Arguments.Buffer = buffer
+    let lines = getbufline(bufnr, 1, '$')
+    if has_key(a:opts, 'OverrideBuffer')
+      let lines[a:opts.OverrideBuffer.LineNr - 1] = a:opts.OverrideBuffer.Line
+      let cnum = a:opts.OverrideBuffer.Col
+    endif
+    let tmp = join(lines, '')
+    " Unique string separator which must not exist in the buffer
+    let sep = '@' . matchstr(reltimestr(reltime()), '\v\.@<=\d+') . '@'
+    while stridx(tmp, sep) >= 0
+      let sep = '@' . matchstr(reltimestr(reltime()), '\v\.@<=\d+') . '@'
+    endwhile
+    let body.Arguments.Buffer = join(lines, sep)
+  else
+    let sep = ''
   endif
 
-  call s:Request(job, body, a:command, a:opts, sep)
+  call s:Request(job, body, a:command, a:opts, sep, bufnr)
 
   if has_key(a:opts, 'ReplayOnLoad')
     let replay_opts = filter(copy(a:opts), 'v:key !=# "ReplayOnLoad"')
@@ -209,10 +210,10 @@ function! OmniSharp#stdio#Request(command, opts) abort
 endfunction
 
 function! OmniSharp#stdio#RequestGlobal(job, command, opts) abort
-  call s:Request(a:job, {}, a:command, a:opts)
+  call s:Request(a:job, {}, a:command, a:opts, '', -1)
 endfunction
 
-function! s:Request(job, body, command, opts, ...) abort
+function! s:Request(job, body, command, opts, sep, bufnr) abort
   call OmniSharp#log#Log(a:job, 'Request: ' . a:command, 1)
 
   let a:body['Command'] = a:command
@@ -221,14 +222,14 @@ function! s:Request(job, body, command, opts, ...) abort
   if has_key(a:opts, 'Parameters')
     call extend(a:body.Arguments, a:opts.Parameters, 'force')
   endif
-  let sep = a:0 ? a:1 : ''
-  if sep !=# ''
-    let encodedBody = substitute(json_encode(a:body), sep, '\\r\\n', 'g')
+  if a:sep !=# ''
+    let encodedBody = substitute(json_encode(a:body), a:sep, '\\r\\n', 'g')
   else
     let encodedBody = json_encode(a:body)
   endif
 
   let s:requests[s:nextseq] = {
+  \ 'BufNum': a:bufnr,
   \ 'Command': a:command,
   \ 'Seq': s:nextseq,
   \ 'StartTime': reltime()

autoload/OmniSharp/util.vim

@@ -123,8 +123,6 @@ function! OmniSharp#util#CheckCapabilities() abort
   endif
 
   if !s:capable
-    " Clear BufEnter and InsertLeave autocmds
-    silent! autocmd! OmniSharp_HighlightTypes
     " Clear plugin integration autocmds
     silent! autocmd! OmniSharp_Integrations
   endif

autoload/ale/sources/OmniSharp.vim

@@ -1,10 +1,13 @@
-function! ale#sources#OmniSharp#WantResults(buffer) abort
-  let g:OmniSharp_diagnostics_requested = 1
+function! ale#sources#OmniSharp#WantResults() abort
+  if !g:OmniSharp_server_stdio | return | endif
+  let bufnr = g:ale_want_results_buffer
+  if getbufvar(bufnr, '&filetype') !=# 'cs' | return | endif
   if OmniSharp#FugitiveCheck() | return | endif
-  call ale#other_source#StartChecking(a:buffer, 'OmniSharp')
-  let opts = { 'BufNum': a:buffer }
+  let g:OmniSharp_diagnostics_requested = 1
+  call ale#other_source#StartChecking(bufnr, 'OmniSharp')
+  let opts = { 'BufNum': bufnr }
   let Callback = function('ale#sources#OmniSharp#ProcessResults', [opts])
-  call OmniSharp#actions#diagnostics#StdioCheck(a:buffer, Callback)
+  call OmniSharp#actions#diagnostics#StdioCheck(bufnr, Callback)
 endfunction
 
 function! ale#sources#OmniSharp#ProcessResults(opts, locations) abort

ftplugin/cs/OmniSharp.vim

@@ -3,23 +3,54 @@ if !OmniSharp#util#CheckCapabilities() | finish | endif
 if get(b:, 'OmniSharp_ftplugin_loaded', 0) | finish | endif
 let b:OmniSharp_ftplugin_loaded = 1
 
+if get(g:, 'OmniSharp_start_server', 0)
+  call OmniSharp#StartServerIfNotRunning()
+endif
+
+call OmniSharp#actions#buffer#Update()
+if g:OmniSharp_highlighting
+  call OmniSharp#actions#highlight#Buffer()
+endif
+
 augroup OmniSharp_FileType
   autocmd! * <buffer>
 
+  autocmd BufEnter <buffer>
+  \ if !pumvisible() |
+  \   call OmniSharp#actions#buffer#Update({'SendBuffer': 1}) |
+  \ endif
   autocmd BufLeave <buffer>
   \ if !pumvisible() |
   \   call OmniSharp#actions#buffer#Update() |
   \ endif
 
   autocmd CompleteDone <buffer> call OmniSharp#actions#complete#ExpandSnippet()
+
+  autocmd TextChanged <buffer> call OmniSharp#actions#buffer#Update()
+
+  autocmd BufEnter <buffer>
+  \ if g:OmniSharp_highlighting |
+  \   call OmniSharp#actions#highlight#Buffer() |
+  \ endif
+  autocmd InsertLeave,TextChanged <buffer>
+  \ if g:OmniSharp_highlighting >= 2 |
+  \   call OmniSharp#actions#highlight#Buffer() |
+  \ endif
+  autocmd TextChangedI <buffer>
+  \ if g:OmniSharp_highlighting >= 3 |
+  \   call OmniSharp#actions#highlight#Buffer() |
+  \ endif
+  if exists('##TextChangedP')
+    autocmd TextChangedP <buffer>
+    \ if g:OmniSharp_highlighting >= 3 |
+    \   call OmniSharp#actions#highlight#Buffer() |
+    \ endif
+  endif
+
 augroup END
 
 setlocal omnifunc=OmniSharp#Complete
 
-if get(g:, 'OmniSharp_start_server', 0)
-  call OmniSharp#StartServerIfNotRunning()
-endif
-
 command! -buffer -bar OmniSharpRestartAllServers call OmniSharp#RestartAllServers()
 command! -buffer -bar OmniSharpRestartServer call OmniSharp#RestartServer()
 command! -buffer -bar -nargs=? -complete=file OmniSharpStartServer call OmniSharp#StartServer(<q-args>)

plugin/OmniSharp.vim

@@ -50,46 +50,8 @@ command! -bar -nargs=? OmniSharpInstall call OmniSharp#Install(<f-args>)
 command! -bar -nargs=? OmniSharpOpenLog call OmniSharp#log#Open(<q-args>)
 command! -bar -bang OmniSharpStatus call OmniSharp#Status(<bang>0)
 
-" Initialise automatic type and interface highlighting
 " Preserve backwards compatibility with older version g:OmniSharp_highlight_types
 let g:OmniSharp_highlighting = get(g:, 'OmniSharp_highlighting', get(g:, 'OmniSharp_highlight_types', 2))
-if g:OmniSharp_highlighting
-  augroup OmniSharp_HighlightTypes
-    autocmd!
-    autocmd BufEnter *.cs,*.csx
-    \ if !pumvisible() && OmniSharp#util#CheckCapabilities() |
-    \   call OmniSharp#actions#highlight#Buffer() |
-    \ endif
-
-    if g:OmniSharp_highlighting >= 2
-      autocmd InsertLeave,TextChanged *.cs,*.csx
-      \ if OmniSharp#util#CheckCapabilities() |
-      \   call OmniSharp#actions#highlight#Buffer() |
-      \ endif
-    endif
-
-    if g:OmniSharp_highlighting >= 3
-      autocmd TextChangedI *.cs,*.csx
-      \ if OmniSharp#util#CheckCapabilities() |
-      \   call OmniSharp#actions#highlight#Buffer() |
-      \ endif
-
-      if exists('##TextChangedP')
-        autocmd TextChangedP *.cs,*.csx
-        \ if OmniSharp#util#CheckCapabilities() |
-        \   call OmniSharp#actions#highlight#Buffer() |
-        \ endif
-      endif
-    endif
-  augroup END
-endif
-
-function! s:ALEWantResults() abort
-  if !g:OmniSharp_server_stdio | return | endif
-  if getbufvar(g:ale_want_results_buffer, '&filetype') ==# 'cs'
-    call ale#sources#OmniSharp#WantResults(g:ale_want_results_buffer)
-  endif
-endfunction
 
 augroup OmniSharp_Integrations
   autocmd!
@@ -113,7 +75,7 @@ augroup OmniSharp_Integrations
   \})
 
   " Listen for ALE requests
-  autocmd User ALEWantResults call s:ALEWantResults()
+  autocmd User ALEWantResults call ale#sources#OmniSharp#WantResults()
 augroup END
 
 if !exists('g:OmniSharp_selector_ui')

test/utils/async-helper.vader

@@ -31,7 +31,8 @@ Execute (set up async helper):
     if has_key(b:, 'OmniSharp_UpdateChangeTick')
       unlet b:OmniSharp_UpdateChangeTick
     endif
-    call OmniSharpTestAwait('OmniSharp#actions#buffer#Update', [])
+    call OmniSharpTestAwait('OmniSharp#actions#buffer#Update',
+    \ [{'Callback': function('s:CallbackStopWaiting')}])
   endfunction
 
   function! OmniSharpTestCleanupBuffer() abort