debug 1.3.3 → 1.5.0

data/lib/debug/breakpoint.rb

@@ -4,11 +4,17 @@ require_relative 'color'
 
 module DEBUGGER__
   class Breakpoint
+    include SkipPathHelper
+
     attr_reader :key
 
-    def initialize do_enable = true
+    def initialize cond, command, path, do_enable: true
       @deleted = false
 
+      @cond = cond
+      @command = command
+      @path = path
+
       setup
       enable if do_enable
     end
@@ -23,6 +29,10 @@ module DEBUGGER__
       nil
     end
 
+    def oneshot?
+      defined?(@oneshot) && @oneshot
+    end
+
     def setup
       raise "not implemented..."
     end
@@ -75,6 +85,17 @@ module DEBUGGER__
       false
     end
 
+    def skip_path?(path)
+      case @path
+      when Regexp
+        !path.match?(@path)
+      when String
+        !path.include?(@path)
+      else
+        super
+      end
+    end
+
     include Color
 
     def generate_label(name)
@@ -87,24 +108,43 @@ module DEBUGGER__
     TracePoint.new(:line){}.enable{}
   end
 
+  class ISeqBreakpoint < Breakpoint
+    def initialize iseq, events, oneshot: false
+      @events = events
+      @iseq = iseq
+      @oneshot = oneshot
+      @key = [:iseq, @iseq.path, @iseq.first_lineno].freeze
+
+      super(nil, nil, nil)
+    end
+
+    def setup
+      @tp = TracePoint.new(*@events) do |tp|
+        delete if @oneshot
+        suspend
+      end
+    end
+
+    def enable
+      @tp.enable(target: @iseq)
+    end
+  end
+
   class LineBreakpoint < Breakpoint
     attr_reader :path, :line, :iseq
 
     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
 
-      @key = [@path, @line].freeze
+      @key = [path, @line].freeze
 
-      super()
+      super(cond, command, path)
 
       try_activate
       @pending = !@iseq
@@ -180,7 +220,7 @@ module DEBUGGER__
       nearest = nil # NearestISeq
 
       ObjectSpace.each_iseq{|iseq|
-        if (iseq.absolute_path || iseq.path) == self.path &&
+        if DEBUGGER__.compare_path((iseq.absolute_path || iseq.path), self.path) &&
             iseq.first_lineno <= self.line &&
             iseq.type != :ensure # ensure iseq is copied (duplicated)
 
@@ -235,24 +275,21 @@ module DEBUGGER__
 
   class CatchBreakpoint < Breakpoint
     attr_reader :last_exc
-    include SkipPathHelper
 
-    def initialize pat, cond: nil, command: nil
+    def initialize pat, cond: nil, command: nil, path: nil
       @pat = pat.freeze
       @key = [:catch, @pat].freeze
       @last_exc = nil
 
-      @cond = cond
-      @command = command
-
-      super()
+      super(cond, command, path)
     end
 
     def setup
       @tp = TracePoint.new(:raise){|tp|
-        next if skip_path?(tp.path)
         exc = tp.raised_exception
         next if SystemExit === exc
+        next if skip_path?(tp.path)
+
         next if !safe_eval(tp.binding, @cond) if @cond
         should_suspend = false
 
@@ -277,47 +314,52 @@ module DEBUGGER__
   end
 
   class CheckBreakpoint < Breakpoint
-    def initialize expr
-      @expr = expr.freeze
-      @key = [:check, @expr].freeze
+    def initialize cond:, command: nil, path: nil
+      @key = [:check, cond].freeze
 
-      super()
+      super(cond, command, path)
     end
 
     def setup
       @tp = TracePoint.new(:line){|tp|
-        next if tp.path.start_with? __dir__
-        next if tp.path.start_with? '<internal:'
+        next if SESSION.in_subsession? # TODO: Ractor support
         next if ThreadClient.current.management?
+        next if skip_path?(tp.path)
 
-        if safe_eval tp.binding, @expr
+        if safe_eval tp.binding, @cond
           suspend
         end
       }
     end
 
     def to_s
-      "#{generate_label("Check")} #{@expr}"
+      s = "#{generate_label("Check")}"
+      s += super
+      s
     end
   end
 
   class WatchIVarBreakpoint < Breakpoint
-    def initialize ivar, object, current
+    def initialize ivar, object, current, cond: nil, command: nil, path: nil
       @ivar = ivar.to_sym
       @object = object
-      @key = [:watch, @ivar].freeze
+      @key = [:watch, object.object_id, @ivar].freeze
 
       @current = current
-      super()
+
+      super(cond, command, path)
     end
 
-    def watch_eval
+    def watch_eval(tp)
       result = @object.instance_variable_get(@ivar)
       if result != @current
         begin
           @prev = @current
           @current = result
-          suspend
+
+          if (@cond.nil? || @object.instance_eval(@cond)) && !skip_path?(tp.path)
+            suspend
+          end
         ensure
           remove_instance_variable(:@prev)
         end
@@ -328,10 +370,7 @@ module DEBUGGER__
 
     def setup
       @tp = TracePoint.new(:line, :return, :b_return){|tp|
-        next if tp.path.start_with? __dir__
-        next if tp.path.start_with? '<internal:'
-
-        watch_eval
+        watch_eval(tp)
       }
     end
 
@@ -349,7 +388,7 @@ module DEBUGGER__
   class MethodBreakpoint < Breakpoint
     attr_reader :sig_method_name, :method
 
-    def initialize b, klass_name, op, method_name, cond: nil, command: nil
+    def initialize b, klass_name, op, method_name, cond: nil, command: nil, path: nil
       @sig_klass_name = klass_name
       @sig_op = op
       @sig_method_name = method_name
@@ -358,19 +397,19 @@ module DEBUGGER__
 
       @klass = nil
       @method = nil
-      @cond = cond
       @cond_class = nil
-      @command = command
       @key = "#{klass_name}#{op}#{method_name}".freeze
 
-      super(false)
+      super(cond, command, path, do_enable: false)
     end
 
     def setup
       @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__)
+
+        caller_location = caller_locations(2, 1).first.to_s
+        next if skip_path?(caller_location)
 
         suspend
       }

