debug 1.4.0 → 1.5.0

data/lib/debug/source_repository.rb

@@ -4,72 +4,112 @@ require_relative 'color'
 
 module DEBUGGER__
   class SourceRepository
-    SrcInfo = Struct.new(:src, :colored)
+    include Color
 
-    def initialize
-      @files = {} # filename => SrcInfo
-    end
+    if RubyVM.respond_to? :keep_script_lines
+      # Ruby 3.1 and later
+      RubyVM.keep_script_lines = true
+      require 'objspace'
 
-    def add iseq, src
-      if (path = iseq.absolute_path) && File.exist?(path)
-        add_path path
-      elsif src
-        add_iseq iseq, src
+      def initialize
+        # cache
+        @cmap = ObjectSpace::WeakMap.new
       end
-    end
 
-    def all_iseq iseq, rs = []
-      rs << iseq
-      iseq.each_child{|ci|
-        all_iseq(ci, rs)
-      }
-      rs
-    end
+      def add iseq, src
+        # do nothing
+      end
+
+      def get iseq
+        return unless iseq
 
-    private def add_iseq iseq, src
-      line = iseq.first_line
-      if line > 1
-        src = ("\n" * (line - 1)) + src
+        if lines = iseq.script_lines&.map(&:chomp)
+          lines
+        else
+          if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
+            File.readlines(path, chomp: true)
+          else
+            nil
+          end
+        end
       end
-      si = SrcInfo.new(src.lines)
 
-      all_iseq(iseq).each{|e|
-        e.instance_variable_set(:@debugger_si, si)
-        e.freeze
-      }
-    end
+      def get_colored iseq
+        if lines = @cmap[iseq]
+          lines
+        else
+          if src_lines = get(iseq)
+            @cmap[iseq] = colorize_code(src_lines.join("\n")).lines
+          else
+            nil
+          end
+        end
+      end
+    else
+      # ruby 3.0 or earlier
+      SrcInfo = Struct.new(:src, :colored)
 
-    private def add_path path
-      src = File.read(path)
-      src = src.gsub("\r\n", "\n") # CRLF -> LF
-      @files[path] = SrcInfo.new(src.lines)
-    rescue SystemCallError
-    end
+      def initialize
+        @files = {} # filename => SrcInfo
+      end
 
-    private def get_si iseq
-      return unless iseq
+      def add iseq, src
+        if (path = (iseq.absolute_path || iseq.path)) && File.exist?(path)
+          add_path path
+        elsif src
+          add_iseq iseq, src
+        end
+      end
 
-      if iseq.instance_variable_defined?(:@debugger_si)
-        iseq.instance_variable_get(:@debugger_si)
-      elsif @files.has_key?(path = iseq.absolute_path)
-        @files[path]
-      elsif path
-        add_path(path)
+      private def all_iseq iseq, rs = []
+        rs << iseq
+        iseq.each_child{|ci|
+          all_iseq(ci, rs)
+        }
+        rs
       end
-    end
 
-    def get iseq
-      if si = get_si(iseq)
-        si.src
+      private def add_iseq iseq, src
+        line = iseq.first_line
+        if line > 1
+          src = ("\n" * (line - 1)) + src
+        end
+        si = SrcInfo.new(src.lines)
+        all_iseq(iseq).each{|e|
+          e.instance_variable_set(:@debugger_si, si)
+          e.freeze
+        }
       end
-    end
 
-    include Color
+      private def add_path path
+        src_lines = File.readlines(path, chomp: true)
+        @files[path] = SrcInfo.new(src_lines)
+      rescue SystemCallError
+      end
+
+      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 || iseq.path))
+          @files[path]
+        elsif path
+          add_path(path)
+        end
+      end
+
+      def get iseq
+        if si = get_si(iseq)
+          si.src
+        end
+      end
 
-    def get_colored iseq
-      if si = get_si(iseq)
-        si.colored || begin
-          si.colored = colorize_code(si.src.join).lines
+      def get_colored iseq
+        if si = get_si(iseq)
+          si.colored || begin
+            si.colored = colorize_code(si.src.join("\n")).lines
+          end
         end
       end
     end

data/lib/debug/thread_client.rb

@@ -8,7 +8,11 @@ require_relative 'color'
 module DEBUGGER__
   module SkipPathHelper
     def skip_path?(path)
-      (skip_paths = CONFIG[:skip_path]) && skip_paths.any?{|skip_path| path.match?(skip_path)}
+      !path || skip_internal_path?(path) || (skip_paths = CONFIG[:skip_path]) && skip_paths.any?{|skip_path| path.match?(skip_path)}
+    end
+
+    def skip_internal_path?(path)
+      path.start_with?(__dir__) || path.start_with?('<internal:')
     end
 
     def skip_location?(loc)
@@ -30,7 +34,11 @@ module DEBUGGER__
     include Color
     include SkipPathHelper
 
