window.c: do BufEnter in correct window after closing help #7431

closes #7429

Problem: after a help window was closed, a window was selected and its
autocommands triggered. After that, restore_snapshot was called and the
focused window changed, confusing the user.

Solution: Add function get_snapshot_focus() that returns the window that
holds the cursor in a snapshot. Use this function in win_close to make
sure the right window is selected before any autocommand is triggered.

2 files changed, 42 insertions, 0 deletions

diff --git a/src/nvim/window.c b/src/nvim/window.c
index 4e4eb297aa..e39569321e 100644
--- a/src/nvim/window.c
+++ b/src/nvim/window.c
@@ -1991,6 +1991,14 @@ int win_close(win_T *win, int free_buf)
    * the screen space. */
   wp = win_free_mem(win, &dir, NULL);
 
+  if (help_window) {
+    // Closing the help window moves the cursor back to the original window.
+    win_T *tmpwp = get_snapshot_focus(SNAP_HELP_IDX);
+    if (tmpwp != NULL) {
+      wp = tmpwp;
+    }
+  }
+
   /* Make sure curwin isn't invalid.  It can cause severe trouble when
    * printing an error message.  For win_equal() curbuf needs to be valid
    * too. */
@@ -5421,6 +5429,27 @@ static win_T *restore_snapshot_rec(frame_T *sn, frame_T *fr)
   return wp;
 }
 
+/// Gets the focused window (the one holding the cursor) of the snapshot.
+static win_T *get_snapshot_focus(int idx)
+{
+  if (curtab->tp_snapshot[idx] == NULL) {
+    return NULL;
+  }
+
+  frame_T *sn = curtab->tp_snapshot[idx];
+  // This should be equivalent to the recursive algorithm found in
+  // restore_snapshot as far as traveling nodes go.
+  while (sn->fr_child != NULL || sn->fr_next != NULL) {
+    while (sn->fr_child != NULL) {
+      sn = sn->fr_child;
+    }
+    if (sn->fr_next != NULL) {
+      sn = sn->fr_next;
+    }
+  }
+
+  return sn->fr_win;
+}
 
 /*
  * Set "win" to be the curwin and "tp" to be the current tab page.
diff --git a/test/functional/autocmd/bufenter_spec.lua b/test/functional/autocmd/bufenter_spec.lua
index fef9838050..e14ddb3316 100644
--- a/test/functional/autocmd/bufenter_spec.lua
+++ b/test/functional/autocmd/bufenter_spec.lua
@@ -31,4 +31,17 @@ describe('autocmd BufEnter', function()
     eq(1, eval("exists('g:dir_bufenter')"))  -- Did BufEnter for the directory.
     eq(2, eval("bufnr('%')"))                -- Switched to the dir buffer.
   end)
+
+  it('triggered by ":split normal|:help|:bw"', function()
+    command("split normal")
+    command("wincmd j")
+    command("helptags runtime/doc")
+    command("help")
+    command("wincmd L")
+    command("autocmd BufEnter normal let g:bufentered = 1")
+    command("bw")
+    eq(1, eval('bufnr("%")')) -- The cursor is back to the bottom window
+    eq(0, eval("exists('g:bufentered')")) -- The autocmd hasn't been triggered
+  end)
+
 end)