byebug 1.8.2 → 2.0.0

data/lib/byebug/commands/control.rb

@@ -4,7 +4,7 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      /^\s* (?:restart|R) (?:\s+(.+))? \s*$/ix
+      /^\s* (?:restart|R) (?:\s+(.+))? \s*$/x
     end
 
     def execute
@@ -19,8 +19,7 @@ module Byebug
         if not File.executable?(Byebug::PROG_SCRIPT)
           print "Ruby program #{Byebug::PROG_SCRIPT} not executable... " \
                 "We'll add a call to Ruby.\n"
-          ruby = begin defined?(Gem) ? Gem.ruby : "ruby" rescue "ruby" end
-          cmd = "#{ruby} -I#{$:.join(' -I')} #{Byebug::PROG_SCRIPT}"
+          cmd = "ruby -rbyebug -I#{$:.join(' -I')} #{Byebug::PROG_SCRIPT}"
         else
           cmd = Byebug::PROG_SCRIPT
         end

data/lib/byebug/commands/display.rb

@@ -2,7 +2,7 @@ module Byebug
 
   module DisplayFunctions
     def display_expression(exp)
-      print "#{exp} = #{debug_silent_eval(exp).to_s}\n"
+      print "#{exp} = #{debug_silent_eval(exp).inspect}\n"
     end
 
     def active_display_expressions?
@@ -46,12 +46,7 @@ module Byebug
 
   class DisplayCommand < Command
     def self.always_run
-      Byebug.annotate = 0 unless Byebug.annotate
-      if Byebug.annotate > 1
-        0
-      else
-        2
-      end
+      2
     end
 
     def regexp

data/lib/byebug/commands/edit.rb

@@ -4,7 +4,7 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      /^\s* ed(?:it)? (?:\s+(\S+))? \s*$/ix
+      /^\s* ed(?:it)? (?:\s+(\S+))? \s*$/x
     end
 
     def execute

data/lib/byebug/commands/enable.rb

@@ -16,7 +16,7 @@ module Byebug
         return nil unless pos
         breakpoints.each do |b|
           if b.id == pos
-            enabled = ('Enable' == is_enable)
+            enabled = ('enable' == is_enable)
             if enabled
               unless syntax_valid?(b.expr)
                 errmsg "Expression \"#{b.expr}\" syntactically incorrect; " \
@@ -24,7 +24,7 @@ module Byebug
                 break
               end
             end
-            b.enabled = ('Enable' == is_enable)
+            b.enabled = ('enable' == is_enable)
             break
           end
         end
@@ -39,7 +39,7 @@ module Byebug
       args.each do |pos|
         pos = get_int(pos, "#{is_enable} display", 1, @state.display.size)
         return nil unless pos
-        @state.display[pos-1][0] = ('Enable' == is_enable)
+        @state.display[pos-1][0] = ('enable' == is_enable)
       end
     end
   end
@@ -52,15 +52,15 @@ module Byebug
         'used to cancel the effect of the "disable" command.'],
        ['display', 2,
         'Enable some expressions to be displayed when program stops',
-        'Arguments are the code numbers of the expressions to resume '     \
+        'Arguments are the code numbers of the expressions to resume '   \
         'displaying. Do "info display" to see the current list of code ' \
         'numbers.'],
       ].map do |name, min, short_help, long_help|
-      SubcmdStruct.new(name, min, short_help, long_help)
+        Subcmd.new(name, min, short_help, long_help)
     end unless defined?(Subcommands)
 
     def regexp
-      /^\s* en(?:able)? (?:\s+(.+))? \s*$/ix
+      /^\s* en(?:able)? (?:\s+(.+))? \s*$/x
     end
 
     def execute
@@ -78,11 +78,11 @@ module Byebug
     end
 
     def enable_breakpoints(args)
-      enable_disable_breakpoints('Enable', args)
+      enable_disable_breakpoints('enable', args)
     end
 
     def enable_display(args)
