Module: Byebug::FrameFunctions

Defined in:
lib/byebug/commands/frame.rb

Overview

Mix-in module to assist in command parsing.

Instance Method Summary collapse

Instance Method Details

#adjust_frame(frame_pos, absolute) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/byebug/commands/frame.rb', line 34

def adjust_frame(frame_pos, absolute)
  if absolute
    abs_frame_pos = switch_to_frame(frame_pos)
    return errmsg "Can't navigate to c-frame\n" if c_frame?(abs_frame_pos)
  else
    abs_frame_pos = navigate_to_frame(frame_pos)
  end

  return errmsg "Can't navigate beyond the oldest frame\n" if
    abs_frame_pos >= @state.context.stack_size
  return errmsg "Can't navigate beyond the newest frame\n" if
    abs_frame_pos < 0

  if @state.frame_pos != abs_frame_pos
    @state.previous_line = nil
    @state.frame_pos = abs_frame_pos
  end

  @state.file = @state.context.frame_file @state.frame_pos
  @state.line = @state.context.frame_line @state.frame_pos

  ListCommand.new(@state).execute
end

#c_frame?(frame_no) ⇒ Boolean

Returns:

  • (Boolean) 


6
7
8
 
# File 'lib/byebug/commands/frame.rb', line 6

def c_frame?(frame_no)
  @state.context.frame_binding(frame_no).nil?
end

#get_frame_args(style, pos) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/byebug/commands/frame.rb', line 70

def get_frame_args(style, pos)
  args = @state.context.frame_args pos
  return '' if args.empty?

  locals = @state.context.frame_locals pos if style == :long
  my_args = args.map do |arg|
    case arg[0]
      when :block
        prefix, default = '&', 'block'
      when :rest
        prefix, default = '*', 'args'
      else
        prefix, default = '', nil
    end
    klass = style == :long && arg[1] ? "##{locals[arg[1]].class}" : ''
    "#{prefix}#{arg[1] || default}#{klass}"
  end

  return "(#{my_args.join(', ')})"
end

#get_frame_block_and_method(pos) ⇒ Object 



63
64
65
66
67
68
 
# File 'lib/byebug/commands/frame.rb', line 63

def get_frame_block_and_method(pos)
  frame_deco_regexp = /((?:block(?: \(\d+ levels\))?|rescue) in )?(.+)/
  frame_deco_method = "#{@state.context.frame_method pos}"
  frame_block_and_method = frame_deco_regexp.match(frame_deco_method)[1..2]
  return frame_block_and_method.map{ |x| x.nil? ? '' : x }
end

#get_frame_call(prefix, pos) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/byebug/commands/frame.rb', line 91

def get_frame_call(prefix, pos)
  frame_block, frame_method = get_frame_block_and_method(pos)
  frame_class = get_frame_class(Command.settings[:callstyle], pos)
  frame_args = get_frame_args(Command.settings[:callstyle], pos)

  call_str = frame_block + frame_class + frame_method + frame_args

  max_call_str_size = Command.settings[:width] - prefix.size
  if call_str.size > max_call_str_size
    call_str = call_str[0..max_call_str_size - 5] + "...)"
  end

  return call_str
end

#get_frame_class(style, pos) ⇒ Object 



58
59
60
61
 
# File 'lib/byebug/commands/frame.rb', line 58

def get_frame_class(style, pos)
  frame_class = style == :short ? '' : "#{@state.context.frame_class pos}"
  return frame_class == '' ? '' : "#{frame_class}."
end

#navigate_to_frame(jump_no) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/byebug/commands/frame.rb', line 18

def navigate_to_frame(jump_no)
  return if jump_no == 0
  total_jumps, current_jumps, new_pos = jump_no.abs, 0, @state.frame_pos
  step = jump_no/total_jumps
  loop do
    new_pos += step
    return new_pos if new_pos < 0 || new_pos >= @state.context.stack_size

    next if c_frame?(new_pos)

    current_jumps += 1
    break if current_jumps == total_jumps
  end
  return new_pos
end

#print_backtrace ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/byebug/commands/frame.rb', line 106

def print_backtrace
  realsize = caller.drop_while {|e| e[/\(eval\)|byebug/] }.size
  if @state.context.stack_size != realsize
    errmsg "Warning, Byebug's stacksize (#{@state.context.stack_size}) is" \
           " incorrect (must be #{realsize}). This might be a bug in " \
           "byebug or ruby's debugging API's\n"
  end
  (0...realsize).each do |idx|
    print_frame(idx)
  end
end

#print_frame(pos, mark_current = true) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/byebug/commands/frame.rb', line 118

def print_frame(pos, mark_current = true)
  file = @state.context.frame_file pos
  line = @state.context.frame_line pos

  unless Command.settings[:frame_fullpath]
    path_components = file.split(/[\\\/]/)
    if path_components.size > 3
      path_components[0...-3] = '...'
      file = path_components.join(File::ALT_SEPARATOR || File::SEPARATOR)
    end
  end

  if mark_current
    frame_str = (pos == @state.frame_pos) ? '--> ' : '    '
  else
    frame_str = ""
  end
  frame_str += c_frame?(pos) ? ' ͱ-- ' : ''

  frame_str += sprintf "#%-2d ", pos
  frame_str += get_frame_call frame_str, pos
  file_line = "at #{CommandProcessor.canonic_file(file)}:#{line}"
  if frame_str.size + file_line.size + 1 > Command.settings[:width]
    frame_str += "\n      #{file_line}\n"
  else
    frame_str += " #{file_line}\n"
  end

  print frame_str
end

#switch_to_frame(frame_no) ⇒ Object 



10
11
12
13
14
15
16
 
# File 'lib/byebug/commands/frame.rb', line 10

def switch_to_frame(frame_no)
  if frame_no < 0
    abs_frame_no = @state.context.stack_size + frame_no
  else
    abs_frame_no = frame_no
  end
end