debug 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ed57ff87f1864d86d79c435081b12df6cb35bd4f24a3cb79f4a909887e5f41
-  data.tar.gz: c342d515e9358e0cfdee353b5d5be1fbbb7bcf46cfdf3f925ace7a3acc2b6e90
+  metadata.gz: 9702de02ad9d9aab11e0f0113a3596110222f92178e2918e6f4c5ad66fb5e3fb
+  data.tar.gz: 6f8552da80d13f0c597223fa651a49f44810d7106feb73c8a93d73249c74a987
 SHA512:
-  metadata.gz: 112d49a60540e034752e1c3d3721c213549cae4653c63041c3f3da08cf7bf01624e8a45c0ee88ff31270eef337cf8db3ca8de7d403eea550aff82621050e9e14
-  data.tar.gz: e6800fb760a734419ed43fa04720b0bc75a815f0de4511df7f76a44b9b864c002eb6c9503f74e1a9471d335f671f0db12636e852cc6bac0366ba00d051e29b0b
+  metadata.gz: 1a2386cd5fcde06d356cb35e1d5ff637c587c33a4fdf9e3866d11761276a31cf5586d383b8cd8f6074be24a681592db7d577b8fcf3270d63afff9256ddaaa78f
+  data.tar.gz: 373039bc43b6071d77c4bb103453258a50668224ea581b4fd0b5ec0bf3df7c4b95702e2bc3723e35c55e238aaf6fa9297090fa7daf8fe4c6eee22124f1087daf

data/.gitignore

@@ -6,4 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.bundle
 /Gemfile.lock

data/README.md

@@ -321,10 +321,14 @@ The `<...>` notation means the argument.
   * Finish this frame. Resume the program until the current frame is finished.
 * `c[ontinue]`
   * Resume the program.
-* `q[uit]` or exit or `Ctrl-D`
+* `q[uit]` or `Ctrl-D`
   * Finish debugger (with the debuggee process on non-remote debugging).
-* `kill` or `q[uit]!`
-  * Stop the debuggee process.
+* `q[uit]!`
+  * Same as q[uit] but without the confirmation prompt.
+* `kill`
+  * Stop the debuggee process with `Kernal#exit!`.
+* `kill!`
+  * Same as kill but without the confirmation prompt.
 
 ### Breakpoint
 
@@ -346,7 +350,7 @@ The `<...>` notation means the argument.
 * `catch <Error>`
   * Set breakpoint on raising `<Error>`.
 * `watch <expr>`
-  * Stop the execution when the result of <expr> is changed.
+  * Stop the execution when the result of `<expr>` is changed.
   * Note that this feature is super slow.
 * `del[ete]`
   * delete all breakpoints.
@@ -388,13 +392,13 @@ The `<...>` notation means the argument.
 ### Frame control
 
 * `f[rame]`
-  * Show current frame.
+  * Show the current frame.
 * `f[rame] <framenum>`
-  * Specify frame. Evaluation are run on this frame environment.
+  * Specify a current frame. Evaluation are run on specified frame.
 * `up`
-  * Specify upper frame.
+  * Specify the upper frame.
 * `down`
-  * Specify down frame.
+  * Specify the lower frame.
 
 ### Evaluate
 
@@ -438,23 +442,23 @@ Debug console mode:
 
   Debug console mode runs Ruby program with the debug console.
 
-  exe/rdbg target.rb foo bar                 starts like 'ruby target.rb foo bar'.
-  exe/rdbg -- -r foo -e bar                  starts like 'ruby -r foo -e bar'.
-  exe/rdbg -O target.rb foo bar              starts and accepts attaching with UNIX domain socket.
-  exe/rdbg -O --port 1234 target.rb foo bar  starts accepts attaching with TCP/IP localhost:1234.
-  exe/rdbg -O --port 1234 -- -r foo -e bar   starts accepts attaching with TCP/IP localhost:1234.
+  rdbg target.rb foo bar                 starts like 'ruby target.rb foo bar'.
+  rdbg -- -r foo -e bar                  starts like 'ruby -r foo -e bar'.
+  rdbg -O target.rb foo bar              starts and accepts attaching with UNIX domain socket.
+  rdbg -O --port 1234 target.rb foo bar  starts accepts attaching with TCP/IP localhost:1234.
+  rdbg -O --port 1234 -- -r foo -e bar   starts accepts attaching with TCP/IP localhost:1234.
 
 Attach mode:
     -A, --attach                     Attach to debuggee process.
 
   Attach mode attaches the remote debug console to the debuggee process.
 