-      enable_disable_display('Enable', args)
+      enable_disable_display('enable', args)
     end
 
     class << self
@@ -110,11 +110,11 @@ module Byebug
         'displaying. Do "info display" to see the current list of code ' \
         'numbers.'],
       ].map do |name, min, short_help, long_help|
-      SubcmdStruct.new(name, min, short_help, long_help)
+      Subcmd.new(name, min, short_help, long_help)
     end unless defined?(Subcommands)
 
     def regexp
-      /^\s* dis(?:able)? (?:\s+(.+))? \s*$/ix
+      /^\s* dis(?:able)? (?:\s+(.+))? \s*$/x
     end
 
     def execute
@@ -132,11 +132,11 @@ module Byebug
     end
 
     def disable_breakpoints(args)
-      enable_disable_breakpoints('Disable', args)
+      enable_disable_breakpoints('disable', args)
     end
 
     def disable_display(args)
-      enable_disable_display('Disable', args)
+      enable_disable_display('disable', args)
     end
 
     class << self

data/lib/byebug/commands/eval.rb

@@ -43,7 +43,7 @@ module Byebug
     end
 
     def regexp
-      /^\s*(p|e(?:val)?)\s+/x
+      /^\s* (p|e(?:val)?)\s+/x
     end
 
     def execute
@@ -72,7 +72,7 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      /^\s*pp\s+/
+      /^\s* pp \s+/x
     end
 
     def execute
@@ -101,7 +101,7 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      /^\s*putl\s+/
+      /^\s* putl\s+/x
     end
 
     def execute
@@ -138,7 +138,7 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      /^\s*ps\s+/
+      /^\s* ps\s+/x
     end
 
     def execute

data/lib/byebug/commands/finish.rb

@@ -14,7 +14,7 @@ module Byebug
       if not @match[1]
         frame_pos = @state.frame_pos
       else
-        frame_pos = get_int(@match[1], "Finish", 0, max_frame-1, 0)
+        frame_pos = get_int(@match[1], "finish", 0, max_frame-1, 0)
         return nil unless frame_pos
       end
       @state.context.step_out frame_pos

data/lib/byebug/commands/frame.rb

@@ -103,13 +103,17 @@ module Byebug
     end
 
     def print_backtrace
-      realsize = caller_locations.
-        drop_while{ |l| IGNORED_FILES.include?(l.path) || l.path == '(eval)' }.
-        take_while{ |l| !IGNORED_FILES.include?(l.path) }.size
-      if @state.context.stack_size != realsize
-        errmsg "Warning, Byebug's stacksize (#{@state.context.stack_size}) is" \
-               " incorrect (must be #{realsize}). This might be a bug in " \
-               "byebug or ruby's debugging API's\n"
+      if Byebug.post_mortem?
+        realsize = @state.context.stack_size
+      else
+        realsize = Thread.current.backtrace_locations.
+          drop_while{ |l| IGNORED_FILES.include?(l.path) || l.path == '(eval)' }.
+          take_while{ |l| !IGNORED_FILES.include?(l.path) }.size
+        size = @state.context.stack_size
+        if size != realsize
+          errmsg "Byebug's stacksize (#{size}) should be #{realsize}. " \
+                 "This might be a bug in byebug or ruby's debugging API's\n"
+        end
       end
       (0...realsize).each do |idx|
         print_frame(idx)
@@ -120,7 +124,7 @@ module Byebug
       file = @state.context.frame_file pos
       line = @state.context.frame_line pos
 
-      unless Command.settings[:frame_fullpath]
+      unless Command.settings[:fullpath]
         path_components = file.split(/[\\\/]/)
         if path_components.size > 3
           path_components[0...-3] = '...'

data/lib/byebug/commands/info.rb

@@ -44,7 +44,7 @@ module Byebug
        ['variables', 1,
         'Local and instance variables of the current stack frame']
       ].map do |name, min, short_help, long_help|
