commit db7c2acbc6104e44b524e720c64623c3b63ed4b8
parent 435f03ee106a548c2e5fd6c10005f5ae2a29a5a4
Author: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 9 Jul 2025 06:38:58 +0800
vim-patch:9.1.1532: termdebug: not enough ways to configure breakpoints (#34851)
Problem: termdebug: not enough ways to configure breakpoints
Solution: add the termdebug_config['signs'] config setting, rework the
termdebug test cases (Dimitry Ishenko)
Allow to configure custom breakpoint signs so one can do something like
this:
```vim
let g:termdebug_config['signs'] = ['>1', '>2', '>3', '>4', '>5', '>6', '>7', '>8', '>9']
let g:termdebug_config['sign'] = '>>'
```
where the first 9 breakpoints will have their own signs and the rest
will be the same (>>).
While at it, rework the test for the termdebug plugin:
- Added test for g:termdebug_config['signs'].
- Added test for g:termdebug_config['sign'].
- Moved test for g:termdebug_config['sign_decimal'] into
Test_termdebug_basic()
closes: vim/vim#17694
https://github.com/vim/vim/commit/c4bca1de0bc0f9db1b2d1dab50a6ddcd748dcfeb
Co-authored-by: Dimitry Ishenko <dimitry.ishenko@gmail.com>
Diffstat:
3 files changed, 51 insertions(+), 69 deletions(-)
diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt
@@ -657,6 +657,9 @@ than 99 will be displayed as "9+".
If you want to customize the breakpoint signs to show `>>` in the signcolumn: >vim
let g:termdebug_config['sign'] = '>>'
+You can also specify individual signs for the first several breakpoints: >vim
+ let g:termdebug_config['signs'] = ['>1', '>2', '>3', '>4', '>5', '>6', '>7', '>8', '>9']
+ let g:termdebug_config['sign'] = '>>'
If you would like to use decimal (base 10) breakpoint signs: >vim
let g:termdebug_config['sign_decimal'] = 1
If the variable g:termdebug_config does not yet exist, you can use: >vim
diff --git a/runtime/pack/dist/opt/termdebug/plugin/termdebug.vim b/runtime/pack/dist/opt/termdebug/plugin/termdebug.vim
@@ -2,7 +2,7 @@
"
" Author: Bram Moolenaar
" Copyright: Vim license applies, see ":help license"
-" Last Change: 2023 Nov 02
+" Last Change: 2025 Jul 08
"
" WORK IN PROGRESS - The basics works stable, more to come
" Note: In general you need at least GDB 7.12 because this provides the
@@ -1688,14 +1688,21 @@ func s:CreateBreakpoint(id, subid, enabled)
let hiName = "debugBreakpoint"
endif
let label = ''
- if exists('g:termdebug_config') && has_key(g:termdebug_config, 'sign')
- let label = g:termdebug_config['sign']
- elseif exists('g:termdebug_config') && has_key(g:termdebug_config, 'sign_decimal')
- let label = printf('%02d', a:id)
- if a:id > 99
- let label = '9+'
+ if exists('g:termdebug_config')
+ if has_key(g:termdebug_config, 'signs')
+ let label = get(g:termdebug_config.signs, a:id - 1, '')
endif
- else
+ if label == '' && has_key(g:termdebug_config, 'sign')
+ let label = g:termdebug_config['sign']
+ endif
+ if label == '' && has_key(g:termdebug_config, 'sign_decimal')
+ let label = printf('%02d', a:id)
+ if a:id > 99
+ let label = '9+'
+ endif
+ endif
+ endif
+ if label == ''
let label = printf('%02X', a:id)
if a:id > 255
let label = 'F+'
diff --git a/test/old/testdir/test_plugin_termdebug.vim b/test/old/testdir/test_plugin_termdebug.vim
@@ -95,15 +95,46 @@ func Test_termdebug_basic()
Continue
call Nterm_wait(gdb_buf)
+ let g:termdebug_config = {}
+ let g:termdebug_config['signs'] = ['>1', '>2', '>3']
+ let g:termdebug_config['sign'] = '>>'
+ let g:termdebug_config['sign_decimal'] = 1
+
let i = 2
while i <= 258
Break
call Nterm_wait(gdb_buf)
if i == 2
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint2.0')[0].text, '02')})
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint2.0')[0].text, '>2')})
+ endif
+ if i == 3
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint3.0')[0].text, '>3')})
+ endif
+ if i == 4
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint4.0')[0].text, '>>')})
+ endif
+ if i == 5
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint5.0')[0].text, '>>')})
+ unlet g:termdebug_config['sign']
+ endif
+ if i == 6
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint6.0')[0].text, '06')})
endif
if i == 10
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint10.0')[0].text, '0A')})
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint10.0')[0].text, '10')})
+ endif
+ if i == 99
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint99.0')[0].text, '99')})
+ endif
+ if i == 100
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint100.0')[0].text, '9+')})
+ endif
+ if i == 110
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint110.0')[0].text, '9+')})
+ unlet g:termdebug_config
+ endif
+ if i == 128
+ call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint128.0')[0].text, '80')})
endif
if i == 168
call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint168.0')[0].text, 'A8')})
@@ -177,65 +208,6 @@ func Test_termdebug_basic()
%bw!
endfunc
-func Test_termdebug_decimal_breakpoints()
- let bin_name = 'XTD_decimal'
- let src_name = bin_name .. '.c'
- call s:generate_files(bin_name)
-
- exe "edit " .. src_name
-
- let g:termdebug_config = {}
- let g:termdebug_config['sign_decimal'] = 1
-
- exe "Termdebug " .. bin_name
- " Nvim: g:termdebug_is_running is not ported yet
- " call WaitForAssert({-> assert_true(get(g:, "termdebug_is_running", v:false))})
- call WaitForAssert({-> assert_equal(3, winnr('$'))})
- let gdb_buf = winbufnr(1)
- wincmd b
- Break 9
- call Nterm_wait(gdb_buf)
- redraw!
- Run
- call Nterm_wait(gdb_buf, 400)
-
- let i = 2
- while i <= 258
- Break
- call Nterm_wait(gdb_buf)
- if i == 2
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint2.0')[0].text, '02')})
- endif
- if i == 10
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint10.0')[0].text, '10')})
- endif
- if i == 168
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint168.0')[0].text, '9+')})
- endif
- if i == 255
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint255.0')[0].text, '9+')})
- endif
- if i == 256
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint256.0')[0].text, '9+')})
- endif
- if i == 258
- call WaitForAssert({-> assert_equal(sign_getdefined('debugBreakpoint258.0')[0].text, '9+')})
- endif
- let i += 1
- endwhile
-
- wincmd t
- quit!
- redraw!
- call WaitForAssert({-> assert_equal(1, winnr('$'))})
- call assert_equal([], sign_getplaced('', #{group: 'TermDebug'})[0].signs)
-
- call s:cleanup_files(bin_name)
- %bw!
-
- unlet g:termdebug_config
-endfunc
-
func Test_termdebug_tbreak()
let g:test_is_flaky = 1
let bin_name = 'XTD_tbreak'
