debug 1.0.0.alpha0 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58f91a1d4079133e3e7590329d65b7b811490f7158ef96d7b3f826968bc3ad1f
-  data.tar.gz: 4da17de6911dc4506cb869298d84df46de08121aca704bb9e2643f774015fbb3
+  metadata.gz: c921a03e7629b04e9629e77c5c6dac3adfa4acb33f4f72d325315a358d07058c
+  data.tar.gz: eac06881f18621e16ac00f7ce628ff64c5aa7b60d99b725cdc30528e4c41b399
 SHA512:
-  metadata.gz: baa1a1708b02b63f47d7d751ce9e5830edcdc690c8ca84c956f0e4ce839db5f3f63cf22e856ad4cec43190bb7401b8dcfd13a3d55de72d0a438520a3fab394bc
-  data.tar.gz: 3816a302b56757b55501950ff2814e21d978a5cdf58a4431d663bd1dfbdaae1c7652e0a9565e4401201b29119cdfaa35f47986eee1b17b0b60c1759ec21f3e6a
+  metadata.gz: 299218c5bbfa513df144365e8172ae270a681b3e8e0ab6b7953834d99454947c1a31ce2f6f9aa85b3ae798ac501ea8e4f8892deabf96ca835cb35112fd26a54b
+  data.tar.gz: cac005fa02d12e187f586b2718d27d0c1463d03219a050102c9767540692cd609666cd6ea65db83a3bda54471c4a5ff10f06e1305b8ec013d5735b2633a2eebe

data/README.md

@@ -2,16 +2,12 @@
 
 ## How to install
 
-This is temporary installation guide until gemify.
-
 ```
-$ git clone https://github.com/ko1/debug.git
-$ gem install debug_inspector
-$ gem install iseq_collector
-$ export RUBYOPT=-I`pwd`/debug/lib
-# or add "-I`pwd`/debug/lib" for the following command
+$ gem install debug
 ```
 
+or specify `-Ipath/to/debug/lib` in `RUBYOPT` or each ruby command-line options for development.
+
 # How to use
 
 ## Invoke with debugger
@@ -19,7 +15,7 @@ $ export RUBYOPT=-I`pwd`/debug/lib
 ### REPL debug
 
 ```
-$ ruby -r debug target.rb
+$ ruby -r debug/repl target.rb
 ```
 
 and you can see the debugger prompt. The program was suspended at the beggining of target.rb. To continue the program, type `c` (or `continue`). See other debug commands below.

data/lib/debug.rb

@@ -1,15 +1 @@
 require_relative 'debug/repl'
-
-# default break points
-DEBUGGER__.add_catch_breakpoint 'RuntimeError'
-class Binding
-  DEBUGGER__.add_line_breakpoint __FILE__, __LINE__ + 1
-  def bp; nil; end
-end
-
-if $0 == __FILE__
-  # DEBUGGER__.add_line_breakpoint __dir__ + '/target.rb', 1
-  # load __dir__ + '/target.rb'
-else
-  DEBUGGER__.add_line_breakpoint $0, 1
-end

data/lib/debug/breakpoint.rb

