Merge pull request #768 from puremourning/edit-breakpoints

Allow editing of breakpoint options in breakpoints window

Author: mergify[bot]

README.md

@@ -910,12 +910,14 @@ The following mappings apply by default in the breakpoints window:
 * `t`, `<F9>` - toggle, i.e. enable/disable breakpoint
 * `T` - toggle, i.e. enable/disable ALL breakpoints
 * `dd`, `<Del>` - delete the current breakpoint
+* `cc`, `C` - edit the current breakpoint options
 * `i`, `a`, `o` - add a new line breakpoint
 * `I`, `A`, `O` - add a new function breakpoint
 * `<Enter>` or double-click - jump to the line breakpoint
 
 A WinBar is provided (where supported) too. This adds functions like
-saving/restoring sessions and clearing all breakpoints too.
+saving/restoring sessions, clearing all breakpoints, and resetting the exception
+breakpoints options.
 
 ### Line breakpoints
 

autoload/vimspector.vim

@@ -173,33 +173,18 @@ function! vimspector#ClearBreakpoints() abort
   py3 _vimspector_session.ClearBreakpoints()
 endfunction
 
-let s:extended_breakpoint_properties = [
-      \ { 'prop': 'condition', 'msg': 'Enter condition expression' },
-      \ { 'prop': 'hitCondition', 'msg': 'Enter hit count expression' },
-      \ { 'prop': 'logMessage',
-      \   'msg': 'Enter log expression (to make log point)' },
-    \ ]
-
-function! s:AskForInput( ... ) abort
-  return py3eval( '__import__( "vimspector", fromlist=[ "utils" ] )'
-                \ . '.utils.AskForInput( *vim.eval( "a:000" ) )' )
+function! vimspector#ResetExceptionBreakpoints() abort
+  if !s:Enabled()
+    return
+  endif
+  py3 _vimspector_session.ResetExceptionBreakpoints()
 endfunction
 
-function! s:GetAdvancedBreakpointOptions() abort
-  let options = {}
-  for spec in s:extended_breakpoint_properties
-    let response = s:AskForInput( spec.msg . ': ' )
-    if response is s:None
-      return s:None
-    elseif response !=# ''
-      let options[ spec.prop ] = response
-    endif
-  endfor
-
-  return options
+function! s:GetAdvancedBreakpointOptions( ... ) abort
+  return py3eval( '__import__( "vimspector", fromlist=[ "breakpoints" ] )'
+                \ . '.breakpoints.GetAdvancedBreakpointOptions()' )
 endfunction
 
-
 function! vimspector#ToggleAdvancedBreakpoint() abort
   let options = s:GetAdvancedBreakpointOptions()
   if options is s:None
@@ -220,6 +205,11 @@ function! vimspector#ToggleBreakpoint( ... ) abort
   py3 _vimspector_session.ToggleBreakpoint( vim.eval( 'options' ) )
 endfunction
 
+function! s:AskForInput( ... ) abort
+  return py3eval( '__import__( "vimspector", fromlist=[ "utils" ] )'
+                \ . '.utils.AskForInput( *vim.eval( "a:000" ) )' )
+endfunction
+
 function! vimspector#SetAdvancedLineBreakpoint() abort
   if !s:Enabled()
     return
@@ -592,6 +582,13 @@ function! vimspector#JumpToBreakpointViewBreakpoint() abort
   py3 _vimspector_session.JumpToBreakpointViewBreakpoint()
 endfunction
 
+function! vimspector#EditBreakpointOptionsViewBreakpoint() abort
+  if !s:Enabled()
+    return
+  endif
+  py3 _vimspector_session.EditBreakpointOptionsViewBreakpoint()
+endfunction
+
 function! vimspector#JumpToNextBreakpoint() abort
   if !s:Enabled()
     return

python3/vimspector/breakpoints.py

@@ -81,9 +81,10 @@ def _UpdateView( self, breakpoint_list, show=True ):
           'toggle': 'ToggleBreakpointViewBreakpoint',
           'toggle_all': 'ToggleAllBreakpointsViewBreakpoint',
           'delete': 'DeleteBreakpointViewBreakpoint',
+          'edit': 'EditBreakpointOptionsViewBreakpoint',
           'jump_to': 'JumpToBreakpointViewBreakpoint',
           'add_line': 'SetAdvancedLineBreakpoint',
