debug 1.0.0.beta5 → 1.0.0.rc1

data/Rakefile

@@ -17,7 +17,8 @@ end
 
 task :default => [:clobber, :compile, :test, 'README.md']
 
-file 'README.md' => ['lib/debug/session.rb', 'exe/rdbg', 'misc/README.md.erb'] do
+file 'README.md' => ['lib/debug/session.rb', 'lib/debug/config.rb',
+                     'exe/rdbg', 'misc/README.md.erb'] do
   require_relative 'lib/debug/session'
   require 'erb'
   File.write 'README.md', ERB.new(File.read('misc/README.md.erb')).result

data/TODO.md

@@ -2,14 +2,11 @@
 
 ## Basic functionality
 
-* VScode DAP support
 * Support Ractors
 * Signal (SIGINT) support
-* Remote connection with openssl
 
 ## UI
 
-* Coloring
 * Interactive breakpoint setting
 * irb integration
 * Web browser integrated UI
@@ -28,6 +25,3 @@
 
 ## Tests
 
-* Test framework
-* Tests for commands
-* Tests for remote debugging

data/bin/gentest

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require_relative '../test/tool/test_builder'
+
+file_info = {}
+
+OptionParser.new do |opt|
+  opt.banner = 'Usage: bin/gentest [file] [option]'
+  opt.on('-m METHOD', 'Method name in the test file') do |m|
+    file_info[:method] = m
+  end
+  opt.on('-c CLASS', 'Class name in the test file') do |c|
+    file_info[:class] = c
+  end
+  opt.parse!(ARGV)
+end
+
+exit if ARGV.empty?
+
+DEBUGGER__::TestBuilder.new(ARGV, file_info[:method], file_info[:class]).start

data/debug.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.extensions    = ['ext/debug/extconf.rb']
 
   spec.add_dependency "irb" # for its color_printer class, which was added after 1.3
+  spec.add_dependency "reline", ">= 0.2.7"
 end

data/exe/rdbg

@@ -1,37 +1,30 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/debug/client'
-
-config = DEBUGGER__.parse_argv(ARGV)
+require_relative '../lib/debug/config'
+config = DEBUGGER__::Config::parse_argv(ARGV)
 
 case config[:mode]
 when :start
   require 'rbconfig'
 
-  if config[:remote]
-    start_mode = "debug/open"
-  else
-    start_mode = "debug/run"
-  end
+  libpath = File.join(File.expand_path(File.dirname(__dir__)), 'lib/debug')
+  start_mode = config[:remote] ? "open" : 'start'
+  cmd = config[:command] ? ARGV.shift : RbConfig.ruby
 
-  ::DEBUGGER__.config_to_env(config)
+  env = ::DEBUGGER__::Config.config_to_env_hash(config)
+  env['RUBYOPT'] = "-r #{libpath}/#{start_mode}"
 
-  cmd = config[:command] ? ARGV.shift : RbConfig.ruby
-  exec({'RUBYOPT' => "-I#{File.expand_path(File.dirname(__dir__))}/lib -r #{start_mode}"},
-       cmd, *ARGV)
+  exec(env, cmd, *ARGV)
 
 when :attach
   require_relative "../lib/debug/client"
-
-  config.each{|k, v|
-    DEBUGGER__::CONFIG[k] = v
-  }
+  ::DEBUGGER__::CONFIG.update config
 
   begin
     if ARGV.empty? && config[:port]
-      connect [config[:host], config[:port]].compact
+      DEBUGGER__::Client.new([config[:host], config[:port]].compact).connect
     else
-      connect ARGV
+      DEBUGGER__::Client.new(ARGV).connect
     end
   rescue DEBUGGER__::CommandLineOptionError
     puts opt.help

data/ext/debug/debug.c

@@ -22,7 +22,17 @@ static VALUE rb_cFrameInfo;
 static VALUE
 di_entry(VALUE loc, VALUE self, VALUE binding, VALUE iseq, VALUE klass, VALUE depth)
 {
-    return rb_struct_new(rb_cFrameInfo, loc, self, binding, iseq, klass, depth, Qnil, Qnil, Qnil, Qnil, Qnil);
+    return rb_struct_new(rb_cFrameInfo,
+                         // :location, :self, :binding, :iseq, :class, :frame_depth,
+                         loc, self, binding, iseq, klass, depth,
+                         // :has_return_value, :return_value,
+                         Qnil, Qnil,
+                         // :has_raised_exception, :raised_exception,
+                         Qnil, Qnil,
+                         // :show_line, :local_variables
+                         Qnil,
+                         // :_local_variables, :_callee # for recorder
+                         Qnil, Qnil);
 }
 
 static int

data/lib/debug/breakpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'color'
 
 module DEBUGGER__
@@ -47,42 +49,55 @@ module DEBUGGER__
     end
 
     def suspend