@@ -1,97 +1,97 @@
-module DEBUGGER__
-  class LineBreakpoint
-    attr_reader :path, :line, :key
-
-    def initialize type, iseq, line, cond = nil, oneshot: false
-      @iseq = iseq
-      @path = iseq.path
-      @line = line
-      @type = type
-      @cond = cond
-      @oneshot = oneshot
-      @key = [@path, @line].freeze
-      setup
-      enable
-    end
-
-    def safe_eval b, expr
-      b.eval(expr)
-    rescue Exception => e
-      puts "[EVAL ERROR]"
-      puts "  expr: #{expr}"
-      puts "  err: #{e} (#{e.class})"
-      nil
-    end
-
-    def setup
-      if !@cond
-        @tp = TracePoint.new(@type) do |tp|
-          tp.disable if @oneshot
-          ThreadClient.current.on_breakpoint tp
-        end
-      else
-        @tp = TracePoint.new(@type) do |tp|
-          next unless safe_eval tp.binding, @cond
-          tp.disable if @oneshot
-          ThreadClient.current.on_breakpoint tp
-        end
-      end
-    end
-
-    def enable
-      if @type == :line
-        @tp.enable(target: @iseq, target_line: @line)
-      else
-        @tp.enable(target: @iseq)
-      end
-    rescue ArgumentError
-      puts @iseq.disasm # for debug
-      raise
-    end
-
-    def disable
-      @tp.disable
-    end
-
-    def to_s
-      "line bp #{@iseq.absolute_path}:#{@line} (#{@type})" +
-        if @cond
-          "if #{@cond}"
-        else
-          ""
-        end
-    end
-
-    def inspect
-      "<#{self.class.name} #{self.to_s}>"
-    end
-  end
-
-  class CatchBreakpoint
-    attr_reader :key
-
-    def initialize pat
-      @pat = pat
-      @tp = TracePoint.new(:raise){|tp|
-        exc = tp.raised_exception
-        exc.class.ancestors.each{|cls|
-          if pat === cls.name
-            puts "catch #{exc.class.inspect} by #{@pat.inspect}"
-            ThreadClient.current.on_suspend :catch
-          end
-        }
-      }
-      @tp.enable
-
-      @key = pat.freeze
-    end
-
-    def disable
-      @tp.disable
-    end
-
-    def to_s
-      "catch bp #{@pat.inspect}"
-    end
-  end
-end
+module DEBUGGER__
+  class LineBreakpoint
+    attr_reader :path, :line, :key
+
+    def initialize type, iseq, line, cond = nil, oneshot: false
+      @iseq = iseq
+      @path = iseq.path
+      @line = line
+      @type = type
+      @cond = cond
+      @oneshot = oneshot
+      @key = [@path, @line].freeze
+      setup
+      enable
+    end
+
+    def safe_eval b, expr
+      b.eval(expr)
+    rescue Exception => e
+      puts "[EVAL ERROR]"
+      puts "  expr: #{expr}"
+      puts "  err: #{e} (#{e.class})"
+      nil
+    end
+
+    def setup
+      if !@cond
+        @tp = TracePoint.new(@type) do |tp|
+          tp.disable if @oneshot
+          ThreadClient.current.on_breakpoint tp
+        end
+      else
+        @tp = TracePoint.new(@type) do |tp|
+          next unless safe_eval tp.binding, @cond
+          tp.disable if @oneshot
+          ThreadClient.current.on_breakpoint tp
+        end
+      end
+    end
+
+    def enable
+      if @type == :line
+        @tp.enable(target: @iseq, target_line: @line)
+      else
+        @tp.enable(target: @iseq)
+      end
+    rescue ArgumentError
+      puts @iseq.disasm # for debug
+      raise
+    end
+
+    def disable
+      @tp.disable
+    end
+
+    def to_s
+      "line bp #{@iseq.absolute_path}:#{@line} (#{@type})" +
+        if @cond
+          "if #{@cond}"
+        else
+          ""
+        end
+    end
+
+    def inspect
+      "<#{self.class.name} #{self.to_s}>"
+    end
+  end
+
+  class CatchBreakpoint
+    attr_reader :key
+
+    def initialize pat
+      @pat = pat
+      @tp = TracePoint.new(:raise){|tp|
+        exc = tp.raised_exception
+        exc.class.ancestors.each{|cls|
+          if pat === cls.name
+            puts "catch #{exc.class.inspect} by #{@pat.inspect}"
+            ThreadClient.current.on_suspend :catch
+          end
+        }
+      }
+      @tp.enable
+
+      @key = pat.freeze
+    end
+
+    def disable
+      @tp.disable
+    end
+
+    def to_s
+      "catch bp #{@pat.inspect}"
+    end
+  end
+end

data/lib/debug/client.rb

