byebug 3.5.1 → 4.0.0

data/lib/byebug/commands/enable_disable.rb

@@ -1,12 +1,14 @@
+require 'byebug/command'
+
 module Byebug
   #
   # Mixin to assist command parsing
   #
   module EnableDisableFunctions
     def enable_disable_breakpoints(is_enable, args)
-      return errmsg('No breakpoints have been set') if Breakpoint.none?
+      return errmsg(pr('toggle.errors.no_breakpoints')) if Breakpoint.none?
 
-      all_breakpoints = Byebug.breakpoints.sort_by { |b| b.id }
+      all_breakpoints = Byebug.breakpoints.sort_by(&:id)
       if args.empty?
         selected_breakpoints = all_breakpoints
       else
@@ -18,16 +20,15 @@ module Byebug
 
           selected_ids << pos
         end
-        selected_breakpoints = all_breakpoints.select do
-          |b| selected_ids.include?(b.id)
+        selected_breakpoints = all_breakpoints.select do |b|
+          selected_ids.include?(b.id)
         end
       end
 
       selected_breakpoints.each do |b|
         enabled = ('enable' == is_enable)
         if enabled && !syntax_valid?(b.expr)
-          return errmsg("Expression \"#{b.expr}\" syntactically incorrect; " \
-                        'breakpoint remains disabled.')
+          return errmsg(pr('toggle.errors.expression', expr: b.expr))
         end
 
         b.enabled = enabled
@@ -35,9 +36,7 @@ module Byebug
     end
 
     def enable_disable_display(is_enable, args)
-      if 0 == @state.display.size
-        return errmsg('No display expressions have been set')
-      end
+      return errmsg(pr('toggle.errors.no_display')) if 0 == @state.display.size
 
       args.each do |pos|
         pos, err = get_int(pos, "#{is_enable} display", 1, @state.display.size)
@@ -52,6 +51,8 @@ module Byebug
   # Enabling or disabling custom display expressions or breakpoints.
   #
   class EnableDisableCommand < Command
+    include EnableDisableFunctions
+
     Subcommands = [
       ['breakpoints', 2, 'Enable/disable breakpoints. Give breakpoint '      \
                          'numbers (separated by spaces) as arguments or no ' \
@@ -64,7 +65,7 @@ module Byebug
                      'numbers']
     ].map do |name, min, help|
       Subcmd.new(name, min, help)
-    end unless defined?(Subcommands)
+    end
 
     def regexp
       /^\s* (dis|en)(?:able)? (?:\s+(.+))? \s*$/x
@@ -73,8 +74,7 @@ module Byebug
     def execute
       cmd = @match[1] == 'dis' ? 'disable' : 'enable'
 
-      return errmsg("\"#{cmd}\" must be followed by \"display\", " \
-                    "\"breakpoints\" or breakpoint ids") unless @match[2]
+      return errmsg(pr('toggle.errors.syntax', toggle: cmd)) unless @match[2]
 
       args = @match[2].split(/[ \t]+/)
       param = args.shift
@@ -108,22 +108,24 @@ module Byebug
       end
 
       def description
-        %{(en|dis)[able][[ (breakpoints|display)][ n1[ n2[ ...[ nn]]]]]
+        prettify <<-EOD
+          (en|dis)[able][[ (breakpoints|display)][ n1[ n2[ ...[ nn]]]]]
 
-         Enables or disables breakpoints or displays.
+           Enables or disables breakpoints or displays.
 
-         "enable" by itself enables all breakpoints, just like
-         "enable breakpoints". On the other side, "disable" or
-         "disable breakpoints" disable all breakpoints.
+           "enable" by itself enables all breakpoints, just like
+           "enable breakpoints". On the other side, "disable" or
+           "disable breakpoints" disable all breakpoints.
 
-         You can also specify a space separated list of breakpoint numbers to
-         enable or disable specific breakpoints. You can use either
-         "enable <id1> ... <idn>" or "enable breakpoints <id1> ... <idn>" and
-         the same with "disable".
+           You can also specify a space separated list of breakpoint numbers to
+           enable or disable specific breakpoints. You can use either
+           "enable <id1> ... <idn>" or "enable breakpoints <id1> ... <idn>" and
+           the same with "disable".
 
-         If instead of "breakpoints" you specify "display", the command will
-         work exactly the same way, but displays will get enabled/disabled
-         instead of breakpoints.}
+           If instead of "breakpoints" you specify "display", the command will
+           work exactly the same way, but displays will get enabled/disabled
+           instead of breakpoints.
+         EOD
       end
     end
   end