data/lib/debug/client.rb

@@ -18,29 +18,69 @@ module DEBUGGER__
         case name
         when 'gen-sockpath'
           puts DEBUGGER__.create_unix_domain_socket_name
+        when 'gen-portpath'
+          port_path = File.join(DEBUGGER__.unix_domain_socket_dir, 'tcp_port')
+          File.unlink port_path if File.exist?(port_path)
+          puts port_path
         when 'list-socks'
           cleanup_unix_domain_sockets
           puts list_connections
-        when 'init'
-          if ARGV.shift == '-'
-            puts <<~EOS
-            export RUBYOPT="-r #{__dir__}/prelude $(RUBYOPT)"
-            EOS
-          else
-            puts <<~EOS
-            # add the following lines in your .bash_profile
-
-            eval "$(rdbg init -)"
-            EOS
-          end
+        when 'setup-autoload'
+          setup_autoload
+        else
+          abort "Unknown utility: #{name}"
+        end
+      end
+
+      def working_shell_type
+        shell = `ps -p #{Process.ppid} -o 'args='`
+        case shell
+        when /bash/
+          :bash
+        when /fish/
+          :fish
+        when /csh/
+          :csh
+        when /zsh/
+          :szh
+        when /dash/
+          :dash
+        else
+          :unknown
+        end
+      end
+
+      def setup_autoload
+        prelude_path = File.join(__dir__, 'prelude.rb')
+
+        case shell = working_shell_type
+        when :bash, :zsh
+          puts <<~EOS
+          # add the following lines in your ~/.#{shell}_profile
+
+          if test -s #{prelude_path} ; then
+            export RUBYOPT='-r #{prelude_path}'
+          fi
+
+          # Add `Kernel#bb` method which is alias of `Kernel#debugger`
+          # export RUBY_DEBUG_BB=1
+          EOS
+
+        when :fish
+          puts <<~EOS
+          # add the following lines in your ~/.config/fish/config.fish
+          set -x RUBYOPT "-r #{__dir__}/prelude" $RUBYOPT
+          EOS
+
         else
