debug 1.0.0.beta4 → 1.0.0.beta5

data/lib/debug/thread_client.rb

@@ -1,7 +1,8 @@
 require 'objspace'
 require 'pp'
-require 'irb/color'
+
 require_relative 'frame_info'
+require_relative 'color'
 
 module DEBUGGER__
   class ThreadClient
@@ -12,23 +13,46 @@ module DEBUGGER__
       end
     end
 
+    include Color
+
     attr_reader :location, :thread, :mode, :id
 
-    def colorize str, color
-      if CONFIG[:use_colorize]
-        IRB::Color.colorize str, color
-      else
-        str
-      end
+    def assemble_arguments(args)
+      args.map do |arg|
+        "#{colorize_cyan(arg[:name])}=#{arg[:value]}"
+      end.join(", ")
     end
 
     def default_frame_formatter frame
-      call_identifier_str = colorize(frame.call_identifier_str, [:BLUE, :BOLD])
-      location_str = colorize(frame.location_str, [:YELLOW])
+      call_identifier_str =
+        case frame.frame_type
+        when :block
+          level, block_loc, args = frame.block_identifier
+
+          if !args.empty?
+            args_str = " {|#{assemble_arguments(args)}|}"
+          end
+
+          "#{colorize_blue("block")}#{args_str} in #{colorize_blue(block_loc + level)}"
+        when :method
+          ci, args = frame.method_identifier
+
+          if !args.empty?
+            args_str = "(#{assemble_arguments(args)})"
+          end
+
+          "#{colorize_blue(ci)}#{args_str}"
+        when :c
+          colorize_blue(frame.c_identifier)
+        when :other
+          colorize_blue(frame.other_identifier)
+        end
+
+      location_str = colorize(frame.location_str, [:GREEN])
       result = "#{call_identifier_str} at #{location_str}"
 
       if return_str = frame.return_str
-        return_str = colorize(frame.return_str, [:MAGENTA])
+        return_str = colorize(frame.return_str, [:MAGENTA, :BOLD])
         result += " #=> #{return_str}"
       end
 
@@ -38,6 +62,7 @@ module DEBUGGER__
     def initialize id, q_evt, q_cmd, thr = Thread.current
       @id = id
       @thread = thr
+      @target_frames = nil
       @q_evt = q_evt
       @q_cmd = q_cmd
       @step_tp = nil
@@ -45,9 +70,14 @@ module DEBUGGER__
       @src_lines_on_stop = (::DEBUGGER__::CONFIG[:show_src_lines]   || 10).to_i
       @show_frames_on_stop = (::DEBUGGER__::CONFIG[:show_frames] || 2).to_i
       @frame_formatter = method(:default_frame_formatter)
+      @var_map = {} # { thread_local_var_id => obj } for DAP
       set_mode nil
     end
 
+    def name
+      "##{@id} #{@thread.name || @thread.backtrace.last}"
+    end
+
     def close
       @q_cmd.close
     end
@@ -71,8 +101,14 @@ module DEBUGGER__
       @q_cmd << req
     end
 
+    def generate_info
+      return unless current_frame
+
+      { location: current_frame.location_str, line: current_frame.location.lineno }
+    end
+
     def event! ev, *args
-      @q_evt << [self, @output, ev, *args]
+      @q_evt << [self, @output, ev, generate_info, *args]
       @output = []
     end
 
@@ -116,6 +152,11 @@ module DEBUGGER__
           cf.has_return_value = true
           cf.return_value = tp.return_value
         end
+
+        if CatchBreakpoint === bp
+          cf.has_raised_exception = true
+          cf.raised_exception = bp.last_exc
+        end
       end
 
       if event != :pause
@@ -187,7 +228,6 @@ module DEBUGGER__
                  start_line: nil,
                  end_line: nil,
                  dir: +1)
-
       if @target_frames && frame = @target_frames[frame_index]
         if file_lines = frame.file_lines
           frame_line = frame.location.lineno - 1
@@ -229,6 +269,10 @@ module DEBUGGER__
           puts "# No sourcefile available for #{frame.path}"
         end
       end
+    rescue Exception => e
+      p e
+      pp e.backtrace
+      exit!
     end
 
     def show_by_editor path = nil
@@ -255,14 +299,18 @@ module DEBUGGER__
 
     def show_locals
       if s = current_frame&.self
-        puts " %self => #{s}"
+        puts " #{colorize_cyan("%self")} => #{colored_inspect(s)}"
       end
       if current_frame&.has_return_value
