1
0
Fork 0
mirror of https://github.com/pry/pry.git synced 2022-11-09 12:35:05 -05:00
pry--pry/lib/pry/repl.rb

200 lines
6.2 KiB
Ruby
Raw Normal View History

require 'forwardable'
2012-12-21 03:02:13 -05:00
class Pry
2012-12-21 03:02:13 -05:00
class REPL
extend Forwardable
2012-12-28 22:06:02 -05:00
def_delegators :@pry, :input, :output
2012-12-28 22:06:02 -05:00
# @return [Pry] The instance of {Pry} that the user is controlling.
attr_accessor :pry
2012-12-28 22:06:02 -05:00
# Instantiate a new {Pry} instance with the given options, then start a
# {REPL} instance wrapping it.
# @option options See {Pry#initialize}
def self.start(options)
2012-12-23 03:08:40 -05:00
new(Pry.new(options)).start
end
2012-12-28 22:06:02 -05:00
# Create an instance of {REPL} wrapping the given {Pry}.
# @param [Pry] pry The instance of {Pry} that this {REPL} will control.
# @param [Hash] options Options for this {REPL} instance.
# @option options [Object] :target The initial target of the session.
2012-12-23 03:08:40 -05:00
def initialize(pry, options = {})
@pry = pry
@indent = Pry::Indent.new
if options[:target]
@pry.push_binding options[:target]
end
end
2012-12-28 22:06:02 -05:00
# Start the read-eval-print loop.
# @return [Object?] If the session throws `:breakout`, return the value
# thrown with it.
# @raise [Exception] If the session throws `:raise_up`, raise the exception
# thrown with it.
2012-12-21 03:02:13 -05:00
def start
2012-12-28 01:10:44 -05:00
prologue
2012-12-28 17:19:42 -05:00
repl
ensure
2012-12-28 01:10:44 -05:00
epilogue
end
private
2012-12-28 22:06:02 -05:00
# Set up the repl session.
# @return [void]
2012-12-28 01:10:44 -05:00
def prologue
2012-12-21 04:38:32 -05:00
pry.exec_hook :before_session, pry.output, pry.current_binding, pry
2012-12-28 22:06:02 -05:00
# Clear the line before starting Pry. This fixes issue #566.
if Pry.config.correct_indent
Kernel.print Pry::Helpers::BaseHelpers.windows_ansi? ? "\e[0F" : "\e[0G"
end
end
2012-12-28 22:06:02 -05:00
# The actual read-eval-print loop.
2012-12-28 19:24:07 -05:00
#
2012-12-28 22:06:02 -05:00
# The {REPL} instance is responsible for reading and looping, whereas the
# {Pry} instance is responsible for evaluating user input and printing
# return values and command output.
2012-12-28 19:24:07 -05:00
#
2012-12-28 22:06:02 -05:00
# @return [Object?] If the session throws `:breakout`, return the value
# thrown with it.
# @raise [Exception] If the session throws `:raise_up`, raise the exception
# thrown with it.
2012-12-28 17:19:42 -05:00
def repl
loop do
2012-12-28 01:11:30 -05:00
case val = read
when :control_c
output.puts ""
2012-12-27 22:56:43 -05:00
pry.reset_eval_string
when :no_more_input
output.puts "" if output.tty?
2012-12-21 04:38:32 -05:00
break
else
2012-12-21 04:38:32 -05:00
output.puts "" if val.nil? && output.tty?
2012-12-28 01:06:50 -05:00
return pry.exit_value unless pry.eval(val)
end
end
end
2012-12-28 22:06:02 -05:00
# Clean up after the repl session.
# @return [void]
2012-12-28 01:10:44 -05:00
def epilogue
2012-12-21 04:38:32 -05:00
pry.exec_hook :after_session, pry.output, pry.current_binding, pry
end
2012-12-28 22:06:02 -05:00
# Read a line of input from the user.
# @return [String] The line entered by the user.
# @return [nil] On `<Ctrl-D>`.
# @return [:control_c] On `<Ctrl+C>`.
# @return [:no_more_input] On EOF.
2012-12-28 01:11:30 -05:00
def read
@indent.reset if pry.eval_string.empty?
current_prompt = pry.select_prompt
indentation = Pry.config.auto_indent ? @indent.current_prefix : ''
2013-01-18 03:35:59 -05:00
val = read_line("#{current_prompt}#{indentation}")
# Return nil for EOF, :no_more_input for error, or :control_c for <Ctrl-C>
return val unless String === val
if Pry.config.auto_indent
original_val = "#{indentation}#{val}"
indented_val = @indent.indent(val)
if output.tty? && @indent.should_correct_indentation?
output.print @indent.correct_indentation(
current_prompt, indented_val,
original_val.length - indented_val.length
)
output.flush
end
else
indented_val = val
end
indented_val
end
2012-12-28 22:06:02 -05:00
# Manage switching of input objects on encountering `EOFError`s.
# @return [Object] Whatever the given block returns.
# @return [:no_more_input] Indicates that no more input can be read.
def handle_read_errors
should_retry = true
exception_count = 0
2012-12-28 22:06:02 -05:00
begin
yield
rescue EOFError
pry.input = Pry.config.input
if !should_retry
2012-12-28 22:06:02 -05:00
output.puts "Error: Pry ran out of things to read from! " \
"Attempting to break out of REPL."
return :no_more_input
end
should_retry = false
retry
2013-01-18 03:35:59 -05:00
# Handle <Ctrl+C> like Bash: empty the current input buffer, but don't
# quit. This is only for MRI 1.9; other versions of Ruby don't let you
# send Interrupt from within Readline.
rescue Interrupt
2013-01-18 03:35:59 -05:00
return :control_c
2012-12-28 22:06:02 -05:00
# If we get a random error when trying to read a line we don't want to
# automatically retry, as the user will see a lot of error messages
# scroll past and be unable to do anything about it.
rescue RescuableException => e
puts "Error: #{e.message}"
output.puts e.backtrace
exception_count += 1
if exception_count < 5
retry
end
puts "FATAL: Pry failed to get user input using `#{input}`."
2012-12-28 22:06:02 -05:00
puts "To fix this you may be able to pass input and output file " \
"descriptors to pry directly. e.g."
puts " Pry.config.input = STDIN"
puts " Pry.config.output = STDOUT"
puts " binding.pry"
return :no_more_input
end
end
2012-12-28 22:06:02 -05:00
# Returns the next line of input to be sent to the {Pry} instance.
# @param [String] current_prompt The prompt to use for input.
2012-12-28 22:06:02 -05:00
# @return [String?] The next line of input, or `nil` on <Ctrl-D>.
2012-12-28 18:19:21 -05:00
def read_line(current_prompt)
handle_read_errors do
if defined? Coolline and input.is_a? Coolline
input.completion_proc = proc do |cool|
2012-12-28 18:19:21 -05:00
completions = @pry.complete cool.completed_word
completions.compact
end
elsif input.respond_to? :completion_proc=
2012-12-28 18:19:21 -05:00
input.completion_proc = proc do |input|
@pry.complete input
end
end
if input == Readline
if !$stdout.tty? && $stdin.tty? && !Pry::Helpers::BaseHelpers.windows?
Readline.output = File.open('/dev/tty', 'w')
end
input.readline(current_prompt, false) # false since we'll add it manually
elsif defined? Coolline and input.is_a? Coolline
input.readline(current_prompt)
else
if input.method(:readline).arity == 1
input.readline(current_prompt)
else
input.readline
end
end
end
end
end
end