vim-patch:9.1.0175: wrong window positions with 'winfix{width,height}' (#27845)

Problem:  winframe functions incorrectly recompute window positions if
          the altframe wasn't adjacent to the closed frame, which is
          possible if adjacent windows had 'winfix{width,height}' set.

Solution: recompute for windows within the parent of the altframe and
          closed frame. Skip this (as before) if the altframe was
          top/left, but only if adjacent to the closed frame, as
          positions won't change in that case. Also correct the return
          value documentation for win_screenpos. (Sean Dewar)

The issue revealed itself after removing the win_comp_pos call below
winframe_restore in win_splitmove. Similarly, wrong positions could result from
windows closed in other tabpages, as win_free_mem uses winframe_remove (at least
until it is entered later, where enter_tabpage calls win_comp_pos).

NOTE: As win_comp_pos handles only curtab, it's possible via other means for
positions in non-current tabpages to be wrong (e.g: after changing 'laststatus',
'showtabline', etc.). Given enter_tabpage recomputes it, maybe it's intentional
as an optimization? Should probably be documented in win_screenpos then, but I
won't address that here.

closes: vim/vim#14191

Nvim: don't reuse "wp" for "topleft" in winframe_remove, so the change
integrates better with the call to winframe_find_altwin before it.

5866bc3a0f

runtime/doc/builtin.txt

@@ -8898,8 +8898,7 @@ win_screenpos({nr})                                            *win_screenpos()*
 		[1, 1], unless there is a tabline, then it is [2, 1].
 		{nr} can be the window number or the |window-ID|.  Use zero
 		for the current window.
-		Returns [0, 0] if the window cannot be found in the current
+		Returns [0, 0] if the window cannot be found.
-		tabpage.
 
 win_splitmove({nr}, {target} [, {options}])                    *win_splitmove()*
 		Temporarily switch to window {target}, then move window {nr}

runtime/lua/vim/_meta/vimfn.lua

@@ -10592,8 +10592,7 @@ function vim.fn.win_move_statusline(nr, offset) end
 --- [1, 1], unless there is a tabline, then it is [2, 1].
 --- {nr} can be the window number or the |window-ID|.  Use zero
 --- for the current window.
---- Returns [0, 0] if the window cannot be found in the current
+--- Returns [0, 0] if the window cannot be found.
---- tabpage.
 ---
 --- @param nr integer
 --- @return any

src/nvim/eval.lua

@@ -12688,9 +12688,7 @@ M.funcs = {
       [1, 1], unless there is a tabline, then it is [2, 1].
       {nr} can be the window number or the |window-ID|.  Use zero
       for the current window.
-      Returns [0, 0] if the window cannot be found in the current
+      Returns [0, 0] if the window cannot be found.
-      tabpage.
-
     ]=],
     name = 'win_screenpos',
     params = { { 'nr', 'integer' } },

src/nvim/window.c

@@ -3148,6 +3148,13 @@ win_T *winframe_remove(win_T *win, int *dirp, tabpage_T *tp, frame_T **unflat_al
   }
 
   frame_T *frp_close = win->w_frame;
+
+  // Save the position of the containing frame (which will also contain the
+  // altframe) before we remove anything, to recompute window positions later.
+  const win_T *const topleft = frame2win(frp_close->fr_parent);
+  int row = topleft->w_winrow;
+  int col = topleft->w_wincol;
+
   // Remove this frame from the list of frames.
   frame_remove(frp_close);
 
@@ -3160,13 +3167,10 @@ win_T *winframe_remove(win_T *win, int *dirp, tabpage_T *tp, frame_T **unflat_al
                     altfr == frp_close->fr_next, false);
   }
 
-  // If rows/columns go to a window below/right its positions need to be
+  // If the altframe wasn't adjacent and left/above, resizing it will have
-  // updated.  Can only be done after the sizes have been updated.
+  // changed window positions within the parent frame.  Recompute them.
-  if (altfr == frp_close->fr_next) {
+  if (altfr != frp_close->fr_prev) {
-    int row = win->w_winrow;
+    frame_comp_pos(frp_close->fr_parent, &row, &col);
-    int col = win->w_wincol;
-
-    frame_comp_pos(altfr, &row, &col);
   }
 
   if (unflat_altfr == NULL) {
@@ -3354,25 +3358,24 @@ void winframe_restore(win_T *wp, int dir, frame_T *unflat_altfr)
     }
   }
 
