debugger 1.4.0 → 1.5.0

data/lib/ruby-debug/printers/texts/plain.yml

@@ -0,0 +1,60 @@
+breakpoints:
+  set_breakpoint_to_line: "Breakpoint {id} file {file}, line {line}"
+  set_breakpoint_to_method: "Breakpoint {id} at {class}::{method}"
+  stop_at_breakpoint: "Breakpoint {id} at {file}:{line}"
+  delete: "Breakpoint {id} has been deleted"
+
+conditions:
+  set_condition: "Condition '{expr}' is set for the breakpoint {id}"
+  unset_condition: "Condition is cleared for the breakpoint {id}"
+
+display:
+  result: "{n}: {exp} = {result}"
+
+eval:
+  exception: "{text_message}"
+  result: "{result}"
+
+frame:
+  line: "{mark}#{pos} {call_str}at line {file}:{line}"
+
+method:
+  methods: "{name}|c"
+
+stop:
+  suspend: "{file}:{line_number}\n{line}"
+
+toggle:
+  breakpoint_enabled: "Breakpoint {id} is enabled"
+  breakpoint_disabled: "Breakpoint {id} is disabled"
+
+restart:
+  success: "Re exec'ing:\n\t{cmd}"
+
+set:
+  errors:
+    no_subcommand: "\"set\" must be followed by the name of an set command:\nList of set subcommands:\n\n{subcommands}"
+
+show:
+  errors:
+    no_subcommand: "\"show\" must be followed by the name of an show command:\nList of show subcommands:\n\n{subcommands}"
+
+thread:
+  context: "{status_flag}{debug_flag}{id} {thread}\t{file_line}"
+
+tmate:
+  errors:
+    wrong_frame: "Wrong frame number"
+
+trace:
+  messages:
+    all_threads: "Tracing {status} all threads"
+    current_thread: "Tracing {status} on current thread"
+  errors:
+    wrong_var_subcommand: "expecting 'stop' or 'nostop'; got {subcmd}"
+    var_is_not_global: "{name} is not a global variable"
+    wrong_subcommand: "expecting 'on', 'off', 'var' or 'variable'; got: {subcmd}"
+  trace: "traced variable {name} has value {value}"
+
+variable:
+  variable: "{key} = {value}"

data/lib/ruby-debug/processor.rb

@@ -6,6 +6,27 @@ module Debugger
   # Should this be a mixin?
   class Processor # :nodoc
     attr_accessor :interface
+    extend Forwardable
+    def_delegator :"Debugger.printer", :print, :pr
+
+    def self.protect(mname)
+      alias_method "__#{mname}", mname
+      module_eval %{
+        def #{mname}(*args)
+          @mutex.synchronize do
+            return unless @interface
+            __#{mname}(*args)
+          end
+        rescue IOError, Errno::EPIPE
+          self.interface = nil
+        rescue SignalException
+          raise
+        rescue Exception
+          print "INTERNAL ERROR!!! #\{$!\}\n" rescue nil
+          print $!.backtrace.map{|l| "\t#\{l\}"}.join("\n") rescue nil
+        end
+      }
+    end
 
     # Format msg with gdb-style annotation header
     def afmt(msg, newline="\n")
@@ -31,6 +52,11 @@ module Debugger
       @interface.print(*args)
     end
 
+    # Split commands like this:
+    # split_commands("abc;def\\;ghi;jkl") => ["abc", "def;ghi", "jkl"]
+    def split_commands(input)
+      input.split(/(?<!\\);/).map { |e| e.gsub("\\;", ";") }
+    end
   end
 
   class CommandProcessor < Processor # :nodoc:
@@ -94,35 +120,23 @@ module Debugger
       end
     end
 
-    def self.print_location_and_text(file, line)
-      file_line = "%s:%s\n%s" % [canonic_file(file), line,
-                                 Debugger.line_at(file, line)]
+    def self.print_location_and_text(file, line, context)
+      result = Debugger.printer.print("stop.suspend",
+        file: canonic_file(file), line_number: line, line: Debugger.line_at(file, line),
+        thnum: context && context.thnum, frames: context && context.stack_size
+      )
+      Debugger.handler.interface.print(annotate_location_and_text(result))
+    end
+
+    def self.annotate_location_and_text(output)
       # FIXME: use annotations routines
       if Debugger.annotate.to_i > 2
