byebug 1.0.1 → 1.0.2

data/lib/byebug/commands/frame.rb

@@ -78,6 +78,17 @@ module Byebug
       return call_str
     end
 
+    def print_backtrace
+      (0...@state.context.stack_size).each do |idx|
+        if idx == @state.frame_pos
+          print "--> "
+        else
+          print "    "
+        end
+        print_frame(idx)
+      end
+    end
+
     def print_frame(pos, adjust = false, context=@state.context)
       file = context.frame_file(pos)
       line = context.frame_line(pos)
@@ -91,12 +102,12 @@ module Byebug
         end
       end
 
-      frame_num = "##{pos}"
+      frame_num = "##{pos} "
       call_str = get_frame_call(frame_num, pos, context)
-      file_line = "at line #{CommandProcessor.canonic_file(file)}:#{line}\n"
+      file_line = "at #{CommandProcessor.canonic_file(file)}:#{line}\n"
       print frame_num
       unless call_str.empty?
-        print call_str
+        print "#{call_str} "
         if call_str.size + frame_num.size + file_line.size > self.class.settings[:width]
           print "\n       "
         end
@@ -159,17 +170,9 @@ module Byebug
     end
 
     def execute
-      (0...@state.context.stack_size).each do |idx|
-        if idx == @state.frame_pos
-          print "--> "
-        else
-          print "    "
-        end
-        print_frame(idx)
-
-      end
+      print_backtrace
       if truncated_callstack?(@state.context, Byebug.start_sentinal)
-#        print "Warning: saved frames may be incomplete; compare with caller(0).\n"
+         print "Warning: saved frames may be incomplete; compare with caller(0).\n"
       end
     end
 
@@ -182,17 +185,19 @@ module Byebug
         s = if cmd == 'where'
           %{
             w[here]\tdisplay stack frames
-            }
+           }
             else
           %{
             bt|backtrace\t\talias for where - display stack frames
-         }
+           }
             end
         s += %{
-Print the entire stack frame. Each frame is numbered, the most recent
-frame is 0. frame number can be referred to in the "frame" command;
-"up" and "down" add or subtract respectively to frame numbers shown.
-The position of the current frame is marked with -->.  }
+            Print the entire stack frame. Each frame is numbered, the most
+            recent frame is 0. frame number can be referred to in the "frame"
+            command; "up" and "down" add or subtract respectively to frame
+            numbers shown. The position of the current frame is marked with
+            -->.
+              }
       end
     end
   end

data/lib/byebug/commands/info.rb

@@ -14,53 +14,55 @@ module Byebug
         print "No exceptions set to be caught.\n"
       end
     end
-
   end
 
   # Implements byebug "info" command.
   class InfoCommand < Command
     self.allow_in_control = true
