debug 1.5.0 → 1.6.0

data/lib/debug/source_repository.rb

@@ -14,10 +14,19 @@ module DEBUGGER__
       def initialize
         # cache
         @cmap = ObjectSpace::WeakMap.new
+        @loaded_file_map = {} # path => nil
       end
 
       def add iseq, src
         # do nothing
+        if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
+          if @loaded_file_map.has_key? path
+            return path, true # reloaded
+          else
+            @loaded_file_map[path] = path
+            return path, false
+          end
+        end
       end
 
       def get iseq
@@ -55,10 +64,14 @@ module DEBUGGER__
 
       def add iseq, src
         if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
+          reloaded = @files.has_key? path
           add_path path
+          return path, reloaded
         elsif src
           add_iseq iseq, src
         end
+
+        nil
       end
 
       private def all_iseq iseq, rs = []

data/lib/debug/thread_client.rb

@@ -6,9 +6,26 @@ require 'pp'
 require_relative 'color'
 
 module DEBUGGER__
+  M_INSTANCE_VARIABLES = method(:instance_variables).unbind
+  M_INSTANCE_VARIABLE_GET = method(:instance_variable_get).unbind
+  M_CLASS = method(:class).unbind
+  M_SINGLETON_CLASS = method(:singleton_class).unbind
+  M_KIND_OF_P = method(:kind_of?).unbind
+  M_RESPOND_TO_P = method(:respond_to?).unbind
+  M_METHOD = method(:method).unbind
+  M_OBJECT_ID = method(:object_id).unbind
+
   module SkipPathHelper
     def skip_path?(path)
-      !path || skip_internal_path?(path) || (skip_paths = CONFIG[:skip_path]) && skip_paths.any?{|skip_path| path.match?(skip_path)}
+      !path ||
+      CONFIG.skip? ||
+      ThreadClient.current.management? ||
+      skip_internal_path?(path) ||
+      skip_config_skip_path?(path)
+    end
+
+    def skip_config_skip_path?(path)
+      (skip_paths = CONFIG[:skip_path]) && skip_paths.any?{|skip_path| path.match?(skip_path)}
     end
 
     def skip_internal_path?(path)
@@ -34,7 +51,7 @@ module DEBUGGER__
     include Color
     include SkipPathHelper
 
-    attr_reader :thread, :id, :recorder
+    attr_reader :thread, :id, :recorder, :check_bp_fulfillment_map
 
     def location
       current_frame&.location
@@ -50,7 +67,8 @@ module DEBUGGER__
       call_identifier_str =
         case frame.frame_type
         when :block
-          level, block_loc, args = frame.block_identifier
+          level, block_loc = frame.block_identifier
+          args = frame.parameters_info
 
           if !args.empty?
             args_str = " {|#{assemble_arguments(args)}|}"
@@ -58,7 +76,8 @@ module DEBUGGER__
 
           "#{colorize_blue("block")}#{args_str} in #{colorize_blue(block_loc + level)}"
         when :method
-          ci, args = frame.method_identifier
+          ci = frame.method_identifier
+          args = frame.parameters_info
 
           if !args.empty?
             args_str = "(#{assemble_arguments(args)})"
@@ -95,6 +114,9 @@ module DEBUGGER__
       @obj_map = {} # { object_id => obj } for CDP
       @recorder = nil
       @mode = :waiting
+      @current_frame_index = 0
+      # every thread should maintain its own CheckBreakpoint fulfillment state
+      @check_bp_fulfillment_map = {} # { check_bp => boolean }
       set_mode :running
       thr.instance_variable_set(:@__thread_client_id, id)
 
@@ -114,6 +136,7 @@ module DEBUGGER__
     end
 
     def set_mode mode
+      debug_mode(@mode, mode)
       # STDERR.puts "#{@mode} => #{mode} @ #{caller.inspect}"
       # pp caller
 
@@ -177,6 +200,7 @@ module DEBUGGER__
     end
 
     def << req
