debug 1.0.0.alpha1 → 1.0.0.beta5

data/lib/debug/client.rb

@@ -1,7 +1,14 @@
 require 'socket'
+require 'io/console/size'
+
 require_relative 'config'
+require_relative 'version'
+
+# $VERBOSE = true
 
 module DEBUGGER__
+  class CommandLineOptionError < Exception; end
+
   class Client
     begin
       require 'readline'
@@ -15,15 +22,9 @@ module DEBUGGER__
       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
+      return util(argv) if String === argv
+
       case argv.size
       when 0
         connect_unix
@@ -40,8 +41,24 @@ module DEBUGGER__
       when 2
         connect_tcp argv[0], argv[1]
       else
-        help
-        exit!
+        raise CommandLineOptionError
+      end
+
+      @width = IO.console_size[1]
+      @width_changed = false
+
+      send "version: #{VERSION} width: #{@width} cookie: #{CONFIG[:cookie]}"
+    end
+
+    def util name
+      case name
+      when 'gen-sockpath'
+        puts DEBUGGER__.create_unix_domain_socket_name
+      when 'list-socks'
+        cleanup_unix_domain_sockets
+        puts list_connections
+      else
+        raise "Unknown utility: #{name}"
       end
     end
 
@@ -57,19 +74,23 @@ module DEBUGGER__
       end
     end
 
+    def list_connections
+      Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
+    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))
+          @s = Socket.unix(File.join(DEBUGGER__.unix_domain_socket_dir, name))
         end
       else
         cleanup_unix_domain_sockets
-        files = Dir.glob(DEBUGGER__.create_unix_domain_socket_name_prefix + '*')
+        files = list_connections
         case files.size
         when 0
-          $stderr.puts "There is no debug sessions."
+          $stderr.puts "No debug session is available."
           exit
         when 1
           @s = Socket.unix(files.first)
@@ -87,13 +108,22 @@ module DEBUGGER__
       @s = Socket.tcp(host, port)
     end
 
+    def send msg
+      p send: msg if $VERBOSE
+      @s.puts msg
+    end
+
     def connect
       trap(:SIGINT){
-        @s.puts "pause"
+        send "pause"
+      }
+      trap(:SIGWINCH){
+        @width = IO.console_size[1]
+        @width_changed = true
       }
 
       while line = @s.gets
-        # p line: line
+        p recv: line if $VERBOSE
         case line
         when /^out (.*)/
           puts "#{$1}"
@@ -109,10 +139,16 @@ module DEBUGGER__
           end
 
           line = (line || 'quit').strip
-          @s.puts "command #{line}"
+
+          if @width_changed
+            @width_changed = false
+            send "width #{@width}"
+          end
+
+          send "command #{line}"
         when /^ask (.*)/
           print $1
-          @s.puts "answer #{gets || ''}"
+          send "answer #{gets || ''}"
         when /^quit/
           raise 'quit'
         else

data/lib/debug/color.rb

