debug 1.3.1 → 1.4.0

data/lib/debug/thread_client.rb

@@ -22,7 +22,7 @@ module DEBUGGER__
       if thc = Thread.current[:DEBUGGER__ThreadClient]
         thc
       else
-        thc = SESSION.thread_client
+        thc = SESSION.get_thread_client
         Thread.current[:DEBUGGER__ThreadClient] = thc
       end
     end
@@ -67,7 +67,7 @@ module DEBUGGER__
       result = "#{call_identifier_str} at #{location_str}"
 
       if return_str = frame.return_str
-        result += " #=> #{colorize_magenta(frame.return_str)}"
+        result += " #=> #{colorize_magenta(return_str)}"
       end
 
       result
@@ -84,6 +84,7 @@ module DEBUGGER__
       @output = []
       @frame_formatter = method(:default_frame_formatter)
       @var_map = {} # { thread_local_var_id => obj } for DAP
+      @obj_map = {} # { object_id => obj } for CDP
       @recorder = nil
       @mode = :waiting
       set_mode :running
@@ -100,13 +101,13 @@ module DEBUGGER__
       @is_management
     end
 
-    def is_management
+    def mark_as_management
       @is_management = true
     end
 
     def set_mode mode
       # STDERR.puts "#{@mode} => #{mode} @ #{caller.inspect}"
-      #pp caller
+      # pp caller
 
       # mode transition check
       case mode
@@ -228,7 +229,7 @@ module DEBUGGER__
       suspend :pause
     end
 
-    def suspend event, tp = nil, bp: nil, sig: nil, postmortem_frames: nil, replay_frames: nil
+    def suspend event, tp = nil, bp: nil, sig: nil, postmortem_frames: nil, replay_frames: nil, postmortem_exc: nil
       return if management?
 
       @current_frame_index = 0
@@ -256,10 +257,15 @@ module DEBUGGER__
           cf.has_raised_exception = true
           cf.raised_exception = bp.last_exc
         end
+
+        if postmortem_exc
+          cf.has_raised_exception = true
+          cf.raised_exception = postmortem_exc
+        end
       end
 
       if event != :pause
-        show_src max_lines: (CONFIG[:show_src_lines] || 10)
+        show_src
         show_frames CONFIG[:show_frames] || 2
 
         set_mode :waiting
@@ -292,15 +298,15 @@ module DEBUGGER__
       SUPPORT_TARGET_THREAD = false
     end
 
-    def step_tp iter
+    def step_tp iter, events = [:line, :b_return, :return]
       @step_tp.disable if @step_tp
 
       thread = Thread.current
 
       if SUPPORT_TARGET_THREAD