+      debug_cmd(req)
       @q_cmd << req
     end
 
@@ -187,6 +211,7 @@ module DEBUGGER__
     end
 
     def event! ev, *args
+      debug_event(ev, args)
       @q_evt << [self, @output, ev, generate_info, *args]
       @output = []
     end
@@ -232,6 +257,7 @@ module DEBUGGER__
 
     def suspend event, tp = nil, bp: nil, sig: nil, postmortem_frames: nil, replay_frames: nil, postmortem_exc: nil
       return if management?
+      debug_suspend(event)
 
       @current_frame_index = 0
 
@@ -266,7 +292,7 @@ module DEBUGGER__
 
       if event != :pause
         show_src
-        show_frames CONFIG[:show_frames] || 2
+        show_frames CONFIG[:show_frames]
 
         set_mode :waiting
 
@@ -413,55 +439,64 @@ module DEBUGGER__
       raise if re_raise
     end
 
-    def show_src(frame_index: @current_frame_index,
-                 update_line: false,
-                 max_lines: CONFIG[:show_src_lines] || 10,
-                 start_line: nil,
-                 end_line: nil,
-                 dir: +1)
-      if @target_frames && frame = @target_frames[frame_index]
-        if file_lines = frame.file_lines
-          frame_line = frame.location.lineno - 1
-
-          lines = file_lines.map.with_index do |e, i|
-            cur = i == frame_line ? '=>' : '  '
-            line = colorize_dim('%4d|' % (i+1))
-            "#{cur}#{line} #{e}"
-          end
+    def get_src(frame,
+                max_lines:,
+                start_line: nil,
+                end_line: nil,
+                dir: +1)
+      if file_lines = frame.file_lines
+        frame_line = frame.location.lineno - 1
+
+        lines = file_lines.map.with_index do |e, i|
+          cur = i == frame_line ? '=>' : '  '
+          line = colorize_dim('%4d|' % (i+1))
+          "#{cur}#{line} #{e}"
+        end
 
-          unless start_line
-            if frame.show_line
-              if dir > 0
-                start_line = frame.show_line
-              else
-                end_line = frame.show_line - max_lines
-                start_line = [end_line - max_lines, 0].max
-              end
+        unless start_line
+          if frame.show_line
+            if dir > 0
+              start_line = frame.show_line
             else
-              start_line = [frame_line - max_lines/2, 0].max
+              end_line = frame.show_line - max_lines
+              start_line = [end_line - max_lines, 0].max
             end
+          else
+            start_line = [frame_line - max_lines/2, 0].max
           end
+        end
 
-          unless end_line
-            end_line = [start_line + max_lines, lines.size].min
-          end
+        unless end_line
+          end_line = [start_line + max_lines, lines.size].min
+        end
 
+        if start_line != end_line && max_lines
+          [start_line, end_line, lines]
+        end
+      else # no file lines
+        nil
+      end
+    rescue Exception => e
+      p e
+      pp e.backtrace
+      exit!
+    end
+
+    def show_src(frame_index: @current_frame_index, update_line: false, max_lines: CONFIG[:show_src_lines], **options)
+      if frame = get_frame(frame_index)
+        start_line, end_line, lines = *get_src(frame, max_lines: max_lines, **options)
+
+        if start_line
           if update_line
             frame.show_line = end_line
           end
 
-          if start_line != end_line && max_lines
-            puts "[#{start_line+1}, #{end_line}] in #{frame.pretty_path}" if !update_line && max_lines != 1
-            puts lines[start_line ... end_line]
-          end
-        else # no file lines
+          puts "[#{start_line+1}, #{end_line}] in #{frame.pretty_path}" if !update_line && max_lines != 1
+          puts lines[start_line...end_line]
+        else
           puts "# No sourcefile available for #{frame.path}"
         end
       end
-    rescue Exception => e
-      p e
-      pp e.backtrace
-      exit!
     end
 
     def current_frame
