Class: Reline::Core
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Forwardable
|
|
Inherits: | Object |
Defined in: | lib/reline.rb |
Constant Summary
-
ATTR_READER_NAMES =
# File 'lib/reline.rb', line 49%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))
Class Method Summary
- .new {|_self| ... } ⇒ Core constructor
Instance Attribute Summary
- #auto_indent_proc=(p) writeonly
- #basic_quote_characters=(v) writeonly
- #basic_word_break_characters=(v) writeonly
- #completer_quote_characters=(v) writeonly
- #completer_word_break_characters=(v) writeonly
- #completion_append_character=(val) writeonly
- #completion_case_fold rw
- #completion_case_fold=(v) rw
- #completion_proc=(p) writeonly
- #config rw
- #dig_perfect_match_proc=(p) writeonly
- #emacs_editing_mode readonly
- #emacs_editing_mode? ⇒ Boolean readonly
- #filename_quote_characters=(v) writeonly
- #input=(val) writeonly
- #key_stroke rw
- #last_incremental_search rw
- #line_editor rw
- #output rw
- #output=(val) rw
- #output_modifier_proc=(p) writeonly
- #pre_input_hook=(p) writeonly
- #prompt_proc=(p) writeonly
- #special_prefixes=(v) writeonly
- #vi_editing_mode readonly
- #vi_editing_mode? ⇒ Boolean readonly
Instance Method Summary
- #add_dialog_proc(name_sym, p, context = nil)
- #ambiguous_width
- #completion_quote_character
- #dialog_proc(name_sym)
- #encoding
- #get_screen_size
- #io_gate
- #readline(prompt = '', add_hist = false)
- #readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
- #inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination) private
- #may_req_ambiguous_char_width private
- #read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block) private
- #read_escaped_key(keyseq_timeout, c, block) private
-
#read_io(keyseq_timeout, &block)
private
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.
Constructor Details
.new {|_self| ... } ⇒ Core
# File 'lib/reline.rb', line 76
def initialize self.output = STDOUT @mutex = Mutex.new @dialog_proc_list = {} yield self @completion_quote_character = nil end
Instance Attribute Details
#auto_indent_proc=(p) (writeonly)
# File 'lib/reline.rb', line 155
def auto_indent_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @auto_indent_proc = p end
#basic_quote_characters=(v) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 112
def basic_quote_characters=(v) @basic_quote_characters = v.encode(encoding) end
#basic_word_break_characters=(v) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 104
def basic_word_break_characters=(v) @basic_word_break_characters = v.encode(encoding) end
#completer_quote_characters=(v) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 116
def completer_quote_characters=(v) @completer_quote_characters = v.encode(encoding) end
#completer_word_break_characters=(v) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 108
def completer_word_break_characters=(v) @completer_word_break_characters = v.encode(encoding) end
#completion_append_character=(val) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 92
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
#completion_case_fold (rw)
[ GitHub ]# File 'lib/reline.rb', line 132
def completion_case_fold @config.completion_ignore_case end
#completion_case_fold=(v) (rw)
[ GitHub ]# File 'lib/reline.rb', line 128
def completion_case_fold=(v) @config.completion_ignore_case = v end
#completion_proc=(p) (writeonly)
# File 'lib/reline.rb', line 140
def completion_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @completion_proc = p end
#config (rw)
[ GitHub ]# File 'lib/reline.rb', line 65
attr_accessor :config
#dig_perfect_match_proc=(p) (writeonly)
# File 'lib/reline.rb', line 164
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 (readonly)
[ GitHub ]# File 'lib/reline.rb', line 204
def emacs_editing_mode config.editing_mode = :emacs nil end
#emacs_editing_mode? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/reline.rb', line 213
def emacs_editing_mode? config.editing_mode_is?(:emacs) end
#filename_quote_characters=(v) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 120
def filename_quote_characters=(v) @filename_quote_characters = v.encode(encoding) end
#input=(val) (writeonly)
#key_stroke (rw)
[ GitHub ]# File 'lib/reline.rb', line 66
attr_accessor :key_stroke
#last_incremental_search (rw)
[ GitHub ]# File 'lib/reline.rb', line 68
attr_accessor :last_incremental_search
#line_editor (rw)
[ GitHub ]# File 'lib/reline.rb', line 67
attr_accessor :line_editor
#output (rw)
[ GitHub ]# File 'lib/reline.rb', line 69
attr_reader :output
#output=(val) (rw)
#output_modifier_proc=(p) (writeonly)
# File 'lib/reline.rb', line 145
def output_modifier_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @output_modifier_proc = p end
#pre_input_hook=(p) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 160
def pre_input_hook=(p) @pre_input_hook = p end
#prompt_proc=(p) (writeonly)
# File 'lib/reline.rb', line 150
def prompt_proc=(p) raise ArgumentError unless p.respond_to?(:call) or p.nil? @prompt_proc = p end
#special_prefixes=(v) (writeonly)
[ GitHub ]# File 'lib/reline.rb', line 124
def special_prefixes=(v) @special_prefixes = v.encode(encoding) end
#vi_editing_mode (readonly)
[ GitHub ]# File 'lib/reline.rb', line 199
def vi_editing_mode config.editing_mode = :vi_insert nil end
#vi_editing_mode? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'lib/reline.rb', line 209
def vi_editing_mode? config.editing_mode_is?(:vi_insert, :vi_command) end
Instance Method Details
#add_dialog_proc(name_sym, p, context = nil)
# File 'lib/reline.rb', line 170
def add_dialog_proc(name_sym, p, context = nil) raise ArgumentError unless name_sym.instance_of?(Symbol) if p.nil? @dialog_proc_list.delete(name_sym) else raise ArgumentError unless p.respond_to?(:call) @dialog_proc_list[name_sym] = DialogProc.new(p, context) end end
#ambiguous_width
[ GitHub ]# File 'lib/reline.rb', line 461
def ambiguous_width may_req_ambiguous_char_width unless defined? @ambiguous_width @ambiguous_width end
#completion_quote_character
[ GitHub ]# File 'lib/reline.rb', line 136
def completion_quote_character @completion_quote_character end
#dialog_proc(name_sym)
[ GitHub ]# File 'lib/reline.rb', line 180
def dialog_proc(name_sym) @dialog_proc_list[name_sym] end
#encoding
[ GitHub ]# File 'lib/reline.rb', line 88
def encoding io_gate.encoding end
#get_screen_size
[ GitHub ]# File 'lib/reline.rb', line 217
def get_screen_size io_gate.get_screen_size end
#inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination) (private)
[ GitHub ]# File 'lib/reline.rb', line 302
private def inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination) if ENV['RELINE_STDERR_TTY'] if io_gate.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 = io_gate.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 pre_input_hook&.call unless Reline::IOGate == Reline::GeneralIO @dialog_proc_list.each_pair do |name_sym, d| line_editor.add_dialog_proc(name_sym, d.dialog_proc, d.context) end end unless config.test_mode config.read config.reset_default_key_bindings io_gate.set_default_key_bindings(config) end line_editor.print_nomultiline_prompt(prompt) line_editor.update_dialogs line_editor.rerender begin line_editor.set_signal_handlers loop do read_io(config.keyseq_timeout) { |inputs| line_editor.set_pasting_state(io_gate.in_pasting?) inputs.each { |key| line_editor.update(key) } } if line_editor.finished? line_editor.render_finished break else line_editor.set_pasting_state(io_gate.in_pasting?) line_editor.rerender end end io_gate.move_cursor_column(0) rescue Errno::EIO # Maybe the I/O has been closed. ensure line_editor.finalize io_gate.deprep(otio) end end
#io_gate
[ GitHub ]#may_req_ambiguous_char_width (private)
[ GitHub ]# File 'lib/reline.rb', line 466
private def may_req_ambiguous_char_width @ambiguous_width = 2 if io_gate == Reline::GeneralIO or !STDOUT.tty? return if defined? @ambiguous_width io_gate.move_cursor_column(0) begin output.write "\u{25bd}" rescue Encoding::UndefinedConversionError # LANG=C @ambiguous_width = 1 else @ambiguous_width = io_gate.cursor_pos.x end io_gate.move_cursor_column(0) io_gate.erase_after_cursor end
#read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block) (private)
[ GitHub ]# File 'lib/reline.rb', line 419
private def read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block) succ_c = io_gate.getc(keyseq_timeout.fdiv(1000)) if succ_c 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 io_gate.ungetc(succ_c) return :next when :matched buffer << succ_c = key_stroke. (buffer).map{ || Reline::Key.new(, , false) } block.( ) return :break end else block.([Reline::Key.new(c, c, false)]) return :break end end
#read_escaped_key(keyseq_timeout, c, block) (private)
[ GitHub ]# File 'lib/reline.rb', line 447
private def read_escaped_key(keyseq_timeout, c, block) escaped_c = io_gate.getc(keyseq_timeout.fdiv(1000)) 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
#read_io(keyseq_timeout, &block) (private)
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.
# File 'lib/reline.rb', line 381
private def read_io(keyseq_timeout, &block) buffer = [] loop do c = io_gate.getc(Float::INFINITY) if c == -1 result = :unmatched else buffer << c result = key_stroke.match_status(buffer) end case result when :matched = key_stroke. (buffer).map{ || Reline::Key.new(, , false) } block.( ) 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 = buffer.map{ || Reline::Key.new(, , false) } block.( ) end break end end end
#readline(prompt = '', add_hist = false)
[ GitHub ]# File 'lib/reline.rb', line 284
def readline(prompt = '', add_hist = false) @mutex.synchronize do Reline.update_iogate io_gate.with_raw_input do inner_readline(prompt, add_hist, false) end 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 end
#readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
[ GitHub ]# File 'lib/reline.rb', line 257
def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination) @mutex.synchronize do unless confirm_multiline_termination raise ArgumentError.new('#readmultiline needs block to confirm multiline termination') end Reline.update_iogate io_gate.with_raw_input do inner_readline(prompt, add_hist, true, &confirm_multiline_termination) end 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 if line_editor.eof? line_editor.reset_line # Return nil if the input is aborted by C-d. nil else whole_buffer end end end