-          'add_func': 'AddAdvancedFunctionBreakpoint'
+          'add_func': 'AddAdvancedFunctionBreakpoint',
         }
         for key, func in groups.items():
           for mapping in utils.GetVimList( mappings, key ):
@@ -100,27 +101,7 @@ def _UpdateView( self, breakpoint_list, show=True ):
 
       utils.SetSyntax( '', 'vimspector-breakpoints', self._buffer )
 
-      if utils.UseWinBar():
-        vim.command( 'nnoremenu <silent> 1.1 WinBar.Delete '
-                     ':call vimspector#DeleteBreakpointViewBreakpoint()<CR>' )
-        vim.command( 'nnoremenu <silent> 1.2 WinBar.Toggle '
-                     ':call vimspector#ToggleBreakpointViewBreakpoint()<CR>' )
-        vim.command( 'nnoremenu <silent> 1.2 WinBar.*Toggle '
-                     ':call'
-                       ' vimspector#ToggleAllBreakpointsViewBreakpoint()<CR>' )
-        vim.command( 'nnoremenu <silent> 1.3 WinBar.Jump\\ To '
-                     ':call vimspector#JumpToBreakpointViewBreakpoint()<CR>' )
-        # TODO: Add tests for this function
-        vim.command( 'nnoremenu <silent> 1.4 WinBar.+Line '
-                     ':call vimspector#SetAdvancedLineBreakpoint()<CR>' )
-        vim.command( 'nnoremenu <silent> 1.4 WinBar.+Function '
-                     ':call vimspector#AddAdvancedFunctionBreakpoint()<CR>' )
-        vim.command( 'nnoremenu <silent> 1.4 WinBar.Clear '
-                     ':call vimspector#ClearBreakpoints()<CR>' )
-        vim.command( 'nnoremenu <silent> 1.4 WinBar.Save '
-                     ':call vimspector#WriteSessionFile()<CR>' )
-        vim.command( 'nnoremenu <silent> 1.4 WinBar.Load '
-                     ':call vimspector#ReadSessionFile()<CR>' )
+      self._RenderWinBar()
 
       # we want to maintain the height of the window
       self._win.options[ "winfixheight" ] = True
@@ -141,6 +122,28 @@ def FormatEntry( el ):
           utils.SetBufferContents( self._buffer,
                                    list( map( FormatEntry, breakpoint_list ) ) )
 
+
+  def _RenderWinBar( self ):
+    if not utils.UseWinBar():
+      return
+
+    if not self._HasWindow():
+      return
+
+    with utils.LetCurrentWindow( self._win ):
+      utils.SetWinBar(
+        ( 'Del', 'vimspector#DeleteBreakpointViewBreakpoint()' ),
+        ( 'On/Off', 'vimspector#ToggleBreakpointViewBreakpoint()' ),
+        ( 'Edit', 'vimspector#EditBreakpointOptionsViewBreakpoint()' ),
+        ( '+Line', 'vimspector#SetAdvancedLineBreakpoint()' ),
+        ( '+Func', 'vimspector#AddAdvancedFunctionBreakpoint()' ),
+        ( 'Clr All', 'vimspector#ClearBreakpoints()' ),
+        ( 'Clr Excp', 'vimspector#ResetExceptionBreakpoints()' ),
+        ( 'Save', 'vimspector#WriteSessionFile()' ),
+        ( 'Load', 'vimspector#ReadSessionFile()' ),
+      )
+
+
   def CloseBreakpoints( self ):
     if not self._HasWindow():
       return
@@ -336,6 +339,26 @@ def JumpToBreakpointViewBreakpoint( self ):
 
     _JumpToBreakpoint( bp )
 
+  def EditBreakpointOptionsViewBreakpoint( self ):
+    vbp = self._breakpoints_view.GetBreakpointForLine()
+    if not vbp:
+      return
+
+    # Try to find the actual breakpoint
+    bp, index = self._FindLineBreakpoint( vbp.get( 'filename' ),
+                                          vbp.get( 'lnum' ) )
+
+    if not bp:
+      return
+
+    options = GetAdvancedBreakpointOptions( bp[ 'options' ] )
+    if options is None:
+      return
+
+    self.SetLineBreakpoint( vbp[ 'filename' ], vbp[ 'lnum' ], options )
+    utils.UserMessage( "Breakpoint updated." )
+
+
   def JumpToNextBreakpoint( self, reverse=False ):
     bps = self._breakpoints_view._breakpoint_list
     if not bps:
