debug 1.0.0.beta3 → 1.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9702de02ad9d9aab11e0f0113a3596110222f92178e2918e6f4c5ad66fb5e3fb
-  data.tar.gz: 6f8552da80d13f0c597223fa651a49f44810d7106feb73c8a93d73249c74a987
+  metadata.gz: ebaae12c10e51036f850fd1cbcde66d891a1e50b64bc5d96bfdab610cb42fd1d
+  data.tar.gz: e62eee365aa1409c650049ccb8ed237854aeed6f7a066dc2b84f96c9cffefd12
 SHA512:
-  metadata.gz: 1a2386cd5fcde06d356cb35e1d5ff637c587c33a4fdf9e3866d11761276a31cf5586d383b8cd8f6074be24a681592db7d577b8fcf3270d63afff9256ddaaa78f
-  data.tar.gz: 373039bc43b6071d77c4bb103453258a50668224ea581b4fd0b5ec0bf3df7c4b95702e2bc3723e35c55e238aaf6fa9297090fa7daf8fe4c6eee22124f1087daf
+  metadata.gz: 2aa2b044268220dc79d72850f6366474fff647fa6893360044ce64a8a97e4d759e414da6c39dac52a6b33593512675091ed4fb4a7399c1357b344d342f3c812f
+  data.tar.gz: 506d0afeb3e3926da6631e99234fd2ba4c96220d5def5a95d0e51afa54ae28beb19c30873c3c0cf9a95fa975023364f7088a0190d26452e307e715925e21a78c

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 *.bundle
 /Gemfile.lock
+/lib/debug/debug.so

data/CONTRIBUTING.md

@@ -0,0 +1,97 @@
+## Manually Test Your Changes
+
+You can manually test your changes with a simple Ruby script + a line of command. The following example will help you check:
+
+- Breakpoint insertion.
+- Resume from the breakpoint.
+- Backtrace display.
+- Information (local variables, ivars..etc.) display.
+- Debugger exit.
+
+
+### Script
+
+```ruby
+# target.rb
+class Foo
+  def first_call
+    second_call(20)
+  end
+
+  def second_call(num)
+    third_call_with_block do |ten|
+      forth_call(num, ten)
+    end
+  end
+
+  def third_call_with_block(&block)
+    @ivar1 = 10; @ivar2 = 20
+
+    yield(10)
+  end
+
+  def forth_call(num1, num2)
+    num1 + num2
+  end
+end
+
+Foo.new.first_call
+```
+
+### Command
+
+```
+$ exe/rdbg -e 'b 20;; c ;; bt ;; info ;; q!' -e c target.rb
+```
+
+### Expect Result
+
+```
+❯ exe/rdbg -e 'b 20;; c ;; bt ;; info ;; q!' -e c target.rb
+[1, 10] in target.rb
+=>    1| class Foo
+      2|   def first_call
+      3|     second_call(20)
+      4|   end
+      5|
+      6|   def second_call(num)
+      7|     third_call_with_block do |ten|
+      8|       forth_call(num, ten)
+      9|     end
+     10|   end
+=>#0    <main> at target.rb:1
+(rdbg:init) b 20
+#1 line bp /PATH_TO_PROJECT/debug/target.rb:20 (return)
+(rdbg:init) c
+[15, 23] in target.rb
+     15|     yield(10)
+     16|   end
+     17|
+     18|   def forth_call(num1, num2)
+     19|     num1 + num2
+=>   20|   end
+     21| end
+     22|
+     23| Foo.new.first_call
+=>#0    Foo#forth_call(num1=20, num2=10) at target.rb:20 #=> 30
+  #1    block{|ten=10|} in second_call at target.rb:8
+  # and 4 frames (use `bt' command for all frames)
+
+Stop by #1 line bp /PATH_TO_PROJECT/debug/target.rb:20 (return)
+(rdbg:init) bt
+=>#0    Foo#forth_call(num1=20, num2=10) at target.rb:20 #=> 30
+  #1    block{|ten=10|} in second_call at target.rb:8
+  #2    Foo#third_call_with_block(block=#<Proc:0x00007f8bc32f0c28 target.rb:7>) at target.rb:15
+  #3    Foo#second_call(num=20) at target.rb:7
+  #4    first_call at target.rb:3
+  #5    <main> at target.rb:23
+(rdbg:init) info
+=>#0    Foo#forth_call(num1=20, num2=10) at target.rb:20 #=> 30
+ %self => #<Foo:0x00007f8bc32f0ed0>
+ %return => 30
+ num1 => 20
+ num2 => 10
+ @ivar1 => 10
+ @ivar2 => 20
+(rdbg:init) q!
+```

data/Gemfile

@@ -2,6 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake"
 gem "rake-compiler"
 gem "minitest", "~> 5.0"

data/README.md

@@ -62,13 +62,14 @@ $ ruby -r debug/run target.rb
 
 $ cat 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 ...
 
 $ ruby target.rb
 ```
