ruby-debug 0.10.0 → 0.10.1

data/cli/ruby-debug/commands/irb.rb

@@ -33,6 +33,8 @@ module IRB # :nodoc:
 end
 
 module Debugger
+
+  # Implements debugger "help" command.
   class IRBCommand < Command # :nodoc:
 
     register_setting_get(:autoirb) do 
@@ -79,7 +81,7 @@ module Debugger
 
       def help(cmd)
         %{
-          irb\tstarts an IRB session. (EXPERIMENTAL)
+          irb\tstarts an Interactive Ruby (IRB) session.
         }
       end
     end

data/cli/ruby-debug/commands/list.rb

@@ -1,5 +1,6 @@
 module Debugger
-  class ListCommand < Command # :nodoc:
+  # Implements debugger "list" command.
+  class ListCommand < Command
 
     register_setting_get(:autolist) do
       ListCommand.always_run 
@@ -9,7 +10,7 @@ module Debugger
     end
 
     def regexp
-      /^\s*l(?:ist)?(?:\s*([-=])|\s+(.+))?$/
+      /^\s* l(?:ist)? (?:\s*([-=])|\s+(.+))? $/x
     end
 
     def execute
@@ -19,8 +20,15 @@ module Debugger
         @state.previous_line + listsize : @state.line - (listsize/2)
         e = b + listsize - 1
       elsif @match[1] == '-'
-        b = @state.previous_line ? 
-        @state.previous_line - listsize : @state.line - (listsize/2)
+        b = if @state.previous_line
+              if  @state.previous_line > 0
+                @state.previous_line - listsize 
+              else
+                @state.previous_line
+              end
+            else 
+              @state.line - (listsize/2)
+            end
         e = b + listsize - 1
       elsif @match[1] == '='
         @state.previous_line = nil
@@ -36,8 +44,7 @@ module Debugger
           e = b + listsize - 1
         end
       end
-      @state.previous_line = b
-      display_list(b, e, @state.file, @state.line)
+      @state.previous_line = display_list(b, e, @state.file, @state.line)
     end
 
     class << self
@@ -58,13 +65,19 @@ module Debugger
 
     private
 
-    def display_list(b, e, file, line)
+    # Show FILE from line B to E where CURRENT is the current line number.
+    # If we can show from B to E then we return B, otherwise we return the
+    # previous line @state.previous_line.
+    def display_list(b, e, file, current)
       print "[%d, %d] in %s\n", b, e, file
-      if lines = Debugger.source_for(file)
-        n = 0
-        b.upto(e) do |n|
+      lines = LineCache::getlines(file, 
+                                  Command.settings[:reload_source_on_change])
+      return @state.previous_line if b >= lines.size
+      if lines
+        e = lines.size if lines.size < e
+        [b, 1].max.upto(e) do |n|
           if n > 0 && lines[n-1]
-            if n == line
+            if n == current
               print "=> %d  %s\n", n, lines[n-1].chomp
             else
               print "   %d  %s\n", n, lines[n-1].chomp
@@ -72,46 +85,10 @@ module Debugger
           end
         end
       else
-        print "No sourcefile available for %s\n", file
-      end
-    end
-  end
-
-  class ReloadCommand < Command # :nodoc:
-    self.control = true
-
-    register_setting_get(:reload_source_on_change) do 
-      Debugger.reload_source_on_change
-    end
-    register_setting_set(:reload_source_on_change) do |value|
-      Debugger.reload_source_on_change = value
-    end
-    
-    def regexp
-      /^\s*r(?:eload)?$/
-    end
-    
-    def execute
-      Debugger.source_reload
-      print "Source code is reloaded. Automatic reloading is #{source_reloading}.\n"
-    end
-    
-    private
-    
-    def source_reloading
-      Debugger.reload_source_on_change ? 'on' : 'off'
-    end
-    
-    class << self
-      def help_command
-        'reload'
-      end
-
-      def help(cmd)
-        %{
-          r[eload]\tforces source code reloading
-        }
+        errmsg "No sourcefile available for %s\n", file
+        return @state.previous_line
       end
