byebug 2.7.0 → 3.0.0

data/ext/byebug/context.c

@@ -12,8 +12,7 @@ reset_stepping_stop_points(debug_context_t *context)
   context->dest_frame   = -1;
   context->lines        = -1;
   context->steps        = -1;
-  context->after_frame  = -1;
-  context->before_frame = -1;
+  context->steps_out    = -1;
 }
 
 /*
@@ -38,16 +37,10 @@ context_mark(void *data)
   rb_gc_mark(context->backtrace);
 }
 
-static void
-context_free(void *data)
-{
-
-}
-
 static int
 real_stack_size()
 {
-  return FIX2INT(rb_funcall(cContext, rb_intern("real_stack_size"), 0));
+  return FIX2INT(rb_funcall(cContext, rb_intern("stack_size"), 1, Qtrue));
 }
 
 extern VALUE
@@ -67,7 +60,7 @@ context_create(VALUE thread)
 
   if (rb_obj_class(thread) == cDebugThread) CTX_FL_SET(context, CTX_FL_IGNORE);
 
-  return Data_Wrap_Struct(cContext, context_mark, context_free, context);
+  return Data_Wrap_Struct(cContext, context_mark, 0, context);
 }
 
 extern VALUE
@@ -80,7 +73,7 @@ context_dup(debug_context_t *context)
   new_context->backtrace = context->backtrace;
   CTX_FL_SET(new_context, CTX_FL_DEAD);
 
-  return Data_Wrap_Struct(cContext, context_mark, context_free, new_context);
+  return Data_Wrap_Struct(cContext, context_mark, 0, new_context);
 }
 
 static VALUE
@@ -225,7 +218,7 @@ Context_frame_binding(int argc, VALUE *argv, VALUE self)
  *
  *  Returns frame's defined class.
  */
