debug 1.6.1 → 1.9.1

data/ext/debug/debug.c

@@ -62,21 +62,34 @@ di_body(const rb_debug_inspector_t *dc, void *ptr)
     long i;
 
     for (i=1; i<len; i++) {
-        VALUE loc, e;
+        VALUE e;
         VALUE iseq = rb_debug_inspector_frame_iseq_get(dc, i);
+        VALUE loc = RARRAY_AREF(locs, i);
+        VALUE path;
 
         if (!NIL_P(iseq)) {
-            VALUE path = iseq_realpath(iseq);
-            if (!NIL_P(path) && !NIL_P(skip_path_prefix) && str_start_with(path, skip_path_prefix)) continue;
+            path = iseq_realpath(iseq);
+        }
+        else {
+            // C frame
+            path = rb_funcall(loc, rb_intern("path"), 0);
+        }
+
+        if (!NIL_P(path) && !NIL_P(skip_path_prefix) && str_start_with(path, skip_path_prefix)) {
+            continue;
         }
 
-        loc = RARRAY_AREF(locs, i);
         e = di_entry(loc,
                      rb_debug_inspector_frame_self_get(dc, i),
                      rb_debug_inspector_frame_binding_get(dc, i),
                      iseq,
                      rb_debug_inspector_frame_class_get(dc, i),
-                     INT2FIX(len - i));
+#ifdef RB_DEBUG_INSPECTOR_FRAME_DEPTH
+                     rb_debug_inspector_frame_depth(dc, i)
+#else
+                     INT2FIX(len - i)
+#endif
+                     );
         rb_ary_push(ary, e);
     }
 
@@ -89,6 +102,13 @@ capture_frames(VALUE self, VALUE skip_path_prefix)
     return rb_debug_inspector_open(di_body, (void *)skip_path_prefix);
 }
 
+#ifdef RB_DEBUG_INSPECTOR_FRAME_DEPTH
+static VALUE
+frame_depth(VALUE self)
+{
+    return rb_debug_inspector_current_depth();
+}
+#else
 static VALUE
 frame_depth(VALUE self)
 {
@@ -96,6 +116,8 @@ frame_depth(VALUE self)
     VALUE bt = rb_make_backtrace();
     return INT2FIX(RARRAY_LEN(bt));
 }
+#endif
+
 
 // iseq
 
@@ -166,13 +188,17 @@ iseq_last_line(VALUE iseqw)
 }
 #endif
 
+#ifdef HAVE_RB_ISEQ
 void Init_iseq_collector(void);
+#endif
 
 void
 Init_debug(void)
 {
+#ifdef HAVE_RB_ISEQ
     VALUE rb_mRubyVM = rb_const_get(rb_cObject, rb_intern("RubyVM"));
     VALUE rb_cISeq = rb_const_get(rb_mRubyVM, rb_intern("InstructionSequence"));
+#endif
     rb_mDebugger = rb_const_get(rb_cObject, rb_intern("DEBUGGER__"));
     rb_cFrameInfo = rb_const_get(rb_mDebugger, rb_intern("FrameInfo"));
 
@@ -196,5 +222,7 @@ Init_debug(void)
     rb_define_method(rb_cISeq, "last_line", iseq_last_line, 0);
 #endif
 
+#ifdef HAVE_RB_ISEQ
     Init_iseq_collector();
+#endif
 }

data/ext/debug/extconf.rb