+      if @command
+        provider, pre_cmds, do_cmds = @command
+        nonstop = true if do_cmds
+        cmds = [*pre_cmds&.split(';;'), *do_cmds&.split(';;')]
+        SESSION.add_preset_commands provider, cmds, kick: false, continue: nonstop
+      end
+
       ThreadClient.current.on_breakpoint @tp, self
     end
 
     def to_s
-      if @cond
-        " if #{@cond}"
-      else
-        ""
-      end
+      s = ''.dup
+      s << " if: #{@cond}"        if defined?(@cond) && @cond
+      s << " pre: #{@command[1]}" if defined?(@command) && @command && @command[1]
+      s << " do: #{@command[2]}"  if defined?(@command) && @command && @command[2]
+      s
     end
 
     def description
       to_s
     end
 
-    class << self
-      include Color
+    def duplicable?
+      false
+    end
 
-      def generate_label(name)
-        colorize(" BP - #{name} ", [:YELLOW, :BOLD, :REVERSE])
-      end
+    include Color
+
+    def generate_label(name)
+      colorize(" BP - #{name} ", [:YELLOW, :BOLD, :REVERSE])
     end
   end
 
-  class LineBreakpoint < Breakpoint
-    LABEL = generate_label("Line")
-    PENDING_LABEL = generate_label("Line (pending)")
+  if RUBY_VERSION.to_f <= 2.7
+    # workaround for https://bugs.ruby-lang.org/issues/17302
+    TracePoint.new(:line){}.enable{}
+  end
 
+  class LineBreakpoint < Breakpoint
     attr_reader :path, :line, :iseq
 
-    def initialize path, line, cond: nil, oneshot: false, hook_call: true
+    def initialize path, line, cond: nil, oneshot: false, hook_call: true, command: nil
       @path = path
       @line = line
       @cond = cond
       @oneshot = oneshot
       @hook_call = hook_call
+      @command = command
+      @pending = false
 
       @iseq = nil
       @type = nil
@@ -90,23 +105,20 @@ module DEBUGGER__
       @key = [@path, @line].freeze
 
       super()
+
       try_activate
+      @pending = !@iseq
     end
 
     def setup
       return unless @type
 
-      if !@cond
-        @tp = TracePoint.new(@type) do |tp|
-          delete if @oneshot
-          suspend
-        end
-      else
-        @tp = TracePoint.new(@type) do |tp|
+      @tp = TracePoint.new(@type) do |tp|
+        if @cond
           next unless safe_eval tp.binding, @cond
-          delete if @oneshot
-          suspend
         end
+        delete if @oneshot
+        suspend
       end
     end
 
@@ -132,9 +144,12 @@ module DEBUGGER__
 
       @key = [@path, @line].freeze
       SESSION.rehash_bps
-
       setup
       enable
+
+      if @pending && !@oneshot
+        DEBUGGER__.warn "#{self} is activated."
+      end
     end
 
     def activate_exact iseq, events, line
@@ -155,6 +170,10 @@ module DEBUGGER__
       end
     end
 
+    def duplicable?
+      @oneshot
+    end
+
     NearestISeq = Struct.new(:iseq, :line, :events)
 
     def try_activate
@@ -203,9 +222,9 @@ module DEBUGGER__
       oneshot = @oneshot ? " (oneshot)" : ""
 
       if @iseq
-        "#{LABEL} #{@path}:#{@line} (#{@type})#{oneshot}" + super
+        "#{generate_label("Line")} #{@path}:#{@line} (#{@type})#{oneshot}" + super
       else
-        "#{PENDING_LABEL} #{@path}:#{@line}#{oneshot}" + super
+        "#{generate_label("Line (pending)")} #{@path}:#{@line}#{oneshot}" + super
       end
     end
 
@@ -215,21 +234,28 @@ module DEBUGGER__
   end
 
   class CatchBreakpoint < Breakpoint
-    LABEL = generate_label("Catch")
     attr_reader :last_exc
+    include SkipPathHelper
 
-    def initialize pat
+    def initialize pat, cond: nil, command: nil
       @pat = pat.freeze
       @key = [:catch, @pat].freeze
       @last_exc = nil
 