data/lib/byebug/commands/eval.rb

@@ -1,3 +1,5 @@
+require 'byebug/command'
+
 require 'English'
 require 'pp'
 
@@ -6,16 +8,52 @@ module Byebug
   # Utilities used by the eval command
   #
   module EvalFunctions
+    #
+    # Run block temporarily ignoring all TracePoint events.
+    #
+    # Used to evaluate stuff within Byebug's prompt. Otherwise, any code
+    # creating new threads won't be properly evaluated because new threads will
+    # get blocked by byebug's main thread.
+    #
+    def allowing_other_threads
+      Byebug.unlock
+      res = yield
+      Byebug.lock
+      res
+    end
+
+    #
+    # Get current binding and yield it to the given block
+    #
     def run_with_binding
       binding = get_binding
       yield binding
     end
+
+    #
+    # Evaluate +expression+ using +binding+
+    #
+    # @param binding [Binding] Context where to evaluate the expression
+    # @param expression [String] Expression to evaluation
+    # @param stack_on_error [Boolean] Whether to show a stack trace on error.
+    #
+    def eval_with_setting(binding, expression, stack_on_error)
+      allowing_other_threads do
+        if stack_on_error
+          bb_eval(expression, binding)
+        else
+          bb_warning_eval(expression, binding)
+        end
+      end
+    end
   end
 
   #
   # Evaluation of expressions from byebug's prompt.
   #
   class EvalCommand < Command
+    include EvalFunctions
+
     self.allow_in_control = true
 
     def match(input)
@@ -24,17 +62,15 @@ module Byebug
     end
 
     def regexp
-      /^\s* (p|e(?:val)?)\s+/x
+      /^\s* e(?:val)? \s+/x
     end
 
     def execute
       expr = @match ? @match.post_match : @input
       run_with_binding do |b|
-        if Setting[:stack_on_error]
-          puts "#{bb_eval(expr, b).inspect}"
-        else
-          puts "#{bb_warning_eval(expr, b).inspect}"
-        end
+        res = eval_with_setting(b, expr, Setting[:stack_on_error])
+
+        print pr('eval.result', expr: expr, result: res.inspect)
       end
     rescue
       puts "#{$ERROR_INFO.class} Exception: #{$ERROR_INFO.message}"
@@ -42,16 +78,18 @@ module Byebug
 
     class << self
       def names
-        %w(p eval)
+        %w(eval)
       end
 
       def description
-        %{(p|e[val]) <expression>
+        prettify <<-EOD
+          e[val] <expression>
 
           Evaluates <expression> and prints its value.
 
           * NOTE - unknown input is automatically evaluated, to turn this off
-          use 'set noautoeval'.}
+          use 'set noautoeval'.
+        EOD
       end
     end
   end
@@ -60,6 +98,8 @@ module Byebug
   # Evaluation and pretty printing from byebug's prompt.
   #
   class PPCommand < Command
+    include EvalFunctions
+
     self.allow_in_control = true
 
     def regexp
@@ -86,9 +126,11 @@ module Byebug
       end
 
       def description
-        %(pp <expression>
+        prettify <<-EOD
+          pp <expression>
 
-          Evaluates <expression> and pretty-prints its value.)
+          Evaluates <expression> and pretty-prints its value.
+        EOD
       end
     end
   end
@@ -97,26 +139,24 @@ module Byebug
   # Evaluation, pretty printing and columnizing from byebug's prompt.
   #
   class PutLCommand < Command
+    include EvalFunctions
     include Columnize
+
     self.allow_in_control = true
 
     def regexp
-      /^\s* putl\s+/x
+      /^\s* putl \s+/x
     end
 
     def execute
       out = StringIO.new
       run_with_binding do |b|
-        if Setting[:stack_on_error]
-          vals = bb_eval(@match.post_match, b)
-        else
-          vals = bb_warning_eval(@match.post_match, b)
-        end
-        if vals.is_a?(Array)
-          vals = vals.map { |item| item.to_s }
-          puts "#{columnize(vals, Setting[:width])}"
+        res = eval_with_setting(b, @match.post_match, Setting[:stack_on_error])
+
+        if res.is_a?(Array)
+          puts "#{columnize(res.map(&:to_s), Setting[:width])}"
         else
