feat(events): add DirChangedPre

zeertzjq · zeertzjq · commit 059d36e326e3 · 2022-02-11T12:55:58.000+08:00
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) vim/vim@28e8f73
diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt
@@ -525,8 +525,19 @@ DirChanged			After the |current-directory| was changed.
 					"global"  to trigger on `:cd`
 					"auto"    to trigger on 'autochdir'.
 				Sets these |v:event| keys:
-				    cwd:   current working directory
-				    scope: "global", "tabpage", "window"
+				    cwd:            current working directory
+				    scope:          "global", "tabpage", "window"
+				    changed_window: v:true if we fired the event
+				                    switching window (or tab)
+				<afile> is set to the new directory name.
+				Non-recursive (event cannot trigger itself).
+							*DirChangedPre*
+DirChangedPre			When the |current-directory| is going to be
+				changed, as with |DirChanged|.
+				The pattern is like with |DirChanged|.
+				Sets these |v:event| keys:
+				    directory:      new working directory
+				    scope:          "global", "tabpage", "window"
 				    changed_window: v:true if we fired the event
 				                    switching window (or tab)
 				<afile> is set to the new directory name.
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
@@ -433,7 +433,8 @@ Vimscript compatibility:
   `this_session` does not alias to |v:this_session|
 
 Working directory (Vim implemented some of these later than Nvim):
-- |DirChanged| can be triggered when switching to another window.
+- |DirChanged| and |DirChangedPre| can be triggered when switching to another
+  window or tab.
 - |getcwd()| and |haslocaldir()| may throw errors if the tab page or window
   cannot be found.  *E5000* *E5001* *E5002*
 - |haslocaldir()| checks for tab-local directory if and only if -1 is passed as