+      return e == lines.size ? @state.previous_line : b
     end
   end
 end

data/cli/ruby-debug/commands/quit.rb

@@ -0,0 +1,38 @@
+module Debugger
+
+  # Implements debugger "quit" command
+  class QuitCommand < Command
+    self.allow_in_control = true
+
+    def regexp
+      / ^\s*
+         (?:q(?:uit)?|exit) \s*
+         (\s+unconditionally)? \s*
+         $
+      /ix
+    end
+
+    def execute
+      if @match[1] or confirm("Really quit? (y/n) ") 
+        @state.interface.finalize
+        exit! # exit -> exit!: No graceful way to stop threads...
+      end
+    end
+
+    class << self
+      def help_command
+        %w[quit exit]
+      end
+
+      def help(cmd)
+        %{
+          q[uit] [unconditionally]\texit from debugger. 
+          exit\talias to quit
+
+          Normally we prompt before exiting. However if the parameter
+          "unconditionally" is given, we stop without asking further questions.
+        }
+      end
+    end
+  end
+end

data/cli/ruby-debug/commands/reload.rb

@@ -0,0 +1,40 @@
+module Debugger
+  # Implements debugger "reload" command.
+  class ReloadCommand < Command
+    self.allow_in_control = true
+
+    register_setting_get(:reload_source_on_change) do 
+      Debugger.reload_source_on_change
+    end
+    register_setting_set(:reload_source_on_change) do |value|
+      Debugger.reload_source_on_change = value
+    end
+    
+    def regexp
+      /^\s*r(?:eload)?$/
+    end
+    
+    def execute
+      Debugger.source_reload
+      print "Source code is reloaded. Automatic reloading is #{source_reloading}.\n"
+    end
+    
+    private
+    
+    def source_reloading
+      Debugger.reload_source_on_change ? 'on' : 'off'
+    end
+    
+    class << self
+      def help_command
+        'reload'
+      end
+
+      def help(cmd)
+        %{
+          r[eload]\tforces source code reloading
+        }
+      end
+    end
+  end
+end

data/cli/ruby-debug/commands/save.rb

@@ -0,0 +1,80 @@
+module Debugger
+  module SaveFunctions # :nodoc:
+
+    # Create a temporary file to write in if file is nil
+    def open_save
+      require "tempfile"
+      file = Tempfile.new("rdebug-save")
+      # We want close to not unlink, so redefine.
+      def file.close
+        @tmpfile.close if @tmpfile
+      end
+      return file
+    end
+  end
+
+  class SaveCommand < Command # :nodoc:
+    self.allow_in_control = true
+    
+    def save_breakpoints(file)
+      Debugger.breakpoints.each do |b|
+        file.puts "break #{b.source}:#{b.pos}#{" if #{b.expr}" if b.expr}"
+      end
+      file.puts "catch #{Debugger.catchpoint}" if Debugger.catchpoint
+    end
+    
+    def save_displays(file)
+      for d in @state.display
+        if d[0]
+          file.puts "display #{d[1]}"
+        end
+      end
+    end
+    
+    def save_settings(file)
+      # FIXME put routine in set
+      %w(autoeval basename debuggertesting).each do |setting|
+        on_off = show_onoff(Command.settings[setting.to_sym])
+        file.puts "set #{setting} #{on_off}"
+      end
+      %w(autolist autoirb).each do |setting|
+        on_off = show_onoff(Command.settings[setting.to_sym] > 0)
+        file.puts "set #{setting} #{on_off}"
+      end
+    end
+    
+    def regexp
+      /^\s*sa(?:ve)?(?:\s+(.+))?$/
+    end
+    
+    def execute
+      if not @match[1] or @match[1].strip.empty?
+        file = open_save()
+      else
+        file = open(@match[1], 'w')
+      end
+      save_breakpoints(file)
+      # save_displays(file)
+      save_settings(file)
+      print "Saved to '#{file.path}'\n"
+      if @state and @state.interface
+        @state.interface.restart_file = file.path
+      end
+      file.close
+    end
+
+    class << self
+      def help_command
+        'save'
+      end
+      
+      def help(cmd)
+        %{
+          save FILE\tsaves current debugger state to FILE as a script file.
+          This includes breakpoints, catchpoint, display expressions and some
+           settings.
+        }
+      end
+    end
+  end
+end

