aniani/vim
0
0
Fork 1
mirror of https://github.com/vim/vim.git synced 2025-08-26 20:03:41 -04:00
Code

patch 9.1.0607: termdebug: uses inconsistent style

Browse Source 
Problem:  termdebug: uses inconsistent style
Solution: termdebug: deprecate numeric values for v:true/false,
          fix white space style in the plugin
          (Ubaldo Tiberi)

closes: #15304

Signed-off-by: Ubaldo Tiberi <ubaldo.tiberi@google.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Ubaldo Tiberi 2024-07-20 12:00:44 +02:00 committed by Christian Brabandt
parent c8a582aad5
commit a90b0b4ba2
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
4 changed files with 144 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
runtime/doc/terminal.txt
View File

@ -1,4 +1,4 @@
*terminal.txt* For Vim version 9.1. Last change: 2024 Jul 14
*terminal.txt* For Vim version 9.1. Last change: 2024 Jul 20
VIM REFERENCE MANUAL by Bram Moolenaar
@ -1530,9 +1530,9 @@ in a buffer with 'buftype' set to "prompt". This works slightly differently:
*termdebug_use_prompt*
Prompt mode can be used even when the |+terminal| feature is present with: >
let g:termdebug_config['use_prompt'] = 1
let g:termdebug_config['use_prompt'] = v:true
If there is no g:termdebug_config you can use: >
let g:termdebug_use_prompt = 1
let g:termdebug_use_prompt = v:true
<
However, the latter form will be deprecated in future releases.
@ -1544,26 +1544,26 @@ 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: >
let g:termdebug_config['map_K'] = 0
let g:termdebug_config['map_K'] = v:false
If there is no g:termdebug_config you can use: >
let g:termdebug_map_K = 0
let g:termdebug_map_K = v:false
<
However, the latter form will be deprecated in future releases.
*termdebug_map_minus*
The - key is normally mapped to |:Down| unless a buffer local mapping to the -
key already exists. If you do not want this use: >
let g:termdebug_config['map_minus'] = 0
let g:termdebug_config['map_minus'] = v:false
<
*termdebug_map_plus*
The + key is normally mapped to |:Up| unless a buffer local mapping to the +
key already exists. If you do not want this use: >
let g:termdebug_config['map_plus'] = 0
let g:termdebug_config['map_plus'] = v:false
<
*termdebug_disasm_window*
If you want the Asm window shown by default, set the "disasm_window" flag to
1. The "disasm_window_height" entry can be used to set the window height: >
let g:termdebug_config['disasm_window'] = 1
let g:termdebug_config['disasm_window'] = v:true
let g:termdebug_config['disasm_window_height'] = 15
If there is no g:termdebug_config you can use: >
let g:termdebug_disasm_window = 15
@ -1579,7 +1579,7 @@ the height option won't be used).
If you want the Var window shown by default, set the "variables_window" flag
to 1. The "variables_window_height" entry can be used to set the window
height: >
let g:termdebug_config['variables_window'] = 1
let g:termdebug_config['variables_window'] = v:true
let g:termdebug_config['variables_window_height'] = 15
If there is no g:termdebug_config you can use: >
let g:termdebug_variables_window = 15

79
runtime/pack/dist/opt/termdebug/plugin/termdebug.vim vendored
View File

