class Byebug::Runner

Responsible for starting the debugger when started from the command line.

Attributes

help[R]

Special working modes that don't actually start the debugger.

quit[RW]

Signals that we should exit after the debugged program is finished.

remote[R]

Special working modes that don't actually start the debugger.

version[R]

Special working modes that don't actually start the debugger.

Public Class Methods

new(stop = true, quit = true) click to toggle source

@param stop [Boolean] Whether the runner should stop right before starting the program.

@param quit [Boolean] Whether the runner should quit right after finishing the program.

# File lib/byebug/runner.rb, line 48
def initialize(stop = true, quit = true)
  @stop = stop
  @quit = quit
end

Public Instance Methods

banner() click to toggle source

Usage banner.

debug_program() click to toggle source

Debugs a script only if syntax checks okay.

# File lib/byebug/runner.rb, line 138
def debug_program
  ok = syntax_valid?(File.read($PROGRAM_NAME))
  fail(InvalidScript, 'The script has incorrect syntax') unless ok

  error = Byebug.debug_load($PROGRAM_NAME, @stop)
  puts "#{error}\n#{error.backtrace}" if error
end
help=(text) click to toggle source
# File lib/byebug/runner.rb, line 53
def help=(text)
  @help ||= text

  interface.puts("\n#{text}\n")
end
interface() click to toggle source
# File lib/byebug/runner.rb, line 105
def interface
  @interface ||= LocalInterface.new
end
prepare_options() click to toggle source

Processes options passed from the command line.

# File lib/byebug/runner.rb, line 112
def prepare_options
  OptionParser.new(banner, 25) do |opts|
    opts.banner = banner

    OptionSetter.new(self, opts).setup
  end
end
remote=(host_and_port) click to toggle source
# File lib/byebug/runner.rb, line 65
def remote=(host_and_port)
  @remote ||= Byebug.parse_host_and_port(host_and_port)
end
run() click to toggle source

Starts byebug to debug a program.

# File lib/byebug/runner.rb, line 85
def run
  prepare_options.order!($ARGV)
  return if version || help

  if remote
    Byebug.start_client(*remote)
    return
  end

  setup_cmd_line_args

  loop do
    debug_program

    break if quit

    ControlProcessor.new.process_commands
  end
end
setup_cmd_line_args() click to toggle source

Extracts debugged program from command line args.

# File lib/byebug/runner.rb, line 123
def setup_cmd_line_args
  Byebug.mode = :standalone

  fail(NoScript, 'You must specify a program to debug...') if $ARGV.empty?

  program = which($ARGV.shift)
  program = which($ARGV.shift) if program == which('ruby')
  fail(NonExistentScript, "The script doesn't exist") unless program

  $PROGRAM_NAME = program
end
version=(number) click to toggle source
# File lib/byebug/runner.rb, line 59
def version=(number)
  @version ||= number

  interface.puts("\n  Running byebug #{number}\n")
end
which(cmd) click to toggle source

Cross-platform way of finding an executable in the $PATH. Borrowed from: stackoverflow.com/questions/2108727

# File lib/byebug/runner.rb, line 150
def which(cmd)
  return File.expand_path(cmd) if File.exist?(cmd)

  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
  ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
    exts.each do |ext|
      exe = File.join(path, "#{cmd}#{ext}")
      return exe if File.executable?(exe) && !File.directory?(exe)
    end
  end

  nil
end