ruby-debug 0.3-mswin32 → 0.4-mswin32

data/CHANGES

@@ -1,3 +1,15 @@
+0.4 
+- Debugger.start method takes a block. If a block is specified, this method starts debugger, yields to the block
+  and stops debugger at the end.
+- 'tm[ate]' command accepts a frame number now.
+- 'list' command accepts on/off parameter which controls whether listing will be displayed on every stop.
+- 'eval on/off' controls the evaluation of unknown command.
+- Debugger reads readline history file .rdebug_hist at startup and saves it at exit.
+- 'sa[ve] <file>' command can be used to save current breackpoints and catchpoint if any
+- 'sc[ript] <file' command can be used to run script file. Script files can contain only control commands.
+- rdebug script accepts '--script FILE' parameter.
+- thread commands are available for the control port.
+
 0.3 (2006-08-07)
 - Renamed Debugger.start_server to Debugger.start_remote.
 - Debugger.start_remote activates debugger by calling Debugger.start.

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/rdoctask'
 SO_NAME = "ruby_debug.so"
 
 # ------- Default Package ----------
-RUBY_DEBUG_VERSION = "0.3"
+RUBY_DEBUG_VERSION = "0.4"
 
 FILES = FileList[
   'Rakefile',

data/bin/rdebug

@@ -12,7 +12,8 @@ options = OpenStruct.new(
   'port'   => Debugger::PORT,
   'cport'  => Debugger::PORT + 1,
   'wait'   => false,
-  'nostop' => false
+  'nostop' => false,
+  'script' => nil
 )
 
 opts = OptionParser.new do |opts|
@@ -28,6 +29,12 @@ EOB
   opts.on("-c", "--client", "Connect to remote debugger") {options.client = true}
   opts.on("-h", "--host HOST", "Host name used for remote debugging") {|options.host|}
   opts.on("-p", "--port PORT", Integer, "Port used for remote debugging") {|options.port|}
+  opts.on("--script FILE", String, "Name of the script file to run") do |options.script| 
+    unless File.exists?(options.script)
+      puts "Script file '#{options.script}' is not found"
+      exit
+    end
+  end
   opts.on("--cport PORT", Integer, "Port used for contol commands, implies -s option") {|options.port|}
   opts.separator ""
   opts.separator "Common options:"
@@ -67,6 +74,9 @@ else
     Debugger.start_remote(options.host, [options.port, options.cport])
   else
     Debugger.start
+    if options.script
+      Debugger.run_script(options.script)
+    end
     debugger 2
   end
   load ARGV.shift

data/ext/ruby_debug.c

@@ -4,7 +4,7 @@
 #include <rubysig.h>
 #include <st.h>
 
-#define DEBUG_VERSION "0.3"
+#define DEBUG_VERSION "0.4"
 
 typedef struct {
     int thnum;
@@ -62,16 +62,18 @@ static VALUE debug_suspend(VALUE);
 static VALUE create_binding(VALUE);
 static VALUE debug_stop(VALUE);
 
+#define IS_STARTED  (threads_tbl != Qnil)
+
 static VALUE
 debug_is_started(VALUE self)
 {
-    return threads_tbl != Qnil ? Qtrue : Qfalse;
+    return IS_STARTED ? Qtrue : Qfalse;
 }
 
 static void
 debug_check_started()
 {
-    if(threads_tbl == Qnil)
+    if(!IS_STARTED)
     {
         rb_raise(rb_eRuntimeError, "Debugger.start is not called yet.");
     }
@@ -181,7 +183,7 @@ call_at_line_unprotected(VALUE args)
 {
     VALUE context;
     context = *RARRAY(args)->ptr;
-    rb_funcall2(context, idAtLine, RARRAY(args)->len - 1, RARRAY(args)->ptr + 1);
+    return rb_funcall2(context, idAtLine, RARRAY(args)->len - 1, RARRAY(args)->ptr + 1);
 }
 
 static VALUE
@@ -478,9 +480,20 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     debugging--;
 }
 
+static VALUE
+debug_stop_i(VALUE value)
+{
+    if(IS_STARTED)
+        debug_stop(value);
+    return Qnil;
+}
+
 static VALUE
 debug_start(VALUE self)
 {
+    if(IS_STARTED)
+        return Qnil;
+        
     threads_tbl = rb_hash_new();
     breakpoints = rb_ary_new();
     waiting     = rb_ary_new();
@@ -490,6 +503,10 @@ debug_start(VALUE self)
         RUBY_EVENT_CALL | RUBY_EVENT_RETURN | RUBY_EVENT_CLASS |
         RUBY_EVENT_END | RUBY_EVENT_RAISE
         );
+    
+    if(rb_block_given_p())
+        return rb_ensure(rb_yield, Qnil, debug_stop_i, Qnil);
+    
     return Qnil;
 }
 

data/lib/ruby-debug.rb

@@ -89,7 +89,7 @@ module Debugger
         cmd_port, ctrl_port = port, port + 1
       end
 
-      @control_tread = Thread.start do
+      @control_thread = Thread.start do
         server = TCPServer.new(host, ctrl_port)
         while (session = server.accept)
           interface = RemoteInterface.new(session)
@@ -176,6 +176,13 @@ module Debugger
       end
       return "\n"
     end
+
+    # runs a script file
+    def run_script(file, out = processor.interface)
+      interface = ScriptInterface.new(file, out)
+      processor = ControlCommandProcessor.new(interface)
+      processor.process_commands
+    end
   end
 end
 

data/lib/ruby-debug/command.rb

@@ -5,11 +5,17 @@ module Debugger
         @commands ||= []
       end
       
+      DEF_OPTIONS = {
+        :event => true, 
+        :control => false, 
+        :always_run => false,
+        :unknown => false,
+      }
+      
       def inherited(klass)
-        klass.instance_variable_set("@event", 
-          klass.instance_variable_get("@event") || true)
-        klass.instance_variable_set("@control", 
-          klass.instance_variable_get("@control") || false)
+        DEF_OPTIONS.each do |o, v|
+          klass.options[o] = v if klass.options[o].nil?
+        end
         commands << klass
       end
 
@@ -20,8 +26,21 @@ module Debugger
         end
       end
       
-      attr_accessor :control
-      attr_accessor :event
+      def method_missing(meth, *args, &block)
+        if meth.to_s =~ /^(.+?)=$/
+          @options[$1.intern] = args.first
+        else
+          if @options.has_key?(meth)
+            @options[meth]
+          else
+            super
+          end
+        end
+      end
+      
+      def options
+        @options ||= {}
+      end
     end
     
     def initialize(state)

data/lib/ruby-debug/commands/control.rb

@@ -8,6 +8,7 @@ module Debugger
 
     def execute
       if confirm("Really quit? (y/n) ")
+        Debugger.save_history if Debugger.respond_to? :save_history
         exit! # exit -> exit!: No graceful way to stop threads...
       end
     end

data/lib/ruby-debug/commands/display.rb

@@ -33,6 +33,7 @@ module Debugger
   end
 
   class DisplayCommand < Command
+    self.always_run = true
     include DisplayFunctions
     
     def initialize(state)

data/lib/ruby-debug/commands/eval.rb

@@ -1,11 +1,22 @@
 module Debugger
   class EvalCommand < Command
+    def match(input)
+      @input = input
+      super
+    end
+    
     def regexp
-      /^\s*(\s*p|e(?:val)?)\s+/
+      /^\s*(p|e(?:val)?)(?:\s+(on|off)|\s+)/
     end
 
     def execute
-      print "%s\n", debug_eval(@match.post_match).inspect
+      if @match && @match[1] != 'p' && %w[on off].include?(@match[2])
+        self.class.unknown = @match[2] == 'on'
+        print "Evaluation of unknown command is #{self.class.unknown ? 'on': 'off'}.\n"
+        return
+      end
+      expr = @match ? @match.post_match : @input
+      print "%s\n", debug_eval(expr).inspect
     end
 
     class << self
@@ -21,7 +32,8 @@ module Debugger
         else
           %{
             e[val] expression\tevaluate expression and print its value,
-            \t\t\talias for p
+            \t\t\talias for p.
+            e[val] on/off\t\twhen 'on', debugger will evaluate every unknown command.
           }
         end
       end

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

@@ -1,11 +1,11 @@
 module Debugger
   class ListCommand < Command
     def regexp
-      /^\s*l(?:ist)?(?:\s+(.+))?$/
+      /^\s*l(?:ist)?(?:\s*(.+))?$/
     end
 
     def execute
-      if not @match[1]
+      if !@match || !@match[1]
         b = @state.previous_line ? @state.previous_line + 10 : @state.line - 5
         e = b + 9
       elsif @match[1] == '-'
@@ -15,6 +15,14 @@ module Debugger
         @state.previous_line = nil
         b = @state.line - 5
         e = b + 9
+      elsif @match[1] == 'on'
+        self.class.always_run = true
+        print "Listing is on.\n"
+        return
+      elsif @match[1] == 'off'
+        self.class.always_run = false
+        print "Listing is off.\n"
+        return
       else
         b, e = @match[1].split(/[-,]/)
         if e
@@ -40,6 +48,7 @@ module Debugger
           l[ist] -\tlist backward
           l[ist] =\tlist current line
           l[ist] nn-mm\tlist given lines
+          l[ist] on/off\tprint listing on every stop
         }
       end
     end

