ruby-debug 0.1.5 → 0.2

data/CHANGES

@@ -1,3 +1,10 @@
+0.2 (2006-06-17)
+- Added the remote debugging. It should be activated by calling Debugger#start_server method.
+- CHANGED: In order to activate the debugger, it's not enough to require 'ruby-debug'. 
+  Debugger#start method must be called explicitly.
+- Debugger used to evaluate anything you enter as long as it's not a command. Starting from
+  this version the 'eval' command must be used to evaluate an expression.
+
 0.1.5 (2006-06-13)
 - Now the check for a  breakpoint uses base filename of the source file.
 - Removed compilation warnings when compiling with -Wall

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/rdoctask'
 SO_NAME = "ruby_debug.so"
 
 # ------- Default Package ----------
-RUBY_DEBUG_VERSION = "0.1.5"
+RUBY_DEBUG_VERSION = "0.2"
 
 FILES = FileList[
   'Rakefile',
@@ -48,7 +48,6 @@ EOF
   spec.has_rdoc = false
 end
 
-
 # Rake task to build the default package
 Rake::GemPackageTask.new(default_spec) do |pkg|
   pkg.need_tar = true
@@ -57,6 +56,30 @@ end
 
 task :default => [:package]
 
+# Windows specification
+win_spec = default_spec.clone
+win_spec.extensions = []
+win_spec.platform = Gem::Platform::WIN32
+win_spec.files += ["lib/#{SO_NAME}"]
+
+desc "Create Windows Gem"
+task :win32_gem do
+  # Copy the win32 extension the top level directory
+  current_dir = File.expand_path(File.dirname(__FILE__))
+  source = File.join(current_dir, "ext", "win32", SO_NAME)
+  target = File.join(current_dir, "lib", SO_NAME)
+  cp(source, target)
+
+  # Create the gem, then move it to pkg
+	Gem::Builder.new(win_spec).build
+	gem_file = "#{win_spec.name}-#{win_spec.version}-#{win_spec.platform}.gem"
+  mv(gem_file, "pkg/#{gem_file}")
+
+  # Remove win extension fro top level directory	
+	rm(target)
+end
+
+
 desc "Publish ruby-debug to RubyForge."
 task :publish do 
   require 'rake/contrib/sshpublisher'

data/bin/rdebug

@@ -1,13 +1,84 @@
 #!/usr/bin/env ruby
 
-if ARGV.empty?
-  puts "Usage: #{__FILE__} <script>"
-  exit(1)
-end
-
 require 'rubygems'
+require 'optparse'
+require "ostruct"
 require 'ruby-debug'
-trap('INT') { Debugger.interrupt_last }
 
-debugger 2
-load ARGV.shift
+options = OpenStruct.new(
+  'server' => false,
+  'client' => false,
+  'host'   => nil,
+  'port'   => Debugger::PORT
+)
+
+opts = OptionParser.new do |opts|
+  opts.banner = <<EOB
+ruby-debug #{Debugger::VERSION}
+Usage: rdebug [options] <script.rb> <script.rb parameters>
+EOB
+  opts.separator ""
+  opts.separator "Options:"
+  opts.on("-s", "--server", "Listen for remote connections") {options.server = true}
+  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.separator ""
+  opts.separator "Common options:"
+  opts.on_tail("--help", "Show this message") do
+    puts opts
+    exit
+  end
+  opts.on_tail("-v", "--version", "Show version") do
+    puts "ruby-debug #{Debugger::VERSION}"
+    exit
+  end
+end
+
+begin
+  opts.parse! ARGV
+rescue StandardError => e
+  puts opts
+  puts
+  puts e.message
+  exit(-1)
+end
+
+if options.client
+  require "socket"
+  interface = Debugger::LocalInterface.new
+  socket = TCPSocket.new(options.host, options.port)
+  puts "Connected."
+
+  catch(:exit) do
+    while (line = socket.gets)
+      case line 
+      when /^PROMPT (.*)$/
+        input = interface.read_command($1)
+        throw :exit unless input
+        socket.puts input
+      when /^CONFIRM (.*)$/
+        input = interface.confirm($1)
+        throw :exit unless input
+        socket.puts input
+      else
+        print line
+      end
+    end
+  end
+  socket.close
+  puts
+else
+  if ARGV.empty?
+    puts opts
+    puts
+    puts "Must specify a script to run"
+    exit(-1)
+  end
+
+  trap('INT') { Debugger.interrupt_last }
+  Debugger.start_server(options.host, options.port) if options.server
+  Debugger.start
+  debugger 2
+  load ARGV.shift
+end

data/bin/remote

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'socket'
+require "ruby-debug/inputs"
+
+host = ARGV[0] || "localhost"
+port = 8989
+
+input = Debugger::LocalInput.new
+socket = TCPSocket.new(host, port)
+puts "Connected."
+
+catch(:exit) do
+  while (line = socket.gets)
+    case line 
+    when /^PROMPT (.*)$/
+      data = input.read_command($1)
+      throw :exit unless data
+      socket.puts data
+    when /^CONFIRM (.*)$/
+      data = input.confirm($1)
+      throw :exit unless data
+      socket.puts data
+    else
+      print line
+    end
+  end
+end
+socket.close
+puts

data/ext/ruby_debug.c

@@ -4,13 +4,15 @@
 #include <rubysig.h>
 #include <st.h>
 
-#define DEBUG_VERSION "0.1.5"
+#define DEBUG_VERSION "0.2"
 
 typedef struct {
     int thnum;
+    VALUE last_file;
+    VALUE last_line;
+    int moved;
     int stop_next;
     int dest_frame;
-    int src_line;
     int stop_line;
     int stop_frame;
     int suspend;
@@ -43,7 +45,7 @@ static VALUE cContext;
 static VALUE cFrame;
 static VALUE cBreakpoint;
 
-static ID idDebugCommand;
+static ID idAtLine;
 static ID idAtBreakpoint;
 static ID idAtCatchpoint;
 static ID idAtTracing;
@@ -81,6 +83,8 @@ debug_context_mark(void* data)
     debug_context_t *debug_context = (debug_context_t *)data;
     rb_gc_mark(debug_context->frames);
     rb_gc_mark(debug_context->thread);
+    rb_gc_mark(debug_context->last_file);
+    rb_gc_mark(debug_context->last_line);
 }
 
 static VALUE
@@ -91,9 +95,13 @@ debug_context_create(VALUE thread)
     
     debug_context = ALLOC(debug_context_t);
     debug_context-> thnum = ++thnum_max;
+    
+    debug_context->last_file = Qnil;
+    debug_context->last_line = Qnil;
+    debug_context->moved = 0;
+
     debug_context->stop_next = -1;
     debug_context->dest_frame = -1;
-    debug_context->src_line = -1;
     debug_context->stop_line = -1;
     debug_context->stop_frame = -1;
     debug_context->suspend = 0;
@@ -145,16 +153,36 @@ debug_frame_create(VALUE file, VALUE line, VALUE binding, ID id)
     return result;
 }
 