-        file_line = "\032\032source #{file_line}"
+        "\032\032source #{output}"
       elsif ENV['EMACS']
-        file_line = "\032\032#{file_line}"
+        "\032\032#{output}"
+      else
+        output
       end
-      print file_line
-    end
-
-    def self.protect(mname)
-      alias_method "__#{mname}", mname
-      module_eval %{
-        def #{mname}(*args)
-          @mutex.synchronize do
-            return unless @interface
-            __#{mname}(*args)
-          end
-        rescue IOError, Errno::EPIPE
-          self.interface = nil
-        rescue SignalException
-          raise
-        rescue Exception
-          print "INTERNAL ERROR!!! #\{$!\}\n" rescue nil
-          print $!.backtrace.map{|l| "\t#\{l\}"}.join("\n") rescue nil
-        end
-      }
     end
 
     def at_breakpoint(context, breakpoint)
@@ -133,7 +147,10 @@ module Debugger
       if Debugger.annotate.to_i > 2
         print afmt("source #{file}:#{line}")
       end
-      print "Breakpoint %d at %s:%s\n", n, file, line
+      print pr(
+        "breakpoints.stop_at_breakpoint", id: n, file: file, line: line, thread_id: Debugger.current_context.thnum
+      )
+      @last_breakpoint = breakpoint
     end
     protect :at_breakpoint
 
@@ -170,12 +187,16 @@ module Debugger
     protect :at_tracing
 
     def at_line(context, file, line)
+      CommandProcessor.print_location_and_text(file, line, context) unless @last_breakpoint
       process_commands(context, file, line)
+    ensure
+      @last_breakpoint = nil
     end
     protect :at_line
 
     def at_return(context, file, line)
       context.stop_frame = -1
+      CommandProcessor.print_location_and_text(file, line, context)
       process_commands(context, file, line)
     end
 
@@ -225,30 +246,14 @@ module Debugger
     def process_commands(context, file, line)
       state, commands = always_run(context, file, line, 1)
       $rdebug_state = state if Command.settings[:debuggertesting]
-      splitter = lambda do |str|
-        str.split(/;/).inject([]) do |m, v|
-          if m.empty?
-            m << v
-          else
-            if m.last[-1] == ?\\
-              m.last[-1,1] = ''
-              m.last << ';' << v
-            else
-              m << v
-            end
-          end
-          m
-        end
-      end
 
       preloop(commands, context)
-      CommandProcessor.print_location_and_text(file, line)
       while !state.proceed?
         input = if @interface.command_queue.empty?
-                  @interface.read_command(prompt(context))
-                else
-                  @interface.command_queue.shift
-                end
+          @interface.read_command(prompt(context))
+        else
+          @interface.command_queue.shift
+        end
         break unless input
         catch(:debug_error) do
           if input == ""
@@ -257,7 +262,7 @@ module Debugger
           else
             @last_cmd = input
           end
-          splitter[input].each do |cmd|
+          split_commands(input).each do |cmd|
             one_cmd(commands, context, cmd)
             postcmd(commands, context, cmd)
           end
@@ -375,6 +380,10 @@ module Debugger
         @interface.print(*args)
       end
 
+      def print_debug(*args)
+        @interface.print_debug(*args)
+      end
+
       def confirm(*args)
         @interface.confirm(*args)
       end

data/test/breakpoints_test.rb

@@ -40,23 +40,9 @@ describe "Breakpoints" do
       debug_file("breakpoint1") { Debugger.breakpoints.must_be_empty }
     end
 
-    it "must show an error" do
-      debug_file("breakpoint1")
-      check_output_includes "There are only #{LineCache.size(fullpath('breakpoint1'))} lines in file \"breakpoint1.rb\".", interface.error_queue
-    end
-  end
-
-
-  describe "setting breakpoint to incorrect line" do
-    before { enter 'break 8' }
-
-    it "must not create a breakpoint" do
-      debug_file("breakpoint1") { Debugger.breakpoints.must_be_empty }
-    end
-
-    it "must show an error" do
+    it "shows an error" do
       debug_file("breakpoint1")