- static VALUE
+static VALUE
 Context_frame_class(int argc, VALUE *argv, VALUE self)
 {
   FRAME_SETUP
@@ -405,8 +398,7 @@ Context_stop_reason(VALUE self)
 static VALUE
 Context_step_into(int argc, VALUE *argv, VALUE self)
 {
-  VALUE steps;
-  VALUE force;
+  VALUE steps, force;
   debug_context_t *context;
 
   rb_scan_args(argc, argv, "11", &steps, &force);
@@ -428,22 +420,35 @@ Context_step_into(int argc, VALUE *argv, VALUE self)
  *  call-seq:
  *    context.step_out(frame)
  *
- *  Stops after frame number +frame+ is activated. Implements +finish+ and
- *  +next+ commands.
+ *  Stops after +n_frames+ frames are finished. Implements +finish+ and
+ *  +next+ commands. +force+ parameter (if true) ensures that the cursor will
+ *  stop in the specified frame even when there's no more instructions to run.
+ *  In that case, it will stop when the return event for that frame is
+ *  triggered.
  */
 static VALUE
-Context_step_out(VALUE self, VALUE frame)
+Context_step_out(int argc, VALUE *argv, VALUE self)
 {
+  int n_args, n_frames;
+  VALUE v_frames, v_force;
   debug_context_t *context;
 
+  n_args = rb_scan_args(argc, argv, "02", &v_frames, &v_force);
+  n_frames = n_args == 0 ? 1 : FIX2INT(v_frames);
+  v_force = (n_args < 2) ? Qfalse : v_force;
+
   Data_Get_Struct(self, debug_context_t, context);
 
-  if (FIX2INT(frame) < 0 || FIX2INT(frame) >= context->calced_stack_size)
+  if (n_frames < 0 || n_frames >= context->calced_stack_size)
     rb_raise(rb_eRuntimeError, "Stop frame is out of range.");
 
-  context->after_frame = context->calced_stack_size - FIX2INT(frame);
+  context->steps_out = n_frames;
+  if (RTEST(v_force))
+    CTX_FL_SET(context, CTX_FL_STOP_ON_RET);
+  else
+    CTX_FL_UNSET(context, CTX_FL_STOP_ON_RET);
 
-  return frame;
+  return Qnil;
 }
 
 /*
@@ -481,27 +486,6 @@ Context_step_over(int argc, VALUE *argv, VALUE self)
   return Qnil;
 }
 
-/*
- *  call-seq:
- *    context.stop_return(frame)
- *
- *  Stops before frame number +frame+ is activated. Useful when you enter the
- *  debugger after the last statement in a method.
- */
-static VALUE
-Context_stop_return(VALUE self, VALUE frame)
-{
-  debug_context_t *context;
-
-  Data_Get_Struct(self, debug_context_t, context);
-  if (FIX2INT(frame) < 0 || FIX2INT(frame) >= context->calced_stack_size)
-    rb_raise(rb_eRuntimeError, "Stop frame is out of range.");
-
-  context->before_frame = context->calced_stack_size - FIX2INT(frame);
-
-  return frame;
-}
-
 static void
 context_suspend_0(debug_context_t *context)
 {
@@ -619,6 +603,8 @@ static VALUE
 DebugThread_inherited(VALUE klass)
 {
   rb_raise(rb_eRuntimeError, "Can't inherit Byebug::DebugThread class");
+
+  return Qnil;
 }
 
 /*
@@ -644,9 +630,8 @@ Init_context(VALUE mByebug)
   rb_define_method(cContext, "resume"           , Context_resume           ,  0);
   rb_define_method(cContext, "calced_stack_size", Context_calced_stack_size,  0);
   rb_define_method(cContext, "step_into"        , Context_step_into        , -1);
-  rb_define_method(cContext, "step_out"         , Context_step_out         ,  1);
+  rb_define_method(cContext, "step_out"         , Context_step_out         , -1);
   rb_define_method(cContext, "step_over"        , Context_step_over        , -1);
-  rb_define_method(cContext, "stop_return"      , Context_stop_return      ,  1);
   rb_define_method(cContext, "stop_reason"      , Context_stop_reason      ,  0);
   rb_define_method(cContext, "suspend"          , Context_suspend          ,  0);
   rb_define_method(cContext, "suspended?"       , Context_is_suspended     ,  0);

data/ext/byebug/extconf.rb

@@ -1,17 +1,17 @@
-require 'mkmf'
-
-RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
-
-if RUBY_VERSION < "2.0"
+if RUBY_VERSION < '2.0'
   STDERR.print("Ruby version is too old\n")
   exit(1)
 end
 
+require 'mkmf'
+
+RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+
 if RbConfig::MAKEFILE_CONFIG['CC'] =~ /gcc/
   $CFLAGS ||= ''
   $CFLAGS += ' -Wall -Werror -Wno-unused-parameter'
   $CFLAGS += ' -gdwarf-2 -g3 -O0' if ENV['debug']
 end
 
-dir_config("ruby")
+dir_config('ruby')
 create_makefile('byebug/byebug')

data/lib/byebug.rb

@@ -1,9 +1,8 @@
 require 'byebug/byebug'
 require 'byebug/version'
 require 'byebug/context'
+require 'byebug/interface'
 require 'byebug/processor'
-require 'byebug/command_processor'
-require 'byebug/control_command_processor'
 require 'byebug/remote'
 require 'stringio'
 require 'tracer'
@@ -15,24 +14,26 @@ module Byebug
   IGNORED_FILES = Dir.glob(File.expand_path('../**/*.rb', __FILE__))
 
   # Default options to Byebug.start
-  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
-  } unless defined?(DEFAULT_START_SETTINGS)
+  unless defined?(DEFAULT_START_SETTINGS)
+    DEFAULT_START_SETTINGS = { post_mortem: false,
+                               tracing: false,
+                               save_history: true }
+  end
 
   # Configuration file used for startup commands. Default value is .byebugrc
   INITFILE = '.byebugrc' unless defined?(INITFILE)
 
+  # Original ARGV, command line and initial directory to make restarts possible
+  ARGV = ARGV.clone unless defined?(ARGV)
+  PROG_SCRIPT = $0 unless defined?(PROG_SCRIPT)
+  INITIAL_DIR = Dir.pwd unless defined?(INITIAL_DIR)
+
   class << self
 
     # processor modules provide +handler+ object
     attr_accessor :handler
     Byebug.handler = CommandProcessor.new
 
-    attr_accessor :last_exception
-    Byebug.last_exception = nil
-
     def source_reload
       Object.send(:remove_const, 'SCRIPT_LINES__') if
         Object.const_defined?('SCRIPT_LINES__')
@@ -102,25 +103,23 @@ module Byebug
     # many times as you called Byebug.start method.</i>
     #
     # +options+ is a hash used to set various debugging options.
-    #   :init        - true if you want to save ARGV and some other variables to
-    #                  make a byebug restart possible. Only the first time :init
-    #                  is set to true the values will get set. Since ARGV is
-    #                  saved, you should make sure it hasn't been changed before
-    #                  the (first) call.
-    #   :post_mortem - true if you want to enter post-mortem debugging on an
-    #                  uncaught exception. Once post-mortem debugging is set, it
-    #                  can't be unset.
+    #   :post_mortem  - true if you want to enter post-mortem debugging on an
+    #                   uncaught exception, false otherwise. Default: false.
+    #   :tracing      - true if line tracing should be enabled, false otherwise.
+    #                   Default: false.
+    #   :save_history - true if byebug's command history should be saved to a
+    #                   file on program termination so that it can be reloaded
+    #                   later.
     #
     def start(options={}, &block)
       options = Byebug::DEFAULT_START_SETTINGS.merge(options)
-      if options[:init]
-        Byebug.const_set('ARGV', ARGV.clone) unless defined? Byebug::ARGV
-        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]
+
       retval = Byebug._start(&block)
+
       post_mortem if options[:post_mortem]
+      at_exit { Byebug::History.save } if options[:save_history]
+
       return retval
     end
 
@@ -139,7 +138,7 @@ module Byebug
 
       home_script = File.expand_path(File.join(ENV['HOME'].to_s, INITFILE))
       if File.exist?(home_script) and cwd_script != home_script
-         run_script(home_script, out)
+        run_script(home_script, out)
       end
     end
 
@@ -161,17 +160,17 @@ module Byebug
     #
     def post_mortem
       return if self.post_mortem?
-      at_exit { handle_post_mortem($!) if post_mortem? }
       self.post_mortem = true
+      at_exit { handle_post_mortem if post_mortem? }
     end
 
-    def handle_post_mortem(exp)
-      return if !exp
-      Byebug.last_exception = exp
-      return if !exp.__bb_context || !exp.__bb_context.calced_stack_size
+    def handle_post_mortem
+      context = raised_exception.__bb_context
+      file    = raised_exception.__bb_file
+      line    = raised_exception.__bb_line
       orig_tracing = Byebug.tracing?
       Byebug.tracing = false
-      handler.at_line(exp.__bb_context, exp.__bb_file, exp.__bb_line)
+      handler.at_line(context, file, line)
     ensure
       Byebug.tracing = orig_tracing
     end
@@ -185,16 +184,13 @@ end
 
 module Kernel
   #
-  # Enters byebug after _steps_into_ line events and _steps_out_ return events
-  # occur. Before entering byebug startup, the init script is read.
+  # Enters byebug right before (or right after if _before_ is false) return
+  # events occur. Before entering byebug the init script is read.
   #
-  def byebug(steps_into = 1, steps_out = 2)
+  def byebug(steps_out = 1, before = true)
     Byebug.start
     Byebug.run_init_script(StringIO.new)
-    if Byebug.current_context.calced_stack_size > 2
-      Byebug.current_context.stop_return steps_out if steps_out >= 1
-    end
-    Byebug.current_context.step_into steps_into if steps_into >= 0
+    Byebug.current_context.step_out(steps_out, before)
   end
 
   alias_method :debugger, :byebug

data/lib/byebug/command.rb

@@ -1,6 +1,6 @@
 require 'columnize'
 require 'forwardable'
-require_relative 'helper'
+require 'byebug/helper'
 
 module Byebug
 
@@ -23,7 +23,7 @@ module Byebug
         @commands ||= []
       end
 
-      attr_accessor :allow_in_control, :unknown, :need_context
+      attr_accessor :allow_in_control, :unknown
       attr_writer :allow_in_post_mortem, :always_run
 
       def allow_in_post_mortem
@@ -143,6 +143,7 @@ module Byebug
     end
 
     # Register default settings
+    register_setting_var(:autosave, true)
     register_setting_var(:basename, false)
     register_setting_var(:callstyle, :long)
     register_setting_var(:testing, false)
@@ -217,6 +218,7 @@ module Byebug
   #  :autolist          - automatically calls 'list' command on breakpoint
   #  :autoreload        - makes 'list' command always display up-to-date source
   #                       code
+  #  :autosave          - automatic saving of command history on exit
   #  :frame_class_names - displays method's class name when showing frame stack
   #  :forcestep         - stepping command always move to the new line
   #  :fullpath          - displays full paths when showing frame stack

data/lib/byebug/commands/continue.rb

@@ -3,7 +3,6 @@ module Byebug
   # Implements byebug "continue" command.
   class ContinueCommand < Command
     self.allow_in_post_mortem = true
-    self.need_context         = false
 
     def regexp
       /^\s* c(?:ont(?:inue)?)? (?:\s+(\S+))? \s*$/x

data/lib/byebug/commands/control.rb

@@ -66,7 +66,6 @@ module Byebug
   class InterruptCommand < Command
     self.allow_in_control     = true
     self.allow_in_post_mortem = false
-    self.need_context         = true
 
     def regexp
       /^\s*i(?:nterrupt)?\s*$/

data/lib/byebug/commands/edit.rb

@@ -1,6 +1,6 @@
 module Byebug
 
-  class Edit < Command
+  class EditCommand < Command
     self.allow_in_control = true
 
     def regexp

data/lib/byebug/commands/finish.rb

@@ -3,21 +3,18 @@ module Byebug
   # Implements byebug's 'finish' command.
   class FinishCommand < Command
     self.allow_in_post_mortem = false
-    self.need_context         = true
 
     def regexp
       /^\s* fin(?:ish)? (?:\s+(\S+))? \s*$/x
     end
 
     def execute
-      if not @match[1]
-        frame_pos = @state.frame_pos
-      else
-        max_frame = Context.stack_size - @state.frame_pos
-        frame_pos = get_int(@match[1], "finish", 0, max_frame-1, 0)
-        return nil unless frame_pos
-      end
-      @state.context.step_out frame_pos
+      max_frames = Context.stack_size - @state.frame_pos
+      n_frames = get_int(@match[1], "finish", 0, max_frames - 1, 1)
+      return nil unless n_frames
+
+      force = n_frames == 0 ? true : false
+      @state.context.step_out(@state.frame_pos + n_frames, force)
       @state.frame_pos = 0
       @state.proceed
     end
@@ -28,14 +25,11 @@ module Byebug
       end
 
       def description
-        %{fin[ish][ frame-number]\tExecute until selected stack frame returns.
-
-          If no frame number is given, we run until the currently selected frame
-          returns. The currently selected frame starts out the most-recent frame
-          or 0 if no frame positioning (e.g "up", "down" or "frame") has been
-          performed.
+        %{fin[ish][ n_frames]\tExecute until frame returns.
 
-          If a frame number is given we run until that frame returns.}
+          If no number is given, we run until the current frame returns. If a
+          number of frames `n_frames` is given, then we run until `n_frames`
+          return from the current position.}
       end
     end
   end

data/lib/byebug/commands/help.rb

@@ -21,7 +21,7 @@ module Byebug
           help.pop if help.last && help.last.empty?
           return print help.join("\n") + "\n"
         else
-          return errmsg "Undefined command: \"#{args[0]}\".  Try \"help\".\n" if
+          return errmsg "Undefined command: \"#{args[0]}\". Try \"help\".\n" if
             args[0]
         end
       end

data/lib/byebug/commands/kill.rb

@@ -16,7 +16,7 @@ module Byebug
           return false
         end
         if 'KILL' == signame
-            @state.interface.finalize
+          @state.interface.close
         end
       else
         if not confirm("Really kill? (y/n) ")

data/lib/byebug/commands/quit.rb

@@ -10,7 +10,7 @@ module Byebug
 
     def execute
       if @match[1] or confirm("Really quit? (y/n) ")
-        @state.interface.finalize
+        @state.interface.close
         exit! # exit -> exit!: No graceful way to stop...
       end
     end

data/lib/byebug/commands/repl.rb

@@ -50,12 +50,12 @@ end
 module Byebug
 
   # Implements byebug's "irb" command.
-  class IRBCommand < Command
+  class IrbCommand < Command
     register_setting_get(:autoirb) do
-      IRBCommand.always_run
+      IrbCommand.always_run
     end
     register_setting_set(:autoirb) do |value|
-      IRBCommand.always_run = value
+      IrbCommand.always_run = value
     end
 
     def regexp