byebug 1.8.2 → 2.0.0

data/lib/byebug/commands/show.rb

@@ -5,9 +5,6 @@ module Byebug
 
     def show_setting(setting_name)
       case setting_name
-      when /^annotate$/
-        Byebug.annotate ||= 0
-        return ("Annotation level is #{Byebug.annotate}")
       when /^args$/
         if Command.settings[:argv] and Command.settings[:argv].size > 0
           if defined?(Byebug::BYEBUG_SCRIPT)
@@ -77,10 +74,10 @@ module Byebug
         on_off = Command.settings[:testing]
         return "Currently testing byebug is #{show_onoff(on_off)}."
       when /^forcestep$/
-        on_off = Command.settings[:force_stepping]
+        on_off = Command.settings[:forcestep]
         return "force-stepping is #{show_onoff(on_off)}."
       when /^fullpath$/
-        on_off = Command.settings[:frame_fullpath]
+        on_off = Command.settings[:fullpath]
         return "Displaying frame's full file names is #{show_onoff(on_off)}."
       when /^history(:?\s+(filename|save|size))?$/
         args = @match[1].split
@@ -119,21 +116,23 @@ module Byebug
       when /^linetrace$/
         on_off = Byebug.tracing?
         return "line tracing is #{show_onoff(on_off)}."
-      when /^linetrace\+$/
-        on_off = Command.settings[:tracing_plus]
-        if on_off
-          return "line tracing style is different consecutive lines."
-        else
+      when /^linetrace_plus$/
+        if Command.settings[:linetrace_plus]
           return "line tracing style is every line."
+        else
+          return "line tracing style is different consecutive lines."
         end
       when /^listsize$/
         listlines = Command.settings[:listsize]
         return "Number of source lines to list is #{listlines}."
-      when /^trace$/
+      when /^post_mortem$/
+        on_off = Byebug.post_mortem?
+        return "post-mortem mode is #{show_onoff(on_off)}"
+      when /^stack_trace_on_error$/
         on_off = Command.settings[:stack_trace_on_error]
         return "Displaying stack trace is #{show_onoff(on_off)}."
       when /^version$/
-        return "byebug #{Byebug::VERSION}"
+        return "Byebug #{Byebug::VERSION}"
       when /^width$/
         return "width is #{Command.settings[:width]}."
       else