data/lib/ruby-debug/commands/script.rb

@@ -0,0 +1,59 @@
+module Debugger
+  class ScriptCommand < Command
+    self.control = true
+    
+    def regexp
+      /^\s*sc(?:ript)?\s+(.+)$/
+    end
+    
+    def execute
+      unless File.exists?(@match[1])
+        print "Script file '#{@match[1]}' is not found\n"
+        return
+      end
+      Debugger.run_script(@match[1], @state)
+    end
+    
+    class << self
+      def help_command
+        'script'
+      end
+      
+      def help(cmd)
+        %{
+          script FILE\texecutes a script file
+        }
+      end
+    end
+  end
+  
+  class SaveCommand < Command
+    self.control = true
+    
+    def regexp
+      /^\s*sa(?:ve)?\s+(.+)$/
+    end
+    
+    def execute
+      open(@match[1], 'w') do |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
+      print "Saved to '#{@match[1]}'\n"
+    end
+
+    class << self
+      def help_command
+        'save'
+      end
+      
+      def help(cmd)
+        %{
+          save FILE\tsaves current breakpoints and catchpoint as a script file
+        }
+      end
+    end
+  end
+end

data/lib/ruby-debug/commands/threads.rb

@@ -1,11 +1,9 @@
 module Debugger
   module ThreadFunctions
     def display_context(c)