@@ -0,0 +1,70 @@
+begin
+  require 'irb/color'
+  require "irb/color_printer"
+rescue LoadError
+  warn "DEBUGGER: can not load newer irb for coloring. Write 'gem \"debug\" in your Gemfile."
+end
+
+module DEBUGGER__
+  module Color
+    if defined? IRB::Color.colorize
+      def colorize str, color
+        if CONFIG[:use_colorize]
+          IRB::Color.colorize str, color
+        else
+          str
+        end
+      end
+    else
+      def colorize str, color
+        str
+      end
+    end
+
+    if defined? IRB::ColorPrinter.pp
+      def color_pp obj
+        IRB::ColorPrinter.pp(obj, "")
+      end
+    else
+      def color_pp obj
+        obj.pretty_inspect
+      end
+    end
+
+    def colored_inspect obj
+      if CONFIG[:use_colorize]
+        color_pp obj
+      else
+        obj.pretty_inspect
+      end
+    rescue => ex
+      err_msg = "#{ex.inspect} rescued during inspection"
+      string_result = obj.to_s rescue nil
+
+      # don't colorize the string here because it's not from user's application
+      if string_result
+        %Q{"#{string_result}" from #to_s because #{err_msg}}
+      else
+        err_msg
+      end
+    end
+
+    if defined? IRB::Color.colorize_code
+      def colorize_code code
+        IRB::Color.colorize_code(code)
+      end
+    else
+      def colorize_code code
+        code
+      end
+    end
+
+    def colorize_cyan(str)
+      colorize(str, [:CYAN, :BOLD])
+    end
+
+    def colorize_blue(str)
+      colorize(str, [:BLUE, :BOLD])
+    end
+  end
+end

data/lib/debug/config.rb

@@ -1,12 +1,17 @@
+
 module DEBUGGER__
-  def self.unix_domain_socket_basedir
+  def self.unix_domain_socket_dir
     case
-    when path = ENV['RUBY_DEBUG_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')
-      unless File.exist?(path)
+
+      case
+      when !File.exist?(path)
         Dir.mkdir(path, 0700)
+      when !File.directory?(path)
+        raise "#{path} is not a directory."
       end
     else
       raise 'specify RUBY_DEBUG_SOCK_DIR environment variable for UNIX domain socket directory.'
@@ -15,12 +20,169 @@ module DEBUGGER__
     path
   end
 
-  def self.create_unix_domain_socket_name_prefix
+  def self.create_unix_domain_socket_name_prefix(base_dir = unix_domain_socket_dir)
     user = ENV['USER'] || 'ruby-debug'
-    File.join(unix_domain_socket_basedir, "ruby-debug-#{user}")
+    File.join(base_dir, "ruby-debug-#{user}")
+  end
+
+  def self.create_unix_domain_socket_name(base_dir = unix_domain_socket_dir)
+    create_unix_domain_socket_name_prefix(base_dir) + "-#{Process.pid}"
+  end
+
+  CONFIG_MAP = {
+    # boot setting
+    nonstop:     'RUBY_DEBUG_NONSTOP',     # Nonstop mode ('1' is nonstop)
+    init_script: 'RUBY_DEBUG_INIT_SCRIPT', # debug command script path loaded at first stop
+    commands:    'RUBY_DEBUG_COMMANDS',    # debug commands invoked at first stop. commands should be separated by ';;'
+
+    # UI setting
+    show_src_lines: 'RUBY_DEBUG_SHOW_SRC_LINES', # Show n lines source code on breakpoint (default: 10 lines).
+    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
+    cookie:      'RUBY_DEBUG_COOKIE',      # Cookie for negotiation
+  }.freeze
+
+  def self.config_to_env config
+    CONFIG_MAP.each{|key, evname|
+      ENV[evname] = config[key].to_s if config[key]
+    }
   end
 
-  def self.create_unix_domain_socket_name
-    create_unix_domain_socket_name_prefix + "-#{Process.pid}"
+  def self.parse_argv argv
+    config = {
+      mode: :start,
+      use_colorize: true,
+    }
+    CONFIG_MAP.each{|key, 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?
+
+    require 'optparse'
+    require_relative 'version'
+
+    opt = OptionParser.new do |o|
+      o.banner = "#{$0} [options] -- [debuggee options]"
+      o.separator ''
+      o.version = ::DEBUGGER__::VERSION
+
+      o.separator 'Debug console mode:'
+      o.on('-n', '--nonstop', 'Do not stop at the beginning of the script.') do
+        config[:nonstop] = '1'
+      end
+
+      o.on('-e COMMAND', 'execute debug command at the beginning of the script.') do |cmd|
+        config[:commands] ||= ''
+        config[:commands] << cmd + ';;'
+      end
+
+      o.on('-x FILE', '--init-script=FILE', 'execute debug command in the FILE.') do |file|
+        config[:init_script] = file
+      end
+
+      o.separator ''
+
+      o.on('-O', '--open', 'Start remote debugging with opening the network port.',
+                           'If TCP/IP options are not given,',
+                           '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
+      o.on('--host=HOST', 'Listening TCP/IP host') do |host|
+        config[:host] = host
+      end
+      o.on('--cookie=COOKIE', 'Set a cookie for connection') do |c|
+        config[:cookie] = c
+      end
+
+      rdbg = 'rdbg'
+
+      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 ''
+      o.separator 'Attach mode:'
+      o.on('-A', '--attach', 'Attach to debuggee process.') do
+        config[:mode] = :attach
+      end
+
+      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 host port' tries to connect to host:port via TCP/IP."
+
+      o.separator ''
+      o.separator 'Other options:'
+
+      o.on("-h", "--help", "Print help") do
+        puts o
+        exit
+      end
+
+      o.on('-c', '--command', 'Command mode (first argument is command name)') do
+        config[:command] = true
+      end
+
+      o.on('--util=NAME', 'Utility mode (used by tools)') do |name|
+        Client.new(name)
+        exit
+      end
+
+      o.separator ''
+      o.separator 'NOTE'
+      o.separator '  All messages communicated between a debugger and a debuggee are *NOT* encrypted.'
+      o.separator '  Please use the remote debugging feature carefully.'
+    end
+
+    opt.parse!(argv)
+
+    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/console.rb

@@ -0,0 +1,96 @@
+require_relative 'session'
+return unless defined?(DEBUGGER__)
+
+require 'io/console/size'
+
+module DEBUGGER__
+  class UI_Console < UI_Base
+    def initialize
+    end
+
+    def remote?
+      false
+    end
+
+    def width
+      IO.console_size[1]
+    end
+
+    def quit n
+      exit n
+    end
+
+    def ask prompt
+      setup_interrupt do
+        print prompt
+        (gets || '').strip
+      end
+    end
+
+    def puts str = nil
+      case str
+      when Array
+        str.each{|line|
+          $stdout.puts line.chomp
+        }
+      when String
+        str.each_line{|line|
+          $stdout.puts line.chomp
+        }
+      when nil
+        $stdout.puts
+      end
+    end
+
+    begin
+      require 'readline'
+
+      def readline_setup
+        Readline.completion_proc = proc{|given|
+          buff = Readline.line_buffer
+          Readline.completion_append_character= ' '
+
+          if /\s/ =~ buff # second parameters
+            given = File.expand_path(given + 'a').sub(/a\z/, '')
+            files = Dir.glob(given + '*')
+            if files.size == 1 && File.directory?(files.first)
+              Readline.completion_append_character= '/'
+            end
+            files
+          else
+            DEBUGGER__.commands.grep(/\A#{given}/)
+          end
+        }
+      end
+
+      def readline_body
+        readline_setup
+        Readline.readline("\n(rdbg) ", true)
+      end
+    rescue LoadError
+      def readline_body
+        print "\n(rdbg) "
+        gets
+      end
+    end
+
+    def readline
+      setup_interrupt do
+        (readline_body || 'quit').strip
+      end
+    end
+
+    def setup_interrupt
+      current_thread = Thread.current # should be session_server thread
+
+      prev_handler = trap(:INT){
+        current_thread.raise Interrupt
+      }
+
+      yield
+    ensure
+      trap(:INT, prev_handler)
+    end
+  end
+end
+