reline 0.3.0 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8c2181e5eb21934546d6b768715cb47eab6e1ea1edb2fd2300f43af62dc2b1
-  data.tar.gz: 99a61e2729d4b5d150f6f59d99d6de235ea4f1aab6ac262c92fff6a77101b85f
+  metadata.gz: 3075f4003cf263e4652fc0dec716c71b55b597e6cbdc8cdb5297181b72780b57
+  data.tar.gz: 78eb2e13f17bc0c7ae34b425effe29bf40a30b355af7d0efd271823c2cdde521
 SHA512:
-  metadata.gz: 96ceefe0bf71e7e44ccd2a5970b35fc44019af9d7da4d2e04ac1d827eb6bc6a201e679a5e40c4db976554159286f16e39cdeac68bcf69c2c5abeb00a2045e563
-  data.tar.gz: 251c2029df6b3073010ad6a591fb216990124ed4f9e00f533e79461be66c6a2383ea56c1554dd273e4af3cfc9358dee37b76a1b4bff25a1867972201bfebace3
+  metadata.gz: 9fd55d135c7b1aaffaff575f930bdb6365c202a1d15b5943d3dd9f678f416ba312b21c836ef8b78d11ee9942c4e0f0ac50d395633196bd649bd23a2fa6096456
+  data.tar.gz: 43fe692b243560a81da41a48f4cb5cdf05514f85788bbc6b54bba72aef4d5e7258e73c2a84622c80e51adf36345cd9e7595455f8301e09c1f299f7b2ec147ff2

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.com/ruby/reline.svg?branch=master)](https://travis-ci.com/ruby/reline)
+[![Gem Version](https://badge.fury.io/rb/reline.svg)](https://badge.fury.io/rb/reline)
+[![CI](https://github.com/ruby/reline/actions/workflows/reline.yml/badge.svg)](https://github.com/ruby/reline/actions/workflows/reline.yml)
 
 This is a screen capture of *IRB improved by Reline*.
 
@@ -54,6 +55,29 @@ end
 
 See also: [test/reline/yamatanooroti/multiline_repl](https://github.com/ruby/reline/blob/master/test/reline/yamatanooroti/multiline_repl)
 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/reline.
+
+### Run tests
+
+> **Note**
+> Please make sure you have `libvterm` installed for `yamatanooroti` tests (integration tests).
+
+If you use Homebrew, you can install it by running `brew install libvterm`.
+
+```bash
+WITH_VTERM=1 bundle install
+WITH_VTERM=1 bundle exec rake test test_yamatanooroti
+```
+
+## Releasing
+
+```bash
+rake release
+gh release create vX.Y.Z --generate-notes
+```
+
 ## License
 
 The gem is available as open source under the terms of the [Ruby License](https://www.ruby-lang.org/en/about/license.txt).

data/lib/reline/ansi.rb

@@ -7,6 +7,9 @@ class Reline::ANSI
   CAPNAME_KEY_BINDINGS = {
     'khome' => :ed_move_to_beg,
     'kend'  => :ed_move_to_end,
+    'kdch1' => :key_delete,
+    'kpp' => :ed_search_prev_history,
+    'knp' => :ed_search_next_history,
     'kcuu1' => :ed_prev_history,
     'kcud1' => :ed_next_history,
     'kcuf1' => :ed_next_char,
@@ -29,8 +32,8 @@ class Reline::ANSI
     false
   end
 
-  def self.set_default_key_bindings(config)
-    if Reline::Terminfo.enabled?
+  def self.set_default_key_bindings(config, allow_terminfo: true)
+    if allow_terminfo && Reline::Terminfo.enabled?
       set_default_key_bindings_terminfo(config)
     else
       set_default_key_bindings_comprehensive_list(config)
@@ -142,6 +145,10 @@ class Reline::ANSI
     @@output = val
   end
 
+  def self.with_raw_input
+    @@input.raw { yield }
+  end
+
   @@buf = []
   def self.inner_getc
     unless @@buf.empty?
@@ -150,7 +157,7 @@ class Reline::ANSI
     until c = @@input.raw(intr: true) { @@input.wait_readable(0.1) && @@input.getbyte }
       Reline.core.line_editor.resize
     end
-    (c == 0x16 && @@input.raw(min: 0, tim: 0, &:getbyte)) || c
+    (c == 0x16 && @@input.raw(min: 0, time: 0, &:getbyte)) || c
   rescue Errno::EIO
     # Maybe the I/O has been closed.
     nil
@@ -199,7 +206,7 @@ class Reline::ANSI
   end
 
   def self.in_pasting?
-    @@in_bracketed_paste_mode or (not Reline::IOGate.empty_buffer?)
+    @@in_bracketed_paste_mode or (not empty_buffer?)
   end
 
   def self.empty_buffer?

data/lib/reline/config.rb

@@ -45,6 +45,8 @@ class Reline::Config
     attr_accessor v
   end
 
+  attr_accessor :autocompletion
+
   def initialize
     @additional_key_bindings = {} # from inputrc
     @additional_key_bindings[:emacs] = {}
@@ -55,6 +57,7 @@ class Reline::Config
     @if_stack = nil
     @editing_mode_label = :emacs
     @keymap_label = :emacs
+    @keymap_prefix = []
     @key_actors = {}
     @key_actors[:emacs] = Reline::KeyActor::Emacs.new
     @key_actors[:vi_insert] = Reline::KeyActor::ViInsert.new
@@ -90,15 +93,7 @@ class Reline::Config
   end
 
   def editing_mode_is?(*val)
-    (val.respond_to?(:any?) ? val : [val]).any?(@editing_mode_label)
-  end
-
-  def autocompletion=(val)
-    @autocompletion = val
-  end
-
-  def autocompletion
-    @autocompletion
+    val.any?(@editing_mode_label)
   end
 
   def keymap
@@ -221,7 +216,7 @@ class Reline::Config
         key, func_name = $1, $2
         keystroke, func = bind_key(key, func_name)
         next unless keystroke
-        @additional_key_bindings[@keymap_label][keystroke] = func
+        @additional_key_bindings[@keymap_label][@keymap_prefix + keystroke] = func
       end
     end
     unless @if_stack.empty?
@@ -292,18 +287,29 @@ class Reline::Config
       when 'emacs'
         @editing_mode_label = :emacs
         @keymap_label = :emacs
+        @keymap_prefix = []
       when 'vi'
         @editing_mode_label = :vi_insert
         @keymap_label = :vi_insert
+        @keymap_prefix = []
       end
     when 'keymap'
       case value
-      when 'emacs', 'emacs-standard', 'emacs-meta', 'emacs-ctlx'
+      when 'emacs', 'emacs-standard'
+        @keymap_label = :emacs
+        @keymap_prefix = []
+      when 'emacs-ctlx'
+        @keymap_label = :emacs
+        @keymap_prefix = [?\C-x.ord]
+      when 'emacs-meta'
         @keymap_label = :emacs
+        @keymap_prefix = [?\e.ord]
       when 'vi', 'vi-move', 'vi-command'
         @keymap_label = :vi_command
+        @keymap_prefix = []
       when 'vi-insert'
         @keymap_label = :vi_insert
+        @keymap_prefix = []
       end
     when 'keyseq-timeout'
       @keyseq_timeout = value.to_i

data/lib/reline/general_io.rb

@@ -31,6 +31,10 @@ class Reline::GeneralIO
     @@input = val
   end
 
+  def self.with_raw_input
+    yield
+  end
+
   def self.getc
     unless @@buf.empty?
       return @@buf.shift
@@ -57,6 +61,12 @@ class Reline::GeneralIO
     Reline::CursorPos.new(1, 1)
   end
 
+  def self.hide_cursor
+  end
+
+  def self.show_cursor
+  end
+
   def self.move_cursor_column(val)
   end
 

data/lib/reline/key_actor/emacs.rb

@@ -43,7 +43,7 @@ class Reline::KeyActor::Emacs < Reline::KeyActor::Base
     #  20 ^T
     :ed_transpose_chars,
     #  21 ^U
-    :ed_kill_line,
+    :unix_line_discard,
     #  22 ^V
     :ed_quoted_insert,
     #  23 ^W

data/lib/reline/key_stroke.rb

@@ -1,4 +1,8 @@
 class Reline::KeyStroke
+  ESC_BYTE = 27
+  CSI_PARAMETER_BYTES_RANGE = 0x30..0x3f
+  CSI_INTERMEDIATE_BYTES_RANGE = (0x20..0x2f)
+
   def initialize(config)
     @config = config
   end
@@ -73,17 +77,26 @@ class Reline::KeyStroke
       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
-    }
+    if key_mapping.keys.any? { |lhs| start_with?(input, lhs) }
+      :matched
+    else
+      match_unknown_escape_sequence(input).first
+    end
   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
+    unless lhs
+      status, size = match_unknown_escape_sequence(input)
+      case status
+      when :matched
+        return [:ed_unassigned] + expand(input.drop(size))
+      when :matching
+        return [:ed_unassigned]
+      else
+        return input
+      end
+    end
     rhs = key_mapping[lhs]
 
     case rhs
@@ -99,6 +112,36 @@ class Reline::KeyStroke
 
   private
 
+  # returns match status of CSI/SS3 sequence and matched length
+  def match_unknown_escape_sequence(input)
+    idx = 0
+    return [:unmatched, nil] unless input[idx] == ESC_BYTE
+    idx += 1
+    idx += 1 if input[idx] == ESC_BYTE
+
+    case input[idx]
+    when nil
+      return [:matching, nil]
+    when 91 # == '['.ord
+      # CSI sequence
+      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])
+      input[idx] ? [:matched, idx + 1] : [:matching, nil]
+    when 79 # == 'O'.ord
+      # SS3 sequence
+      input[idx + 1] ? [:matched, idx + 2] : [:matching, nil]
+    else
+      if idx == 1
+        # `ESC char`, make it :unmatched so that it will be handled correctly in `read_2nd_character_of_key_sequence`
+        [:unmatched, nil]
+      else
+        # `ESC ESC char`
+        [:matched, idx + 1]
+      end
+    end
+  end
+
   def key_mapping
     @config.key_bindings
   end