-        @step_tp = TracePoint.new(:line, :b_return, :return){|tp|
+        @step_tp = TracePoint.new(*events){|tp|
           next if SESSION.break_at? tp.path, tp.lineno
-          next if !yield
+          next if !yield(tp.event)
           next if tp.path.start_with?(__dir__)
           next if tp.path.start_with?('<internal:trace_point>')
           next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
@@ -313,10 +319,10 @@ module DEBUGGER__
         }
         @step_tp.enable(target_thread: thread)
       else
-        @step_tp = TracePoint.new(:line, :b_return, :return){|tp|
+        @step_tp = TracePoint.new(*events){|tp|
           next if thread != Thread.current
           next if SESSION.break_at? tp.path, tp.lineno
-          next if !yield
+          next if !yield(tp.event)
           next if tp.path.start_with?(__dir__)
           next if tp.path.start_with?('<internal:trace_point>')
           next unless File.exist?(tp.path) if CONFIG[:skip_nosrc]
@@ -338,38 +344,45 @@ module DEBUGGER__
       frame_self.instance_eval(src)
     end
 
+    SPECIAL_LOCAL_VARS = [
+      [:raised_exception, "_raised"],
+      [:return_value,     "_return"],
+    ]
+
     def frame_eval src, re_raise: false
-      begin
-        @success_last_eval = false
+      @success_last_eval = false
 
-        b = current_frame&.eval_binding || TOPLEVEL_BINDING
+      b = current_frame.eval_binding
 
-        result = if b
-                   f, _l = b.source_location
-                   b.eval(src, "(rdbg)/#{f}")
-                 else
-                   frame_self = current_frame.self
-                   instance_eval_for_cmethod(frame_self, src)
-                 end
-        @success_last_eval = true
-        result
+      special_local_variables current_frame do |name, var|
+        b.local_variable_set(name, var) if /\%/ !~ name
+      end
 
-      rescue Exception => e
-        return yield(e) if block_given?
+      result = if b
+                  f, _l = b.source_location
+                  b.eval(src, "(rdbg)/#{f}")
+                else
+                  frame_self = current_frame.self
+                  instance_eval_for_cmethod(frame_self, src)
+                end
+      @success_last_eval = true
+      result
 
-        puts "eval error: #{e}"
+    rescue Exception => e
+      return yield(e) if block_given?
 
-        e.backtrace_locations&.each do |loc|
-          break if loc.path == __FILE__
-          puts "  #{loc}"
-        end
-        raise if re_raise
+      puts "eval error: #{e}"
+
+      e.backtrace_locations&.each do |loc|
+        break if loc.path == __FILE__
+        puts "  #{loc}"
       end
+      raise if re_raise
     end
 
     def show_src(frame_index: @current_frame_index,
                  update_line: false,
-                 max_lines: 10,
+                 max_lines: CONFIG[:show_src_lines] || 10,
                  start_line: nil,
                  end_line: nil,
                  dir: +1)
@@ -428,15 +441,20 @@ module DEBUGGER__
 
     ## cmd: show
 
+    def special_local_variables frame
+      SPECIAL_LOCAL_VARS.each do |mid, name|
+        next unless frame&.send("has_#{mid}")
+        name = name.sub('_', '%') if frame.eval_binding.local_variable_defined?(name)
+        yield name, frame.send(mid)
+      end
+    end
+
     def show_locals pat
       if s = current_frame&.self
         puts_variable_info '%self', s, pat
       end
-      if current_frame&.has_return_value
-        puts_variable_info '%return', current_frame.return_value, pat
-      end
-      if current_frame&.has_raised_exception
-        puts_variable_info "%raised", current_frame.raised_exception, pat
+      special_local_variables current_frame do |name, val|
+        puts_variable_info name, val, pat
       end
 
       if vars = current_frame&.local_variables
@@ -633,8 +651,8 @@ module DEBUGGER__
     def make_breakpoint args
       case args.first
       when :method
-        klass_name, op, method_name, cond, cmd = args[1..]
-        bp = MethodBreakpoint.new(current_frame.binding, klass_name, op, method_name, cond: cond, command: cmd)
+        klass_name, op, method_name, cond, cmd, path = args[1..]
+        bp = MethodBreakpoint.new(current_frame.eval_binding, klass_name, op, method_name, cond: cond, command: cmd, path: path)
         begin
           bp.enable
         rescue Exception => e
@@ -644,8 +662,8 @@ module DEBUGGER__
 
         bp
       when :watch
-        ivar, object, result = args[1..]
-        WatchIVarBreakpoint.new(ivar, object, result)
+        ivar, object, result, cond, command, path = args[1..]
+        WatchIVarBreakpoint.new(ivar, object, result, cond: cond, command: command, path: path)
       else
         raise "unknown breakpoint: #{args}"
       end
@@ -732,10 +750,11 @@ module DEBUGGER__
             break
 
           when :finish
-            depth = @target_frames.first.frame_depth
-            step_tp iter do
-              # 3 is debugger's frame count
-              DEBUGGER__.frame_depth - 3 < depth
+            finish_frames = (iter || 1) - 1
+            goal_depth = @target_frames.first.frame_depth - finish_frames
+
+            step_tp nil, [:return, :b_return] do
+              DEBUGGER__.frame_depth - 3 <= goal_depth ? true : false
             end
             break
 
@@ -887,7 +906,7 @@ module DEBUGGER__
             bp = make_breakpoint args
             event! :result, :method_breakpoint, bp
           when :watch
-            ivar = args[1]
+            ivar, cond, command, path = args[1..]
             result = frame_eval(ivar)
 
             if @success_last_eval
@@ -897,7 +916,7 @@ module DEBUGGER__
                 else
                   current_frame.self
                 end
-              bp = make_breakpoint [:watch, ivar, object, result]
+              bp = make_breakpoint [:watch, ivar, object, result, cond, command, path]
               event! :result, :watch_breakpoint, bp
             else
               event! :result, nil
@@ -1067,7 +1086,7 @@ module DEBUGGER__
       end
     end
 
-    # copyed from irb
+    # copied from irb
     class Output
       include Color
 

data/lib/debug/tracer.rb

@@ -142,7 +142,7 @@ module DEBUGGER__
           out tp, ">#{sp}#{call_identifier_str}", depth
         when :return, :c_return, :b_return
           depth += 1 if tp.event == :c_return
-          return_str = colorize_magenta(DEBUGGER__.short_inspect(tp.return_value))
+          return_str = colorize_magenta(DEBUGGER__.safe_inspect(tp.return_value, short: true))
           out tp, "<#{sp}#{call_identifier_str} #=> #{return_str}", depth
         end
       }

data/lib/debug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DEBUGGER__
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/misc/README.md.erb

@@ -11,7 +11,7 @@ New debug.rb has several advantages:
 * [Remote debugging](#remote-debugging): Support remote debugging natively.
   * UNIX domain socket
   * TCP/IP
-  * Integeration with rich debugger frontend
+  * Integration with rich debugger frontend
     * VSCode/DAP ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg))
     * Chrome DevTools
 * Extensible: application can introduce debugging support with several ways:
@@ -60,8 +60,14 @@ There are several options for (1) and (2). Please choose your favorite way.
 
 ### 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`](#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.
+If you can modify the source code, you can use the debugger by adding `require 'debug'` at the top of your program and putting [`binding.break`](#bindingbreak-method) method into lines where you want to stop as breakpoints like `binding.pry` and `binding.irb`.
+
+You can also use its 2 aliases in the same way:
+
+- `binding.b`
+- `debugger`
+
+After that, 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`](#bindingbreak-method).
 
@@ -340,19 +346,19 @@ $ RUBY_DEBUG_PORT=12345 ruby target.rb
 
 ### Integration with external debugger frontend
 
-You can attach with external debuger frontend with VSCode and Chrome.
+You can attach with external debugger frontend with VSCode and Chrome.
 
 ```
 $ rdbg --open=[frontend] target.rb
 ```
 
-will open a debug port and `[frontned]` can attache to the port.
+will open a debug port and `[frontend]` can attach to the port.
 
 Also `open` command allows opening the debug port.
 
 #### VSCode integration
 
-If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the fowllowing steps.
+If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the following steps.
 
 `rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code` command).
 
@@ -364,7 +370,7 @@ Launching: code /tmp/ruby-debug-vscode-20211014-27706-gd7e85/ /tmp/ruby-debug-vs
 DEBUGGER: Connected.
 ```
 
-And it tris to invoke the new VSCode window and VSCode starts attaching to the debuggee Ruby program automatically.
+And it tries to invoke the new VSCode window and VSCode starts attaching to the debuggee Ruby program automatically.
 
 You can also use `open vscode` command in REPL.
 
@@ -427,7 +433,9 @@ Type `devtools://devtools/bundled/inspector.html?ws=127.0.0.1:43633` in the addr
 
 Also `open chrome` command works like `open vscode`.
 
-For more information about how to use Chrome debugging, you might want to read [here](https://developer.chrome.com/docs/devtools/)
+For more information about how to use Chrome debugging, you might want to read [here](https://developer.chrome.com/docs/devtools/).
+
+Note: If you want to maximize Chrome DevTools, click [Toggle Device Toolbar](https://developer.chrome.com/docs/devtools/device-mode/#viewport).
 
 ## Configuration
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2021-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -51,6 +51,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/custom.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - CONTRIBUTING.md