class Reline::Core
Constants
- ATTR_READER_NAMES
Attributes
ambiguous_width[RW]
config[RW]
key_stroke[RW]
last_incremental_search[RW]
line_editor[RW]
output[R]
Public Class Methods
new() { |self| ... }
click to toggle source
# File lib/reline.rb, line 43 def initialize self.output = STDOUT yield self @completion_quote_character = nil end
Public Instance Methods
auto_indent_proc=(p)
click to toggle source
# File lib/reline.rb, line 116 def auto_indent_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @auto_indent_proc = p end
basic_quote_characters=(v)
click to toggle source
# File lib/reline.rb, line 73 def basic_quote_characters=(v) @basic_quote_characters = v.encode(Reline::IOGate.encoding) end
basic_word_break_characters=(v)
click to toggle source
# File lib/reline.rb, line 65 def basic_word_break_characters=(v) @basic_word_break_characters = v.encode(Reline::IOGate.encoding) end
completer_quote_characters=(v)
click to toggle source
# File lib/reline.rb, line 77 def completer_quote_characters=(v) @completer_quote_characters = v.encode(Reline::IOGate.encoding) end
completer_word_break_characters=(v)
click to toggle source
# File lib/reline.rb, line 69 def completer_word_break_characters=(v) @completer_word_break_characters = v.encode(Reline::IOGate.encoding) end
completion_append_character=(val)
click to toggle source
# File lib/reline.rb, line 53 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
completion_case_fold()
click to toggle source
# File lib/reline.rb, line 93 def completion_case_fold @config.completion_ignore_case end
completion_case_fold=(v)
click to toggle source
# File lib/reline.rb, line 89 def completion_case_fold=(v) @config.completion_ignore_case = v end
completion_proc=(p)
click to toggle source
# File lib/reline.rb, line 101 def completion_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @completion_proc = p end
completion_quote_character()
click to toggle source
# File lib/reline.rb, line 97 def completion_quote_character @completion_quote_character end
dig_perfect_match_proc=(p)
click to toggle source
# File lib/reline.rb, line 125 def dig_perfect_match_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @dig_perfect_match_proc = p end
emacs_editing_mode()
click to toggle source
# File lib/reline.rb, line 154 def emacs_editing_mode config.editing_mode = :emacs nil end
emacs_editing_mode?()
click to toggle source
# File lib/reline.rb, line 163 def emacs_editing_mode? config.editing_mode_is?(:emacs) end
encoding()
click to toggle source
# File lib/reline.rb, line 49 def encoding Reline::IOGate.encoding end
filename_quote_characters=(v)
click to toggle source
# File lib/reline.rb, line 81 def filename_quote_characters=(v) @filename_quote_characters = v.encode(Reline::IOGate.encoding) end
get_screen_size()
click to toggle source
# File lib/reline.rb, line 167 def get_screen_size Reline::IOGate.get_screen_size end
input=(val)
click to toggle source
# File lib/reline.rb, line 130 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
output=(val)
click to toggle source
# File lib/reline.rb, line 141 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
output_modifier_proc=(p)
click to toggle source
# File lib/reline.rb, line 106 def output_modifier_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @output_modifier_proc = p end
pre_input_hook=(p)
click to toggle source
# File lib/reline.rb, line 121 def pre_input_hook=(p) @pre_input_hook = p end
prompt_proc=(p)
click to toggle source
# File lib/reline.rb, line 111 def prompt_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @prompt_proc = p end
readline(prompt = '', add_hist = false)
click to toggle source
# File lib/reline.rb, line 187 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
readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
click to toggle source
# File lib/reline.rb, line 171 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
special_prefixes=(v)
click to toggle source
# File lib/reline.rb, line 85 def special_prefixes=(v) @special_prefixes = v.encode(Reline::IOGate.encoding) end
vi_editing_mode()
click to toggle source
# File lib/reline.rb, line 149 def vi_editing_mode config.editing_mode = :vi_insert nil end
vi_editing_mode?()
click to toggle source
# File lib/reline.rb, line 159 def vi_editing_mode? config.editing_mode_is?(:vi_insert, :vi_command) end
Private Instance Methods
inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination)
click to toggle source
# File lib/reline.rb, line 200 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: 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 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 line_editor.rerender 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 Errno::EIO # Maybe the I/O has been closed. rescue StandardError => e line_editor.finalize Reline::IOGate.deprep(otio) raise e end line_editor.finalize Reline::IOGate.deprep(otio) end
may_req_ambiguous_char_width()
click to toggle source
# File lib/reline.rb, line 339 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) 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
read_escaped_key(keyseq_timeout, c, block)
click to toggle source
# File lib/reline.rb, line 318 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
read_io(keyseq_timeout, &block)
click to toggle source
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.
# File lib/reline.rb, line 268 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