feat(events): add DirChangedPre

In Nvim, like DirChanged, this also triggers when switching windows.

This marks Vim patch 8.2.4335 as ported.

vim-patch:8.2.4335: no autocommand event triggered before changing directory

Problem:    No autocommand event triggered before changing directory. (Ronnie
            Magatti)
Solution:   Add DirChangedPre. (closes vim/vim#9721)
https://github.com/vim/vim/commit/28e8f73ae2d90009fd62cd60f97c2643ba44de68

1 files changed, 111 insertions, 17 deletions

diff --git a/test/functional/autocmd/dirchanged_spec.lua b/test/functional/autocmd/dirchanged_spec.lua
index f4a1642ebf..45dc06b39b 100644
--- a/test/functional/autocmd/dirchanged_spec.lua
+++ b/test/functional/autocmd/dirchanged_spec.lua
@@ -8,7 +8,7 @@ local eval = h.eval
 local request = h.request
 local iswin = h.iswin
 
-describe('autocmd DirChanged', function()
+describe('autocmd DirChanged and DirChangedPre', function()
   local curdir = string.gsub(lfs.currentdir(), '\\', '/')
   local dirs = {
     curdir .. '/Xtest-functional-autocmd-dirchanged.dir1',
@@ -26,31 +26,43 @@ describe('autocmd DirChanged', function()
 
   before_each(function()
     clear()
+    command('autocmd DirChangedPre * let [g:evpre, g:amatchpre, g:cdprecount] '
+            ..'= [copy(v:event), expand("<amatch>"), 1 + get(g:, "cdprecount", 0)]')
     command('autocmd DirChanged * let [g:getcwd, g:ev, g:amatch, g:cdcount] '
-        ..'  = [getcwd(), copy(v:event), expand("<amatch>"), 1 + get(g:, "cdcount", 0)]')
+            ..'= [getcwd(), copy(v:event), expand("<amatch>"), 1 + get(g:, "cdcount", 0)]')
     -- Normalize path separators.
+    command([[autocmd DirChangedPre * let g:evpre['directory'] = substitute(g:evpre['directory'], '\\', '/', 'g')]])
     command([[autocmd DirChanged * let g:ev['cwd'] = substitute(g:ev['cwd'], '\\', '/', 'g')]])
-    command([[autocmd DirChanged * let g:getcwd    = substitute(g:getcwd,    '\\', '/', 'g')]])
+    command([[autocmd DirChanged * let g:getcwd = substitute(g:getcwd, '\\', '/', 'g')]])
   end)
 
-  it('sets v:event and <amatch>', function()
+  it('set v:event and <amatch>', function()
     command('lcd '..dirs[1])
+    eq({directory=dirs[1], scope='window', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[1], scope='window', changed_window=false}, eval('g:ev'))
+    eq('window', eval('g:amatchpre'))
     eq('window', eval('g:amatch'))
+    eq(1, eval('g:cdprecount'))
     eq(1, eval('g:cdcount'))
 
     command('tcd '..dirs[2])
+    eq({directory=dirs[2], scope='tabpage', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[2], scope='tabpage', changed_window=false}, eval('g:ev'))
+    eq('tabpage', eval('g:amatchpre'))
     eq('tabpage', eval('g:amatch'))
+    eq(2, eval('g:cdprecount'))
     eq(2, eval('g:cdcount'))
 
     command('cd '..dirs[3])
+    eq({directory=dirs[3], scope='global', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[3], scope='global', changed_window=false}, eval('g:ev'))
+    eq('global', eval('g:amatchpre'))
     eq('global', eval('g:amatch'))
+    eq(3, eval('g:cdprecount'))
     eq(3, eval('g:cdcount'))
   end)
 
-  it('sets getcwd() during event #6260', function()
+  it('DirChanged set getcwd() during event #6260', function()
     command('lcd '..dirs[1])
     eq(dirs[1], eval('g:getcwd'))
 
@@ -61,7 +73,7 @@ describe('autocmd DirChanged', function()
     eq(dirs[3], eval('g:getcwd'))
   end)
 
-  it('disallows recursion', function()
+  it('disallow recursion', function()
     command('set shellslash')
     -- Set up a _nested_ handler.
     command('autocmd DirChanged * nested lcd '..dirs[3])
@@ -72,23 +84,36 @@ describe('autocmd DirChanged', function()
     eq(dirs[3], eval('getcwd()'))
   end)
 
-  it('does not trigger if :cd fails', function()
+  it('only DirChangedPre is triggered if :cd fails', function()
     command('let g:ev = {}')
+    command('let g:cdcount = 0')
 
     local status1, err1 = pcall(function()
-      command('lcd '..dirs[1] .. '/doesnotexist')
+      command('lcd '..dirs[1]..'/doesnotexist')
     end)
+    eq({directory=dirs[1]..'/doesnotexist', scope='window', changed_window=false}, eval('g:evpre'))
     eq({}, eval('g:ev'))
+    eq('window', eval('g:amatchpre'))
+    eq(1, eval('g:cdprecount'))
+    eq(0, eval('g:cdcount'))
 
     local status2, err2 = pcall(function()
-      command('lcd '..dirs[2] .. '/doesnotexist')
+      command('lcd '..dirs[2]..'/doesnotexist')
     end)
+    eq({directory=dirs[2]..'/doesnotexist', scope='window', changed_window=false}, eval('g:evpre'))
     eq({}, eval('g:ev'))
+    eq('window', eval('g:amatchpre'))
+    eq(2, eval('g:cdprecount'))
+    eq(0, eval('g:cdcount'))
 
     local status3, err3 = pcall(function()
-      command('lcd '..dirs[3] .. '/doesnotexist')
+      command('lcd '..dirs[3]..'/doesnotexist')
     end)
+    eq({directory=dirs[3]..'/doesnotexist', scope='window', changed_window=false}, eval('g:evpre'))
     eq({}, eval('g:ev'))
+    eq('window', eval('g:amatchpre'))
+    eq(3, eval('g:cdprecount'))
+    eq(0, eval('g:cdcount'))
 
     eq(false, status1)
     eq(false, status2)
@@ -99,85 +124,121 @@ describe('autocmd DirChanged', function()
     eq('E344:', string.match(err3, "E%d*:"))
   end)
 
-  it("is triggered by 'autochdir'", function()
+  it("are triggered by 'autochdir'", function()
     command('set autochdir')
 
     command('split '..dirs[1]..'/foo')
+    eq({directory=dirs[1], scope='window', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[1], scope='window', changed_window=false}, eval('g:ev'))
+    eq('auto', eval('g:amatchpre'))
     eq('auto', eval('g:amatch'))
+    eq(1, eval('g:cdprecount'))
+    eq(1, eval('g:cdcount'))
 
     command('split '..dirs[2]..'/bar')
+    eq({directory=dirs[2], scope='window', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[2], scope='window', changed_window=false}, eval('g:ev'))
     eq('auto', eval('g:amatch'))
-
+    eq(2, eval('g:cdprecount'))
     eq(2, eval('g:cdcount'))
   end)
 
-  it('does not trigger if directory has not changed', function()
+  it('do not trigger if directory has not changed', function()
     command('lcd '..dirs[1])
+    eq({directory=dirs[1], scope='window', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[1], scope='window', changed_window=false}, eval('g:ev'))
+    eq('window', eval('g:amatchpre'))
     eq('window', eval('g:amatch'))
+    eq(1, eval('g:cdprecount'))
     eq(1, eval('g:cdcount'))
+    command('let g:evpre = {}')
     command('let g:ev = {}')
     command('lcd '..dirs[1])
+    eq({}, eval('g:evpre'))
     eq({}, eval('g:ev'))
+    eq(1, eval('g:cdprecount'))
     eq(1, eval('g:cdcount'))
 
     if iswin() then
       command('lcd '..win_dirs[1])
+      eq({}, eval('g:evpre'))
       eq({}, eval('g:ev'))
+      eq(1, eval('g:cdprecount'))
       eq(1, eval('g:cdcount'))
     end
 
     command('tcd '..dirs[2])
+    eq({directory=dirs[2], scope='tabpage', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[2], scope='tabpage', changed_window=false}, eval('g:ev'))
+    eq('tabpage', eval('g:amatchpre'))
     eq('tabpage', eval('g:amatch'))
+    eq(2, eval('g:cdprecount'))
     eq(2, eval('g:cdcount'))
+    command('let g:evpre = {}')
     command('let g:ev = {}')
     command('tcd '..dirs[2])
+    eq({}, eval('g:evpre'))
     eq({}, eval('g:ev'))
+    eq(2, eval('g:cdprecount'))
     eq(2, eval('g:cdcount'))
 
     if iswin() then
       command('tcd '..win_dirs[2])
+      eq({}, eval('g:evpre'))
       eq({}, eval('g:ev'))
+      eq(2, eval('g:cdprecount'))
       eq(2, eval('g:cdcount'))
     end
 
     command('cd '..dirs[3])
+    eq({directory=dirs[3], scope='global', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[3], scope='global', changed_window=false}, eval('g:ev'))
     eq('global', eval('g:amatch'))
+    eq(3, eval('g:cdprecount'))
     eq(3, eval('g:cdcount'))
+    command('let g:evpre = {}')
     command('let g:ev = {}')
     command('cd '..dirs[3])
+    eq({}, eval('g:evpre'))
     eq({}, eval('g:ev'))
+    eq(3, eval('g:cdprecount'))
     eq(3, eval('g:cdcount'))
 
     if iswin() then
       command('cd '..win_dirs[3])
+      eq({}, eval('g:evpre'))
       eq({}, eval('g:ev'))
+      eq(3, eval('g:cdprecount'))
       eq(3, eval('g:cdcount'))
     end
 
     command('set autochdir')
 
     command('split '..dirs[1]..'/foo')
+    eq({directory=dirs[1], scope='window', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[1], scope='window', changed_window=false}, eval('g:ev'))
+    eq('auto', eval('g:amatchpre'))
     eq('auto', eval('g:amatch'))
+    eq(4, eval('g:cdprecount'))
     eq(4, eval('g:cdcount'))
+    command('let g:evpre = {}')
     command('let g:ev = {}')
     command('split '..dirs[1]..'/bar')
+    eq({}, eval('g:evpre'))
     eq({}, eval('g:ev'))
+    eq(4, eval('g:cdprecount'))
     eq(4, eval('g:cdcount'))
 
     if iswin() then
       command('split '..win_dirs[1]..'/baz')
+      eq({}, eval('g:evpre'))
       eq({}, eval('g:ev'))
+      eq(4, eval('g:cdprecount'))
       eq(4, eval('g:cdcount'))
     end
   end)
 
-  it("is triggered by switching to win/tab with different CWD #6054", function()
+  it("are triggered by switching to win/tab with different CWD #6054", function()
     command('lcd '..dirs[3])            -- window 3
     command('split '..dirs[2]..'/foo')  -- window 2
     command('lcd '..dirs[2])
@@ -185,72 +246,105 @@ describe('autocmd DirChanged', function()
     command('lcd '..dirs[1])
 
     command('2wincmd w')                -- window 2
+    eq({directory=dirs[2], scope='window', changed_window=true}, eval('g:evpre'))
     eq({cwd=dirs[2], scope='window', changed_window=true}, eval('g:ev'))
+    eq('window', eval('g:amatchpre'))
     eq('window', eval('g:amatch'))
 
+    eq(4, eval('g:cdprecount'))
     eq(4, eval('g:cdcount'))
     command('tabnew')                   -- tab 2 (tab-local CWD)
+    eq(4, eval('g:cdprecount'))         -- same CWD, no DirChangedPre event
     eq(4, eval('g:cdcount'))            -- same CWD, no DirChanged event
     command('tcd '..dirs[3])
     command('tabnext')                  -- tab 1 (no tab-local CWD)
+    eq({directory=dirs[2], scope='window', changed_window=true}, eval('g:evpre'))
     eq({cwd=dirs[2], scope='window', changed_window=true}, eval('g:ev'))
+    eq('window', eval('g:amatchpre'))
     eq('window', eval('g:amatch'))
     command('tabnext')                  -- tab 2
+    eq({directory=dirs[3], scope='tabpage', changed_window=true}, eval('g:evpre'))
     eq({cwd=dirs[3], scope='tabpage', changed_window=true}, eval('g:ev'))
+    eq('tabpage', eval('g:amatchpre'))
     eq('tabpage', eval('g:amatch'))
+    eq(7, eval('g:cdprecount'))
     eq(7, eval('g:cdcount'))
 
     command('tabnext')                  -- tab 1
     command('3wincmd w')                -- window 3
+    eq(9, eval('g:cdprecount'))
     eq(9, eval('g:cdcount'))
     command('tabnext')                  -- tab 2 (has the *same* CWD)
+    eq(9, eval('g:cdprecount'))         -- same CWD, no DirChangedPre event
     eq(9, eval('g:cdcount'))            -- same CWD, no DirChanged event
 
     if iswin() then
       command('tabnew')                 -- tab 3
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tcd '..win_dirs[3])
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabnext')                -- tab 1
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabprevious')            -- tab 3
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabprevious')            -- tab 2
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabprevious')            -- tab 1
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('lcd '..win_dirs[3])      -- window 3
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabnext')                -- tab 2
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabnext')                -- tab 3
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabnext')                -- tab 1
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
       command('tabprevious')            -- tab 3
+      eq(9, eval('g:cdprecount'))       -- same CWD, no DirChangedPre event
       eq(9, eval('g:cdcount'))          -- same CWD, no DirChanged event
     end
   end)
 
-  it('is triggered by nvim_set_current_dir()', function()
+  it('are triggered by nvim_set_current_dir()', function()
     request('nvim_set_current_dir', dirs[1])
+    eq({directory=dirs[1], scope='global', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[1], scope='global', changed_window=false}, eval('g:ev'))
+    eq(1, eval('g:cdprecount'))
+    eq(1, eval('g:cdcount'))
 
     request('nvim_set_current_dir', dirs[2])
+    eq({directory=dirs[2], scope='global', changed_window=false}, eval('g:evpre'))
     eq({cwd=dirs[2], scope='global', changed_window=false}, eval('g:ev'))
+    eq(2, eval('g:cdprecount'))
+    eq(2, eval('g:cdcount'))
 
     local status, err = pcall(function()
       request('nvim_set_current_dir', '/doesnotexist')
     end)
     eq(false, status)
     eq('Failed to change directory', string.match(err, ': (.*)'))
-    eq({cwd=dirs[2], scope='global', changed_window=false}, eval('g:ev'))
+    eq({directory='/doesnotexist', scope='global', changed_window=false}, eval('g:evpre'))
+    eq(3, eval('g:cdprecount'))
+    eq(2, eval('g:cdcount'))
   end)
 
-  it('works when local to buffer', function()
+  it('work when local to buffer', function()
+    command('let g:triggeredpre = 0')
     command('let g:triggered = 0')
+    command('autocmd DirChangedPre <buffer> let g:triggeredpre = 1')
     command('autocmd DirChanged <buffer> let g:triggered = 1')
     command('cd '..dirs[1])
+    eq(1, eval('g:triggeredpre'))
     eq(1, eval('g:triggered'))
   end)
 end)