-      if c.thread == Thread.current
-        print "+"
-      else
-        print " "
-      end
+      c_flag = c.thread == Thread.current ? '+' : ' '
+      d_flag = debugger_thread?(c) ? '!' : ' '
+      print "%s%s", c_flag, d_flag
       print "%d ", c.thnum
       print "%s\t", c.thread.inspect
       last_frame = c.frames.first
@@ -14,9 +12,14 @@ module Debugger
       end
       print "\n"
     end
+    
+    def debugger_thread?(c)
+      [Debugger.thread, Debugger.control_thread].include?(c.thread)
+    end
   end
 
   class ThreadListCommand < Command
+    self.control = true
     include ThreadFunctions
 
     def regexp
@@ -43,6 +46,7 @@ module Debugger
   end
 
   class ThreadSwitchCommand < Command
+    self.control = true
     include ThreadFunctions
 
     def regexp
@@ -51,8 +55,11 @@ module Debugger
 
     def execute
       c = get_context(@match[1].to_i)
-      if c == @state.context
+      case
+      when c == @state.context
         print "It's the current thread.\n"
+      when debugger_thread?(c)
+        print "Can't switch to the debugger thread.\n"
       else
         display_context(c)
         c.stop_next = 1
@@ -75,6 +82,7 @@ module Debugger
   end
 
   class ThreadStopCommand < Command
+    self.control = true
     include ThreadFunctions
 
     def regexp
@@ -83,9 +91,12 @@ module Debugger
 
     def execute
       c = get_context(@match[1].to_i)
-      if c == @state.context
+      case
+      when c == @state.context
         print "It's the current thread.\n"
-      elsif c.thread.stop?
+      when debugger_thread?(c)
+        print "Can't stop the debugger thread.\n"
+      when c.thread.stop?
         print "Already stopped.\n"
       else
         display_context(c)
@@ -131,6 +142,7 @@ module Debugger
   end
 
   class ThreadResumeCommand < Command
+    self.control = true
     include ThreadFunctions
 
     def regexp
@@ -139,9 +151,12 @@ module Debugger
 
     def execute
       c = get_context(@match[1].to_i)
-      if c == @state.context
+      case
+      when c == @state.context
         print "It's the current thread.\n"
-      elsif !c.thread.stop?
+      when debugger_thread?(c)
+        print "Can't resume the debugger thread.\n"
+      when !c.thread.stop?
         print "Already running."
       else
         display_context(c)

data/lib/ruby-debug/commands/tmate.rb

@@ -2,11 +2,22 @@ module Debugger
   if RUBY_PLATFORM =~ /darwin/
     class TextMateCommand < Command
       def regexp