-          PP.pp(vals, out)
+          PP.pp(res, out)
           puts out.string
         end
       end
@@ -130,9 +170,11 @@ module Byebug
       end
 
       def description
-        %(putl <expression>
+        prettify <<-EOD
+          putl <expression>
 
-          Evaluates <expression>, an array, and columnize its value.)
+          Evaluates <expression>, an array, and columnize its value.
+        EOD
       end
     end
   end
@@ -141,26 +183,24 @@ module Byebug
   # Evaluation, pretty printing, columnizing and sorting from byebug's prompt
   #
   class PSCommand < Command
+    include EvalFunctions
     include Columnize
+
     self.allow_in_control = true
 
     def regexp
-      /^\s* ps\s+/x
+      /^\s* ps \s+/x
     end
 
     def execute
       out = StringIO.new
       run_with_binding do |b|
-        if Setting[:stack_on_error]
-          vals = bb_eval(@match.post_match, b)
-        else
-          vals = bb_warning_eval(@match.post_match, b)
-        end
-        if vals.is_a?(Array)
-          vals = vals.map { |item| item.to_s }
-          puts "#{columnize(vals.sort!, Setting[:width])}"
+        res = eval_with_setting(b, @match.post_match, Setting[:stack_on_error])
+
+        if res.is_a?(Array)
+          puts "#{columnize(res.map(&:to_s).sort!, Setting[:width])}"
         else
-          PP.pp(vals, out)
+          PP.pp(res, out)
           puts out.string
         end
       end
@@ -174,9 +214,11 @@ module Byebug
       end
 
       def description
-        %(ps <expression>
+        prettify <<-EOD
+          ps <expression>
 
-          Evaluates <expression>, an array, sort and columnize its value.)
+          Evaluates <expression>, an array, sort and columnize its value.
+        EOD
       end
     end
   end

data/lib/byebug/commands/finish.rb

@@ -1,3 +1,5 @@
+require 'byebug/command'
+
 module Byebug
   #
   # Implements the finish functionality.
@@ -12,7 +14,7 @@ module Byebug
     end
 
     def execute
-      max_frames = Context.stack_size - @state.frame_pos
+      max_frames = @state.context.stack_size - @state.frame
       if @match[1]
         n_frames, err = get_int(@match[1], 'finish', 0, max_frames - 1)
         return errmsg(err) unless n_frames
@@ -21,8 +23,8 @@ module Byebug
       end
 
       force = n_frames == 0 ? true : false
-      @state.context.step_out(@state.frame_pos + n_frames, force)
-      @state.frame_pos = 0
+      @state.context.step_out(@state.frame + n_frames, force)
+      @state.frame = 0
       @state.proceed
     end
 
@@ -32,11 +34,13 @@ module Byebug
       end
 
       def description
-        %(fin[ish][ n_frames]        Execute until frame returns.
+        prettify <<-EOD
+          fin[ish][ n_frames]  Execute until 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.)
+          return from the current position.
+        EOD
       end
     end
   end

data/lib/byebug/commands/frame.rb

@@ -1,26 +1,28 @@
+require 'byebug/command'
+
 # encoding: utf-8
+
+require 'pathname'
+
 module Byebug
   #
   # Mixin to assist command parsing
   #
   module FrameFunctions
-    def c_frame?(frame_no)
-      @state.context.frame_binding(frame_no).nil?
-    end
-
     def switch_to_frame(frame_no)
-      frame_no >= 0 ? frame_no : Context.stack_size + frame_no
+      frame_no >= 0 ? frame_no : @state.context.stack_size + frame_no
     end
 
     def navigate_to_frame(jump_no)
       return if jump_no == 0
-      total_jumps, current_jumps, new_pos = jump_no.abs, 0, @state.frame_pos
-      step = jump_no / total_jumps
+      total_jumps, current_jumps, new_pos = jump_no.abs, 0, @state.frame
+      step = jump_no / total_jumps # +1 (up) or -1 (down)
+
       loop do
         new_pos += step