@@ -147,53 +146,45 @@ module Byebug
 
     Subcommands =
       [
-       ['annotate', 2, 'Show annotation level',
-        '0 == normal; '                                                    \
-        '2 == output annotated suitably for use by programs that control ' \
-        'byebug'],
-        ['args', 2,
-         'Show argument list to give to the program being debugged when it is' \
-         ' started',
-         'Follow this command with any number of args to be passed to the '    \
-         'program'],
-        ['autoeval', 4, 'Show whether unrecognized commands are evaluated'],
-        ['autolist', 4, 'Show whether "list" command is run on stopping'],
-        ['autoirb', 4, 'Show whether IRB is invoked on stopping'],
-        ['autoreload', 4, 'Show whether source code is reloaded when changed'],
-        ['basename',  1, 'Show whether basename is used when reporting files'],
-        ['callstyle', 2, 'Show paramater style used when showing call frames'],
-        ['commands',  2, 'Show the history of commands you typed',
-         'You can supply a command number to start with'],
-        ['forcestep', 1, 'Show whether "next/step" force to move onto a new ' \
-         'line'],
-        ['fullpath',  2, 'Show whether full paths are displayed in frames'],
-        ['history', 2, 'Generic command to show command history parameters',
-         'show history filename -- Show the filename in which to record the ' \
-         'command history'                                                    \
-         'show history save -- Show whether history record should be saved '  \
-         'on exit'                                                            \
-         'show history size -- Show the size of the command history'],
-        ['linetrace', 3, 'Show line execution tracing'],
-        ['linetrace+', 10,
-         'Show whether different consecutive lines are shown in tracing'],
-        ['listsize', 3, 'Show number of source lines to list by default'],
-        ['port', 3, 'Show server port'],
-        ['post-mortem', 3,
-         'Show whether we go into post-mortem debugging on an uncaught ' \
-         'exception'],
-        ['trace', 1,
-         'Show whether a stack trace is displayed when "eval" raises an ' \
-         'exception'],
-        ['version', 1, 'Show byebug\'s version'],
-        ['width', 1, 'Show the number of characters per line for byebug']
+       ['args', 2,
+        'Show argument list to the program being debugged when it is started',
+        'Follow this command with any number of args to be passed to the '    \
+        'program'],
+       ['autoeval', 4, 'Show whether unrecognized commands are evaluated'],
+       ['autolist', 4, 'Show whether "list" command is run on stopping'],
+       ['autoirb', 4, 'Show whether IRB is invoked on stopping'],
+       ['autoreload', 4, 'Show whether source code is reloaded when changed'],
+       ['basename',  1, 'Show whether basename is used when reporting files'],
+       ['callstyle', 2, 'Show paramater style used when showing call frames'],
+       ['commands',  2, 'Show the history of commands you typed',
+        'You can supply a command number to start with'],
+       ['forcestep', 1,
+        'Show whether "next/step" commands are set to always move to a line'],
+       ['fullpath',  2, 'Show whether full paths are displayed in frames'],
+       ['history', 2, 'Generic command to show command history parameters',
+        'show history filename -- Show the filename in which to record the ' \
+        'command history'                                                    \
+        'show history save -- Show whether history record should be saved '  \
+        'on exit'                                                            \
+        'show history size -- Show the size of the command history'],
+       ['linetrace', 3, 'Show line execution tracing status'],
+       ['linetrace_plus', 10,
+        'Show whether different consecutive lines are shown in tracing'],
+       ['listsize', 3, 'Show number of source lines to list by default'],
+       ['post-mortem', 3, 'Show whether we should go into post-mortem ' \
+                          'debugging on an uncaught exception'],
+       ['stack_trace_on_error', 1, 'Show whether a stack trace is displayed ' \
+                                   'when "eval" raises an exception'],
+       ['version', 1, 'Show byebug\'s version'],
+       ['width', 1, 'Show the number of characters per line for byebug']
       ].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)
 
     self.allow_in_control = true
 
     def regexp
-      /^\s* show (?:\s+(.+))? \s*$/xi
+      /^\s* show (?:\s+(.+))? \s*$/x
     end
 
     def execute

data/lib/byebug/commands/skip.rb

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

data/lib/byebug/commands/stepping.rb

@@ -4,7 +4,7 @@ module Byebug
   module SteppingFunctions
     def parse_stepping_args(command_name, match)
       if match[1].nil?
-        force = Command.settings[:force_stepping]
+        force = Command.settings[:forcestep]
       elsif match[1] == '+'
         force = true
       elsif match[1] == '-'
@@ -39,7 +39,8 @@ module Byebug
       def description
         %{n[ext][+-]?[ nnn]\tstep over once or nnn times,
           \t\t'+' forces to move to another line.
-          \t\t'-' is the opposite of '+' and disables the force_stepping setting.}
+          \t\t'-' is the opposite of '+' and disables the :forcestep setting.
+         }
       end
     end
   end
@@ -69,8 +70,8 @@ module Byebug
         %{
           s[tep][+-]?[ nnn]\tstep (into methods) once or nnn times
           \t\t'+' forces to move to another line.
-          \t\t'-' is the opposite of '+' and disables the force_stepping setting.
-        }
+          \t\t'-' is the opposite of '+' and disables the :forcestep setting.
+         }
       end
     end
   end

data/lib/byebug/commands/threads.rb