-        /^\s*tm(?:ate)?$/
+        /^\s*tm(?:ate)?(?:\s*(\d+))?$/
       end
 
       def execute
-        %x|open 'txmt://open?url=file://#{File.expand_path(@state.file)}&line=#{@state.line}'|
+        if @match[1]
+          frm_n = @match[1].to_i
+          if frm_n > @state.context.frames.size || frm_n == 0
+            print "Wrong frame number\n"
+            return
+          end
+          frame = @state.context.frames[frm_n - 1]
+          file, line = frame.file, frame.line
+        else
+          file, line = @state.file, @state.line
+        end
+        %x|open 'txmt://open?url=file://#{File.expand_path(file)}&line=#{line}'|
       end
 
       class << self
@@ -16,7 +27,8 @@ module Debugger
 
         def help(cmd)
           %{
-            tm[ate]\topens a current file in TextMate
+            tm[ate] n\topens a current file in TextMate. 
+            \t\tIt uses n-th frame if arg (n) is specifed.
           }
         end
       end

data/lib/ruby-debug/interface.rb

@@ -19,6 +19,26 @@ module Debugger
     
     begin
       require 'readline'
+      FILE_HISTORY = ".rdebug_hist"
+      
+      save_file = File.join(Dir.getwd, FILE_HISTORY)
+      open(save_file, 'r') do |file|
+        file.each do |line|
+          line.chomp!
+          Readline::HISTORY << line
+        end
+      end if File.exists?(save_file)
+
+      class << Debugger; self end.send('define_method', 'save_history') do
+        open(save_file, 'w') do |file|
+          Readline::HISTORY.each do |line|
+            file.puts line
+          end
+        end
+      end
+      class << Debugger; public :save_history end
+      at_exit { Debugger.save_history }
+      
       def readline(prompt, hist)
         Readline::readline(prompt, hist)
       end
@@ -66,4 +86,33 @@ module Debugger
       result.chomp
     end
   end
+  
+  class ScriptInterface
+    def initialize(file, out)
+      @file = open(file)
+      @out = out
+    end
+    
+    def read_command(prompt)
+      while result = @file.gets
+        next if result =~ /^\s*#/
+        next if result.strip.empty?
+        break
+      end
+      raise IOError unless result
+      result
+    end
+    
+    def confirm(prompt)
+      'y'
+    end
+    
+    def print(*args)
+      @out.print(*args)
+    end
+    
+    def close
+      @file.close
+    end
+  end
 end

data/lib/ruby-debug/processor.rb

@@ -85,7 +85,7 @@ module Debugger
         s.commands = event_cmds
       end
       commands = event_cmds.map{|cmd| cmd.new(state) }
-      commands.find{ |cmd| cmd.kind_of?(DisplayCommand) }.execute
+      commands.select{|cmd| cmd.class.always_run }.each{|cmd| cmd.execute }
       
       while !state.proceed? and input = @interface.read_command("(rdb:%d) " % context.thnum)
         catch(:debug_error) do
@@ -99,7 +99,12 @@ module Debugger
           if cmd = commands.find{ |c| c.match(input) }
             cmd.execute
           else
-            print "Unknown command\n"
+            unknown_cmd = commands.find{|cmd| cmd.class.unknown }
+            if unknown_cmd
+              unknown_cmd.execute
+            else
+              print "Unknown command\n"
+            end
           end
         end
       end
@@ -161,6 +166,8 @@ module Debugger
     rescue Exception
       print "INTERNAL ERROR!!! #{$!}\n"
       print $!.backtrace.map{|l| "\t#{l}"}.join("\n")
+    ensure
+      @interface.close
     end
     
     class State
@@ -180,6 +187,10 @@ module Debugger
       def confirm(*args)
         'y'
       end
+      
+      def context
+        nil
+      end
 
       def file
         print "No filename given.\n"

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-debug
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2006-08-13 16:55:45 -04:00
+  version: "0.4"
+date: 2006-08-24 23:57:48 -04:00
 summary: Fast Ruby debugger
 require_paths: 
 - lib
@@ -49,6 +49,7 @@ files:
 - lib/ruby-debug/commands/help.rb
 - lib/ruby-debug/commands/list.rb
 - lib/ruby-debug/commands/method.rb
+- lib/ruby-debug/commands/script.rb
 - lib/ruby-debug/commands/stepping.rb
 - lib/ruby-debug/commands/threads.rb
 - lib/ruby-debug/commands/tmate.rb