debug 1.0.0.beta4 → 1.0.0.beta5

data/lib/debug/session.rb

@@ -1,8 +1,13 @@
 
+# skip to load debugger for bundle exec
+return if $0.end_with?('bin/bundle') && ARGV.first == 'exec'
+
+require_relative 'config'
 require_relative 'thread_client'
 require_relative 'source_repository'
 require_relative 'breakpoint'
-require_relative 'config'
+
+require 'json' if ENV['RUBY_DEBUG_TEST_MODE']
 
 class RubyVM::InstructionSequence
   def traceable_lines_norec lines
@@ -40,6 +45,10 @@ class RubyVM::InstructionSequence
   def last_line
     self.to_a[4][:code_location][2]
   end
+
+  def first_line
+    self.to_a[4][:code_location][0]
+  end
 end
 
 module DEBUGGER__
@@ -51,7 +60,7 @@ module DEBUGGER__
                 #   [file, line] => LineBreakpoint
                 #   "Error" => CatchBreakpoint
                 #   "Foo#bar" => MethodBreakpoint
-                #   [:watch, expr] => WatchExprBreakpoint
+                #   [:watch, ivar] => WatchIVarBreakpoint
                 #   [:check, expr] => CheckBreakpoint
       @th_clients = {} # {Thread => ThreadClient}
       @q_evt = Queue.new
@@ -60,76 +69,20 @@ module DEBUGGER__
       @tc_id = 0
       @initial_commands = []
 
+      @frame_map = {} # {id => [threadId, frame_depth]} for DAP
+      @var_map   = {1 => [:globals], } # {id => ...} for DAP
+      @src_map   = {} # {id => src}
+
       @tp_load_script = TracePoint.new(:script_compiled){|tp|
-        ThreadClient.current.on_load tp.instruction_sequence, tp.eval_script
+        unless @management_threads.include? Thread.current
+          ThreadClient.current.on_load tp.instruction_sequence, tp.eval_script
+        end
       }
       @tp_load_script.enable
 
       @session_server = Thread.new do
         Thread.current.abort_on_exception = true
-
-        while evt = @q_evt.pop
-          tc, output, ev, *ev_args = evt
-          output.each{|str| @ui.puts str}
-
-          case ev
-          when :load
-            iseq, src = ev_args
-            on_load iseq, src
-            tc << :continue
-          when :thread_begin
-            th = ev_args.shift
-            on_thread_begin th
-            tc << :continue
-          when :suspend
-            case ev_args.first
-            when :breakpoint
-              bp, i = bp_index ev_args[1]
-              if bp
-                @ui.puts "\nStop by \##{i} #{bp}"
-              end
-            when :trap
-              @ui.puts ''
-              @ui.puts "\nStop by #{ev_args[1]}"
-            end
-
-            if @displays.empty?
-              wait_command_loop tc
-            else
-              tc << [:eval, :display, @displays]
-            end
-          when :result
-            case ev_args.first
-            when :watch
-              bp = ev_args[1]
-              @bps[bp.key] = bp
-              show_bps bp
-            when :try_display
-              failed_results = ev_args[1]
-              if failed_results.size > 0
-                i, msg = failed_results.last
-                if i+1 == @displays.size
-                  @ui.puts "canceled: #{@displays.pop}"
-                end
-              end
-            when :method_breakpoint
-              bp = ev_args[1]
-              if bp
-                @bps[bp.key] = bp
-                show_bps bp
-              else
-                # can't make a bp
-              end
-            else
-              # ignore
-            end
-
-            wait_command_loop tc
-          end
-        end
-      ensure
-        @bps.each{|k, bp| bp.disable}
-        @th_clients.each{|th, thc| thc.close}
+        session_server_main
       end
 
       @management_threads = [@session_server]
@@ -138,11 +91,84 @@ module DEBUGGER__
       setup_threads
 
       @tp_thread_begin = TracePoint.new(:thread_begin){|tp|
-        ThreadClient.current.on_thread_begin Thread.current
+        unless @management_threads.include?(th = Thread.current)
+          ThreadClient.current.on_thread_begin th
+        end
       }
       @tp_thread_begin.enable
     end
 
