vim-patch:partial:9.1.0497: termdebug can be further improved

Problem:  termdebug can be further improved
Solution: refactor save/restore, update docs,
          add a new save/restore test (Ubaldo Tiberi)

closes: vim/vim#15032

a48637c105

Co-authored-by: Ubaldo Tiberi <ubaldo.tiberi@google.com>

runtime/doc/nvim_terminal_emulator.txt

@@ -462,6 +462,9 @@ If there is no g:termdebug_config you can use: >vim
 	let g:termdebug_use_prompt = 1
 <
 Mappings ~
+The termdebug plugin enables a few default mappings.  All those mappings
+are reset to their original values once the termdebug session concludes.
+
 					*termdebug_map_K* *termdebug-mappings*
 The K key is normally mapped to |:Evaluate| unless a buffer local (|:map-local|)
 mapping to K already exists.  If you do not want this use: >vim

runtime/pack/dist/opt/termdebug/plugin/termdebug.vim

@@ -168,7 +168,7 @@ func s:StartDebug_internal(dict)
   let b:save_signcolumn = &signcolumn
   let s:signcolumn_buflist = [bufnr()]
 
-  let s:save_columns = 0
+  let s:saved_columns = 0
   let s:allleft = v:false
   let wide = 0
   if exists('g:termdebug_config')
@@ -178,7 +178,7 @@ func s:StartDebug_internal(dict)
   endif
   if wide > 0
     if &columns < wide
-      let s:save_columns = &columns
+      let s:saved_columns = &columns
       let &columns = wide
       " If we make the Vim window wider, use the whole left half for the debug
       " windows.
@@ -808,8 +808,8 @@ func s:EndDebugCommon()
 
   call win_gotoid(curwinid)
 
-  if s:save_columns > 0
-    let &columns = s:save_columns
+  if s:saved_columns > 0
+    let &columns = s:saved_columns
   endif
 
   if exists('#User#TermdebugStopPost')
@@ -1028,8 +1028,8 @@ func s:InstallCommands()
     let map = g:termdebug_map_K
   endif
   if map
-    let s:k_map_saved = maparg('K', 'n', 0, 1)
-    if !empty(s:k_map_saved) && !s:k_map_saved.buffer || empty(s:k_map_saved)
+    let s:saved_K_map = maparg('K', 'n', 0, 1)
+    if !empty(s:saved_K_map) && !s:saved_K_map.buffer || empty(s:saved_K_map)
       nnoremap K :Evaluate<CR>
     endif
   endif
@@ -1039,8 +1039,8 @@ func s:InstallCommands()
     let map = get(g:termdebug_config, 'map_plus', 1)
   endif
   if map
-    let s:plus_map_saved = maparg('+', 'n', 0, 1)
-    if !empty(s:plus_map_saved) && !s:plus_map_saved.buffer || empty(s:plus_map_saved)
+    let s:saved_plus_map = maparg('+', 'n', 0, 1)
+    if !empty(s:saved_plus_map) && !s:saved_plus_map.buffer || empty(s:saved_plus_map)
       nnoremap <expr> + $'<Cmd>{v:count1}Up<CR>'
     endif
   endif
@@ -1050,8 +1050,8 @@ func s:InstallCommands()
     let map = get(g:termdebug_config, 'map_minus', 1)
   endif
   if map
-    let s:minus_map_saved = maparg('-', 'n', 0, 1)
-    if !empty(s:minus_map_saved) && !s:minus_map_saved.buffer || empty(s:minus_map_saved)
+    let s:saved_minus_map = maparg('-', 'n', 0, 1)
+    if !empty(s:saved_minus_map) && !s:saved_minus_map.buffer || empty(s:saved_minus_map)
       nnoremap <expr> - $'<Cmd>{v:count1}Down<CR>'
     endif
   endif
@@ -1119,32 +1119,32 @@ func s:DeleteCommands()
   delcommand Var
   delcommand Winbar
 
-  if exists('s:k_map_saved')
-    if !empty(s:k_map_saved) && !s:k_map_saved.buffer
+  if exists('s:saved_K_map')
+    if !empty(s:saved_K_map) && !s:saved_K_map.buffer
       nunmap K
-      call mapset(s:k_map_saved)
-    elseif empty(s:k_map_saved)
+      call mapset(s:saved_K_map)
+    elseif empty(s:saved_K_map)
       nunmap K
     endif
-    unlet s:k_map_saved
+    unlet s:saved_K_map
   endif
-  if exists('s:plus_map_saved')
-    if !empty(s:plus_map_saved) && !s:plus_map_saved.buffer
+  if exists('s:saved_plus_map')
+    if !empty(s:saved_plus_map) && !s:saved_plus_map.buffer
       nunmap +
-      call mapset(s:plus_map_saved)
-    elseif empty(s:plus_map_saved)
+      call mapset(s:saved_plus_map)
+    elseif empty(s:saved_plus_map)
       nunmap +
     endif
-    unlet s:plus_map_saved
+    unlet s:saved_plus_map
   endif
-  if exists('s:minus_map_saved')
-    if !empty(s:minus_map_saved) && !s:minus_map_saved.buffer
+  if exists('s:saved_minus_map')
+    if !empty(s:saved_minus_map) && !s:saved_minus_map.buffer
       nunmap -
-      call mapset(s:minus_map_saved)
-    elseif empty(s:minus_map_saved)
+      call mapset(s:saved_minus_map)
+    elseif empty(s:saved_minus_map)
       nunmap -
     endif
-    unlet s:minus_map_saved
+    unlet s:saved_minus_map
   endif
 
   if has('menu')

test/old/testdir/test_termdebug.vim

@@ -341,14 +341,41 @@ func Test_termdebug_bufnames()
 endfunc
 
 function Test_termdebug_save_restore_variables()
+  " saved mousemodel
   let &mousemodel=''
+
+  " saved keys
+  nnoremap K :echo "hello world!"<cr>
+  let expected_map_K = maparg('K', 'n', 0 , 1)
+  nnoremap + :echo "hello plus!"<cr>
+  let expected_map_plus = maparg('+', 'n', 0 , 1)
+  let expected_map_minus = {}
+
+  " saved &columns
+  let expected_columns = &columns
+
+  " We want termdebug to overwrite 'K' map but not '+' map.
+  let g:termdebug_config = {}
+  let g:termdebug_config['map_K'] = 1
+
   Termdebug
   call WaitForAssert({-> assert_equal(3, winnr('$'))})
   call WaitForAssert({-> assert_match(&mousemodel, 'popup_setpos')})
   wincmd t
   quit!
   call WaitForAssert({-> assert_equal(1, winnr('$'))})
-  call WaitForAssert({-> assert_true(empty(&mousemodel))})
+
+  call assert_true(empty(&mousemodel))
+
+  call assert_true(empty(expected_map_minus))
+  call assert_equal(expected_map_K.rhs, maparg('K', 'n', 0, 1).rhs)
+  call assert_equal(expected_map_plus.rhs, maparg('+', 'n', 0, 1).rhs)
+
+  call assert_equal(expected_columns, &columns)
+
+  nunmap K
+  nunmap +
+  unlet g:termdebug_config
 endfunction