data/cli/ruby-debug/commands/{settings.rb → set.rb}

@@ -1,14 +1,18 @@
 module Debugger
-  class SetCommand < Command # :nodoc:
-    
-    SubcmdStruct=Struct.new(:name, :min, :is_bool, :short_help) unless
-      defined?(SubcmdStruct)
+  # Implements debugger "set" command.
+  class SetCommand < Command
+    SubcmdStruct2=Struct.new(:name, :min, :is_bool, :short_help, 
+                             :long_help) unless defined?(SubcmdStruct2)
     Subcommands = 
       [
        ['annotate', 2, false,
-       "Set annotation level."],
+       "Set annotation level",
+"0 == normal;
+2 == output annotated suitably for use by programs that control 
+ruby-debug."],
        ['args', 2, false,
-       "Set argument list to give program being debugged when it is started."],
+       "Set argument list to give program being debugged when it is started",
+"Follow this command with any number of args, to be passed to the program."],
        ['autoeval', 4, true,
         "Evaluate every unrecognized command"],
        ['autolist', 4, true,
@@ -28,7 +32,10 @@ module Debugger
        ['fullpath', 2, true,
         "Display full file names in frames"],
        ['history', 2, false,
-        "Generic command for setting command history parameters."],
+        "Generic command for setting command history parameters",
+"set history filename -- Set the filename in which to record the command history
+set history save -- Set saving of the history record on exit
+set history size -- Set the size of the command history"],
        ['keep-frame-bindings', 1, true,
         "Save frame binding on each call"],
        ['linetrace+', 10, true,
@@ -37,15 +44,17 @@ module Debugger
        "Set line execution tracing"],
        ['listsize', 3, false,
        "Set number of source lines to list by default"],
+#        ['post-mortem', 3, true,
+#        "Set whether we do post-mortem handling on an uncaught exception"],
        ['trace', 1, true,
         "Display stack trace when 'eval' raises exception"],
        ['width', 1, false,
         "Number of characters the debugger thinks are in a line"],
-      ].map do |name, min, is_bool, short_help| 
-      SubcmdStruct.new(name, min, is_bool, short_help)
+      ].map do |name, min, is_bool, short_help, long_help| 
+      SubcmdStruct2.new(name, min, is_bool, short_help, long_help)
     end unless defined?(Subcommands)
     
-    self.control = true
+    self.allow_in_control = true
 
     def regexp
       /^set (?: \s+ (.*) )?$/ix
@@ -85,7 +94,13 @@ module Debugger
                 else
                   return
                 end
-                Command.settings[:argv][1..-1] = args
+                if defined?(Debugger::RDEBUG_SCRIPT)
+                  # rdebug was called initially. 1st arg is script name.
+                  Command.settings[:argv][1..-1] = args
+                else
+                  # rdebug wasn't called initially. 1st arg is not script name.
+                  Command.settings[:argv] = args
+                end
               when /^args$/
                 Command.settings[:argv][1..-1] = args
               when /^autolist$/
@@ -148,6 +163,15 @@ module Debugger
                 else
                   return
                 end
+#               when /^post-mortem$/
+#                 unless Debugger.post_mortem? == set_on
+#                   if set_on
+#                     Debugger.post_mortem
+#                   else
+#                     errmsg "Can't turn off post-mortem once it is on.\n"
+#                     return
+#                   end
+#                 end
               when /^width$/
                 width = get_int(args[0], "Set width", 10, nil, 80)
                 if width