+    def session_server_main
+      while evt = @q_evt.pop
+        # varible `@internal_info` is only used for test
+        tc, output, ev, @internal_info, *ev_args = evt
+        output.each{|str| @ui.puts str}
+
+        case ev
+        when :load
+          iseq, src = ev_args
+          on_load iseq, src
+          @ui.event :load
+          tc << :continue
+        when :thread_begin
+          th = ev_args.shift
+          on_thread_begin th
+          @ui.event :thread_begin, th
+          tc << :continue
+        when :suspend
+          case ev_args.first
+          when :breakpoint
+            bp, i = bp_index ev_args[1]
+            @ui.event :suspend_bp, i, bp
+          when :trap
+            @ui.event :suspend_trap, ev_args[1]
+          else
+            @ui.event :suspended
+          end
+
+          if @displays.empty?
+            wait_command_loop tc
+          else
+            tc << [:eval, :display, @displays]
+          end
+        when :result
+          case ev_args.first
+          when :watch
+            bp = ev_args[1]
+            @bps[bp.key] = bp
+            show_bps bp
+          when :try_display
+            failed_results = ev_args[1]
+            if failed_results.size > 0
+              i, _msg = failed_results.last
+              if i+1 == @displays.size
+                @ui.puts "canceled: #{@displays.pop}"
+              end
+            end
+          when :method_breakpoint
+            bp = ev_args[1]
+            if bp
+              @bps[bp.key] = bp
+              show_bps bp
+            else
+              # can't make a bp
+            end
+          else
+            # ignore
+          end
+
+          wait_command_loop tc
+
+        when :dap_result
+          dap_event ev_args # server.rb
+          wait_command_loop tc
+        end
+      end
+    ensure
+      @bps.each{|k, bp| bp.disable}
+      @th_clients.each{|th, thc| thc.close}
+    end
+
     def add_initial_commands cmds
       cmds.each{|c|
         c.gsub('#.*', '').strip!
@@ -150,11 +176,11 @@ module DEBUGGER__
       }
     end
 
-    def source path
+    def source iseq
       if CONFIG[:use_colorize]
-        @sr.get_colored(path)
+        @sr.get_colored(iseq)
       else
-        @sr.get(path)
+        @sr.get(iseq)
       end
     end
 
@@ -182,12 +208,24 @@ module DEBUGGER__
 
     def wait_command
       if @initial_commands.empty?
+        @ui.puts "INTERNAL_INFO: #{JSON.generate(@internal_info)}" if ENV['RUBY_DEBUG_TEST_MODE']
         line = @ui.readline
       else
         line = @initial_commands.shift.strip
         @ui.puts "(rdbg:init) #{line}"
       end
 
+      case line
+      when String
+        process_command line
+      when Hash
+        process_dap_request line # defined in server.rb
+      else
+        raise "unexpected input: #{line.inspect}"
+      end
+    end
+
+    def process_command line
       if line.empty?
         if @repl_prev_line
           line = @repl_prev_line
@@ -324,8 +362,8 @@ module DEBUGGER__
         end
         return :retry
 
-      # * `watch <expr>`
-      #   * Stop the execution when the result of `<expr>` is changed.
+      # * `watch @ivar`
+      #   * Stop the execution when the result of current scope's `@ivar` is changed.
       #   * Note that this feature is super slow.
       when 'wat', 'watch'
         if arg
@@ -407,7 +445,7 @@ module DEBUGGER__
       # * `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] th[read[s]]
+      # * `i[nfo] th[read[s]]`
       #   * Show all threads (same as `th[read]`).
       when 'i', 'info'
         case arg
@@ -461,9 +499,11 @@ module DEBUGGER__
         case arg
         when 'on'
           dir = __dir__
