mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
f8ea2860b0
The command prompt on Windows always uses Unicode to take input and print output but most Reline implementation depends on Encoding.default_external. This commit introduces an abstracted structure about the encoding of Reline.
430 lines
13 KiB
Ruby
430 lines
13 KiB
Ruby
require 'io/console'
|
|
require 'timeout'
|
|
require 'forwardable'
|
|
require 'reline/version'
|
|
require 'reline/config'
|
|
require 'reline/key_actor'
|
|
require 'reline/key_stroke'
|
|
require 'reline/line_editor'
|
|
require 'reline/history'
|
|
|
|
module Reline
|
|
FILENAME_COMPLETION_PROC = nil
|
|
USERNAME_COMPLETION_PROC = nil
|
|
|
|
Key = Struct.new('Key', :char, :combined_char, :with_meta)
|
|
CursorPos = Struct.new(:x, :y)
|
|
|
|
class Core
|
|
ATTR_READER_NAMES = %i(
|
|
completion_append_character
|
|
basic_word_break_characters
|
|
completer_word_break_characters
|
|
basic_quote_characters
|
|
completer_quote_characters
|
|
filename_quote_characters
|
|
special_prefixes
|
|
completion_proc
|
|
output_modifier_proc
|
|
prompt_proc
|
|
auto_indent_proc
|
|
pre_input_hook
|
|
dig_perfect_match_proc
|
|
).each(&method(:attr_reader))
|
|
|
|
attr_accessor :config
|
|
attr_accessor :key_stroke
|
|
attr_accessor :line_editor
|
|
attr_accessor :ambiguous_width
|
|
attr_accessor :last_incremental_search
|
|
attr_reader :output
|
|
attr_reader :encoding
|
|
|
|
def initialize(encoding)
|
|
@encoding = encoding
|
|
self.output = STDOUT
|
|
yield self
|
|
@completion_quote_character = nil
|
|
end
|
|
|
|
def completion_append_character=(val)
|
|
if val.nil?
|
|
@completion_append_character = nil
|
|
elsif val.size == 1
|
|
@completion_append_character = val.encode(@encoding)
|
|
elsif val.size > 1
|
|
@completion_append_character = val[0].encode(@encoding)
|
|
else
|
|
@completion_append_character = nil
|
|
end
|
|
end
|
|
|
|
def basic_word_break_characters=(v)
|
|
@basic_word_break_characters = v.encode(@encoding)
|
|
end
|
|
|
|
def completer_word_break_characters=(v)
|
|
@completer_word_break_characters = v.encode(@encoding)
|
|
end
|
|
|
|
def basic_quote_characters=(v)
|
|
@basic_quote_characters = v.encode(@encoding)
|
|
end
|
|
|
|
def completer_quote_characters=(v)
|
|
@completer_quote_characters = v.encode(@encoding)
|
|
end
|
|
|
|
def filename_quote_characters=(v)
|
|
@filename_quote_characters = v.encode(@encoding)
|
|
end
|
|
|
|
def special_prefixes=(v)
|
|
@special_prefixes = v.encode(@encoding)
|
|
end
|
|
|
|
def completion_case_fold=(v)
|
|
@config.completion_ignore_case = v
|
|
end
|
|
|
|
def completion_case_fold
|
|
@config.completion_ignore_case
|
|
end
|
|
|
|
def completion_quote_character
|
|
@completion_quote_character
|
|
end
|
|
|
|
def completion_proc=(p)
|
|
raise ArgumentError unless p.respond_to?(:call)
|
|
@completion_proc = p
|
|
end
|
|
|
|
def output_modifier_proc=(p)
|
|
raise ArgumentError unless p.respond_to?(:call)
|
|
@output_modifier_proc = p
|
|
end
|
|
|
|
def prompt_proc=(p)
|
|
raise ArgumentError unless p.respond_to?(:call)
|
|
@prompt_proc = p
|
|
end
|
|
|
|
def auto_indent_proc=(p)
|
|
raise ArgumentError unless p.respond_to?(:call)
|
|
@auto_indent_proc = p
|
|
end
|
|
|
|
def pre_input_hook=(p)
|
|
@pre_input_hook = p
|
|
end
|
|
|
|
def dig_perfect_match_proc=(p)
|
|
raise ArgumentError unless p.respond_to?(:call)
|
|
@dig_perfect_match_proc = p
|
|
end
|
|
|
|
def input=(val)
|
|
raise TypeError unless val.respond_to?(:getc) or val.nil?
|
|
if val.respond_to?(:getc)
|
|
if defined?(Reline::ANSI) and Reline::IOGate == Reline::ANSI
|
|
Reline::ANSI.input = val
|
|
elsif Reline::IOGate == Reline::GeneralIO
|
|
Reline::GeneralIO.input = val
|
|
end
|
|
end
|
|
end
|
|
|
|
def output=(val)
|
|
raise TypeError unless val.respond_to?(:write) or val.nil?
|
|
@output = val
|
|
if defined?(Reline::ANSI) and Reline::IOGate == Reline::ANSI
|
|
Reline::ANSI.output = val
|
|
end
|
|
end
|
|
|
|
def vi_editing_mode
|
|
config.editing_mode = :vi_insert
|
|
nil
|
|
end
|
|
|
|
def emacs_editing_mode
|
|
config.editing_mode = :emacs
|
|
nil
|
|
end
|
|
|
|
def vi_editing_mode?
|
|
config.editing_mode_is?(:vi_insert, :vi_command)
|
|
end
|
|
|
|
def emacs_editing_mode?
|
|
config.editing_mode_is?(:emacs)
|
|
end
|
|
|
|
def get_screen_size
|
|
Reline::IOGate.get_screen_size
|
|
end
|
|
|
|
def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
|
|
unless confirm_multiline_termination
|
|
raise ArgumentError.new('#readmultiline needs block to confirm multiline termination')
|
|
end
|
|
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.size > 0
|
|
Reline::HISTORY << whole_buffer
|
|
end
|
|
|
|
line_editor.reset_line if line_editor.whole_buffer.nil?
|
|
whole_buffer
|
|
end
|
|
|
|
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.size > 0
|
|
Reline::HISTORY << line.chomp
|
|
end
|
|
|
|
line_editor.reset_line if line_editor.line.nil?
|
|
line
|
|
end
|
|
|
|
private def inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination)
|
|
if ENV['RELINE_STDERR_TTY']
|
|
$stderr.reopen(ENV['RELINE_STDERR_TTY'], 'w')
|
|
$stderr.sync = true
|
|
$stderr.puts "Reline is used by #{Process.pid}"
|
|
end
|
|
otio = Reline::IOGate.prep
|
|
|
|
may_req_ambiguous_char_width
|
|
line_editor.reset(prompt, encoding: @encoding)
|
|
if multiline
|
|
line_editor.multiline_on
|
|
if block_given?
|
|
line_editor.confirm_multiline_termination_proc = confirm_multiline_termination
|
|
end
|
|
else
|
|
line_editor.multiline_off
|
|
end
|
|
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
|
|
line_editor.rerender
|
|
|
|
unless config.test_mode
|
|
config.read
|
|
config.reset_default_key_bindings
|
|
Reline::IOGate::RAW_KEYSTROKE_CONFIG.each_pair do |key, func|
|
|
config.add_default_key_binding(key, func)
|
|
end
|
|
end
|
|
|
|
begin
|
|
loop do
|
|
read_io(config.keyseq_timeout) { |inputs|
|
|
inputs.each { |c|
|
|
line_editor.input_key(c)
|
|
line_editor.rerender
|
|
}
|
|
}
|
|
break if line_editor.finished?
|
|
end
|
|
Reline::IOGate.move_cursor_column(0)
|
|
rescue StandardError => e
|
|
line_editor.finalize
|
|
Reline::IOGate.deprep(otio)
|
|
raise e
|
|
end
|
|
|
|
line_editor.finalize
|
|
Reline::IOGate.deprep(otio)
|
|
end
|
|
|
|
# Keystrokes of GNU Readline will timeout it with the specification of
|
|
# "keyseq-timeout" when waiting for the 2nd character after the 1st one.
|
|
# If the 2nd character comes after 1st ESC without timeout it has a
|
|
# meta-property of meta-key to discriminate modified key with meta-key
|
|
# from multibyte characters that come with 8th bit 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)
|
|
buffer = []
|
|
loop do
|
|
c = Reline::IOGate.getc
|
|
buffer << c
|
|
result = key_stroke.match_status(buffer)
|
|
case result
|
|
when :matched
|
|
expanded = key_stroke.expand(buffer).map{ |expanded_c|
|
|
Reline::Key.new(expanded_c, expanded_c, false)
|
|
}
|
|
block.(expanded)
|
|
break
|
|
when :matching
|
|
if buffer.size == 1
|
|
begin
|
|
succ_c = nil
|
|
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)])
|
|
break
|
|
else
|
|
if key_stroke.match_status(buffer.dup.push(succ_c)) == :unmatched
|
|
if c == "\e".ord
|
|
block.([Reline::Key.new(succ_c, succ_c | 0b10000000, true)])
|
|
else
|
|
block.([Reline::Key.new(c, c, false), Reline::Key.new(succ_c, succ_c, false)])
|
|
end
|
|
break
|
|
else
|
|
Reline::IOGate.ungetc(succ_c)
|
|
end
|
|
end
|
|
end
|
|
when :unmatched
|
|
if buffer.size == 1 and c == "\e".ord
|
|
read_escaped_key(keyseq_timeout, c, block)
|
|
else
|
|
expanded = buffer.map{ |expanded_c|
|
|
Reline::Key.new(expanded_c, expanded_c, false)
|
|
}
|
|
block.(expanded)
|
|
end
|
|
break
|
|
end
|
|
end
|
|
end
|
|
|
|
private def read_escaped_key(keyseq_timeout, c, block)
|
|
begin
|
|
escaped_c = nil
|
|
Timeout.timeout(keyseq_timeout / 1000.0) {
|
|
escaped_c = Reline::IOGate.getc
|
|
}
|
|
rescue Timeout::Error # independent ESC
|
|
block.([Reline::Key.new(c, c, false)])
|
|
else
|
|
if escaped_c.nil?
|
|
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)])
|
|
else
|
|
block.([Reline::Key.new(escaped_c, escaped_c | 0b10000000, true)])
|
|
end
|
|
end
|
|
end
|
|
|
|
private def may_req_ambiguous_char_width
|
|
@ambiguous_width = 2 if Reline::IOGate == Reline::GeneralIO or STDOUT.is_a?(File)
|
|
return if ambiguous_width
|
|
Reline::IOGate.move_cursor_column(0)
|
|
print "\u{25bd}"
|
|
@ambiguous_width = Reline::IOGate.cursor_pos.x
|
|
Reline::IOGate.move_cursor_column(0)
|
|
Reline::IOGate.erase_after_cursor
|
|
end
|
|
end
|
|
|
|
extend Forwardable
|
|
extend SingleForwardable
|
|
|
|
#--------------------------------------------------------
|
|
# Documented API
|
|
#--------------------------------------------------------
|
|
|
|
(Core::ATTR_READER_NAMES).each { |name|
|
|
def_single_delegators :core, "#{name}", "#{name}="
|
|
}
|
|
def_single_delegators :core, :input=, :output=
|
|
def_single_delegators :core, :vi_editing_mode, :emacs_editing_mode
|
|
def_single_delegators :core, :readline
|
|
def_single_delegators :core, :completion_case_fold, :completion_case_fold=
|
|
def_single_delegators :core, :completion_quote_character
|
|
def_instance_delegators self, :readline
|
|
private :readline
|
|
|
|
|
|
#--------------------------------------------------------
|
|
# Undocumented API
|
|
#--------------------------------------------------------
|
|
|
|
# Testable in original
|
|
def_single_delegators :core, :get_screen_size
|
|
def_single_delegators :line_editor, :eof?
|
|
def_instance_delegators self, :eof?
|
|
def_single_delegators :line_editor, :delete_text
|
|
def_single_delegator :line_editor, :line, :line_buffer
|
|
def_single_delegator :line_editor, :byte_pointer, :point
|
|
def_single_delegator :line_editor, :byte_pointer=, :point=
|
|
|
|
def self.insert_text(*args, &block)
|
|
line_editor.insert_text(*args, &block)
|
|
self
|
|
end
|
|
|
|
# Untestable in original
|
|
def_single_delegator :line_editor, :rerender, :redisplay
|
|
def_single_delegators :core, :vi_editing_mode?, :emacs_editing_mode?
|
|
def_single_delegators :core, :ambiguous_width
|
|
def_single_delegators :core, :last_incremental_search
|
|
def_single_delegators :core, :last_incremental_search=
|
|
|
|
def_single_delegators :core, :readmultiline
|
|
def_instance_delegators self, :readmultiline
|
|
private :readmultiline
|
|
|
|
def self.encoding_system_needs
|
|
self.core.encoding
|
|
end
|
|
|
|
def self.core
|
|
@core ||= Core.new(Reline::IOGate.encoding) { |core|
|
|
core.config = Reline::Config.new
|
|
core.key_stroke = Reline::KeyStroke.new(core.config)
|
|
core.line_editor = Reline::LineEditor.new(core.config, Reline::IOGate.encoding)
|
|
|
|
core.basic_word_break_characters = " \t\n`><=;|&{("
|
|
core.completer_word_break_characters = " \t\n`><=;|&{("
|
|
core.basic_quote_characters = '"\''
|
|
core.completer_quote_characters = '"\''
|
|
core.filename_quote_characters = ""
|
|
core.special_prefixes = ""
|
|
}
|
|
end
|
|
|
|
def self.line_editor
|
|
core.line_editor
|
|
end
|
|
end
|
|
|
|
if RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
|
|
require 'reline/windows'
|
|
if Reline::Windows.get_screen_size == [0, 0]
|
|
# Maybe Mintty on Cygwin
|
|
require 'reline/ansi'
|
|
Reline::IOGate = Reline::ANSI
|
|
else
|
|
Reline::IOGate = Reline::Windows
|
|
end
|
|
else
|
|
require 'reline/ansi'
|
|
Reline::IOGate = Reline::ANSI
|
|
end
|
|
Reline::HISTORY = Reline::History.new(Reline.core.config)
|
|
require 'reline/general_io'
|