-          raise "Unknown utility: #{name}"
+          puts "# Sorry that your shell is not supported yet.",
+               "# Please use the content in #{prelude_path} as a reference and modify your login script accordingly."
         end
       end
 
       def cleanup_unix_domain_sockets
         Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*') do |file|
-          if /(\d+)$/ =~ file
+          if File.socket?(file) && (/-(\d+)-\d+$/ =~ file || /-(\d+)$/ =~ file)
             begin
               Process.kill(0, $1.to_i)
             rescue Errno::EPERM
@@ -52,7 +92,9 @@ module DEBUGGER__
       end
 
       def list_connections
-        Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
+        Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*').find_all do |path|
+          File.socket?(path)
+        end
       end
     end
 
@@ -134,9 +176,14 @@ module DEBUGGER__
       trap(:SIGINT){
         send "pause"
       }
-      trap(:SIGWINCH){
-        @width = IO.console_size[1]
-      }
+
+      begin
+        trap(:SIGWINCH){
+          @width = IO.console_size[1]
+        }
+      rescue ArgumentError
+        @width = 80
+      end
 
       while line = @s.gets
         p recv: line if $VERBOSE

data/lib/debug/color.rb

@@ -48,33 +48,29 @@ module DEBUGGER__
 
     if defined? IRB::ColorPrinter.pp
       def color_pp obj, width
-        if !CONFIG[:no_color]
-          IRB::ColorPrinter.pp(obj, "".dup, width)
-        else
-          obj.pretty_inspect
+        with_inspection_error_guard do
+          if !CONFIG[:no_color]
+            IRB::ColorPrinter.pp(obj, "".dup, width)
+          else
+            obj.pretty_inspect
+          end
         end
       end
     else
       def color_pp obj, width
-        obj.pretty_inspect
+        with_inspection_error_guard do
+          obj.pretty_inspect
+        end
       end
     end
 
     def colored_inspect obj, width: SESSION.width, no_color: false