-          @tracer ||= TracePoint.new(){|tp|
+          @tracer ||= TracePoint.new(:call, :return, :b_call, :b_return, :line, :class, :end){|tp|
             next if File.dirname(tp.path) == dir
             next if tp.path == '<internal:trace_point>'
+            # Skip when `JSON.generate` is called during tests
+            next if tp.binding.eval('self').to_s == 'JSON' and ENV['RUBY_DEBUG_TEST_MODE']
             # next if tp.event != :line
             @ui.puts pretty_tp(tp)
           }
@@ -725,6 +765,8 @@ module DEBUGGER__
         case
         when th == Thread.current
           # ignore
+        when @management_threads.include?(th)
+          # ignore
         when @th_clients.has_key?(th)
           thcs << @th_clients[th]
         else
@@ -748,8 +790,13 @@ module DEBUGGER__
       end
     end
 
+    def managed_thread_clients
+      thcs, _unmanaged_ths = update_thread_list
+      thcs
+    end
+
     def thread_switch n
-      thcs, unmanaged_ths = update_thread_list
+      thcs, _unmanaged_ths = update_thread_list
 
       if tc = thcs[n]
         if tc.mode
@@ -867,12 +914,16 @@ module DEBUGGER__
     def resolve_path file
       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
+      case file
+      when '-e', '-'
+        return file
+      else
+        $LOAD_PATH.each do |lp|
+          libpath = File.join(lp, file)
+          return File.realpath(libpath)
+        rescue Errno::ENOENT
+          # next
+        end
       end
 
       raise
@@ -917,6 +968,29 @@ module DEBUGGER__
         end
       end
     end
+
+    def width
+      @ui.width
+    end
+
+    def check_forked
+      unless @session_server.status
+        # TODO: Support it
+        raise 'DEBUGGER: stop at forked process is not supported yet.'
+      end
+    end
+  end
+
+  class UI_Base
+    def event type, *args
+      case type
+      when :suspend_bp
+        i, bp = *args
+        puts "\nStop by \##{i} #{bp}" if bp
+      when :suspend_trap
+        puts "\nStop by #{args.first}"
+      end
+    end
   end
 
   # manual configuration methods
@@ -940,7 +1014,7 @@ module DEBUGGER__
       when dir_prefix
       when %r{rubygems/core_ext/kernel_require\.rb}
       else
-        return loc
+        return loc if loc.absolute_path
       end
     end
     nil
@@ -952,6 +1026,7 @@ module DEBUGGER__
     set_config(kw)
 
     require_relative 'console'
+
     initialize_session UI_Console.new
 
     @prev_handler = trap(:SIGINT){
@@ -992,8 +1067,15 @@ module DEBUGGER__
       # ::DEBUGGER__.add_catch_breakpoint 'RuntimeError'
 
       Binding.module_eval do
-        ::DEBUGGER__.add_line_breakpoint __FILE__, __LINE__ + 1
-        def bp; nil; end
+        def bp command: nil
+          if command
+            cmds = command.split(";;")
+            SESSION.add_initial_commands cmds
+          end
+
+          ::DEBUGGER__.add_line_breakpoint __FILE__, __LINE__ + 1, oneshot: true
+          true
+        end
       end
 
       if !::DEBUGGER__::CONFIG[:nonstop]
@@ -1018,13 +1100,15 @@ module DEBUGGER__
     }
 
     # debug commands file
-    [::DEBUGGER__::CONFIG[:init_script],
+    [init_script = ::DEBUGGER__::CONFIG[:init_script],
      './.rdbgrc',
      File.expand_path('~/.rdbgrc')].each{|path|
-      next unless path
+       next unless path
 
       if File.file? path
         ::DEBUGGER__::SESSION.add_initial_commands File.readlines(path)
+      elsif path == init_script
+        warn "Not found: #{path}"
       end
     }
 
@@ -1086,6 +1170,7 @@ module DEBUGGER__
   end
 
   class ::Module
+    undef method_added
     def method_added mid; end
     def singleton_method_added mid; end
   end
@@ -1099,4 +1184,14 @@ module DEBUGGER__
   end
 
   METHOD_ADDED_TRACKER = self.create_method_added_tracker
+
+  SHORT_INSPECT_LENGTH = 40
+  def self.short_inspect obj, use_short = true
+    str = obj.inspect
+    if use_short && str.length > SHORT_INSPECT_LENGTH
+      str[0...SHORT_INSPECT_LENGTH] + '...'
+    else
+      str
+    end
+  end
 end

data/lib/debug/source_repository.rb

@@ -1,55 +1,75 @@
-require 'irb/color' # IRB::Color.colorize_code
+require_relative 'color'
 
 module DEBUGGER__
   class SourceRepository
+    SrcInfo = Struct.new(:src, :colored)
+
     def initialize
-      @files = {} # filename => [src, iseq]
-      @color_files = {}
+      @files = {} # filename => SrcInfo
     end
 
     def add iseq, src
-      path = iseq.absolute_path
-      path = '-e' if iseq.path == '-e'
-      add_path path, src: src
+      if (path = iseq.absolute_path) && File.exist?(path)
+        add_path path
+      elsif src
+        add_iseq iseq, src
+      end
     end
 
-    def add_path path, src: nil
-      case
-      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
+    def all_iseq iseq, rs = []
+      rs << iseq
+      iseq.each_child{|ci|
+        all_iseq(ci, rs)
+      }
+      rs
+    end
+
+    private def add_iseq iseq, src
+      line = iseq.first_line
+      if line > 1
+        src = ("\n" * (line - 1)) + src
       end
+      si = SrcInfo.new(src.lines)
 
-      if src
+      all_iseq(iseq).each{|e|
+        e.instance_variable_set(:@debugger_si, si)
+        e.freeze
+      }
+    end
+
+    private def add_path path
+      begin
+        src = File.read(path)
         src = src.gsub("\r\n", "\n") # CRLF -> LF
-        @files[path] = src.lines
+        @files[path] = SrcInfo.new(src.lines)
+      rescue SystemCallError
       end
     end
 
-    def get path
-      if @files.has_key? path
+    private def get_si iseq
+      return unless iseq
+
+      if iseq.instance_variable_defined?(:@debugger_si)
+        iseq.instance_variable_get(:@debugger_si)
+      elsif @files.has_key?(path = iseq.absolute_path)
         @files[path]
-      else
-        add_path path
+      elsif path
+        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
+    def get iseq
+      if si = get_si(iseq)
+        si.src
+      end
+    end
+
+    include Color
+
+    def get_colored iseq
+      if si = get_si(iseq)
+        si.colored || begin
+          si.colored = colorize_code(si.src.join).lines
         end
       end
     end