-      check_output_includes 'Line 8 is not a stopping point in file "breakpoint1.rb".', interface.error_queue
+      check_output_includes "There are only #{LineCache.size(fullpath('breakpoint1'))} lines in file 'breakpoint1.rb'", interface.error_queue
     end
   end
 
@@ -72,7 +58,7 @@ describe "Breakpoints" do
       debug_file("breakpoint1") { state.file.must_equal fullpath("breakpoint1") }
     end
 
-    describe "show a message" do
+    describe "shows a message" do
       temporary_change_hash_value(Debugger::Command.settings, :basename, false)
 
       it "must show a message with full filename" do
@@ -90,32 +76,6 @@ describe "Breakpoints" do
   end
 
 
-  describe "reloading source on change" do
-    temporary_change_hash_value(Debugger::Command.settings, :reload_source_on_change, false)
-
-    it "must not reload source if autoreload is not set" do
-      enter(
-        'set noautoreload',
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, ''); 'break 14'},
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, 'c = a + b'); 'cont'}
-      )
-      debug_file "breakpoint1"
-      check_output_includes "Breakpoint 1 at #{fullpath('breakpoint1')}:14"
-    end
-
-    it "must reload source if autoreload is set" do
-      enter(
-        'set autoreload',
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, ''); 'break 14'},
-        # Setting second breakpoint just to reload the source code after rolling the file changes back
-        ->{change_line_in_file(fullpath('breakpoint1'), 14, 'c = a + b'); 'break 15'}, 'cont'
-      )
-      debug_file "breakpoint1"
-      check_output_includes "Line 14 is not a stopping point in file \"breakpoint1.rb\".", interface.error_queue
-    end
-  end
-
-
   describe "set breakpoint in a file" do
     describe "successfully" do
       before do
@@ -132,10 +92,12 @@ describe "Breakpoints" do
     end
 
     describe "when setting breakpoint to unexisted file" do
+
       before do
         enter "break asf:324"
         debug_file("breakpoint1")
       end
+
       it "must show an error" do
         check_output_includes "No source file named asf", interface.error_queue
       end
@@ -160,6 +122,12 @@ describe "Breakpoints" do
       it "must stop at the correct file" do
         debug_file("breakpoint1") { state.file.must_equal fullpath("breakpoint1") }
       end
+
+      it "must show output in plain text" do
+        id = nil
+        debug_file("breakpoint1") { id = breakpoint.id }
+        check_output_includes "Breakpoint #{id} at A::b"
+      end
     end
 
     describe "set breakpoint to a class method" do
@@ -180,7 +148,7 @@ describe "Breakpoints" do
       it "must show an error" do
         enter "break B.a"
         debug_file("breakpoint1")
-        check_output_includes "Unknown class B.", interface.error_queue
+        check_output_includes "Unknown class B", interface.error_queue
       end
     end
   end
@@ -195,7 +163,7 @@ describe "Breakpoints" do
 
     it "must show an error" do
       debug_file("breakpoint1")
-      check_output_includes 'Invalid breakpoint location: foo.', interface.error_queue
+      check_output_includes 'Invalid breakpoint location: foo', interface.error_queue
     end
   end
 
@@ -214,6 +182,12 @@ describe "Breakpoints" do
           enter "cont"
           debug_file("breakpoint1") { state.line.must_equal 15 }
         end
+
+        it "must show success message" do
+          id = nil
+          debug_file("breakpoint1") { id = breakpoint.id }
+          check_output_includes "Breakpoint #{id} is disabled"
+        end
       end
 
       describe "full syntax" do
@@ -229,7 +203,7 @@ describe "Breakpoints" do
         enter "disable"
         debug_file("breakpoint1")
         check_output_includes(
-          '"disable" must be followed "display", "breakpoints" or breakpoint numbers.',
+          "'disable' must be followed 'display', 'breakpoints' or breakpoint numbers",
           interface.error_queue
         )
       end
