byebug 1.1.0 → 1.1.1

data/lib/byebug/commands/eval.rb

@@ -53,22 +53,15 @@ module Byebug
     end
 
     class << self
-      def help_command
-        %w|p eval|
+      def names
+        %w(p eval)
       end
 
-      def help(cmd)
-        if cmd == 'p'
-          %{
-           p expression\tevaluate expression and print its value
-           }
-        else
-          %{
-           e[val] expression\tevaluate expression and print its value,
-           \t\t\talias for p.
-           * NOTE - to turn on autoeval, use 'set autoeval'
-           }
-        end
+      def description
+        %{
+          (p|e[val]) expression\tevaluate expression and print its value
+          * NOTE - to turn on autoeval, use 'set autoeval'
+         }
       end
     end
   end
@@ -91,14 +84,14 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'pp'
+      def names
+        %w(pp)
       end
 
-      def help(cmd)
+      def description
         %{
-         pp expression\tevaluate expression and pretty-print its value
-         }
+          pp expression\tevaluate expression and pretty-print its value
+        }
       end
     end
   end
@@ -128,14 +121,14 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'putl'
+      def names
+        %w(putl)
       end
 
-      def help(cmd)
+      def description
         %{
-         putl expression\tevaluate expression, an array, and columnize its value
-         }
+          putl expression\tevaluate expression, an array, and columnize its value
+        }
       end
     end
   end
@@ -167,14 +160,14 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'ps'
+      def names
+        %w(ps)
       end
 
-      def help(cmd)
+      def description
         %{
-         ps expression\tevaluate expression, an array, sort and columnize its value
-         }
+          ps expression\tevaluate expression, an array, sort and columnize its value
+        }
       end
     end
   end

data/lib/byebug/commands/finish.rb

@@ -17,24 +17,26 @@ module Byebug
         frame_pos = get_int(@match[1], "Finish", 0, max_frame-1, 0)
         return nil unless frame_pos
       end
-      @state.context.stop_frame = frame_pos
+      @state.context.step_out frame_pos
       @state.frame_pos = 0
       @state.proceed
     end
 
     class << self
-      def help_command
-        'finish'
+      def names
+        %w(finish)
       end
 
-      def help(cmd)
+      def description
         %{
-          fin[ish] [frame-number]\tExecute until selected stack frame returns.
+          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. If a frame number
-is given we run until that 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.
+
+          If a frame number is given we run until that frame returns.
         }
       end
     end

data/lib/byebug/commands/frame.rb

@@ -113,11 +113,6 @@ module Byebug
       end
 
       print frame_str
-      #if ENV['EMACS'] && adjust
-      #  fmt = (Byebug.annotate.to_i > 1 ?
-      #         "\032\032source %s:%d\n" : "\032\032%s:%d\n")
-      #  print fmt % [CommandProcessor.canonic_file(file), line]
-      #end
     end
 
     ##
@@ -172,37 +167,29 @@ module Byebug
     def execute
       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)"
       end
     end
 
     class << self
-      def help_command
-        %w|where backtrace|
+      def names
+        %w(where backtrace)
       end
 