-      if !no_color
-        color_pp obj, width
-      else
-        obj.pretty_inspect
-      end
-    rescue => ex
-      err_msg = "#{ex.inspect} rescued during inspection"
-      string_result = obj.to_s rescue nil
-
-      # don't colorize the string here because it's not from user's application
-      if string_result
-        %Q{"#{string_result}" from #to_s because #{err_msg}}
-      else
-        err_msg
+      with_inspection_error_guard do
+        if !no_color
+          color_pp obj, width
+        else
+          obj.pretty_inspect
+        end
       end
     end
 
@@ -109,5 +105,19 @@ module DEBUGGER__
     def colorize_dim(str)
       colorize(str, [:DIM])
     end
+
+    def with_inspection_error_guard
+      yield
+    rescue Exception => ex
+      err_msg = "#{ex.inspect} rescued during inspection"
+      string_result = obj.to_s rescue nil
+
+      # don't colorize the string here because it's not from user's application
+      if string_result
+        %Q{"#{string_result}" from #to_s because #{err_msg}}
+      else
+        err_msg
+      end
+    end
   end
 end

data/lib/debug/config.rb

@@ -43,20 +43,23 @@ module DEBUGGER__
     sock_dir:       ['RUBY_DEBUG_SOCK_DIR',     "REMOTE: UNIX Domain Socket remote debugging: socket directory"],
     cookie:         ['RUBY_DEBUG_COOKIE',       "REMOTE: Cookie for negotiation"],
     open_frontend:  ['RUBY_DEBUG_OPEN_FRONTEND',"REMOTE: frontend used by open command (vscode, chrome, default: rdbg)."],
+    chrome_path:    ['RUBY_DEBUG_CHROME_PATH',  "REMOTE: Platform dependent path of Chrome (For more information, See [here](https://github.com/ruby/debug/pull/334/files#diff-5fc3d0a901379a95bc111b86cf0090b03f857edfd0b99a0c1537e26735698453R55-R64))"],
 
     # obsolete
     parent_on_fork: ['RUBY_DEBUG_PARENT_ON_FORK', "OBSOLETE: Keep debugging parent process on fork (default: false)",     :bool],
   }.freeze
 
-  CONFIG_MAP = CONFIG_SET.map{|k, (ev, desc)| [k, ev]}.to_h.freeze
+  CONFIG_MAP = CONFIG_SET.map{|k, (ev, _)| [k, ev]}.to_h.freeze
 
   class Config
+    @config = nil
+
     def self.config
       @config
     end
 
     def initialize argv
-      if self.class.instance_variable_defined? :@config
+      if self.class.config
         raise 'Can not make multiple configurations in one process'
       end
 
@@ -480,7 +483,7 @@ module DEBUGGER__
     self.helps.each{|cat, cmds|
       r << "### #{cat}"
       r << ''
-      cmds.each{|ws, desc|
+      cmds.each{|_, desc|
         r << desc
       }
       r << ''

data/lib/debug/console.rb

@@ -30,10 +30,38 @@ module DEBUGGER__
         prepend m
       end if SIGWINCH_SUPPORTED
 
+      def parse_input buff, commands
+        c, rest = get_command buff
+        case
+        when commands.keys.include?(c)
+          :command
+        when !rest && /\A\s*[a-z]*\z/ =~ c
+          nil
+        else
+          :ruby
+        end
+      end
+
       def readline_setup prompt
         load_history_if_not_loaded
         commands = DEBUGGER__.commands
 
+        prev_completion_proc = Reline.completion_proc
+        prev_output_modifier_proc = Reline.output_modifier_proc
+        prev_prompt_proc = Reline.prompt_proc
+
+        # prompt state
+        state = nil # :command, :ruby, nil (unknown)
+
+        Reline.prompt_proc = -> args, *kw do
+          case state = parse_input(args.first, commands)
+          when nil, :command
+            [prompt, prompt]
+          when :ruby
+            [prompt.sub('rdbg'){colorize('ruby', [:RED])}] * 2
+          end
+        end
+
         Reline.completion_proc = -> given do
           buff = Reline.line_buffer
           Reline.completion_append_character= ' '
@@ -46,17 +74,16 @@ module DEBUGGER__
             end
             files
           else
-            commands.keys.grep(/\A#{given}/)
+            commands.keys.grep(/\A#{Regexp.escape(given)}/)
           end
         end
 
         Reline.output_modifier_proc = -> buff, **kw do
           c, rest = get_command buff
 
-          case
-          when commands.keys.include?(c = c.strip)
-            # [:DIM, :CYAN, :BLUE, :CLEAR, :UNDERLINE, :REVERSE, :RED, :GREEN, :MAGENTA, :BOLD, :YELLOW]
-            cmd = colorize(c.strip, [:CYAN, :UNDERLINE])
+          case state
+          when :command
+            cmd = colorize(c, [:CYAN, :UNDERLINE])
 
             if commands[c] == c
               rprompt = colorize("    # command", [:DIM])
@@ -64,28 +91,36 @@ module DEBUGGER__
               rprompt = colorize("    # #{commands[c]} command", [:DIM])
             end
 
-            rest = (rest ? colorize_code(rest) : '') + rprompt
-            cmd + rest
-          when !rest && /\A\s*[a-z]*\z/ =~ c
+            rest = rest ? colorize_code(rest) : ''
+            cmd + rest + rprompt
+          when nil
             buff
-          else
-            colorize_code(buff.chomp) + colorize("    # ruby", [:DIM])
+          when :ruby
+            colorize_code(buff.chomp)
           end
         end
+
+        yield
+
+      ensure
+        Reline.completion_proc = prev_completion_proc
+        Reline.output_modifier_proc = prev_output_modifier_proc
+        Reline.prompt_proc = prev_prompt_proc
       end
 
       private def get_command line
         case line.chomp
         when /\A(\s*[a-z]+)(\s.*)?\z$/
-          return $1, $2
+          return $1.strip, $2
         else
-          line.chomp
+          line.strip
         end
       end
 
       def readline prompt
-        readline_setup prompt
-        Reline.readmultiline(prompt, true){ true }
+        readline_setup prompt do
+          Reline.readmultiline(prompt, true){ true }
+        end
       end
 
       def history
@@ -145,7 +180,7 @@ module DEBUGGER__
     FH = "# Today's OMIKUJI: "
 
     def read_history_file
-      if history && File.exists?(path = history_file)
+      if history && File.exist?(path = history_file)
         f = (['', 'DAI-', 'CHU-', 'SHO-'].map{|e| e+'KICHI'}+['KYO']).sample
         ["#{FH}#{f}".dup] + File.readlines(path)
       else

data/lib/debug/frame_info.rb

@@ -2,10 +2,11 @@
 
 module DEBUGGER__
   FrameInfo = Struct.new(:location, :self, :binding, :iseq, :class, :frame_depth,
-                          :has_return_value, :return_value,
+                          :has_return_value,     :return_value,
                           :has_raised_exception, :raised_exception,
                           :show_line,
-                          :_local_variables, :_callee # for recorder
+                          :_local_variables, :_callee, # for recorder
+                          :dupped_binding,
                         )
 
   # extend FrameInfo with debug.so
@@ -31,7 +32,7 @@ module DEBUGGER__
       use_short_path = CONFIG[:use_short_path]
 
       case
-      when use_short_path && path.start_with?(dir = CONFIG["rubylibdir"] + '/')
+      when use_short_path && path.start_with?(dir = RbConfig::CONFIG["rubylibdir"] + '/')
         path.sub(dir, '$(rubylibdir)/')
       when use_short_path && Gem.path.any? do |gp|
           path.start_with?(dir = gp + '/gems/')
@@ -82,14 +83,14 @@ module DEBUGGER__
 
     def block_identifier
       return unless frame_type == :block
-      args = parameters_info(iseq.argc)
+      args = parameters_info
       _, level, block_loc = location.label.match(BLOCK_LABL_REGEXP).to_a
       [level || "", block_loc, args]
     end
 
     def method_identifier
       return unless frame_type == :method
-      args = parameters_info(iseq.argc)
+      args = parameters_info
       ci = "#{klass_sig}#{callee}"
       [ci, args]
     end
@@ -110,7 +111,7 @@ module DEBUGGER__
 
     def return_str
       if self.binding && iseq && has_return_value
-        DEBUGGER__.short_inspect(return_value)
+        DEBUGGER__.safe_inspect(return_value, short: true)
       end
     end
 
@@ -118,19 +119,12 @@ module DEBUGGER__
       "#{pretty_path}:#{location.lineno}"
     end
 
-    private def make_binding
-      __newb__ = self.self.instance_eval('binding')
-      self.local_variables.each{|var, val|
-        __newb__.local_variable_set(var, val)
-      }
-      __newb__
-    end
-
     def eval_binding
-      if b = self.binding
+      if b = self.dupped_binding
         b
-      elsif self.local_variables
-        make_binding
+      else
+        b = self.binding || TOPLEVEL_BINDING
+        self.dupped_binding = b.dup
       end
     end
 
@@ -156,11 +150,11 @@ module DEBUGGER__
       local_variables[var]
     end
 
-    def parameters_info(argc)
-      vars = iseq.locals[0...argc]
+    def parameters_info
+      vars = iseq.parameters_symbols
       vars.map{|var|
         begin
-          { name: var, value: DEBUGGER__.short_inspect(local_variable_get(var)) }
+          { name: var, value: DEBUGGER__.safe_inspect(local_variable_get(var), short: true) }
         rescue NameError, TypeError
           nil
         end

data/lib/debug/local.rb

@@ -98,7 +98,7 @@ module DEBUGGER__
           # only check child process from its parent
           begin
             # wait for all child processes to keep terminal
-            loop{ Process.waitpid }
+            Process.waitpid
           rescue Errno::ESRCH, Errno::ECHILD
           end
         end

data/lib/debug/prelude.rb

@@ -2,9 +2,9 @@
 
 return if defined?(::DEBUGGER__)
 
+# Put the following line in your login script (e.g. ~/.bash_profile) with modified path:
 #
-# put the following line in .bash_profile
-#   export RUBYOPT="-r .../debug/prelude $(RUBYOPT)"
+#   export RUBYOPT="-r /path/to/debug/prelude $(RUBYOPT)"
 #
 module Kernel
   def debugger(*a, up_level: 0, **kw)