JezK
Edit File: reline.rb
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' require 'reline/terminfo' require 'rbconfig' module Reline FILENAME_COMPLETION_PROC = nil USERNAME_COMPLETION_PROC = nil class ConfigEncodingConversionError < StandardError; end Key = Struct.new('Key', :char, :combined_char, :with_meta) do def match?(other) case other when Reline::Key (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) when Integer, Symbol (combined_char and combined_char == other) or (combined_char.nil? and char and char == other) else false end end alias_method :==, :match? end CursorPos = Struct.new(:x, :y) DialogRenderInfo = Struct.new(:pos, :contents, :bg_color, :width, :height, :scrollbar, keyword_init: true) 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 :last_incremental_search attr_reader :output def initialize self.output = STDOUT @dialog_proc_list = {} yield self @completion_quote_character = nil @bracketed_paste_finished = false end def encoding Reline::IOGate.encoding end def completion_append_character=(val) if val.nil? @completion_append_character = nil elsif val.size == 1 @completion_append_character = val.encode(Reline::IOGate.encoding) elsif val.size > 1 @completion_append_character = val[0].encode(Reline::IOGate.encoding) else @completion_append_character = nil end end def basic_word_break_characters=(v) @basic_word_break_characters = v.encode(Reline::IOGate.encoding) end def completer_word_break_characters=(v) @completer_word_break_characters = v.encode(Reline::IOGate.encoding) end def basic_quote_characters=(v) @basic_quote_characters = v.encode(Reline::IOGate.encoding) end def completer_quote_characters=(v) @completer_quote_characters = v.encode(Reline::IOGate.encoding) end def filename_quote_characters=(v) @filename_quote_characters = v.encode(Reline::IOGate.encoding) end def special_prefixes=(v) @special_prefixes = v.encode(Reline::IOGate.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) or p.nil? @completion_proc = p end def autocompletion @config.autocompletion end def autocompletion=(val) @config.autocompletion = val end def output_modifier_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @output_modifier_proc = p end def prompt_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @prompt_proc = p end def auto_indent_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @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) or p.nil? @dig_perfect_match_proc = p end 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) end def dialog_proc(name_sym) @dialog_proc_list[name_sym] 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 Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE = ->() { # autocomplete return nil unless config.autocompletion if just_cursor_moving and completion_journey_data.nil? # Auto complete starts only when edited return nil end pre, target, post = retrieve_completion_block(true) if target.nil? or target.empty? or (completion_journey_data&.pointer == -1 and target.size <= 3) return nil end if completion_journey_data and completion_journey_data.list result = completion_journey_data.list.dup result.shift pointer = completion_journey_data.pointer - 1 else result = call_completion_proc_with_checking_args(pre, target, post) pointer = nil end if result and result.size == 1 and result[0] == target and pointer != 0 result = nil end target_width = Reline::Unicode.calculate_width(target) x = cursor_pos.x - target_width if x < 0 x = screen_width + x y = -1 else y = 0 end cursor_pos_to_render = Reline::CursorPos.new(x, y) if context and context.is_a?(Array) context.clear context.push(cursor_pos_to_render, result, pointer, dialog) end dialog.pointer = pointer DialogRenderInfo.new(pos: cursor_pos_to_render, contents: result, scrollbar: true, height: 15) } 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') 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("\n").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("\n").size > 0 Reline::HISTORY << line.chomp("\n") 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'] if Reline::IOGate.win? $stderr = File.open(ENV['RELINE_STDERR_TTY'], 'a') else $stderr.reopen(ENV['RELINE_STDERR_TTY'], 'w') end $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: Reline::IOGate.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 @dialog_proc_list.each_pair do |name_sym, d| line_editor.add_dialog_proc(name_sym, d.dialog_proc, d.context) end unless config.test_mode config.read config.reset_default_key_bindings Reline::IOGate.set_default_key_bindings(config) end line_editor.rerender begin line_editor.set_signal_handlers prev_pasting_state = false loop do prev_pasting_state = Reline::IOGate.in_pasting? read_io(config.keyseq_timeout) { |inputs| line_editor.set_pasting_state(Reline::IOGate.in_pasting?) inputs.each { |c| line_editor.input_key(c) line_editor.rerender } if @bracketed_paste_finished line_editor.rerender_all @bracketed_paste_finished = false end } 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 line_editor.rerender_all end break if line_editor.finished? end Reline::IOGate.move_cursor_column(0) rescue Errno::EIO # Maybe the I/O has been closed. rescue StandardError => e line_editor.finalize Reline::IOGate.deprep(otio) raise e rescue Exception # Including Interrupt line_editor.finalize Reline::IOGate.deprep(otio) raise end line_editor.finalize Reline::IOGate.deprep(otio) end # 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) buffer = [] loop do c = Reline::IOGate.getc if c == -1 result = :unmatched @bracketed_paste_finished = true else buffer << c result = key_stroke.match_status(buffer) end 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 case read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block) when :break then break when :next then next 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_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block) 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)]) return :break else case key_stroke.match_status(buffer.dup.push(succ_c)) when :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 return :break when :matching Reline::IOGate.ungetc(succ_c) return :next when :matched buffer << succ_c expanded = key_stroke.expand(buffer).map{ |expanded_c| Reline::Key.new(expanded_c, expanded_c, false) } block.(expanded) return :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 def ambiguous_width may_req_ambiguous_char_width unless defined? @ambiguous_width @ambiguous_width end private def may_req_ambiguous_char_width @ambiguous_width = 2 if Reline::IOGate == Reline::GeneralIO or STDOUT.is_a?(File) return if defined? @ambiguous_width Reline::IOGate.move_cursor_column(0) begin output.write "\u{25bd}" rescue Encoding::UndefinedConversionError # LANG=C @ambiguous_width = 1 else @ambiguous_width = Reline::IOGate.cursor_pos.x end 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, :add_dialog_proc def_single_delegators :core, :dialog_proc def_single_delegators :core, :autocompletion, :autocompletion= 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 { |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 = "" core.add_dialog_proc(:autocomplete, Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE, Reline::DEFAULT_DIALOG_CONTEXT) } end def self.ungetc(c) Reline::IOGate.ungetc(c) end def self.line_editor core.line_editor end end require 'reline/general_io' if RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/ require 'reline/windows' if Reline::Windows.msys_tty? Reline::IOGate = if ENV['TERM'] == 'dumb' Reline::GeneralIO else require 'reline/ansi' Reline::ANSI end else Reline::IOGate = Reline::Windows end else Reline::IOGate = if $stdout.isatty require 'reline/ansi' Reline::ANSI else Reline::GeneralIO end end Reline::HISTORY = Reline::History.new(Reline.core.config)