class Byebug::FinishCommand

Implements the finish functionality.

Allows the user to continue execution until certain frames are finished.

Public Class Methods

description() click to toggle source
# File lib/byebug/commands/finish.rb, line 36
def description
  prettify <<-EOD
    fin[ish][ n_frames]  Execute until frame returns.

    If no number is given, we run until the current frame returns. If a
    number of frames `n_frames` is given, then we run until `n_frames`
    return from the current position.
  EOD
end
names() click to toggle source
# File lib/byebug/commands/finish.rb, line 32
def names
  %w(finish)
end

Public Instance Methods

execute() click to toggle source
# File lib/byebug/commands/finish.rb, line 16
def execute
  max_frames = @state.context.stack_size - @state.frame
  if @match[1]
    n_frames, err = get_int(@match[1], 'finish', 0, max_frames - 1)
    return errmsg(err) unless n_frames
  else
    n_frames = 1
  end

  force = n_frames == 0 ? true : false
  @state.context.step_out(@state.frame + n_frames, force)
  @state.frame = 0
  @state.proceed
end
regexp() click to toggle source
# File lib/byebug/commands/finish.rb, line 12
def regexp
  /^\s* fin(?:ish)? (?:\s+(\S+))? \s*$/x
end