class Reline::Core

Constants

ATTR_READER_NAMES
DialogProc

Attributes

config[RW]
key_stroke[RW]
line_editor[RW]
output[R]

Public Class Methods

new() { |self| ... } click to toggle source
# File reline.rb, line 77
def initialize
  self.output = STDOUT
  @dialog_proc_list = {}
  yield self
  @completion_quote_character = nil
  @bracketed_paste_finished = false
end

Public Instance Methods

add_dialog_proc(name_sym, p, context = nil) click to toggle source
# File reline.rb, line 171
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() click to toggle source
# File reline.rb, line 477
def ambiguous_width
  may_req_ambiguous_char_width unless defined? @ambiguous_width
  @ambiguous_width
end
auto_indent_proc=(p) click to toggle source
# File reline.rb, line 156
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 reline.rb, line 113
def basic_quote_characters=(v)
  @basic_quote_characters = v.encode(encoding)
end
basic_word_break_characters=(v) click to toggle source
# File reline.rb, line 105
def basic_word_break_characters=(v)
  @basic_word_break_characters = v.encode(encoding)
end
completer_quote_characters=(v) click to toggle source
# File reline.rb, line 117
def completer_quote_characters=(v)
  @completer_quote_characters = v.encode(encoding)
end
completer_word_break_characters=(v) click to toggle source
# File reline.rb, line 109
def completer_word_break_characters=(v)
  @completer_word_break_characters = v.encode(encoding)
end
completion_append_character=(val) click to toggle source
# File reline.rb, line 93
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() click to toggle source
# File reline.rb, line 133
def completion_case_fold
  @config.completion_ignore_case
end
completion_case_fold=(v) click to toggle source
# File reline.rb, line 129
def completion_case_fold=(v)
  @config.completion_ignore_case = v
end
completion_proc=(p) click to toggle source
# File reline.rb, line 141
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 reline.rb, line 137
def completion_quote_character
  @completion_quote_character
end
dialog_proc(name_sym) click to toggle source
# File reline.rb, line 181
def dialog_proc(name_sym)
  @dialog_proc_list[name_sym]
end
dig_perfect_match_proc=(p) click to toggle source
# File reline.rb, line 165
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 reline.rb, line 205
def emacs_editing_mode
  config.editing_mode = :emacs
  nil
end
emacs_editing_mode?() click to toggle source
# File reline.rb, line 214
def emacs_editing_mode?
  config.editing_mode_is?(:emacs)
end
encoding() click to toggle source
# File reline.rb, line 89
def encoding
  io_gate.encoding
end
filename_quote_characters=(v) click to toggle source
# File reline.rb, line 121
def filename_quote_characters=(v)
  @filename_quote_characters = v.encode(encoding)
end
get_screen_size() click to toggle source
# File reline.rb, line 218
def get_screen_size
  io_gate.get_screen_size
end
input=(val) click to toggle source
# File reline.rb, line 185
def input=(val)
  raise TypeError unless val.respond_to?(:getc) or val.nil?
  if val.respond_to?(:getc) && io_gate.respond_to?(:input=)
    io_gate.input = val
  end
end
io_gate() click to toggle source
# File reline.rb, line 85
def io_gate
  Reline::IOGate
end
output=(val) click to toggle source
# File reline.rb, line 192
def output=(val)
  raise TypeError unless val.respond_to?(:write) or val.nil?
  @output = val
  if io_gate.respond_to?(:output=)
    io_gate.output = val
  end
end
output_modifier_proc=(p) click to toggle source
# File reline.rb, line 146
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 reline.rb, line 161
def pre_input_hook=(p)
  @pre_input_hook = p
end
prompt_proc=(p) click to toggle source
# File reline.rb, line 151
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 reline.rb, line 290
def readline(prompt = '', add_hist = false)
  Reline.update_iogate
  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 reline.rb, line 271
def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
  Reline.update_iogate
  io_gate.with_raw_input do
    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
end
special_prefixes=(v) click to toggle source
# File reline.rb, line 125
def special_prefixes=(v)
  @special_prefixes = v.encode(encoding)
end
vi_editing_mode() click to toggle source
# File reline.rb, line 200
def vi_editing_mode
  config.editing_mode = :vi_insert
  nil
end
vi_editing_mode?() click to toggle source
# File reline.rb, line 210
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 reline.rb, line 304
        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
  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
    io_gate.set_default_key_bindings(config)
  end

  line_editor.rerender

  begin
    line_editor.set_signal_handlers
    prev_pasting_state = false
    loop do
      prev_pasting_state = io_gate.in_pasting?
      read_io(config.keyseq_timeout) { |inputs|
        line_editor.set_pasting_state(io_gate.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 io_gate.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
    io_gate.move_cursor_column(0)
  rescue Errno::EIO
    # Maybe the I/O has been closed.
  rescue StandardError => e
    line_editor.finalize
    io_gate.deprep(otio)
    raise e
  rescue Exception
    # Including Interrupt
    line_editor.finalize
    io_gate.deprep(otio)
    raise
  end

  line_editor.finalize
  io_gate.deprep(otio)
end
may_req_ambiguous_char_width() click to toggle source
# File reline.rb, line 482
        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) click to toggle source
# File reline.rb, line 435
        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
      expanded = key_stroke.expand(buffer).map{ |expanded_c|
        Reline::Key.new(expanded_c, expanded_c, false)
      }
      block.(expanded)
      return :break
    end
  else
    block.([Reline::Key.new(c, c, false)])
    return :break
  end
end
read_escaped_key(keyseq_timeout, c, block) click to toggle source
# File reline.rb, line 463
        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) click to toggle source

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 reline.rb, line 396
        def read_io(keyseq_timeout, &block)
  buffer = []
  loop do
    c = io_gate.getc(Float::INFINITY)
    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