reline 0.3.6 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3075f4003cf263e4652fc0dec716c71b55b597e6cbdc8cdb5297181b72780b57
-  data.tar.gz: 78eb2e13f17bc0c7ae34b425effe29bf40a30b355af7d0efd271823c2cdde521
+  metadata.gz: 709b8943f16732f771d45da031e9676dc01c8b75f0410134a8b1fa8ab590d294
+  data.tar.gz: 04aa52c6ea6a8939402a1554b42bce891bd65a13be6b76cbfd3f4859df1455d4
 SHA512:
-  metadata.gz: 9fd55d135c7b1aaffaff575f930bdb6365c202a1d15b5943d3dd9f678f416ba312b21c836ef8b78d11ee9942c4e0f0ac50d395633196bd649bd23a2fa6096456
-  data.tar.gz: 43fe692b243560a81da41a48f4cb5cdf05514f85788bbc6b54bba72aef4d5e7258e73c2a84622c80e51adf36345cd9e7595455f8301e09c1f299f7b2ec147ff2
+  metadata.gz: ab8a124f732cfa4b8522f397a546fc89ea93f188ca9f44f7f560ea2afb00abbe3b95486c17a20b826d360a8bb064ca441bd357acffe1eb4ec371fbf6380cd37d
+  data.tar.gz: e756e58d4ae8929045998b8278fcee48ba1867741cc4d47bd72beb3e3a74902938d4c8a9dcd4c0452f20b25f5b4fe05eb96929bc39c28f326dc88c9bdf7be458

data/lib/reline/ansi.rb

@@ -1,6 +1,5 @@
 require 'io/console'
 require 'io/wait'
-require 'timeout'
 require_relative 'terminfo'
 
 class Reline::ANSI
@@ -14,10 +13,21 @@ class Reline::ANSI
     'kcud1' => :ed_next_history,
     'kcuf1' => :ed_next_char,
     'kcub1' => :ed_prev_char,
-    'cuu' => :ed_prev_history,
-    'cud' => :ed_next_history,
-    'cuf' => :ed_next_char,
-    'cub' => :ed_prev_char,
+  }
+
+  ANSI_CURSOR_KEY_BINDINGS = {
+    # Up
+    'A' => [:ed_prev_history, {}],
+    # Down
+    'B' => [:ed_next_history, {}],
+    # Right
+    'C' => [:ed_next_char, { ctrl: :em_next_word, meta: :em_next_word }],
+    # Left
+    'D' => [:ed_prev_char, { ctrl: :ed_prev_word, meta: :ed_prev_word }],
+    # End
+    'F' => [:ed_move_to_end, {}],
+    # Home
+    'H' => [:ed_move_to_beg, {}],
   }
 
   if Reline::Terminfo.enabled?
@@ -33,22 +43,12 @@ class Reline::ANSI
   end
 
   def self.set_default_key_bindings(config, allow_terminfo: true)
+    set_default_key_bindings_ansi_cursor(config)
     if allow_terminfo && Reline::Terminfo.enabled?
       set_default_key_bindings_terminfo(config)
     else
       set_default_key_bindings_comprehensive_list(config)
     end
-    {
-      # extended entries of terminfo
-      [27, 91, 49, 59, 53, 67] => :em_next_word, # Ctrl+→, extended entry
-      [27, 91, 49, 59, 53, 68] => :ed_prev_word, # Ctrl+←, extended entry
-      [27, 91, 49, 59, 51, 67] => :em_next_word, # Meta+→, extended entry
-      [27, 91, 49, 59, 51, 68] => :ed_prev_word, # Meta+←, extended entry
-    }.each_pair do |key, func|
-      config.add_default_key_binding_by_keymap(:emacs, key, func)
-      config.add_default_key_binding_by_keymap(:vi_insert, key, func)
-      config.add_default_key_binding_by_keymap(:vi_command, key, func)
-    end
     {
       [27, 91, 90] => :completion_journey_up, # S-Tab
     }.each_pair do |key, func|
@@ -64,18 +64,33 @@ class Reline::ANSI
     end
   end
 