-    attr_reader :location, :thread, :id, :recorder
+    attr_reader :thread, :id, :recorder
+
+    def location
+      current_frame&.location
+    end
 
     def assemble_arguments(args)
       args.map do |arg|
@@ -149,14 +157,7 @@ module DEBUGGER__
     end
 
     def to_s
-      loc = current_frame&.location
-
-      if loc
-        str = "(#{@thread.name || @thread.status})@#{loc}"
-      else
-        str = "(#{@thread.name || @thread.status})@#{@thread.to_s}"
-      end
-
+      str = "(#{@thread.name || @thread.status})@#{current_frame&.location || @thread.to_s}"
       str += " (not under control)" unless self.waiting?
       str
     end
@@ -246,7 +247,6 @@ module DEBUGGER__
 
       cf = @target_frames.first
       if cf
-        @location = cf.location
         case event
         when :return, :b_return, :c_return
           cf.has_return_value = true
@@ -339,9 +339,45 @@ module DEBUGGER__
 
     ## cmd helpers
 
-    # this method is extracted to hide frame_eval's local variables from C method eval's binding
-    def instance_eval_for_cmethod frame_self, src
-      frame_self.instance_eval(src)
+    if TracePoint.respond_to? :allow_reentry
+      def tp_allow_reentry
+        TracePoint.allow_reentry do
+          yield
+        end
+      rescue RuntimeError => e
+        # on the postmortem mode, it is not stopped in TracePoint
+        if e.message == 'No need to allow reentrance.'
+          yield
+        else
+          raise
+        end
+      end
+    else
+      def tp_allow_reentry
+        yield
+      end
+    end
+
+    def frame_eval_core src, b
+      saved_target_frames = @target_frames
+      saved_current_frame_index = @current_frame_index
+
+      if b
+        f, _l = b.source_location
+
+        tp_allow_reentry do
+          b.eval(src, "(rdbg)/#{f}")
+        end
+      else
+        frame_self = current_frame.self
+
+        tp_allow_reentry do
+          frame_self.instance_eval(src)
+        end
+      end
+    ensure
+      @target_frames = saved_target_frames
+      @current_frame_index = saved_current_frame_index
     end
 
     SPECIAL_LOCAL_VARS = [
@@ -358,16 +394,13 @@ module DEBUGGER__
         b.local_variable_set(name, var) if /\%/ !~ name
       end
 
-      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
+      result = frame_eval_core(src, b)
+
       @success_last_eval = true
       result
 
+    rescue SystemExit
+      raise
     rescue Exception => e
       return yield(e) if block_given?
 
@@ -432,13 +465,36 @@ module DEBUGGER__
     end
 
     def current_frame
+      get_frame(@current_frame_index)
+    end
+
+    def get_frame(index)
       if @target_frames
-        @target_frames[@current_frame_index]
+        @target_frames[index]
       else
         nil
       end
     end
 
+    def collect_locals(frame)
+      locals = []
+
+      if s = frame&.self
+        locals << ["%self", s]
+      end
+      special_local_variables frame do |name, val|
+        locals << [name, val]
+      end
+
+      if vars = frame&.local_variables
+        vars.each{|var, val|
+          locals << [var, val]
+        }
+      end
+
+      locals
+    end
+
     ## cmd: show
 
     def special_local_variables frame
@@ -450,17 +506,8 @@ module DEBUGGER__
     end
 
     def show_locals pat
-      if s = current_frame&.self
-        puts_variable_info '%self', s, pat
-      end
-      special_local_variables current_frame do |name, val|
-        puts_variable_info name, val, pat
-      end
-
-      if vars = current_frame&.local_variables
-        vars.each{|var, val|
-          puts_variable_info var, val, pat
-        }
+      collect_locals(current_frame).each do |var, val|
+        puts_variable_info(var, val, pat)
       end
     end
 
@@ -526,28 +573,32 @@ module DEBUGGER__
       w = SESSION::width
 
       if mono_info.length >= w
-        info = truncate(mono_info, width: w)
+        maximum_value_width = w - "#{label} = ".length
+        valstr = truncate(inspected, width: maximum_value_width)
       else
         valstr = colored_inspect(obj, width: 2 ** 30)
         valstr = inspected if valstr.lines.size > 1
-        info = "#{colorize_cyan(label)} = #{valstr}"
       end
 
+      info = "#{colorize_cyan(label)} = #{valstr}"
+
       puts info
     end
 
     def truncate(string, width:)
-      str = string[0 .. (width-4)] + '...'
-      str += ">" if str.start_with?("#<")
-      str
+      if string.start_with?("#<")
+        string[0 .. (width-5)] + '...>'
+      else
+        string[0 .. (width-4)] + '...'
+      end
     end
 
     ### cmd: show edit
 
     def show_by_editor path = nil
       unless path
-        if @target_frames && frame = @target_frames[@current_frame_index]
-          path = frame.path
+        if current_frame
+          path = current_frame.path
         else
           return # can't get path
         end
@@ -853,6 +904,7 @@ module DEBUGGER__
           else
             raise "unsupported frame operation: #{arg.inspect}"
           end
+
           event! :result, nil
 
         when :show
@@ -1001,8 +1053,8 @@ module DEBUGGER__
 
         @tp_recorder ||= TracePoint.new(:line){|tp|
           next unless Thread.current == thread
-          next if tp.path.start_with? __dir__
-          next if tp.path.start_with? '<internal:'
+          # can't be replaced by skip_location
+          next if skip_internal_path?(tp.path)
           loc = caller_locations(1, 1).first
           next if skip_location?(loc)
 

data/lib/debug/tracer.rb

@@ -66,15 +66,7 @@ module DEBUGGER__
     end
 
     def skip? tp
-      if tp.path.start_with?(__dir__) ||
-         tp.path.start_with?('<internal:') ||
-         ThreadClient.current.management? ||
-         skip_path?(tp.path) ||
-         skip_with_pattern?(tp)
-        true
-      else
-        false
-      end
+      ThreadClient.current.management? || skip_path?(tp.path) || skip_with_pattern?(tp)
     end
 
     def skip_with_pattern?(tp)
@@ -89,11 +81,13 @@ module DEBUGGER__
         ThreadClient.current.on_trace self.object_id, buff
       else
         @output.puts buff
+        @output.flush
       end
     end
 
     def puts msg
       @output.puts msg
+      @output.flush
     end
 
     def minfo tp

data/lib/debug/version.rb

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

data/misc/README.md.erb

@@ -1,8 +1,8 @@
-[![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)
+[![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) [![Protocol](https://github.com/ruby/debug/actions/workflows/protocol.yml/badge.svg)](https://github.com/ruby/debug/actions/workflows/protocol.yml)
 
 # debug.rb
 
-This library provides debugging functionality to Ruby.
+This library provides debugging functionality to Ruby (MRI) 2.6 and later.
 
 This debug.rb is replacement of traditional lib/debug.rb standard library which is implemented by `set_trace_func`.
 New debug.rb has several advantages:
@@ -113,7 +113,7 @@ d => nil
       5| binding.break
       6| c = 3
       7| d = 4
-=>    8| binding.break                 # Again the program stops at here
+=>    8| binding.break                 # Again the program stops here
       9| p [a, b, c, d]
      10|
      11| __END__
@@ -358,6 +358,8 @@ Also `open` command allows opening the debug port.
 
 #### VSCode integration
 
+([vscode-rdbg v0.0.9](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) or later is required)
+
 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).
@@ -417,7 +419,7 @@ Note that you can attach with `rdbg --attach` and continue REPL debugging.
 
 #### Chrome DevTool integration
 
-With `rdbg --open=chrome` command will shows the following message.
+With `rdbg --open=chrome` command will show the following message.
 
 ```
 $ rdbg target.rb --open=chrome
@@ -435,8 +437,6 @@ 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/).
 
-Note: If you want to maximize Chrome DevTools, click [Toggle Device Toolbar](https://developer.chrome.com/docs/devtools/device-mode/#viewport).
-
 ## Configuration
 
 You can configure the debugger's behavior with debug commands and environment variables.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Koichi Sasada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.7
 description: Debugging functionality for Ruby. This is completely rewritten debug.rb
-  which was contained by the encient Ruby versions.
+  which was contained by the ancient Ruby versions.
 email:
 - ko1@atdot.net
 executables:
@@ -48,21 +48,12 @@ extensions:
 - ext/debug/extconf.rb
 extra_rdoc_files: []
 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
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - TODO.md
-- bin/console
-- bin/gentest
-- bin/setup
 - debug.gemspec
 - exe/rdbg
 - ext/debug/debug.c
@@ -112,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.0.dev
 signing_key: 
 specification_version: 4
 summary: Debugging functionality for Ruby

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,24 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Your environment**
-
-* `ruby -v`: 
-* `rdbg -v`:
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Additional context**
-Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/custom.md

@@ -1,10 +0,0 @@
----
-name: Custom issue template
-about: Blank issue
-title: ''
-labels: ''
-assignees: ''
-
----
-
-

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,14 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Your proposal**
-What is your idea?
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -1,9 +0,0 @@
-Thanks for your Pull Request 🎉 
-
-**Please follow these instructions to help us review it more efficiently:**
-
-- Add references of related issues/PRs in the description if available.
-- If you're updating the readme file, make sure you followed [the instruction here](https://github.com/ruby/debug/blob/master/CONTRIBUTING.md#to-update-readme).
-
-## Description
-Describe your changes:

data/.github/workflows/ruby.yml

@@ -1,34 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0', 'head', 'debug']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-/Gemfile.lock
-/lib/debug/debug.so
-.ruby-version

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "debug"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)