@@ -0,0 +1,202 @@
+module Byebug
+  module ThreadFunctions
+    def display_context(context, should_show_top_frame = true)
+      args = thread_arguments(context, should_show_top_frame)
+      print "%s%s%d %s\t%s\n", args[:status_flag], args[:debug_flag], args[:id],
+                               args[:thread], args[:file_line]
+    end
+
+    def thread_arguments(context, should_show_top_frame = true)
+      status_flag = if context.suspended?
+        "$"
+      else
+        context.thread == Thread.current ? '+' : ' '
+      end
+      debug_flag = context.ignored? ? '!' : ' '
+      if should_show_top_frame
+        if context.thread == Thread.current
+          file = @state.context.frame_file(0)
+          line = @state.context.frame_line(0)
+        else
+          if context.thread.backtrace_locations && context.thread.backtrace_locations[0]
+            file = context.thread.backtrace_locations[0].path
+            line = context.thread.backtrace_locations[0].lineno
+          end
+        end
+        file_line = "#{file}:#{line}"
+      end
+      {
+        status_flag: status_flag,
+        debug_flag: debug_flag,
+        id: context.thnum,
+        thread: context.thread.inspect,
+        file_line: file_line ? file_line : ''
+      }
+    end
+
+    def parse_thread_num(subcmd, arg)
+      if '' == arg
+        errmsg "\"#{subcmd}\" needs a thread number"
+        nil
+      else
+        thread_num = get_int(arg, subcmd, 1)
+        return nil unless thread_num
+        get_context(thread_num)
+      end
+    end
+
+    def parse_thread_num_for_cmd(subcmd, arg)
+      c = parse_thread_num(subcmd, arg)
+      return nil unless c
+      case
+      when nil == c
+        errmsg 'No such thread'
+      when @state.context == c
+        errmsg "It's the current thread"
+      when c.ignored?
+        errmsg "Can't #{subcmd} thread #{arg}"
+      else
+        return c
+      end
+      return nil
+    end
+
+  end
+
+  class ThreadListCommand < Command
+    self.allow_in_control = true
+
+    def regexp
+      /^\s* th(?:read)? \s+ l(?:ist)? \s*$/x
+    end
+
+    def execute
+      Byebug.contexts.sort_by(&:thnum).each { |c| display_context(c) }
+    end
+
+    class << self
+      def names
+        %w(thread)
+      end
+
+      def description
+        %{
+          th[read] l[ist]\t\t\tlist all threads
+        }
+      end
+    end
+  end
+
+  class ThreadCurrentCommand < Command
+    self.need_context = true
+
+    def regexp
+      /^\s* th(?:read)? \s+ (?:cur(?:rent)?)? \s*$/x
+    end
+
+    def execute
+      display_context(@state.context)
+    end
+
+    class << self
+      def names
+        %w(thread)
+      end
+
+      def description
+        %{th[read] [cur[rent]]\t\tshow current thread}
+      end
+    end
+  end
+
+  class ThreadStopCommand < Command
+    self.allow_in_control     = true
+    self.allow_in_post_mortem = false
+    self.need_context         = true
+
+    def regexp
+      /^\s* th(?:read)? \s+ stop \s* (\S*) \s*$/x
+    end
+
+    def execute
+      c = parse_thread_num_for_cmd('thread stop', @match[1])
+      return unless c
+      c.suspend
+      display_context(c)
+    end
+
+    class << self
+      def names
+        %w(thread)
+      end
+
+      def description
+        %{th[read] stop <nnn>\t\tstop thread nnn}
+      end
+    end
+  end
+
+  class ThreadResumeCommand < Command
+    self.allow_in_control     = true
+    self.allow_in_post_mortem = false
+    self.need_context         = true
+
+    def regexp
+      /^\s* th(?:read)? \s+ resume \s* (\S*) \s*$/x
+    end
+
+    def execute
+      c = parse_thread_num_for_cmd('thread resume', @match[1])
+      return unless c
+      if !c.suspended?
+        errmsg 'Already running'
+        return
+      end
+      c.resume
+      display_context(c)
+    end
+
+    class << self
+      def names
+        %w(thread)
+      end
+
+      def description
+        %{th[read] resume <nnn>\t\tresume thread nnn}
+      end
+    end
+  end
+
+  class ThreadSwitchCommand < Command
+    self.allow_in_control     = true
+    self.allow_in_post_mortem = false
+    self.need_context         = true
+
+    def regexp
+      /^\s* th(?:read)? \s+ (?:sw(?:itch)?\s+)? (\S+) \s*$/x
+    end
+
+    def execute
+      if @match[1] =~ /switch/
+        errmsg '"thread switch" needs a thread number'
+        return
+      end
+      c = parse_thread_num_for_cmd('thread switch', @match[1])
+      return unless c
+      display_context(c)
+      c.step_into 1
+      c.thread.run
+      @state.proceed
+    end
+
+    class << self
+      def names
+        %w(thread)
+      end
+
+      def description
+        %{th[read] [sw[itch]] <nnn>\tswitch thread context to nnn}
+      end
+    end
+  end
+end