@@ -373,11 +374,11 @@ The `<...>` notation means the argument.
   * Note that edited file will not be reloaded.
 * `edit <file>`
   * Open <file> on the editor.
-* `i[nfo]`
+* `i[nfo]`, `i[nfo] l[ocal[s]]`
   * Show information about the current frame (local variables)
   * It includes `self` as `%self` and a return value as `%return`.
-* `i[nfo] <expr>`
-  * Show information about the result of <expr>.
+* `i[nfo] th[read[s]]
+  * Show all threads (same as `th[read]`).
 * `display`
   * Show display setting.
 * `display <expr>`
@@ -437,27 +438,28 @@ Debug console mode:
     -O, --open                       Start debuggee with opening the debugger port.
                                      If TCP/IP options are not given,
                                      a UNIX domain socket will be used.
+        --sock-path=[SOCK_PATH]      UNIX Doman socket path
         --port=[PORT]                Listening TCP/IP port
         --host=[HOST]                Listening TCP/IP host
 
   Debug console mode runs Ruby program with the debug console.
 
-  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.
+  '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.
 
-  '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'           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.
 
 ```
@@ -465,3 +467,5 @@ Attach mode:
 # Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.
+
+Please also check the [contributing guideline](/CONTRIBUTING.md).

data/TODO.md

@@ -0,0 +1,33 @@
+# TODO
+
+## Basic functionality
+
+* VScode DAP support
+* Support Ractors
+* Signal (SIGINT) support
+* Remote connection with openssl
+
+## UI
+
+* Coloring
+* Interactive breakpoint setting
+* irb integration
+* Web browser integrated UI
+
+## Debug command
+
+* Breakpoints
+    * Lightweight pending method break points with Ruby 3.1 feature (TP:method_added)
+    * Non-stop breakpoint but runs some code.
+* Watch points
+    * Lightweight watchpoints for instance variables with Ruby 3.1 features (TP:ivar_set)
+* Faster `next`/`finish` command by specifying target code.
+* `set`/`show` configurations
+* In-memory line traces
+* Timemachine debugging
+
+## Tests
+
+* Test framework
+* Tests for commands
+* Tests for remote debugging

data/ext/debug/debug.c