+      @cond = cond
+      @command = command
+
       super()
     end
 
     def setup
       @tp = TracePoint.new(:raise){|tp|
+        next if skip_path?(tp.path)
         exc = tp.raised_exception
+        next if SystemExit === exc
+        next if !safe_eval(tp.binding, @cond) if @cond
         should_suspend = false
+
         exc.class.ancestors.each{|cls|
           if @pat === cls.name
             should_suspend = true
@@ -242,7 +268,7 @@ module DEBUGGER__
     end
 
     def to_s
-      "#{LABEL} #{@pat.inspect}"
+      "#{generate_label("Catch")} #{@pat.inspect}"
     end
 
     def description
@@ -251,8 +277,6 @@ module DEBUGGER__
   end
 
   class CheckBreakpoint < Breakpoint
-    LABEL = generate_label("Check")
-
     def initialize expr
       @expr = expr.freeze
       @key = [:check, @expr].freeze
@@ -264,8 +288,6 @@ module DEBUGGER__
       @tp = TracePoint.new(:line){|tp|
         next if tp.path.start_with? __dir__
         next if tp.path.start_with? '<internal:'
-        # Skip when `JSON.generate` is called during tests
-        next if tp.defined_class.to_s == '#<Class:JSON>' and ENV['RUBY_DEBUG_TEST_MODE']
 
         if safe_eval tp.binding, @expr
           suspend
@@ -274,13 +296,11 @@ module DEBUGGER__
     end
 
     def to_s
-      "#{LABEL} #{@expr}"
+      "#{generate_label("Check")} #{@expr}"
     end
   end
 
   class WatchIVarBreakpoint < Breakpoint
-    LABEL = generate_label("Watch")
-
     def initialize ivar, object, current
       @ivar = ivar.to_sym
       @object = object
@@ -321,41 +341,38 @@ module DEBUGGER__
         else
           "#{@current}"
         end
-      "#{LABEL} #{@object} #{@ivar} = #{value_str}"
+      "#{generate_label("Watch")} #{@object} #{@ivar} = #{value_str}"
     end
   end
 
   class MethodBreakpoint < Breakpoint
-    LABEL = generate_label("Method")
-    PENDING_LABEL = generate_label("Method (pending)")
-
     attr_reader :sig_method_name, :method
 
-    def initialize b, klass_name, op, method_name, cond
+    def initialize b, klass_name, op, method_name, cond: nil, command: nil
       @sig_klass_name = klass_name
       @sig_op = op
       @sig_method_name = method_name
       @klass_eval_binding = b
+      @override_method = false
 
       @klass = nil
       @method = nil
       @cond = cond
+      @cond_class = nil
+      @command = command
       @key = "#{klass_name}#{op}#{method_name}".freeze
 
       super(false)
     end
 
     def setup
-      if @cond
-        @tp = TracePoint.new(:call){|tp|
-          next unless safe_eval tp.binding, @cond
-          suspend
-        }
-      else
-        @tp = TracePoint.new(:call){|tp|
-          suspend
-        }
-      end
+      @tp = TracePoint.new(:call){|tp|
+        next if !safe_eval(tp.binding, @cond) if @cond
+        next if @cond_class && !tp.self.kind_of?(@cond_class)
+        next if @override_method ? (caller_locations(2, 1).first.to_s.start_with?(__dir__)) : tp.path.start_with?(__dir__)
+
+        suspend
+      }
     end
 
     def eval_class_name
@@ -380,34 +397,61 @@ module DEBUGGER__
       try_enable
     end
 
-    def try_enable quiet: false
+    if RUBY_VERSION.to_f <= 2.6
+      def override klass
+        sig_method_name = @sig_method_name
+        klass.prepend Module.new{
+          define_method(sig_method_name) do |*args, &block|
+            super(*args, &block)
+          end
+        }
+      end
+    else
+      def override klass
+        sig_method_name = @sig_method_name
+        klass.prepend Module.new{
+          define_method(sig_method_name) do |*args, **kw, &block|
+            super(*args, **kw, &block)
+          end
+        }
+      end
+    end
+
+    def try_enable added: false
       eval_class_name
       search_method
 
       begin
         retried = false
+
         @tp.enable(target: @method)
+        DEBUGGER__.warn "#{self} is activated." if added
+
+        if @sig_op == '#'
+          @cond_class = @klass if @method.owner != @klass
+        else # '.'
+          @cond_class = @klass.singleton_class if @method.owner != @klass.singleton_class
+        end
 
       rescue ArgumentError
         raise if retried
         retried = true
-        sig_method_name = @sig_method_name
 
         # maybe C method
-        @klass.module_eval do
-          orig_name = sig_method_name + '__orig__'
-          alias_method orig_name, sig_method_name
-          define_method(sig_method_name) do |*args|
-            send(orig_name, *args)
-          end
+        case @sig_op
+        when '.'
+          override @klass.singleton_class
+        when '#'
+          override @klass
         end
 
         # re-collect the method object after the above patch
         search_method
+        @override_method = true if @method
         retry
       end
     rescue Exception
-      raise unless quiet
+      raise unless added
     end
 
     def sig
@@ -416,9 +460,9 @@ module DEBUGGER__
 
     def to_s
       if @method
-        "#{LABEL} #{sig}"
+        "#{generate_label("Method")} #{sig} at #{@method.source_location.join(':')}"
       else
-        "#{PENDING_LABEL} #{sig}"
+        "#{generate_label("Method (pending)")} #{sig}"
       end + super
     end
   end