data/lib/byebug/commands/trace.rb

@@ -5,7 +5,7 @@ module Byebug
       /^\s* tr(?:ace)? (?: \s+ (\S+))   # on | off | var(iable)
                        (?: \s+ (\S+))?  # (variable-name)?
                        (?: \s+ (\S+))?  # (stop | nostop)?
-       \s*$/ix
+       \s*$/x
     end
 
     def execute

data/lib/byebug/helper.rb

@@ -11,15 +11,15 @@ module Byebug
       begin
         int = Integer(str)
         if min and int < min
-          print "#{cmd} argument \"#{str}\" needs to be at least #{min}.\n"
+          print "\"#{cmd}\" argument \"#{str}\" needs to be at least #{min}.\n"
           return nil
         elsif max and int > max
-          print "#{cmd} argument \"#{str}\" needs to be at most #{max}.\n"
+          print "\"#{cmd}\" argument \"#{str}\" needs to be at most #{max}.\n"
           return nil
         end
         return int
       rescue
-        print "#{cmd} argument \"#{str}\" needs to be a number.\n"
+        print "\"#{cmd}\" argument \"#{str}\" needs to be a number.\n"
         return nil
       end
     end

data/lib/byebug/interface.rb

@@ -10,23 +10,8 @@ module Byebug
     # Common routine for reporting byebug error messages.
     # Derived classes may want to override this to capture output.
     def errmsg(*args)
-      if Byebug.annotate.to_i > 2
-        aprint 'error-begin'
-        print(*args)
-        aprint ''
-      else
-        print '*** '
-        print(*args)
-      end
-    end
-
-    # Format msg with gdb-style annotation header
-    def afmt(msg, newline="\n")
-      "\032\032#{msg}#{newline}"
-    end
-
-    def aprint(msg)
-      print afmt(msg) if Byebug.annotate.to_i > 2
+      print '*** '
+      print(*args)
     end
 
     def format(*args)
@@ -83,9 +68,6 @@ module Byebug
 
     # Things to do before quitting
     def finalize
-      if Byebug.method_defined?("annotate") and Byebug.annotate.to_i > 2
-        print "\032\032exited\n\n"
-      end
       if Byebug.respond_to?(:save_history)
         Byebug.save_history
       end

data/lib/byebug/processor.rb

@@ -9,7 +9,7 @@ module Byebug
     attr_accessor :interface
 
     extend Forwardable
-    def_delegators :@interface, :errmsg, :print, :aprint, :afmt
+    def_delegators :@interface, :errmsg, :print
 
     def initialize(interface)
       @interface = interface
@@ -19,22 +19,6 @@ module Byebug
   class CommandProcessor < Processor
     attr_reader :display
 
-    @@Show_breakpoints_postcmd = [ Byebug::BreakCommand.new(nil).regexp,
-                                   Byebug::ConditionCommand.new(nil).regexp,
-                                   Byebug::DeleteCommand.new(nil).regexp,
-                                   Byebug::DisableCommand.new(nil).regexp,
-                                   Byebug::EnableCommand.new(nil).regexp
-                                 ]
-    @@Show_annotations_run = [ Byebug::ContinueCommand.new(nil).regexp,
-                               Byebug::FinishCommand.new(nil).regexp,
-                               Byebug::NextCommand.new(nil).regexp,
-                               Byebug::StepCommand.new(nil).regexp
-                             ]
-    @@Show_annotations_postcmd = [ Byebug::DownCommand.new(nil).regexp,
-                                   Byebug::FrameCommand.new(nil).regexp,
-                                   Byebug::UpCommand.new(nil).regexp
-                                 ]
-
     def initialize(interface = LocalInterface.new)
       super(interface)
 