@@ -90,7 +90,7 @@ method_added_tracker(VALUE tpval, void *ptr)
     VALUE mid = rb_tracearg_callee_id(arg);
 
     if (RB_UNLIKELY(mid == ID2SYM(rb_intern("method_added")) ||
-                    mid == ID2SYM(rb_intern("singleton_method_method_added")))) {
+                    mid == ID2SYM(rb_intern("singleton_method_added")))) {
         VALUE args[] = {
             tpval,
         };

data/lib/debug.rb

@@ -1 +1 @@
-require_relative 'debug/run'
+require_relative 'debug/session'

data/lib/debug/breakpoint.rb

@@ -209,7 +209,7 @@ module DEBUGGER__
       @tp = TracePoint.new(:raise){|tp|
         exc = tp.raised_exception
         exc.class.ancestors.each{|cls|
-          suspend if pat === cls.name
+          suspend if @pat === cls.name
         }
       }
     end
@@ -333,7 +333,11 @@ module DEBUGGER__
       end
     end
 
-    def enable quiet: false
+    def enable
+      try_enable
+    end
+
+    def try_enable quiet: false
       eval_class_name
       search_method
 

data/lib/debug/config.rb

@@ -2,7 +2,7 @@
 module DEBUGGER__
   def self.unix_domain_socket_dir
     case
-    when path = DEBUGGER__::CONFIG[:sock_dir]
+    when path = ::DEBUGGER__::CONFIG[:sock_dir]
     when path = ENV['XDG_RUNTIME_DIR']
     when home = ENV['HOME']
       path = File.join(home, '.ruby-debug-sock')
@@ -40,25 +40,39 @@ module DEBUGGER__
     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).
+    use_colorize:   'RUBY_DEBUG_USE_COLORIZE',   # Show coloring
 
     # remote
     port:        'RUBY_DEBUG_PORT',        # TCP/IP remote debugging: port
     host:        'RUBY_DEBUG_HOST',        # TCP/IP remote debugging: host (localhost if not given)
+    sock_path:   'RUBY_DEBUG_SOCK_PATH',   # UNIX Domain Socket remote debugging: socket path
     sock_dir:    'RUBY_DEBUG_SOCK_DIR',    # UNIX Domain Socket remote debugging: socket directory
   }.freeze
 
   def self.config_to_env config
     CONFIG_MAP.each{|key, evname|
-      ENV[evname] = config[key]
+      ENV[evname] = config[key].to_s if config[key]
     }
   end
 
   def self.parse_argv argv
     config = {
       mode: :start,
+      use_colorize: true,
     }
     CONFIG_MAP.each{|key, evname|
-      config[key] = ENV[evname] if ENV[evname]
+      if val = ENV[evname]
+        if /_USE_/ =~ evname || /NONSTOP/ =~ evname
+          case val
+          when '1', 'true', 'TRUE', 'T'
+            config[key] = true
+          else
+            config[key] = false
+          end
+        else
+          config[key] = val
+        end
+      end
     }
     return config if !argv || argv.empty?
 
@@ -83,6 +97,9 @@ module DEBUGGER__
                            'a UNIX domain socket will be used.') do
         config[:remote] = true
       end
+      o.on('--sock-path=[SOCK_PATH]', 'UNIX Doman socket path') do |path|
+        config[:sock_path] = path
+      end
       o.on('--port=[PORT]', 'Listening TCP/IP port') do |port|
         config[:port] = port
       end
@@ -95,11 +112,11 @@ module DEBUGGER__
       o.separator ''
       o.separator '  Debug console mode runs Ruby program with the debug console.'
       o.separator ''
-      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 "  '#{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:'
@@ -110,11 +127,11 @@ module DEBUGGER__
       o.separator ''
       o.separator '  Attach mode attaches the remote debug console to the debuggee process.'
       o.separator ''
-      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'           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
 
@@ -122,4 +139,16 @@ module DEBUGGER__
 
     config
   end
+
+  CONFIG = ::DEBUGGER__.parse_argv(ENV['RUBY_DEBUG_OPT'])
+
+  def self.set_config kw
+    kw.each{|k, v|
+      if CONFIG_MAP[k]
+        CONFIG[k] = v # TODO: ractor support
+      else
+        raise "unknown option: #{k}"
+      end
+    }
+  end
 end

data/lib/debug/frame_info.rb