-      SubcmdStruct.new(name, min, short_help, long_help)
+        Subcmd.new(name, min, short_help, long_help)
     end unless defined?(Subcommands)
 
     InfoFileSubcommands =
@@ -59,11 +59,11 @@ module Byebug
        ['path', 4, 'Show full file path name for file'],
        ['sha1', 1, 'Show SHA1 hash of contents of the file']
       ].map do |name, min, short_help, long_help|
-      SubcmdStruct.new(name, min, short_help, long_help)
-    end unless defined?(InfoFileSubcommands)
+        Subcmd.new(name, min, short_help, long_help)
+      end unless defined?(InfoFileSubcommands)
 
     def regexp
-      /^\s* i(?:nfo)? (?:\s+(.+))? \s*$/ix
+      /^\s* i(?:nfo)? (?:\s+(.+))? \s*$/x
     end
 
     def execute
@@ -72,16 +72,16 @@ module Byebug
       args = @match[1].split(/[ \t]+/)
       param = args.shift
       subcmd = Command.find(Subcommands, param)
-      if subcmd
+      return errmsg "Unknown info command #{param}\n" unless subcmd
+
+      if @state.context
         send("info_#{subcmd.name}", *args)
       else
-        errmsg "Unknown info command #{param}\n"
+        errmsg "info_#{subcmd.name} not available without a context.\n"
       end
     end
 
     def info_args(*args)
-      return errmsg "No frame selected.\n" unless @state.context
-
       locals = @state.context.frame_locals
       args = @state.context.frame_args
       return if args == [[:rest]]
@@ -106,9 +106,6 @@ module Byebug
     private :info_breakpoint
 
     def info_breakpoints(*args)
-      return errmsg "\"info breakpoints\" not available here.\n" unless
-        @state.context
-
       return print "No breakpoints.\n" if Byebug.breakpoints.empty?
 
       brkpts = Byebug.breakpoints.sort_by{|b| b.id}
@@ -123,9 +120,6 @@ module Byebug
     end
 
     def info_display(*args)
-      return errmsg "\"info display\" not available here.\n" unless
-        @state.context
-
       return print "There are no auto-display expressions now.\n" unless
         @state.display.find{|d| d[0]}
 
@@ -207,38 +201,35 @@ module Byebug
     end
 
     def info_instance_variables(*args)
-      return errmsg "\"info instance_variables\" not available here.\n" unless
-        @state.context
-
       obj = debug_eval('self')
       var_list(obj.instance_variables)
     end
 
     def info_line(*args)
-      return errmsg "\"info line\" not available here.\n" unless @state.context
       print "Line #{@state.line} of \"#{@state.file}\"\n"
     end
 
     def info_locals(*args)
-      return errmsg "\"info locals\" not available here.\n" unless
-        @state.context
-
       locals = @state.context.frame_locals
-      locals.keys.sort.each do |name|
-        ### FIXME: make a common routine
+      print_hash(locals)
+    end
+
+    def print_hash(vars)
+      vars.keys.sort.each do |name|
         begin
-          s = "#{name} = #{locals[name].inspect}"
+          s = "#{name} = #{vars[name].inspect}"
         rescue
           begin
-          s = "#{name} = #{locals[name].to_s}"
+          s = "#{name} = #{vars[name].to_s}"
           rescue
-            s = "*Error in evaluation*"
+            s = "#{name} = *Error in evaluation*"
           end
         end
         pad_with_dots(s)
         print "#{s}\n"
       end
     end
+    private :print_hash
 
     def info_stop_reason(stop_reason)
       case stop_reason
@@ -255,9 +246,6 @@ module Byebug
     private :info_stop_reason
 
     def info_program(*args)
-      return errmsg "The program being debugged is not being run.\n" unless
-        @state.context
-
       return print "The program crashed.\n" + Byebug.last_exception ?
                    "Exception: #{Byebug.last_exception.inspect}" : "" + "\n" if
         @state.context.dead?
