debug 1.4.0 → 1.5.0

data/lib/debug/session.rb

@@ -7,7 +7,7 @@ return if ENV['RUBY_DEBUG_ENABLE'] == '0'
 if $0.end_with?('bin/bundle') && ARGV.first == 'exec'
   trace_var(:$0) do |file|
     trace_var(:$0, nil)
-    if /-r (#{__dir__}\S+)/ =~ ENV['RUBYOPT']
+    if /-r (#{Regexp.escape(__dir__)}\S+)/ =~ ENV['RUBYOPT']
       lib = $1
       $LOADED_FEATURES.delete_if{|path| path.start_with?(__dir__)}
       ENV['RUBY_DEBUG_INITIAL_SUSPEND_PATH'] = file
@@ -31,7 +31,7 @@ $LOADED_FEATURES << 'debug.rb'
 $LOADED_FEATURES << File.expand_path(File.join(__dir__, '..', 'debug.rb'))
 require 'debug' # invalidate the $LOADED_FEATURE cache
 
-require 'json' if ENV['RUBY_DEBUG_TEST_MODE']
+require 'json' if ENV['RUBY_DEBUG_TEST_UI'] == 'terminal'
 
 class RubyVM::InstructionSequence
   def traceable_lines_norec lines
@@ -56,23 +56,22 @@ class RubyVM::InstructionSequence
 
   def type
     self.to_a[9]
-  end
-
-  def argc
-    self.to_a[4][:arg_size]
-  end
+  end unless method_defined?(:type)
 
-  def locals
-    self.to_a[10]
-  end
+  def parameters_symbols
+    ary = self.to_a
+    argc = ary[4][:arg_size]
+    locals = ary.to_a[10]
+    locals[0...argc]
+  end unless method_defined?(:parameters_symbols)
 
   def last_line
     self.to_a[4][:code_location][2]
-  end
+  end unless method_defined?(:last_line)
 
   def first_line
     self.to_a[4][:code_location][0]
-  end
+  end unless method_defined?(:first_line)
 end
 
 module DEBUGGER__
@@ -82,8 +81,10 @@ module DEBUGGER__
   class Session
     attr_reader :intercepted_sigint_cmd, :process_group
 
-    def initialize ui
-      @ui = ui
+    include Color
+
+    def initialize
+      @ui = nil
       @sr = SourceRepository.new
       @bps = {} # bp.key => bp
                 #   [file, line] => LineBreakpoint
@@ -104,13 +105,13 @@ module DEBUGGER__
       @intercept_trap_sigint = false
       @intercepted_sigint_cmd = 'DEFAULT'
       @process_group = ProcessGroup.new
-      @subsession = nil
+      @subsession_stack = []
 
       @frame_map = {} # for DAP: {id => [threadId, frame_depth]} and CDP: {id => frame_depth}
       @var_map   = {1 => [:globals], } # {id => ...} for DAP
       @src_map   = {} # {id => src}
 
-      @script_paths = [File.absolute_path($0)] # for CDP
+      @scr_id_map = {} # for CDP
       @obj_map = {} # { object_id => ... } for CDP
 
       @tp_thread_begin = nil
@@ -120,9 +121,6 @@ module DEBUGGER__
       @tp_load_script.enable
 
       @thread_stopper = thread_stopper
-
-      activate
-
       self.postmortem = CONFIG[:postmortem]
     end
 
@@ -134,15 +132,13 @@ module DEBUGGER__
       @bps.has_key? [file, line]
     end
 
-    def activate on_fork: false
+    def activate ui = nil, on_fork: false
+      @ui = ui if ui
+
       @tp_thread_begin&.disable
       @tp_thread_begin = nil
 
-      if on_fork
-        @ui.activate self, on_fork: true
-      else
-        @ui.activate self, on_fork: false
-      end
+      @ui.activate self, on_fork: on_fork
 
       q = Queue.new
       @session_server = Thread.new do
@@ -215,6 +211,7 @@ module DEBUGGER__
         q << true
 
       when :init
+        enter_subsession
         wait_command_loop tc
 
       when :load
@@ -257,7 +254,7 @@ module DEBUGGER__
         end
 
       when :result
-        raise "[BUG] not in subsession" unless @subsession
+        raise "[BUG] not in subsession" if @subsession_stack.empty?
 
         case ev_args.first
         when :try_display
@@ -369,7 +366,7 @@ module DEBUGGER__
           @ui.puts "(rdbg:#{@preset_command.source}) #{line}"
         end
       else
-        @ui.puts "INTERNAL_INFO: #{JSON.generate(@internal_info)}" if ENV['RUBY_DEBUG_TEST_MODE']
+        @ui.puts "INTERNAL_INFO: #{JSON.generate(@internal_info)}" if ENV['RUBY_DEBUG_TEST_UI'] == 'terminal'
         line = @ui.readline prompt
       end
 
@@ -510,8 +507,8 @@ module DEBUGGER__
       #   * break and run `<command>` before stopping.
       # * `b[reak] ... do: <command>`
       #   * break and run `<command>`, and continue.
-      # * `b[reak] ... path: <path_regexp>`
-      #   * break if the triggering event's path matches <path_regexp>.
+      # * `b[reak] ... path: <path>`
+      #   * break if the path matches to `<path>`. `<path>` can be a regexp with `/regexp/`.
       # * `b[reak] if: <expr>`
       #   * break if: `<expr>` is true at any lines.
       #   * Note that this feature is super slow.
@@ -566,8 +563,8 @@ module DEBUGGER__
       #   * runs `<command>` before stopping.
       # * `catch ... do: <command>`
       #   * stops and run `<command>`, and continue.
-      # * `catch ... path: <path_regexp>`
-      #   * stops if the exception is raised from a path that matches <path_regexp>.
+      # * `catch ... path: <path>`
+      #   * stops if the exception is raised from a `<path>`. `<path>` can be a regexp with `/regexp/`.
       when 'catch'
         check_postmortem
 
@@ -588,8 +585,8 @@ module DEBUGGER__
       #   * runs `<command>` before stopping.
       # * `watch ... do: <command>`
       #   * stops and run `<command>`, and continue.
-      # * `watch ... path: <path_regexp>`
-      #   * stops if the triggering event's path matches <path_regexp>.
+      # * `watch ... path: <path>`
+      #   * stops if the path matches `<path>`. `<path>` can be a regexp with `/regexp/`.
       when 'wat', 'watch'
         check_postmortem
 
@@ -699,8 +696,8 @@ module DEBUGGER__
       #   * Show information about accessible constants except toplevel constants.
       # * `i[nfo] g[lobal[s]]`
       #   * Show information about global variables
-      # * `i[nfo] ... </pattern/>`
-      #   * Filter the output with `</pattern/>`.
+      # * `i[nfo] ... /regexp/`
+      #   * Filter the output with `/regexp/`.
       # * `i[nfo] th[read[s]]`
       #   * Show all threads (same as `th[read]`).
       when 'i', 'info'
@@ -834,8 +831,8 @@ module DEBUGGER__
       #   * Add an exception tracer. It indicates raising exceptions.
       # * `trace object <expr>`
       #   * Add an object tracer. It indicates that an object by `<expr>` is passed as a parameter or a receiver on method call.
-      # * `trace ... </pattern/>`
-      #   * Indicates only matched events to `</pattern/>` (RegExp).
+      # * `trace ... /regexp/`
+      #   * Indicates only matched events to `/regexp/`.
       # * `trace ... into: <file>`
       #   * Save trace information into: `<file>`.
       # * `trace off <num>`
@@ -978,7 +975,7 @@ module DEBUGGER__
       when 'open'
         case arg&.downcase
         when '', nil
-          repl_open_unix
+          repl_open
         when 'vscode'
           repl_open_vscode
         when /\A(.+):(\d+)\z/
@@ -1003,11 +1000,7 @@ module DEBUGGER__
       # * `h[elp] <command>`
       #   * Show help for the given command.
       when 'h', 'help', '?'
-        if arg
-          show_help arg
-        else
-          @ui.puts DEBUGGER__.help
-        end
+        show_help arg
         return :retry
 
       ### END
@@ -1055,14 +1048,14 @@ module DEBUGGER__
       repl_open_setup
     end
 
-    def repl_open_unix
-      DEBUGGER__.open_unix nonstop: true
+    def repl_open
+      DEBUGGER__.open nonstop: true
       repl_open_setup
     end
 
     def repl_open_vscode
       CONFIG[:open_frontend] = 'vscode'
-      repl_open_unix
+      repl_open
     end
 
     def step_command type, arg
@@ -1159,16 +1152,50 @@ module DEBUGGER__
       end
     end
 
-    def show_help arg
-      DEBUGGER__.helps.each{|cat, cs|
-        cs.each{|ws, desc|
-          if ws.include? arg
-            @ui.puts desc
-            return
+    def show_help arg = nil
+      instructions = (DEBUGGER__.commands.keys + DEBUGGER__.commands.values).uniq
+      print_instructions = proc do |desc|
+        desc.split("\n").each do |line|
+          next if line.start_with?(" ") # workaround for step back
+          formatted_line = line.gsub(/[\[\]\*]/, "").strip
+          instructions.each do |inst|
+            if formatted_line.start_with?("`#{inst}")
+              desc.sub!(line, colorize(line, [:CYAN, :BOLD]))
+            end
+          end
+        end
+        @ui.puts desc
+      end
+
+      print_category = proc do |cat|
+        @ui.puts "\n"
+        @ui.puts colorize("### #{cat}", [:GREEN, :BOLD])
+        @ui.puts "\n"
+      end
+
+      DEBUGGER__.helps.each { |cat, cs|
+        # categories
+        if arg.nil?
+          print_category.call(cat)
+        else
+          cs.each { |ws, _|
+            if ws.include?(arg)
+              print_category.call(cat)
+              break
+            end
+          }
+        end
+
+        # instructions
+        cs.each { |ws, desc|
+          if arg.nil? || ws.include?(arg)
+            print_instructions.call(desc.dup)
+            return if arg
           end
         }
       }
-      @ui.puts "not found: #{arg}"
+
+      @ui.puts "not found: #{arg}" if arg
     end
 
     def ask msg, default = 'Y'
@@ -1272,14 +1299,20 @@ module DEBUGGER__
         end
       }
       expr.default_proc = nil
-      expr.transform_values{|v| v.join(' ')}
+      expr = expr.transform_values{|v| v.join(' ')}
+
+      if (path = expr[:path]) && path =~ /\A\/(.*)\/\z/
+        expr[:path] = Regexp.compile($1)
+      end
+
+      expr
     end
 
     def repl_add_breakpoint arg
       expr = parse_break arg.strip
       cond = expr[:if]
       cmd = ['break', expr[:pre], expr[:do]] if expr[:pre] || expr[:do]
-      path = Regexp.compile(expr[:path]) if expr[:path]
+      path = expr[:path]
 
       case expr[:sig]
       when /\A(\d+)\z/
@@ -1290,7 +1323,7 @@ module DEBUGGER__
         @tc << [:breakpoint, :method, $1, $2, $3, cond, cmd, path]
         return :noretry
       when nil
-        add_check_breakpoint cond, path
+        add_check_breakpoint cond, path, cmd
       else
         @ui.puts "Unknown breakpoint format: #{arg}"
         @ui.puts
@@ -1302,7 +1335,7 @@ module DEBUGGER__
       expr = parse_break arg.strip
       cond = expr[:if]
       cmd = ['catch', expr[:pre], expr[:do]] if expr[:pre] || expr[:do]
-      path = Regexp.compile(expr[:path]) if expr[:path]
+      path = expr[:path]
 
       bp = CatchBreakpoint.new(expr[:sig], cond: cond, command: cmd, path: path)
       add_bp bp
@@ -1322,8 +1355,8 @@ module DEBUGGER__
       add_bp bp
     end
 
-    def add_check_breakpoint expr, path
-      bp = CheckBreakpoint.new(expr, path)
+    def add_check_breakpoint cond, path, command
+      bp = CheckBreakpoint.new(cond: cond, path: path, command: command)
       add_bp bp
     end
 
@@ -1336,6 +1369,15 @@ module DEBUGGER__
       @ui.puts e.message
     end
 
+    def clear_line_breakpoints path
+      path = resolve_path(path)
+      @bps.delete_if do |k, bp|
+        if (Array === k) && DEBUGGER__.compare_path(k.first, path)
+          bp.delete
+        end
+      end
+    end
+
     def add_iseq_breakpoint iseq, **kw
       bp = ISeqBreakpoint.new(iseq, [:line], **kw)
       add_bp bp
@@ -1503,27 +1545,38 @@ module DEBUGGER__
     end
 
     private def enter_subsession
-      raise "already in subsession" if @subsession
-      @subsession = true
-      stop_all_threads
-      @process_group.lock
-      DEBUGGER__.info "enter_subsession"
+      if !@subsession_stack.empty?
+        DEBUGGER__.info "Enter subsession (nested #{@subsession_stack.size})"
+      else
+        DEBUGGER__.info "Enter subsession"
+        stop_all_threads
+        @process_group.lock
+      end
+
+      @subsession_stack << true
     end
 
     private def leave_subsession type
-      DEBUGGER__.info "leave_subsession"
-      @process_group.unlock
-      restart_all_threads
+      raise '[BUG] leave_subsession: not entered' if @subsession_stack.empty?
+      @subsession_stack.pop
+
+      if @subsession_stack.empty?
+        DEBUGGER__.info "Leave subsession"
+        @process_group.unlock
+        restart_all_threads
+      else
+        DEBUGGER__.info "Leave subsession (nested #{@subsession_stack.size})"
+      end
+
       @tc << type if type
       @tc = nil
-      @subsession = false
     rescue Exception => e
-      STDERR.puts [e, e.backtrace].inspect
+      STDERR.puts PP.pp([e, e.backtrace], ''.dup)
       raise
     end
 
     def in_subsession?
-      @subsession
+      !@subsession_stack.empty?
     end
 
     ## event
@@ -1537,7 +1590,7 @@ module DEBUGGER__
       end
 
       pending_line_breakpoints.each do |_key, bp|
-        if bp.path == (iseq.absolute_path || iseq.path)
+        if DEBUGGER__.compare_path(bp.path, (iseq.absolute_path || iseq.path))
           bp.try_activate
         end
       end
@@ -1860,6 +1913,9 @@ module DEBUGGER__
         puts "\nStop by #{args.first}"
       end
     end
+
+    def flush
+    end
   end
 
   # manual configuration methods
@@ -1876,7 +1932,7 @@ module DEBUGGER__
   # nil for -r
   def self.require_location
     locs = caller_locations
-    dir_prefix = /#{__dir__}/
+    dir_prefix = /#{Regexp.escape(__dir__)}/
 
     locs.each do |loc|
       case loc.absolute_path
@@ -1896,7 +1952,7 @@ module DEBUGGER__
 
     unless defined? SESSION
       require_relative 'local'
-      initialize_session UI_LocalConsole.new
+      initialize_session{ UI_LocalConsole.new }
     end
 
     setup_initial_suspend unless nonstop
@@ -1904,8 +1960,9 @@ module DEBUGGER__
 
   def self.open host: nil, port: CONFIG[:port], sock_path: nil, sock_dir: nil, nonstop: false, **kw
     CONFIG.set_config(**kw)
+    require_relative 'server'
 
-    if port || CONFIG[:open_frontend] == 'chrome'
+    if port || CONFIG[:open_frontend] == 'chrome' || (!::Addrinfo.respond_to?(:unix))
       open_tcp host: host, port: (port || 0), nonstop: nonstop
     else
       open_unix sock_path: sock_path, sock_dir: sock_dir, nonstop: nonstop
@@ -1919,7 +1976,7 @@ module DEBUGGER__
     if defined? SESSION
       SESSION.reset_ui UI_TcpServer.new(host: host, port: port)
     else
-      initialize_session UI_TcpServer.new(host: host, port: port)
+      initialize_session{ UI_TcpServer.new(host: host, port: port) }
     end
 
     setup_initial_suspend unless nonstop
@@ -1932,7 +1989,7 @@ module DEBUGGER__
     if defined? SESSION
       SESSION.reset_ui UI_UnixDomainServer.new(sock_dir: sock_dir, sock_path: sock_path)
     else
-      initialize_session UI_UnixDomainServer.new(sock_dir: sock_dir, sock_path: sock_path)
+      initialize_session{ UI_UnixDomainServer.new(sock_dir: sock_dir, sock_path: sock_path) }
     end
 
     setup_initial_suspend unless nonstop
@@ -1959,9 +2016,10 @@ module DEBUGGER__
   end
 
   class << self
-    define_method :initialize_session do |ui|
+    define_method :initialize_session do |&init_ui|
       DEBUGGER__.info "Session start (pid: #{Process.pid})"
-      ::DEBUGGER__.const_set(:SESSION, Session.new(ui))
+      ::DEBUGGER__.const_set(:SESSION, Session.new)
+      SESSION.activate init_ui.call
       load_rc
     end
   end
@@ -2062,10 +2120,64 @@ module DEBUGGER__
     yield
   end
 
+  if File.identical?(__FILE__.upcase, __FILE__.downcase)
+    # For case insensitive file system (like Windows)
+    # Note that this check is not enough because case sensitive/insensitive is
+    # depend on the file system. So this check is only roughly estimation.
+
+    def self.compare_path(a, b)
+      a.downcase == b.downcase
+    end
+  else
+    def self.compare_path(a, b)
+      a == b
+    end
+  end
+
   module ForkInterceptor
-    def fork(&given_block)
-      return super unless defined?(SESSION) && SESSION.active?
+    if Process.respond_to? :_fork
+      def _fork
+        return yield unless defined?(SESSION) && SESSION.active?
+
+        parent_hook, child_hook = __fork_setup_for_debugger
+
+        super.tap do |pid|
+          if pid != 0
+            # after fork: parent
+            parent_hook.call pid
+          else
+            # after fork: child
+            child_hook.call
+          end
+        end
+      end
+    else
+      def fork(&given_block)
+        return yield unless defined?(SESSION) && SESSION.active?
+        parent_hook, child_hook = __fork_setup_for_debugger
+
+        if given_block
+          new_block = proc {
+            # after fork: child
+            child_hook.call
+            given_block.call
+          }
+          super(&new_block).tap{|pid| parent_hook.call(pid)}
+        else
+          super.tap do |pid|
+            if pid
+              # after fork: parent
+              parent_hook.call pid
+            else
+              # after fork: child
+              child_hook.call
+            end
+          end
+        end
+      end
+    end
 
+    private def __fork_setup_for_debugger
       unless fork_mode = CONFIG[:fork_mode]
         if CONFIG[:parent_on_fork]
           fork_mode = :parent
@@ -2112,26 +2224,7 @@ module DEBUGGER__
         }
       end
 
-      if given_block
-        new_block = proc {
-          # after fork: child
-          child_hook.call
-          given_block.call
-        }
-        pid = super(&new_block)
-        parent_hook.call(pid)
-        pid
-      else
-        if pid = super
-          # after fork: parent
-          parent_hook.call pid
-        else
-          # after fork: child
-          child_hook.call
-        end
-
-        pid
-      end
+      return parent_hook, child_hook
     end
   end
 
@@ -2148,28 +2241,46 @@ module DEBUGGER__
     end
   end
 
-  if RUBY_VERSION >= '3.0.0'
+  if Process.respond_to? :_fork
+    module ::Process
+      class << self
+        prepend ForkInterceptor
+      end
+    end
+
+    # trap
     module ::Kernel
-      prepend ForkInterceptor
       prepend TrapInterceptor
     end
+    module ::Signal
+      class << self
+        prepend TrapInterceptor
+      end
+    end
   else
-    class ::Object
-      include ForkInterceptor
-      include TrapInterceptor
+    if RUBY_VERSION >= '3.0.0'
+      module ::Kernel
+        prepend ForkInterceptor
+        prepend TrapInterceptor
+      end
+    else
+      class ::Object
+        include ForkInterceptor
+        include TrapInterceptor
+      end
     end
-  end
 
-  module ::Kernel
-    class << self
-      prepend ForkInterceptor
-      prepend TrapInterceptor
+    module ::Kernel
+      class << self
+        prepend ForkInterceptor
+        prepend TrapInterceptor
+      end
     end
-  end
 
-  module ::Process
-    class << self
-      prepend ForkInterceptor
+    module ::Process
+      class << self
+        prepend ForkInterceptor
+      end
     end
   end