-static VALUE
-call_debug_command(VALUE context, int thnum, VALUE binding, ID mid, VALUE file, VALUE line)
+static void
+save_current_position(VALUE context)
 {
-    VALUE id;
+    VALUE cur_frame;
+    debug_context_t *debug_context;
+    debug_frame_t *debug_frame;
+
+    Data_Get_Struct(context, debug_context_t, debug_context);
+    if(RARRAY(debug_context->frames)->len == 0)
+        return;
+
+    cur_frame = *RARRAY(debug_context->frames)->ptr;
+    Data_Get_Struct(cur_frame, debug_frame_t, debug_frame);
+    
+    debug_context->last_file = debug_frame->file;
+    debug_context->last_line = debug_frame->line;
+    debug_context->moved = 0;
+}
 
-    id = mid ? ID2SYM(mid) : Qnil;
+#define did_moved()   (debug_context->last_line != line || \
+                          debug_context->last_file == Qnil || \
+                          rb_str_cmp(debug_context->last_file, file) != 0)
 
+static VALUE
+call_at_line(VALUE context, int thnum, VALUE binding, VALUE file, VALUE line)
+{
     last_debugged_thnum = thnum;
+    save_current_position(context);
     debug_suspend(mDebugger);
-    return rb_funcall(context, idDebugCommand, 4, file, line, id, binding);
+    return rb_funcall(context, idAtLine, 3, file, line, binding);
 }
 
 static void
@@ -189,7 +217,7 @@ basename(VALUE filename)
 }
 
 static int
