reline 0.5.8 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcccc644594f9c2e4b9ae0eb743c2ae293ef084e96a8d9bd032b76825111c01b
-  data.tar.gz: b5ab239a3d20925d4fbd8fb827908fa3e4fa70298a172e32e9b2b4de59dc767e
+  metadata.gz: 28ee53a9963a33e9eb1159bea507695d94cc4f67b05ce005175808b7ec2d5175
+  data.tar.gz: c165de2edcc223bc4e3e149208fe29994063445ea0cf02b93658010a245df5e4
 SHA512:
-  metadata.gz: 9bce894711da0253bf9b3f0eb192ff64947d591edd00f9094430431eb470fade4d02f3f8b529d364cdd7124d7f5a5203ea755be41dbfda890e37654aca430706
-  data.tar.gz: eed500ad148a1f83e3de03e6d7daaf5d250ba3ea25d47d24070e749dfd44a7d900b83474dd0b427faee74bad883dab97b7af1984a7fb7209e1819fd416d4381b
+  metadata.gz: af0f93e54d3a414c63dfb369746f00e8fa9cac609c646c0a48ad5f87275e7b6f5c88c47d4c30218075d3774fd41ba7978f49a0ffbfa070ee42921ba0e500c06e
+  data.tar.gz: 5b0a45b7ae2cfb0e23c9d3b4a863e381f4d9ba5d6298f864c261e408cb5c366031d6137d623d0d46e3729b7bbe086fc5da5c5e636163bce230ae0f297441e016

data/lib/reline/config.rb

@@ -29,18 +29,20 @@ class Reline::Config
   attr_accessor :autocompletion
 
   def initialize
-    @additional_key_bindings = {} # from inputrc
-    @additional_key_bindings[:emacs] = {}
-    @additional_key_bindings[:vi_insert] = {}
-    @additional_key_bindings[:vi_command] = {}
-    @oneshot_key_bindings = {}
+    @additional_key_bindings = { # from inputrc
+      emacs: Reline::KeyActor::Base.new,
+      vi_insert: Reline::KeyActor::Base.new,
+      vi_command: Reline::KeyActor::Base.new
+    }
+    @oneshot_key_bindings = Reline::KeyActor::Base.new
     @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
-    @key_actors[:vi_command] = Reline::KeyActor::ViCommand.new
+    @default_key_bindings = {
+      emacs: Reline::KeyActor::Base.new(Reline::KeyActor::EMACS_MAPPING),
+      vi_insert: Reline::KeyActor::Base.new(Reline::KeyActor::VI_INSERT_MAPPING),
+      vi_command: Reline::KeyActor::Base.new(Reline::KeyActor::VI_COMMAND_MAPPING)
+    }
     @vi_cmd_mode_string = '(cmd)'
     @vi_ins_mode_string = '(ins)'
     @emacs_mode_string = '@'
@@ -62,7 +64,7 @@ class Reline::Config
   end
 
   def editing_mode
-    @key_actors[@editing_mode_label]
+    @default_key_bindings[@editing_mode_label]
   end
 
   def editing_mode=(val)
@@ -74,7 +76,7 @@ class Reline::Config
   end
 
   def keymap
-    @key_actors[@keymap_label]
+    @default_key_bindings[@keymap_label]
   end
 
   def loaded?
@@ -133,14 +135,14 @@ class Reline::Config
 
   def key_bindings
     # The key bindings for each editing mode will be overwritten by the user-defined ones.
-    kb = @key_actors[@editing_mode_label].default_key_bindings.dup
-    kb.merge!(@additional_key_bindings[@editing_mode_label])
-    kb.merge!(@oneshot_key_bindings)
-    kb
+    Reline::KeyActor::Composite.new([@oneshot_key_bindings, @additional_key_bindings[@editing_mode_label], @default_key_bindings[@editing_mode_label]])
   end
 
   def add_oneshot_key_binding(keystroke, target)
-    @oneshot_key_bindings[keystroke] = target
+    # IRB sets invalid keystroke [Reline::Key]. We should ignore it.
+    return unless keystroke.all? { |c| c.is_a?(Integer) }
+
+    @oneshot_key_bindings.add(keystroke, target)
   end
 
   def reset_oneshot_key_bindings
@@ -148,11 +150,11 @@ class Reline::Config
   end
 
   def add_default_key_binding_by_keymap(keymap, keystroke, target)