@@ -0,0 +1,113 @@
+
+module DEBUGGER__
+  FrameInfo = Struct.new(:location, :self, :binding, :iseq, :class, :frame_depth,
+                          :has_return_value, :return_value, :show_line)
+
+
+  # extend FrameInfo with debug.so
+  if File.exist? File.join(__dir__, 'debug.so')
+    require_relative 'debug.so'
+  else
+    require "debug/debug"
+  end
+
+  class FrameInfo
+    HOME = ENV['HOME'] ? (ENV['HOME'] + '/') : nil
+
+    def path
+      location.path
+    end
+
+    def realpath
+      location.absolute_path
+    end
+
+    def pretty_path
+      use_short_path = ::DEBUGGER__::CONFIG[:use_short_path]
+
+      case
+      when use_short_path && path.start_with?(dir = ::DEBUGGER__::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 file_lines
+      SESSION.source(realpath || path)
+    end
+
+    def call_identifier_str
+      if binding && iseq
+        if iseq.type == :block
+          if (argc = iseq.argc) > 0
+            args = parameters_info iseq.locals[0...argc]
+            args_str = "{|#{args}|}"
+          end
+
+          location.label.sub('block'){ "block#{args_str}" }
+        elsif (callee = binding.eval('__callee__', __FILE__, __LINE__)) && (argc = iseq.argc) > 0
+          args = parameters_info iseq.locals[0...argc]
+          "#{klass_sig}#{callee}(#{args})"
+        else
+          location.label
+        end
+      else
+        "[C] #{klass_sig}#{location.base_label}"
+      end
+    end
+
+    def return_str
+      if binding && iseq && has_return_value
+        short_inspect(return_value)
+      end
+    end
+
+    def location_str
+      "#{pretty_path}:#{location.lineno}"
+    end
+
+    private
+
+    SHORT_INSPECT_LENGTH = 40
+
+    def short_inspect obj
+      str = obj.inspect
+      if str.length > SHORT_INSPECT_LENGTH
+        str[0...SHORT_INSPECT_LENGTH] + '...'
+      else
+        str
+      end
+    end
+
+    def get_singleton_class obj
+      obj.singleton_class # TODO: don't use it
+    rescue TypeError
+      nil
+    end
+
+    def parameters_info vars
+      vars.map{|var|
+        begin
+          "#{var}=#{short_inspect(binding.local_variable_get(var))}"
+        rescue NameError, TypeError
+          nil
+        end
+      }.compact.join(', ')
+    end
+
+    def klass_sig
+      if self.class == get_singleton_class(self.self)
+        "#{self.self}."
+      else
+        "#{self.class}#"
+      end
+    end
+  end
+end

data/lib/debug/server.rb

@@ -187,39 +187,30 @@ module DEBUGGER__
   end
 
   class UI_UnixDomainServer < UI_ServerBase
-    def initialize sock_dir: nil
+    def initialize sock_dir: nil, sock_path: nil
+      @sock_path = sock_path
       @sock_dir = sock_dir || DEBUGGER__.unix_domain_socket_dir
 
       super()
     end
 
     def accept
-      @file = DEBUGGER__.create_unix_domain_socket_name(@sock_dir)
+      case
+      when @sock_path
+      when sp = ::DEBUGGER__::CONFIG[:sock_path]
+        @sock_path = sp
+      else
+        @sock_path = DEBUGGER__.create_unix_domain_socket_name(@sock_dir)
+      end
 
-      ::DEBUGGER__.message "Debugger can attach via UNIX domain socket (#{@file})"
-      Socket.unix_server_loop @file do |sock, client|
+      ::DEBUGGER__.message "Debugger can attach via UNIX domain socket (#{@sock_path})"
+      Socket.unix_server_loop @sock_path do |sock, client|
         @client_addr = client
         yield sock
       end
     end
   end
 
-  def self.open host: nil, port: ::DEBUGGER__::CONFIG[:port], sock_dir: nil
-    if port
-      open_tcp host: host, port: port
-    else
-      open_unix sock_dir: sock_dir
-    end
-  end
-
-  def self.open_tcp(host: nil, port:)
-    initialize_session UI_TcpServer.new(host: host, port: port)
-  end
-
-  def self.open_unix sock_dir: nil
-    initialize_session UI_UnixDomainServer.new(sock_dir: sock_dir)
-  end
-
   def self.message msg
     $stderr.puts "DEBUGGER: #{msg}"
   end

data/lib/debug/session.rb

@@ -1,18 +1,7 @@
-module DEBUGGER__
-  # used in thread_client.c
-  FrameInfo = Struct.new(:location, :self, :binding, :iseq, :class, :frame_depth,
-                         :has_return_value, :return_value, :show_line)
-end
-
-if File.exist? File.join(__dir__, 'debug.so')
-  require_relative 'debug.so'
-else
-  require "debug/debug"
-end
-
+
+require_relative 'thread_client'
 require_relative 'source_repository'
 require_relative 'breakpoint'
-require_relative 'thread_client'
 require_relative 'config'
 
 class RubyVM::InstructionSequence
@@ -61,7 +50,7 @@ module DEBUGGER__
       @bps = {} # bp.key => bp
                 #   [file, line] => LineBreakpoint
                 #   "Error" => CatchBreakpoint
-                #   Method => MethodBreakpoint
+                #   "Foo#bar" => MethodBreakpoint
                 #   [:watch, expr] => WatchExprBreakpoint
                 #   [:check, expr] => CheckBreakpoint
       @th_clients = {} # {Thread => ThreadClient}
@@ -73,7 +62,8 @@ module DEBUGGER__
 
       @tp_load_script = TracePoint.new(:script_compiled){|tp|
         ThreadClient.current.on_load tp.instruction_sequence, tp.eval_script
-      }.enable
+      }
+      @tp_load_script.enable
 
       @session_server = Thread.new do
         Thread.current.abort_on_exception = true
