class Byebug::BreakCommand

Implements breakpoint functionality

Public Class Methods

description() click to toggle source
# File lib/byebug/commands/break.rb, line 21
def self.description
  <<-EOD
    b[reak] [file:]line [if expr]
    b[reak] [module::...]class(.|#)method [if expr]

    They can be specified by line or method and an expression can be added
    for conditionally enabled breakpoints.

    #{short_description}
  EOD
end
regexp() click to toggle source
# File lib/byebug/commands/break.rb, line 17
def self.regexp
  /^\s* b(?:reak)? (?:\s+ (\S+))? (?:\s+ if \s+(.+))? \s*$/x
end
short_description() click to toggle source
# File lib/byebug/commands/break.rb, line 33
def self.short_description
  'Sets breakpoints in the source code'
end

Public Instance Methods

execute() click to toggle source
# File lib/byebug/commands/break.rb, line 37
def execute
  return puts(help) unless @match[1]

  b = line_breakpoint(@match[1]) || method_breakpoint(@match[1])
  return errmsg(pr('break.errors.location')) unless b

  if syntax_valid?(@match[2])
    return puts(pr('break.created', id: b.id, file: b.source, line: b.pos))
  end

  errmsg(pr('break.errors.expression', expr: @match[2]))
  b.enabled = false
end

Private Instance Methods

add_line_breakpoint(file, line) click to toggle source
# File lib/byebug/commands/break.rb, line 82
def add_line_breakpoint(file, line)
  fail(pr('break.errors.source', file: file)) unless File.exist?(file)

  fullpath = File.realpath(file)

  if line > n_lines(file)
    fail(pr('break.errors.far_line', lines: n_lines(file), file: fullpath))
  end

  unless Breakpoint.potential_line?(fullpath, line)
    fail(pr('break.errors.line', file: fullpath, line: line))
  end

  Breakpoint.add(fullpath, line, @match[2])
end
line_breakpoint(location) click to toggle source
# File lib/byebug/commands/break.rb, line 53
def line_breakpoint(location)
  line_match = location.match(/^(\d+)$/)
  file_line_match = location.match(/^([^:]+):(\d+)$/)
  return unless line_match || file_line_match

  file = line_match ? frame.file : file_line_match[1]
  line = line_match ? line_match[1].to_i : file_line_match[2].to_i

  add_line_breakpoint(file, line)
end
method_breakpoint(location) click to toggle source
# File lib/byebug/commands/break.rb, line 64
def method_breakpoint(location)
  location.match(/([^.#]+)[.#](.+)/) do |match|
    klass = target_object(match[1])
    method = match[2].intern

    Breakpoint.add(klass, method, @match[2])
  end
end
target_object(str) click to toggle source
# File lib/byebug/commands/break.rb, line 73
def target_object(str)
  k = error_eval(str)

  k && k.is_a?(Module) ? k.name : str
rescue
  errmsg('Warning: breakpoint source is not yet defined')
  str
end