+  def self.set_default_key_bindings_ansi_cursor(config)
+    ANSI_CURSOR_KEY_BINDINGS.each do |char, (default_func, modifiers)|
+      bindings = [["\e[#{char}", default_func]] # CSI + char
+      if modifiers[:ctrl]
+        # CSI + ctrl_key_modifier + char
+        bindings << ["\e[1;5#{char}", modifiers[:ctrl]]
+      end
+      if modifiers[:meta]
+        # CSI + meta_key_modifier + char
+        bindings << ["\e[1;3#{char}", modifiers[:meta]]
+        # Meta(ESC) + CSI + char
+        bindings << ["\e\e[#{char}", modifiers[:meta]]
+      end
+      bindings.each do |sequence, func|
+        key = sequence.bytes
+        config.add_default_key_binding_by_keymap(:emacs, key, func)
+        config.add_default_key_binding_by_keymap(:vi_insert, key, func)
+        config.add_default_key_binding_by_keymap(:vi_command, key, func)
+      end
+    end
+  end
+
   def self.set_default_key_bindings_terminfo(config)
     key_bindings = CAPNAME_KEY_BINDINGS.map do |capname, key_binding|
       begin
         key_code = Reline::Terminfo.tigetstr(capname)
-        case capname
-        # Escape sequences that omit the move distance and are set to defaults
-        # value 1 may be sometimes sent by pressing the arrow-key.
-        when 'cuu', 'cud', 'cuf', 'cub'
-          [ key_code.sub(/%p1%d/, '').bytes, key_binding ]
-        else
-          [ key_code.bytes, key_binding ]
-        end
+        [ key_code.bytes, key_binding ]
       rescue Reline::Terminfo::TerminfoError
         # capname is undefined
       end
@@ -94,14 +109,8 @@ class Reline::ANSI
       [27, 91, 49, 126] => :ed_move_to_beg, # Home
       [27, 91, 52, 126] => :ed_move_to_end, # End
       [27, 91, 51, 126] => :key_delete,     # Del
-      [27, 91, 65] => :ed_prev_history,     # ↑
-      [27, 91, 66] => :ed_next_history,     # ↓
-      [27, 91, 67] => :ed_next_char,        # →
-      [27, 91, 68] => :ed_prev_char,        # ←
 
       # KDE
-      [27, 91, 72] => :ed_move_to_beg,      # Home
-      [27, 91, 70] => :ed_move_to_end,      # End
       # Del is 0x08
       [27, 71, 65] => :ed_prev_history,     # ↑
       [27, 71, 66] => :ed_next_history,     # ↓
@@ -118,12 +127,6 @@ class Reline::ANSI
       # Del is 0x08
       # Arrow keys are the same of KDE
 
-      # iTerm2
-      [27, 27, 91, 67] => :em_next_word,    # Option+→, extended entry
-      [27, 27, 91, 68] => :ed_prev_word,    # Option+←, extended entry
-      [195, 166] => :em_next_word,          # Option+f
-      [195, 162] => :ed_prev_word,          # Option+b
-
       [27, 79, 65] => :ed_prev_history,     # ↑
       [27, 79, 66] => :ed_next_history,     # ↓
       [27, 79, 67] => :ed_next_char,        # →
@@ -150,11 +153,13 @@ class Reline::ANSI
   end
 
   @@buf = []
-  def self.inner_getc
+  def self.inner_getc(timeout_second)
     unless @@buf.empty?
       return @@buf.shift
     end
     until c = @@input.raw(intr: true) { @@input.wait_readable(0.1) && @@input.getbyte }
+      timeout_second -= 0.1
+      return nil if timeout_second <= 0
       Reline.core.line_editor.resize
     end
     (c == 0x16 && @@input.raw(min: 0, time: 0, &:getbyte)) || c
@@ -168,40 +173,38 @@ class Reline::ANSI
   @@in_bracketed_paste_mode = false
   START_BRACKETED_PASTE = String.new("\e[200~,", encoding: Encoding::ASCII_8BIT)
   END_BRACKETED_PASTE = String.new("\e[200~.", encoding: Encoding::ASCII_8BIT)
-  def self.getc_with_bracketed_paste
+  def self.getc_with_bracketed_paste(timeout_second)
     buffer = String.new(encoding: Encoding::ASCII_8BIT)
-    buffer << inner_getc
+    buffer << inner_getc(timeout_second)
     while START_BRACKETED_PASTE.start_with?(buffer) or END_BRACKETED_PASTE.start_with?(buffer) do
       if START_BRACKETED_PASTE == buffer
         @@in_bracketed_paste_mode = true
-        return inner_getc
+        return inner_getc(timeout_second)
       elsif END_BRACKETED_PASTE == buffer
         @@in_bracketed_paste_mode = false
         ungetc(-1)
-        return inner_getc
+        return inner_getc(timeout_second)
       end
