byebug 0.0.1 → 1.0.0

data/ext/byebug/byebug.h

@@ -16,9 +16,8 @@ typedef struct rb_trace_arg_struct rb_trace_point_t;
 #define CTX_FL_DEAD         (1<<5)
 #define CTX_FL_WAS_RUNNING  (1<<6)
 #define CTX_FL_ENABLE_BKPT  (1<<7)
-#define CTX_FL_STEPPED      (1<<8)
-#define CTX_FL_FORCE_MOVE   (1<<9)
-#define CTX_FL_CATCHING     (1<<10)
+#define CTX_FL_FORCE_MOVE   (1<<8)
+#define CTX_FL_CATCHING     (1<<9)
 
 /* macro functions */
 #define CTX_FL_TEST(c,f)  ((c)->flags & (f))

data/ext/byebug/context.c

@@ -162,22 +162,17 @@ context_create(VALUE thread, VALUE cDebugThread) {
   return Data_Wrap_Struct(cContext, Context_mark, Context_free, context);
 }
 
-static inline void
-check_frame_number_valid(debug_context_t *context, int frame_no)
-{
-  if (frame_no < 0 || frame_no >= context->stack_size) {
-    rb_raise(rb_eArgError, "Invalid frame number %d, stack (0...%d)",
-        frame_no, context->stack_size);
-  }
-}
-
 static debug_frame_t*
 get_frame_no(debug_context_t *context, int frame_n)
 {
   debug_frame_t *frame;
   int i;
 
-  check_frame_number_valid(context, frame_n);
+  if (frame_n < 0 || frame_n >= context->stack_size) {
+    rb_raise(rb_eArgError, "Invalid frame number %d, stack (0...%d)",
+        frame_n, context->stack_size);
+  }
+
   frame = context->stack;
   for (i = 0; i < frame_n; i++) {
     frame = frame->prev;
@@ -255,22 +250,39 @@ Context_frame_self(int argc, VALUE *argv, VALUE self)
   return frame->self;
 }
 
-/*
+static VALUE
+Context_frame_locals(int argc, VALUE *argv, VALUE self)
+{
+  VALUE binding = Context_frame_binding(argc, argv, self);
+  const char src[] =
+              "local_variables.inject({}){|h, v| h[v] = eval(\"#{v}\"); h}";
+  return NIL_P(binding) ?
+         rb_hash_new() :
+         rb_funcall(binding, rb_intern("eval"), 1, rb_str_new2(src));
+}
+
 static VALUE
 Context_frame_args(int argc, VALUE *argv, VALUE self)
 {
-    debug_context_t *context;
-    debug_frame_t *frame;
-    VALUE frame_no;
-    int frame_n;
+  VALUE binding = Context_frame_binding(argc, argv, self);
+  const char src[] =
+      "__method__ ? " \
+      "self.method(__method__).parameters.map{|(attr, mid)| mid} : []";
+  return NIL_P(binding) ?
+         rb_ary_new() :
+         rb_funcall(binding, rb_intern("eval"), 1, rb_str_new2(src));
+}
 
-    Data_Get_Struct(self, debug_context_t, context);
-    frame_n = rb_scan_args(argc, argv, "01", &frame_no) == 0 ? 0 : FIX2INT(frame_no);
-    frame = get_frame_no(context, frame_n);
+static VALUE
+Context_frame_args_info(int argc, VALUE *argv, VALUE self)
+{
+  VALUE binding = Context_frame_binding(argc, argv, self);
+  const char src[] = "method(__method__).parameters";
 
-    return frame->arg_ary;
+  return NIL_P(binding) ?
+         rb_ary_new() :
+         rb_funcall(binding, rb_intern("eval"), 1, rb_str_new2(src));
 }
-*/
 
 static VALUE
 Context_tracing(VALUE self)
@@ -324,6 +336,30 @@ Context_stop_reason(VALUE self)
     return ID2SYM(rb_intern(symbol));
 }
 
