ruby-debug 0.10.2 → 0.10.3

data/cli/ruby-debug.rb

@@ -25,9 +25,15 @@ module Debugger
   end
   
   class << self
+    # gdb-style annotation mode. Used in GNU Emacs interface
+    attr_accessor :annotate
+
     # in remote mode, wait for the remote connection 
     attr_accessor :wait_connection
-    attr_accessor :annotate
+
+    # If set, a string to look for in caller() and is used to see
+    # if the call stack is truncated.
+    attr_accessor :start_sentinal 
     
     attr_reader :thread, :control_thread
 
@@ -80,7 +86,7 @@ module Debugger
     
     def start_control(host = nil, ctrl_port = PORT + 1) # :nodoc:
       raise "Debugger is not started" unless started?
-      return if @control_thread
+      return if defined?(@control_thread) && @control_thread
       @control_thread = DebugThread.new do
         server = TCPServer.new(host, ctrl_port)
         while (session = server.accept)
@@ -145,3 +151,26 @@ module Debugger
     end
   end
 end
+
+module Kernel
+
+  # Enters the debugger in the current thread after _steps_ line events occur.
+  # Before entering the debugger startup script is read.
+  #
+  # Setting _steps_ to 0 will cause a break in the debugger subroutine
+  # and not wait for a line event to occur. You will have to go "up 1"
+  # in order to be back in your debugged program rather than the
+  # debugger. Settings _steps_ to 0 could be useful you want to stop
+  # right after the last statement in some scope, because the next
+  # step will take you out of some scope.
+  def debugger(steps = 1)
+    Debugger.start unless Debugger.started?
+    Debugger.run_init_script(StringIO.new)
+    if 0 == steps
+      Debugger.current_context.stop_frame = 0
+    else
+      Debugger.current_context.stop_next = steps
+    end
+  end
+  alias breakpoint debugger unless respond_to?(:breakpoint)
+end

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

@@ -72,7 +72,11 @@ module Debugger
             errmsg("Line %d is not a stopping point in file \"%s\".\n", line, file) 
             return
           end
+        else
+          errmsg("No source file named %s\n" % file)
+          return unless confirm("Set breakpoint anyway? (y/n) ")
         end
+
         unless @state.context
           errmsg "We are not in a state we can add breakpoints.\n"
           return 

data/cli/ruby-debug/commands/continue.RB.save

@@ -0,0 +1,48 @@
+module Debugger
+
+  # Implements debugger "continue" command.
+  class ContinueCommand < Command
+    self.allow_in_post_mortem = false
+    self.need_context         = true
+    def regexp
+      /^\s* c(?:ont(?:inue)?)? (?:\s+(.*))? $/x
+    end
+
+    def execute
+      unless @state.context
+        errmsg "We are not in a state we can continue.\n"
+        return 
+      end
+      if @match[1] && !@state.context.dead?
+        if '-' == @match[1]
+          Debugger.stop if Debugger.started? 
+        else
+          filename = File.expand_path(@state.file)
+          line_number = get_int(@match[1], "Continue", 0, nil, 0)
+          return unless line_number
+          unless LineCache.trace_line_numbers(filename).member?(line_number)
+            errmsg("Line %d is not a stopping point in file \"%s\".\n", 
+                   line_number, filename) 
+            return
+          end
+          @state.context.set_breakpoint(filename, line_number)
+        end
+      end
+      @state.proceed
+    end
+
+    class << self
+      def help_command
+        'continue'
+      end
+
+      def help(cmd)
+        %{
+          c[ont[inue]][ nnn | -]\trun until program ends, hits a breakpoint or reaches line nnn.
+
+If - is given then we issue a Debugger.stop to remove tracing the program continues at full speed.
+        }
+      end
+    end
+  end
+end

data/cli/ruby-debug/commands/disassemble.RB