-      begin
-        succ_c = nil
-        Timeout.timeout(Reline.core.config.keyseq_timeout * 100) {
-          succ_c = inner_getc
-        }
-      rescue Timeout::Error
-        break
-      else
+      succ_c = inner_getc(Reline.core.config.keyseq_timeout)
+
+      if succ_c
         buffer << succ_c
+      else
+        break
       end
     end
     buffer.bytes.reverse_each do |ch|
       ungetc ch
     end
-    inner_getc
+    inner_getc(timeout_second)
   end
 
-  def self.getc
+  # if the usage expects to wait indefinitely, use Float::INFINITY for timeout_second
+  def self.getc(timeout_second)
     if Reline.core.config.enable_bracketed_paste
-      getc_with_bracketed_paste
+      getc_with_bracketed_paste(timeout_second)
     else
-      inner_getc
+      inner_getc(timeout_second)
     end
   end
 
@@ -331,9 +334,12 @@ class Reline::ANSI
     @@output.write "\e[K"
   end
 
+  # This only works when the cursor is at the bottom of the scroll range
+  # For more details, see https://github.com/ruby/reline/pull/577#issuecomment-1646679623
   def self.scroll_down(x)
     return if x.zero?
-    @@output.write "\e[#{x}S"
+    # We use `\n` instead of CSI + S because CSI + S would cause https://github.com/ruby/reline/issues/576
+    @@output.write "\n" * x
   end
 
   def self.clear_screen

data/lib/reline/general_io.rb

@@ -1,4 +1,3 @@
-require 'timeout'
 require 'io/wait'
 
 class Reline::GeneralIO
@@ -35,7 +34,7 @@ class Reline::GeneralIO
     yield
   end
 
-  def self.getc
+  def self.getc(_timeout_second)
     unless @@buf.empty?
       return @@buf.shift
     end

data/lib/reline/line_editor.rb

@@ -1605,7 +1605,7 @@ class Reline::LineEditor
     else
       @just_cursor_moving = false
     end
-    if @is_multiline and @auto_indent_proc and not simplified_rendering?
+    if @is_multiline and @auto_indent_proc and not simplified_rendering? and @line
       process_auto_indent
     end
   end
@@ -2696,6 +2696,7 @@ class Reline::LineEditor
       @cursor_max -= width
     end
   end
+  alias_method :kill_word, :em_delete_next_word
 
   private def ed_delete_prev_word(key)
     if @byte_pointer > 0
@@ -2707,6 +2708,7 @@ class Reline::LineEditor
       @cursor_max -= width
     end
   end
+  alias_method :backward_kill_word, :ed_delete_prev_word
 
   private def ed_transpose_chars(key)
     if @byte_pointer > 0

data/lib/reline/version.rb

@@ -1,3 +1,3 @@
 module Reline
-  VERSION = '0.3.6'
+  VERSION = '0.3.8'
 end

data/lib/reline/windows.rb

@@ -295,7 +295,7 @@ class Reline::Windows
     yield
   end
 
-  def self.getc
+  def self.getc(_timeout_second)
     check_input_event
     @@output_buf.shift
   end

data/lib/reline.rb

@@ -1,5 +1,4 @@
 require 'io/console'
-require 'timeout'
 require 'forwardable'
 require 'reline/version'
 require 'reline/config'
@@ -397,7 +396,7 @@ module Reline
     private def read_io(keyseq_timeout, &block)
       buffer = []
       loop do
-        c = io_gate.getc
+        c = io_gate.getc(Float::INFINITY)
         if c == -1
           result = :unmatched
           @bracketed_paste_finished = true
@@ -434,15 +433,8 @@ module Reline
     end
 
     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 = io_gate.getc
-        }
-      rescue Timeout::Error # cancel matching only when first byte
-        block.([Reline::Key.new(c, c, false)])
-        return :break
-      else
+      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
@@ -462,27 +454,23 @@ module Reline
           block.(expanded)
           return :break
         end
+      else
+        block.([Reline::Key.new(c, c, false)])
+        return :break
       end
     end
 
     private def read_escaped_key(keyseq_timeout, c, block)
-      begin
-        escaped_c = nil
-        Timeout.timeout(keyseq_timeout / 1000.0) {
-          escaped_c = io_gate.getc
-        }
-      rescue Timeout::Error # independent ESC
+      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
-        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
+        block.([Reline::Key.new(escaped_c, escaped_c | 0b10000000, true)])
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reline
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.8
 platform: ruby
 authors:
 - aycabta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-08 00:00:00.000000000 Z
+date: 2023-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: io-console
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Alternative GNU Readline or Editline implementation by pure Ruby.