-    @key_actors[keymap].default_key_bindings[keystroke] = target
+    @default_key_bindings[keymap].add(keystroke, target)
   end
 
   def add_default_key_binding(keystroke, target)
-    @key_actors[@keymap_label].default_key_bindings[keystroke] = target
+    add_default_key_binding_by_keymap(@keymap_label, keystroke, target)
   end
 
   def read_lines(lines, file = nil)
@@ -192,7 +194,7 @@ class Reline::Config
         func_name = func_name.split.first
         keystroke, func = bind_key(key, func_name)
         next unless keystroke
-        @additional_key_bindings[@keymap_label][@keymap_prefix + keystroke] = func
+        @additional_key_bindings[@keymap_label].add(@keymap_prefix + keystroke, func)
       end
     end
     unless if_stack.empty?

data/lib/reline/{ansi.rb → io/ansi.rb}

@@ -1,10 +1,7 @@
 require 'io/console'
 require 'io/wait'
-require_relative 'terminfo'
-
-class Reline::ANSI
-  RESET_COLOR = "\e[0m"
 
+class Reline::ANSI < Reline::IO
   CAPNAME_KEY_BINDINGS = {
     'khome' => :ed_move_to_beg,
     'kend'  => :ed_move_to_end,
@@ -36,15 +33,18 @@ class Reline::ANSI
     Reline::Terminfo.setupterm(0, 2)
   end
 
-  def self.encoding
-    Encoding.default_external
+  def initialize
+    @input = STDIN
+    @output = STDOUT
+    @buf = []
+    @old_winch_handler = nil
   end
 
-  def self.win?
-    false
+  def encoding
+    Encoding.default_external
   end
 
-  def self.set_default_key_bindings(config, allow_terminfo: true)
+  def set_default_key_bindings(config, allow_terminfo: true)
     set_bracketed_paste_key_bindings(config)
     set_default_key_bindings_ansi_cursor(config)
     if allow_terminfo && Reline::Terminfo.enabled?
@@ -67,13 +67,13 @@ class Reline::ANSI
     end
   end
 
-  def self.set_bracketed_paste_key_bindings(config)
+  def set_bracketed_paste_key_bindings(config)
     [:emacs, :vi_insert, :vi_command].each do |keymap|
       config.add_default_key_binding_by_keymap(keymap, START_BRACKETED_PASTE.bytes, :bracketed_paste_start)
     end
   end
 
-  def self.set_default_key_bindings_ansi_cursor(config)
+  def 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]
@@ -95,7 +95,7 @@ class Reline::ANSI
     end
   end
 
-  def self.set_default_key_bindings_terminfo(config)
+  def set_default_key_bindings_terminfo(config)
     key_bindings = CAPNAME_KEY_BINDINGS.map do |capname, key_binding|
       begin
         key_code = Reline::Terminfo.tigetstr(capname)
@@ -112,12 +112,16 @@ class Reline::ANSI
     end
   end
 