@@ -1,135 +1,135 @@
-require 'socket'
-require_relative 'config'
-
-module DEBUGGER__
-  class Client
-    begin
-      require 'readline'
-      def readline
-        Readline.readline("\n(rdb) ", true)
-      end
-    rescue LoadError
-      def readline
-        print "\n(rdb) "
-        gets
-      end
-    end
-
-    def help
-      puts "-run -e attach       # connect via UNIX Domain socket"
-      puts "-run -e attach name  # connect via UNIX Domain socket with specified name"
-      puts "-run -e attach port_num  # connect via TCP/IP socket with specified port"
-      puts "-run -e attach host port_num"
-      puts "               # connect via TCP/IP socket with specified host and port"
-    end
-
-    def initialize argv
-      case argv.size
-      when 0
-        connect_unix
-      when 1
-        case arg = argv.shift
-        when /-h/, /--help/
-          help
-          exit
-        when /\A\d+\z/
-          connect_tcp nil, arg.to_i
-        else
-          connect_unix arg
-        end
-      when 2
-        connect_tcp argv[0], argv[1]
-      else
-        help
-        exit!
-      end
-    end
-
-    def cleanup_unix_domain_sockets
-      Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*') do |file|
-        if /(\d+)$/ =~ file
-          begin
-            Process.kill(0, $1.to_i)
-          rescue Errno::ESRCH
-            File.unlink(file)
-          end
-        end
-      end
-    end
-
-    def connect_unix name = nil
-      if name
-        if File.exist? name
-          @s = Socket.unix(name)
-        else
-          @s = Socket.unix(File.join(DEBUGGER__.unix_domain_socket_basedir, name))
-        end
-      else
-        cleanup_unix_domain_sockets
-        files = Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
-        case files.size
-        when 0
-          $stderr.puts "There is no debug sessions."
-          exit
-        when 1
-          @s = Socket.unix(files.first)
-        else
-          $stderr.puts "Please select a debug session:"
-          files.each{|f|
-            $stderr.puts "  #{File.basename(f)}"
-          }
-          exit
-        end
-      end
-    end
-
-    def connect_tcp host, port
-      @s = Socket.tcp(host, port)
-    end
-
-    def connect
-      trap(:SIGINT){
-        @s.puts "pause"
-      }
-
-      while line = @s.gets
-        # p line: line
-        case line
-        when /^out (.*)/
-          puts "#{$1}"
-        when /^input/
-          prev_trap = trap(:SIGINT, 'DEFAULT')
-
-          begin
-            line = readline
-          rescue Interrupt
-            retry
-          ensure
-            trap(:SIGINT, prev_trap)
-          end
-
-          line = (line || 'quit').strip
-          @s.puts "command #{line}"
-        when /^ask (.*)/
-          print $1
-          @s.puts "answer #{gets || ''}"
-        when /^quit/
-          raise 'quit'
-        else
-          puts "(unknown) #{line.inspect}"
-        end
-      end
-    rescue
-      STDERR.puts "disconnected (#{$!})"
-      exit
-    end
-  end
-end
-
-def connect argv = ARGV
-  DEBUGGER__::Client.new(argv).connect
-end
-
-if __FILE__ == $0
-  connect
-end
+require 'socket'
+require_relative 'config'
+
+module DEBUGGER__
+  class Client
+    begin
+      require 'readline'
+      def readline
+        Readline.readline("\n(rdb) ", true)
+      end
+    rescue LoadError
+      def readline
+        print "\n(rdb) "
+        gets
+      end
+    end
+
+    def help
+      puts "-run -e attach       # connect via UNIX Domain socket"
+      puts "-run -e attach name  # connect via UNIX Domain socket with specified name"
+      puts "-run -e attach port_num  # connect via TCP/IP socket with specified port"
+      puts "-run -e attach host port_num"
+      puts "               # connect via TCP/IP socket with specified host and port"
+    end
+
+    def initialize argv
+      case argv.size
+      when 0
+        connect_unix
+      when 1
+        case arg = argv.shift
+        when /-h/, /--help/
+          help
+          exit
+        when /\A\d+\z/
+          connect_tcp nil, arg.to_i
+        else
+          connect_unix arg
+        end
+      when 2
+        connect_tcp argv[0], argv[1]
+      else
+        help
+        exit!
+      end
+    end
+
+    def cleanup_unix_domain_sockets
+      Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*') do |file|
+        if /(\d+)$/ =~ file
+          begin
+            Process.kill(0, $1.to_i)
+          rescue Errno::ESRCH
+            File.unlink(file)
+          end
+        end
+      end
+    end
+
+    def connect_unix name = nil
+      if name
+        if File.exist? name
+          @s = Socket.unix(name)
+        else
+          @s = Socket.unix(File.join(DEBUGGER__.unix_domain_socket_basedir, name))
+        end
+      else
+        cleanup_unix_domain_sockets
+        files = Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
+        case files.size
+        when 0
+          $stderr.puts "There is no debug sessions."
+          exit
+        when 1
+          @s = Socket.unix(files.first)
+        else
+          $stderr.puts "Please select a debug session:"
+          files.each{|f|
+            $stderr.puts "  #{File.basename(f)}"
+          }
+          exit
+        end
+      end
+    end
+
+    def connect_tcp host, port
+      @s = Socket.tcp(host, port)
+    end
+
+    def connect
+      trap(:SIGINT){
+        @s.puts "pause"
+      }
+
+      while line = @s.gets
+        # p line: line
+        case line
+        when /^out (.*)/
+          puts "#{$1}"
+        when /^input/
+          prev_trap = trap(:SIGINT, 'DEFAULT')
+
+          begin
+            line = readline
+          rescue Interrupt
+            retry
+          ensure
+            trap(:SIGINT, prev_trap)
+          end
+
+          line = (line || 'quit').strip
+          @s.puts "command #{line}"
+        when /^ask (.*)/
+          print $1
+          @s.puts "answer #{gets || ''}"
+        when /^quit/
+          raise 'quit'
+        else
+          puts "(unknown) #{line.inspect}"
+        end
+      end
+    rescue
+      STDERR.puts "disconnected (#{$!})"
+      exit
+    end
+  end
+end
+
+def connect argv = ARGV
+  DEBUGGER__::Client.new(argv).connect
+end
+
+if __FILE__ == $0
+  connect
+end