@@ -176,7 +200,21 @@ module Debugger
         "set"
       end
 
-      def help(cmd)
+      def help(args)
+        if args[1] 
+          s = args[1]
+          subcmd = Subcommands.find do |try_subcmd| 
+            (s.size >= try_subcmd.min) and
+              (try_subcmd.name[0..s.size-1] == s)
+          end
+          if subcmd
+            str = subcmd.short_help + '.'
+            str += "\n" + subcmd.long_help if subcmd.long_help
+            return str
+          else
+            return "Invalid 'set' subcommand '#{args[1]}'."
+          end
+        end
         s = %{
           Modifies parts of the ruby-debug environment. Boolean values take
           on, off, 1 or 0.

data/cli/ruby-debug/commands/show.rb

@@ -8,7 +8,13 @@ module Debugger
         return ("Annotation level is #{Debugger.annotate}")
       when /^args$/
         if Command.settings[:argv] and Command.settings[:argv].size > 0
-          args = Command.settings[:argv][1..-1].join(' ')
+          if defined?(Debugger::RDEBUG_SCRIPT)
+            # rdebug was called initially. 1st arg is script name.
+            args = Command.settings[:argv][1..-1].join(' ')
+          else
+            # rdebug wasn't called initially. 1st arg is not script name.
+            args = Command.settings[:argv].join(' ')
+          end
         else
           args = ''
         end
@@ -31,6 +37,36 @@ module Debugger
       when /^callstyle$/
         style = Command.settings[:callstyle]
         return "Frame call-display style is #{style}."
+      when /^commands(:?\s+(\d+))?$/
+        s = '';
+        args = @match[1].split
+        if args[1]
+          first_line = args[1].to_i - 4
+          last_line  = first_line + 10 - 1
+          if first_line > Readline::HISTORY.length
+            first_line = last_line = Readline::HISTORY.length
+          elsif first_line <= 0
+            first_line = 1
+          end
+          if last_line > Readline::HISTORY.length
+            last_line = Readline::HISTORY.length
+          end
+          i = first_line
+          commands = Readline::HISTORY.to_a[first_line..last_line]
+        else
+          if Readline::HISTORY.length > 10
+            commands = Readline::HISTORY.to_a[-10..-1]
+            i = Readline::HISTORY.length - 10
+          else
+            commands = Readline::HISTORY.to_a
+            i = 1
+          end
+        end
+        commands.each do |cmd|
+          s += ("%5d  %s\n" % [i, cmd])
+          i += 1
+        end
+        return s
       when /^debuggertesting$/
         on_off = Command.settings[:debuggertesting]
         return "Currently testing the debugger is #{show_onoff(on_off)}."
@@ -94,7 +130,7 @@ module Debugger
       when /^port$/
         return "server port is #{Debugger::PORT}."
       when /^post-mortem$/
-        on_off = Debugger.post_mortem
+        on_off = Debugger.post_mortem?
         return "post-mortem handling is #{show_onoff(on_off)}."
       when /^trace$/
         on_off = Command.settings[:stack_trace_on_error]
@@ -109,41 +145,49 @@ module Debugger
     end
   end
 
-  class ShowCommand < Command # :nodoc:
+  # Implements debugger "show" command.
+  class ShowCommand < Command
     
-    SubcmdStruct=Struct.new(:name, :min, :short_help) unless 
-      defined?(SubcmdStruct)
     Subcommands = 
       [
-       ['annotate', 2, "Show annotation level"],
+       ['annotate', 2, "Show annotation level",
+"0 == normal; 2 == output annotated suitably for use by programs that control 
+ruby-debug."],
        ['args', 2, 
-        "Show argument list to give program being debugged when it is started"],
-       ['autoeval', 4, "Show if unrecognized command are evaluated"],
-       ['autolist', 4, "Show if 'list' commands is run on breakpoints"],
-       ['autoirb', 4, "Show if IRB is invoked on debugger stops"],
+        "Show argument list to give program being debugged when it is started",
+"Follow this command with any number of args, to be passed to the program."],
+       ['autoeval',  4, "Show if unrecognized command are evaluated"],
+       ['autolist',  4, "Show if 'list' commands is run on breakpoints"],
+       ['autoirb',   4, "Show if IRB is invoked on debugger stops"],
        ['autoreload', 4, "Show if source code is reloaded when changed"],
-       ['basename', 1, "Show if basename used in reporting files"],
+       ['basename',  1, "Show if basename used in reporting files"],
        ['callstyle', 2, "Show paramater style used showing call frames"],
+       ['commands',  2, "Show the history of commands you typed",
+"You can supply a command number to start with."],
        ['forcestep', 1, "Show if sure 'next/step' forces move to a new line"],
-       ['fullpath', 2, "Show if full file names are displayed in frames"],
-       ['history', 2, "Generic command for showing command history parameters"],
+       ['fullpath',  2, "Show if full file names are displayed in frames"],
+       ['history', 2, "Generic command for showing command history parameters",
+"show history filename -- Show the filename in which to record the command history
+show history save -- Show saving of the history record on exit
+show history size -- Show the size of the command history"],
        ['keep-frame-bindings', 1, "Save frame binding on each call"],
        ['linetrace', 3, "Show line execution tracing"],
        ['linetrace+', 10, 
         "Show if consecutive lines should be different are shown in tracing"],
        ['listsize', 3, "Show number of source lines to list by default"],
-       ['port', 1, "Show server port"],
+       ['port', 3, "Show server port"],
+       ['post-mortem', 3, "Show whether we go into post-mortem debugging on an uncaught exception"],
        ['trace', 1, 
         "Show if a stack trace is displayed when 'eval' raises exception"],
        ['version', 1, 
         "Show what version of the debugger this is"],
        ['width', 1, 
         "Show the number of characters the debugger thinks are in a line"],
-      ].map do |name, min, short_help| 
-      SubcmdStruct.new(name, min, short_help)
+      ].map do |name, min, short_help, long_help| 
+      SubcmdStruct.new(name, min, short_help, long_help)
     end unless defined?(Subcommands)
     
-    self.control = true
+    self.allow_in_control = true
 
     def regexp
       /^show (?: \s+ (.+) )?$/xi
@@ -157,16 +201,14 @@ module Debugger
           print "show #{subcmd.name} -- #{subcmd.short_help}\n"
         end
       else
-        subcmd, arg = @match[1].split(/[ \t]+/)
-        subcmd.downcase!
-        for try_subcmd in Subcommands do
-          if (subcmd.size >= try_subcmd.min) and
-              (try_subcmd.name[0..subcmd.size-1] == subcmd)
-            print "%s\n" % show_setting(try_subcmd.name)
-            return
-          end
+        args = @match[1].split(/[ \t]+/)
+        param = args.shift
+        subcmd = find(Subcommands, param)
+        if subcmd
+          print "%s\n" % show_setting(subcmd.name)
+        else
+          print "Unknown show command #{param}\n"
         end
-        print "Unknown show command #{subcmd}\n"
       end
     end
 
@@ -175,7 +217,21 @@ module Debugger
         "show"
       end
 
-      def help(cmd)
+      def help(args)
+        if args[1] 
+          s = args[1]
+          subcmd = Subcommands.find do |try_subcmd| 
+            (s.size >= try_subcmd.min) and
+              (try_subcmd.name[0..s.size-1] == s)
+          end
+          if subcmd
+            str = subcmd.short_help + '.'
+            str += "\n" + subcmd.long_help if subcmd.long_help
+            return str
+          else
+            return "Invalid 'show' subcommand '#{args[1]}'."
+          end
+        end
         s = "
           Generic command for showing things about the debugger.