debug 1.0.0.rc1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4753f123beef802e8cea541c779672938b200d5077011cd53a6a99c282d225cb
-  data.tar.gz: '078b495c6c5170cf6704c3100e1769477efadcbca47b5bae54c18c76424b8466'
+  metadata.gz: d6eba8a00eaa711138e43036c5adb97834f1a87e586f8a5a3f580875e4d78e5c
+  data.tar.gz: 26ed8ac77bb93ab2a9f67fac6c4ef4481fbcdd227f116aaff78e808a2343b13b
 SHA512:
-  metadata.gz: 4e3e35a50f48444a978499798ef4d0ff997060f8562118baadec7af7c55ce4932f0a7ebd937dca974338c4086e44fbe34ce85b12386d3b67f65c774ab642a0b1
-  data.tar.gz: 3ba0fa3adf1122d4c86ac491c99a782d3f31d519255f4110e9721f3749bd87ac0aed2f9d1528a14b4ca814a3eb60ed0ef2f30cb51b24f6ec219e8b9ead6c5b73
+  metadata.gz: b459267a95928388d1bf53bab8bf51fc8d5a6d0db0bc2fbaa55f740b1b446aad2294e45cc2b70471ccf8bb1daada458f239f08c7ceb7588774f08796a7838620
+  data.tar.gz: 86d06a4ec76943e26af39a26120c8a3a906d3fcecca195a662e63b9be2b7b9a1ba82bd2fba177205b436cde89be9214988e0f2cccc0f7fb2dcbf7226e92886e9

data/README.md

@@ -8,7 +8,7 @@ This debug.rb is replacement of traditional lib/debug.rb standard library which
 New debug.rb has several advantages:
 
 * Fast: No performance penalty on non-stepping mode and non-breakpoints.
