reline 0.3.5 → 0.6.2

data/lib/reline/key_actor/vi_insert.rb

@@ -1,7 +1,7 @@
-class Reline::KeyActor::ViInsert < Reline::KeyActor::Base
-  MAPPING = [
+module Reline::KeyActor
+  VI_INSERT_MAPPING = [
     #   0 ^@
-    :ed_unassigned,
+    nil,
     #   1 ^A
     :ed_insert,
     #   2 ^B
@@ -19,7 +19,7 @@ class Reline::KeyActor::ViInsert < Reline::KeyActor::Base
     #   8 ^H
     :vi_delete_prev_char,
     #   9 ^I
-    :ed_insert,
+    :complete,
     #  10 ^J
     :ed_newline,
     #  11 ^K
@@ -29,11 +29,11 @@ class Reline::KeyActor::ViInsert < Reline::KeyActor::Base
     #  13 ^M
     :ed_newline,
     #  14 ^N
-    :ed_insert,
+    :menu_complete,
     #  15 ^O
     :ed_insert,
     #  16 ^P
-    :ed_insert,
+    :menu_complete_backward,
     #  17 ^Q
     :ed_ignore,
     #  18 ^R
@@ -41,7 +41,7 @@ class Reline::KeyActor::ViInsert < Reline::KeyActor::Base
     #  19 ^S
     :vi_search_next,
     #  20 ^T
-    :ed_insert,
+    :ed_transpose_chars,
     #  21 ^U
     :vi_kill_line_prev,
     #  22 ^V
@@ -51,7 +51,7 @@ class Reline::KeyActor::ViInsert < Reline::KeyActor::Base
     #  24 ^X
     :ed_insert,
     #  25 ^Y
-    :ed_insert,
+    :em_yank,
     #  26 ^Z
     :ed_insert,
     #  27 ^[
@@ -97,25 +97,25 @@ class Reline::KeyActor::ViInsert < Reline::KeyActor::Base
     #  47 /
     :ed_insert,
     #  48 0
-    :ed_insert,
+    :ed_digit,
     #  49 1
-    :ed_insert,
+    :ed_digit,
     #  50 2
-    :ed_insert,
+    :ed_digit,
     #  51 3
-    :ed_insert,
+    :ed_digit,
     #  52 4
-    :ed_insert,
+    :ed_digit,
     #  53 5
-    :ed_insert,
+    :ed_digit,
     #  54 6
-    :ed_insert,
+    :ed_digit,
     #  55 7
-    :ed_insert,
+    :ed_digit,
     #  56 8
-    :ed_insert,
+    :ed_digit,
     #  57 9
-    :ed_insert,
+    :ed_digit,
     #  58 :
     :ed_insert,
     #  59 ;
@@ -257,261 +257,261 @@ class Reline::KeyActor::ViInsert < Reline::KeyActor::Base
     # 127 ^?
     :vi_delete_prev_char,
     # 128 M-^@
-    :ed_unassigned,
+    nil,
     # 129 M-^A
-    :ed_unassigned,
+    nil,
     # 130 M-^B
-    :ed_unassigned,
+    nil,
     # 131 M-^C
-    :ed_unassigned,
+    nil,
     # 132 M-^D
-    :ed_unassigned,
+    nil,
     # 133 M-^E
-    :ed_unassigned,
+    nil,
     # 134 M-^F
-    :ed_unassigned,
+    nil,
     # 135 M-^G
-    :ed_unassigned,
+    nil,
     # 136 M-^H
-    :ed_unassigned,
+    nil,
     # 137 M-^I
-    :ed_unassigned,
+    nil,
     # 138 M-^J
     :key_newline,
     # 139 M-^K
-    :ed_unassigned,
+    nil,
     # 140 M-^L
-    :ed_unassigned,
+    nil,
     # 141 M-^M
     :key_newline,
     # 142 M-^N
-    :ed_unassigned,
+    nil,
     # 143 M-^O
-    :ed_unassigned,
+    nil,
     # 144 M-^P
-    :ed_unassigned,
+    nil,
     # 145 M-^Q
-    :ed_unassigned,
+    nil,
     # 146 M-^R
-    :ed_unassigned,
+    nil,
     # 147 M-^S
-    :ed_unassigned,
+    nil,
     # 148 M-^T
-    :ed_unassigned,
+    nil,
     # 149 M-^U
-    :ed_unassigned,
+    nil,
     # 150 M-^V
-    :ed_unassigned,
+    nil,
     # 151 M-^W
-    :ed_unassigned,
+    nil,
     # 152 M-^X
-    :ed_unassigned,
+    nil,
     # 153 M-^Y
-    :ed_unassigned,
+    nil,
     # 154 M-^Z
-    :ed_unassigned,
+    nil,
     # 155 M-^[
-    :ed_unassigned,
+    nil,
     # 156 M-^\
-    :ed_unassigned,
+    nil,
     # 157 M-^]
-    :ed_unassigned,
+    nil,
     # 158 M-^^
-    :ed_unassigned,
+    nil,
     # 159 M-^_
-    :ed_unassigned,
+    nil,
     # 160 M-SPACE
-    :ed_unassigned,
+    nil,
     # 161 M-!
-    :ed_unassigned,
+    nil,
     # 162 M-"
-    :ed_unassigned,
+    nil,
     # 163 M-#
-    :ed_unassigned,
+    nil,
     # 164 M-$
-    :ed_unassigned,
+    nil,
     # 165 M-%
-    :ed_unassigned,
+    nil,
     # 166 M-&
-    :ed_unassigned,
+    nil,
     # 167 M-'
-    :ed_unassigned,
+    nil,
     # 168 M-(
-    :ed_unassigned,
+    nil,
     # 169 M-)
-    :ed_unassigned,
+    nil,
     # 170 M-*
-    :ed_unassigned,
+    nil,
     # 171 M-+
-    :ed_unassigned,
+    nil,
     # 172 M-,
-    :ed_unassigned,
+    nil,
     # 173 M--
-    :ed_unassigned,
+    nil,
     # 174 M-.
-    :ed_unassigned,
+    nil,
     # 175 M-/
-    :ed_unassigned,
+    nil,
     # 176 M-0
-    :ed_unassigned,
+    nil,
     # 177 M-1
-    :ed_unassigned,
+    nil,
     # 178 M-2
-    :ed_unassigned,
+    nil,
     # 179 M-3
-    :ed_unassigned,
+    nil,
     # 180 M-4
-    :ed_unassigned,
+    nil,
     # 181 M-5
-    :ed_unassigned,
+    nil,
     # 182 M-6
-    :ed_unassigned,
+    nil,
     # 183 M-7
-    :ed_unassigned,
+    nil,
     # 184 M-8
-    :ed_unassigned,
+    nil,
     # 185 M-9
-    :ed_unassigned,
+    nil,
     # 186 M-:
-    :ed_unassigned,
+    nil,
     # 187 M-;
-    :ed_unassigned,
+    nil,
     # 188 M-<
-    :ed_unassigned,
+    nil,
     # 189 M-=
-    :ed_unassigned,
+    nil,
     # 190 M->
-    :ed_unassigned,
+    nil,
     # 191 M-?
-    :ed_unassigned,
+    nil,
     # 192 M-@
-    :ed_unassigned,
+    nil,
     # 193 M-A
-    :ed_unassigned,
+    nil,
     # 194 M-B
-    :ed_unassigned,
+    nil,
     # 195 M-C
-    :ed_unassigned,
+    nil,
     # 196 M-D
-    :ed_unassigned,
+    nil,
     # 197 M-E
-    :ed_unassigned,
+    nil,
     # 198 M-F
-    :ed_unassigned,
+    nil,
     # 199 M-G
-    :ed_unassigned,
+    nil,
     # 200 M-H
-    :ed_unassigned,
+    nil,
     # 201 M-I
-    :ed_unassigned,
+    nil,
     # 202 M-J
-    :ed_unassigned,
+    nil,
     # 203 M-K
-    :ed_unassigned,
+    nil,
     # 204 M-L
-    :ed_unassigned,
+    nil,
     # 205 M-M
-    :ed_unassigned,
+    nil,
     # 206 M-N
-    :ed_unassigned,
+    nil,
     # 207 M-O
-    :ed_unassigned,
+    nil,
     # 208 M-P
-    :ed_unassigned,
+    nil,
     # 209 M-Q
-    :ed_unassigned,
+    nil,
     # 210 M-R
-    :ed_unassigned,
+    nil,
     # 211 M-S
-    :ed_unassigned,
+    nil,
     # 212 M-T
-    :ed_unassigned,
+    nil,
     # 213 M-U
-    :ed_unassigned,
+    nil,
     # 214 M-V
-    :ed_unassigned,
+    nil,
     # 215 M-W
-    :ed_unassigned,
+    nil,
     # 216 M-X
-    :ed_unassigned,
+    nil,
     # 217 M-Y
-    :ed_unassigned,
+    nil,
     # 218 M-Z
-    :ed_unassigned,
+    nil,
     # 219 M-[
-    :ed_unassigned,
+    nil,
     # 220 M-\
-    :ed_unassigned,
+    nil,
     # 221 M-]
-    :ed_unassigned,
+    nil,
     # 222 M-^
-    :ed_unassigned,
+    nil,
     # 223 M-_
-    :ed_unassigned,
+    nil,
     # 224 M-`
-    :ed_unassigned,
+    nil,
     # 225 M-a
-    :ed_unassigned,
+    nil,
     # 226 M-b
-    :ed_unassigned,
+    nil,
     # 227 M-c
-    :ed_unassigned,
+    nil,
     # 228 M-d
-    :ed_unassigned,
+    nil,
     # 229 M-e
-    :ed_unassigned,
+    nil,
     # 230 M-f
-    :ed_unassigned,
+    nil,
     # 231 M-g
-    :ed_unassigned,
+    nil,
     # 232 M-h
-    :ed_unassigned,
+    nil,
     # 233 M-i
-    :ed_unassigned,
+    nil,
     # 234 M-j
-    :ed_unassigned,
+    nil,
     # 235 M-k
-    :ed_unassigned,
+    nil,
     # 236 M-l
-    :ed_unassigned,
+    nil,
     # 237 M-m
-    :ed_unassigned,
+    nil,
     # 238 M-n
-    :ed_unassigned,
+    nil,
     # 239 M-o
-    :ed_unassigned,
+    nil,
     # 240 M-p
-    :ed_unassigned,
+    nil,
     # 241 M-q
-    :ed_unassigned,
+    nil,
     # 242 M-r
-    :ed_unassigned,
+    nil,
     # 243 M-s
-    :ed_unassigned,
+    nil,
     # 244 M-t
-    :ed_unassigned,
+    nil,
     # 245 M-u
-    :ed_unassigned,
+    nil,
     # 246 M-v
-    :ed_unassigned,
+    nil,
     # 247 M-w
-    :ed_unassigned,
+    nil,
     # 248 M-x
-    :ed_unassigned,
+    nil,
     # 249 M-y
-    :ed_unassigned,
+    nil,
     # 250 M-z
-    :ed_unassigned,
+    nil,
     # 251 M-{
-    :ed_unassigned,
+    nil,
     # 252 M-|
-    :ed_unassigned,
+    nil,
     # 253 M-}
-    :ed_unassigned,
+    nil,
     # 254 M-~
-    :ed_unassigned,
+    nil,
     # 255 M-^?
-    :ed_unassigned
+    nil
     # EOF
   ]
 end

data/lib/reline/key_actor.rb

@@ -2,6 +2,7 @@ module Reline::KeyActor
 end
 
 require 'reline/key_actor/base'
+require 'reline/key_actor/composite'
 require 'reline/key_actor/emacs'
 require 'reline/key_actor/vi_command'
 require 'reline/key_actor/vi_insert'

data/lib/reline/key_stroke.rb

@@ -1,103 +1,117 @@
 class Reline::KeyStroke
-  def initialize(config)
+  ESC_BYTE = 27
+  CSI_PARAMETER_BYTES_RANGE = 0x30..0x3f
+  CSI_INTERMEDIATE_BYTES_RANGE = (0x20..0x2f)
+
+  attr_accessor :encoding
+
+  def initialize(config, encoding)
     @config = config
+    @encoding = encoding
   end
 
-  def compress_meta_key(ary)
-    return ary unless @config.convert_meta
-    ary.inject([]) { |result, key|
-      if result.size > 0 and result.last == "\e".ord
-        result[result.size - 1] = Reline::Key.new(key, key | 0b10000000, true)
+  # Input exactly matches to a key sequence
+  MATCHING = :matching
+  # Input partially matches to a key sequence
+  MATCHED = :matched
+  # Input matches to a key sequence and the key sequence is a prefix of another key sequence
+  MATCHING_MATCHED = :matching_matched
+  # Input does not match to any key sequence
+  UNMATCHED = :unmatched
+
+  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
-        result << key
+        # Invalid string is MATCHING (part of valid string) or MATCHED (invalid bytes to be ignored)
+        MATCHING_MATCHED
       end
-      result
-    }
+    end
   end
 
-  def start_with?(me, other)
-    compressed_me = compress_meta_key(me)
-    compressed_other = compress_meta_key(other)
-    i = 0
-    loop do
-      my_c = compressed_me[i]
-      other_c = compressed_other[i]
-      other_is_last = (i + 1) == compressed_other.size
-      me_is_last = (i + 1) == compressed_me.size
-      if my_c != other_c
-        if other_c == "\e".ord and other_is_last and my_c.is_a?(Reline::Key) and my_c.with_meta
-          return true
-        else
-          return false
-        end
-      elsif other_is_last
-        return true
-      elsif me_is_last
-        return false
-      end
-      i += 1
+  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
-  end
+    return [[], []] unless matched_bytes
 
-  def equal?(me, other)
-    case me
-    when Array
-      compressed_me = compress_meta_key(me)
-      compressed_other = compress_meta_key(other)
-      compressed_me.size == compressed_other.size and [compressed_me, compressed_other].transpose.all?{ |i| equal?(i[0], i[1]) }
-    when Integer
-      if other.is_a?(Reline::Key)
-        if other.combined_char == "\e".ord
-          false
-        else
-          other.combined_char == me
-        end
-      else
-        me == other
+    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.
+      macro = func.pack('c*').force_encoding(@encoding)
+      keys = macro.chars.map do |c|
+        f = key_mapping.get(c.bytes)
+        Reline::Key.new(c, f.is_a?(Symbol) ? f : :ed_insert, false)
       end
-    when Reline::Key
-      if other.is_a?(Integer)
-        me.combined_char == other
+    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
-        me == other
+        keys = []
       end
     end
-  end
 
-  def match_status(input)
-    key_mapping.keys.select { |lhs|
-      start_with?(lhs, input)
-    }.tap { |it|
-      return :matched  if it.size == 1 && equal?(it[0], input)
-      return :matching if it.size == 1 && !equal?(it[0], input)
-      return :matched  if it.max_by(&:size)&.size&.< input.size
-      return :matching if it.size > 1
-    }
-    key_mapping.keys.select { |lhs|
-      start_with?(input, lhs)
-    }.tap { |it|
-      return it.size > 0 ? :matched : :unmatched
-    }
+    [keys, input.drop(matched_bytes.size)]
   end
 
-  def expand(input)
-    input = compress_meta_key(input)
-    lhs = key_mapping.keys.select { |item| start_with?(input, item) }.sort_by(&:size).last
-    return input unless lhs
-    rhs = key_mapping[lhs]
+  private
 
-    case rhs
-    when String
-      rhs_bytes = rhs.bytes
-      expand(expand(rhs_bytes) + expand(input.drop(lhs.size)))
-    when Symbol
-      [rhs] + expand(input.drop(lhs.size))
-    when Array
-      rhs
+  # returns match status of CSI/SS3 sequence and matched length
+  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
-  end
 
-  private
+    case input.size
+    when idx
+      MATCHING
+    when idx + 1
+      MATCHED
+    else
+      UNMATCHED
+    end
+  end
 
   def key_mapping
     @config.key_bindings

data/lib/reline/kill_ring.rb

@@ -14,7 +14,7 @@ class Reline::KillRing
     end
 
     def ==(other)
-      object_id == other.object_id
+      equal?(other)
     end
   end
 
@@ -68,7 +68,7 @@ class Reline::KillRing
   def append(string, before_p = false)
     case @state
     when State::FRESH, State::YANK
-      @ring << RingPoint.new(string)
+      @ring << RingPoint.new(+string)
       @state = State::CONTINUED
     when State::CONTINUED, State::PROCESSED
       if before_p