@@ -237,14 +211,15 @@ describe "Breakpoints" do
       it "must show an error if no breakpoints is set" do
         enter "disable 1"
         debug_file("breakpoint1")
-        check_output_includes 'No breakpoints have been set.', interface.error_queue
+        check_output_includes 'No breakpoints have been set', interface.error_queue
       end
 
       it "must show an error if not a number is provided as an argument to 'disable' command" do
         enter "break 14", "disable foo"
         debug_file("breakpoint1")
-        check_output_includes "Disable breakpoints argument 'foo' needs to be a number."
+        check_output_includes "Disable breakpoints argument 'foo' needs to be a number"
       end
+
     end
   end
 
@@ -263,6 +238,12 @@ describe "Breakpoints" do
           enter "cont"
           debug_file("breakpoint1") { state.line.must_equal 14 }
         end
+
+        it "must show success message" do
+          id = nil
+          debug_file("breakpoint1") { id = breakpoint.id }
+          check_output_includes "Breakpoint #{id} is enabled"
+        end
       end
 
       describe "full syntax" do
@@ -279,7 +260,7 @@ describe "Breakpoints" do
         enter "enable"
         debug_file("breakpoint1")
         check_output_includes(
-          '"enable" must be followed "display", "breakpoints" or breakpoint numbers.',
+          "'enable' must be followed 'display', 'breakpoints' or breakpoint numbers",
           interface.error_queue
         )
       end
@@ -288,7 +269,10 @@ describe "Breakpoints" do
 
 
   describe "deleting a breakpoint" do
-    before { enter "break 14", ->{"delete #{breakpoint.id}"}, "break 15" }
+    before do
+      @breakpoint_id = nil
+      enter "break 14", ->{@breakpoint_id = breakpoint.id; "delete #{@breakpoint_id}"}, "break 15"
+    end
 
     it "must have only one breakpoint" do
       debug_file("breakpoint1") { Debugger.breakpoints.size.must_equal 1 }
@@ -298,6 +282,11 @@ describe "Breakpoints" do
       enter "cont"
       debug_file("breakpoint1") { state.line.must_equal 15 }
     end
+
+    it "must show a success message" do
+      debug_file("breakpoint1")
+      check_output_includes "Breakpoint #{@breakpoint_id} has been deleted"
+    end
   end
 
 
@@ -315,7 +304,7 @@ describe "Breakpoints" do
     it "must show an error when conditional syntax is wrong" do
       enter "break 14 ifa b == 3", "break 15", "cont"
       debug_file("breakpoint1") { state.line.must_equal 15 }
-      check_output_includes "Expecting 'if' in breakpoint condition; got: ifa b == 3.", interface.error_queue
+      check_output_includes "Expecting 'if' in breakpoint condition; got: ifa b == 3", interface.error_queue
     end
 
     describe "enabling with wrong conditional syntax" do
@@ -335,7 +324,7 @@ describe "Breakpoints" do
       it "must show an error" do
         debug_file("breakpoint1")
         check_output_includes(
-          'Expression "b -=( 3" syntactically incorrect; breakpoint remains disabled.',
+          "Expression 'b -=( 3' syntactically incorrect; breakpoint remains disabled",
           interface.error_queue
         )
       end
@@ -344,13 +333,13 @@ describe "Breakpoints" do
     it "must show an error if no file or line is specified" do
       enter "break ifa b == 3", "break 15", "cont"
       debug_file("breakpoint1") { state.line.must_equal 15 }
-      check_output_includes "Invalid breakpoint location: ifa b == 3.", interface.error_queue
+      check_output_includes "Invalid breakpoint location: ifa b == 3", interface.error_queue
     end
 
     it "must show an error if expression syntax is invalid" do
       enter "break if b -=) 3", "break 15", "cont"
       debug_file("breakpoint1") { state.line.must_equal 15 }
-      check_output_includes 'Expression "b -=) 3" syntactically incorrect; breakpoint disabled.', interface.error_queue
+      check_output_includes "Expression 'b -=) 3' syntactically incorrect; breakpoint disabled", interface.error_queue
     end
   end