-* Remote debugging: Support remote debugging natively.
+* [Remote debugging](#remote-debugging): Support remote debugging natively.
   * UNIX domain socket
   * TCP/IP
   * VSCode/DAP integration ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
@@ -25,7 +25,7 @@ New debug.rb has several advantages:
 # Installation
 
 ```
-$ gem install debug --pre
+$ gem install debug
 ```
 
 or specify `-Ipath/to/debug/lib` in `RUBYOPT` or each ruby command-line option, especially for debug this gem development.
@@ -33,7 +33,7 @@ or specify `-Ipath/to/debug/lib` in `RUBYOPT` or each ruby command-line option,
 If you use Bundler, write the following line to your Gemfile.
 
 ```
-gem "debug", ">= 1.0.0.rc"
+gem "debug", ">= 1.0.0"
 ```
 
 # HOW TO USE
@@ -44,22 +44,24 @@ To use a debugger, roughly you will do the following steps:
 2. Run a program with the debugger.
 3. At the breakpoint, enter the debugger console.
 4. Use debug commands.
-    * Query the program status (e.g. `p lvar` to see the local variable `lvar`).
-    * Control program flow (e.g. move to the another line with `step`, to the next line with `next`).
-    * Set another breakpoint (e.g. `catch Exception` to set a breakpoint when `Exception` is raised).
-    * Change the configuration (e.g. `config set no_color true` to disable coloring).
+    * [Evaluate Ruby expressions](#evaluate) (e.g. `p lvar` to see the local variable `lvar`).
+    * [Query the program status](#information) (e.g. `info` to see information about the current frame).
+    * [Control program flow](#control-flow) (e.g. move to the another line with `step`, to the next line with `next`).
+    * [Set another breakpoint](#breakpoint) (e.g. `catch Exception` to set a breakpoint that'll be triggered when `Exception` is raised).
+    * [Activate tracing in your program](#trace) (e.g. `trace call` to trace method calls).
+    * [Change the configuration](#configuration-1) (e.g. `config set no_color true` to disable coloring).
     * Continue the program (`c` or `continue`) and goto 3.
 
 ## Invoke with the debugger
 
 There are several options for (1) and (2). Please choose your favorite way.
 
-### Modify source code as `binding.pry` and `binding.irb`
+### Modify source code with [`binding.break`](#bindingbreak-method) (similar to `binding.pry` or `binding.irb`)
 
-If you can modify the source code, you can use the debugger by adding `require 'debug'` line at the top of your program and putting `binding.break` method (`binding.b` for short) into lines where you want to stop as breakpoints like `binding.pry` and `binding.irb`.
+If you can modify the source code, you can use the debugger by adding `require 'debug'` line at the top of your program and putting [`binding.break`](#bindingbreak-method) method (`binding.b` for short) into lines where you want to stop as breakpoints like `binding.pry` and `binding.irb`.
 After that, you run the program as usual and you will enter the debug console at breakpoints you inserted.
 
-The following example shows the demonstration of `binding.break`.
+The following example shows the demonstration of [`binding.break`](#bindingbreak-method).
 
 ```shell
 $ cat target.rb                        # Sample program
@@ -355,7 +357,7 @@ config set no_color true
   * `RUBY_DEBUG_LOG_LEVEL` (`log_level`): Log level same as Logger (default: WARN)
   * `RUBY_DEBUG_SHOW_SRC_LINES` (`show_src_lines`): Show n lines source code on breakpoint (default: 10 lines)
   * `RUBY_DEBUG_SHOW_FRAMES` (`show_frames`): Show n frames on breakpoint (default: 2 frames)
-  * `RUBY_DEBUG_USE_SHORT_PATH` (`use_short_path`): Show shoten PATH (like $(Gem)/foo.rb)
+  * `RUBY_DEBUG_USE_SHORT_PATH` (`use_short_path`): Show shorten PATH (like $(Gem)/foo.rb)
   * `RUBY_DEBUG_NO_COLOR` (`no_color`): Do not use colorize (default: false)
   * `RUBY_DEBUG_NO_SIGINT_HOOK` (`no_sigint_hook`): Do not suspend on SIGINT (default: false)
   * `RUBY_DEBUG_NO_RELINE` (`no_reline`): Do not use Reline library (default: false)
@@ -370,6 +372,7 @@ config set no_color true
 
 * BOOT
   * `RUBY_DEBUG_NONSTOP` (`nonstop`): Nonstop mode
+  * `RUBY_DEBUG_STOP_AT_LOAD` (`stop_at_load`): Stop at just loading location
   * `RUBY_DEBUG_INIT_SCRIPT` (`init_script`): debug command script path loaded at first stop
   * `RUBY_DEBUG_COMMANDS` (`commands`): debug commands invoked at first stop. commands should be separated by ';;'
   * `RUBY_DEBUG_NO_RC` (`no_rc`): ignore loading ~/.rdbgrc(.rb)
@@ -397,7 +400,12 @@ If there are `~/.rdbgrc.rb` is available, it is also loaded as a ruby script at
 
 On the debug console, you can use the following debug commands.
 
-* `Enter` repeats the last command (useful when repeating `step`s).
+There are additional features:
+
+* `<expr>` without debug command is almost same as `pp <expr>`.
+  * If the input line `<expr>` does *NOT* start with any debug command, the line `<expr>` will be evaluated as a Ruby expression and the result will be printed with `pp` method. So that the input `foo.bar` is same as `pp foo.bar`.
+  * If `<expr>` is recognized as a debug command, of course it is not evaluated as a Ruby expression, but is executed as debug command. For example, you can not evaluate such single letter local variables `i`, `b`, `n`, `c` because they are single letter debug commands. Use `p i` instead.
+* `Enter` without any input repeats the last command (useful when repeating `step`s).
 * `Ctrl-D` is equal to `quit` command.
 * [debug command compare sheet - Google Sheets](https://docs.google.com/spreadsheets/d/1TlmmUDsvwK4sSIyoMv-io52BUUz__R5wpu-ComXlsw0/edit?usp=sharing)
 
@@ -429,6 +437,9 @@ The `<...>` notation means the argument.
   * Stop the debuggee process with `Kernal#exit!`.
 * `kill!`
   * Same as kill but without the confirmation prompt.
+* `sigint`
+  * Execute SIGINT handler registerred by the debuggee.
+  * Note that this command should be used just after stop by `SIGINT`.
 
 ### Breakpoint
 
@@ -489,7 +500,7 @@ The `<...>` notation means the argument.
   * Show information about the current frame (local variables)
   * It includes `self` as `%self` and a return value as `%return`.
 * `i[nfo] i[var[s]]` or `i[nfo] instance`
-  * Show information about insttance variables about `self`.
+  * Show information about instance variables about `self`.
 * `i[nfo] c[onst[s]]` or `i[nfo] constant[s]`
   * Show information about accessible constants except toplevel constants.
 * `i[nfo] g[lobal[s]]`
@@ -529,7 +540,7 @@ The `<...>` notation means the argument.
   * Evaluate like `p <expr>` on the current frame.
 * `pp <expr>`
   * Evaluate like `pp <expr>` on the current frame.
-* `e[val] <expr>`
+* `eval <expr>`
   * Evaluate `<expr>` on the current frame.
 * `irb`
   * Invoke `irb` on the current frame.
@@ -721,6 +732,7 @@ Attach mode:
 Other options:
     -h, --help                       Print help
         --util=NAME                  Utility mode (used by tools)
+        --stop-at-load               Stop immediately when the debugging feature is loaded.
 
 NOTE
   All messages communicated between a debugger and a debuggee are *NOT* encrypted.

data/Rakefile

@@ -15,7 +15,7 @@ Rake::ExtensionTask.new("debug") do |ext|
   ext.lib_dir = "lib/debug"
 end
 
-task :default => [:clobber, :compile, :test, 'README.md']
+task :default => [:clobber, :compile, 'README.md', :test]
 
 file 'README.md' => ['lib/debug/session.rb', 'lib/debug/config.rb',
                      'exe/rdbg', 'misc/README.md.erb'] do

data/TODO.md

@@ -3,25 +3,21 @@
 ## Basic functionality
 
 * Support Ractors
-* Signal (SIGINT) support
+* Signal (SIGINT) trap handling 
 
 ## UI
 
+* Completion for Ruby's code
 * Interactive breakpoint setting
+* Interactive record & play debugging
 * irb integration
 * Web browser integrated UI
+* History file
 
 ## Debug command
 
 * Breakpoints
     * Lightweight pending method break points with Ruby 3.1 feature (TP:method_added)
-    * Non-stop breakpoint but runs some code.
 * Watch points
     * Lightweight watchpoints for instance variables with Ruby 3.1 features (TP:ivar_set)
 * Faster `next`/`finish` command by specifying target code.
-* `set`/`show` configurations
-* In-memory line traces
-* Timemachine debugging
-
-## Tests
-

data/exe/rdbg

@@ -9,7 +9,7 @@ when :start
 
   libpath = File.join(File.expand_path(File.dirname(__dir__)), 'lib/debug')
   start_mode = config[:remote] ? "open" : 'start'
-  cmd = config[:command] ? ARGV.shift : RbConfig.ruby
+  cmd = config[:command] ? ARGV.shift : (ENV['RUBY'] || RbConfig.ruby)
 
   env = ::DEBUGGER__::Config.config_to_env_hash(config)
   env['RUBYOPT'] = "-r #{libpath}/#{start_mode}"

data/ext/debug/debug.c

@@ -122,6 +122,11 @@ Init_debug(void)
 {
     rb_mDebugger = rb_const_get(rb_cObject, rb_intern("DEBUGGER__"));
     rb_cFrameInfo = rb_const_get(rb_mDebugger, rb_intern("FrameInfo"));
+
+    // Debugger and FrameInfo were defined in Ruby. We need to register them
+    // as mark objects so they are automatically pinned.
+    rb_gc_register_mark_object(rb_mDebugger);
+    rb_gc_register_mark_object(rb_cFrameInfo);
     rb_define_singleton_method(rb_mDebugger, "capture_frames", capture_frames, 1);
     rb_define_singleton_method(rb_mDebugger, "frame_depth", frame_depth, 0);
     rb_define_singleton_method(rb_mDebugger, "create_method_added_tracker", create_method_added_tracker, 0);

data/lib/debug/breakpoint.rb

@@ -288,6 +288,7 @@ module DEBUGGER__
       @tp = TracePoint.new(:line){|tp|
         next if tp.path.start_with? __dir__
         next if tp.path.start_with? '<internal:'
+        next if ThreadClient.current.management?
 
         if safe_eval tp.binding, @expr
           suspend
@@ -430,17 +431,24 @@ module DEBUGGER__
         if @sig_op == '#'
           @cond_class = @klass if @method.owner != @klass
         else # '.'
-          @cond_class = @klass.singleton_class if @method.owner != @klass.singleton_class
+          begin
+            @cond_class = @klass.singleton_class if @method.owner != @klass.singleton_class
+          rescue TypeError
+          end
         end
 
-      rescue ArgumentError
+      rescue ArgumentError => e
         raise if retried
         retried = true
 
         # maybe C method
         case @sig_op
         when '.'
-          override @klass.singleton_class
+          begin
+            override @klass.singleton_class
+          rescue TypeError
+            override @klass.class
+          end
         when '#'
           override @klass
         end
@@ -450,7 +458,7 @@ module DEBUGGER__
         @override_method = true if @method
         retry
       end
-    rescue Exception
+    rescue Exception => e
       raise unless added
     end
 
@@ -460,7 +468,8 @@ module DEBUGGER__
 
     def to_s
       if @method
-        "#{generate_label("Method")} #{sig} at #{@method.source_location.join(':')}"
+        loc = @method.source_location || []
+        "#{generate_label("Method")} #{sig} at #{loc.join(':')}"
       else
         "#{generate_label("Method (pending)")} #{sig}"
       end + super

data/lib/debug/color.rb

@@ -19,7 +19,7 @@ module DEBUGGER__
     if defined? IRB::Color.colorize
       def colorize str, color
         if !CONFIG[:no_color]
-          IRB::Color.colorize str, color
+          IRB::Color.colorize str, color, colorable: true
         else
           str
         end
@@ -64,7 +64,7 @@ module DEBUGGER__
 
     if defined? IRB::Color.colorize_code
       def colorize_code code
-        IRB::Color.colorize_code(code)
+        IRB::Color.colorize_code(code, colorable: true)
       end
     else
       def colorize_code code

data/lib/debug/config.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 module DEBUGGER__
+  LOG_LEVELS = {
+    UNKNOWN: 0,
+    FATAL:   1,
+    ERROR:   2,
+    WARN:    3,
+    INFO:    4,
+  }.freeze
+
   CONFIG_SET = {
     # UI setting
     log_level:      ['RUBY_DEBUG_LOG_LEVEL',      "UI: Log level same as Logger (default: WARN)",                   :loglevel],
     show_src_lines: ['RUBY_DEBUG_SHOW_SRC_LINES', "UI: Show n lines source code on breakpoint (default: 10 lines)", :int],
     show_frames:    ['RUBY_DEBUG_SHOW_FRAMES',    "UI: Show n frames on breakpoint (default: 2 frames)",            :int],
-    use_short_path: ['RUBY_DEBUG_USE_SHORT_PATH', "UI: Show shoten PATH (like $(Gem)/foo.rb)",                      :bool],
+    use_short_path: ['RUBY_DEBUG_USE_SHORT_PATH', "UI: Show shorten PATH (like $(Gem)/foo.rb)",                      :bool],
     no_color:       ['RUBY_DEBUG_NO_COLOR',       "UI: Do not use colorize (default: false)",                       :bool],
     no_sigint_hook: ['RUBY_DEBUG_NO_SIGINT_HOOK', "UI: Do not suspend on SIGINT (default: false)",                  :bool],
     no_reline:      ['RUBY_DEBUG_NO_RELINE',      "UI: Do not use Reline library (default: false)",                 :bool],
@@ -21,6 +29,7 @@ module DEBUGGER__
 
     # boot setting
     nonstop:        ['RUBY_DEBUG_NONSTOP',     "BOOT: Nonstop mode",                                                :bool],
+    stop_at_load:   ['RUBY_DEBUG_STOP_AT_LOAD',"BOOT: Stop at just loading location",                               :bool],
     init_script:    ['RUBY_DEBUG_INIT_SCRIPT', "BOOT: debug command script path loaded at first stop"],
     commands:       ['RUBY_DEBUG_COMMANDS',    "BOOT: debug commands invoked at first stop. commands should be separated by ';;'"],
     no_rc:          ['RUBY_DEBUG_NO_RC',       "BOOT: ignore loading ~/.rdbgrc(.rb)",                               :bool],
@@ -102,7 +111,9 @@ module DEBUGGER__
       end
 
       if_updated old_conf, conf, :postmortem do |_, new_p|
-        SESSION.postmortem = new_p
+        if defined?(SESSION)
+          SESSION.postmortem = new_p
+        end
       end
 
       if_updated old_conf, conf, :sigdump_sig do |old_sig, new_sig|
@@ -306,6 +317,10 @@ module DEBUGGER__
           exit
         end
 
+        o.on('--stop-at-load', 'Stop immediately when the debugging feature is loaded.') do
+          config[:stop_at_load] = true
+        end
+
         o.separator ''
         o.separator 'NOTE'
         o.separator '  All messages communicated between a debugger and a debuggee are *NOT* encrypted.'
@@ -372,7 +387,7 @@ module DEBUGGER__
     desc = cat = nil
     cmds = Hash.new
 
-    File.read(File.join(__dir__, 'session.rb')).each_line do |line|
+    File.read(File.join(__dir__, 'session.rb'), encoding: Encoding::UTF_8).each_line do |line|
       case line
       when /\A\s*### (.+)/
         cat = $1

data/lib/debug/console.rb

@@ -6,11 +6,19 @@ module DEBUGGER__
       require 'reline'
 
       # reline 0.2.7 or later is required.
-      raise LoadError if Reline::VERSION < '0.2.6'
+      raise LoadError if Reline::VERSION < '0.2.7'
 
       require_relative 'color'
       include Color
 
+      begin
+        prev = trap(:SIGWINCH, nil)
+        trap(:SIGWINCH, prev)
+        SIGWINCH_SUPPORTED = true
+      rescue ArgumentError
+        SIGWINCH_SUPPORTED = false
+      end
+
       # 0.2.7 has SIGWINCH issue on non-main thread
       class ::Reline::LineEditor
         m = Module.new do
@@ -20,7 +28,7 @@ module DEBUGGER__
           end
         end
         prepend m
-      end
+      end if SIGWINCH_SUPPORTED
 
       def readline_setup prompt
         commands = DEBUGGER__.commands

data/lib/debug/frame_info.rb

@@ -27,6 +27,7 @@ module DEBUGGER__
     end
 
     def pretty_path
+      return '#<none>' unless path = self.path
       use_short_path = CONFIG[:use_short_path]
 
       case
@@ -137,10 +138,9 @@ module DEBUGGER__
       if lvars = self._local_variables
         lvars
       elsif b = self.binding
-        lvars = b.local_variables.map{|var|
+        b.local_variables.map{|var|
           [var, b.local_variable_get(var)]
         }.to_h
-        self._local_variables = lvars
       end
     end
 

data/lib/debug/local.rb

@@ -7,32 +7,27 @@ module DEBUGGER__
   class UI_LocalConsole < UI_Base
     def initialize
       @console = Console.new
-
-      unless CONFIG[:no_sigint_hook]
-        @prev_handler = trap(:SIGINT){
-          if SESSION.active?
-            ThreadClient.current.on_trap :SIGINT
-          end
-        }
-      end
-    end
-
-    def close
-      if @prev_handler
-        trap(:SIGINT, @prev_handler)
-      end
     end
 
     def remote?
       false
     end
 
-    def activate on_fork: false
-      # Do nothing
+    def activate session, on_fork: false
+      unless CONFIG[:no_sigint_hook]
+        prev_handler = trap(:SIGINT){
+          if session.active?
+            ThreadClient.current.on_trap :SIGINT
+          end
+        }
+        session.intercept_trap_sigint_start prev_handler
+      end
     end
 
     def deactivate
-      # Do nothing
+      if SESSION.intercept_trap_sigint?
+        trap(:SIGINT, SESSION.intercepted_sigint_cmd)
+      end
     end
 
     def width
@@ -76,15 +71,17 @@ module DEBUGGER__
     end
 
     def setup_interrupt
-      current_thread = Thread.current # should be session_server thread
+      SESSION.intercept_trap_sigint false do
+        current_thread = Thread.current # should be session_server thread
 
-      prev_handler = trap(:INT){
-        current_thread.raise Interrupt
-      }
+        prev_handler = trap(:INT){
+          current_thread.raise Interrupt
+        }
 
-      yield
-    ensure
-      trap(:INT, prev_handler)
+        yield
+      ensure
+        trap(:INT, prev_handler)
+      end
     end
   end
 end

data/lib/debug/server.rb

@@ -15,8 +15,6 @@ module DEBUGGER__
       @q_ans = nil
       @unsent_messages = []
       @width = 80
-
-      activate
     end
 
     class Terminate < StandardError
@@ -37,7 +35,7 @@ module DEBUGGER__
       end
     end
 
-    def activate on_fork: false
+    def activate session, on_fork: false
       @reader_thread = Thread.new do
         # An error on this thread should break the system.
         Thread.current.abort_on_exception = true
@@ -138,9 +136,9 @@ module DEBUGGER__
     end
 
     def setup_interrupt
-      prev_handler = trap(:SIGINT) do
+      prev_handler = trap(:SIGURG) do
         # $stderr.puts "trapped SIGINT"
-        ThreadClient.current.on_trap :SIGINT
+        ThreadClient.current.on_trap :SIGURG
 
         case prev_handler
         when Proc
@@ -150,9 +148,12 @@ module DEBUGGER__
         end
       end
 
+      if prev_handler != "SYSTEM_DEFAULT"
+        DEBUGGER__.warn "SIGURG handler is overriddend by the debugger."
+      end
       yield
     ensure
-      trap(:SIGINT, prev_handler)
+      trap(:SIGURG, prev_handler)
     end
 
     attr_reader :reader_thread
@@ -230,7 +231,7 @@ module DEBUGGER__
 
     def pause
       # $stderr.puts "DEBUG: pause request"
-      Process.kill(:SIGINT, Process.pid)
+      Process.kill(:SIGURG, Process.pid)
     end
 
     def quit n

data/lib/debug/server_dap.rb

@@ -153,8 +153,8 @@ module DEBUGGER__
         when 'setFunctionBreakpoints'
           send_response req
         when 'setExceptionBreakpoints'
-          filters = args.dig('filterOptions').map{|bp_info|
-            case bp_info.dig('filterId')
+          process_filter = ->(filter_id) {
+            case filter_id
             when 'any'
               bp = SESSION.add_catch_breakpoint 'Exception'
             when 'RuntimeError'
@@ -163,10 +163,19 @@ module DEBUGGER__
               bp = nil
             end
             {
-              verifiled: bp ? true : false,
+              verified: bp ? true : false,
               message: bp.inspect,
             }
           }
+
+          filters = args.fetch('filters').map {|filter_id|
+            process_filter.call(filter_id)
+          }
+
+          filters += args.fetch('filterOptions', {}).map{|bp_info|
+            process_filter.call(bp_info.dig('filterId'))
+          }
+
           send_response req, breakpoints: filters
         when 'configurationDone'
           send_response req
@@ -354,7 +363,7 @@ module DEBUGGER__
               fail_response req
             end
           else
-            raise "Uknown type: #{ref.inspect}"
+            raise "Unknown type: #{ref.inspect}"
           end
         else
           fail_response req
@@ -471,7 +480,7 @@ module DEBUGGER__
         fid = args.shift
         frame = @target_frames[fid]
 
-        lnum = 
+        lnum =
           if frame.binding
             frame.binding.local_variables.size
           elsif vars = frame.local_variables
@@ -580,7 +589,7 @@ module DEBUGGER__
         end
         event! :dap_result, :evaluate, req, tid: self.id, **evaluate_result(result)
       else
-        raise "Unkown req: #{args.inspect}"
+        raise "Unknown req: #{args.inspect}"
       end
     end