-        return new_pos if new_pos < 0 || new_pos >= Context.stack_size
+        break if new_pos < 0 || new_pos >= @state.context.stack_size
 
-        next if c_frame?(new_pos)
+        next if @state.c_frame?(new_pos)
 
         current_jumps += 1
         break if current_jumps == total_jumps
@@ -28,126 +30,36 @@ module Byebug
       new_pos
     end
 
-    def adjust_frame(frame_pos, absolute)
+    def adjust_frame(frame, absolute)
       if absolute
-        abs_frame_pos = switch_to_frame(frame_pos)
-        return errmsg("Can't navigate to c-frame") if c_frame?(abs_frame_pos)
+        abs_frame = switch_to_frame(frame)
+        return errmsg(pr('frame.errors.c_frame')) if @state.c_frame?(abs_frame)
       else
-        abs_frame_pos = navigate_to_frame(frame_pos)
+        abs_frame = navigate_to_frame(frame)
       end
 
-      if abs_frame_pos >= Context.stack_size
-        return errmsg("Can't navigate beyond the oldest frame")
-      elsif abs_frame_pos < 0
-        return errmsg("Can't navigate beyond the newest frame")
+      if abs_frame >= @state.context.stack_size
+        return errmsg(pr('frame.errors.too_low'))
+      elsif abs_frame < 0
+        return errmsg(pr('frame.errors.too_high'))
       end
 
-      @state.frame_pos = abs_frame_pos
-      @state.file = @state.context.frame_file @state.frame_pos
-      @state.line = @state.context.frame_line @state.frame_pos
+      @state.frame = abs_frame
+      @state.file = @state.context.frame_file(@state.frame)
+      @state.line = @state.context.frame_line(@state.frame)
       @state.prev_line = nil
-      ListCommand.new(@state).execute
-    end
-
-    def get_frame_class(style, pos)
-      frame_class = style == 'short' ? '' : "#{@state.context.frame_class pos}"
-      frame_class == '' ? '' : "#{frame_class}."
-    end
-
-    def get_frame_block_and_method(pos)
-      frame_deco_regexp = /((?:block(?: \(\d+ levels\))?|rescue) in )?(.+)/
-      frame_deco_method = "#{@state.context.frame_method pos}"
-      frame_block_and_method = frame_deco_regexp.match(frame_deco_method)[1..2]
-      frame_block_and_method.map { |x| x.nil? ? '' : x }
-    end
-
-    def get_frame_args(style, pos)
-      args = @state.context.frame_args pos
-      return '' if args.empty?
-
-      locals = @state.context.frame_locals pos if style == 'long'
-      my_args = args.map do |arg|
-        case arg[0]
-        when :block
-          prefix, default = '&', 'block'
-        when :rest
-          prefix, default = '*', 'args'
-        else
-          prefix, default = '', nil
-        end
-
-        klass = style == 'long' && arg[1] ? "##{locals[arg[1]].class}" : ''
-        "#{prefix}#{arg[1] || default}#{klass}"
-      end
-
-      "(#{my_args.join(', ')})"
-    end
-
-    def get_frame_call(prefix, pos)
-      frame_block, frame_method = get_frame_block_and_method(pos)
-      frame_class = get_frame_class(Setting[:callstyle], pos)
-      frame_args = get_frame_args(Setting[:callstyle], pos)
-
-      call_str = frame_block + frame_class + frame_method + frame_args
-
-      max_call_str_size = Setting[:width] - prefix.size
-      if call_str.size > max_call_str_size
-        call_str = call_str[0..max_call_str_size - 5] + '...)'
-      end
-
-      call_str
-    end
-
-    def print_backtrace
-      realsize = Context.stack_size
-      calcedsize = @state.context.calced_stack_size
-      if calcedsize != realsize
-        if Byebug.post_mortem?
-          stacksize = calcedsize
-        else
-          errmsg "Byebug's stacksize (#{calcedsize}) should be #{realsize}. " \
-                 "This might be a bug in byebug or ruby's debugging API's\n"
-          stacksize = realsize
-        end
-      else
-        stacksize = calcedsize
-      end
-      (0...stacksize).each do |idx|
-        print_frame(idx)
-      end
-    end
-
-    require 'pathname'
-
-    def shortpath(fullpath)
-      components = Pathname(fullpath).each_filename.to_a
-      return File.join(components) if components.size <= 2
 