-    Subcommands = [
-      ['args', 1, 'Argument variables of current stack frame'],
-      ['breakpoints', 1, 'Status of user-settable breakpoints',
-       'Without argument, list info about all breakpoints. With an integer ' \
-       'argument, list info on that breakpoint.'],
-      ['catch', 3, 'Exceptions that can be caught in the current stack frame'],
-      ['display', 2, 'Expressions to display when program stops'],
-      ['file', 4, 'Info about a particular file read in',
-       'After the file name is supplied, you can list file attributes that ' \
-       'you wish to see. Attributes include: "all", "basic", "breakpoint", ' \
-       '"lines", "mtime", "path" and "sha1".'],
-      ['files', 5, 'File names and timestamps of files read in'],
-      ['global_variables', 2, 'Global variables'],
-      ['instance_variables', 2,
-       'Instance variables of the current stack frame'],
-      ['line', 2,
-       'Line number and file name of current position in source file'],
-      ['locals', 2, 'Local variables of the current stack frame'],
-      ['program', 2, 'Execution status of the program'],
-      ['stack', 2, 'Backtrace of the stack'],
-#     ['thread', 6,  'List info about thread NUM',
-#      'If no thread number is given, we list info for all threads. '         \
-#      '\'terse\' and \'verbose\' options are possible. If \'terse\', just '  \
-#      'give summary thread name information. See "help info threads" for '   \
-#      'more detail about this summary information. If \'verbose\' appended ' \
-#      'to the end of the command, then the entire stack trace is given for ' \
-#      'each thread.'],
-#     ['threads', 7, 'information of currently-known threads',
-#      'This information includes whether the thread is the current thread ' \
-#      '(+), it\'s suspended ($) or it\'s ignored (!), plus the thread '     \
-#      'number and the top stack item. If \'verbose\' is given then the '    \
-#      'entire stack frame is shown.'],
-      ['variables', 1,
-       'Local and instance variables of the current stack frame']
+    Subcommands =
+      [
+       ['args', 1, 'Argument variables of current stack frame'],
+       ['breakpoints', 1, 'Status of user-settable breakpoints',
+        'Without argument, list info about all breakpoints. With an integer ' \
+        'argument, list info on that breakpoint.'],
+       ['catch', 3,
+        'Exceptions that can be caught in the current stack frame'],
+       ['display', 2, 'Expressions to display when program stops'],
+       ['file', 4, 'Info about a particular file read in',
+        'After the file name is supplied, you can list file attributes that ' \
+        'you wish to see. Attributes include: "all", "basic", "breakpoint", ' \
+        '"lines", "mtime", "path" and "sha1".'],
+       ['files', 5, 'File names and timestamps of files read in'],
+       ['global_variables', 2, 'Global variables'],
+       ['instance_variables', 2,
+        'Instance variables of the current stack frame'],
+       ['line', 2,
+        'Line number and file name of current position in source file'],
+       ['locals', 2, 'Local variables of the current stack frame'],
+       ['program', 2, 'Execution status of the program'],
+       ['stack', 2, 'Backtrace of the stack'],
+#      ['thread', 6,  'List info about thread NUM',
+#       'If no thread number is given, we list info for all threads. "terse"' \
+#       ' and "verbose" options are possible. If "terse", just give summary ' \
+#       'thread name information. See "help info threads" for more detail '   \
+#       'about this summary information. If "verbose" is appended to the end' \
+#       ' of the command, then the entire stack trace is given for each '     \
+#       'thread.'],
+#      ['threads', 7, 'information of currently-known threads',
+#       'This information includes whether the thread is the current thread ' \
+#       '(+), it\'s suspended ($) or it\'s ignored (!), plus the thread '     \
+#       'number and the top stack item. If "verbose" is given then the '      \
+#       'entire stack frame is shown.'],
+       ['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)
     end unless defined?(Subcommands)
 
-    InfoFileSubcommands = [
-       ['all', 1, 'All file information available - breakpoints, lines, mtime' \
-         ', path and sha1'],
+    InfoFileSubcommands =
+      [
+       ['all', 1, 'All file information available - breakpoints, lines, ' \
+        'mtime, path and sha1'],
        ['basic', 2, 'basic information - path, number of lines'],
        ['breakpoints', 2, 'Show trace line numbers',
         'These are the line number where a breakpoint can be set.'],
@@ -72,7 +74,8 @@ module Byebug
       SubcmdStruct.new(name, min, short_help, long_help)
     end unless defined?(InfoFileSubcommands)
 
-#   InfoThreadSubcommands = [
+#   InfoThreadSubcommands =
+#     [
 #      ['terse', 1, 'summary information'],
 #      ['verbose', 1, 'summary information and stack frame info'],
 #     ].map do |name, min, short_help, long_help|
@@ -84,17 +87,15 @@ module Byebug
     end
 
     def execute
-      if !@match[1]
-        print_subcommands
+      return print_subcmds(Subcommands) unless @match[1]
+
+      args = @match[1].split(/[ \t]+/)
+      param = args.shift
+      subcmd = find(Subcommands, param)
+      if subcmd
+        send("info_#{subcmd.name}", *args)
       else
-        args = @match[1].split(/[ \t]+/)
-        param = args.shift
-        subcmd = find(Subcommands, param)
-        if subcmd
-          send("info_#{subcmd.name}", *args)
-        else
-          errmsg "Unknown info command #{param}\n"
-        end
+        errmsg "Unknown info command #{param}\n"
       end
     end
 
@@ -167,24 +168,17 @@ module Byebug
     end
 
     def info_file(*args)
-      unless args[0]
-        info_files
-        return
-      end
+      return info_files unless args[0]
       file = args[0]
-      param =  args[1]
 
-      param = 'basic' unless param
+      param =  args[1] ? args[1] : 'basic'
+
       subcmd = find(InfoFileSubcommands, param)
-      unless subcmd
-        errmsg "Invalid parameter #{param}\n"
-        return
-      end
+      return errmsg "Invalid parameter #{param}\n" unless subcmd
 
       unless LineCache::cached?(file)
         unless LineCache::cached_script?(file)
-          print "File #{file} is not cached\n"
-          return
+          return print "File #{file} is not cached\n"
         end
         LineCache::cache(file, Command.settings[:reload_source_on_change])
       end
@@ -192,10 +186,9 @@ module Byebug
       print "File #{file}"
       path = LineCache.path(file)
       if %w(all basic path).member?(subcmd.name) and path != file
-        print " - %s\n", path
-      else
-        print "\n"
+        print " - #{path}"
       end
+      print "\n"
 
       if %w(all basic lines).member?(subcmd.name)
         lines = LineCache.size(file)
@@ -214,6 +207,7 @@ module Byebug
         stat = LineCache.stat(file)
         print "\t%s\n", stat.mtime if stat
       end
+
       if %w(all sha1).member?(subcmd.name)
         print "\t%s\n", LineCache.sha1(file)
       end
@@ -304,14 +298,7 @@ module Byebug
         errmsg "info stack not available here.\n"
         return
       end
-      (0...@state.context.stack_size).each do |idx|
-        if idx == @state.frame_pos
-          print "--> "
-        else
-          print "    "
-        end
-        print_frame(idx)
-      end
+      print_backtrace
     end
 
 #   def info_thread_preamble(arg)
@@ -407,33 +394,25 @@ module Byebug
       end
 
       def help(args)
+        # specific subcommand help
         if args[1]
-          s = args[1]
-          subcmd = Subcommands.find do |try_subcmd|
-            (s.size >= try_subcmd.min) and
-              (try_subcmd.name[0..s.size-1] == s)
-          end
-          if subcmd
-            str = subcmd.short_help + '.'
-            if 'file' == subcmd.name and args[2]
-              s = args[2]
-              subsubcmd = InfoFileSubcommands.find do |try_subcmd|
-                (s.size >= try_subcmd.min) and
-                  (try_subcmd.name[0..s.size-1] == s)
-              end
-              if subsubcmd
-                str += "\n" + subsubcmd.short_help + '.'
-              else
-                str += "\nInvalid file attribute #{args[2]}."
-              end
-            else
-              str += "\n" + subcmd.long_help if subcmd.long_help
-            end
-            return str
+          subcmd = find(Subcommands, args[1])
+          return "Invalid \"info\" subcommand \"#{args[1]}\"." unless subcmd
+
+          str = subcmd.short_help + '.'
+          if 'file' == subcmd.name and args[2]
+            subsubcmd = find(InfoFileSubcommands, args[2])
+            return str += "\nInvalid \"file\" attribute \"#{args[2]}\"." \
+              unless subsubcmd
+
+            str += "\n" + subsubcmd.short_help + '.'
           else
-            return "Invalid 'info' subcommand '#{args[1]}'."
+            str += "\n" + subcmd.long_help if subcmd.long_help
           end
+          return str
         end
+
+        # general help
         s = %{
           Generic command for showing things about the program being debugged.
           --

data/lib/byebug/commands/list.rb

@@ -10,6 +10,9 @@ module Byebug
       ListCommand.always_run = value
     end
 
+    # Set default value
+    Command.settings[:autolist] = 1
+
     def regexp
       /^\s* l(?:ist)? (?:\s*([-=])|\s+(.+))? $/x
     end

data/lib/byebug/commands/set.rb

@@ -4,35 +4,37 @@ module Byebug
   class SetCommand < Command
     SubcmdStruct2=Struct.new(:name, :min, :is_bool, :short_help,
                              :long_help) unless defined?(SubcmdStruct2)
-    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'],
-      ['autoeval', 4, true, "Evaluate every unrecognized command"],
-      ['autolist', 4, true, "Execute 'list' command on every breakpoint"],
-      ['autoirb', 4, true, "Invoke IRB on every stop"],
-      ['autoreload', 4, true, "Reload source code when changed"],
-      ['basename', 1, true, "Report file basename only showing file names"],
-      ['callstyle', 2, false, "Set how you want call parameters displayed"],
-      ['byebugtesting', 8, false, "Used when testing 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,
-       '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"],
-      ['width', 1, false, 'Number of characters per line for byebug\'s output']
+    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'],
+       ['autoeval', 4, true, 'Evaluate every unrecognized command'],
+       ['autolist', 4, true, 'Execute "list" command on every breakpoint'],
+       ['autoirb', 4, true, 'Invoke IRB on every stop'],
+       ['autoreload', 4, true, 'Reload source code when changed'],
+       ['basename', 1, true, 'Report file basename only showing file names'],
+       ['callstyle', 2, false, 'Set how you want call parameters displayed'],
+       ['byebugtesting', 8, false, 'Used when testing 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,
+        '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'],
+       ['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)
@@ -44,129 +46,119 @@ module Byebug
     end
 
     def execute
-      if not @match[1]
-        print_subcommands
+      # "Set" alone just prints subcommands
+      return print_subcmds(Subcommands) unless @match[1]
+
+      args = @match[1].split(/[ \t]+/)
+      try_subcmd = args.shift
+      try_subcmd.downcase!
+      if try_subcmd =~ /^no/i
+        set_on = false
+        try_subcmd = try_subcmd[2..-1]
       else
-        args = @match[1].split(/[ \t]+/)
-        subcmd = args.shift
-        subcmd.downcase!
-        if subcmd =~ /^no/i
-          set_on = false
-          subcmd = subcmd[2..-1]
+        set_on = true
+      end
+
+      subcmd = find(Subcommands, try_subcmd)
+
+      # Subcommand not found...
+      return print "Unknown set command \"#{try_subcmd}\"\n" unless subcmd
+
+      set_on = get_onoff(args[0]) if subcmd.is_bool and args.size > 0
+
+      case subcmd.name
+      when /^annotate$/
+        level = get_int(args[0], "Set annotate", 0, 3, 0)
+        if level
+          Byebug.annotate = level
         else
-          set_on = true
+          return
+        end
+        if defined?(Byebug::RDEBUG_SCRIPT)
+          # byebug was called initially. 1st arg is script name.
+          Command.settings[:argv][1..-1] = args
+        else
+          # byebug wasn't called initially. 1st arg is not script name.
+          Command.settings[:argv] = args
+        end
+      when /^args$/
+        Command.settings[:argv][1..-1] = args
+      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]
+          arg = args[0].downcase.to_sym
+          case arg
+          when :short, :last, :tracked
+            Command.settings[:callstyle] = arg
+          else
+            print "Invalid call style #{arg}. Should be one of: " \
+                  "'short', 'last' or 'tracked'.\n"
+          end
+        end
+      when /^trace$/
+        Command.settings[:stack_trace_on_error] = set_on
+      when /^fullpath$/
+        Command.settings[:full_path] = set_on
+      when /^autoreload$/
+        Command.settings[:reload_source_on_change] = set_on
+      when /^autoirb$/
+        Command.settings[:autoirb] = (set_on ? 1 : 0)
+      when /^byebugtesting$/
+        Command.settings[:byebugtesting] = set_on
+        if set_on
+          Command.settings[:basename] = true
         end
-        for try_subcmd in Subcommands do
-          if (subcmd.size >= try_subcmd.min) and
-              (try_subcmd.name[0..subcmd.size-1] == subcmd)
-            begin
-              if try_subcmd.is_bool
-                if args.size > 0
-                  set_on = get_onoff(args[0])
-                end
-              end
-              case try_subcmd.name
-              when /^annotate$/
-                level = get_int(args[0], "Set annotate", 0, 3, 0)
-                if level
-                  Byebug.annotate = level
-                else
-                  return
-                end
-                if defined?(Byebug::RDEBUG_SCRIPT)
-                  # byebug was called initially. 1st arg is script name.
-                  Command.settings[:argv][1..-1] = args
-                else
-                  # byebug wasn't called initially. 1st arg is not script name.
-                  Command.settings[:argv] = args
-                end
-              when /^args$/
-                Command.settings[:argv][1..-1] = args
-              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]
-                  arg = args[0].downcase.to_sym
-                  case arg
-                  when :short, :last, :tracked
-                    Command.settings[:callstyle] = arg
-                  else
-                    print "Invalid call style #{arg}. Should be one of: " \
-                          "'short', 'last' or 'tracked'.\n"
-                  end
-                end
-              when /^trace$/
-                Command.settings[:stack_trace_on_error] = set_on
-              when /^fullpath$/
-                Command.settings[:full_path] = set_on
-              when /^autoreload$/
-                Command.settings[:reload_source_on_change] = set_on
-              when /^autoirb$/
-                Command.settings[:autoirb] = (set_on ? 1 : 0)
-              when /^byebugtesting$/
-                Command.settings[:byebugtesting] = set_on
-                if set_on
-                  Command.settings[:basename] = true
-                end
-              when /^forcestep$/
-                self.class.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$/
-                Command.settings[:tracing] = set_on
-              when /^listsize$/
-                listsize = get_int(args[0], "Set listsize", 1, nil, 10)
-                if listsize
-                  self.class.settings[:listsize] = listsize
-                else
-                  return
-                end
-              when /^width$/
-                width = get_int(args[0], "Set width", 10, nil, 80)
-                if width
-                  self.class.settings[:width] = width
-                  ENV['COLUMNS'] = width.to_s
-                else
-                  return
-                end
-              else
-                print "Unknown setting #{@match[1]}.\n"
-                return
-              end
-              print "#{show_setting(try_subcmd.name)}\n"
-              return
-            rescue RuntimeError
-              return
-            end
+      when /^forcestep$/
+        self.class.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$/
+        Command.settings[:tracing] = set_on
+      when /^listsize$/
+        listsize = get_int(args[0], "Set listsize", 1, nil, 10)
+        if listsize
+          self.class.settings[:listsize] = listsize
+        else
+          return
+        end
+      when /^width$/
+        width = get_int(args[0], "Set width", 10, nil, 80)
+        if width
+          self.class.settings[:width] = width
+          ENV['COLUMNS'] = width.to_s
+        else
+          return
         end
-        print "Unknown set command #{subcmd}\n"
+      else
+        return print "Unknown setting #{@match[1]}.\n"
       end
+      return print "#{show_setting(subcmd.name)}\n"
     end
 
     class << self
@@ -175,20 +167,17 @@ module Byebug
       end
 
       def help(args)
+        # specific subcommand help
         if args[1]
-          s = args[1]
-          subcmd = Subcommands.find do |try_subcmd|
-            (s.size >= try_subcmd.min) and
-              (try_subcmd.name[0..s.size-1] == s)
-          end
-          if subcmd
-            str = subcmd.short_help + '.'
-            str += "\n" + subcmd.long_help if subcmd.long_help
-            return str
-          else
-            return "Invalid 'set' subcommand '#{args[1]}'."
-          end
+          subcmd = find(Subcommands, args[1])
+          return "Invalid \"set\" subcommand \"#{args[1]}\"." unless subcmd
+
+          str = subcmd.short_help + '.'
+          str += "\n" + subcmd.long_help if subcmd.long_help
+          return str
         end
+
+        # general help
         s = %{
           Modifies parts of byebug environment. Boolean values take
           on, off, 1 or 0.