-  int row = wp->w_winrow;
-  int col = wp->w_wincol;
-
   // Restore the lost room that was redistributed to the altframe.  Also
   // adjusts window sizes to fit restored statuslines/separators, if needed.
   if (dir == 'v') {
     frame_new_height(unflat_altfr, unflat_altfr->fr_height - frp->fr_height,
                      unflat_altfr == frp->fr_next, false);
-    row += frp->fr_height;
   } else if (dir == 'h') {
     frame_new_width(unflat_altfr, unflat_altfr->fr_width - frp->fr_width,
                     unflat_altfr == frp->fr_next, false);
-    col += frp->fr_width;
   }
 
-  // If rows/columns went to a window below/right, its positions need to be
+  // Recompute window positions within the parent frame to restore them.
-  // restored.  Can only be done after the sizes have been updated.
+  // Positions were unchanged if the altframe was adjacent and left/above.
-  if (unflat_altfr == frp->fr_next) {
+  if (unflat_altfr != frp->fr_prev) {
-    frame_comp_pos(unflat_altfr, &row, &col);
+    const win_T *const topleft = frame2win(frp->fr_parent);
+    int row = topleft->w_winrow;
+    int col = topleft->w_wincol;
+
+    frame_comp_pos(frp->fr_parent, &row, &col);
   }
 }
 

test/old/testdir/test_window_cmd.vim

@@ -200,11 +200,11 @@ func Test_window_split_edit_bufnr()
   %bw!
 endfunc
 
-func s:win_layout_info() abort
+func s:win_layout_info(tp = tabpagenr()) abort
   return #{
-        \ layout: winlayout(),
+        \ layout: winlayout(a:tp),
-        \ pos_sizes: range(1, winnr('$'))
+        \ pos_sizes: range(1, tabpagewinnr(a:tp, '$'))
-        \            ->map({_, nr -> win_getid(nr)->getwininfo()[0]})
+        \            ->map({_, nr -> win_getid(nr, a:tp)->getwininfo()[0]})
         \            ->map({_, wininfo -> #{id: wininfo.winid,
         \                                   row: wininfo.winrow,
         \                                   col: wininfo.wincol,
@@ -2145,4 +2145,69 @@ func Test_win_gotoid_splitmove_textlock_cmdwin()
            \ .. ":call assert_equal('', win_gettype(winnr('#')))\<CR>", 'ntx')
 endfunc
 
+func Test_winfixsize_positions()
+  " Check positions are correct when closing a window in a non-current tabpage
+  " causes non-adjacent window to fill the space due to 'winfix{width,height}'.
+  tabnew
+  vsplit
+  wincmd |
+  split
+  set winfixheight
+  split foo
+  tabfirst
+
+  bwipe! foo
+  " Save actual values before entering the tabpage.
+  let info = s:win_layout_info(2)
+  tabnext
+  " Compare it with the expected value (after win_comp_pos) from entering.
+  call assert_equal(s:win_layout_info(), info)
+
+  $tabnew
+  split
+  split
+  wincmd k
+  belowright vsplit
+  set winfixwidth
+  belowright vsplit foo
+  tabprevious
+
+  bwipe! foo
+  " Save actual values before entering the tabpage.
+  let info = s:win_layout_info(3)
+  tabnext
+  " Compare it with the expected value (after win_comp_pos) from entering.
+  call assert_equal(s:win_layout_info(), info)
+
+  " Check positions unchanged when failing to move a window, if 'winfix{width,
+  " height}' would otherwise cause a non-adjacent window to fill the space.
+  %bwipe
+  call assert_fails('execute "split|"->repeat(&lines)', 'E36:')
+  wincmd p
+  vsplit
+  set winfixwidth
+  vsplit
+  set winfixwidth
+  vsplit
+  vsplit
+  set winfixwidth
+  wincmd p
+
+  let info = s:win_layout_info()
+  call assert_fails('wincmd J', 'E36:')
+  call assert_equal(info, s:win_layout_info())
+
+  only
+  call assert_fails('execute "vsplit|"->repeat(&columns)', 'E36:')
+  belowright split
+  set winfixheight
+  belowright split
+
+  let info = s:win_layout_info()
+  call assert_fails('wincmd H', 'E36:')
+  call assert_equal(info, s:win_layout_info())
+
+  %bwipe
+endfunc
+
 " vim: shiftwidth=2 sts=2 expandtab