-      File.join('...', components[-3..-1])
+      ListCommand.new(@state).execute if Setting[:autolist]
     end
 
-    def print_frame(pos, mark_current = true)
-      fullpath = @state.context.frame_file(pos)
-      file = Setting[:fullpath] ? fullpath : shortpath(fullpath)
-      line = @state.context.frame_line(pos)
-
-      if mark_current
-        frame_str = (pos == @state.frame_pos) ? '--> ' : '    '
-      else
-        frame_str = ''
-      end
-      frame_str += c_frame?(pos) ? ' ͱ-- ' : ''
-
-      frame_str += format('#%-2d ', pos)
-      frame_str += get_frame_call frame_str, pos
-      file_line = "at #{CommandProcessor.canonic_file(file)}:#{line}"
-      if frame_str.size + file_line.size + 1 > Setting[:width]
-        frame_str += "\n      #{file_line}"
-      else
-        frame_str += " #{file_line}"
-      end
+    def get_pr_arguments(frame_no)
+      file = @state.frame_file(frame_no)
+      line = @state.frame_line(frame_no)
+      call = @state.frame_call(frame_no)
+      mark = @state.frame_mark(frame_no)
+      pos = @state.frame_pos(frame_no)
 
-      puts frame_str
+      { mark: mark, pos: pos, call: call, file: file, line: line }
     end
   end
 
@@ -155,6 +67,8 @@ module Byebug
   # Show current backtrace.
   #
   class WhereCommand < Command
+    include FrameFunctions
+
     def regexp
       /^\s* (?:w(?:here)?|bt|backtrace) \s*$/x
     end
@@ -169,22 +83,36 @@ module Byebug
       end
 
       def description
-        %(w[here]|bt|backtrace        Display stack frames.
+        prettify <<-EOD
+          w[here]|bt|backtrace        Display stack frames.
 
           Print the entire stack frame. Each frame is numbered; the most recent
           frame is 0. A 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 -->. C-frames hang
           from their most immediate Ruby frame to indicate that they are not
-          navigable.)
+          navigable.
+        EOD
       end
     end
+
+    private
+
+    def print_backtrace
+      bt = prc('frame.line', (0...@state.context.stack_size)) do |_, index|
+        get_pr_arguments(index)
+      end
+
+      print(bt)
+    end
   end
 
   #
   # Move the current frame up in the backtrace.
   #
   class UpCommand < Command
+    include FrameFunctions
+
     def regexp
       /^\s* u(?:p)? (?:\s+(\S+))? \s*$/x
     end
@@ -202,7 +130,9 @@ module Byebug
       end
 
       def description
-        %(up[ count]        Move to higher frame.)
+        prettify <<-EOD
+          up[ count] Move to higher frame.
+        EOD
       end
     end
   end
@@ -211,6 +141,8 @@ module Byebug
   # Move the current frame down in the backtrace.
   #
   class DownCommand < Command
+    include FrameFunctions
+
     def regexp
       /^\s* down (?:\s+(\S+))? \s*$/x
     end
@@ -228,7 +160,9 @@ module Byebug
       end
 
       def description
-        %(down[ count]        Move to lower frame.)
+        prettify <<-EOD
+          down[ count] Move to lower frame.
+        EOD
       end
     end
   end
@@ -237,12 +171,17 @@ module Byebug
   # Move to specific frames in the backtrace.
   #
   class FrameCommand < Command
+    include FrameFunctions
+
     def regexp
       /^\s* f(?:rame)? (?:\s+(\S+))? \s*$/x
     end
 
     def execute
-      return print_frame @state.frame_pos unless @match[1]
+      unless @match[1]
+        print(pr('frame.line', get_pr_arguments(@state.frame)))
+        return
+      end
 
       pos, err = get_int(@match[1], 'Frame')
       return errmsg(err) unless pos
@@ -256,7 +195,8 @@ module Byebug
       end
 
       def description
-        %(f[rame][ frame-number]
+        prettify <<-EOD
+          f[rame][ frame-number]
 
           Move the current frame to the specified frame number, or the 0 if no
           frame-number has been given.
@@ -267,7 +207,8 @@ 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 there is a front end also watching over things.
+        EOD
       end
     end
   end