class Byebug::Interface

Main Interface class

Contains common functionality to all implemented interfaces.

Attributes

command_queue[RW]
error[R]
history[RW]
input[R]
output[R]

Public Class Methods

new() click to toggle source
# File lib/byebug/interface.rb, line 21
def initialize
  @command_queue = []
  @history = History.new
  @last_line = ""
end

Public Instance Methods

autorestore() click to toggle source

Restores history according to autosave setting.

# File lib/byebug/interface.rb, line 117
def autorestore
  history.restore if Setting[:autosave]
end
autosave() click to toggle source

Saves or clears history according to autosave setting.

# File lib/byebug/interface.rb, line 110
def autosave
  Setting[:autosave] ? history.save : history.clear
end
close() click to toggle source
# File lib/byebug/interface.rb, line 104
def close
end
confirm(prompt) click to toggle source

Confirms user introduced an affirmative response to the input stream.

# File lib/byebug/interface.rb, line 100
def confirm(prompt)
  readline(prompt) == "y"
end
errmsg(message) click to toggle source

Prints an error message to the error stream.

# File lib/byebug/interface.rb, line 79
def errmsg(message)
  error.print("*** #{message}\n")
end
last_if_empty(input) click to toggle source
# File lib/byebug/interface.rb, line 27
def last_if_empty(input)
  @last_line = input.empty? ? @last_line : input
end
prepare_input(prompt) click to toggle source

Reads a new line from the interface's input stream.

@return [String] New string read or the previous string if the string read now was empty.

# File lib/byebug/interface.rb, line 69
def prepare_input(prompt)
  line = readline(prompt)
  return unless line

  last_if_empty(line)
end
print(message) click to toggle source

Prints an output message to the output stream without a final “n”.

puts(message) click to toggle source

Prints an output message to the output stream.

# File lib/byebug/interface.rb, line 86
def puts(message)
  output.puts(message)
end
read_command(prompt) click to toggle source

Pops a command from the input stream.

# File lib/byebug/interface.rb, line 34
def read_command(prompt)
  return command_queue.shift unless command_queue.empty?

  read_input(prompt)
end
read_file(filename) click to toggle source

Pushes lines in filename to the command queue.

# File lib/byebug/interface.rb, line 43
def read_file(filename)
  command_queue.concat(get_lines(filename))
end
read_input(prompt, save_hist = true) click to toggle source

Reads a new line from the interface's input stream, parses it into commands and saves it to history.

@return [String] Representing something to be run by the debugger.

# File lib/byebug/interface.rb, line 53
def read_input(prompt, save_hist = true)
  line = prepare_input(prompt)
  return unless line

  history.push(line) if save_hist

  command_queue.concat(split_commands(line))
  command_queue.shift
end

Private Instance Methods

split_commands(cmd_line) click to toggle source

Splits a command line of the form “cmd1 ; cmd2 ; … ; cmdN” into an array of commands: [cmd1, cmd2, …, cmdN]

# File lib/byebug/interface.rb, line 127
def split_commands(cmd_line)
  return [""] if cmd_line.empty?

  cmd_line.split(/;/).each_with_object([]) do |v, m|
    if m.empty? || m.last[-1] != '\\'
      m << v.strip
      next
    end

    m.last[-1, 1] = ""
    m.last << ";" << v
  end
end