reline 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1da0f8ec80f16c720589413fbc14c02ac199dcfc0b0344270a61edbad4aec966
-  data.tar.gz: d214e02ad3500323e98d97d57677b7bbc94ea4c09df0b529d5b21ea66374a6a8
+  metadata.gz: 1009c9156a8c15c1f3c64a3cb89a0d6a1acef037185bfb76c24ed9df7e49cb2c
+  data.tar.gz: 983ad1d570617a47d732402485a79eba8bd1acc6f3555f117ca6822cee52030d
 SHA512:
-  metadata.gz: 0d218a92032ad8b02218e44bda7fe7d7404845f6cc9cceb9aade01d3c49bc33a0396b02857de417ecee59b5d65c0cb787eecec8dea60180ae3b5457df6c89ebd
-  data.tar.gz: 12c4b8d00608e1f9f16a1c5e530ae86c7530f39ddb1c0f6100b1d4ae87a6dbd53def15d9f387941062aafdb57360fd499dc5850a5bd60d07776daf60e057acfe
+  metadata.gz: 424c026623c896ccd59fed73b5f61e7bb067dfdc8fe34a13bdb317895fb512eb666b25c76439e940915307e658e85dbbfcb8339ecfae5c5b72fa9239d1599778
+  data.tar.gz: 93077ced9c8009d5c2f7f59eb013f8134394347c57660e7958244a2adfe60b2a09463ac2062d9ce31e5d75974b19665f7e800f2078bf9b461dfbada76c3e572e

data/README.md

@@ -8,6 +8,52 @@ This is a screen capture of *IRB improved by Reline*.
 
 Reline is compatible with the API of Ruby's stdlib 'readline', GNU Readline and Editline by pure Ruby implementation.
 