@ -15,7 +15,7 @@ vim9script
# There are two ways to run gdb:
# - In a terminal window; used if possible, does not work on MS-Windows
# Not used when g:termdebug_use_prompt is set to 1.
# Not used when g:termdebug_use_prompt is set to true.
# - Using a "prompt" buffer; may use a terminal window for the program
# For both the current window is used to view source code and shows the
@ -90,7 +90,7 @@ var varbufname: string
var asmbufnr: number
var asmbufname: string
var promptbufnr: number
# This is for the "debugged-program" thing
# 'pty' refers to the "debugged-program" pty
var ptybufnr: number
var ptybufname: string
var commbufnr: number
@ -276,6 +276,18 @@ def DeprecationWarnings()
\ is deprecated and will be removed in the future. See ':h g:termdebug_config' for alternatives.")
endif
# termdebug config types
if exists('g:termdebug_config') && !empty(g:termdebug_config)
for key in keys(g:termdebug_config)
if index(['disasm_window', 'variables_window', 'use_prompt', 'map_K', 'map_minus', 'map_plus'], key) != -1
if typename(g:termdebug_config[key]) == 'number'
var val = g:termdebug_config[key]
Echowarn($"Deprecation Warning: 'g:termdebug_config[\"{key}\"] = {val}' will be deprecated.
\ Please use 'g:termdebug_config[\"{key}\"] = {val != 0}'" )
endif
endif
endfor
endif
enddef
# Take a breakpoint number as used by GDB and turn it into an integer.
@ -353,7 +365,7 @@ def StartDebug_internal(dict: dict<any>)
endif
# Uncomment this line to write logging in "debuglog".
# call ch_logfile('debuglog', 'w')
# ch_logfile('debuglog', 'w')
# Assume current window is the source code window
sourcewin = win_getid()
@ -444,7 +456,7 @@ def CreateCommunicationPty(): string
# Create a hidden terminal window to communicate with gdb
commbufnr = term_start('NONE', {
term_name: commbufname,
out_cb: function('CommOutput'),
out_cb: CommOutput,
hidden: 1
})
if commbufnr == 0
@ -603,7 +615,7 @@ def StartDebug_term(dict: dict<any>)
return
endif
job_setoptions(term_getjob(gdbbufnr), {exit_cb: function('EndDebug')})
job_setoptions(term_getjob(gdbbufnr), {exit_cb: EndDebug})
# Set the filetype, this can be used to add mappings.
set filetype=termdebug
@ -627,8 +639,8 @@ def StartDebug_prompt(dict: dict<any>)
set buftype=prompt
exe $"file {gdbbufname}"
prompt_setcallback(promptbufnr, function('PromptCallback'))
prompt_setinterrupt(promptbufnr, function('PromptInterrupt'))
prompt_setcallback(promptbufnr, PromptCallback)
prompt_setinterrupt(promptbufnr, PromptInterrupt)
if vvertical
# Assuming the source code window will get a signcolumn, use two more
@ -655,8 +667,8 @@ def StartDebug_prompt(dict: dict<any>)
ch_log($'executing "{join(gdb_cmd)}"')
gdbjob = job_start(gdb_cmd, {
exit_cb: function('EndDebug'),
out_cb: function('GdbOutCallback'),
exit_cb: EndDebug,
out_cb: GdbOutCallback
})
if job_status(gdbjob) != "run"
Echoerr('Failed to start gdb')
@ -1119,9 +1131,9 @@ def CommOutput(chan: channel, message: string)
if msg =~ '^\(\*stopped\|\*running\|=thread-selected\)'
HandleCursor(msg)
elseif msg =~ '^\^done,bkpt=' || msg =~ '^=breakpoint-created,'
HandleNewBreakpoint(msg, 0)
HandleNewBreakpoint(msg, false)
elseif msg =~ '^=breakpoint-modified,'
HandleNewBreakpoint(msg, 1)
HandleNewBreakpoint(msg, true)
elseif msg =~ '^=breakpoint-deleted,'
HandleBreakpointDelete(msg)
elseif msg =~ '^=thread-group-started'
@ -1225,10 +1237,10 @@ def InstallCommands()
if pup
&mousemodel = 'popup_setpos'
an 1.200 PopUp.-SEP3- <Nop>
an 1.210 PopUp.Set\ breakpoint :Break<CR>
an 1.220 PopUp.Clear\ breakpoint :Clear<CR>
an 1.230 PopUp.Run\ until :Until<CR>
an 1.240 PopUp.Evaluate :Evaluate<CR>
an 1.210 PopUp.Set\ breakpoint <cmd>Break<CR>
an 1.220 PopUp.Clear\ breakpoint <cmd>Clear<CR>
an 1.230 PopUp.Run\ until <cmd>Until<CR>
an 1.240 PopUp.Evaluate <cmd>Evaluate<CR>
endif
endif
@ -1311,7 +1323,6 @@ def DeleteCommands()
endif
endfor
win_gotoid(curwinid)
# winbar_winids = []
&mousemodel = saved_mousemodel
try
@ -1599,14 +1610,17 @@ def GotoSourcewinOrCreateIt()
enddef
def GetDisasmWindow(): number
if exists('g:termdebug_config')
return get(g:termdebug_config, 'disasm_window', 0)
def GetDisasmWindow(): bool
# TODO Remove the deprecated features after 1 Jan 2025.
var val: any
if exists('g:termdebug_config') && has_key(g:termdebug_config, 'disasm_window')
val = g:termdebug_config['disasm_window']
elseif exists('g:termdebug_disasm_window')
val = g:termdebug_disasm_window
else
val = false
endif
if exists('g:termdebug_disasm_window')
return g:termdebug_disasm_window
endif
return 0
return typename(val) == 'number' ? val != 0 : val
enddef
def GetDisasmWindowHeight(): number
@ -1669,14 +1683,17 @@ def GotoAsmwinOrCreateIt()
endif
enddef
def GetVariablesWindow(): number
if exists('g:termdebug_config')
return get(g:termdebug_config, 'variables_window', 0)
def GetVariablesWindow(): bool
# TODO Remove the deprecated features after 1 Jan 2025.
var val: any
if exists('g:termdebug_config') && has_key(g:termdebug_config, 'variables_window')
val = g:termdebug_config['variables_window']
elseif exists('g:termdebug_variables_window')
val = g:termdebug_variables_window
else
val = false
endif
if exists('g:termdebug_disasm_window')
return g:termdebug_variables_window
endif
return 0
return typename(val) == 'number' ? val != 0 : val
enddef
def GetVariablesWindowHeight(): number
@ -1857,7 +1874,7 @@ enddef
# Handle setting a breakpoint
# Will update the sign that shows the breakpoint
def HandleNewBreakpoint(msg: string, modifiedFlag: any)
def HandleNewBreakpoint(msg: string, modifiedFlag: bool)
var nr = ''
if msg !~ 'fullname='

51
src/testdir/test_termdebug.vim
View File

@ -160,7 +160,7 @@ func Test_termdebug_basic()
call WaitForAssert({-> assert_equal(1, winnr('$'))})
call assert_equal([], sign_getplaced('', #{group: 'TermDebug'})[0].signs)
for use_prompt in [0, 1]
for use_prompt in [v:true, v:false]
let g:termdebug_config = {}
let g:termdebug_config['use_prompt'] = use_prompt
TermdebugCommand ./XTD_basic arg args
@ -365,7 +365,7 @@ function Test_termdebug_save_restore_variables()
" We want termdebug to overwrite 'K' map but not '+' map.
let g:termdebug_config = {}
let g:termdebug_config['map_K'] = 1
let g:termdebug_config['map_K'] = v:true
Termdebug
call WaitForAssert({-> assert_equal(3, winnr('$'))})
@ -394,7 +394,7 @@ function Test_termdebug_sanity_check()
for key in keys(s:dict)
let s:filename = s:dict[key]
let g:termdebug_config[key] = 1
let g:termdebug_config[key] = v:true
let s:error_message = "You have a file/folder named '" .. s:filename .. "'"
" Write dummy file with bad name
@ -422,4 +422,49 @@ function Test_termdebug_double_termdebug_instances()
:%bw!
endfunction
function Test_termdebug_config_types()
" TODO Remove the deprecated features after 1 Jan 2025.
let g:termdebug_config = {}
let s:error_message = 'Deprecation Warning:'
call assert_true(maparg('K', 'n', 0, 1)->empty())
for key in ['disasm_window', 'variables_window', 'map_K']
for val in [0, 1, v:true, v:false]
let g:termdebug_config[key] = val
Termdebug
" Type check: warning is displayed
if typename(val) == 'number'
call WaitForAssert({-> assert_true(execute('messages') =~ s:error_message)})
endif
" Test on g:termdebug_config keys
if val && key != 'map_K'
call WaitForAssert({-> assert_equal(4, winnr('$'))})
call remove(g:termdebug_config, key)
else
call WaitForAssert({-> assert_equal(3, winnr('$'))})
endif
" Test on mapping
if key == 'map_K'
if val
call assert_equal(':Evaluate<CR>', maparg('K', 'n', 0, 1).rhs)
else
call assert_true(maparg('K', 'n', 0, 1)->empty())
endif
endif
" Shutoff termdebug
wincmd t
quit!
call WaitForAssert({-> assert_equal(1, winnr('$'))})
:%bw!
endfor
endfor
unlet g:termdebug_config
endfunction
" vim: shiftwidth=2 sts=2 expandtab

2
src/version.c
View File

@ -704,6 +704,8 @@ static char *(features[]) =
static int included_patches[] =
{ /* Add new patch number below this line */
/**/
607,
/**/
606,
/**/