@@ -149,7 +139,8 @@ module DEBUGGER__
 
       @tp_thread_begin = TracePoint.new(:thread_begin){|tp|
         ThreadClient.current.on_thread_begin Thread.current
-      }.enable
+      }
+      @tp_thread_begin.enable
     end
 
     def add_initial_commands cmds
@@ -160,7 +151,11 @@ module DEBUGGER__
     end
 
     def source path
-      @sr.get(path)
+      if CONFIG[:use_colorize]
+        @sr.get_colored(path)
+      else
+        @sr.get(path)
+      end
     end
 
     def inspect
@@ -409,17 +404,23 @@ module DEBUGGER__
 
         @tc << [:show, :edit, arg]
 
-      # * `i[nfo]`
+      # * `i[nfo]`, `i[nfo] l[ocal[s]]`
       #   * Show information about the current frame (local variables)
       #   * It includes `self` as `%self` and a return value as `%return`.
-      # * `i[nfo] <expr>`
-      #   * Show information about the result of <expr>.
+      # * `i[nfo] th[read[s]]
+      #   * Show all threads (same as `th[read]`).
       when 'i', 'info'
         case arg
         when nil
           @tc << [:show, :local]
+        when 'l', /locals?/
+          @tc << [:show, :local]
+        when 'th', /threads?/
+          thread_list
+          return :retry
         else
-          @tc << [:show, :object_info, arg]
+          show_help 'info'
+          return :retry
         end
 
       # * `display`
@@ -855,7 +856,7 @@ module DEBUGGER__
 
     def add_catch_breakpoint arg
       bp = CatchBreakpoint.new(arg)
-      add_braekpoint bp
+      add_breakpoint bp
     end
 
     def add_check_breakpoint expr
@@ -897,26 +898,37 @@ module DEBUGGER__
       b = tp.binding
       if var_name = b.local_variables.first
         mid = b.local_variable_get(var_name)
-        found = false
+        unresolved = false
 
         @bps.each{|k, bp|
           case bp
           when MethodBreakpoint
             if bp.method.nil?
-              found = true
               if bp.sig_method_name == mid.to_s
-                bp.enable(quiet: true)
+                bp.try_enable(quiet: true)
               end
             end
+
+            unresolved = true unless bp.enabled?
           end
         }
