lib/byebug/command.rb



require 'columnize'
require 'forwardable'
require 'byebug/helpers/string'

module Byebug
  #
  # Parent class of all byebug commands.
  #
  # Subclasses need to implement a `regexp` method and an `execute` method.
  #
  class Command
    extend Forwardable

    include Helpers::StringHelper

    def initialize(state)
      @match = nil
      @state = state
    end

    def match(input)
      @match = regexp.match(input)
    end

    def_delegators :'self.class', :to_name, :description

    #
    # Default help text for a command.
    #
    def help
      prettify(description)
    end

    def_delegator :"Byebug.printer", :print, :pr
    def_delegator :"Byebug.printer", :print_collection, :prc
    def_delegator :"Byebug.printer", :print_variables, :prv

    protected

    def_delegators :@state, :errmsg, :puts, :print, :confirm

    #
    # Evaluates a string containing Ruby code, using binding +b+. In case of
    # error full stack trace and error are printed.
    #
    def bb_eval(str, b = get_binding)
      b.eval(str)
    rescue StandardError, ScriptError => e
      at = e.backtrace
      locations = []
      locations << "#{at.shift}: #{e.class} Exception(#{e.message})"
      locations += at.map { |path| "\tfrom #{path}" }

      errmsg(pr('eval.exception', text_message: locations.join("\n")))
      nil
    end

    #
    # Evaluates a string containing Ruby code, using binding +b+. In case of
    # error, an error message with the exception is printed.
    #
    def bb_warning_eval(str, b = get_binding)
      b.eval(str)
    rescue StandardError, ScriptError => e
      text_message = "#{e.class} Exception: #{e.message}"
      errmsg(pr('eval.exception', text_message: text_message))
      nil
    end

    def get_binding(pos = @state.frame)
      @state.context ? @state.context.frame_binding(pos) : TOPLEVEL_BINDING
    end

    class << self
      attr_accessor :allow_in_control
      attr_writer :allow_in_post_mortem, :always_run

      def allow_in_post_mortem
        !defined?(@allow_in_post_mortem) ? true : false
      end

      def always_run
        @always_run ||= 0
      end

      #
      # Name of the command, as executed by the user.
      #
      def to_name
        name.gsub(/^Byebug::/, '').gsub(/Command$/, '').downcase
      end

      #
      # Available subcommands for the current command
      #
      # A subcommand is any class defined inside the parent's command class
      #
      def subcommands
        const_list = constants(false).map { |const| const_get(const, false) }

        const_list.select { |c| c.is_a?(Class) }
      end
    end
  end
end