debug 1.4.0 → 1.6.1

data/lib/debug/console.rb

@@ -30,6 +30,18 @@ module DEBUGGER__
         prepend m
       end if SIGWINCH_SUPPORTED
 
+      def parse_input buff, commands
+        c, rest = get_command buff
+        case
+        when commands.keys.include?(c)
+          :command
+        when !rest && /\A\s*[a-z]*\z/ =~ c
+          nil
+        else
+          :ruby
+        end
+      end
+
       def readline_setup prompt
         load_history_if_not_loaded
         commands = DEBUGGER__.commands
@@ -38,7 +50,17 @@ module DEBUGGER__
         prev_output_modifier_proc = Reline.output_modifier_proc
         prev_prompt_proc = Reline.prompt_proc
 
-        Reline.prompt_proc = nil
+        # prompt state
+        state = nil # :command, :ruby, nil (unknown)
+
+        Reline.prompt_proc = -> args, *kw do
+          case state = parse_input(args.first, commands)
+          when nil, :command
+            [prompt, prompt]
+          when :ruby
+            [prompt.sub('rdbg'){colorize('ruby', [:RED])}] * 2
+          end
+        end
 
         Reline.completion_proc = -> given do
           buff = Reline.line_buffer
@@ -52,17 +74,16 @@ module DEBUGGER__
             end
             files
           else