@@ -267,39 +255,19 @@ module Byebug
     end
 
     def info_stack(*args)
-      return errmsg "\"info stack\" not available here.\n" unless @state.context
-
       print_backtrace
     end
 
     def info_global_variables(*args)
-      return errmsg "\"info global_variables\" not available here.\n" unless
-        @state.context
-
       var_global
     end
 
     def info_variables(*args)
-      return errmsg "\"info variables\" not available here.\n" unless
-        @state.context
-
-      obj = debug_eval('self')
       locals = @state.context.frame_locals
       locals[:self] = @state.context.frame_self(@state.frame_pos)
-      locals.keys.sort.each do |name|
-        ### FIXME: make a common routine
-        begin
-          s = "#{name} = #{locals[name].inspect}"
-        rescue
-          begin
-            s = "#{name} = #{locals[name].to_s}"
-          rescue
-            s = "#{name} = *Error in evaluation*"
-          end
-        end
-        pad_with_dots(s)
-        print "#{s}\n"
-      end
+      print_hash(locals)
+
+      obj = debug_eval('self')
       var_list(obj.instance_variables, obj.instance_eval{binding()})
       var_class_self
     end

data/lib/byebug/commands/kill.rb

@@ -5,11 +5,7 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      / ^\s*
-         (?:kill) \s*
-         (?:\s+(\S+))?\s*
-         $
-      /ix
+      /^\s* (?:kill) \s* (?:\s+(\S+))? \s*$/x
     end
 
     def execute

data/lib/byebug/commands/list.rb

@@ -28,7 +28,7 @@ module Byebug
       b, e = set_line_range(Command.settings[:listsize], lines.size)
       return @state.previous_line if b < 0
 
-      print "[#{b}, #{e}] in #{@state.file}\n"
+      print "\n[#{b}, #{e}] in #{@state.file}\n"
       @state.previous_line = display_list(b, e, lines, @state.line)
     end
 
@@ -114,6 +114,7 @@ module Byebug
             end
           end
         end
+        print "\n"
         return e == lines.size ? @state.previous_line : b
       end
   end

data/lib/byebug/commands/quit.rb

@@ -5,7 +5,7 @@ module Byebug
     self.allow_in_control = true
 
     def regexp
-      /^\s* (?:q(?:uit)?|exit) \s* (!|\s+unconditionally)? \s*$/ix
+      /^\s* (?:q(?:uit)?|exit) \s* (!|\s+unconditionally)? \s*$/x
     end
 
     def execute

data/lib/byebug/commands/repl.rb

@@ -74,11 +74,11 @@ module Byebug
       when :cont
         @state.proceed
       when :step
-        force = Command.settings[:force_stepping]
+        force = Command.settings[:forcestep]
         @state.context.step_into 1, force
         @state.proceed
       when :next
-        force = Command.settings[:force_stepping]
+        force = Command.settings[:forcestep]
         @state.context.step_over 1, @state.frame_pos, force
         @state.proceed
       else

data/lib/byebug/commands/save.rb

@@ -49,7 +49,7 @@ module Byebug
     end
 
     def regexp
-      /^\s* sa(?:ve)? (?:\s+(\S+))? \s*$/ix
+      /^\s* sa(?:ve)? (?:\s+(\S+))? \s*$/x
     end
 
     def execute

data/lib/byebug/commands/set.rb

@@ -1,5 +1,69 @@
 module Byebug
 