@@ -440,6 +463,12 @@ def ClearBreakpoints( self ):
     self.UpdateUI()
 
 
+  def ResetExceptionBreakpoints( self ):
+    # TODO: Should exceptoni breakpoints be per-session!?
+    self._exception_breakpoints = None
+    self.UpdateUI()
+
+
   def _FindLineBreakpoint( self, file_name, line ):
     for bp, index in self._AllBreakpointsOnLine( file_name, line ):
       return bp, index
@@ -1172,3 +1201,27 @@ def _SignToLine( self, file_name, bp ):
       bp[ 'line' ] = int( signs[ 0 ][ 'signs' ][ 0 ][ 'lnum' ] )
 
     return
+
+
+_extended_breakpoint_properties = [
+  { 'prop': 'condition', 'msg': 'Enter condition expression' },
+  { 'prop': 'hitCondition', 'msg': 'Enter hit count expression' },
+  { 'prop': 'logMessage',
+    'msg': 'Enter log expression (to make log point)' },
+]
+
+
+def GetAdvancedBreakpointOptions( existing_options = None ):
+  options = {}
+  if existing_options:
+    options.update( existing_options )
+
+  for spec in _extended_breakpoint_properties:
+    response = utils.AskForInput( spec[ 'msg' ] + ': ',
+                                  options.get( spec[ 'prop' ] ) )
+    if response is None:
+      return None
+    elif response:
+      options[ spec[ 'prop' ] ] = response
+
+  return options

python3/vimspector/debug_session.py

@@ -2093,6 +2093,9 @@ def DeleteBreakpointViewBreakpoint( self ):
   def JumpToBreakpointViewBreakpoint( self ):
     self._breakpoints.JumpToBreakpointViewBreakpoint()
 
+  def EditBreakpointOptionsViewBreakpoint( self ):
+    self._breakpoints.EditBreakpointOptionsViewBreakpoint()
+
   def JumpToNextBreakpoint( self ):
     self._breakpoints.JumpToNextBreakpoint()
 
@@ -2170,6 +2173,9 @@ def ClearLineBreakpoint( self, file_name, line_num ):
   def ClearBreakpoints( self ):
     return self._breakpoints.ClearBreakpoints()
 
+  def ResetExceptionBreakpoints( self ):
+    return self._breakpoints.ResetExceptionBreakpoints()
+
   def AddFunctionBreakpoint( self, function, options ):
     return self._breakpoints.AddFunctionBreakpoint( function, options )
 

python3/vimspector/settings.py

@@ -100,9 +100,10 @@
       'toggle': [ 't', '<F9>' ],
       'toggle_all': [ 'T' ],
       'delete': [ 'dd', '<Del>' ],
+      'edit': [ 'cc', 'C' ],
       'add_line': [ 'i', 'a', 'o', '<Insert>' ],
       'add_func': [ 'I', 'A', 'O', '<leader><Insert>' ],
-      'jump_to': [ '<2-LeftMouse>', '<Enter>' ]
+      'jump_to': [ '<2-LeftMouse>', '<Enter>' ],
     }
   },
 

support/test/python/simple_python/.vimspector.json

@@ -126,6 +126,17 @@
         }
       }
     },