data/lib/debug/config.rb

@@ -1,26 +1,26 @@
-module DEBUGGER__
-  def self.unix_domain_socket_basedir
-    case
-    when path = ENV['RUBY_DEBUG_SOCK_DIR']
-    when path = ENV['XDG_RUNTIME_DIR']
-    when home = ENV['HOME']
-      path = File.join(home, '.ruby-debug-sock')
-      unless File.exist?(path)
-        Dir.mkdir(path, 0700)
-      end
-    else
-      raise 'specify RUBY_DEBUG_SOCK_DIR environment variable for UNIX domain socket directory.'
-    end
-
-    path
-  end
-
-  def self.create_unix_domain_socket_name_prefix
-    user = ENV['USER'] || 'ruby-debug'
-    File.join(unix_domain_socket_basedir, "ruby-debug-#{user}")
-  end
-
-  def self.create_unix_domain_socket_name
-    create_unix_domain_socket_name_prefix + "-#{Process.pid}"
-  end
-end
+module DEBUGGER__
+  def self.unix_domain_socket_basedir
+    case
+    when path = ENV['RUBY_DEBUG_SOCK_DIR']
+    when path = ENV['XDG_RUNTIME_DIR']
+    when home = ENV['HOME']
+      path = File.join(home, '.ruby-debug-sock')
+      unless File.exist?(path)
+        Dir.mkdir(path, 0700)
+      end
+    else
+      raise 'specify RUBY_DEBUG_SOCK_DIR environment variable for UNIX domain socket directory.'
+    end
+
+    path
+  end
+
+  def self.create_unix_domain_socket_name_prefix
+    user = ENV['USER'] || 'ruby-debug'
+    File.join(unix_domain_socket_basedir, "ruby-debug-#{user}")
+  end
+
+  def self.create_unix_domain_socket_name
+    create_unix_domain_socket_name_prefix + "-#{Process.pid}"
+  end
+end

data/lib/debug/repl.rb

@@ -59,9 +59,11 @@ module DEBUGGER__
     end
   end
 
-  SESSION = Session.new(UI_Repl.new)
+  initialize_session UI_Repl.new
 
   PREV_HANDLER = trap(:SIGINT){
     ThreadClient.current.on_trap
   }
+
+  DEBUGGER__.add_line_breakpoint $0, 1
 end

data/lib/debug/server.rb

@@ -105,7 +105,7 @@ module DEBUGGER__
     end
 
     def pause
-      $stderr.puts "DEBUG: pause request"
+      # $stderr.puts "DEBUG: pause request"
       Process.kill(:SIGINT, Process.pid)
     end
 

data/lib/debug/session.rb

@@ -82,12 +82,11 @@ module DEBUGGER__
       end
 
       @management_threads = [@session_server]
+      @management_threads << @ui.reader_thread if @ui.respond_to? :reader_thread
 
       setup_threads
     end
 
-    attr_reader :management_threads
-
     def source path
       @sr.get(path)
     end
@@ -595,4 +594,18 @@ module DEBUGGER__
   def self.add_catch_breakpoint pat
     ::DEBUGGER__::SESSION.add_catch_breakpoint pat
   end
+
+  class << self
+    define_method :initialize_session do |ui|
+      ::DEBUGGER__.const_set(:SESSION, Session.new(ui))
+
+      # default breakpoints
+      ::DEBUGGER__.add_catch_breakpoint 'RuntimeError'
+
+      Binding.module_eval do
+        ::DEBUGGER__.add_line_breakpoint __FILE__, __LINE__ + 1
+        def bp; nil; end
+      end
+    end
+  end
 end

data/lib/debug/tcpserver.rb

@@ -18,6 +18,5 @@ module DEBUGGER__
     end
   end
 
-  SESSION = Session.new(s = UI_TcpServer.new)
-  SESSION.management_threads << s.reader_thread
+  initialize_session UI_TcpServer.new
 end

data/lib/debug/unixserver.rb

@@ -14,6 +14,5 @@ module DEBUGGER__
     end
   end
 
-  SESSION = Session.new(s = UI_UnixDomainServer.new)
-  SESSION.management_threads << s.reader_thread
+  initialize_session UI_UnixDomainServer.new
 end

data/lib/debug/version.rb

@@ -1,3 +1,3 @@
 module DEBUGGER__
-  VERSION = "1.0.0.alpha0"
+  VERSION = "1.0.0.alpha1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debug
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha0
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Koichi Sasada