+  # Mix-in module to setting settings
+  module SetFunctions
+
+    def set_setting(setting_name, setting_value, setting_args)
+      case setting_name
+      when /^args$/
+        if defined?(Byebug::BYEBUG_SCRIPT)
+          Command.settings[:argv][1..-1] = setting_args
+        else
+          Command.settings[:argv] = setting_args
+        end
+      when /^autoirb$/
+        Command.settings[:autoirb] = (setting_value ? 1 : 0)
+      when /^autolist$/
+        Command.settings[:autolist] = (setting_value ? 1 : 0)
+      when /^callstyle$/
+        if setting_args[0] and ['short', 'long'].include?(setting_args[0])
+          Command.settings[:callstyle] = setting_args[0].to_sym
+        else
+          print "Invalid callstyle. Should be one of: \"short\" or \"long\"\n"
+        end
+      when /^history$/
+        try_subcmd = setting_args[0]
+        subcmd = Command.find(SetCommand::SetHistorySubcommands, try_subcmd)
+        return print "Invalid history parameter #{try_subcmd}. Should be" \
+                     ' "filename", "save" or "size"' unless subcmd
+
+        sub_sub_cmd = setting_args[1]
+        iface = @state.interface
+        case subcmd.name
+        when /^save$/
+          iface.history_save = sub_sub_cmd ? get_onoff(sub_sub_cmd) : true
+        when /^size$/
+          return print 'You need to specify the history size' unless sub_sub_cmd
+          iface.history_length = get_int(sub_sub_cmd, "Set history size")
+        when /^filename$/
+          return print 'You need to specify a filename' unless sub_sub_cmd
+          iface.histfile = File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", sub_sub_cmd)
+        end
+      when /^linetrace$/
+        Byebug.tracing = setting_value
+      when /^listsize$/
+        listsize = get_int(setting_args[0], "Set listsize", 1, nil, 10)
+        return unless listsize
+        Command.settings[:listsize] = listsize
+      when /^width$/
+        return unless width = get_int(setting_args[0], "Set width", 10, nil, 80)
+        Command.settings[:width] = width
+      when /^post_mortem$/
+        if setting_value
+          Byebug.post_mortem
+        else
+          Byebug.post_mortem = false
+        end
+      when /^autoeval|autoreload|basename|forcestep|fullpath|linetrace_plus|
+             testing|stack_trace_on_error$/x
+        Command.settings[setting_name.to_sym] = setting_value
+      else
+        return print "Unknown setting #{@match[1]}.\n"
+      end
+    end
+  end
+
+
   # Implements byebug "set" command.
   class SetCommand < Command
     SubcmdStruct2 = Struct.new(:name,
@@ -10,12 +74,8 @@ module Byebug
 
     Subcommands =
       [
-       ['annotate', 2, false, 'Set annotation level',
-        '0 == normal; '                                                    \
-        '2 == output annotated suitably for use by programs that control ' \
-        'byebug'],
        ['args', 2, false,
-        'Set argument list to give program being debugged when it is started'],
+        'Set argument list to the program being debugged when it is started'],
        ['autoeval', 4, true, 'Evaluate every unrecognized command'],
        ['autolist', 4, true, 'Execute "list" command on every breakpoint'],
        ['autoirb', 4, true, 'Invoke IRB on every stop'],
@@ -26,27 +86,34 @@ module Byebug
        ['forcestep', 2, true,
         'Make sure "next/step" commands always move to a new line'],
        ['fullpath', 2, true, 'Display full file names in frames'],
-       ['history', 2, false,
-        'Generic command for setting command history parameters',
-        'set history filename -- Set the filename in which to record the ' \
-        'command history'                                                  \
-        'set history save -- Set saving of the history record on exit'     \
-        'set history size -- Set the size of the command history'],
-       ['linetrace+', 10, true,
+       ['history', 2, false, 'Command for setting command history parameters',
+        'History parameters are "filename", "save" and "size"'],
+       ['linetrace', 3, true, 'Enable line execution tracing'],
+       ['linetrace_plus', 10, true,
         'Set line execution tracing to show different lines'],
-       ['linetrace', 3, true, 'Set line execution tracing'],
        ['listsize', 3, false, 'Set number of source lines to list by default'],
-       ['trace', 1, true, 'Display stack trace when "eval" raises exception'],
+       ['post_mortem', 2, true, 'Enable post-mortem mode'],
+       ['stack_trace_on_error', 1, true,
+        'Display stack trace when "eval" raises exception'],
        ['width', 1, false,
         'Number of characters per line for byebug\'s output']
       ].map do |name, min, is_bool, short_help, long_help|
       SubcmdStruct2.new(name, min, is_bool, short_help, long_help)
     end unless defined?(Subcommands)
 
+    SetHistorySubcommands =
+      [
+       ['filename', 1, 'Set the filename in which to record command history'],
+       ['save', 1, 'Set saving of the history record on exit'],
+       ['size', 1, 'Set the size of the command history']
+      ].map do |name, min, short_help, long_help|
+        Subcmd.new(name, min, short_help, long_help)
+      end unless defined?(SetHistorySubcommands)
+
     self.allow_in_control = true
 
     def regexp
-      /^\s* set (?:\s+(.*))? \s*$/ix
+      /^\s* set (?:\s+(.*))? \s*$/x
     end
 
     def execute
@@ -63,8 +130,6 @@ module Byebug
       end
 
       subcmd = Command.find(Subcommands, try_subcmd)
-
-      # Subcommand not found...
       return print "Unknown set command \"#{try_subcmd}\"\n" unless subcmd
 
       begin
@@ -73,79 +138,8 @@ module Byebug
         return
       end
 
-      case subcmd.name
-      when /^annotate$/
-        level = get_int(args[0], "Set annotate", 0, 3, 0)
-        if level
-          Byebug.annotate = level
-        else
-          return
-        end
-      when /^args$/
-        if defined?(Byebug::BYEBUG_SCRIPT)
-          Command.settings[:argv][1..-1] = args
-        else
-          Command.settings[:argv] = args
-        end
-      when /^autolist$/
-        Command.settings[:autolist] = (set_on ? 1 : 0)
-      when /^autoeval$/
-        Command.settings[:autoeval] = set_on
-      when /^basename$/
-        Command.settings[:basename] = set_on
-      when /^callstyle$/
-        if args[0] and (args[0] == 'short' or args[0] == 'long')
-          Command.settings[:callstyle] = args[0].to_sym
-        else
-          print "Invalid callstyle. Should be one of: \"short\" or \"long\"\n"
-        end
-      when /^trace$/
-        Command.settings[:stack_trace_on_error] = set_on
-      when /^fullpath$/
-        Command.settings[:frame_fullpath] = set_on
-      when /^autoreload$/
-        Command.settings[:autoreload] = set_on
-      when /^autoirb$/
-        Command.settings[:autoirb] = (set_on ? 1 : 0)
-      when /^testing$/
-        Command.settings[:testing] = set_on
-      when /^forcestep$/
-        Command.settings[:force_stepping] = set_on
-      when /^history$/
-        if 2 == args.size
-          interface = @state.interface
-          case args[0]
-          when /^save$/
-            interface.history_save = get_onoff(args[1])
-          when /^size$/
-            interface.history_length =
-              get_int(args[1], "Set history size")
-          when /^filename$/
-            interface.histfile =
-              File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", args[1])
-          else
-            print "Invalid history parameter #{args[0]}. Should be " \
-                  "\"filename\", \"save\" or \"size\".\n"
-          end
-        else
-          print 'Need two parameters for "set history"; got ' \
-                "#{args.size}.\n"
-          return
-        end
-      when /^linetrace\+$/
-        self.class.settings[:tracing_plus] = set_on
-      when /^linetrace$/
-        Byebug.tracing = set_on
-      when /^listsize$/
-        listsize = get_int(args[0], "Set listsize", 1, nil, 10)
-        return unless listsize
-        self.class.settings[:listsize] = listsize
-      when /^width$/
-        return unless width = get_int(args[0], "Set width", 10, nil, 80)
-        Command.settings[:width] = width
-      else
-        return print "Unknown setting #{@match[1]}.\n"
-      end
+      set_setting(subcmd.name, set_on, args)
+
       return print "#{show_setting(subcmd.name)}\n"
     end