-        unless found
+        unless unresolved
           METHOD_ADDED_TRACKER.disable
         end
       end
     end
   end
 
+  # manual configuration methods
+
+  def self.add_line_breakpoint file, line, **kw
+    ::DEBUGGER__::SESSION.add_line_breakpoint file, line, **kw
+  end
+
+  def self.add_catch_breakpoint pat
+    ::DEBUGGER__::SESSION.add_catch_breakpoint pat
+  end
+
   # String for requring location
   # nil for -r
   def self.require_location
@@ -934,7 +946,12 @@ module DEBUGGER__
     nil
   end
 
-  def self.console
+  # start methods
+
+  def self.console **kw
+    set_config(kw)
+
+    require_relative 'console'
     initialize_session UI_Console.new
 
     @prev_handler = trap(:SIGINT){
@@ -942,14 +959,30 @@ module DEBUGGER__
     }
   end
 
-  def self.add_line_breakpoint file, line, **kw
-    ::DEBUGGER__::SESSION.add_line_breakpoint file, line, **kw
+  def self.open host: nil, port: ::DEBUGGER__::CONFIG[:port], sock_path: nil, sock_dir: nil, **kw
+    set_config(kw)
+
+    if port
+      open_tcp host: host, port: port
+    else
+      open_unix sock_path: sock_path, sock_dir: sock_dir
+    end
   end
 
-  def self.add_catch_breakpoint pat
-    ::DEBUGGER__::SESSION.add_catch_breakpoint pat
+  def self.open_tcp host: nil, port:, **kw
+    set_config(kw)
+    require_relative 'server'
+    initialize_session UI_TcpServer.new(host: host, port: port)
   end
 
+  def self.open_unix sock_path: nil, sock_dir: nil, **kw
+    set_config(kw)
+    require_relative 'server'
+    initialize_session UI_UnixDomainServer.new(sock_dir: sock_dir, sock_path: sock_path)
+  end
+
+  # boot utilities
+
   class << self
     define_method :initialize_session do |ui|
       ::DEBUGGER__.const_set(:SESSION, Session.new(ui))
@@ -963,7 +996,7 @@ module DEBUGGER__
         def bp; nil; end
       end
 
-      if ::DEBUGGER__::CONFIG[:nonstop] != '1'
+      if !::DEBUGGER__::CONFIG[:nonstop]
         if loc = ::DEBUGGER__.require_location
           # require 'debug/console' or 'debug'
           add_line_breakpoint loc.absolute_path, loc.lineno + 1, oneshot: true, hook_call: false
@@ -1052,8 +1085,6 @@ module DEBUGGER__
     r.join("\n")
   end
 
-  CONFIG = ::DEBUGGER__.parse_argv(ENV['RUBY_DEBUG_OPT'])
-
   class ::Module
     def method_added mid; end
     def singleton_method_added mid; end

data/lib/debug/source_repository.rb

@@ -1,27 +1,57 @@
+require 'irb/color' # IRB::Color.colorize_code
+
 module DEBUGGER__
   class SourceRepository
     def initialize
       @files = {} # filename => [src, iseq]
+      @color_files = {}
     end
 
     def add iseq, src
       path = iseq.absolute_path
       path = '-e' if iseq.path == '-e'
+      add_path path, src: src
+    end
 
+    def add_path path, src: nil
       case
-      when path = iseq.absolute_path
-        src = File.read(path)
-      when iseq.path == '-e'
-        path = '-e'
+      when src
+        if File.file?(path)
+          path = '(eval)' + path
+          src = nil
+        end
+      when path == '-e'
+      when path
+        begin
+          src = File.read(path)
+        rescue SystemCallError
+        end
       else
         src = nil
       end
 
-      @files[path] = src.lines if src
+      if src
+        src = src.gsub("\r\n", "\n") # CRLF -> LF
+        @files[path] = src.lines
+      end
     end
 
     def get path
