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'                    ],
  ['autoeval'      , 5 , 'Show whether unrecognized commands are '      \
                         'evaluated'                                      ],
  ['autolist'      , 5 , 'Show whether "list" command is run on stopping' ],
  ['autoirb'       , 5 , 'Show whether IRB is invoked on stopping'        ],
  ['autoreload'    , 5 , 'Show whether source code is reloaded when '   \
                         'changed'                                        ],
  ['autosave'      , 5 , 'Show whether command history is '             \
                         'automatically saved on exit'                    ],
  ['basename'      , 1 , 'Show whether basename is used when reporting' \
                         ' files'                                         ],
  ['callstyle'     , 2 , 'Show parameter 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'],
  ['histfile'      , 5 , 'File where byebug save history of commands'     ],
  ['histsize'      , 5 , 'Maximum number of commands stored in '        \
                         'byebug\'s 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 , '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, help|
  Subcmd.new(name, min, help)
end

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, 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 145

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

.names ⇒ Object

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

def names
  %w(show)
end

Instance Method Details

#execute ⇒ Object

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

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 123

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