Class: Reline::Core

Relationships & Source Files
Namespace Children
Classes: `DialogProc`
Inherits:	Object
Defined in:	lib/reline.rb

Constant Summary

ATTR_READER_NAMES =
# File 'lib/reline.rb', line 39

%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
#autocompletion rw
#autocompletion=(val) rw
#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
#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`

Yields:

(_self)

Yield Parameters:

_self (Core) —

the object that the method was called on

[ GitHub ]

# File 'lib/reline.rb', line 61


def initialize
  self.output = STDOUT
  @dialog_proc_list = {}
  yield self
  @completion_quote_character = nil
  @bracketed_paste_finished = false
end

Instance Attribute Details

#auto_indent_proc=(p) (writeonly)

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/reline.rb', line 144


def auto_indent_proc=(p)
  raise ArgumentError unless p.respond_to?(:call) or p.nil?
  @auto_indent_proc = p
end

#autocompletion (rw)

[ GitHub ]

# File 'lib/reline.rb', line 126


def autocompletion
  @config.autocompletion
end

#autocompletion=(val) (rw)

[ GitHub ]

# File 'lib/reline.rb', line 130


def autocompletion=(val)
  @config.autocompletion = val
end

#basic_quote_characters=(v) (writeonly)

[ GitHub ]

# File 'lib/reline.rb', line 93


def basic_quote_characters=(v)
  @basic_quote_characters = v.encode(Reline::IOGate.encoding)
end

#basic_word_break_characters=(v) (writeonly)

[ GitHub ]

# File 'lib/reline.rb', line 85


def basic_word_break_characters=(v)
  @basic_word_break_characters = v.encode(Reline::IOGate.encoding)
end

#completer_quote_characters=(v) (writeonly)

[ GitHub ]

# File 'lib/reline.rb', line 97


def completer_quote_characters=(v)
  @completer_quote_characters = v.encode(Reline::IOGate.encoding)
end

#completer_word_break_characters=(v) (writeonly)

[ GitHub ]

# File 'lib/reline.rb', line 89


def completer_word_break_characters=(v)
  @completer_word_break_characters = v.encode(Reline::IOGate.encoding)
end

#completion_append_character=(val) (writeonly)

[ GitHub ]

# File 'lib/reline.rb', line 73


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 (rw)

[ GitHub ]

# File 'lib/reline.rb', line 113


def completion_case_fold
  @config.completion_ignore_case
end

#completion_case_fold=(v) (rw)

[ GitHub ]

# File 'lib/reline.rb', line 109


def completion_case_fold=(v)
  @config.completion_ignore_case = v
end

#completion_proc=(p) (writeonly)

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/reline.rb', line 121


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 55


attr_accessor :config

#dig_perfect_match_proc=(p) (writeonly)

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/reline.rb', line 153


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 193


def emacs_editing_mode
  config.editing_mode = :emacs
  nil
end

#emacs_editing_mode? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/reline.rb', line 202


def emacs_editing_mode?
  config.editing_mode_is?(:emacs)
end

#filename_quote_characters=(v) (writeonly)

[ GitHub ]

# File 'lib/reline.rb', line 101


def filename_quote_characters=(v)
  @filename_quote_characters = v.encode(Reline::IOGate.encoding)
end

#input=(val) (writeonly)

Raises:

(TypeError)

[ GitHub ]

# File 'lib/reline.rb', line 169


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

#key_stroke (rw)

[ GitHub ]

# File 'lib/reline.rb', line 56


attr_accessor :key_stroke

#last_incremental_search (rw)

[ GitHub ]

# File 'lib/reline.rb', line 58


attr_accessor :last_incremental_search

#line_editor (rw)

[ GitHub ]

# File 'lib/reline.rb', line 57


attr_accessor :line_editor

#output (rw)

[ GitHub ]

# File 'lib/reline.rb', line 59


attr_reader :output

#output=(val) (rw)

Raises:

(TypeError)

[ GitHub ]

# File 'lib/reline.rb', line 180


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) (writeonly)

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/reline.rb', line 134


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 149


def pre_input_hook=(p)
  @pre_input_hook = p
end

#prompt_proc=(p) (writeonly)

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/reline.rb', line 139


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 105


def special_prefixes=(v)
  @special_prefixes = v.encode(Reline::IOGate.encoding)
end

#vi_editing_mode (readonly)

[ GitHub ]

# File 'lib/reline.rb', line 188


def vi_editing_mode
  config.editing_mode = :vi_insert
  nil
end

#vi_editing_mode? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/reline.rb', line 198


def vi_editing_mode?
  config.editing_mode_is?(:vi_insert, :vi_command)
end

Instance Method Details

#add_dialog_proc(name_sym, p, context = nil)

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/reline.rb', line 159


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

#ambiguous_width

[ GitHub ]

# File 'lib/reline.rb', line 463


def ambiguous_width
  may_req_ambiguous_char_width unless defined? @ambiguous_width
  @ambiguous_width
end

#completion_quote_character

[ GitHub ]

# File 'lib/reline.rb', line 117


def completion_quote_character
  @completion_quote_character
end

#dialog_proc(name_sym)

[ GitHub ]

# File 'lib/reline.rb', line 165


def dialog_proc(name_sym)
  @dialog_proc_list[name_sym]
end

#encoding

[ GitHub ]

# File 'lib/reline.rb', line 69


def encoding
  Reline::IOGate.encoding
end

#get_screen_size

[ GitHub ]

# File 'lib/reline.rb', line 206


def get_screen_size
  Reline::IOGate.get_screen_size
end

#inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination) (private)

[ GitHub ]

# File 'lib/reline.rb', line 279


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

#may_req_ambiguous_char_width (private)

[ GitHub ]

# File 'lib/reline.rb', line 468


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

#read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block) (private)

[ GitHub ]

# File 'lib/reline.rb', line 410


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

#read_escaped_key(keyseq_timeout, c, block) (private)

[ GitHub ]

# File 'lib/reline.rb', line 442


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

#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.

[ GitHub ]

# File 'lib/reline.rb', line 371


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

#readline(prompt = '', add_hist = false)

[ GitHub ]

# File 'lib/reline.rb', line 266


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)

[ GitHub ]

# File 'lib/reline.rb', line 250


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

Class: Reline::Core

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new {|_self| ... } ⇒ Core

Instance Attribute Details

#auto_indent_proc=(p) (writeonly)

#autocompletion (rw)

#autocompletion=(val) (rw)

#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 Details

#add_dialog_proc(name_sym, p, context = nil)

#ambiguous_width

#completion_quote_character

#dialog_proc(name_sym)

#encoding

#get_screen_size

#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)

#readline(prompt = '', add_hist = false)

#readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)

.new {|_self| ... } ⇒ `Core`

#emacs_editing_mode? ⇒ `Boolean` (readonly)

#vi_editing_mode? ⇒ `Boolean` (readonly)