+#if 0
+
+static VALUE
+Context_jump(VALUE self, VALUE line, VALUE file)
+{
+  debug_context_t *context;
+  debug_frame_t *frame;
+  int i, lineno;
+
+  Data_Get_Struct(self, debug_context_t, context);
+
+  frame = context->stack;
+  lineno = FIX2INT(line);
+
+  for (i = 0; i < context->stack_size; i++) {
+    if (strcmp(frame->file, RSTRING_PTR(file))) {
+      /* And now? */
+    }
+    frame = frame->prev;
+  }
+}
+
+#endif
+
 static VALUE
 Context_stop_next(int argc, VALUE *argv, VALUE self)
 {
@@ -332,7 +368,8 @@ Context_stop_next(int argc, VALUE *argv, VALUE self)
   debug_context_t *context;
 
   rb_scan_args(argc, argv, "11", &steps, &force);
-  if(FIX2INT(steps) < 0) rb_raise(rb_eRuntimeError, "Steps argument can't be negative.");
+  if (FIX2INT(steps) < 0)
+    rb_raise(rb_eRuntimeError, "Steps argument can't be negative.");
 
   Data_Get_Struct(self, debug_context_t, context);
   context->stop_next = FIX2INT(steps);
@@ -351,23 +388,17 @@ Context_step_over(int argc, VALUE *argv, VALUE self)
   debug_context_t *context;
 
   Data_Get_Struct(self, debug_context_t, context);
-  if(context->stack_size == 0)
+  if (context->stack_size == 0)
     rb_raise(rb_eRuntimeError, "No frames collected.");
 
   rb_scan_args(argc, argv, "12", &lines, &frame, &force);
   context->stop_line = FIX2INT(lines);
-  CTX_FL_UNSET(context, CTX_FL_STEPPED);
-  if(frame == Qnil)
-  {
-    context->dest_frame = context->stack_size;
-  }
-  else
-  {
-    if(FIX2INT(frame) < 0 && FIX2INT(frame) >= context->stack_size)
-      rb_raise(rb_eRuntimeError, "Destination frame is out of range.");
-    context->dest_frame = context->stack_size - FIX2INT(frame);
-  }
-  if(RTEST(force))
+
+  if (FIX2INT(frame) < 0 && FIX2INT(frame) >= context->stack_size)
+    rb_raise(rb_eRuntimeError, "Destination frame is out of range.");
+  context->dest_frame = context->stack_size - FIX2INT(frame);
+
+  if (RTEST(force))
     CTX_FL_SET(context, CTX_FL_FORCE_MOVE);
   else
     CTX_FL_UNSET(context, CTX_FL_FORCE_MOVE);
@@ -378,12 +409,12 @@ Context_step_over(int argc, VALUE *argv, VALUE self)
 static VALUE
 Context_stop_frame(VALUE self, VALUE frame)
 {
-  debug_context_t *debug_context;
+  debug_context_t *context;
 
-  Data_Get_Struct(self, debug_context_t, debug_context);
-  if(FIX2INT(frame) < 0 && FIX2INT(frame) >= debug_context->stack_size)
+  Data_Get_Struct(self, debug_context_t, context);
+  if(FIX2INT(frame) < 0 && FIX2INT(frame) >= context->stack_size)
     rb_raise(rb_eRuntimeError, "Stop frame is out of range.");
-  debug_context->stop_frame = debug_context->stack_size - FIX2INT(frame);
+  context->stop_frame = context->stack_size - FIX2INT(frame);
 
   return frame;
 }
@@ -412,7 +443,9 @@ Init_context(VALUE mByebug)
   rb_define_method(cContext, "frame_method", Context_frame_method, -1);
   rb_define_method(cContext, "frame_binding", Context_frame_binding, -1);
   rb_define_method(cContext, "frame_self", Context_frame_self, -1);
-//rb_define_method(cContext, "frame_args", Context_frame_args, -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_locals", Context_frame_locals, -1);
   rb_define_method(cContext, "stop_next=", Context_stop_next, -1);
   rb_define_method(cContext, "step", Context_stop_next, -1);
   rb_define_method(cContext, "step_over", Context_step_over, -1);

data/lib/byebug.rb

@@ -11,7 +11,6 @@ require 'linecache19'
 module Byebug
 
   @reload_source_on_change = false
-  @tracing_started = false
 
   self.handler = CommandProcessor.new
 
@@ -19,21 +18,19 @@ module Byebug
   DEFAULT_START_SETTINGS = {
     :init        => true,  # Set $0 and save ARGV?
     :post_mortem => false, # post-mortem debugging on uncaught exception?
-    :tracing     => nil    # Byebug.tracing value. true/false resets,
+    :tracing     => nil    # Byebug.tracing value. true/false resets
   } unless defined?(DEFAULT_START_SETTINGS)
 
-  # the port number used for remote debugging
+  # Port number used for remote debugging
   PORT = 8989 unless defined?(PORT)
 
-  # What file is used for byebug startup commands.
-  unless defined?(INITFILE)
-    INITFILE = '.rdebugrc'
-    HOME_DIR = ENV['HOME'].to_s
-  end
+  # Configuration file used for startup commands. Default value is .byebugrc
+  INITFILE = '.byebugrc' unless defined?(INITFILE)
 
   class << self
 
-    # if true, checks the modification time of source files and reloads if it was modified
+    # If true, checks the modification time of source files and reloads them if
+    # they were modified
     attr_accessor :reload_source_on_change
 
     attr_accessor :last_exception
@@ -42,11 +39,10 @@ module Byebug
     # gdb-style annotation mode. Used in GNU Emacs interface
     attr_accessor :annotate
 
-    # in remote mode, wait for the remote connection
+    # If in remote mode, wait for the remote connection
     attr_accessor :wait_connection
 
-    # If set, a string to look for in caller() and is used to see
-    # if the call stack is truncated.
+    # A string to look for in caller() to see if the call stack is truncated
     attr_accessor :start_sentinal
 
     attr_reader :thread, :control_thread, :cmd_port, :ctrl_port
@@ -75,13 +71,13 @@ module Byebug
       LineCache::clear_file_cache
     end
 
-    # Get line +line_number+ from file named +filename+. Return "\n" if
-    # there was a problem. Leaking blanks are stripped off.
-    def line_at(filename, line_number) # :nodoc:
-      @reload_on_change=nil unless defined?(@reload_on_change)
+    # Get line +line_number+ from file named +filename+.
+    # @return "\n" if there was a problem. Leaking blanks are stripped off.
+    def line_at(filename, line_number)
+      @reload_on_change = nil unless defined?(@reload_on_change)
       line = LineCache::getline(filename, line_number, @reload_on_change)
       return "\n" unless line
-      return "#{line.gsub(/^\s+/, '').chomp}\n"
+      return "#{line.gsub(/^\s+/, '').chomp}"
     end
 
     alias stop remove_tracepoints
@@ -110,16 +106,14 @@ module Byebug
     # If it's called without a block it returns +true+, unless byebug was
     # already started.
     #
-    # If a block is given, it starts byebug and yields to block. When the
-    # block is finished executing it stops the byebug with Byebug.stop
-    # method. Inside the block you will probably want to have a call to
-    # Byebug.byebug. For example:
+    # If a block is given, it starts byebug and yields block. When the block is
+    # executed it stops byebug with Byebug.stop method. Inside the block you
+    # will probably want to have a call to Byebug.byebug. For example:
     #
     #     Byebug.start{byebug; foo}  # Stop inside of foo
     #
     # Also, byebug only allows one invocation of byebug at a time; nested
-    # Byebug.start's have no effect and you can't use this inside the byebug
-    # itself.
+    # Byebug.start's have no effect and you can't use this inside byebug itself.
     #
     # <i>Note that if you want to stop byebug, you must call Byebug.stop as
     # many times as you called Byebug.start method.</i>
@@ -141,15 +135,15 @@ module Byebug
         Byebug.const_set('PROG_SCRIPT', $0) unless defined? Byebug::PROG_SCRIPT
         Byebug.const_set('INITIAL_DIR', Dir.pwd) unless defined? Byebug::INITIAL_DIR
       end
-      #Byebug.tracing = options[:tracing] unless options[:tracing].nil?
+      Byebug.tracing = options[:tracing] unless options[:tracing].nil?
       if Byebug.started?
         retval = block && block.call(self)
       else
         retval = Byebug._start(&block)
       end
-      if options[:post_mortem]
-        post_mortem
-      end
+      #if options[:post_mortem]
+      #  post_mortem
+      #end
       return retval
     end
 
@@ -247,12 +241,13 @@ module Byebug
     # program you are debugging, in the directory where you invoke byebug.
     #
     def run_init_script(out = handler.interface)
-      cwd_script_file  = File.expand_path(File.join(".", INITFILE))
-      run_script(cwd_script_file, out) if File.exists?(cwd_script_file)
+      cwd_script  = File.expand_path(File.join(".", INITFILE))
+      run_script(cwd_script, out) if File.exists?(script_file)
 
-      home_script_file = File.expand_path(File.join(HOME_DIR, INITFILE))
-      run_script(home_script_file, out) if File.exists?(home_script_file) and
-        cwd_script_file != home_script_file
+      home_script = File.expand_path(File.join(ENV['HOME'].to_s, INITFILE))
+      if File.exists?(home_script) and cwd_script != home_script
+         run_script(home_script_file, out)
+      end
     end
 
     #
@@ -374,14 +369,15 @@ class Module
 end
 module Kernel
 
+  ##
   # Enters byebug in the current thread after _steps_ line events occur.
   #
-  # Before entering byebug startup, the init script is read. Setting _steps_ to 0
-  # will cause a break in the byebug subroutine and not wait for a line event to
-  # occur. You will have to go "up 1" in order to be back to your debugged program
-  # from byebug program. Setting _steps_ to 0 could be useful if you want to stop
-  # right after the last statement in some scope, because the next step will take
-  # you out of some scope.
+  # Before entering byebug startup, the init script is read. Setting _steps_ to
+  # 0 will cause a break in byebug's subroutine and not wait for a line event to
+  # occur. You will have to go "up 1" in order to be back to your debugged
+  # program from byebug. Setting _steps_ to 0 could be useful if you want to
+  # stop right after the last statement in some scope, because the next step
+  # will take you out of some scope.
   def byebug(steps = 1)
     Byebug.start
     Byebug.run_init_script(StringIO.new)

data/lib/byebug/command.rb

@@ -1,12 +1,15 @@
 require 'columnize'
+require 'forwardable'
 require_relative 'helper'
 
 module Byebug
 
+  # Root dir for byebug
   BYEBUG_DIR = File.expand_path(File.dirname(__FILE__)) unless
     defined?(BYEBUG_DIR)
 
-  class Command # :nodoc:
+  class Command
+
     SubcmdStruct = Struct.new(:name, :min, :short_help, :long_help) unless
       defined?(SubcmdStruct)
 
@@ -32,11 +35,11 @@ module Byebug
 
       DEF_OPTIONS = {
         :allow_in_control     => false,
-        :allow_in_post_mortem => true,
-        :event => true,
-        :always_run => 0,
-        :unknown => false,
-        :need_context => false,
+        :allow_in_post_mortem => true ,
+        :event                => true ,
+        :always_run           => 0    ,
+        :unknown              => false,
+        :need_context         => false,
       } unless defined?(DEF_OPTIONS)
 
       def inherited(klass)
@@ -47,12 +50,10 @@ module Byebug
       end
 
       def load_commands
-        Dir[File.join(Byebug.const_get(:BYEBUG_DIR), 'commands', '*')].each do |file|
-          require file if file =~ /\.rb$/
-        end
-        Byebug.constants.grep(/Functions$/).map { |name| Byebug.const_get(name) }.each do |mod|
-          include mod
-        end
+        Dir[File.join(Byebug.const_get(:BYEBUG_DIR), 'commands', '*')].each {
+          |file| require file if file =~ /\.rb$/ }
+        Byebug.constants.grep(/Functions$/).map {
+          |name| Byebug.const_get(name) }.each { |mod| include mod }
       end
 
       def method_missing(meth, *args, &block)
@@ -155,14 +156,8 @@ module Byebug
 
     protected
 
-      # FIXME: use delegate?
-      def errmsg(*args)
-        @state.errmsg(*args)
-      end
-
-      def print(*args)
-        @state.print(*args)
-      end
+      extend Forwardable
+      def_delegators :@state, :errmsg, :print
 
       def confirm(msg)
         @state.confirm(msg) == 'y'
@@ -197,9 +192,9 @@ module Byebug
         @state.context.frame_binding(@state.frame_pos)
       end
 
-      def line_at(file, line)
-        Byebug.line_at(file, line)
-      end
+      #def line_at(file, line)
+      #  Byebug.line_at(file, line)
+      #end
 
       def get_context(thnum)
         Byebug.contexts.find{|c| c.thnum == thnum}
@@ -208,7 +203,7 @@ module Byebug
 
   Command.load_commands
 
-  #
+  ##
   # Returns ths settings object.
   # Use Byebug.settings[] and Byebug.settings[]= methods to query and set
   # byebug settings. These settings are available:

data/lib/byebug/commands/breakpoints.rb

@@ -32,14 +32,13 @@ module Byebug
         end
       end
 
-      brkpt_filename = nil
+      brkpt_filename = file
       if file.nil?
         unless @state.context
           errmsg "We are not in a state that has an associated file.\n"
           return
         end
         brkpt_filename = @state.file
-        file = File.basename(@state.file)
         if line.nil?
           # Set breakpoint at current line
           line = @state.line.to_s
@@ -53,11 +52,6 @@ module Byebug
           errmsg "Unknown class #{file}.\n"
           throw :debug_error
         end
-      else
-        # FIXME: This should be done in LineCache.
-        file = File.expand_path(file) if file.index(File::SEPARATOR) || \
-        File::ALT_SEPARATOR && file.index(File::ALT_SEPARATOR)
-        brkpt_filename = file
       end
 
       if line =~ /^\d+$/
@@ -65,15 +59,19 @@ module Byebug
         if LineCache.cache(brkpt_filename, Command.settings[:reload_source_on_change])
           last_line = LineCache.size(brkpt_filename)
           if line > last_line
-            errmsg("There are only %d lines in file \"%s\".\n", last_line, file)
+            errmsg \
+              "There are only %d lines in file %s\n",
+              last_line, brkpt_filename
             return
           end
           unless LineCache.trace_line_numbers(brkpt_filename).member?(line)
-            errmsg("Line %d is not a stopping point in file \"%s\".\n", line, file)
+            errmsg \
+              "Line %d is not a stopping point in file %s\n",
+               line, brkpt_filename
             return
           end
         else
-          errmsg("No source file named %s\n" % file)
+          errmsg("No source file named %s\n", brkpt_filename)
           return unless confirm("Set breakpoint anyway? (y/n) ")
         end
 
@@ -82,7 +80,8 @@ module Byebug
           return
         end
         b = Byebug.add_breakpoint brkpt_filename, line, expr
-        print "Breakpoint %d file %s, line %s\n", b.id, brkpt_filename, line.to_s
+        print "Created breakpoint #{b.id} at " \
+              "#{CommandProcessor.canonic_file(brkpt_filename)}:#{line.to_s}"
         unless syntax_valid?(expr)
           errmsg("Expression \"#{expr}\" syntactically incorrect; breakpoint disabled.\n")
           b.enabled = false
@@ -90,7 +89,7 @@ module Byebug
       else
         method = line.intern
         b = Byebug.add_breakpoint class_name, method, expr
-        print "Breakpoint %d at %s::%s\n", b.id, class_name, method.to_s
+        print "Created breakpoint #{b.id} at #{class_name}::#{method.to_s}"
       end
     end