@@ -43,8 +27,6 @@ module Byebug
       @last_cmd               = nil   # To allow empty (just <RET>) commands
       @last_file              = nil   # Filename the last time we stopped
       @last_line              = nil   # Line number the last time we stopped
-      @breakpoints_were_empty = false # Show breakpoints 1st time
-      @displays_were_empty    = true  # No display 1st time
       @context_was_dead       = false  # Assume we haven't started.
     end
 
@@ -57,7 +39,7 @@ module Byebug
 
     require 'pathname'  # For cleanpath
 
-    ##
+    #
     # Regularize file name.
     #
     # This is also used as a common funnel place if basename is desired or if we
@@ -95,17 +77,14 @@ module Byebug
     end
 
     def at_breakpoint(context, breakpoint)
-      aprint 'stopped'
       n = Byebug.breakpoints.index(breakpoint) + 1
       file = CommandProcessor.canonic_file(breakpoint.source)
       line = breakpoint.pos
-      aprint "source #{file}:#{line}"
       print "Stopped by breakpoint #{n} at #{file}:#{line}\n"
     end
     protect :at_breakpoint
 
     def at_catchpoint(context, excpt)
-      aprint 'stopped'
       file = CommandProcessor.canonic_file(context.frame_file(0))
       line = context.frame_line(0)
       print "Catchpoint at %s:%d: `%s' (%s)\n", file, line, excpt, excpt.class
@@ -120,10 +99,8 @@ module Byebug
     protect :at_catchpoint
 
     def at_tracing(context, file, line)
-      if file != @last_file || line != @last_line ||
-         Command.settings[:tracing_plus] == false
-        @last_file = file
-        @last_line = line
+      if file != @last_file || line != @last_line || Command.settings[:linetrace_plus]
+        @last_file, @last_line = file, line
         print "Tracing: #{CommandProcessor.canonic_file(file)}:#{line} " \
               "#{Byebug.line_at(file,line)}\n"
       end
@@ -142,16 +119,14 @@ module Byebug
     protect :at_return
 
     private
-      ##
+      #
       # Prompt shown before reading a command.
       #
       def prompt(context)
-        p = "(byebug#{context.dead?  ? ':post-mortem' : ''}) "
-        p = afmt("pre-prompt")+p+"\n"+afmt("prompt") if Byebug.annotate.to_i > 2
-        return p
+        return "(byebug#{context.dead?  ? ':post-mortem' : ''}) "
       end
 
-      ##
+      #
       # Run commands everytime.
       #
       # For example display commands or possibly the list or irb in an
@@ -181,7 +156,7 @@ module Byebug
         return state, commands
       end
 
-      ##
+      #
       # Splits a command line of the form "cmd1 ; cmd2 ; ... ; cmdN" into an
       # array of commands: [cmd1, cmd2, ..., cmdN]
       #
@@ -201,7 +176,7 @@ module Byebug
         end
       end
 
-      ##
+      #
       # Handle byebug commands.
       #
       def process_commands(context, file, line)
@@ -209,7 +184,7 @@ module Byebug
         $state = Command.settings[:testing] ? state : nil
 
         preloop(commands, context)
-        aprint state.location if Command.settings[:autolist] == 0
+        print state.location if Command.settings[:autolist] == 0
 
         while !state.proceed?
           input = @interface.command_queue.empty? ?
@@ -225,25 +200,23 @@ module Byebug
             end
             split_commands(input).each do |cmd|
               one_cmd(commands, context, cmd)
