Module: Byebug::InfoFunctions

Includes:
FileFunctions
Included in:
InfoCommand
Defined in:
lib/byebug/commands/info.rb

Overview

Utilities for the info command.

Instance Method Summary collapse

Methods included from FileFunctions

#get_line, #get_lines, #n_lines, #normalize

Instance Method Details

#info_args(*args) ⇒ Object


20
21
22
23
24
25
26
27
28
29
30
# File 'lib/byebug/commands/info.rb', line 20

def info_args(*args)
  locals = @state.context.frame_locals
  args = @state.context.frame_args
  return if args == [[:rest]]

  args.map do |_, name|
    s = "#{name} = #{locals[name].inspect}"
    s[Setting[:width] - 3..-1] = '...' if s.size > Setting[:width]
    puts s
  end
end

#info_breakpoint(brkpt) ⇒ Object


32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/byebug/commands/info.rb', line 32

def info_breakpoint(brkpt)
  expr = brkpt.expr.nil? ? '' : " if #{brkpt.expr}"
  y_n = brkpt.enabled? ? 'y' : 'n'
  interp = format('%-3d %-3s at %s:%s%s',
                  brkpt.id, y_n, brkpt.source, brkpt.pos, expr)
  puts interp
  hits = brkpt.hit_count
  return unless hits > 0

  s = (hits > 1) ? 's' : ''
  puts "\tbreakpoint already hit #{hits} time#{s}"
end

#info_breakpoints(*args) ⇒ Object


45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/byebug/commands/info.rb', line 45

def info_breakpoints(*args)
  return puts('No breakpoints.') if Byebug.breakpoints.empty?

  brkpts = Byebug.breakpoints.sort_by(&:id)
  unless args.empty?
    indices = args.map(&:to_i)
    brkpts = brkpts.select { |b| indices.member?(b.id) }
    return errmsg('No breakpoints found among list given') if brkpts.empty?
  end

  puts 'Num Enb What'
  brkpts.each { |b| info_breakpoint(b) }
end

#info_catch(*_args) ⇒ Object


8
9
10
11
12
13
14
15
16
17
18
# File 'lib/byebug/commands/info.rb', line 8

def info_catch(*_args)
  return puts('No frame selected.') unless @state.context

  if Byebug.catchpoints && !Byebug.catchpoints.empty?
    Byebug.catchpoints.each do |exception, _hits|
      puts("#{exception}: #{exception.is_a?(Class)}")
    end
  else
    puts 'No exceptions set to be caught.'
  end
end

#info_display(*_args) ⇒ Object


59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/byebug/commands/info.rb', line 59

def info_display(*_args)
  return puts('There are no auto-display expressions now.') unless
    @state.display.find { |d| d[0] }

  puts 'Auto-display expressions now in effect:'
  puts 'Num Enb Expression'
  n = 1
  @state.display.each do |d|
    puts(format('%3d: %s  %s', n, d[0] ? 'y' : 'n', d[1]))
    n += 1
  end
end

#info_file_basic(file) ⇒ Object


74
75
76
77
78
79
80
# File 'lib/byebug/commands/info.rb', line 74

def info_file_basic(file)
  path = File.expand_path(file)
  return unless File.exist?(path)

  s = n_lines(path) == 1 ? '' : 's'
  "#{path} (#{n_lines(path)} line#{s})"
end

#info_file_breakpoints(file) ⇒ Object


82
83
84
85
86
87
88
# File 'lib/byebug/commands/info.rb', line 82

def info_file_breakpoints(file)
  breakpoints = Breakpoint.potential_lines(file)
  return unless breakpoints

  breakpoints.to_a.sort.columnize(line_prefix: '  ',
                                  displaywidth: Setting[:width])
end

#info_file_mtime(file) ⇒ Object


90
91
92
# File 'lib/byebug/commands/info.rb', line 90

def info_file_mtime(file)
  File.stat(file).mtime
end

#info_file_sha1(file) ⇒ Object


94
95
96
97
# File 'lib/byebug/commands/info.rb', line 94

def info_file_sha1(file)
  require 'digest/sha1'
  Digest::SHA1.hexdigest(file)
end

#info_line(*_args) ⇒ Object


99
100
101
# File 'lib/byebug/commands/info.rb', line 99

def info_line(*_args)
  puts "Line #{@state.line} of \"#{@state.file}\""
end

#info_program(*_args) ⇒ Object


114
115
116
117
118
119
120
121
122
123
# File 'lib/byebug/commands/info.rb', line 114

def info_program(*_args)
  if @state.context.dead?
    puts 'The program crashed.'
    excpt = Byebug.last_exception
    return puts("Exception: #{excpt.inspect}") if excpt
  end

  puts 'Program stopped. '
  info_stop_reason @state.context.stop_reason
end

#info_stop_reason(stop_reason) ⇒ Object


103
104
105
106
107
108
109
110
111
112
# File 'lib/byebug/commands/info.rb', line 103

def info_stop_reason(stop_reason)
  case stop_reason
  when :step
    puts "It stopped after stepping, next'ing or initial start."
  when :breakpoint
    puts 'It stopped at a breakpoint.'
  when :catchpoint
    puts 'It stopped at a catchpoint.'
  end
end