class Byebug::BreakCommand - byebug-4.0.5 Documentation

# class Byebug::BreakCommand

Implements breakpoint functionality

### Public Class Methods

description() click to toggle source

    # File lib/byebug/commands/break.rb, line 35
    def description
      prettify <<-EOD
        b[reak] [file:]line [if expr]
        b[reak] [module::...]class(.|#)method [if expr]

        Set breakpoint to some position, (optionally) if expr == true
      EOD
    end

names() click to toggle source

    # File lib/byebug/commands/break.rb, line 31
    def names
      %w(break)
    end

### Public Instance Methods

execute() click to toggle source

    # File lib/byebug/commands/break.rb, line 15
    def execute
      return puts(self.class.help) unless @match[1]

      b = line_breakpoint(@match[1]) || method_breakpoint(@match[1])

      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
    rescue => e
      errmsg(e.message)
    end

regexp() click to toggle source

    # File lib/byebug/commands/break.rb, line 11
    def regexp
      /^\s* b(?:reak)? (?:\s+ (\S+))? (?:\s+ if \s+(.+))? \s*$/x
    end

### Private Instance Methods

check_errors(file, line) click to toggle source

    # File lib/byebug/commands/break.rb, line 69
    def check_errors(file, line)
      path, deco_path = File.expand_path(file), normalize(file)

      fail(pr('break.errors.source', file: deco_path)) unless File.exist?(path)

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

      return if Breakpoint.potential_line?(path, line)

      fail(pr('break.errors.line', file: deco_path, line: line))
    end

line_breakpoint(loc) click to toggle source

    # File lib/byebug/commands/break.rb, line 47
    def line_breakpoint(loc)
      line, file_line = loc.match(/^(\d+)$/), loc.match(/^([^:]+):(\d+)$/)
      return nil unless line || file_line

      f, l = line ? [@state.file, line[1]] : [file_line[1], file_line[2]]

      check_errors(f, l.to_i)

      Breakpoint.add(File.expand_path(f), l.to_i, @match[2])
    end

method_breakpoint(location) click to toggle source

    # File lib/byebug/commands/break.rb, line 58
    def method_breakpoint(location)
      location.match(/([^.#]+)[.#](.+)/) do |match|
        k, m = bb_warning_eval(match[1]), match[2]

        klass = k && k.is_a?(Module) ? k.name : match[1]
        method = m.intern

        Breakpoint.add(klass, method, @match[2])
      end
    end