Class: Byebug::WhereCommand

Inherits:
Command
  • Object
show all
Defined in:
lib/byebug/commands/frame.rb

Overview

Implements byebug “where” or “backtrace” command.

Constant Summary

Constants inherited from Command

Command::DEF_OPTIONS

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Command

commands, help, inherited, #initialize, load_commands, #match, method_missing, options, register_setting_get, register_setting_set, register_setting_var, settings, settings_map

Constructor Details

This class inherits a constructor from Byebug::Command

Class Method Details

.descriptionObject



179
180
181
182
183
184
185
186
187
188
# File 'lib/byebug/commands/frame.rb', line 179

def description
  %{
    w[here]|bt|backtrace\tdisplay stack frames

    Print the entire stack frame. Each frame is numbered, the most recent
    frame is 0. frame number can be referred to in the "frame" command;
    "up" and "down" add or subtract respectively to frame numbers shown.
    The position of the current frame is marked with -->.
  }
end

.namesObject



175
176
177
# File 'lib/byebug/commands/frame.rb', line 175

def names
  %w(where backtrace)
end

Instance Method Details

#executeObject



167
168
169
170
171
172
# File 'lib/byebug/commands/frame.rb', line 167

def execute
  print_backtrace
  if truncated_callstack?(@state.context, Byebug.start_sentinal)
     print "Warning: saved frames may be incomplete; compare with caller(0)"
  end
end

#regexpObject



163
164
165
# File 'lib/byebug/commands/frame.rb', line 163

def regexp
  /^\s*(?:w(?:here)?|bt|backtrace)$/
end