-check_breakpoints(VALUE context, VALUE file, VALUE klass, VALUE pos)
+check_breakpoints(debug_context_t *debug_context, VALUE file, VALUE klass, VALUE pos)
 {
     VALUE breakpoint; 
     debug_breakpoint_t *debug_breakpoint;
@@ -197,6 +225,9 @@ check_breakpoints(VALUE context, VALUE file, VALUE klass, VALUE pos)
 
     if(RARRAY(breakpoints)->len == 0)
         return -1;
+    if(!debug_context->moved)
+        return -1;
+    
     for(i = 0; i < RARRAY(breakpoints)->len; i++)
     {
         breakpoint = rb_ary_entry(breakpoints, i);
@@ -282,10 +313,12 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     debug_context_t *debug_context;
     VALUE file = Qnil, line = Qnil;
     int breakpoint_index = -1;
-
+    
     static int debugging = 0;
 
+    if (mid == ID_ALLOCATOR) return;
     if(debugging) return;
+    if(!node) return;
 
     debugging++;
 
@@ -294,11 +327,11 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     Data_Get_Struct(context, debug_context_t, debug_context);
     check_suspend(debug_context);
 
-    if(node)
-    {
-        file = rb_str_new2(node->nd_file);
-        line = INT2FIX(nd_line(node));
-    }
+    file = rb_str_new2(node->nd_file);
+    line = INT2FIX(nd_line(node));
+
+    if(did_moved())
+        debug_context->moved  = 1;
 
     switch(event)
     {
@@ -310,15 +343,15 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
         {
             rb_funcall(context, idAtTracing, 2, file, line);
         }
-
+        
         if(debug_context->dest_frame == -1 || 
             RARRAY(debug_context->frames)->len == debug_context->dest_frame)
         {
             debug_context->stop_next--;
             if(debug_context->stop_next < 0)
-            debug_context->stop_next = -1;
+                debug_context->stop_next = -1;
             /* we check that we actualy moved to another line */
-            if(line != Qnil && debug_context->src_line != FIX2INT(line))
+            if(did_moved())
             {
                 debug_context->stop_line--;
             }
@@ -334,7 +367,7 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
         }
 
         if(debug_context->stop_next == 0 || debug_context->stop_line == 0 ||
-            (breakpoint_index = check_breakpoints(context, file, klass, line)) != -1)
+            (breakpoint_index = check_breakpoints(debug_context, file, klass, line)) != -1)
         {
             binding = self? create_binding(self) : Qnil;
             /* check breakpoint expression */
@@ -342,41 +375,37 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
             {
                 breakpoint = get_breakpoint_at(breakpoint_index);
                 if(check_breakpoint_expression(breakpoint, binding))
-                    rb_funcall(context, idAtBreakpoint, 2, breakpoint, mid ? rb_str_new2(rb_id2name(mid)) : Qnil);
+                    rb_funcall(context, idAtBreakpoint, 1, breakpoint);
                 else
                     break;
             }
 
             /* reset all pointers */
             debug_context->dest_frame = -1;
-            debug_context->src_line = -1;
             debug_context->stop_line = -1;
             debug_context->stop_next = -1;
 
-            call_debug_command(context, debug_context->thnum, binding, mid, file, line);
+            call_at_line(context, debug_context->thnum, binding, file, line);
         }
         break;
         }
     case RUBY_EVENT_C_CALL:
-        {
-        if(node)
         {
             set_frame_source(debug_context, file, line);
-        }
-        break;
+            break;
         }
     case RUBY_EVENT_CALL:
         {
         save_call_frame(self, file, line, mid, debug_context);
-        breakpoint_index = check_breakpoints(context, file, klass, rb_str_new2(rb_id2name(mid)));
+        breakpoint_index = check_breakpoints(debug_context, file, klass, rb_str_new2(rb_id2name(mid)));
         if(breakpoint_index != -1)
         {
             binding = self? create_binding(self) : Qnil;
             breakpoint = get_breakpoint_at(breakpoint_index);
             if(check_breakpoint_expression(breakpoint, binding))
             {
-                rb_funcall(context, idAtBreakpoint, 2, breakpoint, mid ? rb_str_new2(rb_id2name(mid)) : Qnil);
-                call_debug_command(context, debug_context->thnum, binding, mid, file, line);
+                rb_funcall(context, idAtBreakpoint, 1, breakpoint);
+                call_at_line(context, debug_context->thnum, binding, file, line);
             }
         }
         break;
@@ -407,7 +436,7 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
         if( !NIL_P(rb_class_inherited_p(expn_class, rb_eSystemExit)) )
         {
             debug_stop(mDebugger);
-            rb_exit(0);
+            break;
         }
 
         if(catchpoint == Qnil)
@@ -419,10 +448,10 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
             aclass = rb_ary_entry(ancestors, i);
             if(rb_str_cmp(rb_mod_name(aclass), catchpoint) == 0)
             {
-                rb_funcall(context, idAtCatchpoint, 0);
+                rb_funcall(context, idAtCatchpoint, 1, ruby_errinfo);
                 binding = self? create_binding(self) : Qnil;
-                call_debug_command(context, debug_context->thnum, binding, mid, file, line);
-            break;
+                call_at_line(context, debug_context->thnum, binding, file, line);
+                break;
             }
         }
 
@@ -437,18 +466,6 @@ debug_event_hook(rb_event_t event, NODE *node, VALUE self, ID mid, VALUE klass)
     debugging--;
 }
 
