Merge pull request mhinz#326 from mhinz/toggle

Improve handling of disabled buffers

Author: mhinz

autoload/sy.vim

@@ -23,7 +23,6 @@ function! sy#start(...) abort
     let new_sy = {
           \ 'path':       path,
           \ 'buffer':     bufnr,
-          \ 'active':     0,
           \ 'detecting':  0,
           \ 'vcs':        [],
           \ 'hunks':      [],
@@ -36,19 +35,11 @@ function! sy#start(...) abort
           \    'file': sy#util#escape(fnamemodify(path, ':t'))
           \ }}
     call setbufvar(bufnr, 'sy', new_sy)
-    if get(g:, 'signify_disable_by_default')
-      call sy#verbose('Disabled by default.')
-      return
-    endif
-    let new_sy.active = 1
-    call setbufvar(bufnr, 'sy', new_sy)
+    call sy#set_buflocal_autocmds(bufnr)
     call sy#repo#detect(bufnr)
   elseif has('vim_starting')
     call sy#verbose("Don't run Sy more than once during startup.")
     return
-  elseif !sy.active
-    call sy#verbose('Inactive buffer.')
-    return
   elseif empty(sy.vcs)
     if get(sy, 'retry')
       let sy.retry = 0
@@ -59,7 +50,7 @@ function! sy#start(...) abort
         call sy#verbose('Detection is already in progress.')
       else
         call sy#verbose('No VCS found. Disabling.')
-        call sy#disable(sy.buffer)
+        call sy#stop(sy.buffer)
       endif
     endif
   else
@@ -76,50 +67,40 @@ function! sy#start(...) abort
 endfunction
 
 " #stop {{{1
-function! sy#stop(bufnr) abort
-  if empty(getbufvar(a:bufnr, 'sy'))
-    return
-  endif
-  call sy#sign#remove_all_signs(a:bufnr)
+function! sy#stop(...) abort
+  let bufnr = bufnr('')
+  if empty(getbufvar(a:0 ? a:1 : bufnr, 'sy')) | return | endif
+  call sy#sign#remove_all_signs(bufnr)
+  execute printf('autocmd! signify * <buffer=%d>', bufnr)
+  call setbufvar(bufnr, 'sy', {})
 endfunction
 
-" #enable {{{1
-function! sy#enable() abort
-  if !exists('b:sy')
-    call sy#start()
-    return
-  endif
-
-  if !b:sy.active
-    let b:sy.active = 1
-    let b:sy.retry  = 1
-    call sy#start()
-  endif
+" #toggle {{{1
+function! sy#toggle() abort
+  call call(empty(getbufvar(bufnr(''), 'sy')) ? 'sy#start' : 'sy#stop', [])
 endfunction
 
-" #disable {{{1
-function! sy#disable(...) abort
-  let sy = getbufvar(a:0 ? a:1 : bufnr(''), 'sy')
-
-  if !empty(sy) && sy.active
-    call sy#stop(sy.buffer)
-    let b:sy.active = 0
-    let b:sy.stats = [-1, -1, -1]
-  endif
+" #start_all {{{1
+function! sy#start_all() abort
+  for bufnr in range(1, bufnr(''))
+    call sy#start({'bufnr': bufnr})
+  endfor
+  let g:signify_disable_by_default = 0
 endfunction
 
-" #toggle {{{1
-function! sy#toggle() abort
-  if !exists('b:sy') || !b:sy.active
-    call sy#enable()
-  else
-    call sy#disable()
-  endif
+" #stop_all {{{1
+function! sy#stop_all() abort
+  for bufnr in range(1, bufnr(''))
+    if !empty(getbufvar(bufnr, 'sy'))
+      call sy#stop(bufnr)
+    endif
+  endfor
+  let g:signify_disable_by_default = 1
 endfunction
 
 " #buffer_is_active {{{1
 function! sy#buffer_is_active()
-  return exists('b:sy') && b:sy.active
+  return !empty(getbufvar(bufnr(''), 'sy'))
 endfunction
 
 " #verbose {{{1
@@ -135,6 +116,35 @@ function! sy#verbose(msg, ...) abort
   endif
 endfunction
 
+" #set_buflocal_autocmds {{{1
+function! sy#set_buflocal_autocmds(bufnr) abort
+  augroup signify
+    execute printf('autocmd! * <buffer=%d>', a:bufnr)
+
+    execute printf('autocmd BufEnter     <buffer=%d> call sy#start()', a:bufnr)
+    execute printf('autocmd WinEnter     <buffer=%d> call sy#start()', a:bufnr)
+    execute printf('autocmd BufWritePost <buffer=%d> call sy#start()', a:bufnr)
+
+    execute printf('autocmd CursorHold   <buffer=%d> call sy#start()', a:bufnr)
+    execute printf('autocmd CursorHoldI  <buffer=%d> call sy#start()', a:bufnr)
+
+    execute printf('autocmd FocusGained  <buffer=%d> SignifyRefresh', a:bufnr)
+
+    execute printf('autocmd CmdwinEnter <buffer=%d> let g:signify_cmdwin_active = 1', a:bufnr)
+    execute printf('autocmd CmdwinLeave <buffer=%d> let g:signify_cmdwin_active = 0', a:bufnr)
+
+    execute printf('autocmd ShellCmdPost <buffer=%d> call sy#start()', a:bufnr)
+
+    if exists('##VimResume')
+      execute printf('autocmd VimResume <buffer=%d> call sy#start()', a:bufnr)
+    endif
+  augroup END
+
+  if exists('#User#SignifyAutocmds')
+    doautocmd <nomodeline> User SignifyAutocmds
+  endif
+endfunction
+
 " s:get_path {{{1
 function! s:get_path(bufnr)
   let path = resolve(fnamemodify(bufname(a:bufnr), ':p'))

