byebug 11.0.1

data/lib/byebug/commands/var.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "byebug/subcommands"
+
+require "byebug/commands/var/all"
+require "byebug/commands/var/args"
+require "byebug/commands/var/const"
+require "byebug/commands/var/instance"
+require "byebug/commands/var/local"
+require "byebug/commands/var/global"
+
+module Byebug
+  #
+  # Shows variables and its values
+  #
+  class VarCommand < Command
+    include Subcommands
+
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^\s* v(?:ar)? (?:\s+ (.+))? \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        [v]ar <subcommand>
+
+        #{short_description}
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Shows variables and its values"
+    end
+  end
+end

data/lib/byebug/commands/var/all.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/var"
+
+module Byebug
+  #
+  # Reopens the +var+ command to define the +all+ subcommand
+  #
+  class VarCommand < Command
+    #
+    # Shows global, instance and local variables
+    #
+    class AllCommand < Command
+      include Helpers::VarHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* a(?:ll)? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          v[ar] a[ll]
+
+          #{short_description}
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Shows local, global and instance variables of self."
+      end
+
+      def execute
+        var_global
+        var_instance("self")
+        var_local
+      end
+    end
+  end
+end

data/lib/byebug/commands/var/args.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/var"
+
+module Byebug
+  #
+  # Reopens the +var+ command to define the +args+ subcommand
+  #
+  class VarCommand < Command
+    #
+    # Information about arguments of the current method/block
+    #
+    class ArgsCommand < Command
+      include Helpers::VarHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* a(?:rgs)? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          v[ar] a[args]
+
+          #{short_description}
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Information about arguments of the current scope"
+      end
+
+      def execute
+        var_args
+      end
+    end
+  end
+end

data/lib/byebug/commands/var/const.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/eval"
+
+module Byebug
+  #
+  # Reopens the +var+ command to define the +const+ subcommand
+  #
+  class VarCommand < Command
+    #
+    # Shows constants
+    #
+    class ConstCommand < Command
+      include Helpers::EvalHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* c(?:onst)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          v[ar] c[onstant]
+
+          #{short_description}
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Shows constants of an object."
+      end
+
+      def execute
+        obj = warning_eval(str_obj)
+        return errmsg(pr("variable.errors.not_module", object: str_obj)) unless obj.is_a?(Module)
+
+        constants = warning_eval("#{str_obj}.constants")
+        puts prv(constants.sort.map { |c| [c, obj.const_get(c)] }, "constant")
+      end
+
+      private
+
+      def str_obj
+        @str_obj ||= @match[1] || "self.class"
+      end
+    end
+  end
+end

data/lib/byebug/commands/var/global.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Byebug
+  #
+  # Reopens the +var+ command to define the +global+ subcommand
+  #
+  class VarCommand < Command
+    #
+    # Shows global variables
+    #
+    class GlobalCommand < Command
+      include Helpers::VarHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* g(?:lobal)? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          v[ar] g[lobal]
+
+          #{short_description}
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Shows global variables."
+      end
+
+      def execute
+        var_global
+      end
+    end
+  end
+end

data/lib/byebug/commands/var/instance.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/var"
+
+module Byebug
+  #
+  # Reopens the +var+ command to define the +instance+ subcommand
+  #
+  class VarCommand < Command
+    #
+    # Shows instance variables
+    #
+    class InstanceCommand < Command
+      include Helpers::VarHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* i(?:nstance)? (?:\s+ (.+))? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          v[ar] i[nstance][ <object>]
+
+          #{short_description}
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Shows instance variables of self or a specific object."
+      end
+
+      def execute
+        var_instance(@match[1])
+      end
+    end
+  end
+end

data/lib/byebug/commands/var/local.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "byebug/helpers/var"
+
+module Byebug
+  #
+  # Reopens the +var+ command to define the +local+ subcommand
+  #
+  class VarCommand < Command
+    #
+    # Shows local variables in current scope
+    #
+    class LocalCommand < Command
+      include Helpers::VarHelper
+
+      self.allow_in_post_mortem = true
+
+      def self.regexp
+        /^\s* l(?:ocal)? \s*$/x
+      end
+
+      def self.description
+        <<-DESCRIPTION
+          v[ar] l[ocal]
+
+          #{short_description}
+        DESCRIPTION
+      end
+
+      def self.short_description
+        "Shows local variables in current scope."
+      end
+
+      def execute
+        var_local
+      end
+    end
+  end
+end