-              postcmd(commands, context, cmd)
             end
           end
         end
-        postloop(commands, context)
       end
 
-      ##
+      #
       # Executes a single byebug command
       #
       def one_cmd(commands, context, input)
-        if cmd = commands.find{ |c| c.match(input) }
+        if cmd = commands.find { |c| c.match(input) }
           if context.dead? && cmd.class.need_context
             print "Command is unavailable\n"
           else
             cmd.execute
           end
         else
-          unknown_cmd = commands.find{ |c| c.class.unknown }
+          unknown_cmd = commands.find { |c| c.class.unknown }
           if unknown_cmd
             unknown_cmd.execute
           else
@@ -252,65 +225,16 @@ module Byebug
         end
       end
 
+      #
+      # Tasks to do before processor loop
+      #
       def preloop(commands, context)
         @context_was_dead = true if context.dead? and not @context_was_dead
 
-        aprint 'stopped'
         if @context_was_dead
-          aprint 'exited'
           print "The program finished.\n"
           @context_was_dead = false
         end
-
-        if Byebug.annotate.to_i > 2
-          breakpoint_annotations(commands, context)
-          display_annotations(commands, context)
-          annotation('stack', commands, context, "where")
-          annotation('variables', commands, context, "info variables") unless
-            context.dead?
-        end
-      end
-
-      def postcmd(commands, context, cmd)
-        if Byebug.annotate.to_i > 2
-          cmd = @last_cmd unless cmd
-          breakpoint_annotations(commands, context) if
-            @@Show_breakpoints_postcmd.find{|pat| cmd =~ pat}
-          display_annotations(commands, context)
-          if @@Show_annotations_postcmd.find{|pat| cmd =~ pat}
-            annotation('stack', commands, context, "where") if
-              context.stack_size > 0
-            annotation('variables', commands, context, "info variables") unless
-              context.dead?
-          end
-          if not context.dead? and @@Show_annotations_run.find{|pat| cmd =~ pat}
-            afmt 'starting'
-            @context_was_dead = false
-          end
-        end
-      end
-
-      def postloop(commands, context)
-      end
-
-      def annotation(label, commands, context, cmd)
-        print afmt(label)
-        one_cmd(commands, context, cmd)
-      end
-
-      def breakpoint_annotations(commands, context)
-        unless Byebug.breakpoints.empty? and @breakpoints_were_empty
-          annotation('breakpoints', commands, context, "info breakpoints")
-          @breakpoints_were_empty = Byebug.breakpoints.empty?
-        end
-      end
-
-      def display_annotations(commands, context)
-        return if display.empty?
-        have_display = display.find{|d| d[0]}
-        return unless have_display and @displays_were_empty
-        @displays_were_empty = have_display
-        annotation('display', commands, context, "display")
       end
 
       class State
@@ -324,7 +248,7 @@ module Byebug
         end
 
         extend Forwardable
-        def_delegators :@interface, :aprint, :errmsg, :print, :confirm
+        def_delegators :@interface, :errmsg, :print, :confirm
 
         def proceed?
           @proceed
@@ -345,7 +269,6 @@ module Byebug
 
 
   class ControlCommandProcessor < Processor
-
     def initialize(interface)
       super(interface)
       @context_was_dead = false # Assume we haven't started.
@@ -359,7 +282,6 @@ module Byebug
       commands = control_cmds.map{|cmd| cmd.new(state) }
 
       if @context_was_dead
-        aprint 'exited'
         print "The program finished.\n"
         @context_was_dead = false
       end
@@ -382,12 +304,11 @@ module Byebug
       @interface.close
     end
 
-    # The prompt shown before reading a command.
-    # Note: have an unused 'context' parameter to match the local interface.
+    #
+    # Prompt shown before reading a command.
+    #
     def prompt(context)
-      p = '(byebug:ctrl) '
-      p = afmt("pre-prompt") +p+"\n"+ afmt("prompt") if Byebug.annotate.to_i > 2
-      return p
+      return '(byebug:ctrl) '
     end
 
     class State