require 'reline/key_actor'
require 'reline/key_stroke'
require 'reline/line_editor'
require 'reline/terminfo'
FILENAME_COMPLETION_PROC = nil
USERNAME_COMPLETION_PROC = nil
class ConfigEncodingConversionError < StandardError; end
Key = Struct.new('Key', :char, :combined_char, :with_meta) do
(other.char.nil? or char.nil? or char == other.char) and
(other.combined_char.nil? or combined_char.nil? or combined_char == other.combined_char) and
(other.with_meta.nil? or with_meta.nil? or with_meta == other.with_meta)
(combined_char and combined_char == other) or
(combined_char.nil? and char and char == other)
alias_method :==, :match?
CursorPos = Struct.new(:x, :y)
DialogRenderInfo = Struct.new(
completion_append_character
basic_word_break_characters
completer_word_break_characters
completer_quote_characters
filename_quote_characters
).each(&method(:attr_reader))
attr_accessor :key_stroke
attr_accessor :line_editor
attr_accessor :last_incremental_search
@completion_quote_character = nil
@bracketed_paste_finished = false
def completion_append_character=(val)
@completion_append_character = nil
@completion_append_character = val.encode(Reline::IOGate.encoding)
@completion_append_character = val[0].encode(Reline::IOGate.encoding)
@completion_append_character = nil
def basic_word_break_characters=(v)
@basic_word_break_characters = v.encode(Reline::IOGate.encoding)
def completer_word_break_characters=(v)
@completer_word_break_characters = v.encode(Reline::IOGate.encoding)
def basic_quote_characters=(v)
@basic_quote_characters = v.encode(Reline::IOGate.encoding)
def completer_quote_characters=(v)
@completer_quote_characters = v.encode(Reline::IOGate.encoding)
def filename_quote_characters=(v)
@filename_quote_characters = v.encode(Reline::IOGate.encoding)
@special_prefixes = v.encode(Reline::IOGate.encoding)
def completion_case_fold=(v)
@config.completion_ignore_case = v
@config.completion_ignore_case
def completion_quote_character
@completion_quote_character
raise ArgumentError unless p.respond_to?(:call) or p.nil?
def output_modifier_proc=(p)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
@output_modifier_proc = p
raise ArgumentError unless p.respond_to?(:call) or p.nil?
raise ArgumentError unless p.respond_to?(:call) or p.nil?
def dig_perfect_match_proc=(p)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
@dig_perfect_match_proc = p
DialogProc = Struct.new(:dialog_proc, :context)
def add_dialog_proc(name_sym, p, context = nil)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
raise ArgumentError unless name_sym.instance_of?(Symbol)
@dialog_proc_list[name_sym] = DialogProc.new(p, context)
def dialog_proc(name_sym)
@dialog_proc_list[name_sym]
raise TypeError unless val.respond_to?(:getc) or val.nil?
if val.respond_to?(:getc)
if defined?(Reline::ANSI) and Reline::IOGate == Reline::ANSI
elsif Reline::IOGate == Reline::GeneralIO
Reline::GeneralIO.input = val
raise TypeError unless val.respond_to?(:write) or val.nil?
if defined?(Reline::ANSI) and Reline::IOGate == Reline::ANSI
Reline::ANSI.output = val
config.editing_mode = :vi_insert
config.editing_mode = :emacs
config.editing_mode_is?(:vi_insert, :vi_command)
config.editing_mode_is?(:emacs)
Reline::IOGate.get_screen_size
Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE = ->() {
return nil unless config.autocompletion
if just_cursor_moving and completion_journey_data.nil?
# Auto complete starts only when edited
pre, target, post = retrieve_completion_block(true)
if target.nil? or target.empty? or (completion_journey_data&.pointer == -1 and target.size <= 3)
if completion_journey_data and completion_journey_data.list
result = completion_journey_data.list.dup
pointer = completion_journey_data.pointer - 1
result = call_completion_proc_with_checking_args(pre, target, post)
if result and result.size == 1 and result[0] == target and pointer != 0
target_width = Reline::Unicode.calculate_width(target)
x = cursor_pos.x - target_width
cursor_pos_to_render = Reline::CursorPos.new(x, y)
if context and context.is_a?(Array)
context.push(cursor_pos_to_render, result, pointer, dialog)
pos: cursor_pos_to_render,
Reline::DEFAULT_DIALOG_CONTEXT = Array.new
def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
unless confirm_multiline_termination
raise ArgumentError.new('#readmultiline needs block to confirm multiline termination')
inner_readline(prompt, add_hist, true, &confirm_multiline_termination)
whole_buffer = line_editor.whole_buffer.dup
whole_buffer.taint if RUBY_VERSION < '2.7'
if add_hist and whole_buffer and whole_buffer.chomp("\n").size > 0
Reline::HISTORY << whole_buffer
line_editor.reset_line if line_editor.whole_buffer.nil?
def readline(prompt = '', add_hist = false)
inner_readline(prompt, add_hist, false)
line = line_editor.line.dup
line.taint if RUBY_VERSION < '2.7'
if add_hist and line and line.chomp("\n").size > 0
Reline::HISTORY << line.chomp("\n")
line_editor.reset_line if line_editor.line.nil?
private def inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination)
if ENV['RELINE_STDERR_TTY']
$stderr = File.open(ENV['RELINE_STDERR_TTY'], 'a')
$stderr.reopen(ENV['RELINE_STDERR_TTY'], 'w')
$stderr.puts "Reline is used by #{Process.pid}"
otio = Reline::IOGate.prep
may_req_ambiguous_char_width
line_editor.reset(prompt, encoding: Reline::IOGate.encoding)
line_editor.confirm_multiline_termination_proc = confirm_multiline_termination
line_editor.multiline_off
line_editor.output = output
line_editor.completion_proc = completion_proc
line_editor.completion_append_character = completion_append_character
line_editor.output_modifier_proc = output_modifier_proc
line_editor.prompt_proc = prompt_proc
line_editor.auto_indent_proc = auto_indent_proc
line_editor.dig_perfect_match_proc = dig_perfect_match_proc
line_editor.pre_input_hook = pre_input_hook
@dialog_proc_list.each_pair do |name_sym, d|
line_editor.add_dialog_proc(name_sym, d.dialog_proc, d.context)
config.reset_default_key_bindings
Reline::IOGate.set_default_key_bindings(config)
line_editor.set_signal_handlers
prev_pasting_state = false
prev_pasting_state = Reline::IOGate.in_pasting?
read_io(config.keyseq_timeout) { |inputs|
line_editor.set_pasting_state(Reline::IOGate.in_pasting?)
if @bracketed_paste_finished
@bracketed_paste_finished = false
if prev_pasting_state == true and not Reline::IOGate.in_pasting? and not line_editor.finished?
line_editor.set_pasting_state(false)
prev_pasting_state = false
break if line_editor.finished?
Reline::IOGate.move_cursor_column(0)
# Maybe the I/O has been closed.
rescue StandardError => e
Reline::IOGate.deprep(otio)
Reline::IOGate.deprep(otio)
Reline::IOGate.deprep(otio)
# GNU Readline waits for "keyseq-timeout" milliseconds to see if the ESC
# is followed by a character, and times out and treats it as a standalone
# ESC if the second character does not arrive. If the second character
# comes before timed out, it is treated as a modifier key with the
# meta-property of meta-key, so that it can be distinguished from
# multibyte characters with the 8th bit turned on.
# GNU Readline will wait for the 2nd character with "keyseq-timeout"
# milli-seconds but wait forever after 3rd characters.
private def read_io(keyseq_timeout, &block)
@bracketed_paste_finished = true
result = key_stroke.match_status(buffer)
expanded = key_stroke.expand(buffer).map{ |expanded_c|
Reline::Key.new(expanded_c, expanded_c, false)
case read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block)
if buffer.size == 1 and c == "\e".ord
read_escaped_key(keyseq_timeout, c, block)
expanded = buffer.map{ |expanded_c|
Reline::Key.new(expanded_c, expanded_c, false)
private def read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block)
Timeout.timeout(keyseq_timeout / 1000.0) {
succ_c = Reline::IOGate.getc
rescue Timeout::Error # cancel matching only when first byte
block.([Reline::Key.new(c, c, false)])
case key_stroke.match_status(buffer.dup.push(succ_c))
block.([Reline::Key.new(succ_c, succ_c | 0b10000000, true)])
block.([Reline::Key.new(c, c, false), Reline::Key.new(succ_c, succ_c, false)])
Reline::IOGate.ungetc(succ_c)
expanded = key_stroke.expand(buffer).map{ |expanded_c|
Reline::Key.new(expanded_c, expanded_c, false)
private def read_escaped_key(keyseq_timeout, c, block)
Timeout.timeout(keyseq_timeout / 1000.0) {
escaped_c = Reline::IOGate.getc
rescue Timeout::Error # independent ESC
block.([Reline::Key.new(c, c, false)])
block.([Reline::Key.new(c, c, false)])
elsif escaped_c >= 128 # maybe, first byte of multi byte
block.([Reline::Key.new(c, c, false), Reline::Key.new(escaped_c, escaped_c, false)])
elsif escaped_c == "\e".ord # escape twice
block.([Reline::Key.new(c, c, false), Reline::Key.new(c, c, false)])
block.([Reline::Key.new(escaped_c, escaped_c | 0b10000000, true)])
may_req_ambiguous_char_width unless defined? @ambiguous_width
private def may_req_ambiguous_char_width
@ambiguous_width = 2 if Reline::IOGate == Reline::GeneralIO or !STDOUT.tty?
return if defined? @ambiguous_width
Reline::IOGate.move_cursor_column(0)
rescue Encoding::UndefinedConversionError
@ambiguous_width = Reline::IOGate.cursor_pos.x
Reline::IOGate.move_cursor_column(0)
Reline::IOGate.erase_after_cursor