+## Usage
+
+### Single line editing mode
+
+It's compatible with the readline standard library.
+
+See [the document of readline stdlib](https://ruby-doc.org/stdlib/libdoc/readline/rdoc/Readline.html) or [bin/example](https://github.com/ruby/reline/blob/master/bin/example).
+
+### Multi-line editing mode
+
+```ruby
+require "reline"
+
+prompt = 'prompt> '
+use_history = true
+
+begin
+  while true
+    text = Reline.readmultiline(prompt, use_history) do |multiline_input|
+      # Accept the input until `end` is entered
+      multiline_input.split.last == "end"
+    end
+
+    puts 'You entered:'
+    puts text
+  end
+# If you want to exit, type Ctrl-C
+rescue Interrupt
+  puts '^C'
+  exit 0
+end
+```
+
+```bash
+$ ruby example.rb
+prompt> aaa
+prompt> bbb
+prompt> end
+You entered:
+aaa
+bbb
+end
+```
+
+See also: [test/reline/yamatanooroti/multiline_repl](https://github.com/ruby/reline/blob/master/test/reline/yamatanooroti/multiline_repl)
+
 ## 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

@@ -1,7 +1,26 @@
 require 'io/console'
+require 'io/wait'
 require 'timeout'
+require_relative 'terminfo'
 
 class Reline::ANSI
+  CAPNAME_KEY_BINDINGS = {
+    'khome' => :ed_move_to_beg,
+    'kend'  => :ed_move_to_end,
+    'kcuu1' => :ed_prev_history,
+    '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,
+  }
+
+  if Reline::Terminfo.enabled?
+    Reline::Terminfo.setupterm(0, 2)
+  end
+
   def self.encoding
     Encoding.default_external
   end
@@ -10,52 +29,108 @@ class Reline::ANSI
     false
   end
 
-  RAW_KEYSTROKE_CONFIG = {
-    # 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
-    [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,     # ↓
-    [27, 71, 67] => :ed_next_char,        # →
-    [27, 71, 68] => :ed_prev_char,        # ←
-
-    # urxvt / exoterm
-    [27, 91, 55, 126] => :ed_move_to_beg, # Home
-    [27, 91, 56, 126] => :ed_move_to_end, # End
-
-    # GNOME
-    [27, 79, 72] => :ed_move_to_beg,      # Home
-    [27, 79, 70] => :ed_move_to_end,      # End
-    # Del is 0x08
-    # Arrow keys are the same of KDE
-
-    # iTerm2
-    [27, 27, 91, 67] => :em_next_word,    # Option+→
-    [27, 27, 91, 68] => :ed_prev_word,    # Option+←
-    [195, 166] => :em_next_word,          # Option+f
-    [195, 162] => :ed_prev_word,          # Option+b
-
-    # others
-    [27, 32] => :em_set_mark,             # M-<space>
-    [24, 24] => :em_exchange_mark,        # C-x C-x TODO also add Windows
-    [27, 91, 49, 59, 53, 67] => :em_next_word, # Ctrl+→
-    [27, 91, 49, 59, 53, 68] => :ed_prev_word, # Ctrl+←
-
-    [27, 79, 65] => :ed_prev_history,     # ↑
-    [27, 79, 66] => :ed_next_history,     # ↓
-    [27, 79, 67] => :ed_next_char,        # →
-    [27, 79, 68] => :ed_prev_char,        # ←
-  }
+  def self.set_default_key_bindings(config)
+    if 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|
+      config.add_default_key_binding_by_keymap(:emacs, key, func)
+      config.add_default_key_binding_by_keymap(:vi_insert, key, func)
+    end
+    {
+      # default bindings
+      [27, 32] => :em_set_mark,             # M-<space>
+      [24, 24] => :em_exchange_mark,        # C-x C-x
+    }.each_pair do |key, func|
+      config.add_default_key_binding_by_keymap(:emacs, key, func)
+    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
+      rescue Reline::Terminfo::TerminfoError
+        # capname is undefined
+      end
+    end.compact.to_h
+
+    key_bindings.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
+  end
+
+  def self.set_default_key_bindings_comprehensive_list(config)
+    {
+      # 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
+      [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,     # ↓
+      [27, 71, 67] => :ed_next_char,        # →
+      [27, 71, 68] => :ed_prev_char,        # ←
+
+      # urxvt / exoterm
+      [27, 91, 55, 126] => :ed_move_to_beg, # Home
+      [27, 91, 56, 126] => :ed_move_to_end, # End
+
+      # GNOME
+      [27, 79, 72] => :ed_move_to_beg,      # Home
+      [27, 79, 70] => :ed_move_to_end,      # End
+      # 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,        # →
+      [27, 79, 68] => :ed_prev_char,        # ←
+    }.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
+  end
 
   @@input = STDIN
   def self.input=(val)
@@ -72,13 +147,15 @@ class Reline::ANSI
     unless @@buf.empty?
       return @@buf.shift
     end
-    until c = @@input.raw(intr: true, &:getbyte)
-      sleep 0.1
+    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
   rescue Errno::EIO
     # Maybe the I/O has been closed.
     nil
+  rescue Errno::ENOTTY
+    nil
   end
 
   @@in_bracketed_paste_mode = false
@@ -129,12 +206,7 @@ class Reline::ANSI
     unless @@buf.empty?
       return false
     end
-    rs, = IO.select([@@input], [], [], 0.00001)
-    if rs and rs[0]
-      false
-    else
-      true
-    end
+    !@@input.wait_readable(0)
   end
 
   def self.ungetc(c)
@@ -143,8 +215,7 @@ class Reline::ANSI
 
   def self.retrieve_keybuffer
     begin
-      result = select([@@input], [], [], 0.001)
-      return if result.nil?
+      return unless @@input.wait_readable(0.001)
       str = @@input.read_nonblock(1024)
       str.bytes.each do |c|
         @@buf.push(c)
@@ -211,7 +282,7 @@ class Reline::ANSI
 
   def self.move_cursor_up(x)
     if x > 0
-      @@output.write "\e[#{x}A" if x > 0
+      @@output.write "\e[#{x}A"
     elsif x < 0
       move_cursor_down(-x)
     end
@@ -219,12 +290,36 @@ class Reline::ANSI
 
   def self.move_cursor_down(x)
     if x > 0
-      @@output.write "\e[#{x}B" if x > 0
+      @@output.write "\e[#{x}B"
     elsif x < 0
       move_cursor_up(-x)
     end
   end
 
+  def self.hide_cursor
+    if Reline::Terminfo.enabled?
+      begin
+        @@output.write Reline::Terminfo.tigetstr('civis')
+      rescue Reline::Terminfo::TerminfoError
+        # civis is undefined
+      end
+    else
+      # ignored
+    end
+  end
+
+  def self.show_cursor
+    if Reline::Terminfo.enabled?
+      begin
+        @@output.write Reline::Terminfo.tigetstr('cnorm')
+      rescue Reline::Terminfo::TerminfoError
+        # cnorm is undefined
+      end
+    else
+      # ignored
+    end
+  end
+
   def self.erase_after_cursor
     @@output.write "\e[K"
   end
@@ -246,14 +341,10 @@ class Reline::ANSI
 
   def self.prep
     retrieve_keybuffer
-    int_handle = Signal.trap('INT', 'IGNORE')
-    Signal.trap('INT', int_handle)
     nil
   end
 
   def self.deprep(otio)
-    int_handle = Signal.trap('INT', 'IGNORE')
-    Signal.trap('INT', int_handle)
     Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler
   end
 end

data/lib/reline/config.rb

@@ -47,7 +47,10 @@ class Reline::Config
 
   def initialize
     @additional_key_bindings = {} # from inputrc
-    @default_key_bindings = {} # environment-dependent
+    @additional_key_bindings[:emacs] = {}
+    @additional_key_bindings[:vi_insert] = {}
+    @additional_key_bindings[:vi_command] = {}
+    @oneshot_key_bindings = {}
     @skip_section = nil
     @if_stack = nil
     @editing_mode_label = :emacs
@@ -63,14 +66,19 @@ class Reline::Config
     @history_size = -1 # unlimited
     @keyseq_timeout = 500
     @test_mode = false
+    @autocompletion = false
+    @convert_meta = true if seven_bit_encoding?(Reline::IOGate.encoding)
   end
 
   def reset
     if editing_mode_is?(:vi_command)
       @editing_mode_label = :vi_insert
     end
-    @additional_key_bindings = {}
-    @default_key_bindings = {}
+    @additional_key_bindings.keys.each do |key|
+      @additional_key_bindings[key].clear
+    end
+    @oneshot_key_bindings.clear
+    reset_default_key_bindings
   end
 
   def editing_mode
@@ -85,6 +93,14 @@ class Reline::Config
     (val.respond_to?(:any?) ? val : [val]).any?(@editing_mode_label)
   end
 
+  def autocompletion=(val)
+    @autocompletion = val
+  end
+
+  def autocompletion
+    @autocompletion
+  end
+
   def keymap
     @key_actors[@keymap_label]
   end
@@ -115,8 +131,12 @@ class Reline::Config
     return home_rc_path
   end
 
+  private def default_inputrc_path
+    @default_inputrc_path ||= inputrc_path
+  end
+
   def read(file = nil)
-    file ||= inputrc_path
+    file ||= default_inputrc_path
     begin
       if file.respond_to?(:readlines)
         lines = file.readlines
@@ -135,19 +155,46 @@ class Reline::Config
   end
 
   def key_bindings
-    # override @default_key_bindings with @additional_key_bindings
-    @default_key_bindings.merge(@additional_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
+  end
+
+  def add_oneshot_key_binding(keystroke, target)
+    @oneshot_key_bindings[keystroke] = target
+  end
+
+  def reset_oneshot_key_bindings
+    @oneshot_key_bindings.clear
+  end
+
+  def add_default_key_binding_by_keymap(keymap, keystroke, target)
+    @key_actors[keymap].default_key_bindings[keystroke] = target
   end
 
   def add_default_key_binding(keystroke, target)
-    @default_key_bindings[keystroke] = target
+    @key_actors[@keymap_label].default_key_bindings[keystroke] = target
   end
 
   def reset_default_key_bindings
-    @default_key_bindings = {}
+    @key_actors.values.each do |ka|
+      ka.reset_default_key_bindings
+    end
   end
 
   def read_lines(lines, file = nil)
+    if not lines.empty? and lines.first.encoding != Reline.encoding_system_needs
+      begin
+        lines = lines.map do |l|
+          l.encode(Reline.encoding_system_needs)
+        rescue Encoding::UndefinedConversionError
+          mes = "The inputrc encoded in #{lines.first.encoding.name} can't be converted to the locale #{Reline.encoding_system_needs.name}."
+          raise Reline::ConfigEncodingConversionError.new(mes)
+        end
+      end
+    end
     conditions = [@skip_section, @if_stack]
     @skip_section = nil
     @if_stack = []
@@ -174,7 +221,7 @@ class Reline::Config
         key, func_name = $1, $2
         keystroke, func = bind_key(key, func_name)
         next unless keystroke
-        @additional_key_bindings[keystroke] = func
+        @additional_key_bindings[@keymap_label][keystroke] = func
       end
     end
     unless @if_stack.empty?
@@ -282,11 +329,8 @@ class Reline::Config
   end
 
   def retrieve_string(str)
-    if str =~ /\A"(.*)"\z/
-      parse_keyseq($1).map(&:chr).join
-    else
-      parse_keyseq(str).map(&:chr).join
-    end
+    str = $1 if str =~ /\A"(.*)"\z/
+    parse_keyseq(str).map { |c| c.chr(Reline.encoding_system_needs) }.join
   end
 
   def bind_key(key, func_name)
@@ -344,4 +388,8 @@ class Reline::Config
     end
     ret
   end
+
+  private def seven_bit_encoding?(encoding)
+    encoding == Encoding::US_ASCII
+  end
 end

data/lib/reline/general_io.rb

@@ -1,21 +1,31 @@
 require 'timeout'
+require 'io/wait'
 
 class Reline::GeneralIO
-  def self.reset
+  def self.reset(encoding: nil)
     @@pasting = false
+    @@encoding = encoding
   end
 
   def self.encoding
-    RUBY_PLATFORM =~ /mswin|mingw/ ? Encoding::UTF_8 : Encoding::default_external
+    if defined?(@@encoding)
+      @@encoding
+    elsif RUBY_PLATFORM =~ /mswin|mingw/
+      Encoding::UTF_8
+    else
+      Encoding::default_external
+    end
   end
 
   def self.win?
     false
   end
 
-  RAW_KEYSTROKE_CONFIG = {}
+  def self.set_default_key_bindings(_)
+  end
 
   @@buf = []
+  @@input = STDIN
 
   def self.input=(val)
     @@input = val
@@ -27,7 +37,7 @@ class Reline::GeneralIO
     end
     c = nil
     loop do
-      result = select([@@input], [], [], 0.1)
+      result = @@input.wait_readable(0.1)
       next if result.nil?
       c = @@input.read(1)
       break

data/lib/reline/key_actor/base.rb

@@ -4,4 +4,16 @@ class Reline::KeyActor::Base
   def get_method(key)
     self.class::MAPPING[key]
   end
+
+  def initialize
+    @default_key_bindings = {}
+  end
+
+  def default_key_bindings
+    @default_key_bindings
+  end
+
+  def reset_default_key_bindings
+    @default_key_bindings.clear
+  end
 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
-    :em_kill_line,
+    :unix_line_discard,
     #  22 ^V
     :ed_quoted_insert,
     #  23 ^W

data/lib/reline/key_stroke.rb

@@ -1,38 +1,88 @@
 class Reline::KeyStroke
-  using Module.new {
-    refine Array do
-      def start_with?(other)
-        other.size <= size && other == self.take(other.size)
+  def initialize(config)
+    @config = config
+  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)
+      else
+        result << key
       end
+      result
+    }
+  end
 
-      def bytes
-        self
+  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
     end
-  }
+  end
 
-  def initialize(config)
-    @config = config
+  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
+      end
+    when Reline::Key
+      if other.is_a?(Integer)
+        me.combined_char == other
+      else
+        me == other
+      end
+    end
   end
 
   def match_status(input)
     key_mapping.keys.select { |lhs|
-      lhs.start_with? input
+      start_with?(lhs, input)
     }.tap { |it|
-      return :matched  if it.size == 1 && (it.max_by(&:size)&.size&.== input.size)
-      return :matching if it.size == 1 && (it.max_by(&:size)&.size&.!= input.size)
+      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|
-      input.start_with? lhs
+      start_with?(input, lhs)
     }.tap { |it|
       return it.size > 0 ? :matched : :unmatched
     }
   end
 
   def expand(input)
-    lhs = key_mapping.keys.select { |item| input.start_with? item }.sort_by(&:size).reverse.first
+    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]