-static VALUE
-debug_thnum(VALUE self)
-{
-    VALUE thread, context;
-    debug_context_t *debug_context;
-    
-    thread = rb_thread_current();
-    context = thread_context_lookup(thread);
-    Data_Get_Struct(context, debug_context_t, debug_context);
-    return INT2FIX(debug_context->thnum);
-}
-
 static VALUE
 debug_start(VALUE self)
 {
@@ -743,9 +760,8 @@ context_stop_next(VALUE self, VALUE steps)
 static VALUE
 context_step_over(int argc, VALUE *argv, VALUE self)
 {
-    VALUE lines, frame, cur_frame;
+    VALUE lines, frame;
     debug_context_t *debug_context;
-    debug_frame_t *debug_frame;
 
     debug_check_started();
 
@@ -766,10 +782,6 @@ context_step_over(int argc, VALUE *argv, VALUE self)
         debug_context->dest_frame = FIX2INT(frame);
     }
 
-    cur_frame = *RARRAY(debug_context->frames)->ptr;
-    Data_Get_Struct(cur_frame, debug_frame_t, debug_frame);
-    debug_context->src_line = FIX2INT(debug_frame->line);
-
     return Qnil;
 }
 
@@ -937,7 +949,6 @@ Init_ruby_debug()
     rb_define_module_function(mDebugger, "start", debug_start, 0);
     rb_define_module_function(mDebugger, "stop", debug_stop, 0);
     rb_define_module_function(mDebugger, "started?", debug_is_started, 0);
-    rb_define_module_function(mDebugger, "thnum", debug_thnum, 0);
     rb_define_module_function(mDebugger, "breakpoints", debug_breakpoints, 0);
     rb_define_module_function(mDebugger, "add_breakpoint", debug_add_breakpoint, -1);
     rb_define_module_function(mDebugger, "catchpoint", debug_catchpoint, 0);
@@ -974,7 +985,7 @@ Init_ruby_debug()
     rb_define_method(cBreakpoint, "pos", breakpoint_pos, 0);
     rb_define_method(cBreakpoint, "expr", breakpoint_expr, 0);
 
-    idDebugCommand = rb_intern("debug_command");
+    idAtLine       = rb_intern("at_line");
     idAtBreakpoint = rb_intern("at_breakpoint");
     idAtCatchpoint = rb_intern("at_catchpoint");
     idAtTracing    = rb_intern("at_tracing");

data/lib/ruby-debug/interface.rb

@@ -0,0 +1,69 @@
+module Debugger  
+  class LocalInterface
+    def read_command(prompt)
+      readline(prompt, true)
+    end
+    
+    def confirm(prompt)
+      readline(prompt, false)
+    end
+    
+    def print(*args)
+      STDOUT.printf(*args)
+    end
+    
+    def close
+    end
+    
+    private
+    
+    begin
+      require 'readline'
+      def readline(prompt, hist)
+        Readline::readline(prompt, hist)
+      end
+    rescue LoadError
+      def readline(prompt, hist)
+        STDOUT.print prompt
+        STDOUT.flush
+        line = STDIN.gets
+        exit unless line
+        line.chomp!
+        line
+      end
+      USE_READLINE = false
+    end
+  end
+
+  class RemoteInterface
+    def initialize(socket)
+      @socket = socket
+    end
+    
+    def read_command(prompt)
+      send_command "PROMPT #{prompt}"
+    end
+    
+    def confirm(prompt)
+      send_command "CONFIRM #{prompt}"
+    end
+
+    def print(*args)
+      @socket.printf(*args)
+    end
+    
+    def close
+      @socket.close
+    rescue Exception
+    end
+    
+    private
+    
+    def send_command(msg)
+      @socket.puts msg
+      result = @socket.gets
+      raise IOError unless result
+      result.chomp
+    end
+  end
+end