class Reline::KeyStroke

Constants

CSI_INTERMEDIATE_BYTES_RANGE
CSI_PARAMETER_BYTES_RANGE
ESC_BYTE
MATCHED: Input partially matches to a key sequence
MATCHING: Input exactly matches to a key sequence
MATCHING_MATCHED: Input matches to a key sequence and the key sequence is a prefix of another key sequence
UNMATCHED: Input does not match to any key sequence

Attributes

encoding[RW]

Public Class Methods

new(config, encoding) click to toggle source

# File reline/key_stroke.rb, line 8
def initialize(config, encoding)
  @config = config
  @encoding = encoding
end

Public Instance Methods

expand(input) click to toggle source

# File reline/key_stroke.rb, line 44
def expand(input)
  matched_bytes = nil
  (1..input.size).each do |i|
    bytes = input.take(i)
    status = match_status(bytes)
    matched_bytes = bytes if status == MATCHED || status == MATCHING_MATCHED
    break if status == MATCHED || status == UNMATCHED
  end
  return [[], []] unless matched_bytes

  func = key_mapping.get(matched_bytes)
  s = matched_bytes.pack('c*').force_encoding(@encoding)
  if func.is_a?(Array)
    # Perform simple macro expansion for single byte key bindings.
    # Multibyte key bindings and recursive macro expansion are not supported yet.
    marco = func.pack('c*').force_encoding(@encoding)
    keys = marco.chars.map do |c|
      f = key_mapping.get(c.bytes)
      Reline::Key.new(c, f.is_a?(Symbol) ? f : :ed_insert, false)
    end
  elsif func
    keys = [Reline::Key.new(s, func, false)]
  else
    if s.valid_encoding? && s.size == 1
      keys = [Reline::Key.new(s, :ed_insert, false)]
    else
      keys = []
    end
  end

  [keys, input.drop(matched_bytes.size)]
end

match_status(input) click to toggle source

# File reline/key_stroke.rb, line 22
def match_status(input)
  matching = key_mapping.matching?(input)
  matched = key_mapping.get(input)
  if matching && matched
    MATCHING_MATCHED
  elsif matching
    MATCHING
  elsif matched
    MATCHED
  elsif input[0] == ESC_BYTE
    match_unknown_escape_sequence(input, vi_mode: @config.editing_mode_is?(:vi_insert, :vi_command))
  else
    s = input.pack('c*').force_encoding(@encoding)
    if s.valid_encoding?
      s.size == 1 ? MATCHED : UNMATCHED
    else
      # Invalid string is MATCHING (part of valid string) or MATCHED (invalid bytes to be ignored)
      MATCHING_MATCHED
    end
  end
end

Private Instance Methods

key_mapping() click to toggle source

# File reline/key_stroke.rb, line 116
def key_mapping
  @config.key_bindings
end

match_unknown_escape_sequence(input, vi_mode: false) click to toggle source

returns match status of CSI/SS3 sequence and matched length

# File reline/key_stroke.rb, line 80
def match_unknown_escape_sequence(input, vi_mode: false)
  idx = 0
  return UNMATCHED unless input[idx] == ESC_BYTE
  idx += 1
  idx += 1 if input[idx] == ESC_BYTE

  case input[idx]
  when nil
    if idx == 1 # `ESC`
      return MATCHING_MATCHED
    else # `ESC ESC`
      return MATCHING
    end
  when 91 # == '['.ord
    # CSI sequence `ESC [ ... char`
    idx += 1
    idx += 1 while idx < input.size && CSI_PARAMETER_BYTES_RANGE.cover?(input[idx])
    idx += 1 while idx < input.size && CSI_INTERMEDIATE_BYTES_RANGE.cover?(input[idx])
  when 79 # == 'O'.ord
    # SS3 sequence `ESC O char`
    idx += 1
  else
    # `ESC char` or `ESC ESC char`
    return UNMATCHED if vi_mode
  end

  case input.size
  when idx
    MATCHING
  when idx + 1
    MATCHED
  else
    UNMATCHED
  end
end