ruby-debug 0.4.1 → 0.4.2

data/CHANGES

@@ -1,3 +1,8 @@
+0.4.2
+- Module#deubg_method added.
+- Added rdoc.
+- Bugfixes.
+
 0.4.1
 - New binding_n method for Kernel module.
 - Bugfixes.

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/rdoctask'
 SO_NAME = "ruby_debug.so"
 
 # ------- Default Package ----------
-RUBY_DEBUG_VERSION = "0.4.1"
+RUBY_DEBUG_VERSION = "0.4.2"
 
 FILES = FileList[
   'Rakefile',
@@ -14,6 +14,7 @@ FILES = FileList[
   'CHANGES',
   'lib/**/*',
   'ext/*',
+  'doc/*',
   'bin/*'
 ]
 
@@ -45,7 +46,7 @@ EOF
   spec.rubyforge_project = 'ruby-debug'
   
   # rdoc
-  spec.has_rdoc = false
+  spec.has_rdoc = true
 end
 
 # Rake task to build the default package
@@ -99,4 +100,20 @@ task :clean do
       rm "Makefile"
     end
   end
-end
+end
+
+# ---------  RDoc Documentation ------
+desc "Generate rdoc documentation"
+Rake::RDocTask.new("rdoc") do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "ruby-debug"
+  # Show source inline with line numbers
+  rdoc.options << "--inline-source" << "--line-numbers"
+  # Make the readme file the start page for the generated html
+  rdoc.options << '--main' << 'README'
+  rdoc.rdoc_files.include('bin/**/*',
+                          'lib/**/*.rb',
+                          'ext/**/ruby_debug.c',
+                          'README',
+                          'LICENSE')
+end

data/bin/rdebug

@@ -19,7 +19,7 @@ options = OpenStruct.new(
 opts = OptionParser.new do |opts|
   opts.banner = <<EOB
 ruby-debug #{Debugger::VERSION}
-Usage: rdebug [options] <script.rb> <script.rb parameters>
+Usage: rdebug [options] <script.rb> -- <script.rb parameters>
 EOB
   opts.separator ""
   opts.separator "Options:"

data/ext/ruby_debug.c

@@ -4,7 +4,7 @@
 #include <rubysig.h>
 #include <st.h>
 
-#define DEBUG_VERSION "0.4.1"
+#define DEBUG_VERSION "0.4.2"
 
 typedef struct {
     int thnum;
@@ -59,6 +59,7 @@ static ID idList;
 static ID idClear;
 static ID idIndex;
 
+static int start_count = 0;
 static int thnum_max = 0;
 static int last_debugged_thnum = -1;
 
@@ -68,6 +69,12 @@ static VALUE debug_stop(VALUE);
 
 #define IS_STARTED  (threads_tbl != Qnil)
 
+/*
+ *   call-seq:
+ *      Debugger.started? -> bool
+ *   
+ *   Returns +true+ the debugger is started.
+ */
 static VALUE
 debug_is_started(VALUE self)
 {
@@ -512,11 +519,26 @@ debug_stop_i(VALUE value)
     return Qnil;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.start -> bool
+ *      Debugger.start { ... } -> obj
+ *   
+ *   This method activates the debugger. 
+ *   If it's called without a block it returns +true+, unless debugger was already started.
+ *   If a block is given, it starts debugger and yields to block. At the end of stops the debugger
+ *   with Debugger.stop method.
+ *
+ *   <i>Note that if you want to stop debugger, you must call Debugger.stop as many time as you 
+ *   called Debugger.start method.</i>
+ */
 static VALUE
 debug_start(VALUE self)
 {
+    start_count++;
+    
     if(IS_STARTED)
-        return Qnil;
+        return Qfalse;
         
     threads_tbl = rb_hash_new();
     breakpoints = rb_ary_new();
@@ -531,20 +553,35 @@ debug_start(VALUE self)
     if(rb_block_given_p())
         return rb_ensure(rb_yield, Qnil, debug_stop_i, Qnil);
     
-    return Qnil;
+    return Qtrue;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.stop -> bool
+ *   
+ *   This method disacivates the debugger. It returns +true+ if the debugger is disacivated, 
+ *   otherwise it returns +false+.
+ *
+ *   <i>Note that if you want to stop debugger, you must call Debugger.stop as many time as you 
+ *   called Debugger.start method.</i>
+ */
 static VALUE
 debug_stop(VALUE self)
 {
     debug_check_started();
+    
+    start_count--;
+    if(start_count)
+        return Qfalse;
+    
     rb_remove_event_hook(debug_event_hook);
 
     waiting     = Qnil;
     breakpoints = Qnil;
     threads_tbl = Qnil;
 
-    return Qnil;
+    return Qtrue;
 }
 
 static void
@@ -557,6 +594,16 @@ breakpoint_mark(void *data)
     rb_gc_mark(breakpoint->expr);
 }
 
+/*
+ *   call-seq:
+ *      Debugger.add_breakpoint(source, pos, condition = nil) -> breakpoint
+ *   
+ *   Adds a new breakpoint.
+ *   <i>source</i> is a name of a file or a class.
+ *   <i>pos</i> is a line number or a method name if <i>source</i> is a class name.
+ *   <i>condition</i> is a string which is evaluated to +true+ when this breakpoint
+ *   is activated.
+ */
 static VALUE
 debug_add_breakpoint(int argc, VALUE *argv, VALUE self)
 {
@@ -580,6 +627,12 @@ debug_add_breakpoint(int argc, VALUE *argv, VALUE self)
     return result;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.breakpoints -> array
+ *   
+ *   Returns an array of breakpoints.
+ */
 static VALUE
 debug_breakpoints(VALUE self)
 {
@@ -588,6 +641,13 @@ debug_breakpoints(VALUE self)
     return breakpoints;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.checkpoint -> string
+ *   
+ *   Returns a current checkpoint, which is a name of exception that will 
+ *   trigger a debugger when raised.
+ */
 static VALUE
 debug_catchpoint(VALUE self)
 {
@@ -596,6 +656,12 @@ debug_catchpoint(VALUE self)
     return catchpoint;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.checkpoint = string -> string
+ *   
+ *   Sets checkpoint.
+ */
 static VALUE
 debug_set_catchpoint(VALUE self, VALUE value)
 {
@@ -624,6 +690,12 @@ find_last_context_func(VALUE key, VALUE value, VALUE *result)
     return ST_CONTINUE;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.last_interrupted -> context
+ *   
+ *   Returns last debugged context.
+ */
 static VALUE
 debug_last_interrupted(VALUE self)
 {
@@ -635,6 +707,13 @@ debug_last_interrupted(VALUE self)
     return result;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.current_context -> context
+ *   
+ *   Returns current context. 
+ *   <i>Note:</i> Debugger.current_context.thread == Thread.current
+ */
 static VALUE
 debug_current_context(VALUE self)
 {
@@ -648,6 +727,12 @@ debug_current_context(VALUE self)
     return context;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.contexts -> array
+ *   
+ *   Returns an array of all contexts.
+ */
 static VALUE
 debug_contexts(VALUE self)
 {
@@ -681,6 +766,12 @@ debug_contexts(VALUE self)
     return new_list;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.suspend -> Debugger
+ *   
+ *   Suspends all contexts.
+ */
 static VALUE
 debug_suspend(VALUE self)
 {
@@ -713,6 +804,12 @@ debug_suspend(VALUE self)
     return self;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.resume -> Debugger
+ *   
+ *   Resumes all contexts.
+ */
 static VALUE
 debug_resume(VALUE self)
 {
@@ -751,12 +848,24 @@ debug_resume(VALUE self)
     return self;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.tracing -> bool
+ *   
+ *   Returns +true+ is a global tracing is activated.
+ */
 static VALUE
 debug_tracing(VALUE self)
 {
     return tracing;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.tracing = bool
+ *   
+ *   Sets a global tracing flag.
+ */
 static VALUE
 debug_set_tracing(VALUE self, VALUE value)
 {
@@ -764,6 +873,12 @@ debug_set_tracing(VALUE self, VALUE value)
     return value;
 }
 
+/*
+ *   call-seq:
+ *      context.stop_next = steps
+ *   
+ *   Stops the current context after a number +steps+ are made.
+ */
 static VALUE
 context_stop_next(VALUE self, VALUE steps)
 {
@@ -779,6 +894,12 @@ context_stop_next(VALUE self, VALUE steps)
     return steps;
 }
 
+/*
+ *   call-seq:
+ *      context.step_over(steps)
+ *   
+ *   Steps over a +steps+ number of times.
+ */
 static VALUE
 context_step_over(int argc, VALUE *argv, VALUE self)
 {
@@ -807,6 +928,12 @@ context_step_over(int argc, VALUE *argv, VALUE self)
     return Qnil;
 }
 
+/*
+ *   call-seq:
+ *      context.stop_frame(frame)
+ *   
+ *   Stops when a frame with number +frame+ is activated. Implements +up+ and +down+ commands.
+ */
 static VALUE
 context_stop_frame(VALUE self, VALUE frame)
 {
@@ -822,6 +949,12 @@ context_stop_frame(VALUE self, VALUE frame)
     return frame;
 }
 
+/*
+ *   call-seq:
+ *      context.frames -> array
+ *   
+ *   Returns an array of frames.
+ */
 static VALUE
 context_frames(VALUE self)
 {
@@ -831,6 +964,12 @@ context_frames(VALUE self)
     return debug_context->frames;
 }
 
+/*
+ *   call-seq:
+ *      context.thread -> trhread
+ *   
+ *   Returns a thread this context is associated with.
+ */
 static VALUE
 context_thread(VALUE self)
 {
@@ -840,6 +979,12 @@ context_thread(VALUE self)
     return debug_context->thread;
 }
 
+/*
+ *   call-seq:
+ *      context.thnum -> int
+ *   
+ *   Returns the context's number.
+ */
 static VALUE
 context_thnum(VALUE self)
 {
@@ -849,6 +994,12 @@ context_thnum(VALUE self)
     return INT2FIX(debug_context->thnum);
 }
 
+/*
+ *   call-seq:
+ *      context.set_suspend -> nil
+ *   
+ *   Suspends the thread when it is running.
+ */
 static VALUE
 context_set_suspend(VALUE self)
 {
@@ -861,6 +1012,12 @@ context_set_suspend(VALUE self)
     return Qnil;
 }
 
+/*
+ *   call-seq:
+ *      context.clear_suspend -> nil
+ *   
+ *   Clears a suspend flag.
+ */
 static VALUE
 context_clear_suspend(VALUE self)
 {
@@ -873,6 +1030,12 @@ context_clear_suspend(VALUE self)
     return Qnil;
 }
 
+/*
+ *   call-seq:
+ *      context.tracing -> bool
+ *   
+ *   Returns the tracing flag for the current context.
+ */
 static VALUE
 context_tracing(VALUE self)
 {
@@ -884,6 +1047,12 @@ context_tracing(VALUE self)
     return debug_context->tracing ? Qtrue : Qfalse;
 }
 
+/*
+ *   call-seq:
+ *      context.tracking = bool
+ *   
+ *   Controls the tracing for this context.
+ */
 static VALUE
 context_set_tracing(VALUE self, VALUE value)
 {
@@ -896,6 +1065,12 @@ context_set_tracing(VALUE self, VALUE value)
     return value;
 }
 
+/*
+ *   call-seq:
+ *      frame.file -> string
+ *   
+ *   Returns the name of the file.
+ */
 static VALUE
 frame_file(VALUE self)
 {
@@ -905,6 +1080,12 @@ frame_file(VALUE self)
     return debug_frame->file;
 }
 
+/*
+ *   call-seq:
+ *      frame.line -> int
+ *   
+ *   Returns the line number in the file.
+ */
 static VALUE
 frame_line(VALUE self)
 {
@@ -914,6 +1095,12 @@ frame_line(VALUE self)
     return debug_frame->line;
 }
 
+/*
+ *   call-seq:
+ *      frame.binding -> binding
+ *   
+ *   Returns the binding captured at the moment this frame was created.
+ */
 static VALUE
 frame_binding(VALUE self)
 {
@@ -923,6 +1110,12 @@ frame_binding(VALUE self)
     return debug_frame->binding;
 }
 
+/*
+ *   call-seq:
+ *      frame.id -> sym
+ *   
+ *   Returns the sym of the called method.
+ */
 static VALUE
 frame_id(VALUE self)
 {
@@ -932,6 +1125,12 @@ frame_id(VALUE self)
     return debug_frame->id ? ID2SYM(debug_frame->id): Qnil;
 }
 
+/*
+ *   call-seq:
+ *      breakpoint.source -> string
+ *   
+ *   Returns a source of the breakpoint.
+ */
 static VALUE
 breakpoint_source(VALUE self)
 {
@@ -941,6 +1140,12 @@ breakpoint_source(VALUE self)
     return breakpoint->source;
 }
 
+/*
+ *   call-seq:
+ *      breakpoint.pos -> string or int
+ *   
+ *   Returns a position of this breakpoint.
+ */
 static VALUE
 breakpoint_pos(VALUE self)
 {
@@ -950,6 +1155,12 @@ breakpoint_pos(VALUE self)
     return breakpoint->pos;
 }
 
+/*
+ *   call-seq:
+ *      breakpoint.expr -> string
+ *   
+ *   Returns a codition expression when this breakpoint should be activated.
+ */
 static VALUE
 breakpoint_expr(VALUE self)
 {
@@ -959,30 +1170,18 @@ breakpoint_expr(VALUE self)
     return breakpoint->expr;
 }
 
-
-#if defined(_WIN32)
-__declspec(dllexport) 
-#endif
-void
-Init_ruby_debug()
+/*
+ *   Document-class: Context
+ *   
+ *   == Summary
+ *   
+ *   Debugger keeps a single instance of this class for each Ruby thread. 
+ *   This class provides access to stack frames (see Frame class). Also it
+ *   gives you ability to step thought the code.
+ */
+static void
+Init_context()
 {
-    mDebugger = rb_define_module("Debugger");
-    rb_define_const(mDebugger, "VERSION", rb_str_new2(DEBUG_VERSION));
-    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, "breakpoints", debug_breakpoints, 0);
-    rb_define_module_function(mDebugger, "add_breakpoint", debug_add_breakpoint, -1);
-    rb_define_module_function(mDebugger, "catchpoint", debug_catchpoint, 0);
-    rb_define_module_function(mDebugger, "catchpoint=", debug_set_catchpoint, 1);
-    rb_define_module_function(mDebugger, "last_context", debug_last_interrupted, 0);
-    rb_define_module_function(mDebugger, "contexts", debug_contexts, 0);
-    rb_define_module_function(mDebugger, "current_context", debug_current_context, 0);
-    rb_define_module_function(mDebugger, "suspend", debug_suspend, 0);
-    rb_define_module_function(mDebugger, "resume", debug_resume, 0);
-    rb_define_module_function(mDebugger, "tracing", debug_tracing, 0);
-    rb_define_module_function(mDebugger, "tracing=", debug_set_tracing, 1);
-
     cContext = rb_define_class_under(mDebugger, "Context", rb_cObject);
     rb_define_method(cContext, "stop_next=", context_stop_next, 1);
     rb_define_method(cContext, "step_over", context_step_over, -1);
@@ -994,17 +1193,76 @@ Init_ruby_debug()
     rb_define_method(cContext, "clear_suspend", context_clear_suspend, 0);
     rb_define_method(cContext, "tracing", context_tracing, 0);
     rb_define_method(cContext, "tracing=", context_set_tracing, 1);
+}
 
+/*
+ *   Document-class: Frame
+ *   
+ *   == Summary
+ *   
+ *   This class holds infomation about a particular call frame.
+ */
+static void
+Init_frame()
+{
     cFrame = rb_define_class_under(cContext, "Frame", rb_cObject);
     rb_define_method(cFrame, "file", frame_file, 0);
     rb_define_method(cFrame, "line", frame_line, 0);
     rb_define_method(cFrame, "binding", frame_binding, 0);
     rb_define_method(cFrame, "id", frame_id, 0);
+}
 
+/*
+ *   Document-class: Breakpoint
+ *   
+ *   == Summary
+ *   
+ *   This class represents a breakpoint. It defines position of the breakpoint and 
+ *   condition when this breakpoint should be triggered.
+ */
+static void
+Init_breakpoint()
+{
     cBreakpoint = rb_define_class_under(mDebugger, "Breakpoint", rb_cObject);
     rb_define_method(cBreakpoint, "source", breakpoint_source, 0);
     rb_define_method(cBreakpoint, "pos", breakpoint_pos, 0);
     rb_define_method(cBreakpoint, "expr", breakpoint_expr, 0);
+}
+
+/*
+ *   Document-class: Debugger
+ *   
+ *   == Summary
+ *   
+ *   This is a singleton class allows controlling the debugger. Use it to start/stop debugger, 
+ *   set/remove breakpoints, etc.
+ */
+#if defined(_WIN32)
+__declspec(dllexport) 
+#endif
+void
+Init_ruby_debug()
+{
+    mDebugger = rb_define_module("Debugger");
+    rb_define_const(mDebugger, "VERSION", rb_str_new2(DEBUG_VERSION));
+    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, "breakpoints", debug_breakpoints, 0);
+    rb_define_module_function(mDebugger, "add_breakpoint", debug_add_breakpoint, -1);
+    rb_define_module_function(mDebugger, "catchpoint", debug_catchpoint, 0);
+    rb_define_module_function(mDebugger, "catchpoint=", debug_set_catchpoint, 1);
+    rb_define_module_function(mDebugger, "last_context", debug_last_interrupted, 0);
+    rb_define_module_function(mDebugger, "contexts", debug_contexts, 0);
+    rb_define_module_function(mDebugger, "current_context", debug_current_context, 0);
+    rb_define_module_function(mDebugger, "suspend", debug_suspend, 0);
+    rb_define_module_function(mDebugger, "resume", debug_resume, 0);
+    rb_define_module_function(mDebugger, "tracing", debug_tracing, 0);
+    rb_define_module_function(mDebugger, "tracing=", debug_set_tracing, 1);
+    
+    Init_context();
+    Init_frame();
+    Init_breakpoint();
 
     idAtLine       = rb_intern("at_line");
     idAtBreakpoint = rb_intern("at_breakpoint");
@@ -1015,7 +1273,7 @@ Init_ruby_debug()
     idEval         = rb_intern("eval");
     idList         = rb_intern("list");
     idClear        = rb_intern("clear");
-    idIndex = rb_intern("index");
+    idIndex        = rb_intern("index");
 
     file_separator = rb_eval_string("File::SEPARATOR");
     alt_file_separator = rb_eval_string("File::ALT_SEPARATOR");

data/lib/ruby-debug.rb

@@ -55,13 +55,17 @@ module Debugger
     
     attr_reader :thread, :control_thread
     
+    #
     # Interrupts the main thread
+    #
     def interrupt
       context = contexts.find{|c| c.thread == Thread.current }
       context.interrupt
     end
     
+    #
     # Interrupts the last debugged thread
+    #
     def interrupt_last
       if context = last_context
         return nil unless context.thread.alive?
@@ -70,11 +74,13 @@ module Debugger
       context
     end
     
-    def interface=(value)
+    def interface=(value) # :nodoc:
       processor.interface = value
     end
     
+    #
     # Starts a remote debugger.
+    #
     def start_remote(host = nil, port = PORT)
       return if @thread
       return if started?
@@ -124,7 +130,9 @@ module Debugger
     end
     alias start_server start_remote
     
+    #
     # Connects to the remote debugger
+    #
     def start_client(host = 'localhost', port = PORT)
       require "socket"
       interface = Debugger::LocalInterface.new
@@ -151,7 +159,7 @@ module Debugger
       puts
     end
     
-    def stop_main_thread
+    def stop_main_thread # :nodoc:
       return unless stop_on_connect
       
       context = contexts.find{ |c| c.thread == Thread.main }
@@ -159,7 +167,7 @@ module Debugger
     end
     private :stop_main_thread
 
-    def source_for(file)
+    def source_for(file) # :nodoc:
       if source = SCRIPT_LINES__[file]
         return source unless source == true
       end
@@ -168,7 +176,7 @@ module Debugger
       end
     end
     
-    def line_at(file, line)
+    def line_at(file, line) # :nodoc:
       lines = source_for(file)
       if lines
         line = lines[line-1]
@@ -178,7 +186,9 @@ module Debugger
       return "\n"
     end
 
-    # runs a script file
+    #
+    # Runs a script file
+    #
     def run_script(file, out = processor.interface)
       interface = ScriptInterface.new(file, out)
       processor = ControlCommandProcessor.new(interface)
@@ -188,15 +198,36 @@ module Debugger
 end
 
 module Kernel
-  # stops the current thread after a number of _steps_ made.
+  #
+  # Stops the current thread after a number of _steps_ made.
+  #
   def debugger(steps = 1)
     Debugger.current_context.stop_next = steps
   end
   
-  # returns a binding of n-th call frame
+  #
+  # Returns a binding of n-th call frame
+  #
   def binding_n(n = 0)
     frame = Debugger.current_context.frames[n+1]
     raise "Unknown frame #{n}" unless frame
     frame.binding 
   end
+end
+
+class Module
+  #
+  # Wraps the +meth+ method with Debugger.start {...} block.
+  #
+  def debug_method(meth)
+    alias_method "__debugee_#{meth}".to_sym, meth
+    class_eval <<-EOD
+    def #{meth}(*args, &block)
+      Debugger.start do
+        debugger 2
+        __debugee_#{meth}(*args, &block)
+      end
+    end
+    EOD
+  end
 end

data/lib/ruby-debug/command.rb

@@ -1,5 +1,5 @@
 module Debugger
-  class Command
+  class Command # :nodoc:
     class << self
       def commands
         @commands ||= []

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

@@ -1,5 +1,5 @@
 module Debugger
-  class AddBreakpoint < Command
+  class AddBreakpoint < Command # :nodoc:
     self.control = true
     
     def regexp
@@ -19,13 +19,12 @@ module Debugger
 
     def execute
       if @match[1]
-        file, pos, expr = @match.captures
+        pos, _, _, expr = @match.captures
       else
-        file, pos, expr = @match.captures[1..-1]
+        _, file, pos, expr = @match.captures
       end
       
-      if file =~ /^\d+$/
-        pos = file
+      if file.nil?
         file = File.basename(@state.file)
       else
         if pos !~ /^\d+$/
@@ -65,7 +64,7 @@ module Debugger
     end
   end
 
-  class BreakpointsCommand < Command
+  class BreakpointsCommand < Command # :nodoc:
     self.control = true
 
     def regexp
@@ -101,7 +100,7 @@ module Debugger
     end
   end
 
-  class DeleteBreakpointCommand < Command
+  class DeleteBreakpointCommand < Command # :nodoc:
     self.control = true
 
     def regexp

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

@@ -1,5 +1,5 @@
 module Debugger
-  class CatchCommand < Command
+  class CatchCommand < Command # :nodoc:
     self.control = true
 
     def regexp

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

@@ -1,5 +1,5 @@
 module Debugger
-  class QuitCommand < Command
+  class QuitCommand < Command # :nodoc:
     self.control = true
 
     def regexp
@@ -26,7 +26,7 @@ module Debugger
     end
   end
   
-  class InterruptCommand < Command
+  class InterruptCommand < Command # :nodoc:
     self.event = false
     self.control = true
     

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

@@ -1,11 +1,11 @@
 module Debugger
-  module DisplayFunctions
+  module DisplayFunctions # :nodoc:
     def display_expression(exp)
       print "%s = %s\n", exp, debug_silent_eval(exp).to_s
     end
   end
 
-  class AddDisplayCommand < Command
+  class AddDisplayCommand < Command # :nodoc:
     include DisplayFunctions
 
     def regexp
@@ -32,7 +32,7 @@ module Debugger
     end
   end
 
-  class DisplayCommand < Command
+  class DisplayCommand < Command # :nodoc:
     self.always_run = true
     include DisplayFunctions
     
@@ -68,7 +68,7 @@ module Debugger
     end
   end
 
-  class DeleteDisplayCommand < Command
+  class DeleteDisplayCommand < Command # :nodoc:
     include DisplayFunctions
 
     def regexp

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

@@ -1,5 +1,5 @@
 module Debugger
-  class EvalCommand < Command
+  class EvalCommand < Command # :nodoc:
     def match(input)
       @input = input
       super
@@ -40,7 +40,7 @@ module Debugger
     end
   end
 
-  class PPCommand < Command
+  class PPCommand < Command # :nodoc:
     def regexp
       /^\s*pp\s+/
     end

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

@@ -1,12 +1,12 @@
 module Debugger
-  module FrameFunctions
+  module FrameFunctions # :nodoc:
     def format_frame(frame, pos)
       file, line, id = frame.file, frame.line, frame.id
       "#%d %s:%s%s\n" % [pos + 1, file, line, (id ? ":in `#{id.id2name}'" : "")]
     end
   end
 
-  class WhereCommand < Command
+  class WhereCommand < Command # :nodoc:
     include FrameFunctions
 
     def regexp
@@ -43,7 +43,7 @@ module Debugger
     end
   end
 
-  class UpCommand < Command
+  class UpCommand < Command # :nodoc:
     include FrameFunctions
 
     def regexp
@@ -91,7 +91,7 @@ module Debugger
     end
   end
 
-  class DownCommand < Command
+  class DownCommand < Command # :nodoc:
     include FrameFunctions
 
     def regexp

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

@@ -1,5 +1,5 @@
 module Debugger
-  class HelpCommand < Command
+  class HelpCommand < Command # :nodoc:
     self.control = true
 
     def regexp

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

@@ -1,5 +1,5 @@
 module Debugger
-  class ListCommand < Command
+  class ListCommand < Command # :nodoc:
     def regexp
       /^\s*l(?:ist)?(?:\s*(.+))?$/
     end

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

@@ -1,5 +1,5 @@
 module Debugger
-  class MethodCommand < Command
+  class MethodCommand < Command # :nodoc:
     def regexp
       /^\s*m(?:ethod)?\s+(?:(i(:?nstance)?)\s)?/
     end

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

@@ -1,5 +1,5 @@
 module Debugger
-  class ScriptCommand < Command
+  class ScriptCommand < Command # :nodoc:
     self.control = true
     
     def regexp
@@ -27,7 +27,7 @@ module Debugger
     end
   end
   
-  class SaveCommand < Command
+  class SaveCommand < Command # :nodoc:
     self.control = true
     
     def regexp

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

@@ -1,5 +1,5 @@
 module Debugger
-  class NextCommand < Command
+  class NextCommand < Command # :nodoc:
     def regexp
       /^\s*n(?:ext)?(?:\s+(\d+))?$/
     end
@@ -23,7 +23,7 @@ module Debugger
     end
   end
 
-  class StepCommand < Command
+  class StepCommand < Command # :nodoc:
     def regexp
       /^\s*s(?:tep)?(?:\s+(\d+))?$/
     end
@@ -46,7 +46,7 @@ module Debugger
     end
   end
 
-  class FinishCommand < Command
+  class FinishCommand < Command # :nodoc:
     def regexp
       /^\s*fin(?:ish)?$/
     end
@@ -74,7 +74,7 @@ module Debugger
     end
   end
 
-  class ContinueCommand < Command
+  class ContinueCommand < Command # :nodoc:
     def regexp
       /^\s*c(?:ont)?$|^\s*r(?:un)?$/
     end

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

@@ -1,5 +1,5 @@
 module Debugger
-  module ThreadFunctions
+  module ThreadFunctions # :nodoc:
     def display_context(c)
       c_flag = c.thread == Thread.current ? '+' : ' '
       d_flag = debugger_thread?(c) ? '!' : ' '
@@ -18,7 +18,7 @@ module Debugger
     end
   end
 
-  class ThreadListCommand < Command
+  class ThreadListCommand < Command # :nodoc:
     self.control = true
     include ThreadFunctions
 
@@ -45,7 +45,7 @@ module Debugger
     end
   end
 
-  class ThreadSwitchCommand < Command
+  class ThreadSwitchCommand < Command # :nodoc:
     self.control = true
     include ThreadFunctions
 
@@ -81,7 +81,7 @@ module Debugger
     end
   end
 
-  class ThreadStopCommand < Command
+  class ThreadStopCommand < Command # :nodoc:
     self.control = true
     include ThreadFunctions
 
@@ -117,7 +117,7 @@ module Debugger
     end
   end
 
-  class ThreadCurrentCommand < Command
+  class ThreadCurrentCommand < Command # :nodoc:
     include ThreadFunctions
 
     def regexp
@@ -141,7 +141,7 @@ module Debugger
     end
   end
 
-  class ThreadResumeCommand < Command
+  class ThreadResumeCommand < Command # :nodoc:
     self.control = true
     include ThreadFunctions
 

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

@@ -1,6 +1,6 @@
 module Debugger
   if RUBY_PLATFORM =~ /darwin/
-    class TextMateCommand < Command
+    class TextMateCommand < Command # :nodoc:
       def regexp
         /^\s*tm(?:ate)?(?:\s*(\d+))?$/
       end

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

@@ -1,5 +1,5 @@
 module Debugger
-  class TraceCommand < Command
+  class TraceCommand < Command # :nodoc:
     def regexp
       /^\s*tr(?:ace)?(?:\s+(on|off))?(?:\s+(all))?$/
     end

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

@@ -1,5 +1,5 @@
 module Debugger
-  module VarFunctions
+  module VarFunctions # :nodoc:
     def var_list(ary, bind = nil)
       bind ||= @state.binding
       ary.sort!
@@ -9,7 +9,7 @@ module Debugger
     end
   end
 
-  class VarConstantCommand < Command
+  class VarConstantCommand < Command # :nodoc:
     include VarFunctions
 
     def regexp
@@ -38,7 +38,7 @@ module Debugger
     end
   end
 
-  class VarGlobalCommand < Command
+  class VarGlobalCommand < Command # :nodoc:
     include VarFunctions
 
     def regexp
@@ -62,7 +62,7 @@ module Debugger
     end
   end
 
-  class VarInstanceCommand < Command
+  class VarInstanceCommand < Command # :nodoc:
     include VarFunctions
 
     def regexp
@@ -87,7 +87,7 @@ module Debugger
     end
   end
 
-  class VarLocalCommand < Command
+  class VarLocalCommand < Command # :nodoc:
     include VarFunctions
 
     def regexp

data/lib/ruby-debug/interface.rb

@@ -1,5 +1,5 @@
 module Debugger  
-  class LocalInterface
+  class LocalInterface # :nodoc:
     def read_command(prompt)
       readline(prompt, true)
     end
@@ -55,7 +55,7 @@ module Debugger
     end
   end
 
-  class RemoteInterface
+  class RemoteInterface # :nodoc:
     def initialize(socket)
       @socket = socket
     end
@@ -87,7 +87,7 @@ module Debugger
     end
   end
   
-  class ScriptInterface
+  class ScriptInterface # :nodoc:
     def initialize(file, out)
       @file = open(file)
       @out = out

data/lib/ruby-debug/lock.rb

@@ -1,5 +1,5 @@
 module Debugger
-  class Lock
+  class Lock  # :nodoc:
     def initialize
       @locker = nil
       @waiting = []

data/lib/ruby-debug/processor.rb

@@ -2,7 +2,7 @@ require 'ruby-debug/interface'
 require 'ruby-debug/command'
 
 module Debugger
-  class CommandProcessor
+  class CommandProcessor # :nodoc:
     attr_accessor :interface
     attr_reader   :display
     
@@ -110,7 +110,7 @@ module Debugger
       end
     end
 
-    class State
+    class State # :nodoc:
       attr_accessor :context, :file, :line, :binding
       attr_accessor :frame_pos, :previous_line, :display
       attr_accessor :interface, :commands
@@ -139,7 +139,7 @@ module Debugger
     end
   end
   
-  class ControlCommandProcessor
+  class ControlCommandProcessor # :nodoc:
     def initialize(interface)
       @interface = interface
     end
@@ -170,7 +170,7 @@ module Debugger
       @interface.close
     end
     
-    class State
+    class State # :nodoc:
       attr_reader :commands
       def initialize(interface, commands)
         @interface = interface

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-debug
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
-date: 2006-08-27 16:17:09 -04:00
+  version: 0.4.2
+date: 2006-09-15 02:05:10 -04:00
 summary: Fast Ruby debugger
 require_paths: 
 - lib
@@ -15,7 +15,7 @@ description: ruby-debug is a fast implementation of the standard Ruby debugger d
 autorequire: ruby-debug
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
   - - ">="