autoload/sy/debug.vim

@@ -14,7 +14,7 @@ function! sy#debug#list_active_buffers() abort
 
     echo "\n". path ."\n". repeat('=', strlen(path))
 
-    for k in ['active', 'buffer', 'vcs', 'stats', 'signid']
+    for k in ['buffer', 'vcs', 'stats', 'signid']
       if k == 'stats'
         echo printf("%10s  =  %d added, %d changed, %d removed\n",
               \ k,

autoload/sy/repo.vim

@@ -129,7 +129,7 @@ function! s:handle_diff(options, exitval) abort
   elseif !empty(sy.updated_by) && sy.updated_by != a:options.vcs
     call sy#verbose(printf('Signs already got updated by %s.', sy.updated_by), a:options.vcs)
     return
-  elseif empty(sy.vcs) && sy.active
+  elseif empty(sy.vcs)
     let sy.detecting -= 1
   endif
 
@@ -257,7 +257,7 @@ endfunction
 
 " #debug_detection {{{1
 function! sy#repo#debug_detection()
-  if !exists('b:sy')
+  if empty(getbufvar(bufnr(''), 'sy'))
     echomsg 'signify: I cannot detect any changes!'
     return
   endif
@@ -365,8 +365,10 @@ endfunction
 
 " #diff_hunk {{{1
 function! sy#repo#diff_hunk() abort
-  if exists('b:sy') && !empty(b:sy.updated_by)
-    call sy#repo#get_diff(bufnr(''), b:sy.updated_by, function('s:diff_hunk'))
+  let bufnr = bufnr('')
+  let sy = getbufvar(bufnr, 'sy')
+  if !empty(sy) && !empty(sy.updated_by)
+    call sy#repo#get_diff(bufnr, sy.updated_by, function('s:diff_hunk'))
   endif
 endfunction
 
@@ -396,8 +398,10 @@ endfunction
 
 " #undo_hunk {{{1
 function! sy#repo#undo_hunk() abort
-  if exists('b:sy') && !empty(b:sy.updated_by)
-    call sy#repo#get_diff(bufnr(''), b:sy.updated_by, function('s:undo_hunk'))
+  let bufnr = bufnr('')
+  let sy = getbufvar(bufnr, 'sy')
+  if !empty(sy) && !empty(sy.updated_by)
+    call sy#repo#get_diff(bufnr, sy.updated_by, function('s:undo_hunk'))
   endif
 endfunction
 

autoload/sy/util.vim

@@ -93,7 +93,8 @@ endfunction
 
 " #return_if_no_changes {{{1
 function! sy#util#return_if_no_changes() abort
-  if !exists('b:sy') || empty(b:sy.hunks)
+  let sy = getbufvar(bufnr(''), 'sy')
+  if empty(sy) || empty(sy.hunks)
     echomsg 'signify: There are no changes.'
     return 'return'
   endif

doc/signify.txt

@@ -231,8 +231,11 @@ Works the same as |g:signify_vcs_cmds|.
                                                   *g:signify_disable_by_default*  >
     let g:signify_disable_by_default = 0
 <
-This makes Sy not looking for changes for each new buffer. You can easily
-enable it later using |signify-:SignifyToggle|.
+Disable Sy by default. You can still enable it later via:
+
+    |signify-:SignifyToggle|
+    |signify-:SignifyEnable|
+    |signify-:SignifyEnableAll|
 
 ------------------------------------------------------------------------------
                                                *g:signify_skip_filename_pattern*
@@ -340,12 +343,24 @@ Enable the plugin for the current buffer only.
 Can also be used to when a repository was initialized while Sy was already
 loaded.
 
+------------------------------------------------------------------------------
+                                                     *signify-:SignifyEnableAll*  >
+    :SignifyEnableAll
+<
+Enable the plugin for all buffers. Sets |g:signify_disable_by_default| to 0.
+
 ------------------------------------------------------------------------------
                                                        *signify-:SignifyDisable*  >
     :SignifyDisable
 <
 Disable the plugin for the current buffer only.
 
+------------------------------------------------------------------------------
+                                                    *signify-:SignifyDisableAll*  >
+    :SignifyDisableAll
+<
+Disable the plugin for all buffers. Sets |g:signify_disable_by_default| to 1.
+
 ------------------------------------------------------------------------------
                                                         *signify-:SignifyToggle*  >
     :SignifyToggle
@@ -451,12 +466,12 @@ See all of them with:
 <
 You can disable sign updating for certain events:
 >
-    autocmd User SignifySetup autocmd! signify CursorHold,CursorHoldI
+    autocmd User SignifyAutocmds autocmd! signify CursorHold,CursorHoldI
 <
 If you don't need immediate feedback or responses from your VCS are slow, then
 use this to only update signs when writing the buffer:
 >
-    autocmd User SignifySetup
+    autocmd User SignifyAutocmds
           \ exe 'au! signify' | au signify BufWritePost * call sy#start()
 <
 ==============================================================================
@@ -467,7 +482,13 @@ Signify fires these user events:
 User SignifySetup~
 
     This event fires at the end of `plugin/signify.vim`, in case you want to
-    change any of the default autocmds, commands, or mappings.
+    change any of the default commands, or mappings.
+
+User SignifyAutocmds~
+
+    This event fires every time Sy sets autocmds. E.g. when opening a
+    version-controlled file or when using |signify-:SignifyToggle| a lot.
+    Useful to change the default |signify-autocmds|.
 
 User Signify~
 
@@ -657,6 +678,9 @@ EXAMPLE                                                        *signify-example*
 
 An example configuration for Sy:
 >
+    " Faster sign updates on CursorHold/CursorHoldI
+    set updatetime=100
+
     nnoremap <leader>gd :SignifyDiff<cr>
     nnoremap <leader>gp :SignifyHunkDiff<cr>
     nnoremap <leader>gu :SignifyHunkUndo<cr>

plugin/signify.vim

@@ -6,41 +6,9 @@ if exists('g:loaded_signify') || !has('signs') || &compatible
   finish
 endif
 
-" Variables {{{1
 let g:loaded_signify = 1
 let g:signify_locked = 0
 
-" Autocmds {{{1
-augroup signify
-  autocmd!
-
-  autocmd BufEnter     * call sy#start()
-  autocmd WinEnter     * call sy#start()
-  autocmd BufWritePost * call sy#start()
-
-  autocmd CursorHold   * call sy#start()
-  autocmd CursorHoldI  * call sy#start()
-
-  autocmd FocusGained  * SignifyRefresh
-
-  autocmd QuickFixCmdPre  *vimgrep* let g:signify_locked = 1
-  autocmd QuickFixCmdPost *vimgrep* let g:signify_locked = 0
-
-  autocmd CmdwinEnter * let g:signify_cmdwin_active = 1
-  autocmd CmdwinLeave * let g:signify_cmdwin_active = 0
-
-  autocmd ShellCmdPost * call sy#start()
-
-  if exists('##VimResume')
-    autocmd VimResume * call sy#start()
-  endif
-
-  if has('gui_running') && has('win32') && argc()
-    " Fix 'no signs at start' race.
-    autocmd GUIEnter * redraw
-  endif
-augroup END
-
 " Commands {{{1
 command! -nargs=0 -bar       SignifyList            call sy#debug#list_active_buffers()
 command! -nargs=0 -bar       SignifyDebug           call sy#repo#debug_detection()
@@ -49,10 +17,13 @@ command! -nargs=0 -bar -bang SignifyDiff            call sy#repo#diffmode(<bang>
 command! -nargs=0 -bar       SignifyHunkDiff        call sy#repo#diff_hunk()
 command! -nargs=0 -bar       SignifyHunkUndo        call sy#repo#undo_hunk()
 command! -nargs=0 -bar       SignifyRefresh         call sy#util#refresh_windows()
-command! -nargs=0 -bar       SignifyEnable          call sy#enable()
-command! -nargs=0 -bar       SignifyDisable         call sy#disable()
+
+command! -nargs=0 -bar       SignifyEnable          call sy#start()
+command! -nargs=0 -bar       SignifyDisable         call sy#stop()
 command! -nargs=0 -bar       SignifyToggle          call sy#toggle()
 command! -nargs=0 -bar       SignifyToggleHighlight call sy#highlight#line_toggle()
+command! -nargs=0 -bar       SignifyEnableAll       call sy#start_all()
+command! -nargs=0 -bar       SignifyDisableAll      call sy#stop_all()
 
 " Mappings {{{1
 let s:cpoptions = &cpoptions
@@ -87,6 +58,20 @@ xnoremap <silent> <plug>(signify-motion-outer-visual)  :<c-u>call sy#util#hunk_t
 
 let &cpoptions = s:cpoptions
 unlet s:cpoptions
+
+" Autocmds {{{1
+if has('gui_running') && has('win32') && argc()
+  " Fix 'no signs at start' race.
+  autocmd GUIEnter * redraw
+endif
+
+autocmd QuickFixCmdPre  *vimgrep* let g:signify_locked = 1
+autocmd QuickFixCmdPost *vimgrep* let g:signify_locked = 0
+
+autocmd BufNewFile,BufRead * nested
+      \ if !get(g:, 'signify_disable_by_default') |
+      \   call sy#start({'bufnr': bufnr('')}) |
+      \ endif
 " 1}}}
 
 if exists('#User#SignifySetup')