Class: Byebug::WhereCommand

Inherits:
Command
  • Object
show all
Includes:
Helpers::FrameHelper
Defined in:
lib/byebug/commands/where.rb

Overview

Show current backtrace.

Instance Attribute Summary

Attributes inherited from Command

#processor

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers::FrameHelper

#jump_frames, #switch_to_frame

Methods inherited from Command

#arguments, columnize, #context, #frame, help, #initialize, match, to_s

Methods included from Helpers::StringHelper

#camelize, #deindent, #prettify

Constructor Details

This class inherits a constructor from Byebug::Command

Class Method Details

.description ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/byebug/commands/where.rb', line 20

def self.description
  <<-DESCRIPTION
    w[here]|bt|backtrace[ maximum-frame]

    #{short_description}

    Print the entire stack frame. Each frame is numbered; the most recent
    frame is 0. A 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 -->. C-frames hang
    from their most immediate Ruby frame to indicate that they are not
    navigable.

    Without an argument, the command prints all the frames. With an argument,
    the command prints the nth first frames, where n is the largest between
    the argument or the maximum stack frame.
  DESCRIPTION
end

.regexp ⇒ Object 



16
17
18
 
# File 'lib/byebug/commands/where.rb', line 16

def self.regexp
  /^\s* (?:w(?:here)?|bt|backtrace) (?:\s+(\S+))? \s*$/x
end

.short_description ⇒ Object 



39
40
41
 
# File 'lib/byebug/commands/where.rb', line 39

def self.short_description
  "Displays the backtrace"
end

Instance Method Details

#execute ⇒ Object 



43
44
45
 
# File 'lib/byebug/commands/where.rb', line 43

def execute
  print_backtrace
end