-  def self.set_default_key_bindings_comprehensive_list(config)
+  def set_default_key_bindings_comprehensive_list(config)
     {
+      # xterm
+      [27, 91, 51, 126] => :key_delete, # kdch1
+      [27, 91, 53, 126] => :ed_search_prev_history, # kpp
+      [27, 91, 54, 126] => :ed_search_next_history, # knp
+
       # Console (80x25)
       [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
 
       # KDE
       # Del is 0x08
@@ -147,47 +151,42 @@ class Reline::ANSI
     end
   end
 
-  @@input = STDIN
-  def self.input=(val)
-    @@input = val
+  def input=(val)
+    @input = val
   end
 
-  @@output = STDOUT
-  def self.output=(val)
-    @@output = val
+  def output=(val)
+    @output = val
   end
 
-  def self.with_raw_input
-    if @@input.tty?
-      @@input.raw(intr: true) { yield }
+  def with_raw_input
+    if @input.tty?
+      @input.raw(intr: true) { yield }
     else
       yield
     end
   end
 
-  @@buf = []
-  def self.inner_getc(timeout_second)
-    unless @@buf.empty?
-      return @@buf.shift
+  def inner_getc(timeout_second)
+    unless @buf.empty?
+      return @buf.shift
     end
-    until @@input.wait_readable(0.01)
+    until @input.wait_readable(0.01)
       timeout_second -= 0.01
       return nil if timeout_second <= 0
 
       Reline.core.line_editor.handle_signal
     end
-    c = @@input.getbyte
-    (c == 0x16 && @@input.raw(min: 0, time: 0, &:getbyte)) || c
+    c = @input.getbyte
+    (c == 0x16 && @input.tty? && @input.raw(min: 0, time: 0, &:getbyte)) || c
   rescue Errno::EIO
     # Maybe the I/O has been closed.
     nil
-  rescue Errno::ENOTTY
-    nil
   end
 
   START_BRACKETED_PASTE = String.new("\e[200~", encoding: Encoding::ASCII_8BIT)
   END_BRACKETED_PASTE = String.new("\e[201~", encoding: Encoding::ASCII_8BIT)
-  def self.read_bracketed_paste
+  def read_bracketed_paste
     buffer = String.new(encoding: Encoding::ASCII_8BIT)
     until buffer.end_with?(END_BRACKETED_PASTE)
       c = inner_getc(Float::INFINITY)
@@ -199,38 +198,38 @@ class Reline::ANSI
   end
 
   # if the usage expects to wait indefinitely, use Float::INFINITY for timeout_second
-  def self.getc(timeout_second)
+  def getc(timeout_second)
     inner_getc(timeout_second)
   end
 
-  def self.in_pasting?
+  def in_pasting?
     not empty_buffer?
   end
 
-  def self.empty_buffer?
-    unless @@buf.empty?
+  def empty_buffer?
+    unless @buf.empty?
       return false
     end
-    !@@input.wait_readable(0)
+    !@input.wait_readable(0)
   end
 
-  def self.ungetc(c)
-    @@buf.unshift(c)
+  def ungetc(c)
+    @buf.unshift(c)
   end
 
-  def self.retrieve_keybuffer
+  def retrieve_keybuffer
     begin
-      return unless @@input.wait_readable(0.001)
-      str = @@input.read_nonblock(1024)
+      return unless @input.wait_readable(0.001)
+      str = @input.read_nonblock(1024)
       str.bytes.each do |c|
-        @@buf.push(c)
+        @buf.push(c)
       end
     rescue EOFError
     end
   end
 
-  def self.get_screen_size
-    s = @@input.winsize
+  def get_screen_size
+    s = @input.winsize
     return s if s[0] > 0 && s[1] > 0
     s = [ENV["LINES"].to_i, ENV["COLUMNS"].to_i]
     return s if s[0] > 0 && s[1] > 0
@@ -239,20 +238,20 @@ class Reline::ANSI
     [24, 80]
   end
 
-  def self.set_screen_size(rows, columns)
-    @@input.winsize = [rows, columns]
+  def set_screen_size(rows, columns)
+    @input.winsize = [rows, columns]
     self
-  rescue Errno::ENOTTY
+  rescue Errno::ENOTTY, Errno::ENODEV
     self
   end
 
-  def self.cursor_pos
-    begin
+  def cursor_pos
+    if both_tty?
       res = +''
       m = nil
-      @@input.raw do |stdin|
-        @@output << "\e[6n"
-        @@output.flush
+      @input.raw do |stdin|
+        @output << "\e[6n"
+        @output.flush
         loop do
           c = stdin.getc
           next if c.nil?
@@ -266,9 +265,9 @@ class Reline::ANSI
       end
       column = m[:column].to_i - 1
       row = m[:row].to_i - 1
-    rescue Errno::ENOTTY
+    else
       begin
-        buf = @@output.pread(@@output.pos, 0)
+        buf = @output.pread(@output.pos, 0)
         row = buf.count("\n")
         column = buf.rindex("\n") ? (buf.size - buf.rindex("\n")) - 1 : 0
       rescue Errno::ESPIPE, IOError
@@ -281,82 +280,85 @@ class Reline::ANSI
     Reline::CursorPos.new(column, row)
   end
 
-  def self.move_cursor_column(x)
-    @@output.write "\e[#{x + 1}G"
+  def both_tty?
+    @input.tty? && @output.tty?
+  end
+
+  def move_cursor_column(x)
+    @output.write "\e[#{x + 1}G"
   end
 
-  def self.move_cursor_up(x)
+  def move_cursor_up(x)
     if x > 0
-      @@output.write "\e[#{x}A"
+      @output.write "\e[#{x}A"
     elsif x < 0
       move_cursor_down(-x)
     end
   end
 
-  def self.move_cursor_down(x)
+  def move_cursor_down(x)
     if x > 0
-      @@output.write "\e[#{x}B"
+      @output.write "\e[#{x}B"
     elsif x < 0
       move_cursor_up(-x)
     end
   end
 
-  def self.hide_cursor
+  def hide_cursor
+    seq = "\e[?25l"
     if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
       begin
-        @@output.write Reline::Terminfo.tigetstr('civis')
+        seq = Reline::Terminfo.tigetstr('civis')
       rescue Reline::Terminfo::TerminfoError
         # civis is undefined
       end
-    else
-      # ignored
     end
+    @output.write seq
   end
 
-  def self.show_cursor
+  def show_cursor
+    seq = "\e[?25h"
     if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
       begin
-        @@output.write Reline::Terminfo.tigetstr('cnorm')
+        seq = Reline::Terminfo.tigetstr('cnorm')
       rescue Reline::Terminfo::TerminfoError
         # cnorm is undefined
       end
-    else
-      # ignored
     end
+    @output.write seq
   end
 
-  def self.erase_after_cursor
-    @@output.write "\e[K"
+  def erase_after_cursor
+    @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)
+  def scroll_down(x)
     return if x.zero?
     # We use `\n` instead of CSI + S because CSI + S would cause https://github.com/ruby/reline/issues/576
-    @@output.write "\n" * x
+    @output.write "\n" * x
   end
 
-  def self.clear_screen
-    @@output.write "\e[2J"
-    @@output.write "\e[1;1H"
+  def clear_screen
+    @output.write "\e[2J"
+    @output.write "\e[1;1H"
   end
 
-  @@old_winch_handler = nil
-  def self.set_winch_handler(&handler)
-    @@old_winch_handler = Signal.trap('WINCH', &handler)
+  def set_winch_handler(&handler)
+    @old_winch_handler = Signal.trap('WINCH', &handler)
   end
 
-  def self.prep
+  def prep
     # Enable bracketed paste
-    @@output.write "\e[?2004h" if Reline.core.config.enable_bracketed_paste
+    @output.write "\e[?2004h" if Reline.core.config.enable_bracketed_paste && both_tty?
     retrieve_keybuffer
     nil
   end
 
-  def self.deprep(otio)
+  def deprep(otio)
     # Disable bracketed paste
-    @@output.write "\e[?2004l" if Reline.core.config.enable_bracketed_paste
-    Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler
+    @output.write "\e[?2004l" if Reline.core.config.enable_bracketed_paste && both_tty?
+    Signal.trap('WINCH', @old_winch_handler) if @old_winch_handler
   end
 end

data/lib/reline/io/dumb.rb

@@ -0,0 +1,106 @@
+require 'io/wait'
+
+class Reline::Dumb < Reline::IO
+  RESET_COLOR = '' # Do not send color reset sequence
+
+  def initialize(encoding: nil)
+    @input = STDIN
+    @buf = []
+    @pasting = false
+    @encoding = encoding
+    @screen_size = [24, 80]
+  end
+
+  def dumb?
+    true
+  end
+
+  def encoding
+    if @encoding
+      @encoding
+    elsif RUBY_PLATFORM =~ /mswin|mingw/
+      Encoding::UTF_8
+    else
+      Encoding::default_external
+    end
+  end
+
+  def set_default_key_bindings(_)
+  end
+
+  def input=(val)
+    @input = val
+  end
+
+  def with_raw_input
+    yield
+  end
+
+  def getc(_timeout_second)
+    unless @buf.empty?
+      return @buf.shift
+    end
+    c = nil
+    loop do
+      Reline.core.line_editor.handle_signal
+      result = @input.wait_readable(0.1)
+      next if result.nil?
+      c = @input.read(1)
+      break
+    end
+    c&.ord
+  end
+
+  def ungetc(c)
+    @buf.unshift(c)
+  end
+
+  def get_screen_size
+    @screen_size
+  end
+
+  def cursor_pos
+    Reline::CursorPos.new(1, 1)
+  end
+
+  def hide_cursor
+  end
+
+  def show_cursor
+  end
+
+  def move_cursor_column(val)
+  end
+
+  def move_cursor_up(val)
+  end
+
+  def move_cursor_down(val)
+  end
+
+  def erase_after_cursor
+  end
+
+  def scroll_down(val)
+  end
+
+  def clear_screen
+  end
+
+  def set_screen_size(rows, columns)
+    @screen_size = [rows, columns]
+  end
+
+  def set_winch_handler(&handler)
+  end
+
+  def in_pasting?
+    @pasting
+  end
+
+  def prep
+  end
+
+  def deprep(otio)
+  end
+end