ruby-debug-base 0.9.3 → 0.10.0

data/ext/ruby_debug.c

@@ -3,8 +3,9 @@
 #include <node.h>
 #include <rubysig.h>
 #include <st.h>
+#include <version.h>
 
-#define DEBUG_VERSION "0.9.3"
+#define DEBUG_VERSION "0.10.0"
 
 #ifdef _WIN32
 struct FRAME {
@@ -67,6 +68,7 @@ RUBY_EXTERN struct RVarmap *ruby_dyna_vars;
 #define STACK_SIZE_INCREMENT 128
 
 typedef struct {
+    int argc;         /* Number of arguments a frame should have. */
     VALUE binding;
     ID id;
     ID orig_id;
@@ -74,6 +76,7 @@ typedef struct {
     const char * file;
     short dead;
     VALUE self;
+    VALUE arg_ary;
     union {
         struct {
             struct FRAME *frame;
@@ -81,7 +84,9 @@ typedef struct {
             struct RVarmap *dyna_vars;
         } runtime;
         struct {
+            VALUE args;
             VALUE locals;
+	    VALUE arg_ary;
         } copy;
     } info;
 } debug_frame_t;
@@ -118,6 +123,7 @@ typedef struct {
         ID  mid;
     } pos;
     VALUE expr;
+    VALUE enabled;
     int hit_count;
     int hit_value;
     enum hit_condition hit_condition;
@@ -135,6 +141,7 @@ static VALUE locker             = Qnil;
 static VALUE post_mortem        = Qfalse;
 static VALUE keep_frame_binding = Qfalse;
 static VALUE debug              = Qfalse;
+static VALUE track_frame_args   = Qfalse;
 
 static VALUE last_context = Qnil;
 static VALUE last_thread  = Qnil;
@@ -165,9 +172,11 @@ static unsigned long hook_count = 0;
 static VALUE create_binding(VALUE);
 static VALUE debug_stop(VALUE);
 static void save_current_position(debug_context_t *);
+static VALUE context_copy_args(debug_frame_t *);
 static VALUE context_copy_locals(debug_frame_t *);
 static void context_suspend_0(debug_context_t *);
 static void context_resume_0(debug_context_t *);
+static void copy_scalar_args(debug_frame_t *);
 
 typedef struct locked_thread_t {
     VALUE thread_id;
@@ -221,7 +230,8 @@ id2ref_unprotected(VALUE id)
 static VALUE
 id2ref_error()
 {
-    rb_p(ruby_errinfo);
+    if(debug == Qtrue)
+      rb_p(ruby_errinfo);
     return Qnil;
 }
 
@@ -409,6 +419,7 @@ debug_context_mark(void *data)
         if(frame->dead)
         {
             rb_gc_mark(frame->info.copy.locals);
+            rb_gc_mark(frame->info.copy.args);
         }
     }
     rb_gc_mark(debug_context->breakpoint);
@@ -471,6 +482,7 @@ debug_context_dup(debug_context_t *debug_context)
         new_frame = &(new_debug_context->frames[i]);
         old_frame = &(debug_context->frames[i]);
         new_frame->dead = 1;
+        new_frame->info.copy.args = context_copy_args(old_frame);
         new_frame->info.copy.locals = context_copy_locals(old_frame);
     }
     return Data_Wrap_Struct(cContext, debug_context_mark, debug_context_free, new_debug_context);
@@ -521,7 +533,7 @@ static VALUE
 call_at_line(VALUE context, debug_context_t *debug_context, VALUE file, VALUE line)
 {
     VALUE args;
-
+    
     last_debugged_thnum = debug_context->thnum;
     save_current_position(debug_context);
 
@@ -545,6 +557,7 @@ save_call_frame(rb_event_t event, VALUE self, char *file, int line, ID mid, debu
         debug_context->frames = REALLOC_N(debug_context->frames, debug_frame_t, debug_context->stack_len);
     }
     debug_frame = &debug_context->frames[frame_n];
+    debug_frame->argc = ruby_frame->argc;
     debug_frame->file = file;
     debug_frame->line = line;
     debug_frame->binding = binding;
@@ -555,8 +568,11 @@ save_call_frame(rb_event_t event, VALUE self, char *file, int line, ID mid, debu
     debug_frame->info.runtime.frame = ruby_frame;
     debug_frame->info.runtime.scope = ruby_scope;
     debug_frame->info.runtime.dyna_vars = event == RUBY_EVENT_LINE ? ruby_dyna_vars : NULL;
+    if (RTEST(track_frame_args))
+      copy_scalar_args(debug_frame);
 }
 
+
 #if defined DOSISH
 #define isdirsep(x) ((x) == '/' || (x) == '\\')
 #else
@@ -593,7 +609,9 @@ filename_cmp(VALUE source, char *file)
 inline static int
 classname_cmp(VALUE name, VALUE klass)
 {
-    return (klass != Qnil && rb_str_cmp(name, rb_mod_name(klass)) == 0);
+    VALUE class_name = (Qnil == name) ? rb_str_new2("main") : name;
+    return (klass != Qnil 
+	    && rb_str_cmp(class_name, rb_mod_name(klass)) == 0);
 }
 
 static int
@@ -606,6 +624,7 @@ check_breakpoint_hit_condition(VALUE breakpoint)
     Data_Get_Struct(breakpoint, debug_breakpoint_t, debug_breakpoint);
 
     debug_breakpoint->hit_count++;
+    if (!Qtrue == debug_breakpoint->enabled) return 0;
     switch(debug_breakpoint->hit_condition)
     {
         case HIT_COND_NONE:
@@ -640,6 +659,7 @@ check_breakpoint_by_pos(VALUE breakpoint, char *file, int line)
     if(breakpoint == Qnil)
         return 0;
     Data_Get_Struct(breakpoint, debug_breakpoint_t, debug_breakpoint);
+    if (!Qtrue == debug_breakpoint->enabled) return 0;
     if(debug_breakpoint->type != BP_POS_TYPE)
         return 0;
     if(debug_breakpoint->pos.line != line)
@@ -657,6 +677,7 @@ check_breakpoint_by_method(VALUE breakpoint, VALUE klass, ID mid)
     if(breakpoint == Qnil)
         return 0;
     Data_Get_Struct(breakpoint, debug_breakpoint_t, debug_breakpoint);
+    if (!Qtrue == debug_breakpoint->enabled) return 0;
     if(debug_breakpoint->type != BP_METHOD_TYPE)
         return 0;
     if(debug_breakpoint->pos.mid != mid)
@@ -713,8 +734,8 @@ check_breakpoints_by_method(debug_context_t *debug_context, VALUE klass, ID mid)
 }
 
 /*
- * This is a NASTY HACK. For some reasons rb_f_binding is decalred
- * static in eval.c
+ * This is a NASTY HACK. For some reasons rb_f_binding is declared
+ * static in eval.c. So we create a cons up call to binding in C.
  */
 static VALUE
 create_binding(VALUE self)
@@ -1167,11 +1188,12 @@ debug_start(VALUE self)
  *   call-seq:
  *      Debugger.stop -> bool
  *
- *   This method disacivates the debugger. It returns +true+ if the debugger is disacivated,
+ *   This method disables the debugger. It returns +true+ if the debugger is disabled,
  *   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>
+ *   <i>Note that if you want to stop debugger, you must call
+ *   Debugger.stop as many times as you called Debugger.start
+ *   method.</i>
  */
 static VALUE
 debug_stop(VALUE self)
@@ -1224,6 +1246,7 @@ create_breakpoint_from_args(int argc, VALUE *argv, int id)
         breakpoint->pos.line = FIX2INT(pos);
     else
         breakpoint->pos.mid = rb_intern(RSTRING(pos)->ptr);
+    breakpoint->enabled = Qtrue;
     breakpoint->expr = NIL_P(expr) ? expr: StringValue(expr);
     breakpoint->hit_count = 0;
     breakpoint->hit_value = 0;
@@ -1568,6 +1591,31 @@ debug_set_post_mortem(VALUE self, VALUE value)
     return value;
 }
 
+/*
+ *   call-seq:
+ *      Debugger.track_fame_args? -> bool
+ *
+ *   Returns +true+ if the debugger track frame argument values on calls.
+ */
+static VALUE
+debug_track_frame_args(VALUE self)
+{
+    return track_frame_args;
+}
+
+/*
+ *   call-seq:
+ *      Debugger.track_frame_args = bool
+ *
+ *   Setting to +true+ will make the debugger save argument info on calls.
+ */
+static VALUE
+debug_set_track_frame_args(VALUE self, VALUE value)
+{
+    track_frame_args = RTEST(value) ? Qtrue : Qfalse;
+    return value;
+}
+
 /*
  *   call-seq:
  *      Debugger.keep_frame_binding? -> bool
@@ -1816,36 +1864,73 @@ check_frame_number(debug_context_t *debug_context, VALUE frame)
     return frame_n;
 }
 
+static int 
+optional_frame_position(int argc, VALUE *argv) {
+  unsigned int i_scanned;
+  VALUE level;
+
+  if ((argc > 1) || (argc < 0))
+    rb_raise(rb_eArgError, "wrong number of arguments (%d for 0 or 1)", argc);
+  i_scanned = rb_scan_args(argc, argv, "01", &level);
+  if (0 == i_scanned) {
+    level = INT2FIX(0);
+  }
+  return level;
+}
+
 /*
  *   call-seq:
- *      context.frame_binding(frame) -> binding
+ *      context.frame_args_info(frame_position=0) -> list 
+        if track_frame_args or nil otherwise
+ *
+ *   Returns info saved about call arguments (if any saved).
+ */
+static VALUE
+context_frame_args_info(int argc, VALUE *argv, VALUE self)
+{
+    VALUE frame;
+    debug_context_t *debug_context;
+
+    debug_check_started();
+    frame = optional_frame_position(argc, argv);
+    Data_Get_Struct(self, debug_context_t, debug_context);
+
+    return RTEST(track_frame_args) ? GET_FRAME->arg_ary : Qnil;
+}
+
+/*
+ *   call-seq:
+ *      context.frame_binding(frame_position=0) -> binding
  *
  *   Returns frame's binding.
  */
 static VALUE
-context_frame_binding(VALUE self, VALUE frame)
+context_frame_binding(int argc, VALUE *argv, VALUE self)
 {
+    VALUE frame;
     debug_context_t *debug_context;
 
     debug_check_started();
+    frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
     return GET_FRAME->binding;
 }
 
 /*
  *   call-seq:
- *      context.frame_method(frame) -> sym
+ *      context.frame_method(frame_position=0) -> sym
  *
  *   Returns the sym of the called method.
  */
 static VALUE
-context_frame_id(VALUE self, VALUE frame)
+context_frame_id(int argc, VALUE *argv, VALUE self)
 {
-
+    VALUE frame;
     debug_context_t *debug_context;
     ID id;
 
     debug_check_started();
+    frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
     id = GET_FRAME->id;
@@ -1854,16 +1939,18 @@ context_frame_id(VALUE self, VALUE frame)
 
 /*
  *   call-seq:
- *      context.frame_line(frame) -> int
+ *      context.frame_line(frame_position) -> int
  *
  *   Returns the line number in the file.
  */
 static VALUE
-context_frame_line(VALUE self, VALUE frame)
+context_frame_line(int argc, VALUE *argv, VALUE self)
 {
+    VALUE frame;
     debug_context_t *debug_context;
 
     debug_check_started();
+    frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
     return INT2FIX(GET_FRAME->line);
@@ -1871,21 +1958,100 @@ context_frame_line(VALUE self, VALUE frame)
 
 /*
  *   call-seq:
- *      context.frame_file(frame) -> string
+ *      context.frame_file(frame_position) -> string
  *
  *   Returns the name of the file.
  */
 static VALUE
-context_frame_file(VALUE self, VALUE frame)
+context_frame_file(int argc, VALUE *argv, VALUE self)
 {
+    VALUE frame;
     debug_context_t *debug_context;
 
     debug_check_started();
+    frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
     return rb_str_new2(GET_FRAME->file);
 }
 
+static int
+arg_value_is_small(VALUE val) 
+{
+  switch (TYPE(val)) {
+  case T_FIXNUM: case T_FLOAT:  case T_CLASS:
+  case T_NIL:    case T_MODULE: case T_FILE:
+  case T_TRUE:   case T_FALSE:  case T_UNDEF:
+    return 1;
+  default:
+    return SYMBOL_P(val);
+  }
+}
+
+/*
+ *   Save scalar arguments or a class name.
+ */
+static void
+copy_scalar_args(debug_frame_t *debug_frame)
+{
+  unsigned int i;
+  ID *tbl = ruby_scope->local_tbl;;
+  if (tbl && ruby_scope->local_vars) 
+  {
+      int n = *tbl++;
+      if (debug_frame->argc+2 < n) n = debug_frame->argc+2;
+      debug_frame->arg_ary = rb_ary_new2(n);
+      for (i=2; i<n; i++) 
+      {   
+	  /* skip flip states */
+	  if (rb_is_local_id(tbl[i])) 
+            {
+	      const char *name = rb_id2name(tbl[i]);
+              VALUE val = rb_eval_string (name);
+	      if (arg_value_is_small(val))
+		rb_ary_push(debug_frame->arg_ary, val);
+	      else
+		rb_ary_push(debug_frame->arg_ary, 
+			    rb_str_new2(rb_obj_classname(val)));
+	    }
+      }
+  }
+}
+
+
+/*
+ *   call-seq:
+ *      context.copy_args(frame) -> list of args
+ *
+ *   Returns a array of argument names.
+ */
+static VALUE
+context_copy_args(debug_frame_t *debug_frame)
+{
+    ID *tbl;
+    int n, i;
+    struct SCOPE *scope;
+    VALUE list = rb_ary_new2(0); /* [] */
+
+    scope = debug_frame->info.runtime.scope;
+    tbl = scope->local_tbl;
+
+    if (tbl && scope->local_vars) 
+    {
+        n = *tbl++;
+        if (debug_frame->argc+2 < n) n = debug_frame->argc+2;
+        list = rb_ary_new2(n);
+	/* skip first 2 ($_ and $~) */
+        for (i=2; i<n; i++) 
+        {   
+            /* skip first 2 ($_ and $~) */
+            if (!rb_is_local_id(tbl[i])) continue; /* skip flip states */
+            rb_ary_push(list, rb_str_new2(rb_id2name(tbl[i])));
+        }
+    }
+
+    return list;
+}
 static VALUE
 context_copy_locals(debug_frame_t *debug_frame)
 {
@@ -1927,12 +2093,14 @@ context_copy_locals(debug_frame_t *debug_frame)
  *   Returns frame's local variables.
  */
 static VALUE
-context_frame_locals(VALUE self, VALUE frame)
+context_frame_locals(int argc, VALUE *argv, VALUE self)
 {
+    VALUE frame;
     debug_context_t *debug_context;
     debug_frame_t *debug_frame;
 
     debug_check_started();
+    frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
     debug_frame = GET_FRAME;
@@ -1944,17 +2112,43 @@ context_frame_locals(VALUE self, VALUE frame)
 
 /*
  *   call-seq:
- *      context.frame_self(frame) -> obj
+ *      context.frame_args(frame_position=0) -> list
+ *
+ *   Returns frame's argument parameters
+ */
+static VALUE
+context_frame_args(int argc, VALUE *argv, VALUE self)
+{
+    VALUE frame;
+    debug_context_t *debug_context;
+    debug_frame_t *debug_frame;
+
+    debug_check_started();
+    frame = optional_frame_position(argc, argv);
+    Data_Get_Struct(self, debug_context_t, debug_context);
+
+    debug_frame = GET_FRAME;
+    if(debug_frame->dead)
+        return debug_frame->info.copy.args;
+    else
+        return context_copy_args(debug_frame);
+}
+
+/*
+ *   call-seq:
+ *      context.frame_self(frame_postion=0) -> obj
  *
  *   Returns self object of the frame.
  */
 static VALUE
-context_frame_self(VALUE self, VALUE frame)
+context_frame_self(int argc, VALUE *argv, VALUE self)
 {
+    VALUE frame;
     debug_context_t *debug_context;
     debug_frame_t *debug_frame;
 
     debug_check_started();
+    frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
     debug_frame = GET_FRAME;
@@ -1963,27 +2157,34 @@ context_frame_self(VALUE self, VALUE frame)
 
 /*
  *   call-seq:
- *      context.frame_class(frame) -> obj
+ *      context.frame_class(frame_position) -> obj
  *
  *   Returns the real class of the frame. 
  *   It could be different than context.frame_self(frame).class
  */
 static VALUE
-context_frame_class(VALUE self, VALUE frame)
+context_frame_class(int argc, VALUE *argv, VALUE self)
 {
+    VALUE frame;
     debug_context_t *debug_context;
     debug_frame_t *debug_frame;
     VALUE klass;
 
     debug_check_started();
+    frame = optional_frame_position(argc, argv);
     Data_Get_Struct(self, debug_context_t, debug_context);
 
     debug_frame = GET_FRAME;
     
     if(CTX_FL_TEST(debug_context, CTX_FL_DEAD))
         return Qnil;
-    
+
+#if RUBY_VERSION_CODE >= 190
+    klass = debug_frame->info.runtime.frame->this_class;
+#else
     klass = debug_frame->info.runtime.frame->last_class;
+#endif
+
     klass = real_class(klass);
     if(TYPE(klass) == T_CLASS || TYPE(klass) == T_MODULE)
         return klass;
@@ -2010,7 +2211,7 @@ context_stack_size(VALUE self)
 
 /*
  *   call-seq:
- *      context.thread -> trhread
+ *      context.thread -> thread
  *
  *   Returns a thread this context is associated with.
  */
@@ -2277,6 +2478,36 @@ context_stop_reason(VALUE self)
 }
 
 
+/*
+ *   call-seq:
+ *      breakpoint.enabled?
+ *
+ *   Returns whether breakpoint is enabled or not.
+ */
+static VALUE
+breakpoint_enabled(VALUE self)
+{
+    debug_breakpoint_t *breakpoint;
+
+    Data_Get_Struct(self, debug_breakpoint_t, breakpoint);
+    return breakpoint->enabled;
+}
+
+/*
+ *   call-seq:
+ *      breakpoint.enabled = bool
+ *
+ *   Enables or disables breakpoint.
+ */
+static VALUE
+breakpoint_set_enabled(VALUE self, VALUE bool)
+{
+    debug_breakpoint_t *breakpoint;
+
+    Data_Get_Struct(self, debug_breakpoint_t, breakpoint);
+    return breakpoint->enabled = bool;
+}
+
 /*
  *   call-seq:
  *      breakpoint.source -> string
@@ -2521,14 +2752,16 @@ Init_context()
     rb_define_method(cContext, "tracing", context_tracing, 0);
     rb_define_method(cContext, "tracing=", context_set_tracing, 1);
     rb_define_method(cContext, "ignored?", context_ignored, 0);
-    rb_define_method(cContext, "frame_binding", context_frame_binding, 1);
-    rb_define_method(cContext, "frame_id", context_frame_id, 1);
-    rb_define_method(cContext, "frame_method", context_frame_id, 1);
-    rb_define_method(cContext, "frame_line", context_frame_line, 1);
-    rb_define_method(cContext, "frame_file", context_frame_file, 1);
-    rb_define_method(cContext, "frame_locals", context_frame_locals, 1);
-    rb_define_method(cContext, "frame_self", context_frame_self, 1);
-    rb_define_method(cContext, "frame_class", context_frame_class, 1);
+    rb_define_method(cContext, "frame_args", context_frame_args, -1);
+    rb_define_method(cContext, "frame_args_info", context_frame_args_info, -1);
+    rb_define_method(cContext, "frame_binding", context_frame_binding, -1);
+    rb_define_method(cContext, "frame_class", context_frame_class, -1);
+    rb_define_method(cContext, "frame_file", context_frame_file, -1);
+    rb_define_method(cContext, "frame_id", context_frame_id, -1);
+    rb_define_method(cContext, "frame_line", context_frame_line, -1);
+    rb_define_method(cContext, "frame_locals", context_frame_locals, -1);
+    rb_define_method(cContext, "frame_method", context_frame_id, -1);
+    rb_define_method(cContext, "frame_self", context_frame_self, -1);
     rb_define_method(cContext, "stack_size", context_stack_size, 0);
     rb_define_method(cContext, "dead?", context_dead, 0);
     rb_define_method(cContext, "breakpoint", context_breakpoint, 0);
@@ -2550,6 +2783,8 @@ Init_breakpoint()
     rb_define_method(cBreakpoint, "id", breakpoint_id, 0);
     rb_define_method(cBreakpoint, "source", breakpoint_source, 0);
     rb_define_method(cBreakpoint, "source=", breakpoint_set_source, 1);
+    rb_define_method(cBreakpoint, "enabled?", breakpoint_enabled, 0);
+    rb_define_method(cBreakpoint, "enabled=", breakpoint_set_enabled, 1);
     rb_define_method(cBreakpoint, "pos", breakpoint_pos, 0);
     rb_define_method(cBreakpoint, "pos=", breakpoint_set_pos, 1);
     rb_define_method(cBreakpoint, "expr", breakpoint_expr, 0);
@@ -2583,7 +2818,8 @@ Init_ruby_debug()
     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, "remove_breakpoint", debug_remove_breakpoint, 1);
+    rb_define_module_function(mDebugger, "remove_breakpoint", 
+			      debug_remove_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);
@@ -2601,6 +2837,10 @@ Init_ruby_debug()
     rb_define_module_function(mDebugger, "post_mortem=", debug_set_post_mortem, 1);
     rb_define_module_function(mDebugger, "keep_frame_binding?", debug_keep_frame_binding, 0);
     rb_define_module_function(mDebugger, "keep_frame_binding=", debug_set_keep_frame_binding, 1);
+    rb_define_module_function(mDebugger, "track_frame_args?", 
+			      debug_track_frame_args, 0);
+    rb_define_module_function(mDebugger, "track_frame_args=", 
+			      debug_set_track_frame_args, 1);
     rb_define_module_function(mDebugger, "debug", debug_debug, 0);
     rb_define_module_function(mDebugger, "debug=", debug_set_debug, 1);