-        puts " %return => #{current_frame.return_value}"
+        puts " #{colorize_cyan("%return")} => #{colored_inspect(current_frame.return_value)}"
+      end
+      if current_frame&.has_raised_exception
+        puts " #{colorize_cyan("%raised")} => #{colored_inspect(current_frame.raised_exception)}"
       end
       if b = current_frame&.binding
         b.local_variables.each{|loc|
-          puts " #{loc} => #{b.local_variable_get(loc).inspect}"
+          value = b.local_variable_get(loc)
+          puts " #{colorize_cyan(loc)} => #{colored_inspect(value)}"
         }
       end
     end
@@ -270,7 +318,8 @@ module DEBUGGER__
     def show_ivars
       if s = current_frame&.self
         s.instance_variables.each{|iv|
-          puts " #{iv} => #{s.instance_variable_get(iv)}"
+          value = s.instance_variable_get(iv)
+          puts " #{colorize_cyan(iv)} => #{colored_inspect(value)}"
         }
       end
     end
@@ -281,7 +330,7 @@ module DEBUGGER__
 
         b = current_frame.binding
         result = if b
-                   f, l = b.source_location
+                   f, _l = b.source_location
                    b.eval(src, "(rdbg)/#{f}")
                  else
                    frame_self = current_frame.self
@@ -312,7 +361,7 @@ module DEBUGGER__
     end
 
     def show_frames max = (@target_frames || []).size
-      if max > 0 && frames = @target_frames
+      if max > 0 && @target_frames
         size = @target_frames.size
         max += 1 if size == max + 1
         max.times{|i|
@@ -369,6 +418,8 @@ module DEBUGGER__
     def wait_next_action
       set_mode :wait_next_action
 
+      SESSION.check_forked
+
       while cmds = @q_cmd.pop
         # pp [self, cmds: cmds]
 
@@ -397,9 +448,13 @@ module DEBUGGER__
               loc = caller_locations(2, 1).first
               loc_path = loc.absolute_path || "!eval:#{loc.path}"
 
+              # same stack depth
+              (DEBUGGER__.frame_depth - 3 <= depth) ||
+
+              # different frame
               (next_line && loc_path == path &&
-                (loc_lineno = loc.lineno) > line && loc_lineno <= next_line) ||
-              (DEBUGGER__.frame_depth - 3 < depth)
+               (loc_lineno = loc.lineno) > line &&
+               loc_lineno <= next_line)
             }
           when :finish
             depth = @target_frames.first.frame_depth
@@ -426,7 +481,7 @@ module DEBUGGER__
             puts "=> " + result.inspect
           when :pp
             puts "=> "
-            PP.pp(result, out = ''.dup)
+            PP.pp(result, out = ''.dup, SESSION.width)
             puts out
           when :call
             result = frame_eval(eval_src)
@@ -444,8 +499,17 @@ module DEBUGGER__
             result = failed_results
           when :watch
             if @success_last_eval
-              puts "#{eval_src} = #{result}"
-              result = WatchExprBreakpoint.new(eval_src, result)
+              if eval_src.match?(/@\w+/)
+                object =
+                  if b = current_frame.binding
+                    b.receiver
+                  else
+                    current_frame.self
+                  end
+                puts "#{object} #{eval_src} = #{result}"
+                result = WatchIVarBreakpoint.new(eval_src, object, result)
+              end
+
               result_type = :watch
             else
               result = nil
@@ -515,6 +579,10 @@ module DEBUGGER__
 
         when :breakpoint
           add_breakpoint args
+
+        when :dap
+          process_dap args
+
         else
           raise [cmd, *args].inspect
         end

data/lib/debug/version.rb

@@ -1,3 +1,3 @@
 module DEBUGGER__
-  VERSION = "1.0.0.beta4"
+  VERSION = "1.0.0.beta5"
 end

data/misc/README.md.erb

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/ruby/debug/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/ruby/debug/actions/workflows/ruby.yml?query=branch%3Amaster)
+
 # debug.rb
 
 This library provides debugging functionality to Ruby.
@@ -49,28 +51,33 @@ To use debugging feature, you can have 3 ways.
 
 ### Local debug console
 
+#### (1) Use `rdbg` command
+
 ```
-# (1) Use `rdbg` command
 $ rdbg target.rb
 $ rdbg -- -r foo -e expr # -- is required to make clear rdbg options and ruby's options
+```
 
-# (2) Use `-r debug/run` command line option
+#### (2) Use `-r debug/run` command line option
 
+```
 $ ruby -r debug/run target.rb
+```
 
-# (3) Write `require 'debug...' in .rb files
+#### (3) Write `require 'debug...'` in .rb files
 
-$ cat target.rb
+```ruby
+# target.rb
 require 'debug/run' # start the debug console
-... rest of program ...
 
 # or
 
-$ cat target.rb
 require 'debug/session'  # introduce the functionality
 DEBUGGER__.console       # and start the debug console
-... rest of program ...
+# ... rest of program ...
+```
 