-  'exe/rdbg -A' tries to connect via UNIX domain socket.
-                      If there are multiple processes are waiting for the
-                      debugger connection, list possible debuggee names.
-  'exe/rdbg -A path' tries to connect via UNIX domain socket with given path name.
-  'exe/rdbg -A port' tries to connect localhost:port via TCP/IP.
-  'exe/rdbg -A host port' tries to connect host:port via TCP/IP.
+  'rdbg -A' tries to connect via UNIX domain socket.
+            If there are multiple processes are waiting for the
+            debugger connection, list possible debuggee names.
+  'rdbg -A path' tries to connect via UNIX domain socket with given path name.
+  'rdbg -A port' tries to connect to localhost:port via TCP/IP.
+  'rdbg -A host port' tries to connect to host:port via TCP/IP.
 
 ```
 

data/lib/debug/breakpoint.rb

@@ -28,7 +28,7 @@ module DEBUGGER__
     end
 
     def disable
-      @tp.disable
+      @tp&.disable
     end
 
     def enabled?
@@ -144,7 +144,10 @@ module DEBUGGER__
       nearest = nil # NearestISeq
 
       ObjectSpace.each_iseq{|iseq|
-        if (iseq.absolute_path || iseq.path) == self.path && iseq.first_lineno <= self.line
+        if (iseq.absolute_path || iseq.path) == self.path &&
+            iseq.first_lineno <= self.line &&
+            iseq.type != :ensure # ensure iseq is copied (duplicated)
+
           iseq.traceable_lines_norec(line_events = {})
           lines = line_events.keys.sort
 

data/lib/debug/config.rb

@@ -30,12 +30,16 @@ module DEBUGGER__
   end
 
   CONFIG_MAP = {
-    # execution preferences
+    # boot setting
     nonstop:     'RUBY_DEBUG_NONSTOP',     # Nonstop mode ('1' is nonstop)
     init_script: 'RUBY_DEBUG_INIT_SCRIPT', # debug command script path loaded at first stop
     commands:    'RUBY_DEBUG_COMMANDS',    # debug commands invoked at first stop. commands should be separated by ';;'
+
+    # UI setting
     show_src_lines: 'RUBY_DEBUG_SHOW_SRC_LINES', # Show n lines source code on breakpoint (default: 10 lines).
     show_frames:    'RUBY_DEBUG_SHOW_FRAMES',    # Show n frames on breakpoint (default: 2 frames).
+    use_short_path: 'RUBY_DEBUG_USE_SHORT_PATH', # Show shoten PATH (like $(Gem)/foo.rb).
+    skip_nosrc:     'RUBY_DEBUG_SKIP_NOSRC',     # Skip on no source code lines (default: false).
 
     # remote
     port:        'RUBY_DEBUG_PORT',        # TCP/IP remote debugging: port
@@ -86,14 +90,16 @@ module DEBUGGER__
         config[:host] = host
       end
 
+      rdbg = 'rdbg'
+
       o.separator ''
       o.separator '  Debug console mode runs Ruby program with the debug console.'
       o.separator ''
-      o.separator "  #{$0} target.rb foo bar                 starts like 'ruby target.rb foo bar'."
-      o.separator "  #{$0} -- -r foo -e bar                  starts like 'ruby -r foo -e bar'."
-      o.separator "  #{$0} -O target.rb foo bar              starts and accepts attaching with UNIX domain socket."
-      o.separator "  #{$0} -O --port 1234 target.rb foo bar  starts accepts attaching with TCP/IP localhost:1234."
-      o.separator "  #{$0} -O --port 1234 -- -r foo -e bar   starts accepts attaching with TCP/IP localhost:1234."
+      o.separator "  #{rdbg} target.rb foo bar                 starts like 'ruby target.rb foo bar'."
+      o.separator "  #{rdbg} -- -r foo -e bar                  starts like 'ruby -r foo -e bar'."
+      o.separator "  #{rdbg} -O target.rb foo bar              starts and accepts attaching with UNIX domain socket."
+      o.separator "  #{rdbg} -O --port 1234 target.rb foo bar  starts accepts attaching with TCP/IP localhost:1234."
+      o.separator "  #{rdbg} -O --port 1234 -- -r foo -e bar   starts accepts attaching with TCP/IP localhost:1234."
 
       o.separator ''
       o.separator 'Attach mode:'
@@ -104,12 +110,12 @@ module DEBUGGER__
       o.separator ''
       o.separator '  Attach mode attaches the remote debug console to the debuggee process.'
       o.separator ''
-      o.separator "  '#{$0} -A' tries to connect via UNIX domain socket."
-      o.separator "  #{' ' * $0.size}            If there are multiple processes are waiting for the"
-      o.separator "  #{' ' * $0.size}            debugger connection, list possible debuggee names."
-      o.separator "  '#{$0} -A path' tries to connect via UNIX domain socket with given path name."
-      o.separator "  '#{$0} -A port' tries to connect localhost:port via TCP/IP."
-      o.separator "  '#{$0} -A host port' tries to connect host:port via TCP/IP."
+      o.separator "  '#{rdbg} -A' tries to connect via UNIX domain socket."
+      o.separator "  #{' ' * rdbg.size}      If there are multiple processes are waiting for the"
+      o.separator "  #{' ' * rdbg.size}      debugger connection, list possible debuggee names."
+      o.separator "  '#{rdbg} -A path' tries to connect via UNIX domain socket with given path name."
+      o.separator "  '#{rdbg} -A port' tries to connect to localhost:port via TCP/IP."
+      o.separator "  '#{rdbg} -A host port' tries to connect to host:port via TCP/IP."
     end
 
     opt.parse!(argv)

data/lib/debug/session.rb

@@ -4,7 +4,11 @@
                          :has_return_value, :return_value, :show_line)
 end
 
-require "debug/debug"
+if File.exist? File.join(__dir__, 'debug.so')
+  require_relative 'debug.so'
+else
+  require "debug/debug"
+end
 
 require_relative 'source_repository'
 require_relative 'breakpoint'
@@ -133,6 +137,9 @@ module DEBUGGER__
             wait_command_loop tc
           end
         end
+      ensure
+        @bps.each{|k, bp| bp.disable}
+        @th_clients.each{|th, thc| thc.close}
       end
 
       @management_threads = [@session_server]
@@ -224,9 +231,9 @@ module DEBUGGER__
       when 'c', 'continue'
         @tc << :continue
 
-      # * `q[uit]` or exit or `Ctrl-D`
+      # * `q[uit]` or `Ctrl-D`
       #   * Finish debugger (with the debuggee process on non-remote debugging).
-      when 'q', 'quit', 'exit'
+      when 'q', 'quit'
         if ask 'Really quit?'
           @ui.quit arg.to_i
           @tc << :continue
@@ -234,15 +241,26 @@ module DEBUGGER__
           return :retry
         end
 
-      # * `kill` or `q[uit]!`
-      #   * Stop the debuggee process.
-      when 'kill', 'quit!', 'q!'
+      # * `q[uit]!`
+      #   * Same as q[uit] but without the confirmation prompt.
+      when 'q!', 'quit!'
+        @ui.quit arg.to_i
+        @tc << :continue
+
+      # * `kill`
+      #   * Stop the debuggee process with `Kernal#exit!`.
+      when 'kill'
         if ask 'Really kill?'
           exit! (arg || 1).to_i
         else
           return :retry
         end
 
