Class: Byebug::ShowCommand

Inherits:

Command

• Object
• Command
• Byebug::ShowCommand

Defined in:

lib/byebug/commands/show.rb

Overview

Implements byebug “show” command.

Constant Summary

Subcommands =

[
   ['args', 2,
    'Show argument list to the program being debugged when it is started',
    'Follow this command with any number of args to be passed to the '    \
    'program'],
   ['autoeval', 4, 'Show whether unrecognized commands are evaluated'],
   ['autolist', 4, 'Show whether "list" command is run on stopping'],
   ['autoirb', 4, 'Show whether IRB is invoked on stopping'],
   ['autoreload', 4, 'Show whether source code is reloaded when changed'],
   ['basename',  1, 'Show whether basename is used when reporting files'],
   ['callstyle', 2, 'Show paramater style used when showing call frames'],
   ['commands',  2, 'Show the history of commands you typed',
    'You can supply a command number to start with'],
   ['forcestep', 1,
    'Show whether "next/step" commands are set to always move to a line'],
   ['fullpath',  2, 'Show whether full paths are displayed in frames'],
   ['history', 2, 'Generic command to show command history parameters',
    'show history filename -- Show the filename in which to record the ' \
    'command history'                                                    \
    'show history save -- Show whether history record should be saved '  \
    'on exit'                                                            \
    'show history size -- Show the size of the command history'],
   ['linetrace', 3, 'Show line execution tracing status'],
   ['linetrace_plus', 10,
    'Show whether different consecutive lines are shown in tracing'],
   ['listsize', 3, 'Show number of source lines to list by default'],
   ['post-mortem', 3, 'Show whether we should go into post-mortem ' \
                      'debugging on an uncaught exception'],
   ['stack_on_error', 1, 'Show whether a stack trace is displayed ' \
                               'when "eval" raises an exception'],
   ['verbose', 4, true,
    'Show whether verbose output for debugging byebug itself is enabled'],
   ['version', 1, 'Show byebug\'s version'],
   ['width', 1, 'Show the number of characters per line for byebug']
  ].map do |name, min, short_help, long_help|
  Subcmd.new(name, min, short_help, long_help)
end

Constants inherited from Command

Command::DEF_OPTIONS

Class Method Summary

• .description ⇒ Object
• .names ⇒ Object

Instance Method Summary

• #execute ⇒ Object
• #regexp ⇒ Object

Methods inherited from Command

command_exists?, commands, find, format_subcmd, format_subcmds, help, inherited, #initialize, load_commands, #match, method_missing, options, register_setting_get, register_setting_set, register_setting_var, settings, settings_map, terminal_width

Constructor Details

This class inherits a constructor from Byebug::Command

Class Method Details

.description ⇒ Object

# File 'lib/byebug/commands/show.rb', line 213

def description
  %{Generic command for showing things about byebug.}
end

.names ⇒ Object

# File 'lib/byebug/commands/show.rb', line 209

def names
  %w(show)
end

Instance Method Details

#execute ⇒ Object

# File 'lib/byebug/commands/show.rb', line 195

def execute
  return print ShowCommand.help(nil) unless @match[1]

  args = @match[1].split(/[ \t]+/)
  param = args.shift
  subcmd = Command.find(Subcommands, param)
  if subcmd
    print "%s\n" % show_setting(subcmd.name)
  else
    print "Unknown show command #{param}\n"
  end
end

#regexp ⇒ Object

# File 'lib/byebug/commands/show.rb', line 191

def regexp
  /^\s* show (?:\s+(.+))? \s*$/x
end