-      def help(cmd)
-        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
-            -->.
-            }
+      def description
+        %{
+          w[here]|bt|backtrace\tdisplay stack frames
+
+          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
 
-  class UpCommand < Command # :nodoc:
+  class UpCommand < Command
     def regexp
       /^\s* u(?:p)? (?:\s+(.*))?$/x
     end
@@ -214,13 +201,13 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'up'
+      def names
+        %w(up)
       end
 
-      def help(cmd)
+      def description
         %{
-          up[count]\tmove to higher frame
+          up[ count]\tmove to higher frame
         }
       end
     end
@@ -238,13 +225,13 @@ module Byebug
     end
 
     class << self
-      def help_command
-        'down'
+      def names
+        %w(down)
       end
 
-      def help(cmd)
+      def description
         %{
-          down[count]\tmove to lower frame
+          down[ count]\tmove to lower frame
         }
       end
     end
@@ -255,7 +242,6 @@ module Byebug
       / ^\s*
         f(?:rame)?
         (?: \s+ (\S+))? \s*
-        (?: thread \s+ (.*))? \s*
         $/x
     end
 
@@ -266,26 +252,17 @@ module Byebug
         pos = get_int(@match[1], "Frame")
         return unless pos
       end
-      #if @match[2]
-      #  context = parse_thread_num('frame', @match[2])
-      #  unless context
-      #    errmsg "Thread #{@match[2]} doesn't exist.\n"
-      #    return
-      #  end
-      #else
-      # context = @state.context
-      #end
       adjust_frame(pos, true)
     end
 
     class << self
-      def help_command
-        'frame'
+      def names
+        %w(frame)
       end
 
       def help(cmd)
         %{
-          f[rame] [frame-number [thread thread-number]]
+          f[rame][ frame-number]
 
           Move the current frame to the specified frame number, or the 0 if no
           frame-number has been given.
@@ -296,9 +273,6 @@ module Byebug
           Without an argument, the command prints the current stack frame. Since
           the current position is redisplayed, it may trigger a resyncronization
           if there is a front end also watching over things.
-
-          If a thread number is given then we set the context for evaluating
-          expressions to that frame of that thread.
         }
       end
     end

data/lib/byebug/commands/help.rb

@@ -3,6 +3,7 @@ module Byebug
   # Implements byebug "help" command.
   class HelpCommand < Command
     include Columnize
+
     self.allow_in_control = true
 
     def regexp
@@ -12,41 +13,34 @@ module Byebug
     def execute
       if @match[1]
         args = @match[1].split
-        cmds = @state.commands.select do |cmd|
-          [cmd.help_command].flatten.include?(args[0])
-        end
-      else
-        args = @match[1]
-        cmds = []
-      end
-      unless cmds.empty?
-        help = cmds.map{ |cmd| cmd.help(args) }.join
-        help = help.split("\n").map{|l| l.gsub(/^ +/, '')}
-        help.shift if help.first && help.first.empty?
-        help.pop if help.last && help.last.empty?
-        print help.join("\n")
-      else
-        if args and args[0]
-          errmsg "Undefined command: \"#{args[0]}\".  Try \"help\"."
+        cmds = @state.commands.select { |cmd| cmd.names.include?(args[0]) }
+        unless cmds.empty?
+          help = cmds.map{ |cmd| cmd.help(args) }.join
+          help = help.split("\n").map{|l| l.gsub(/^ +/, '')}
+          help.shift if help.first && help.first.empty?
+          help.pop if help.last && help.last.empty?
+          return print help.join("\n") + "\n"
         else
-          print "byebug help v#{Byebug::VERSION}\n" unless
-            self.class.settings[:byebugtesting]
-          print "Type 'help <command-name>' for help on a specific command\n\n"
-          print "Available commands:\n"
-          cmds = @state.commands.map{ |cmd| cmd.help_command }
-          cmds = cmds.flatten.uniq.sort
-          print columnize(cmds, Command.settings[:width])
+          return errmsg "Undefined command: \"#{args[0]}\".  Try \"help\".\n" if
+            args[0]
         end
       end
-      print "\n"
+
+      print "byebug help v#{Byebug::VERSION}\n" unless
+        Command.settings[:testing]
+
+      print "Type \"help <command-name>\" for help on a specific command\n\n"
+      print "Available commands:\n"
+      cmds = @state.commands.map{ |cmd| cmd.names }.flatten.uniq.sort
+      print columnize(cmds, Command.settings[:width])
     end
 
     class << self
-      def help_command
-        'help'
+      def names
+        %w(help)
       end
 
-      def help(cmd)
+      def description
         %{
           h[elp]\t\tprint this help
           h[elp] command\tprint help on command

data/lib/byebug/commands/info.rb

@@ -43,18 +43,6 @@ module Byebug
        ['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|
@@ -76,20 +64,12 @@ module Byebug
       SubcmdStruct.new(name, min, short_help, long_help)
     end unless defined?(InfoFileSubcommands)
 
-    InfoThreadSubcommands =
-      [
-       ['terse', 1, 'summary information'],
-       ['verbose', 1, 'summary information and stack frame info'],
-      ].map do |name, min, short_help, long_help|
-      SubcmdStruct.new(name, min, short_help, long_help)
-    end unless defined?(InfoThreadSubcommands)
-
     def regexp
       /^\s* i(?:nfo)? (?:\s+(.*))?$/ix
     end
 
     def execute
-      return print format_subcmds(Subcommands) unless @match[1]
+      return help(@match) unless @match[1]
 
       args = @match[1].split(/[ \t]+/)
       param = args.shift
@@ -311,57 +291,6 @@ module Byebug
       print_backtrace
     end
 
-    def info_thread_preamble(arg)
-      if not @state.context
-        errmsg "info threads not available here.\n"
-        return false, false
-      end
-      verbose = if arg
-        subcmd = find(InfoThreadSubcommands, arg)
-        unless subcmd
-          errmsg "'terse' or 'verbose' expected. Got '#{arg}'\n"
-          return false, false
-        end
-        'verbose' == subcmd.name
-      else
-        false
-      end
-      return true, verbose
-    end
-    private :info_thread_preamble
-
-    def info_threads(*args)
-      ok, verbose = info_thread_preamble(args[0])
-      return unless ok
-      threads = Byebug.contexts.sort_by{|c| c.thnum}.each do |c|
-        display_context(c, !verbose)
-        if verbose and not c.ignored?
-          (0...c.stack_size).each do |idx|
-            print "\t"
-            print_frame(idx, true, c)
-          end
-        end
-      end
-    end
-
-    def info_thread(*args)
-      unless args[0]
-        info_threads(args[0])
-        return
-      end
-      ok, verbose = info_thread_preamble(args[1])
-      return unless ok
-      c = parse_thread_num("info thread" , args[0])
-      return unless c
-      display_context(c, !verbose)
-      if verbose and not c.ignored?
-        (0...c.stack_size).each do |idx|
-          print "\t"
-          print_frame(idx, true, c)
-        end
-      end
-    end
-
     def info_global_variables(*args)
       unless @state.context
         errmsg "info global_variables not available here.\n"
@@ -398,35 +327,43 @@ module Byebug
       var_class_self
     end
 
-    class << self
-      def help_command
-        'info'
-      end
-
-      def help(args)
-        # specific subcommand help
-        if args[1]
-          subcmd = find(Subcommands, args[1])
-          return "Invalid \"info\" subcommand \"#{args[1]}\"." unless subcmd
-
+    def help(args)
+      if args[1]
+        subcmd = find(Subcommands, args[1])
+        if 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
-
-            return str += "\n" + subsubcmd.short_help + '.'
+            if subsubcmd
+              str += "\nInvalid \"file\" attribute \"#{args[2]}\"."
+            else
+              str += "\n" + subsubcmd.short_help + '.'
+            end
           else
-            return str += "\n" + subcmd.long_help if subcmd.long_help
+            str += "\n" + subcmd.long_help if subcmd.long_help
           end
+        else
+          str = "Invalid \"info\" subcommand \"#{args[1]}\"."
         end
+      else
+        str = InfoCommand.description + format_subcmds(Subcommands)
+      end
+      print str
+    end
+
+    class << self
+      def names
+        %w(info)
+      end
 
-        # general help
-        str = %{
-          Generic command for showing things about the program being debugged.
+      def description
+        %{
+          info[ subcommand]
+
+          Generic command for showing things about the program being
         }
-        str += format_subcmds(Subcommands)
       end
     end
   end
+
 end