lib/byebug/commands/set.rb



module Byebug

  # Implements byebug "set" command.
  class SetCommand < Command
    SubcmdStruct2 = Struct.new(:name,
                               :min,
                               :is_bool,
                               :short_help,
                               :long_help) unless defined?(SubcmdStruct2)

    Subcommands =
      [
       ['annotate', 2, false, 'Set annotation level',
        '0 == normal; '                                                    \
        '2 == output annotated suitably for use by programs that control ' \
        'byebug'],
       ['args', 2, false,
        'Set argument list to give program being debugged when it is started'],
       ['autoeval', 4, true, 'Evaluate every unrecognized command'],
       ['autolist', 4, true, 'Execute "list" command on every breakpoint'],
       ['autoirb', 4, true, 'Invoke IRB on every stop'],
       ['autoreload', 4, true, 'Reload source code when changed'],
       ['basename', 1, true, 'Set filename display style'],
       ['callstyle', 2, false, 'Set how you want call parameters displayed'],
       ['testing', 2, false, 'Used when testing byebug'],
       ['forcestep', 2, true,
        'Make sure "next/step" commands always move to a new line'],
       ['fullpath', 2, true, 'Display full file names in frames'],
       ['history', 2, false,
        'Generic command for setting command history parameters',
        'set history filename -- Set the filename in which to record the ' \
        'command history'                                                  \
        'set history save -- Set saving of the history record on exit'     \
        'set history size -- Set the size of the command history'],
       ['linetrace+', 10, true,
        'Set line execution tracing to show different lines'],
       ['linetrace', 3, true, 'Set line execution tracing'],
       ['listsize', 3, false, 'Set number of source lines to list by default'],
       ['trace', 1, true, 'Display stack trace when "eval" raises exception'],
       ['width', 1, false,
        'Number of characters per line for byebug\'s output']
      ].map do |name, min, is_bool, short_help, long_help|
      SubcmdStruct2.new(name, min, is_bool, short_help, long_help)
    end unless defined?(Subcommands)

    self.allow_in_control = true

    def regexp
      /^set (?: \s+ (.*) )?$/ix
    end

    def execute
      return print SetCommand.help(nil) if SetCommand.names.include?(@match[0])

      args = @match[1].split(/[ \t]+/)
      try_subcmd = args.shift
      try_subcmd.downcase!
      if try_subcmd =~ /^no/i
        set_on = false
        try_subcmd = try_subcmd[2..-1]
      else
        set_on = true
      end

      subcmd = Command.find(Subcommands, try_subcmd)

      # Subcommand not found...
      return print "Unknown set command \"#{try_subcmd}\"\n" unless subcmd

      begin
        set_on = get_onoff(args[0]) if subcmd.is_bool and args.size > 0
      rescue RuntimeError
        return
      end

      case subcmd.name
      when /^annotate$/
        level = get_int(args[0], "Set annotate", 0, 3, 0)
        if level
          Byebug.annotate = level
        else
          return
        end
      when /^args$/
        if defined?(Byebug::BYEBUG_SCRIPT)
          Command.settings[:argv][1..-1] = args
        else
          Command.settings[:argv] = args
        end
      when /^autolist$/
        Command.settings[:autolist] = (set_on ? 1 : 0)
      when /^autoeval$/
        Command.settings[:autoeval] = set_on
      when /^basename$/
        Command.settings[:basename] = set_on
      when /^callstyle$/
        if args[0] and (args[0] == 'short' or args[0] == 'long')
          Command.settings[:callstyle] = args[0].to_sym
        else
          print "Invalid callstyle. Should be one of: \"short\" or \"long\"\n"
        end
      when /^trace$/
        Command.settings[:stack_trace_on_error] = set_on
      when /^fullpath$/
        Command.settings[:frame_fullpath] = set_on
      when /^autoreload$/
        Command.settings[:autoreload] = set_on
      when /^autoirb$/
        Command.settings[:autoirb] = (set_on ? 1 : 0)
      when /^testing$/
        Command.settings[:testing] = set_on
      when /^forcestep$/
        Command.settings[:force_stepping] = set_on
      when /^history$/
        if 2 == args.size
          interface = @state.interface
          case args[0]
          when /^save$/
            interface.history_save = get_onoff(args[1])
          when /^size$/
            interface.history_length =
              get_int(args[1], "Set history size")
          when /^filename$/
            interface.histfile =
              File.join(ENV["HOME"]||ENV["HOMEPATH"]||".", args[1])
          else
            print "Invalid history parameter #{args[0]}. Should be " \
                  "\"filename\", \"save\" or \"size\".\n"
          end
        else
          print 'Need two parameters for "set history"; got ' \
                "#{args.size}.\n"
          return
        end
      when /^linetrace\+$/
        self.class.settings[:tracing_plus] = set_on
      when /^linetrace$/
        Byebug.tracing = set_on
      when /^listsize$/
        listsize = get_int(args[0], "Set listsize", 1, nil, 10)
        return unless listsize
        self.class.settings[:listsize] = listsize
      when /^width$/
        return unless width = get_int(args[0], "Set width", 10, nil, 80)
        Command.settings[:width] = width
      else
        return print "Unknown setting #{@match[1]}.\n"
      end
      return print "#{show_setting(subcmd.name)}\n"
    end

    class << self
      def names
        %w(set)
      end

      def description
        %{Modifies parts of byebug environment. Boolean values take on, off, 1
          or 0. You can see these environment settings with the "show" command.}
      end
    end

  end
end