-            commands.keys.grep(/\A#{given}/)
+            commands.keys.grep(/\A#{Regexp.escape(given)}/)
           end
         end
 
         Reline.output_modifier_proc = -> buff, **kw do
           c, rest = get_command buff
 
-          case
-          when commands.keys.include?(c = c.strip)
-            # [:DIM, :CYAN, :BLUE, :CLEAR, :UNDERLINE, :REVERSE, :RED, :GREEN, :MAGENTA, :BOLD, :YELLOW]
-            cmd = colorize(c.strip, [:CYAN, :UNDERLINE])
+          case state
+          when :command
+            cmd = colorize(c, [:CYAN, :UNDERLINE])
 
             if commands[c] == c
               rprompt = colorize("    # command", [:DIM])
@@ -70,14 +91,14 @@ module DEBUGGER__
               rprompt = colorize("    # #{commands[c]} command", [:DIM])
             end
 
-            rest = (rest ? colorize_code(rest) : '') + rprompt
-            cmd + rest
-          when !rest && /\A\s*[a-z]*\z/ =~ c
+            rest = rest ? colorize_code(rest) : ''
+            cmd + rest + rprompt
+          when nil
             buff
-          else
-            colorize_code(buff.chomp) + colorize("    # ruby", [:DIM])
+          when :ruby
+            colorize_code(buff.chomp)
           end
-        end
+        end unless CONFIG[:no_hint]
 
         yield
 
@@ -90,9 +111,9 @@ module DEBUGGER__
       private def get_command line
         case line.chomp
         when /\A(\s*[a-z]+)(\s.*)?\z$/
-          return $1, $2
+          return $1.strip, $2
         else
-          line.chomp
+          line.strip
         end
       end
 
@@ -153,7 +174,13 @@ module DEBUGGER__
     end
 
     def history_file
-      CONFIG[:history_file] || File.expand_path("~/.rdbg_history")
+      history_file = CONFIG[:history_file]
+
+      if !history_file.empty?
+        File.expand_path(history_file)
+      else
+        history_file
+      end
     end
 
     FH = "# Today's OMIKUJI: "
@@ -181,7 +208,7 @@ module DEBUGGER__
       if history && @init_history_lines
         added_records = history.to_a[@init_history_lines .. -1]
         path = history_file
-        max = CONFIG[:save_history] || 10_000
+        max = CONFIG[:save_history]
 
         if !added_records.empty? && !path.empty?
           orig_records = read_history_file

data/lib/debug/frame_info.rb

@@ -27,8 +27,8 @@ module DEBUGGER__
       location.absolute_path
     end
 
-    def pretty_path
-      return '#<none>' unless path = self.path
+    def self.pretty_path path
+      return '#<none>' unless path
       use_short_path = CONFIG[:use_short_path]
 
       case
@@ -45,15 +45,18 @@ module DEBUGGER__
       end
     end
 
+    def pretty_path
+      FrameInfo.pretty_path path
+    end
+
     def name
       # p frame_type: frame_type, self: self
       case frame_type
       when :block
-        level, block_loc, _args = block_identifier
+        level, block_loc = block_identifier
         "block in #{block_loc}#{level}"
       when :method
-        ci, _args = method_identifier
-        "#{ci}"
+        method_identifier
       when :c
         c_identifier
       when :other
@@ -83,16 +86,13 @@ module DEBUGGER__
 
     def block_identifier
       return unless frame_type == :block
-      args = parameters_info(iseq.argc)
       _, level, block_loc = location.label.match(BLOCK_LABL_REGEXP).to_a
-      [level || "", block_loc, args]
+      [level || "", block_loc]
     end
 
     def method_identifier
       return unless frame_type == :method
-      args = parameters_info(iseq.argc)
-      ci = "#{klass_sig}#{callee}"
-      [ci, args]
+      "#{klass_sig}#{callee}"
     end
 
     def c_identifier
@@ -106,7 +106,11 @@ module DEBUGGER__
     end
 
     def callee
-      self._callee ||= self.binding&.eval('__callee__')
+      self._callee ||= begin
+                         self.binding&.eval('__callee__')
+                       rescue NameError # BasicObject
+                         nil
+                       end
     end
 
     def return_str
@@ -115,6 +119,11 @@ module DEBUGGER__
       end
     end
 
+    def matchable_location
+      # realpath can sometimes be nil so we can't use it here
+      "#{path}:#{location.lineno}"
+    end
+
     def location_str
       "#{pretty_path}:#{location.lineno}"
     end
@@ -123,7 +132,6 @@ module DEBUGGER__
       if b = self.dupped_binding
         b
       else
-        b = TOPLEVEL_BINDING unless b = self.binding
         b = self.binding || TOPLEVEL_BINDING
         self.dupped_binding = b.dup
       end
@@ -139,9 +147,18 @@ module DEBUGGER__
       end
     end
 
-    private
+    def parameters_info
+      vars = iseq.parameters_symbols
+      vars.map{|var|
+        begin
+          { name: var, value: DEBUGGER__.safe_inspect(local_variable_get(var), short: true) }
+        rescue NameError, TypeError
+          nil
+        end
+      }.compact
+    end
 
-    def get_singleton_class obj
+    private def get_singleton_class obj
       obj.singleton_class # TODO: don't use it
     rescue TypeError
       nil
@@ -151,18 +168,7 @@ module DEBUGGER__
       local_variables[var]
     end
 
-    def parameters_info(argc)
-      vars = iseq.locals[0...argc]
-      vars.map{|var|
-        begin
-          { name: var, value: DEBUGGER__.safe_inspect(local_variable_get(var), short: true) }
-        rescue NameError, TypeError
-          nil
-        end
-      }.compact
-    end
-
-    def klass_sig
+    private def klass_sig
       if self.class == get_singleton_class(self.self)
         "#{self.self}."
       else

data/lib/debug/local.rb

@@ -98,7 +98,7 @@ module DEBUGGER__
           # only check child process from its parent
           begin
             # wait for all child processes to keep terminal
-            loop{ Process.waitpid }
+            Process.waitpid
           rescue Errno::ESRCH, Errno::ECHILD
           end
         end

data/lib/debug/server.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'socket'
+require 'etc'
 require_relative 'config'
 require_relative 'version'
 
@@ -19,8 +20,8 @@ module DEBUGGER__
       @session = nil
     end
 
-    class Terminate < StandardError
-    end
+    class Terminate < StandardError; end
+    class GreetingError < StandardError; end
 
     def deactivate
       @reader_thread.raise Terminate
@@ -47,10 +48,13 @@ module DEBUGGER__
 
         accept do |server, already_connected: false|
           DEBUGGER__.warn "Connected."
+          greeting_done = false
+          @need_pause_at_first = true
 
           @accept_m.synchronize{
             @sock = server
             greeting
+            greeting_done = true
 
             @accept_cv.signal
 
@@ -65,17 +69,21 @@ module DEBUGGER__
           } unless already_connected
 
           setup_interrupt do
-            pause unless already_connected
+            pause if !already_connected && @need_pause_at_first
             process
           end
 
+        rescue GreetingError => e
+          DEBUGGER__.warn "GreetingError: #{e.message}"
+          next
         rescue Terminate
           raise # should catch at outer scope
         rescue => e
           DEBUGGER__.warn "ReaderThreadError: #{e}"
           pp e.backtrace
         ensure
-          cleanup_reader
+          DEBUGGER__.warn "Disconnected."
+          cleanup_reader if greeting_done
         end # accept
 
       rescue Terminate
@@ -84,7 +92,7 @@ module DEBUGGER__
     end
 
     def cleanup_reader
-      DEBUGGER__.warn "Disconnected."
+      @sock.close if @sock
       @sock = nil
       @q_msg.close
       @q_msg = nil
@@ -92,21 +100,53 @@ module DEBUGGER__
       @q_ans = nil
     end
 
+    def check_cookie c
+      cookie = CONFIG[:cookie]
+      if cookie && cookie != c
+        raise GreetingError, "Cookie mismatch (#{$2.inspect} was sent)"
+      end
+    end
+
+    def parse_option params
+      case params.strip
+      when /width:\s+(\d+)/
+        @width = $1.to_i
+        parse_option $~.post_match
+      when /cookie:\s+(\S+)/
+        check_cookie $1 if $1 != '-'
+        parse_option $~.post_match
+      when /nonstop: (true|false)/
+        @need_pause_at_first = false if $1 == 'true'
+        parse_option $~.post_match
+      when /(.+):(.+)/
+        raise GreetingError, "Unkown option: #{params}"
+      else
+        # OK
+      end
+    end
+
     def greeting
       case g = @sock.gets
-      when /^version:\s+(.+)\s+width: (\d+) cookie:\s+(.*)$/
-        v, w, c = $1, $2, $3
+      when /^info cookie:\s+(.*)$/
+        check_cookie $1
+        @sock.puts "PID: #{Process.pid}, $0: #{$0}"
+        @sock.puts "debug #{VERSION} on #{RUBY_DESCRIPTION}"
+        @sock.puts "uname: #{Etc.uname.inspect}"
+        @sock.close
+        raise GreetingError, "HEAD request"
+
+      when /^version:\s+(\S+)\s+(.+)$/
+        v, params = $1, $2
+
         # TODO: protocol version
         if v != VERSION
-          raise "Incompatible version (#{VERSION} client:#{$1})"
-        end
-
-        cookie = CONFIG[:cookie]
-        if cookie && cookie != c
-          raise "Cookie mismatch (#{$2.inspect} was sent)"
+          raise GreetingError, "Incompatible version (server:#{VERSION} and client:#{$1})"
         end
+        parse_option(params)
 
-        @width = w.to_i
+        puts "DEBUGGER (client): Connected. PID:#{Process.pid}, $0:#{$0}"
+        puts "DEBUGGER (client): Type `Ctrl-C` to enter the debug console." unless @need_pause_at_first
+        puts
 
       when /^Content-Length: (\d+)/
         require_relative 'server_dap'
@@ -114,18 +154,21 @@ module DEBUGGER__
         raise unless @sock.read(2) == "\r\n"
         self.extend(UI_DAP)
         @repl = false
+        @need_pause_at_first = false
         dap_setup @sock.read($1.to_i)
-      when /^GET \/ HTTP\/1.1/
+
+      when /^GET \/.* HTTP\/1.1/
         require_relative 'server_cdp'
 
         self.extend(UI_CDP)
         @repl = false
+        @need_pause_at_first = false
         CONFIG.set_config no_color: true
 
         @ws_server = UI_CDP::WebSocketServer.new(@sock)
         @ws_server.handshake
       else
-        raise "Greeting message error: #{g}"
+        raise GreetingError, "Unknown greeting message: #{g}"
       end
     end
 
@@ -145,6 +188,7 @@ module DEBUGGER__
           }
         end
 
+        return unless line
         next if line == :can_not_read
 
         case line
@@ -168,7 +212,7 @@ module DEBUGGER__
             raise "pid:#{Process.pid} but get #{line}"
           end
         else
-          STDERR.puts "unsupported: #{line}"
+          STDERR.puts "unsupported: #{line.inspect}"
           exit!
         end
       end
@@ -290,7 +334,9 @@ module DEBUGGER__
     end
 
     def readline prompt
-      input = (sock do |s|
+      input = (sock(skip: CONFIG[:skip_bp]) do |s|
+        next unless s
+
         if @repl
           raise "not in subsession, but received: #{line.inspect}" unless @session.in_subsession?
           line = "input #{Process.pid}"
@@ -325,18 +371,28 @@ module DEBUGGER__
     def after_fork_parent
       # do nothing
     end
+
+    def vscode_setup debug_port
+      require_relative 'server_dap'
+      UI_DAP.setup debug_port
+    end
   end
 
   class UI_TcpServer < UI_ServerBase
     def initialize host: nil, port: nil
-      @addr = nil
-      @host = host || CONFIG[:host] || '127.0.0.1'
-      @port = port || begin
-        port_str = CONFIG[:port] || raise("Specify listening port by RUBY_DEBUG_PORT environment variable.")
-        if /\A\d+\z/ !~ port_str
-          raise "Specify digits for port number"
-        else
+      @local_addr = nil
+      @host = host || CONFIG[:host]
+      @port_save_file = nil
+      @port = begin
+        port_str = (port && port.to_s) || CONFIG[:port] || raise("Specify listening port by RUBY_DEBUG_PORT environment variable.")
+        case port_str
+        when /\A\d+\z/
           port_str.to_i
+        when /\A(\d+):(.+)\z/
+          @port_save_file = $2
+          $1.to_i
+        else
+          raise "Specify digits for port number"
         end
       end
 
@@ -346,12 +402,12 @@ module DEBUGGER__
     def chrome_setup
       require_relative 'server_cdp'
 
-      unless @chrome_pid = UI_CDP.setup_chrome(@addr)
-        DEBUGGER__.warn <<~EOS if CONFIG[:open_frontend] == 'chrome'
+      unless @chrome_pid = UI_CDP.setup_chrome(@local_addr.inspect_sockaddr)
+        DEBUGGER__.warn <<~EOS
           With Chrome browser, type the following URL in the address-bar:
-          
-             devtools://devtools/bundled/inspector.html?ws=#{@addr}
-          
+
+             devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=#{@local_addr.inspect_sockaddr}/#{SecureRandom.uuid}
+
           EOS
       end
     end
@@ -362,18 +418,28 @@ module DEBUGGER__
 
       begin
         Socket.tcp_server_sockets @host, @port do |socks|
-          @addr = socks[0].local_address.inspect_sockaddr # Change this part if `socks` are multiple.
+          @local_addr = socks.first.local_address # Change this part if `socks` are multiple.
           rdbg = File.expand_path('../../exe/rdbg', __dir__)
+          DEBUGGER__.warn "Debugger can attach via TCP/IP (#{@local_addr.inspect_sockaddr})"
+
+          if @port_save_file
+            File.write(@port_save_file, "#{socks[0].local_address.ip_port.to_s}\n")
+            DEBUGGER__.warn "Port is saved into #{@port_save_file}"
+          end
 
-          DEBUGGER__.warn "Debugger can attach via TCP/IP (#{@addr})"
           DEBUGGER__.info <<~EOS
           With rdbg, use the following command line:
           #
-          #   #{rdbg} --attach #{@addr.split(':').join(' ')}
+          #   #{rdbg} --attach #{@local_addr.ip_address} #{@local_addr.ip_port}
           #
           EOS
 
-          chrome_setup if CONFIG[:open_frontend] == 'chrome'
+          case CONFIG[:open_frontend]
+          when 'chrome'
+            chrome_setup
+          when 'vscode'
+            vscode_setup @local_addr.inspect_sockaddr
+          end
 
           Socket.accept_loop(socks) do |sock, client|
             @client_addr = client
@@ -397,6 +463,10 @@ module DEBUGGER__
       end
     ensure
       @sock_for_fork = nil
+
+      if @port_save_file && File.exist?(@port_save_file)
+        File.unlink(@port_save_file)
+      end
     end
   end
 
@@ -409,11 +479,6 @@ module DEBUGGER__
       super()
     end
 
-    def vscode_setup
-      require_relative 'server_dap'
-      UI_DAP.setup @sock_path
-    end
-
     def accept
       super # for fork
 
@@ -426,7 +491,7 @@ module DEBUGGER__
       end
 
       ::DEBUGGER__.warn "Debugger can attach via UNIX domain socket (#{@sock_path})"
-      vscode_setup if CONFIG[:open_frontend] == 'vscode'
+      vscode_setup @sock_path if CONFIG[:open_frontend] == 'vscode'
 
       begin
         Socket.unix_server_loop @sock_path do |sock, client|