data/lib/byebug/commands/where.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "byebug/command"
+require "byebug/helpers/frame"
+
+module Byebug
+  #
+  # Show current backtrace.
+  #
+  class WhereCommand < Command
+    include Helpers::FrameHelper
+
+    self.allow_in_post_mortem = true
+
+    def self.regexp
+      /^\s* (?:w(?:here)?|bt|backtrace) \s*$/x
+    end
+
+    def self.description
+      <<-DESCRIPTION
+        w[here]|bt|backtrace
+
+        #{short_description}
+
+        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.
+      DESCRIPTION
+    end
+
+    def self.short_description
+      "Displays the backtrace"
+    end
+
+    def execute
+      print_backtrace
+    end
+
+    private
+
+    def print_backtrace
+      bt = prc("frame.line", (0...context.stack_size)) do |_, index|
+        Frame.new(context, index).to_hash
+      end
+
+      print(bt)
+    end
+  end
+end

data/lib/byebug/context.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "byebug/frame"
+require "byebug/helpers/path"
+require "byebug/helpers/file"
+require "byebug/processors/command_processor"
+
+module Byebug
+  #
+  # Mantains context information for the debugger and it's the main
+  # communication point between the library and the C-extension through the
+  # at_breakpoint, at_catchpoint, at_tracing, at_line and at_return callbacks
+  #
+  class Context
+    include Helpers::FileHelper
+
+    class << self
+      include Helpers::PathHelper
+
+      attr_writer :ignored_files
+
+      #
+      # List of files byebug will ignore while debugging
+      #
+      def ignored_files
+        @ignored_files ||=
+          Byebug.mode == :standalone ? lib_files + [bin_file] : lib_files
+      end
+
+      attr_writer :interface
+
+      def interface
+        @interface ||= LocalInterface.new
+      end
+
+      attr_writer :processor
+
+      def processor
+        @processor ||= CommandProcessor
+      end
+    end
+
+    #
+    # Reader for the current frame
+    #
+    def frame
+      @frame ||= Frame.new(self, 0)
+    end
+
+    #
+    # Writer for the current frame
+    #
+    def frame=(pos)
+      @frame = Frame.new(self, pos)
+    end
+
+    extend Forwardable
+    def_delegators :frame, :file, :line
+
+    #
+    # Current file & line information
+    #
+    def location
+      "#{normalize(file)}:#{line}"
+    end
+
+    #
+    # Current file, line and source code information
+    #
+    def full_location
+      return location if virtual_file?(file)
+
+      "#{location} #{get_line(file, line)}"
+    end
+
+    #
+    # Context's stack size
+    #
+    def stack_size
+      return 0 unless backtrace
+
+      backtrace.drop_while { |l| ignored_file?(l.first.path) }
+               .take_while { |l| !ignored_file?(l.first.path) }
+               .size
+    end
+
+    def interrupt
+      step_into 1
+    end
+
+    #
+    # Line handler
+    #
+    def at_line
+      self.frame = 0
+      return if ignored_file?(file)
+
+      processor.at_line
+    end
+
+    #
+    # Tracing handler
+    #
+    def at_tracing
+      return if ignored_file?(file)
+
+      processor.at_tracing
+    end
+
+    #
+    # Breakpoint handler
+    #
+    def at_breakpoint(breakpoint)
+      processor.at_breakpoint(breakpoint)
+    end
+
+    #
+    # Catchpoint handler
+    #
+    def at_catchpoint(exception)
+      processor.at_catchpoint(exception)
+    end
+
+    #
+    # Return handler
+    #
+    def at_return(return_value)
+      return if ignored_file?(file)
+
+      processor.at_return(return_value)
+    end
+
+    #
+    # End of class definition handler
+    #
+    def at_end
+      return if ignored_file?(file)
+
+      processor.at_end
+    end
+
+    private
+
+    def processor
+      @processor ||= self.class.processor.new(self, self.class.interface)
+    end
+
+    #
+    # Tells whether a file is ignored by the debugger.
+    #
+    # @param path [String] filename to be checked.
+    #
+    def ignored_file?(path)
+      self.class.ignored_files.include?(path)
+    end
+  end
+end