+      # * `kill!`
+      #   * Same as kill but without the confirmation prompt.
+      when 'kill!'
+        exit! (arg || 1).to_i
+
       ### Breakpoint
 
       # * `b[reak]`
@@ -312,7 +330,7 @@ module DEBUGGER__
         return :retry
 
       # * `watch <expr>`
-      #   * Stop the execution when the result of <expr> is changed.
+      #   * Stop the execution when the result of `<expr>` is changed.
       #   * Note that this feature is super slow.
       when 'wat', 'watch'
         if arg
@@ -410,7 +428,7 @@ module DEBUGGER__
       #   * Show the result of `<expr>` at every suspended timing.
       when 'display'
         if arg && !arg.empty?
-          @displays << arg 
+          @displays << arg
           @tc << [:eval, :try_display, @displays]
         else
           @tc << [:eval, :display, @displays]
@@ -459,19 +477,19 @@ module DEBUGGER__
       ### Frame control
 
       # * `f[rame]`
-      #   * Show current frame.
+      #   * Show the current frame.
       # * `f[rame] <framenum>`
-      #   * Specify frame. Evaluation are run on this frame environment.
+      #   * Specify a current frame. Evaluation are run on specified frame.
       when 'frame', 'f'
         @tc << [:frame, :set, arg]
 
       # * `up`
-      #   * Specify upper frame.
+      #   * Specify the upper frame.
       when 'up'
         @tc << [:frame, :up]
 
       # * `down`
-      #   * Specify down frame.
+      #   * Specify the lower frame.
       when 'down'
         @tc << [:frame, :down]
 
@@ -801,7 +819,7 @@ module DEBUGGER__
       end
     end
 
-    ## event 
+    ## event
 
     def on_load iseq, src
       @sr.add iseq, src
@@ -849,6 +867,13 @@ module DEBUGGER__
       File.realpath(File.expand_path(file))
     rescue Errno::ENOENT
       return file if file == '-e'
+      $LOAD_PATH.each do |lp|
+        libpath = File.join(lp, file)
+        return File.realpath(libpath)
+      rescue Errno::ENOENT
+        # next
+      end
+
       raise
     end
 

data/lib/debug/thread_client.rb

@@ -24,6 +24,10 @@ module DEBUGGER__
       set_mode nil
     end
 
+    def close
+      @q_cmd.close
+    end
+
     def inspect
       "#<DBG:TC #{self.id}:#{self.mode}@#{@thread.backtrace[-1]}>"
     end