-      @files[path]
+      if @files.has_key? path
+        @files[path]
+      else
+        add_path path
+      end
+    end
+
+    def get_colored path
+      if src_lines = @color_files[path]
+        return src_lines
+      else
+        if src_lines = get(path)
+          @color_files[path] = IRB::Color.colorize_code(src_lines.join).lines
+        end
+      end
     end
   end
 end

data/lib/debug/thread_client.rb

@@ -1,5 +1,7 @@
 require 'objspace'
 require 'pp'
+require 'irb/color'
+require_relative 'frame_info'
 
 module DEBUGGER__
   class ThreadClient
@@ -12,6 +14,27 @@ module DEBUGGER__
 
     attr_reader :location, :thread, :mode, :id
 
+    def colorize str, color
+      if CONFIG[:use_colorize]
+        IRB::Color.colorize str, color
+      else
+        str
+      end
+    end
+
+    def default_frame_formatter frame
+      call_identifier_str = colorize(frame.call_identifier_str, [:BLUE, :BOLD])
+      location_str = colorize(frame.location_str, [:YELLOW])
+      result = "#{call_identifier_str} at #{location_str}"
+
+      if return_str = frame.return_str
+        return_str = colorize(frame.return_str, [:MAGENTA])
+        result += " #=> #{return_str}"
+      end
+
+      result
+    end
+
     def initialize id, q_evt, q_cmd, thr = Thread.current
       @id = id
       @thread = thr
@@ -19,8 +42,9 @@ module DEBUGGER__
       @q_cmd = q_cmd
       @step_tp = nil
       @output = []
-      @src_lines_on_stop = (DEBUGGER__::CONFIG[:show_src_lines]   || 10).to_i
-      @show_frames_on_stop = (DEBUGGER__::CONFIG[:show_frames] || 2).to_i
+      @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)
       set_mode nil
     end
 
@@ -129,7 +153,7 @@ 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]
+          next unless File.exist?(tp.path) if ::DEBUGGER__::CONFIG[:skip_nosrc]
 
           tp.disable
           on_suspend tp.event, tp
@@ -140,7 +164,7 @@ 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]
+          next unless File.exist?(tp.path) if ::DEBUGGER__::CONFIG[:skip_nosrc]
 
           tp.disable
           on_suspend tp.event, tp
@@ -157,23 +181,15 @@ module DEBUGGER__
       end
     end
 
-    def file_lines path
-      if (src_lines = SESSION.source(path))
-        src_lines
-      elsif File.exist?(path)
-        File.readlines(path)
-      end
-    end
-
     def show_src(frame_index: @current_frame_index,
                  update_line: false,
                  max_lines: 10,
                  start_line: nil,
                  end_line: nil,
                  dir: +1)
-      #
+
       if @target_frames && frame = @target_frames[frame_index]
-        if file_lines = file_lines(path = frame.location.path)
+        if file_lines = frame.file_lines
           frame_line = frame.location.lineno - 1
 
           lines = file_lines.map.with_index do |e, i|
@@ -206,11 +222,11 @@ module DEBUGGER__
           end
 
           if start_line != end_line && max_lines
-            puts "[#{start_line+1}, #{end_line}] in #{pretty_path(path)}" if !update_line && max_lines != 1
+            puts "[#{start_line+1}, #{end_line}] in #{frame.pretty_path}" if !update_line && max_lines != 1
             puts lines[start_line ... end_line]
           end
         else # no file lines
-          puts "# No sourcefile available for #{path}"
+          puts "# No sourcefile available for #{frame.path}"
         end
       end
     end
@@ -218,7 +234,7 @@ module DEBUGGER__
     def show_by_editor path = nil
       unless path
         if @target_frames && frame = @target_frames[@current_frame_index]
-          path = frame.location.path
+          path = frame.path
         else
           return # can't get path
         end
