vim-patch:9.1.1070: Cannot control cursor positioning of getchar() (#32303)

Problem:  Cannot control cursor positioning of getchar().
Solution: Add "cursor" flag to {opts}, with possible values "hide",
          "keep" and "msg".

related: vim/vim#10603
closes: vim/vim#16569

https://github.com/vim/vim/commit/edf0f7db28f87611368e158210e58ed30f673098

2 files changed, 152 insertions, 3 deletions

diff --git a/test/functional/vimscript/getchar_spec.lua b/test/functional/vimscript/getchar_spec.lua
new file mode 100644
index 0000000000..1327d741cf
--- /dev/null
+++ b/test/functional/vimscript/getchar_spec.lua
@@ -0,0 +1,92 @@
+local n = require('test.functional.testnvim')()
+local Screen = require('test.functional.ui.screen')
+
+local clear = n.clear
+local exec = n.exec
+local feed = n.feed
+local async_command = n.async_meths.nvim_command
+
+describe('getchar()', function()
+  before_each(clear)
+
+  -- oldtest: Test_getchar_cursor_position()
+  it('cursor positioning', function()
+    local screen = Screen.new(40, 6)
+    exec([[
+      call setline(1, ['foobar', 'foobar', 'foobar'])
+      call cursor(3, 6)
+    ]])
+    screen:expect([[
+      foobar                                  |*2
+      fooba^r                                  |
+      {1:~                                       }|*2
+                                              |
+    ]])
+
+    -- Default: behaves like "msg" when immediately after printing a message,
+    -- even if :sleep moved cursor elsewhere.
+    for _, cmd in ipairs({
+      'echo 1234 | call getchar()',
+      'echo 1234 | call getchar(-1, {})',
+      "echo 1234 | call getchar(-1, #{cursor: 'msg'})",
+      'echo 1234 | sleep 1m | call getchar()',
+      'echo 1234 | sleep 1m | call getchar(-1, {})',
+      "echo 1234 | sleep 1m | call getchar(-1, #{cursor: 'msg'})",
+    }) do
+      async_command(cmd)
+      screen:expect([[
+        foobar                                  |*3
+        {1:~                                       }|*2
+        1234^                                    |
+      ]])
+      feed('a')
+      screen:expect([[
+        foobar                                  |*2
+        fooba^r                                  |
+        {1:~                                       }|*2
+        1234                                    |
+      ]])
+    end
+
+    -- Default: behaves like "keep" when not immediately after printing a message.
+    for _, cmd in ipairs({
+      'call getchar()',
+      'call getchar(-1, {})',
+      "call getchar(-1, #{cursor: 'keep'})",
+      "echo 1234 | sleep 1m | call getchar(-1, #{cursor: 'keep'})",
+    }) do
+      async_command(cmd)
+      screen:expect_unchanged()
+      feed('a')
+      screen:expect_unchanged()
+    end
+
+    async_command("call getchar(-1, #{cursor: 'msg'})")
+    screen:expect([[
+      foobar                                  |*3
+      {1:~                                       }|*2
+      ^1234                                    |
+    ]])
+    feed('a')
+    screen:expect([[
+      foobar                                  |*2
+      fooba^r                                  |
+      {1:~                                       }|*2
+      1234                                    |
+    ]])
+
+    async_command("call getchar(-1, #{cursor: 'hide'})")
+    screen:expect([[
+      foobar                                  |*3
+      {1:~                                       }|*2
+      1234                                    |
+    ]])
+    feed('a')
+    screen:expect([[
+      foobar                                  |*2
+      fooba^r                                  |
+      {1:~                                       }|*2
+      1234                                    |
+    ]])
+  end)
+end)
diff --git a/test/old/testdir/test_functions.vim b/test/old/testdir/test_functions.vim
index f57743900a..738a417b86 100644
--- a/test/old/testdir/test_functions.vim
+++ b/test/old/testdir/test_functions.vim
@@ -2458,6 +2458,14 @@ func Test_getchar()
 
   call assert_fails('call getchar(1, 1)', 'E1206:')
   call assert_fails('call getcharstr(1, 1)', 'E1206:')
+  call assert_fails('call getchar(1, #{cursor: "foo"})', 'E475:')
+  call assert_fails('call getcharstr(1, #{cursor: "foo"})', 'E475:')
+  call assert_fails('call getchar(1, #{cursor: 0z})', 'E976:')
+  call assert_fails('call getcharstr(1, #{cursor: 0z})', 'E976:')
+  call assert_fails('call getchar(1, #{simplify: 0z})', 'E974:')
+  call assert_fails('call getcharstr(1, #{simplify: 0z})', 'E974:')
+  call assert_fails('call getchar(1, #{number: []})', 'E745:')
+  call assert_fails('call getchar(1, #{number: {}})', 'E728:')
   call assert_fails('call getcharstr(1, #{number: v:true})', 'E475:')
   call assert_fails('call getcharstr(1, #{number: v:false})', 'E475:')
 
@@ -2476,10 +2484,59 @@ func Test_getchar()
   enew!
 endfunc
 
+func Test_getchar_cursor_position()
+  CheckRunVimInTerminal
+
+  let lines =<< trim END
+    call setline(1, ['foobar', 'foobar', 'foobar'])
+    call cursor(3, 6)
+    nnoremap <F1> <Cmd>echo 1234<Bar>call getchar()<CR>
+    nnoremap <F2> <Cmd>call getchar()<CR>
+    nnoremap <F3> <Cmd>call getchar(-1, {})<CR>
+    nnoremap <F4> <Cmd>call getchar(-1, #{cursor: 'msg'})<CR>
+    nnoremap <F5> <Cmd>call getchar(-1, #{cursor: 'keep'})<CR>
+    nnoremap <F6> <Cmd>call getchar(-1, #{cursor: 'hide'})<CR>
+  END
+  call writefile(lines, 'XgetcharCursorPos', 'D')
+  let buf = RunVimInTerminal('-S XgetcharCursorPos', {'rows': 6})
+  call WaitForAssert({-> assert_equal([3, 6], term_getcursor(buf)[0:1])})
+
+  call term_sendkeys(buf, "\<F1>")
+  call WaitForAssert({-> assert_equal([6, 5], term_getcursor(buf)[0:1])})
+  call assert_true(term_getcursor(buf)[2].visible)
+  call term_sendkeys(buf, 'a')
+  call WaitForAssert({-> assert_equal([3, 6], term_getcursor(buf)[0:1])})
+  call assert_true(term_getcursor(buf)[2].visible)
+
+  for key in ["\<F2>", "\<F3>", "\<F4>"]
+    call term_sendkeys(buf, key)
+    call WaitForAssert({-> assert_equal([6, 1], term_getcursor(buf)[0:1])})
+    call assert_true(term_getcursor(buf)[2].visible)
+    call term_sendkeys(buf, 'a')
+    call WaitForAssert({-> assert_equal([3, 6], term_getcursor(buf)[0:1])})
+    call assert_true(term_getcursor(buf)[2].visible)
+  endfor
+
+  call term_sendkeys(buf, "\<F5>")
+  call TermWait(buf, 50)
+  call assert_equal([3, 6], term_getcursor(buf)[0:1])
+  call assert_true(term_getcursor(buf)[2].visible)
+  call term_sendkeys(buf, 'a')
+  call TermWait(buf, 50)
+  call assert_equal([3, 6], term_getcursor(buf)[0:1])
+  call assert_true(term_getcursor(buf)[2].visible)
+
+  call term_sendkeys(buf, "\<F6>")
+  call WaitForAssert({-> assert_false(term_getcursor(buf)[2].visible)})
+  call term_sendkeys(buf, 'a')
+  call WaitForAssert({-> assert_true(term_getcursor(buf)[2].visible)})
+  call assert_equal([3, 6], term_getcursor(buf)[0:1])
+
+  call StopVimInTerminal(buf)
+endfunc
+
 func Test_libcall_libcallnr()
-  if !has('libcall')
-    return
-  endif
+  CheckFeature libcall
 
   if has('win32')
     let libc = 'msvcrt.dll'