@@ -125,6 +129,8 @@ module DEBUGGER__
           next if SESSION.break? tp.path, tp.lineno
           next if !yield
           next if tp.path.start_with?(__dir__)
+          next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
+
           tp.disable
           on_suspend tp.event, tp
         }
@@ -134,6 +140,8 @@ module DEBUGGER__
           next if thread != Thread.current
           next if SESSION.break? tp.path, tp.lineno
           next if !yield
+          next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
+
           tp.disable
           on_suspend tp.event, tp
         }
@@ -197,10 +205,12 @@ module DEBUGGER__
             frame.show_line = end_line
           end
 
-          if start_line != end_line
-            puts "[#{start_line+1}, #{end_line}] in #{path}" unless update_line
+          if start_line != end_line && max_lines
+            puts "[#{start_line+1}, #{end_line}] in #{pretty_path(path)}" if !update_line && max_lines != 1
             puts lines[start_line ... end_line]
           end
+        else # no file lines
+          puts "# No sourcefile available for #{path}"
         end
       end
     end
@@ -287,9 +297,15 @@ module DEBUGGER__
       }.compact.join(', ')
     end
 
+    def get_singleton_class obj
+      obj.singleton_class # TODO: don't use it
+    rescue TypeError
+      nil
+    end
+
     def klass_sig frame
       klass = frame.class
-      if klass == frame.self.singleton_class
+      if klass == get_singleton_class(frame.self)
         "#{frame.self}."
       else
         "#{frame.class}#"
@@ -307,40 +323,65 @@ module DEBUGGER__
       end
     end
 
+    HOME = ENV['HOME'] ? (ENV['HOME'] + '/') : nil
+
+    def pretty_path path
+      use_short_path = CONFIG[:use_short_path]
+
+      case
+      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/')
+        end
+        path.sub(dir, '$(Gem)/')
+      when HOME && path.start_with?(HOME)
+        path.sub(HOME, '~/')
+      else
+        path
+      end
+    end
+
+    def pretty_location loc
+      " at #{pretty_path(loc.path)}:#{loc.lineno}"
+    end
+
     def frame_str i
-      buff = ''.dup
       frame = @target_frames[i]
       b = frame.binding
 
-      buff << (@current_frame_index == i ? '--> ' : '    ')
-      if b
-        buff << "##{i}\t#{frame.location}"
-      else
-        buff << "##{i}\t[C] #{frame.location}"
-      end
+      cur_str = (@current_frame_index == i ? '=>' : '  ')
 
       if b && (iseq = frame.iseq)
         if iseq.type == :block
           if (argc = iseq.argc) > 0
             args = parameters_info b, iseq.locals[0...argc]
-            buff << " {|#{args}|}"
+            args_str = "{|#{args}|}"
           end
+
+          label_prefix = frame.location.label.sub('block'){ "block#{args_str}" }
+          ci_str = label_prefix
+        elsif (callee = b.eval('__callee__', __FILE__, __LINE__)) && (argc = iseq.argc) > 0
+          args = parameters_info b, iseq.locals[0...argc]
+          ksig = klass_sig frame
+          ci_str = "#{ksig}#{callee}(#{args})"
         else
-          if (callee = b.eval('__callee__', __FILE__, __LINE__)) && (argc = iseq.argc) > 0
-            args = parameters_info b, iseq.locals[0...argc]
-            ksig = klass_sig frame
-            buff << " #{ksig}#{callee}(#{args})"
-          end
+          ci_str = frame.location.label
         end
 
+        loc_str = "#{pretty_location(frame.location)}"
+
         if frame.has_return_value
-          buff << " #=> #{short_inspect(frame.return_value)}"
+          return_str = " #=> #{short_inspect(frame.return_value)}"
         end
       else
-        # p frame.self
+        ksig = klass_sig frame
+        callee = frame.location.base_label
+        ci_str = "[C] #{ksig}#{callee}"
+        loc_str = "#{pretty_location(frame.location)}"
       end
 
-      buff
+      "#{cur_str}##{i}\t#{ci_str}#{loc_str}#{return_str}"
     end
 
     def show_frames max = (@target_frames || []).size
@@ -351,7 +392,7 @@ module DEBUGGER__
           break if i >= size
           puts frame_str(i)
         }
-        puts "    # and #{size - max} frames (use `bt' command for all frames)" if max < size
+        puts "  # and #{size - max} frames (use `bt' command for all frames)" if max < size
       end
     end
 

data/lib/debug/version.rb

@@ -1,3 +1,3 @@
 module DEBUGGER__
-  VERSION = "1.0.0.beta2"
+  VERSION = "1.0.0.beta3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies: []
 description: Debugging functionality for Ruby. This is completely rewritten debug.rb
   which was contained by the encient Ruby versions.