vim-patch:9.0.0739: mouse column not correctly used for popup_setpos (#20729)

Problem:    Mouse column not correctly used for popup_setpos.
Solution:   Adjust off-by-one error and handle Visual line selection properly.
            (Yee Cheng Chin, closes vim/vim#11356)
https://github.com/vim/vim/commit/17822c507c03d509037c9ee5eee5cfbb201b3f01

The test_termcodes.vim test cannot be used. Use a Lua test instead.

3 files changed, 144 insertions, 8 deletions

diff --git a/src/nvim/mouse.c b/src/nvim/mouse.c
index 7b267d6ce4..734ece73b4 100644
--- a/src/nvim/mouse.c
+++ b/src/nvim/mouse.c
@@ -31,7 +31,9 @@
 static linenr_T orig_topline = 0;
 static int orig_topfill = 0;
 
-/// Translate window coordinates to buffer position without any side effects
+/// Translate window coordinates to buffer position without any side effects.
+/// Returns IN_BUFFER and sets "mpos->col" to the column when in buffer text.
+/// The column is one for the first column.
 int get_fpos_of_mouse(pos_T *mpos)
 {
   int grid = mouse_grid;
@@ -67,9 +69,6 @@ int get_fpos_of_mouse(pos_T *mpos)
 
   mpos->col = vcol2col(wp, mpos->lnum, col);
 
-  if (mpos->col > 0) {
-    mpos->col--;
-  }
   mpos->coladd = 0;
   return IN_BUFFER;
 }
diff --git a/src/nvim/normal.c b/src/nvim/normal.c
index 1ac8d7013e..b7febe2d51 100644
--- a/src/nvim/normal.c
+++ b/src/nvim/normal.c
@@ -1820,10 +1820,17 @@ bool do_mouse(oparg_T *oap, int c, int dir, long count, bool fixindent)
           } else if (get_fpos_of_mouse(&m_pos) != IN_BUFFER) {
             jump_flags = MOUSE_MAY_STOP_VIS;
           } else {
-            if ((lt(curwin->w_cursor, VIsual)
-                 && (lt(m_pos, curwin->w_cursor) || lt(VIsual, m_pos)))
-                || (lt(VIsual, curwin->w_cursor)
-                    && (lt(m_pos, VIsual) || lt(curwin->w_cursor, m_pos)))) {
+            if (VIsual_mode == 'V') {
+              if ((curwin->w_cursor.lnum <= VIsual.lnum
+                   && (m_pos.lnum < curwin->w_cursor.lnum || VIsual.lnum < m_pos.lnum))
+                  || (VIsual.lnum < curwin->w_cursor.lnum
+                      && (m_pos.lnum < VIsual.lnum || curwin->w_cursor.lnum < m_pos.lnum))) {
+                jump_flags = MOUSE_MAY_STOP_VIS;
+              }
+            } else if ((ltoreq(curwin->w_cursor, VIsual)
+                        && (lt(m_pos, curwin->w_cursor) || lt(VIsual, m_pos)))
+                       || (lt(VIsual, curwin->w_cursor)
+                           && (lt(m_pos, VIsual) || lt(curwin->w_cursor, m_pos)))) {
               jump_flags = MOUSE_MAY_STOP_VIS;
             } else if (VIsual_mode == Ctrl_V) {
               getvcols(curwin, &curwin->w_cursor, &VIsual, &leftcol, &rightcol);
diff --git a/test/functional/ui/mouse_spec.lua b/test/functional/ui/mouse_spec.lua
index cb8dfdb8e1..b3ea0edb12 100644
--- a/test/functional/ui/mouse_spec.lua
+++ b/test/functional/ui/mouse_spec.lua
@@ -4,6 +4,7 @@ local clear, feed, meths = helpers.clear, helpers.feed, helpers.meths
 local insert, feed_command = helpers.insert, helpers.feed_command
 local eq, funcs = helpers.eq, helpers.funcs
 local command = helpers.command
+local exec = helpers.exec
 
 describe('ui/mouse/input', function()
   local screen
@@ -1687,4 +1688,133 @@ describe('ui/mouse/input', function()
     helpers.poke_eventloop()
     helpers.assert_alive()
   end)
+
+  it('mousemodel=popup_setpos', function()
+    screen:try_resize(80, 24)
+    exec([[
+      5new
+      call setline(1, ['the dish ran away with the spoon',
+            \ 'the cow jumped over the moon' ])
+
+      set mouse=a mousemodel=popup_setpos
+
+      aunmenu PopUp
+      nmenu PopUp.foo :let g:menustr = 'foo'<CR>
+      nmenu PopUp.bar :let g:menustr = 'bar'<CR>
+      nmenu PopUp.baz :let g:menustr = 'baz'<CR>
+      vmenu PopUp.foo y:<C-U>let g:menustr = 'foo'<CR>
+      vmenu PopUp.bar y:<C-U>let g:menustr = 'bar'<CR>
+      vmenu PopUp.baz y:<C-U>let g:menustr = 'baz'<CR>
+    ]])
+
+    meths.win_set_cursor(0, {1, 0})
+    meths.input_mouse('right', 'press', '', 0, 0, 4)
+    meths.input_mouse('right', 'release', '', 0, 0, 4)
+    feed('<Down><Down><CR>')
+    eq('bar', meths.get_var('menustr'))
+    eq({1, 4}, meths.win_get_cursor(0))
+
+    -- Test for right click in visual mode inside the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 9})
+    feed('vee')
+    meths.input_mouse('right', 'press', '', 0, 0, 11)
+    meths.input_mouse('right', 'release', '', 0, 0, 11)
+    feed('<Down><CR>')
+    eq({1, 9}, meths.win_get_cursor(0))
+    eq('ran away', funcs.getreg('"'))
+
+    -- Test for right click in visual mode right before the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 9})
+    feed('vee')
+    meths.input_mouse('right', 'press', '', 0, 0, 8)
+    meths.input_mouse('right', 'release', '', 0, 0, 8)
+    feed('<Down><CR>')
+    eq({1, 8}, meths.win_get_cursor(0))
+    eq('', funcs.getreg('"'))
+
+    -- Test for right click in visual mode right after the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 9})
+    feed('vee')
+    meths.input_mouse('right', 'press', '', 0, 0, 17)
+    meths.input_mouse('right', 'release', '', 0, 0, 17)
+    feed('<Down><CR>')
+    eq({1, 17}, meths.win_get_cursor(0))
+    eq('', funcs.getreg('"'))
+
+    -- Test for right click in block-wise visual mode inside the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 15})
+    feed('<C-V>j3l')
+    meths.input_mouse('right', 'press', '', 0, 1, 16)
+    meths.input_mouse('right', 'release', '', 0, 1, 16)
+    feed('<Down><CR>')
+    eq({1, 15}, meths.win_get_cursor(0))
+    eq('\0224', funcs.getregtype('"'))
+
+    -- Test for right click in block-wise visual mode outside the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 15})
+    feed('<C-V>j3l')
+    meths.input_mouse('right', 'press', '', 0, 1, 1)
+    meths.input_mouse('right', 'release', '', 0, 1, 1)
+    feed('<Down><CR>')
+    eq({2, 1}, meths.win_get_cursor(0))
+    eq('v', funcs.getregtype('"'))
+    eq('', funcs.getreg('"'))
+
+    -- Test for right click in line-wise visual mode inside the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 15})
+    feed('V')
+    meths.input_mouse('right', 'press', '', 0, 0, 9)
+    meths.input_mouse('right', 'release', '', 0, 0, 9)
+    feed('<Down><CR>')
+    eq({1, 0}, meths.win_get_cursor(0)) -- After yanking, the cursor goes to 1,1
+    eq('V', funcs.getregtype('"'))
+    eq(1, #funcs.getreg('"', 1, true))
+
+    -- Test for right click in multi-line line-wise visual mode inside the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 15})
+    feed('Vj')
+    meths.input_mouse('right', 'press', '', 0, 1, 19)
+    meths.input_mouse('right', 'release', '', 0, 1, 19)
+    feed('<Down><CR>')
+    eq({1, 0}, meths.win_get_cursor(0)) -- After yanking, the cursor goes to 1,1
+    eq('V', funcs.getregtype('"'))
+    eq(2, #funcs.getreg('"', 1, true))
+
+    -- Test for right click in line-wise visual mode outside the selection
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 15})
+    feed('V')
+    meths.input_mouse('right', 'press', '', 0, 1, 9)
+    meths.input_mouse('right', 'release', '', 0, 1, 9)
+    feed('<Down><CR>')
+    eq({2, 9}, meths.win_get_cursor(0))
+    eq('', funcs.getreg('"'))
+
+    -- Try clicking on the status line
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {1, 9})
+    feed('vee')
+    meths.input_mouse('right', 'press', '', 0, 5, 1)
+    meths.input_mouse('right', 'release', '', 0, 5, 1)
+    feed('<Down><CR>')
+    eq({1, 9}, meths.win_get_cursor(0))
+    eq('ran away', funcs.getreg('"'))
+
+    -- Try clicking outside the window
+    funcs.setreg('"', '')
+    meths.win_set_cursor(0, {2, 1})
+    feed('vee')
+    meths.input_mouse('right', 'press', '', 0, 6, 1)
+    meths.input_mouse('right', 'release', '', 0, 6, 1)
+    feed('<Down><CR>')
+    eq(2, funcs.winnr())
+    eq('', funcs.getreg('"'))
+  end)
 end)