class Byebug::SetCommand - byebug-4.0.5 Documentation

# class Byebug::SetCommand

Change byebug settings.

### Public Class Methods

description() click to toggle source

    # File lib/byebug/commands/set.rb, line 53
    def description
      prettify <<-EOD
        set <setting> <value>

        Modifies parts of byebug environment.

        Boolean values take "on", "off", "true", "false", "1" or "0". If you
        don't specify a value, the boolean setting will be enabled.
        Conversely, you can use "set no<setting> to disable them.

        You can see these environment settings with the "show" command.
      EOD
    end

help(subcmd = nil) click to toggle source

    # File lib/byebug/commands/set.rb, line 67
    def help(subcmd = nil)
      Setting.help('set', subcmd)
    end

names() click to toggle source

    # File lib/byebug/commands/set.rb, line 49
    def names
      %w(set)
    end

### Public Instance Methods

execute() click to toggle source

    # File lib/byebug/commands/set.rb, line 14
    def execute
      key, value = @match[:setting], @match[:value]
      return puts(SetCommand.help) if key.nil? && value.nil?

      setting = Setting.find(key)
      return errmsg(pr('set.errors.unknown_setting', key: key)) unless setting

      if !setting.boolean? && value.nil?
        value, err = nil, pr('set.errors.must_specify_value', key: key)
      elsif setting.boolean?
        value, err = get_onoff(value, key =~ /^no/ ? false : true)
      elsif setting.integer?
        value, err = get_int(value, setting.to_sym, 1)
      end
      return errmsg(err) if value.nil?

      setting.value = value

      puts setting.to_s
    end

get_onoff(arg, default) click to toggle source

    # File lib/byebug/commands/set.rb, line 35
    def get_onoff(arg, default)
      return default if arg.nil?

      case arg
      when '1', 'on', 'true'
        true
      when '0', 'off', 'false'
        false
      else
        [nil, pr('set.errors.on_off', arg: arg)]
      end
    end

regexp() click to toggle source

    # File lib/byebug/commands/set.rb, line 10
    def regexp
      /^\s* set (?:\s+(?<setting>\w+))? (?:\s+(?<value>\S+))? \s*$/x
    end