diff --git a/src/nvim/auevents.lua b/src/nvim/auevents.lua
@@ -40,6 +40,7 @@ return {
     'DiagnosticChanged',      -- diagnostics in a buffer were modified
     'DiffUpdated',            -- diffs have been updated
     'DirChanged',             -- directory changed
+    'DirChangedPre',          -- directory is going to change
     'EncodingChanged',        -- after changing the 'encoding' option
     'ExitPre',                -- before exiting
     'FileAppendCmd',          -- append to a file using command
@@ -132,18 +133,14 @@ return {
   nvim_specific = {
     BufModifiedSet=true,
     DiagnosticChanged=true,
-    DirChanged=true,
     RecordingEnter=true,
     RecordingLeave=true,
     Signal=true,
-    TabClosed=true,
-    TabNew=true,
     TabNewEntered=true,
     TermClose=true,
     TermOpen=true,
     UIEnter=true,
     UILeave=true,
-    WinClosed=true,
     WinScrolled=true,
   },
 }
diff --git a/src/nvim/autocmd.c b/src/nvim/autocmd.c
@@ -1517,13 +1517,13 @@ static bool apply_autocmds_group(event_T event, char_u *fname, char_u *fname_io,
         || event == EVENT_CMDLINELEAVE || event == EVENT_CMDWINENTER
         || event == EVENT_CMDWINLEAVE || event == EVENT_CMDUNDEFINED
         || event == EVENT_COLORSCHEME || event == EVENT_COLORSCHEMEPRE
-        || event == EVENT_DIRCHANGED || event == EVENT_FILETYPE
-        || event == EVENT_FUNCUNDEFINED || event == EVENT_MODECHANGED
-        || event == EVENT_OPTIONSET || event == EVENT_QUICKFIXCMDPOST
-        || event == EVENT_QUICKFIXCMDPRE || event == EVENT_REMOTEREPLY
-        || event == EVENT_SPELLFILEMISSING || event == EVENT_SYNTAX
-        || event == EVENT_SIGNAL || event == EVENT_TABCLOSED
-        || event == EVENT_WINCLOSED) {
+        || event == EVENT_DIRCHANGED || event == EVENT_DIRCHANGEDPRE
+        || event == EVENT_FILETYPE || event == EVENT_FUNCUNDEFINED
+        || event == EVENT_MODECHANGED || event == EVENT_OPTIONSET
+        || event == EVENT_QUICKFIXCMDPOST || event == EVENT_QUICKFIXCMDPRE
+        || event == EVENT_REMOTEREPLY || event == EVENT_SPELLFILEMISSING
+        || event == EVENT_SYNTAX || event == EVENT_SIGNAL
+        || event == EVENT_TABCLOSED || event == EVENT_WINCLOSED) {
       fname = vim_strsave(fname);
     } else {
       fname = (char_u *)FullName_save((char *)fname, false);
diff --git a/src/nvim/ex_docmd.c b/src/nvim/ex_docmd.c
@@ -7784,7 +7784,7 @@ static char_u *get_prevdir(CdScope scope)
 /// Deal with the side effects of changing the current directory.
 ///
 /// @param scope  Scope of the function call (global, tab or window).
-void post_chdir(CdScope scope, bool trigger_dirchanged)
+static void post_chdir(CdScope scope, bool trigger_dirchanged)
 {
   // Always overwrite the window-local CWD.
   XFREE_CLEAR(curwin->w_localdir);
@@ -7825,7 +7825,7 @@ void post_chdir(CdScope scope, bool trigger_dirchanged)
   shorten_fnames(true);
 
   if (trigger_dirchanged) {
-    do_autocmd_dirchanged(cwd, scope, kCdCauseManual);
+    do_autocmd_dirchanged(cwd, scope, kCdCauseManual, false);
   }
 }
 
@@ -7869,10 +7869,13 @@ bool changedir_func(char_u *new_dir, CdScope scope)
   }
 
   bool dir_differs = pdir == NULL || pathcmp((char *)pdir, (char *)new_dir, -1) != 0;
-  if (dir_differs && vim_chdir(new_dir) != 0) {
-    emsg(_(e_failed));
-    xfree(pdir);
-    return false;
+  if (dir_differs) {
+    do_autocmd_dirchanged((char *)new_dir, scope, kCdCauseManual, true);
+    if (vim_chdir(new_dir) != 0) {
+      emsg(_(e_failed));
+      xfree(pdir);
+      return false;
+    }
   }
 
   char_u **pp;
diff --git a/src/nvim/file_search.c b/src/nvim/file_search.c
@@ -1600,11 +1600,13 @@ char_u *find_file_in_path_option(char_u *ptr, size_t len, int options, int first
   return file_name;
 }
 
-void do_autocmd_dirchanged(char *new_dir, CdScope scope, CdCause cause)
+void do_autocmd_dirchanged(char *new_dir, CdScope scope, CdCause cause, bool pre)
 {
   static bool recursive = false;
 
-  if (recursive || !has_event(EVENT_DIRCHANGED)) {
+  event_T event = pre ? EVENT_DIRCHANGEDPRE : EVENT_DIRCHANGED;
+
+  if (recursive || !has_event(event)) {
     // No autocommand was defined or we changed
     // the directory from this autocommand.
     return;
@@ -1638,8 +1640,12 @@ void do_autocmd_dirchanged(char *new_dir, CdScope scope, CdCause cause)
   new_dir = new_dir_buf;
 #endif
 
+  if (pre) {
+    tv_dict_add_str(dict, S_LEN("directory"), new_dir);
+  } else {
+    tv_dict_add_str(dict, S_LEN("cwd"), new_dir);
+  }
   tv_dict_add_str(dict, S_LEN("scope"), buf);  // -V614
-  tv_dict_add_str(dict, S_LEN("cwd"), new_dir);
   tv_dict_add_bool(dict, S_LEN("changed_window"), cause == kCdCauseWindow);
   tv_dict_set_keys_readonly(dict);
 
@@ -1655,8 +1661,7 @@ void do_autocmd_dirchanged(char *new_dir, CdScope scope, CdCause cause)
     abort();
   }
 
-  apply_autocmds(EVENT_DIRCHANGED, (char_u *)buf, (char_u *)new_dir, false,
-                 curbuf);
+  apply_autocmds(event, (char_u *)buf, (char_u *)new_dir, false, curbuf);
 
   restore_v_event(dict, &save_v_event);
 
@@ -1682,12 +1687,16 @@ int vim_chdirfile(char_u *fname, CdCause cause)
     return OK;
   }
 
+  if (cause != kCdCauseOther) {
+    do_autocmd_dirchanged(dir, kCdScopeWindow, cause, true);
+  }
+
   if (os_chdir(dir) != 0) {
     return FAIL;
   }
 
   if (cause != kCdCauseOther) {
-    do_autocmd_dirchanged(dir, kCdScopeWindow, cause);
+    do_autocmd_dirchanged(dir, kCdScopeWindow, cause, false);
   }
 
   return OK;
diff --git a/src/nvim/testdir/test_autocmd.vim b/src/nvim/testdir/test_autocmd.vim
@@ -1850,14 +1850,16 @@ endfunc
 
 function Test_dirchanged_global()
   call s:Before_test_dirchanged()
+  autocmd test_dirchanged DirChangedPre global call add(s:li, "pre cd " .. v:event.directory)
   autocmd test_dirchanged DirChanged global call add(s:li, "cd:")
   autocmd test_dirchanged DirChanged global call add(s:li, expand("<afile>"))
   call chdir(s:dir_foo)
-  call assert_equal(["cd:", s:dir_foo], s:li)
+  let expected = ["pre cd " .. s:dir_foo, "cd:", s:dir_foo]
+  call assert_equal(expected, s:li)
   call chdir(s:dir_foo)
-  call assert_equal(["cd:", s:dir_foo], s:li)
+  call assert_equal(expected, s:li)
   exe 'lcd ' .. fnameescape(s:dir_bar)
-  call assert_equal(["cd:", s:dir_foo], s:li)
+  call assert_equal(expected, s:li)
   call s:After_test_dirchanged()
 endfunc
 
@@ -1879,14 +1881,16 @@ function Test_dirchanged_auto()
   CheckOption autochdir
   call s:Before_test_dirchanged()
   call test_autochdir()
+  autocmd test_dirchanged DirChangedPre auto call add(s:li, "pre cd " .. v:event.directory)
   autocmd test_dirchanged DirChanged auto call add(s:li, "auto:")
   autocmd test_dirchanged DirChanged auto call add(s:li, expand("<afile>"))
   set acd
   cd ..
   call assert_equal([], s:li)
   exe 'edit ' . s:dir_foo . '/Xfile'
   call assert_equal(s:dir_foo, getcwd())
-  call assert_equal(["auto:", s:dir_foo], s:li)
+  let expected = ["pre cd " .. s:dir_foo, "auto:", s:dir_foo]
+  call assert_equal(expected, s:li)
   set noacd
   bwipe!
   call s:After_test_dirchanged()
diff --git a/src/nvim/window.c b/src/nvim/window.c
@@ -4645,20 +4645,29 @@ void fix_current_dir(void)
         globaldir = (char_u *)xstrdup(cwd);
       }
     }
+    bool dir_differs = pathcmp(new_dir, cwd, -1) != 0;
+    if (!p_acd && dir_differs) {
+      do_autocmd_dirchanged(new_dir, curwin->w_localdir ? kCdScopeWindow : kCdScopeTabpage,
+                            kCdCauseWindow, true);
+    }
     if (os_chdir(new_dir) == 0) {
-      if (!p_acd && pathcmp(new_dir, cwd, -1) != 0) {
-        do_autocmd_dirchanged(new_dir, curwin->w_localdir
-                              ? kCdScopeWindow : kCdScopeTabpage, kCdCauseWindow);
+      if (!p_acd && dir_differs) {
+        do_autocmd_dirchanged(new_dir, curwin->w_localdir ? kCdScopeWindow : kCdScopeTabpage,
+                              kCdCauseWindow, false);
       }
-      last_chdir_reason = NULL;
-      shorten_fnames(true);
     }
+    last_chdir_reason = NULL;
+    shorten_fnames(true);
   } else if (globaldir != NULL) {
     // Window doesn't have a local directory and we are not in the global
     // directory: Change to the global directory.
+    bool dir_differs = pathcmp((char *)globaldir, cwd, -1) != 0;
+    if (!p_acd && dir_differs) {
+      do_autocmd_dirchanged((char *)globaldir, kCdScopeGlobal, kCdCauseWindow, true);
+    }
     if (os_chdir((char *)globaldir) == 0) {
-      if (!p_acd && pathcmp((char *)globaldir, cwd, -1) != 0) {
-        do_autocmd_dirchanged((char *)globaldir, kCdScopeGlobal, kCdCauseWindow);
+      if (!p_acd && dir_differs) {
+        do_autocmd_dirchanged((char *)globaldir, kCdScopeGlobal, kCdCauseWindow, false);
       }
     }
     XFREE_CLEAR(globaldir);
diff --git a/test/functional/autocmd/dirchanged_spec.lua b/test/functional/autocmd/dirchanged_spec.lua