+    "run - no exception bp override": {
+      "adapter": "debugpy",
+      "configuration": {
+        "request": "launch",
+        "type": "python",
+        "cwd": "${workspaceRoot}",
+        "program": "${file}",
+        "stopOnEntry": false,
+        "console": "integratedTerminal"
+      }
+    },
     "run - debugpy-python2": {
       "adapter": "debugpy-python2",
       "configuration": {

tests/breakpoints.test.vim

@@ -569,6 +569,118 @@ function! Test_Conditional_Line_Breakpoint()
   %bwipeout!
 endfunction
 
+function! Test_Conditional_Line_Breakpoint_Edit()
+  lcd testdata/cpp/simple
+  edit simple.cpp
+  call setpos( '.', [ 0, 16, 1 ] )
+
+  call vimspector#test#signs#AssertCursorIsAtLineInBuffer( 'simple.cpp', 16, 1 )
+  call vimspector#test#signs#AssertSignGroupEmptyAtLine( 'VimspectorBP', 16 )
+
+  " Add breakpoint using API:
+  "  - add it using a condition which doesn't match (argc == 0)
+  "  - then edit it to use a condition which matches (argc == 1)
+  call vimspector#SetLineBreakpoint( 'simple.cpp', 17,
+                                   \ { 'condition': 'argc == 0' } )
+  call vimspector#test#signs#AssertSignGroupSingletonAtLine(
+        \ 'VimspectorBP',
+        \ 17,
+        \ 'vimspectorBPCond',
+        \ 9 )
+
+  call vimspector#ListBreakpoints()
+  call s:CheckBreakpointView( [
+    \ 'simple.cpp:17 Line breakpoint - ENABLED: {"condition": "argc == 0"}'
+    \ ] )
+  let bname = bufname( winbufnr( g:vimspector_session_windows.breakpoints ) )
+  call vimspector#test#signs#AssertCursorIsAtLineInBuffer(
+        \ bname,
+        \ 1,
+        \ 1 )
+
+  call feedkeys( 'cc'
+               \ .. "\<C-u>argc == 1\<CR>"
+               \ .. "1\<CR>"
+               \ .. "\<CR>",
+               \ 'xt' )
+
+  call s:CheckBreakpointView( [
+    \ 'simple.cpp:17 Line breakpoint - ENABLED: {"condition": "argc == 1", "hitCondition": "1"}'
+    \ ] )
+
+  wincmd p
+  call vimspector#ListBreakpoints()
+  call setpos( '.', [ 0, 1, 1 ] )
+
+  " Start debugging
+  call vimspector#LaunchWithSettings( #{ configuration: 'run-to-breakpoint' } )
+
+  " Condition matches on line 17
+  call vimspector#test#signs#AssertCursorIsAtLineInBuffer( 'simple.cpp', 17, 1 )
+
+  call vimspector#test#setup#Reset()
+
+  lcd -
+  %bwipeout!
+endfunction
+
+function! Test_Conditional_Line_Breakpoint_Edit_While_Connected()
+  lcd testdata/cpp/simple
+  edit simple.cpp
+  call setpos( '.', [ 0, 16, 1 ] )
+
+  call vimspector#Launch()
+  " break on main
+  call vimspector#test#signs#AssertCursorIsAtLineInBuffer(
+        \ 'simple.cpp',
+        \ s:break_main_line, 1 )
+
+  " Add breakpoint using API:
+  "  - add it using a condition which doesn't match (argc == 0)
+  "  - then edit it to use a condition which matches (argc == 1)
+  call vimspector#SetLineBreakpoint( 'simple.cpp', 17,
+                                   \ { 'condition': 'argc == 0' } )
+  call WaitForAssert( { ->
+        \ vimspector#test#signs#AssertSignGroupSingletonAtLine(
+          \ 'VimspectorBP',
+          \ 17,
+          \ 'vimspectorBPCond',
+          \ 9 ) } )
+
+  call vimspector#ListBreakpoints()
+  call s:CheckBreakpointView( [
+    \ 'simple.cpp:17 Line breakpoint - VERIFIED: {"condition": "argc == 0"}'
+    \ ] )
+  let bname = bufname( winbufnr( g:vimspector_session_windows.breakpoints ) )
+  call vimspector#test#signs#AssertCursorIsAtLineInBuffer(
+        \ bname,
+        \ 1,
+        \ 1 )
+
+  call feedkeys( 'cc'
+               \ .. "\<C-u>argc == 1\<CR>"
+               \ .. "1\<CR>"
+               \ .. "\<CR>",
+               \ 'xt' )
+
+  call s:CheckBreakpointView( [
+    \ 'simple.cpp:17 Line breakpoint - VERIFIED: {"condition": "argc == 1", "hitCondition": "1"}'
+    \ ] )
+
+  wincmd p
+  call vimspector#ListBreakpoints()
+  call setpos( '.', [ 0, 1, 1 ] )
+
+  " Condition matches on line 17
+  call vimspector#Continue()
+  call vimspector#test#signs#AssertCursorIsAtLineInBuffer( 'simple.cpp', 17, 1 )
+  call vimspector#test#setup#Reset()
+
+  lcd -
+  %bwipeout!
+endfunction
+
+
 function! SetUp_Test_Conditional_Line_Breakpoint_Disable()
   let g:vimspector_enable_mappings = 'HUMAN'
   call s:PushSetting( 'vimspector_toggle_disables_breakpoint', 1 )