@@ -4,6 +4,7 @@ File.write("debug_version.h", "#define RUBY_DEBUG_VERSION \"#{DEBUGGER__::VERSIO
 $distcleanfiles << "debug_version.h"
 
 if defined? RubyVM
+  $defs << '-DHAVE_RB_ISEQ'
   $defs << '-DHAVE_RB_ISEQ_PARAMETERS'
   $defs << '-DHAVE_RB_ISEQ_CODE_LOCATION'
 

data/ext/debug/iseq_collector.c

@@ -1,5 +1,6 @@
 #include <ruby/ruby.h>
 
+#ifdef HAVE_RB_ISEQ
 VALUE rb_iseqw_new(VALUE v);
 void rb_objspace_each_objects(
     int (*callback)(void *start, void *end, size_t stride, void *data),
@@ -89,3 +90,4 @@ Init_iseq_collector(void)
     rb_define_singleton_method(rb_mObjSpace, "each_iseq", each_iseq, 0);
     rb_define_singleton_method(rb_mObjSpace, "count_iseq", count_iseq, 0);
 }
+#endif

data/lib/debug/abbrev_command.rb

@@ -0,0 +1,77 @@
+
+module DEBUGGER__
+  class AbbrevCommand
+    class TrieNode
+      def initialize
+        @children = {}
+        @types = {} # set
+      end
+
+      def append c, type
+        trie = (@children[c] ||= TrieNode.new)
+        trie.add_type type
+      end
+
+      def [](c)
+        @children[c]
+      end
+
+      def add_type type
+        @types[type] = true
+        self
+      end
+
+      def types
+        @types.keys
+      end
+
+      def type
+        if @types.size == 1
+          @types.keys.first
+        else
+          nil
+        end
+      end
+
+      def candidates
+        @children.map{|c, n|
+          ss = n.candidates
+          ss.empty? ? c :
+          ss.map{|s|
+            c+s
+          }
+        }.flatten
+      end
+    end
+
+    # config: { type: [commands...], ... }
+    def initialize config
+      @trie = TrieNode.new
+      build config
+    end
+
+    private def build config
+      config.each do |type, commands|
+        commands.each do |command|
+          trie = @trie
+          command.each_char do |c|
+            trie = trie.append(c, type)
+          end
+        end
+      end
+    end
+
+    def search str, if_none = nil
+      trie = @trie
+      str.each_char do |c|
+        if trie = trie[c]
+          return trie.type if trie.type
+        else
+          return if_none
+        end
+      end
+      yield trie.candidates.map{|s| str + s} if block_given?
+      if_none
+    end
+  end
+end

data/lib/debug/breakpoint.rb

@@ -6,7 +6,7 @@ module DEBUGGER__
   class Breakpoint
     include SkipPathHelper
 
-    attr_reader :key
+    attr_reader :key, :skip_src
 
     def initialize cond, command, path, do_enable: true
       @deleted = false
@@ -141,10 +141,11 @@ module DEBUGGER__
       nbp
     end
 
-    def initialize path, line, cond: nil, oneshot: false, hook_call: true, command: nil, skip_activate: false
+    def initialize path, line, cond: nil, oneshot: false, hook_call: true, command: nil, skip_activate: false, skip_src: false
       @line = line
       @oneshot = oneshot
       @hook_call = hook_call
+      @skip_src = skip_src
       @pending = false
 
       @iseq = nil
@@ -196,8 +197,10 @@ module DEBUGGER__
       enable
 
       if @pending && !@oneshot
-        DEBUGGER__.warn "#{self} is activated."
+        DEBUGGER__.info "#{self} is activated."
       end
+
+      @pending = false
     end
 
     def activate_exact iseq, events, line
@@ -264,13 +267,10 @@ module DEBUGGER__
 
           if !nearest || ((line - nline).abs < (line - nearest.line).abs)
             nearest = NearestISeq.new(iseq, nline, events)
-          else
-            if @hook_call && nearest.iseq.first_lineno <= iseq.first_lineno
-              if (nearest.line > line && !nearest.events.include?(:RUBY_EVENT_CALL)) ||
-                (events.include?(:RUBY_EVENT_CALL))
-                nearest = NearestISeq.new(iseq, nline, events)
-              end
-            end
+          elsif @hook_call &&
+                nearest.line == iseq.first_line &&
+                events.include?(:RUBY_EVENT_CALL)
+            nearest = NearestISeq.new(iseq, nline, events)
           end
         end
       end
@@ -293,6 +293,10 @@ module DEBUGGER__
     def inspect
       "<#{self.class.name} #{self.to_s}>"
     end
+
+    def path_is? path
+      DEBUGGER__.compare_path(@path, path)
+    end
   end
 
   class CatchBreakpoint < Breakpoint
@@ -500,7 +504,7 @@ module DEBUGGER__
         retried = false
 
         @tp.enable(target: @method)
-        DEBUGGER__.warn "#{self} is activated." if added
+        DEBUGGER__.info "#{self} is activated." if added
 
         if @sig_op == '#'
           @cond_class = @klass if @method.owner != @klass

data/lib/debug/client.rb

@@ -25,6 +25,9 @@ module DEBUGGER__
         when 'list-socks'
           cleanup_unix_domain_sockets
           puts list_connections
+        when 'list-socks-verbose'
+          cleanup_unix_domain_sockets
+          puts list_connections verbose: true
         when 'setup-autoload'
           setup_autoload
         else
@@ -42,7 +45,7 @@ module DEBUGGER__
         when /csh/
           :csh
         when /zsh/
-          :szh
+          :zsh
         when /dash/
           :dash
         else
@@ -91,10 +94,24 @@ module DEBUGGER__
         end
       end
 
-      def list_connections
-        Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*').find_all do |path|
+      def list_connections verbose: false
+        socks = Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*').find_all do |path|
           File.socket?(path)
         end
+
+        if verbose
+          socks = socks.map{|sock_path|
+            Socket.unix(sock_path){|sock|
+              sock.puts "info cookie: #{CONFIG[:cookie] || '-'}"
+              pid = sock.gets.chomp
+              _dbg = sock.gets.chomp
+              _unm = sock.gets.chomp
+              [sock_path, pid]
+            }
+          }
+        end
+
+        socks
       end
     end
 
@@ -157,9 +174,10 @@ module DEBUGGER__
         when 1
           @s = Socket.unix(files.first)
         else
+          files = Client.list_connections verbose: true
           $stderr.puts "Please select a debug session:"
-          files.each{|f|
-            $stderr.puts "  #{File.basename(f)}"
+          files.each{|(f, desc)|
+            $stderr.puts "  #{File.basename(f)} (#{desc})"
           }
           exit
         end
@@ -222,7 +240,7 @@ module DEBUGGER__
         when /^ask (\d+) (.*)/
           pid = $1
           print $2
-          send "answer #{pid} #{gets || ''}"
+          send "answer #{pid} #{$stdin.gets || ''}"
 
         when /^quit/
           raise 'quit'
@@ -231,8 +249,8 @@ module DEBUGGER__
           puts "(unknown) #{line.inspect}"
         end
       end
-    rescue
-      STDERR.puts "disconnected (#{$!})"
+    rescue => e
+      STDERR.puts "disconnected (#{e})"
       exit
     ensure
       deactivate

data/lib/debug/config.rb

@@ -14,12 +14,15 @@ module DEBUGGER__
     # UI setting
     log_level:      ['RUBY_DEBUG_LOG_LEVEL',      "UI: Log level same as Logger",               :loglevel, "WARN"],
     show_src_lines: ['RUBY_DEBUG_SHOW_SRC_LINES', "UI: Show n lines source code on breakpoint", :int, "10"],
+    show_evaledsrc: ['RUBY_DEBUG_SHOW_EVALEDSRC', "UI: Show actually evaluated source",         :bool, "false"],
     show_frames:    ['RUBY_DEBUG_SHOW_FRAMES',    "UI: Show n frames on breakpoint",            :int, "2"],
     use_short_path: ['RUBY_DEBUG_USE_SHORT_PATH', "UI: Show shorten PATH (like $(Gem)/foo.rb)", :bool, "false"],
     no_color:       ['RUBY_DEBUG_NO_COLOR',       "UI: Do not use colorize",                    :bool, "false"],
     no_sigint_hook: ['RUBY_DEBUG_NO_SIGINT_HOOK', "UI: Do not suspend on SIGINT",               :bool, "false"],
     no_reline:      ['RUBY_DEBUG_NO_RELINE',      "UI: Do not use Reline library",              :bool, "false"],
     no_hint:        ['RUBY_DEBUG_NO_HINT',        "UI: Do not show the hint on the REPL",       :bool, "false"],
+    no_lineno:      ['RUBY_DEBUG_NO_LINENO',      "UI: Do not show line numbers",               :bool, "false"],
+    irb_console:    ["RUBY_DEBUG_IRB_CONSOLE",    "UI: Use IRB as the console",                 :bool, "false"],
 
     # control setting
     skip_path:      ['RUBY_DEBUG_SKIP_PATH',      "CONTROL: Skip showing/entering frames for given paths", :path],
@@ -33,12 +36,13 @@ module DEBUGGER__
     nonstop:        ['RUBY_DEBUG_NONSTOP',     "BOOT: Nonstop mode",                                                :bool, "false"],
     stop_at_load:   ['RUBY_DEBUG_STOP_AT_LOAD',"BOOT: Stop at just loading location",                               :bool, "false"],
     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 ';;'"],
+    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, "false"],
     history_file:   ['RUBY_DEBUG_HISTORY_FILE',"BOOT: history file",               :string, "~/.rdbg_history"],
     save_history:   ['RUBY_DEBUG_SAVE_HISTORY',"BOOT: maximum save history lines", :int, "10000"],
 
     # remote setting
+    open:           ['RUBY_DEBUG_OPEN',         "REMOTE: Open remote port (same as `rdbg --open` option)"],
     port:           ['RUBY_DEBUG_PORT',         "REMOTE: TCP/IP remote debugging: port"],
     host:           ['RUBY_DEBUG_HOST',         "REMOTE: TCP/IP remote debugging: host", :string, "127.0.0.1"],
     sock_path:      ['RUBY_DEBUG_SOCK_PATH',    "REMOTE: UNIX Domain Socket remote debugging: socket path"],
@@ -46,7 +50,7 @@ module DEBUGGER__
     local_fs_map:   ['RUBY_DEBUG_LOCAL_FS_MAP', "REMOTE: Specify local fs map", :path_map],
     skip_bp:        ['RUBY_DEBUG_SKIP_BP',      "REMOTE: Skip breakpoints if no clients are attached", :bool, 'false'],
     cookie:         ['RUBY_DEBUG_COOKIE',       "REMOTE: Cookie for negotiation"],
-    open_frontend:  ['RUBY_DEBUG_OPEN_FRONTEND',"REMOTE: frontend used by open command (vscode, chrome, default: rdbg)."],
+    session_name:   ['RUBY_DEBUG_SESSION_NAME', "REMOTE: Session name for differentiating multiple sessions"],
     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
@@ -63,8 +67,6 @@ module DEBUGGER__
     end
 
     def initialize argv
-      @skip_all = false
-
       if self.class.config
         raise 'Can not make multiple configurations in one process'
       end
@@ -94,14 +96,6 @@ module DEBUGGER__
       set_config(key => val)
     end
 
-    def skip_all
-      @skip_all = true
-    end
-
-    def skip?
-      @skip_all
-    end
-
     def set_config(**kw)
       conf = config.dup
       kw.each{|k, v|
@@ -158,6 +152,12 @@ module DEBUGGER__
       if_updated old_conf, conf, :sigdump_sig do |old_sig, new_sig|
         setup_sigdump old_sig, new_sig
       end
+
+      if_updated old_conf, conf, :no_sigint_hook do |old, new|
+        if defined?(SESSION)
+          SESSION.set_no_sigint_hook old, new
+        end
+      end
     end
 
     private def if_updated old_conf, new_conf, key
@@ -268,6 +268,8 @@ module DEBUGGER__
       require 'optparse'
       require_relative 'version'
 
+      have_shown_version = false
+
       opt = OptionParser.new do |o|
         o.banner = "#{$0} [options] -- [debuggee options]"
         o.separator ''
@@ -308,8 +310,25 @@ module DEBUGGER__
                                         'If TCP/IP options are not given, a UNIX domain socket will be used.',
                                         'If FRONTEND is given, prepare for the FRONTEND.',
                                         'Now rdbg, vscode and chrome is supported.') do |f|
-          config[:remote] = true
-          config[:open_frontend] = f.downcase if f
+
+          case f # some format patterns are not documented yet
+          when nil
+            config[:open] = true
+          when /\A\d\z/
+            config[:open] = true
+            config[:port] = f.to_i
+          when /\A(\S+):(\d+)\z/
+            config[:open] = true
+            config[:host] = $1
+            config[:port] = $2.to_i
+          when 'tcp'
+            config[:open] = true
+            config[:port] ||= 0
+          when 'vscode', 'chrome', 'cdp'
+            config[:open] = f&.downcase
+          else
+            raise "Unknown option for --open: #{f}"
+          end
         end
         o.on('--sock-path=SOCK_PATH', 'UNIX Domain socket path') do |path|
           config[:sock_path] = path
@@ -323,6 +342,9 @@ module DEBUGGER__
         o.on('--cookie=COOKIE', 'Set a cookie for connection') do |c|
           config[:cookie] = c
         end
+        o.on('--session-name=NAME', 'Session name') do |name|
+          config[:session_name] = name
+        end
 
         rdbg = 'rdbg'
 
@@ -358,6 +380,16 @@ module DEBUGGER__
         o.separator ''
         o.separator 'Other options:'
 
+        o.on('-v', 'Show version number') do
+          puts o.ver
+          have_shown_version = true
+        end
+
+        o.on('--version', 'Show version number and exit') do
+          puts o.ver
+          exit
+        end
+
         o.on("-h", "--help", "Print help") do
           puts o
           exit
@@ -381,6 +413,13 @@ module DEBUGGER__
 
       opt.parse!(argv)
 
+      if argv.empty?
+        case
+        when have_shown_version && config[:mode] == :start
+          exit
+        end
+      end
+
       config
     end
 
@@ -411,8 +450,9 @@ module DEBUGGER__
     unless (dir_uid = fs.uid) == (uid = Process.uid)
       raise "#{path} uid is #{dir_uid}, but Process.uid is #{uid}"
     end
-    unless (dir_mode = fs.mode) == 040700 # 4: dir, 7:rwx
-      raise "#{path}'s mode is #{dir_mode.to_s(8)} (should be 040700)"
+
+    if fs.world_writable? && !fs.sticky?
+      raise "#{path} is world writable but not sticky"
     end
 
     path
@@ -422,7 +462,7 @@ module DEBUGGER__
     require 'tmpdir'
 
     if tmpdir = Dir.tmpdir
-      path = File.join(tmpdir, "ruby-debug-sock-#{Process.uid}")
+      path = File.join(tmpdir, "rdbg-#{Process.uid}")
 
       unless File.exist?(path)
         d = Dir.mktmpdir
@@ -435,7 +475,7 @@ module DEBUGGER__
 
   def self.unix_domain_socket_homedir
     if home = ENV['HOME']
-      path = File.join(home, '.ruby-debug-sock')
+      path = File.join(home, '.rdbg-sock')
 
       unless File.exist?(path)
         Dir.mkdir(path, 0700)
@@ -459,12 +499,14 @@ module DEBUGGER__
   end
 
   def self.create_unix_domain_socket_name_prefix(base_dir = unix_domain_socket_dir)
-    user = ENV['USER'] || 'UnknownUser'
-    File.join(base_dir, "ruby-debug-#{user}")
+    File.join(base_dir, "rdbg")
   end
 
   def self.create_unix_domain_socket_name(base_dir = unix_domain_socket_dir)
-    create_unix_domain_socket_name_prefix(base_dir) + "-#{Process.pid}"
+    suffix = "-#{Process.pid}"
+    name = CONFIG[:session_name]
+    suffix << "-#{name}" if name
+    create_unix_domain_socket_name_prefix(base_dir) + suffix
   end
 
   ## Help
@@ -479,10 +521,14 @@ module DEBUGGER__
       when /\A\s*### (.+)/
         cat = $1
         break if $1 == 'END'
-      when /\A      when (.+)/
+      when /\A      register_command (.+)/
         next unless cat
         next unless desc
-        ws = $1.split(/,\s*/).map{|e| e.gsub('\'', '')}
+
+        ws = []
+        $1.gsub(/'([a-z]+)'/){|w|
+          ws << $1
+        }
         helps[cat] << [ws, desc]
         desc = nil
         max_w = ws.max_by{|w| w.length}

data/lib/debug/console.rb

@@ -5,30 +5,9 @@ module DEBUGGER__
       raise LoadError if CONFIG[:no_reline]
       require 'reline'
 
-      # reline 0.2.7 or later is required.
-      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
-          def reset(prompt = '', encoding:)
-            super
-            Signal.trap(:SIGWINCH, nil)
-          end
-        end
-        prepend m
-      end if SIGWINCH_SUPPORTED
+      include Color
 
       def parse_input buff, commands
         c, rest = get_command buff
@@ -56,10 +35,10 @@ module DEBUGGER__
         Reline.prompt_proc = -> args, *kw do
           case state = parse_input(args.first, commands)
           when nil, :command
-            [prompt, prompt]
+            [prompt]
           when :ruby
-            [prompt.sub('rdbg'){colorize('ruby', [:RED])}] * 2
-          end
+            [prompt.sub('rdbg'){colorize('ruby', [:RED])}]
+          end * args.size
         end
 
         Reline.completion_proc = -> given do
@@ -96,7 +75,7 @@ module DEBUGGER__
           when nil
             buff
           when :ruby
-            colorize_code(buff.chomp)
+            colorize_code(buff)
           end
         end unless CONFIG[:no_hint]
 
@@ -224,11 +203,11 @@ module DEBUGGER__
     end
 
     def load_history
-      read_history_file.count{|line|
+      read_history_file.each{|line|
         line.strip!
         history << line unless line.empty?
-      }
+      } if history.empty?
+      history.count
     end
   end # class Console
 end
-