@@ -513,8 +548,8 @@ module DEBUGGER__
 
     def show_ivars pat
       if s = current_frame&.self
-        s.instance_variables.sort.each{|iv|
-          value = s.instance_variable_get(iv)
+        M_INSTANCE_VARIABLES.bind_call(s).sort.each{|iv|
+          value = M_INSTANCE_VARIABLE_GET.bind_call(s, iv)
           puts_variable_info iv, value, pat
         }
       end
@@ -523,10 +558,10 @@ module DEBUGGER__
     def show_consts pat, only_self: false
       if s = current_frame&.self
         cs = {}
-        if s.kind_of? Module
+        if M_KIND_OF_P.bind_call(s, Module)
           cs[s] = :self
         else
-          s = s.class
+          s = M_CLASS.bind_call(s)
           cs[s] = :self unless only_self
         end
 
@@ -564,7 +599,7 @@ module DEBUGGER__
       return if pat && pat !~ label
 
       begin
-        inspected = obj.inspect
+        inspected = DEBUGGER__.safe_inspect(obj)
       rescue Exception => e
         inspected = e.inspect
       end
@@ -623,15 +658,11 @@ module DEBUGGER__
       if @target_frames && (max ||= @target_frames.size) > 0
         frames = []
         @target_frames.each_with_index{|f, i|
-          next if pattern && !(f.name.match?(pattern) || f.location_str.match?(pattern))
-          next if CONFIG[:skip_path] && CONFIG[:skip_path].any?{|pat|
-            case pat
-            when String
-              f.location_str.start_with?(pat)
-            when Regexp
-              f.location_str.match?(pat)
-            end
-          }
+          # we need to use FrameInfo#matchable_location because #location_str is for display
+          # and it may change based on configs (e.g. use_short_path)
+          next if pattern && !(f.name.match?(pattern) || f.matchable_location.match?(pattern))
+          # avoid using skip_path? because we still want to display internal frames
+          next if skip_config_skip_path?(f.matchable_location)
 
           frames << [i, f]
         }
@@ -668,18 +699,25 @@ module DEBUGGER__
         o = Output.new(@output)
 
         locals = current_frame&.local_variables
-        klass  = (obj.class == Class || obj.class == Module ? obj : obj.class)
 
-        o.dump("constants", obj.constants) if obj.respond_to?(:constants)
+        klass = M_CLASS.bind_call(obj)
+        klass = obj if Class == klass || Module == klass
+
+        o.dump("constants", obj.constants) if M_RESPOND_TO_P.bind_call(obj, :constants)
         outline_method(o, klass, obj)
-        o.dump("instance variables", obj.instance_variables)
+        o.dump("instance variables", M_INSTANCE_VARIABLES.bind_call(obj))
         o.dump("class variables", klass.class_variables)
         o.dump("locals", locals.keys) if locals
       end
     end
 
     def outline_method(o, klass, obj)
-      singleton_class = begin obj.singleton_class; rescue TypeError; nil end
+      begin
+        singleton_class = M_SINGLETON_CLASS.bind_call(obj)
+      rescue TypeError
+        singleton_class = nil
+      end
+
       maps = class_method_map((singleton_class || klass).ancestors)
       maps.each do |mod, methods|
         name = mod == singleton_class ? "#{klass}.methods" : "#{mod}#methods"
@@ -699,6 +737,23 @@ module DEBUGGER__
 
     ## cmd: breakpoint
 
+    # TODO: support non-ASCII Constant name
+    def constant_name? name
+      case name
+      when /\A::\b/
+        constant_name? $~.post_match
+      when /\A[A-Z]\w*/
+        post = $~.post_match
+        if post.empty?
+          true
+        else
+          constant_name? post
+        end
+      else
+        false
+      end
+    end
+
     def make_breakpoint args
       case args.first
       when :method
@@ -706,9 +761,24 @@ module DEBUGGER__
         bp = MethodBreakpoint.new(current_frame.eval_binding, klass_name, op, method_name, cond: cond, command: cmd, path: path)
         begin
           bp.enable
+        rescue NameError => e
+          if bp.klass
+            puts "Unknown method name: \"#{e.name}\""
+          else
+            # klass_name can not be evaluated
+            if constant_name? klass_name
+              puts "Unknown constant name: \"#{e.name}\""
+            else
+              # only Class name is allowed
+              puts "Not a constant name: \"#{klass_name}\""
+              bp = nil
+            end
+          end
+
+          Session.activate_method_added_trackers if bp
         rescue Exception => e
-          puts e.message
-          ::DEBUGGER__::METHOD_ADDED_TRACKER.enable
+          puts e.inspect
+          bp = nil
         end
 
         bp
@@ -981,7 +1051,7 @@ module DEBUGGER__
             begin
               obj = frame_eval args.shift, re_raise: true
               opt = args.shift
-              obj_inspect = obj.inspect
+              obj_inspect = DEBUGGER__.safe_inspect(obj)
 
               width = 50
 
@@ -989,7 +1059,7 @@ module DEBUGGER__
                 obj_inspect = truncate(obj_inspect, width: width)
               end
 
-              event! :result, :trace_pass, obj.object_id, obj_inspect, opt
+              event! :result, :trace_pass, M_OBJECT_ID.bind_call(obj), obj_inspect, opt
             rescue => e
               puts e.message
               event! :result, nil
@@ -1006,8 +1076,8 @@ module DEBUGGER__
             # enable recording
             if !@recorder
               @recorder = Recorder.new
-              @recorder.enable
             end
+            @recorder.enable
           when :off
             if @recorder&.enabled?
               @recorder.disable
@@ -1039,6 +1109,33 @@ module DEBUGGER__
       raise
     end
 
+    def debug_event(ev, args)
+      DEBUGGER__.debug{
+        args = args.map { |arg| DEBUGGER__.safe_inspect(arg) }
+        "#{inspect} sends Event { type: #{ev.inspect}, args: #{args} } to Session"
+      }
+    end
+
+    def debug_mode(old_mode, new_mode)
+      DEBUGGER__.debug{
+        "#{inspect} changes mode (#{old_mode} -> #{new_mode})"
+      }
+    end
+
+    def debug_cmd(cmds)
+      DEBUGGER__.debug{
+        cmd, *args = *cmds
+        args = args.map { |arg| DEBUGGER__.safe_inspect(arg) }
+        "#{inspect} receives Cmd { type: #{cmd.inspect}, args: #{args} } from Session"
+      }
+    end
+
+    def debug_suspend(event)
+      DEBUGGER__.debug{
+        "#{inspect} is suspended for #{event.inspect}"
+      }
+    end
+
     class Recorder
       attr_reader :log, :index
       attr_accessor :backup_frames

data/lib/debug/tracer.rb

@@ -74,7 +74,7 @@ module DEBUGGER__
     end
 
     def out tp, msg = nil, depth = caller.size - 1
-      location_str = colorize("#{tp.path}:#{tp.lineno}", [:GREEN])
+      location_str = colorize("#{FrameInfo.pretty_path(tp.path)}:#{tp.lineno}", [:GREEN])
       buff = "#{header(depth)}#{msg} at #{location_str}"
 
       if false # TODO: Ractor.main?
@@ -119,7 +119,6 @@ module DEBUGGER__
         next if skip?(tp)
 
         depth = caller.size
-        sp = ' ' * depth
 
         call_identifier_str =
           if tp.defined_class
@@ -133,9 +132,11 @@ module DEBUGGER__
         case tp.event
         when :call, :c_call, :b_call
           depth += 1 if tp.event == :c_call
+          sp = ' ' * depth
           out tp, ">#{sp}#{call_identifier_str}", depth
         when :return, :c_return, :b_return
           depth += 1 if tp.event == :c_return
+          sp = ' ' * depth
           return_str = colorize_magenta(DEBUGGER__.safe_inspect(tp.return_value, short: true))
           out tp, "<#{sp}#{call_identifier_str} #=> #{return_str}", depth
         end
@@ -185,7 +186,7 @@ module DEBUGGER__
       @tracer = TracePoint.new(:a_call){|tp|
         next if skip?(tp)
 
-        if tp.self.object_id == @obj_id
+        if M_OBJECT_ID.bind_call(tp.self) == @obj_id
           klass = tp.defined_class
           method = tp.method_id
           method_info =

data/lib/debug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DEBUGGER__
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/misc/README.md.erb

@@ -9,11 +9,15 @@ New debug.rb has several advantages:
 
 * Fast: No performance penalty on non-stepping mode and non-breakpoints.
 * [Remote debugging](#remote-debugging): Support remote debugging natively.
-  * UNIX domain socket
+  * UNIX domain socket (UDS)
   * TCP/IP
-  * Integration with rich debugger frontend
-    * VSCode/DAP ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
-    * Chrome DevTools
+  * Integration with rich debugger frontends
+
+     Frontend |  [Console](https://github.com/ruby/debug#invoke-as-a-remote-debuggee) | [VSCode](https://github.com/ruby/debug#vscode-integration) | [Chrome DevTool](#chrome-devtool-integration) |
+     ---|---|---|---|
+     Connection | UDS, TCP/IP | UDS, TCP/IP | TCP/IP |
+     Requirement | No | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | Chrome |
+
 * Extensible: application can introduce debugging support with several ways:
   * By `rdbg` command
   * By loading libraries with `-r` command line option
@@ -38,6 +42,9 @@ If you use Bundler, write the following line to your Gemfile.
 gem "debug", ">= 1.0.0"
 ```
 
+(The version constraint is important; `debug < 1.0.0` is an older,
+abandoned gem that is completely different from this product.)
+
 # HOW TO USE
 
 To use a debugger, roughly you will do the following steps:
@@ -134,7 +141,7 @@ d => 4
 ### Invoke the program from the debugger as a traditional debuggers
 
 If you don't want to modify the source code, you can set breakpoints with a debug command `break` (`b` for short).
-Using `rdbg` command to launch the program without any modifications, you can run the program with the debugger.
+Using `rdbg` command (or `bundle exec rdbg`) to launch the program without any modifications, you can run the program with the debugger.
 
 ```shell
 $ cat target.rb                        # Sample program
@@ -280,7 +287,12 @@ You can run your application as a remote debuggee and the remote debugger consol
 
 ### Invoke as a remote debuggee
 
-There are two ways to invoke a script as remote debuggee: Use `rdbg --open` and require `debug/open` (or `debug/open_nonstop`).
+There are multiple ways to run your program as a debuggee:
+
+Stop at program start | [`rdbg` option](https://github.com/ruby/debug#rdbg---open-or-rdbg--o-for-short) | [require](https://github.com/ruby/debug#require-debugopen-in-a-program) | [debugger API](https://github.com/ruby/debug#start-by-method)
+---|---|---|---|
+Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open`
+No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
 
 #### `rdbg --open` (or `rdbg -O` for short)
 
@@ -452,10 +464,18 @@ config set log_level INFO
 config set no_color true
 ```
 
-<% cat = nil; DEBUGGER__::CONFIG_SET.each do |key, (env, desc)| %>
+<% cat = nil; DEBUGGER__::CONFIG_SET.each do |key, (env, desc, _, default)| %>
 <% /\A(\w+): (.+)/ =~ desc; if cat != $1; cat = 1 %>
 * <%= $1 %>
-<% cat = $1; end %>  * `<%= env %>` (`<%= key %>`): <%= $2 %><% end %>
+<% cat = $1; end %>  * `<%= env %>` (`<%= key %>`): <%= default ? "#{$2} (default: #{default})" : $2 %><% end %>
+
+There are other environment variables:
+
+* `NO_COLOR`: If the value is set, set `RUBY_DEBUG_NO_COLOR` ([NO_COLOR: disabling ANSI color output in various Unix commands](https://no-color.org/)).
+* `RUBY_DEBUG_ENABLE`: If the value is `0`, do not enable debug.gem feature.
+* `RUBY_DEBUG_ADDED_RUBYOPT`: Remove this value from `RUBYOPT` at first. This feature helps loading debug.gem with `RUBYOPT='-r debug/...'` and you don't want to derive it to child processes. In this case you can set `RUBY_DEBUG_ADDED_RUBYOPT='-r debug/...'` (same value) and this string will be deleted from `RUBYOPT` at first.
+* `RUBY_DEBUG_EDITOR` or `EDITOR`: An editor used by `edit` debug command.
+* `RUBY_DEBUG_BB`: Define `Kernel#bb` method which is alias of `Kernel#debugger`.
 
 ### Initial scripts
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.3.1
 description: Debugging functionality for Ruby. This is completely rewritten debug.rb
   which was contained by the ancient Ruby versions.
 email:
@@ -60,7 +60,6 @@ files:
 - ext/debug/extconf.rb
 - ext/debug/iseq_collector.c
 - lib/debug.rb
-- lib/debug/bp.vim
 - lib/debug/breakpoint.rb
 - lib/debug/client.rb
 - lib/debug/color.rb
@@ -103,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Debugging functionality for Ruby

data/lib/debug/bp.vim

@@ -1,68 +0,0 @@
-let g:rdb_bps = {}
-
-function SET_BP()
-  let signed = sign_getplaced(bufname(), {'lnum': line('.')})
-  if empty(signed[0]['signs'])
-    call sign_place(0, '', 'signBP', bufname(), {'lnum': line('.')})
-  else
-    "echo signed[0]['signs']
-    call sign_unplace('', {'buffer': bufname(), 'id': signed[0]['signs'][0]['id']})
-  endif
-endfunction
-
-function UPDATE_BPS()
-  let signs = sign_getplaced(bufname())
-  let key = expand('%:p')
-
-  if empty(signs[0]['signs'])
-    let removed = remove(g:rdb_bps, key)
-  else
-    let g:rdb_bps[key] = signs[0]['signs']
-  endif
-endfunction
-
-function APPLY_BPS()
-  let key = expand('%:p')
-  if has_key(g:rdb_bps, key)
-    for b in g:rdb_bps[key]
-      call sign_place(0, '', 'signBP', bufname(), {'lnum': b['lnum']})
-    endfor
-  endif
-endfunction
-
-function WRITE_BPS()
-  call writefile([json_encode(g:rdb_bps)], '.rdb_breakpoints.json')
-endfunction
-
-" load
-try
-  let json = readfile('.rdb_breakpoints.json')
-  let g:rdb_bps = json_decode(json[0])
-  " {"/full/path/to/file1": [{"lnum": 10}, ...], ...}
-catch /Can't open/
-  let g:rdb_bps = {}
-catch /Invalid arguments for function json_decode/
-  let g:rdb_bps = {}
-endtry
-
-sign define signBP text=BR
-
-call APPLY_BPS()
-
-autocmd BufReadPost * call APPLY_BPS()
-autocmd BufUnload   * call UPDATE_BPS()
-autocmd VimLeave    * call WRITE_BPS()
-
-function! s:ruby_bp_settings() abort
-  echomsg "Type <Space> to toggle break points and <q> to quit"
-
-  if &readonly
-    nnoremap <silent> <buffer> <Space> :call SET_BP()<CR>
-    nnoremap <silent> <buffer> q :<C-u>quit<CR>
-  endif
-endfunction
-
-" autocmd FileType ruby call s:ruby_bp_settings()
-autocmd BufEnter *.rb call s:ruby_bp_settings()
-
-call s:ruby_bp_settings()