@@ -287,101 +303,12 @@ module DEBUGGER__
       end
     end
 
-    def parameters_info b, vars
-      vars.map{|var|
-        begin
-          "#{var}=#{short_inspect(b.local_variable_get(var))}"
-        rescue NameError, TypeError
-          nil
-        end
-      }.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 == get_singleton_class(frame.self)
-        "#{frame.self}."
-      else
-        "#{frame.class}#"
-      end
-    end
-
-    SHORT_INSPECT_LENGTH = 40
-
-    def short_inspect obj
-      str = obj.inspect
-      if str.length > SHORT_INSPECT_LENGTH
-        str[0...SHORT_INSPECT_LENGTH] + '...'
-      else
-        str
-      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
-      frame = @target_frames[i]
-      b = frame.binding
-
+    def frame_str(i)
       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]
-            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
-          ci_str = frame.location.label
-        end
-
-        loc_str = "#{pretty_location(frame.location)}"
-
-        if frame.has_return_value
-          return_str = " #=> #{short_inspect(frame.return_value)}"
-        end
-      else
-        ksig = klass_sig frame
-        callee = frame.location.base_label
-        ci_str = "[C] #{ksig}#{callee}"
-        loc_str = "#{pretty_location(frame.location)}"
-      end
-
-      "#{cur_str}##{i}\t#{ci_str}#{loc_str}#{return_str}"
+      prefix = "#{cur_str}##{i}"
+      frame = @target_frames[i]
+      frame_string = @frame_formatter.call(frame)
+      "#{prefix}\t#{frame_string}"
     end
 
     def show_frames max = (@target_frames || []).size
@@ -457,7 +384,7 @@ module DEBUGGER__
             step_tp{true}
           when :next
             frame = @target_frames.first
-            path = frame.location.absolute_path || "!eval:#{frame.location.path}"
+            path = frame.location.absolute_path || "!eval:#{frame.path}"
             line = frame.location.lineno
             frame.iseq.traceable_lines_norec(lines = {})
             next_line = lines.keys.bsearch{|e| e > line}
@@ -533,7 +460,7 @@ module DEBUGGER__
           case type
           when :up
             if @current_frame_index + 1 < @target_frames.size
-              @current_frame_index += 1 
+              @current_frame_index += 1
               show_src max_lines: 1
               show_frame(@current_frame_index)
             end

data/lib/debug/version.rb

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

data/misc/README.md.erb

@@ -62,13 +62,14 @@ $ ruby -r debug/run target.rb
 
 $ cat 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 ...
 
 $ ruby target.rb
 ```
@@ -295,10 +296,10 @@ You can control debuggee's behavior with environment variables:
 * `RUBY_DEBUG_COMMANDS`: Debug commands invoked at the first stop. Commands should be separated by ';;'.
 * `RUBY_DEBUG_SHOW_SRC_LINES`: Show n lines source code on breakpoint (default: 10 lines).
 * `RUBY_DEBUG_SHOW_FRAMES`: Show n frames on breakpoint (default: 2 frames).
-
 * Remote debugging
   * `RUBY_DEBUG_PORT`: TCP/IP remote debugging: port to open.
   * `RUBY_DEBUG_HOST`: TCP/IP remote debugging: host (localhost if not given) to open.
+  * `RUBY_DEBUG_SOCK_PATH`: UNIX Domain Socket remote debugging: socket path to open.
   * `RUBY_DEBUG_SOCK_DIR`: UNIX Domain Socket remote debugging: socket directory to open.
 
 ## Debug command on the debug console
@@ -322,3 +323,5 @@ The `<...>` notation means the argument.
 # Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.
+
+Please also check the [contributing guideline](/CONTRIBUTING.md).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0.beta4
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-14 00:00:00.000000000 Z
+date: 2021-05-25 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.
@@ -21,10 +21,12 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
 - debug.gemspec
@@ -38,6 +40,7 @@ files:
 - lib/debug/client.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