@@ -0,0 +1,38 @@
+module Debugger
+
+  require 'pp'
+  require 'nodepp'
+  require 'classtree'
+  require 'parse_tree'
+  class Disassemble < Command # :nodoc:
+    self.allow_in_control = false
+    @@parse_tree = ParseTree.new(true)
+    
+    def regexp
+      /^\s*(dis(?:assemble)?)\s+/
+    end
+
+    def execute
+      expr = @match ? @match.post_match : @input
+      binding = @state.context ? get_binding : TOPLEVEL_BINDING
+      method_str = "method(:#{expr})"
+      if method_obj = debug_eval(method_str, binding)
+        print @@parse_tree.parse_tree_for_method(method_obj.class, 
+                                                 method_str).inspect
+        print "#{method_obj}\n"
+      end
+    end
+
+    class << self
+      def help_command
+        %w|disassemble method-name|
+      end
+
+      def help(cmd)
+          %{
+            dis[assemble] method-name\tdo live unparsing of method name
+          }
+      end
+    end
+  end if false
+end

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

@@ -107,6 +107,48 @@ module Debugger
         print fmt % [CommandProcessor.canonic_file(file), line]
       end
     end
+
+    # Check if call stack is truncated.  This can happen if
+    # Debugger.start is not called low enough in the call stack. An
+    # array of additional callstack lines from caller is returned if
+    # definitely truncated, false if not, and nil if we don't know.
+    #
+    # We determine truncation based on a passed in sentinal set via
+    # caller which can be nil.  
+    #
+    # First we see if we can find our position in caller. If so, then
+    # we compare context position to that in caller using sentinal
+    # as a place to start ignoring additional caller entries. sentinal
+    # is set by rdebug, but if it's not set, i.e. nil then additional
+    # entries are presumably ones that we haven't recorded in context
+    def truncated_callstack?(context, sentinal=nil, cs=caller)
+      recorded_size = context.stack_size
+      to_find_fl = "#{context.frame_file(0)}:#{context.frame_line(0)}"
+      top_discard = false
+      cs.each_with_index do |fl, i|
+        fl.gsub!(/in `.*'$/, '')
+        fl.gsub!(/:$/, '')
+        if fl == to_find_fl
+          top_discard = i
+          break 
+        end
+      end
+      if top_discard
+        cs = cs[top_discard..-1]
+        return false unless cs
+        return cs unless sentinal
+        if cs.size > recorded_size+2 && cs[recorded_size+2] != sentinal 
+          # caller seems to truncate recursive calls and we don't.
+          # See if we can find sentinal in the first 0..recorded_size+1 entries
+          return false if cs[0..recorded_size+1].any?{ |f| f==sentinal }
+          return cs
+        end
+        return false
+      end
+      return nil
+    end
+
+
   end
 
   # Implements debugger "where" or "backtrace" command.
@@ -123,6 +165,10 @@ module Debugger
           print "    "
         end
         print_frame(idx)
+
+      end
+      if truncated_callstack?(@state.context, Debugger.start_sentinal)
+        print "Warning: saved frames may be incomplete; compare with caller(0).\n" 
       end
     end
 

data/cli/ruby-debug/commands/source.RB

@@ -0,0 +1,44 @@
+module Debugger
+  # Implements debugger "source" command.
+  class SourceCommand < Command
+    self.allow_in_control = true
+    
+    def regexp
+      /^\s* so(?:urce)? (\s+ -v)? \s+ (.+) $/x
+    end
+    
+    def execute
+      if 3 == @match.size then
+        verbose=true
+        file=@match[2]
+      else
+        verbose=false
+        file=@match[1]
+      end
+        
+      file = File.expand_path(file).strip
+      unless File.exist?(file)
+        errmsg "Command file '#{file}' is not found\n"
+        return
+      end
+      if @state and @state.interface
+        @state.interface.command_queue += File.open(file).readlines
+      else
+        Debugger.run_script(file, @state, verbose)
+      end
+    end
+    
+    class << self
+      def help_command
+        'source'
+      end
+      
+      def help(cmd)
+        %{
+          source FILE\texecutes a file containing debugger commands
+        }
+      end
+    end
+  end
+  
+end

data/cli/ruby-debug/interface.rb

@@ -83,7 +83,7 @@ module Debugger
       end
     end
     
-    def readline_support?(msg)
+    def readline_support?
       @have_readline
     end
 

data/test/cli/commands/catchpoint_test.rb

@@ -2,16 +2,17 @@
 
 require 'test/unit'
 
-BASE_DIR = File.join(File.dirname(__FILE__), '..', '..', '..')
-
-%w(ext lib cli).each do |dir|
-  $: <<  File.join(BASE_DIR, dir)
-end
-
-require File.join(BASE_DIR, 'cli', 'ruby-debug')
-
 class TestCatchCommand < Test::Unit::TestCase
   
+  base_dir = File.expand_path(File.join(File.dirname(__FILE__), 
+                                        '..', '..', '..'))
+  
+  %w(ext lib cli).each do |dir|
+    $: <<  File.join(base_dir, dir)
+  end
+  
+  require File.join(base_dir, 'cli', 'ruby-debug')
+  
   class MockState
     attr_accessor :message 
     def context; end

data/test/cli/commands/unit/regexp.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+
+
+class TestCommandREs < Test::Unit::TestCase
+  base_dir=File.expand_path(File.join(File.dirname(__FILE__), 
+                                      '..', '..', '..', '..',
+                                      'cli', 'ruby-debug'))
+  require File.join(base_dir, 'command')
+  require File.join(base_dir, 'commands', 'frame')
+  include Debugger
+ 
+  def test_up
+    c = UpCommand.new(nil)
+    assert c.regexp.match('up')
+    assert c.regexp.match('up 2')
+    assert c.regexp.match('up 2+5')
+    assert c.regexp.match('u')
+    assert c.regexp.match('u 2')
+    assert_equal nil, c.regexp.match('ufoo')
+  end
+
+  def test_down
+    c = DownCommand.new(nil)
+    assert c.regexp.match('down')
+    assert c.regexp.match('down 2')
+    assert_equal(nil, c.regexp.match('d 2'))
+    assert_equal(nil, c.regexp.match('d'))
+    assert_equal(nil, c.regexp.match('dow'))
+  end
+end
+

data/test/data/annotate.right

@@ -128,9 +128,11 @@ self = main
 error-begin
 No source file named bogus
 
+Breakpoint 3 file bogus, line 5
 breakpoints
 Num Enb What
   2 y   at gcd.rb:12
+  3 y   at bogus:5
 
 display
 

data/test/data/breakpoints.right

@@ -42,16 +42,17 @@ return nil if a <= 0
 # info program
 Program stopped. It stopped at a breakpoint.
 # c 6
-Breakpoint 2 at gcd.rb:10
-gcd.rb:10
-return nil if a <= 0
+Breakpoint 3 at Object:gcd
+gcd.rb:4
+def gcd(a, b)
 # info break
 Num Enb What
   1 y   at gcd.rb:6
 	breakpoint already hit 1 time
   2 y   at gcd.rb:10
-	breakpoint already hit 2 times
+	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # break foo
 *** Invalid breakpoint location: foo.
 # info break
@@ -59,23 +60,26 @@ Num Enb What
   1 y   at gcd.rb:6
 	breakpoint already hit 1 time
   2 y   at gcd.rb:10
-	breakpoint already hit 2 times
+	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # disable  1
 # info break
 Num Enb What
   1 n   at gcd.rb:6
 	breakpoint already hit 1 time
   2 y   at gcd.rb:10
-	breakpoint already hit 2 times
+	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # delete 1
 # # We should see breakpoint 2 but not 1
 # info break
 Num Enb What
   2 y   at gcd.rb:10
-	breakpoint already hit 2 times
+	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # # We should still be able to access 2
 # disable 2
 # disable bar

data/test/data/emacs_basic.right

@@ -42,8 +42,9 @@ return nil if a <= 0
 # info program
 Program stopped. It stopped at a breakpoint.
 # c 10
-gcd.rb:10
-return nil if a <= 0
+Breakpoint 3 at Object:gcd
+gcd.rb:4
+def gcd(a, b)
 # info break
 Num Enb What
   1 y   at gcd.rb:6
@@ -51,6 +52,7 @@ Num Enb What
   2 y   at gcd.rb:10
 	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # break foo
 *** Invalid breakpoint location: foo.
 # info break
@@ -60,6 +62,7 @@ Num Enb What
   2 y   at gcd.rb:10
 	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # disable  1
 # info break
 Num Enb What
@@ -68,6 +71,7 @@ Num Enb What
   2 y   at gcd.rb:10
 	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # enable breakpoint 1
 # enable br 10
 Enable breakpoints argument '10' needs to at most 3.
@@ -78,6 +82,7 @@ Num Enb What
   2 y   at gcd.rb:10
 	breakpoint already hit 1 time
   3 y   at Object:gcd
+	breakpoint already hit 1 time
 # # We should still be able to access 2
 # disable 2
 # enable