+```
 $ ruby target.rb
 ```
 
@@ -144,33 +151,36 @@ $ rdbg  ~/src/rb/target.rb
 
 ### Remote debug (1) UNIX domain socket
 
+#### (1) Use `rdbg` command
+
 ```
-# (1) Use `rdbg` command
 $ rdbg --open target.rb # or rdbg -O target.rb for shorthand
 Debugger can attach via UNIX domain socket (/home/ko1/.ruby-debug-sock/ruby-debug-ko1-5042)
-...
+```
 
-# (2) Use `-r debug/open` command line option
+#### (2) Use `-r debug/open` command line option
 
+```
 $ ruby -r debug/open target.rb
 Debugger can attach via UNIX domain socket (/home/ko1/.ruby-debug-sock/ruby-debug-ko1-5042)
-...
+```
+
+#### (3) Write `require 'debug/open'` in .rb files
 
-# (3) Write `require 'debug/open' in .rb files
-$ cat target.rb
+```ruby
+# target.rb
 require 'debug/open' # open the debugger entry point by UNIX domain socket.
-...
 
 # or
 
-$ cat target.rb
 require 'debug/server' # introduce remote debugging feature
 DEBUGGER__.open        # open the debugger entry point by UNIX domain socket.
 # or DEBUGGER__.open_unix to specify UNIX domain socket.
+```
 
+```
 $ ruby target.rb
 Debugger can attach via UNIX domain socket (/home/ko1/.ruby-debug-sock/ruby-debug-ko1-5042)
-...
 ```
 
 It runs target.rb and accept debugger connection within UNIX domain socket.
@@ -234,40 +244,49 @@ The socket file is located at
 
 You can open the TCP/IP port instead of using UNIX domain socket.
 
+#### (1) Use `rdbg` command
+
 ```
-# (1) Use `rdbg` command
 $ rdbg -O --port=12345 target.rb
 # or
 $ rdbg --open --port=12345 target.rb
 Debugger can attach via TCP/IP (localhost:12345)
-...
+```
+
+#### (2) Use `-r debug/open` command line option
 
-# (2) Use `-r debug/open` command line option
 
+```
 $ RUBY_DEBUG_PORT=12345 ruby -r debug/open target.rb
 Debugger can attach via TCP/IP (localhost:12345)
-...
+```
 
-# (3) Write `require 'debug/open' in .rb files
-$ cat target.rb
+#### (3) Write `require 'debug/open'` in .rb files
+
+```ruby
+# target.rb
 require 'debug/open' # open the debugger entry point.
-...
+```
+
+and run with environment variable RUBY_DEBUG_PORT
 
-# and run with environment variable RUBY_DEBUG_PORT
+```
 $ RUBY_DEBUG_PORT=12345 ruby target.rb
 Debugger can attach via TCP/IP (localhost:12345)
-...
+```
 
-# or
+or
 
-$ cat target.rb
+```ruby
+# target.rb
 require 'debug/server' # introduce remote debugging feature
 DEBUGGER__.open(port: 12345)
 # or DEBUGGER__.open_tcp(port: 12345)
+```
 
+```
 $ ruby target.rb
 Debugger can attach via TCP/IP (localhost:12345)
-...
 ```
 
 You can also specify the host with the `RUBY_DEBUG_HOST` environment variable. And also `DEBUGGER__.open` method accepts a `host:` keyword parameter. If the host is not given, `localhost` will be used.
@@ -325,3 +344,7 @@ The `<...>` notation means the argument.
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.
 
 Please also check the [contributing guideline](/CONTRIBUTING.md).
+
+# Acknowledgement
+
+* Some tests are based on [deivid-rodriguez/byebug: Debugging in Ruby 2](https://github.com/deivid-rodriguez/byebug)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.0.beta5
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
-dependencies: []
+date: 2021-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Debugging functionality for Ruby. This is completely rewritten debug.rb
   which was contained by the encient Ruby versions.
 email:
@@ -20,6 +34,7 @@ extensions:
 - ext/debug/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - CONTRIBUTING.md
 - Gemfile
@@ -38,14 +53,17 @@ files:
 - lib/debug/bp.vim
 - lib/debug/breakpoint.rb
 - lib/debug/client.rb
+- lib/debug/color.rb
 - lib/debug/config.rb
 - lib/debug/console.rb
 - lib/debug/frame_info.rb
 - lib/debug/open.rb
 - lib/debug/run.rb
 - lib/debug/server.rb
+- lib/debug/server_dap.rb
 - lib/debug/session.rb
 - lib/debug/source_repository.rb
+- lib/debug/test_console.rb
 - lib/debug/thread_client.rb
 - lib/debug/version.rb
 - misc/README.md.erb