reline 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e100afbceacfa4a270221c7e5158f211dc9972efbbec251108661a380d43b1
-  data.tar.gz: 051ef05dac8d446be2b0268202da3762d702287650dc05a3041aa7910f481624
+  metadata.gz: 89f055454b502262f43495a2d8de12ba033259287a4c09e7c93afeb0462c9c33
+  data.tar.gz: 6c6f081e14d699faed9ac7ba08001dac978318535f58458fd2c777db56b57b50
 SHA512:
-  metadata.gz: '0068601561915d76b2ce265c7de49252941dbe1e57464db9b08876dfd49da6fc12c3821d90d8240b4f64728a4a55a469726233689fa077ef7296796495025295'
-  data.tar.gz: 4385616c29cba0596c84d98219d658361cae3dc8c9427e8460d1703972995a9adcb242ab252c30fe2abcf712d2d824a4cb41691b44e241a9d711a89da3e0d62d
+  metadata.gz: 6bd17793312ff9f2996ce08ebada091005c7efd9ff1d0ef007ea982ee5e74ee03a83fb0bb7c975c6da747db712a3837d14c108fd7de087094f1db37e051876aa
+  data.tar.gz: 148dd6767b1aae9a295d334445957b64e6f6a46b8941a10517e5d4567a29eac369fe3843c6c8c1bb5fd66d1165c82988316b030eb05080517bb7105bc5174281

data/README.md

@@ -1,5 +1,9 @@
 [![Build Status](https://travis-ci.com/ruby/reline.svg?branch=master)](https://travis-ci.com/ruby/reline)
 
+This is a screen capture of *IRB improved by Reline*.
+
+![IRB improved by Reline](https://raw.githubusercontent.com/wiki/ruby/reline/images/irb_improved_by_reline.gif)
+
 # Reline
 
 Reline is compatible with the API of Ruby's stdlib 'readline', GNU Readline and Editline by pure Ruby implementation.

data/lib/reline.rb

@@ -7,6 +7,7 @@ require 'reline/key_actor'
 require 'reline/key_stroke'
 require 'reline/line_editor'
 require 'reline/history'
+require 'rbconfig'
 
 module Reline
   FILENAME_COMPLETION_PROC = nil
@@ -98,22 +99,22 @@ module Reline
     end
 
     def completion_proc=(p)
-      raise ArgumentError unless p.respond_to?(:call)
+      raise ArgumentError unless p.respond_to?(:call) or p.nil?
       @completion_proc = p
     end
 
     def output_modifier_proc=(p)
-      raise ArgumentError unless p.respond_to?(:call)
+      raise ArgumentError unless p.respond_to?(:call) or p.nil?
       @output_modifier_proc = p
     end
 
     def prompt_proc=(p)
-      raise ArgumentError unless p.respond_to?(:call)
+      raise ArgumentError unless p.respond_to?(:call) or p.nil?
       @prompt_proc = p
     end
 
     def auto_indent_proc=(p)
-      raise ArgumentError unless p.respond_to?(:call)
+      raise ArgumentError unless p.respond_to?(:call) or p.nil?
       @auto_indent_proc = p
     end
 
@@ -122,7 +123,7 @@ module Reline
     end
 
     def dig_perfect_match_proc=(p)
-      raise ArgumentError unless p.respond_to?(:call)
+      raise ArgumentError unless p.respond_to?(:call) or p.nil?
       @dig_perfect_match_proc = p
     end
 
@@ -175,7 +176,7 @@ module Reline
 
       whole_buffer = line_editor.whole_buffer.dup
       whole_buffer.taint if RUBY_VERSION < '2.7'
-      if add_hist and whole_buffer and whole_buffer.chomp.size > 0
+      if add_hist and whole_buffer and whole_buffer.chomp("\n").size > 0
         Reline::HISTORY << whole_buffer
       end
 
@@ -188,8 +189,8 @@ module Reline
 
       line = line_editor.line.dup
       line.taint if RUBY_VERSION < '2.7'
-      if add_hist and line and line.chomp.size > 0
-        Reline::HISTORY << line.chomp
+      if add_hist and line and line.chomp("\n").size > 0
+        Reline::HISTORY << line.chomp("\n")
       end
 
       line_editor.reset_line if line_editor.line.nil?
@@ -222,7 +223,6 @@ module Reline
       line_editor.auto_indent_proc = auto_indent_proc
       line_editor.dig_perfect_match_proc = dig_perfect_match_proc
       line_editor.pre_input_hook = pre_input_hook
-      line_editor.rerender
 
       unless config.test_mode
         config.read
@@ -232,17 +232,27 @@ module Reline
         end
       end
 
+      line_editor.rerender
+
       begin
+        prev_pasting_state = false
         loop do
+          prev_pasting_state = Reline::IOGate.in_pasting?
           read_io(config.keyseq_timeout) { |inputs|
             inputs.each { |c|
               line_editor.input_key(c)
               line_editor.rerender
             }
           }
+          if prev_pasting_state == true and not Reline::IOGate.in_pasting? and not line_editor.finished?
+            prev_pasting_state = false
+            line_editor.rerender_all
+          end
           break if line_editor.finished?
         end
         Reline::IOGate.move_cursor_column(0)
+      rescue Errno::EIO
+        # Maybe the I/O has been closed.
       rescue StandardError => e
         line_editor.finalize
         Reline::IOGate.deprep(otio)
@@ -336,8 +346,14 @@ module Reline
       @ambiguous_width = 2 if Reline::IOGate == Reline::GeneralIO or STDOUT.is_a?(File)
       return if ambiguous_width
       Reline::IOGate.move_cursor_column(0)
-      output.write "\u{25bd}"
-      @ambiguous_width = Reline::IOGate.cursor_pos.x
+      begin
+        output.write "\u{25bd}"
+      rescue Encoding::UndefinedConversionError
+        # LANG=C
+        @ambiguous_width = 1
+      else
+        @ambiguous_width = Reline::IOGate.cursor_pos.x
+      end
       Reline::IOGate.move_cursor_column(0)
       Reline::IOGate.erase_after_cursor
     end

data/lib/reline/ansi.rb

@@ -28,12 +28,22 @@ class Reline::ANSI
     [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
@@ -61,8 +71,29 @@ class Reline::ANSI
     unless @@buf.empty?
       return @@buf.shift
     end
-    c = @@input.raw(intr: true, &:getbyte)
+    until c = @@input.raw(intr: true, &:getbyte)
+      sleep 0.1
+    end
     (c == 0x16 && @@input.raw(min: 0, tim: 0, &:getbyte)) || c
+  rescue Errno::EIO
+    # Maybe the I/O has been closed.
+    nil
+  end
+
+  def self.in_pasting?
+    not Reline::IOGate.empty_buffer?
+  end
+
+  def self.empty_buffer?
+    unless @@buf.empty?
+      return false
+    end
+    rs, = IO.select([@@input], [], [], 0.00001)
+    if rs and rs[0]
+      false
+    else
+      true
+    end
   end
 
   def self.ungetc(c)
@@ -105,10 +136,13 @@ class Reline::ANSI
       @@input.raw do |stdin|
         @@output << "\e[6n"
         @@output.flush
-        while (c = stdin.getc) != 'R'
-          res << c if c
+        loop do
+          c = stdin.getc
+          next if c.nil?
+          res << c
+          m = res.match(/\e\[(?<row>\d+);(?<column>\d+)R/)
+          break if m
         end
-        m = res.match(/\e\[(?<row>\d+);(?<column>\d+)/)
         (m.pre_match + m.post_match).chars.reverse_each do |ch|
           stdin.ungetc ch
         end
@@ -116,9 +150,16 @@ class Reline::ANSI
       column = m[:column].to_i - 1
       row = m[:row].to_i - 1
     rescue Errno::ENOTTY
-      buf = @@output.pread(@@output.pos, 0)
-      row = buf.count("\n")
-      column = buf.rindex("\n") ? (buf.size - buf.rindex("\n")) - 1 : 0
+      begin
+        buf = @@output.pread(@@output.pos, 0)
+        row = buf.count("\n")
+        column = buf.rindex("\n") ? (buf.size - buf.rindex("\n")) - 1 : 0
+      rescue Errno::ESPIPE
+        # Just returns column 1 for ambiguous width because this I/O is not
+        # tty and can't seek.
+        row = 0
+        column = 1
+      end
     end
     Reline::CursorPos.new(column, row)
   end

data/lib/reline/config.rb

@@ -1,10 +1,6 @@
-require 'pathname'
-
 class Reline::Config
   attr_reader :test_mode
 
-  DEFAULT_PATH = '~/.inputrc'
-
   KEYSEQ_PATTERN = /\\(?:C|Control)-[A-Za-z_]|\\(?:M|Meta)-[0-9A-Za-z_]|\\(?:C|Control)-(?:M|Meta)-[A-Za-z_]|\\(?:M|Meta)-(?:C|Control)-[A-Za-z_]|\\e|\\[\\\"\'abdfnrtv]|\\\d{1,3}|\\x\h{1,2}|./
 
   class InvalidInputrc < RuntimeError
@@ -37,6 +33,10 @@ class Reline::Config
     show-all-if-ambiguous
     show-all-if-unmodified
     visible-stats
+    show-mode-in-prompt
+    vi-cmd-mode-icon
+    vi-ins-mode-icon
+    emacs-mode-string
   }
   VARIABLE_NAME_SYMBOLS = VARIABLE_NAMES.map { |v| :"#{v.tr(?-, ?_)}" }
   VARIABLE_NAME_SYMBOLS.each do |v|
@@ -54,7 +54,11 @@ class Reline::Config
     @key_actors[:emacs] = Reline::KeyActor::Emacs.new
     @key_actors[:vi_insert] = Reline::KeyActor::ViInsert.new
     @key_actors[:vi_command] = Reline::KeyActor::ViCommand.new
-    @history_size = 500
+    @vi_cmd_mode_icon = '(cmd)'
+    @vi_ins_mode_icon = '(ins)'
+    @emacs_mode_string = '@'
+    # https://tiswww.case.edu/php/chet/readline/readline.html#IDX25
+    @history_size = -1 # unlimited
     @keyseq_timeout = 500
     @test_mode = false
   end
@@ -83,8 +87,34 @@ class Reline::Config
     @key_actors[@keymap_label]
   end
 
+  def inputrc_path
+    case ENV['INPUTRC']
+    when nil, ''
+    else
+      return File.expand_path(ENV['INPUTRC'])
+    end
+
+    # In the XDG Specification, if ~/.config/readline/inputrc exists, then
+    # ~/.inputrc should not be read, but for compatibility with GNU Readline,
+    # if ~/.inputrc exists, then it is given priority.
+    home_rc_path = File.expand_path('~/.inputrc')
+    return home_rc_path if File.exist?(home_rc_path)
+
+    case path = ENV['XDG_CONFIG_HOME']
+    when nil, ''
+    else
+      path = File.join(path, 'readline/inputrc')
+      return path if File.exist?(path) and path == File.expand_path(path)
+    end
+
+    path = File.expand_path('~/.config/readline/inputrc')
+    return path if File.exist?(path)
+
+    return home_rc_path
+  end
+
   def read(file = nil)
-    file ||= File.expand_path(ENV['INPUTRC'] || DEFAULT_PATH)
+    file ||= inputrc_path
     begin
       if file.respond_to?(:readlines)
         lines = file.readlines
@@ -135,7 +165,7 @@ class Reline::Config
 
       case line
       when /^set +([^ ]+) +([^ ]+)/i
-        var, value = $1.downcase, $2.downcase
+        var, value = $1.downcase, $2
         bind_variable(var, value)
         next
       when /\s*("#{KEYSEQ_PATTERN}+")\s*:\s*(.*)\s*$/o
@@ -185,7 +215,11 @@ class Reline::Config
   def bind_variable(name, value)
     case name
     when 'history-size'
-      @history_size = value.to_i
+      begin
+        @history_size = Integer(value)
+      rescue ArgumentError
+        @history_size = 500
+      end
     when 'bell-style'
       @bell_style =
         case value
@@ -224,12 +258,35 @@ class Reline::Config
       end
     when 'keyseq-timeout'
       @keyseq_timeout = value.to_i
+    when 'show-mode-in-prompt'
+      case value
+      when 'off'
+        @show_mode_in_prompt = false
+      when 'on'
+        @show_mode_in_prompt = true
+      else
+        @show_mode_in_prompt = false
+      end
+    when 'vi-cmd-mode-string'
+      @vi_cmd_mode_icon = retrieve_string(value)
+    when 'vi-ins-mode-string'
+      @vi_ins_mode_icon = retrieve_string(value)
+    when 'emacs-mode-string'
+      @emacs_mode_string = retrieve_string(value)
     when *VARIABLE_NAMES then
       variable_name = :"@#{name.tr(?-, ?_)}"
       instance_variable_set(variable_name, value.nil? || value == '1' || value == 'on')
     end
   end
 
+  def retrieve_string(str)
+    if str =~ /\A"(.*)"\z/
+      parse_keyseq($1).map(&:chr).join
+    else
+      parse_keyseq(str).map(&:chr).join
+    end
+  end
+
   def bind_key(key, func_name)
     if key =~ /\A"(.*)"\z/
       keyseq = parse_keyseq($1)

data/lib/reline/general_io.rb

@@ -1,6 +1,10 @@
 require 'timeout'
 
 class Reline::GeneralIO
+  def self.reset
+    @@pasting = false
+  end
+
   def self.encoding
     RUBY_PLATFORM =~ /mswin|mingw/ ? Encoding::UTF_8 : Encoding::default_external
   end
@@ -67,6 +71,20 @@ class Reline::GeneralIO
   def self.set_winch_handler(&handler)
   end
 
+  @@pasting = false
+
+  def self.in_pasting?
+    @@pasting
+  end
+
+  def self.start_pasting
+    @@pasting = true
+  end
+
+  def self.finish_pasting
+    @@pasting = false
+  end
+
   def self.prep
   end
 

data/lib/reline/history.rb

@@ -29,27 +29,47 @@ class Reline::History < Array
   end
 
   def push(*val)
-    diff = size + val.size - @config.history_size
-    if diff > 0
-      if diff <= size
-        shift(diff)
-      else
-        diff -= size
-        clear
-        val.shift(diff)
+    # If history_size is zero, all histories are dropped.
+    return self if @config.history_size.zero?
+    # If history_size is negative, history size is unlimited.
+    if @config.history_size.positive?
+      diff = size + val.size - @config.history_size
+      if diff > 0
+        if diff <= size
+          shift(diff)
+        else
+          diff -= size
+          clear
+          val.shift(diff)
+        end
       end
     end
-    super(*(val.map{ |v| String.new(v, encoding: Reline.encoding_system_needs) }))
+    super(*(val.map{ |v|
+      String.new(v, encoding: Reline.encoding_system_needs)
+    }))
   end
 
   def <<(val)
-    shift if size + 1 > @config.history_size
+    # If history_size is zero, all histories are dropped.
+    return self if @config.history_size.zero?
+    # If history_size is negative, history size is unlimited.
+    if @config.history_size.positive?
+      shift if size + 1 > @config.history_size
+    end
     super(String.new(val, encoding: Reline.encoding_system_needs))
   end
 
   private def check_index(index)
     index += size if index < 0
-    raise RangeError.new("index=<#{index}>") if index < -@config.history_size or @config.history_size < index
+    if index < -2147483648 or 2147483647 < index
+      raise RangeError.new("integer #{index} too big to convert to `int'")
+    end
+    # If history_size is negative, history size is unlimited.
+    if @config.history_size.positive?
+      if index < -@config.history_size or @config.history_size < index
+        raise RangeError.new("index=<#{index}>")
+      end
+    end
     raise IndexError.new("index=<#{index}>") if index < 0 or size <= index
     index
   end

data/lib/reline/key_actor/emacs.rb

@@ -37,9 +37,9 @@ class Reline::KeyActor::Emacs < Reline::KeyActor::Base
     #  17 ^Q
     :ed_quoted_insert,
     #  18 ^R
-    :ed_search_prev_history,
+    :vi_search_prev,
     #  19 ^S
-    :ed_search_next_history,
+    :vi_search_next,
     #  20 ^T
     :ed_transpose_chars,
     #  21 ^U
@@ -413,11 +413,11 @@ class Reline::KeyActor::Emacs < Reline::KeyActor::Base
     # 205 M-M
     :ed_unassigned,
     # 206 M-N
-    :ed_search_next_history,
+    :vi_search_next,
     # 207 M-O
     :ed_sequence_lead_in,
     # 208 M-P
-    :ed_search_prev_history,
+    :vi_search_prev,
     # 209 M-Q
     :ed_unassigned,
     # 210 M-R
@@ -477,11 +477,11 @@ class Reline::KeyActor::Emacs < Reline::KeyActor::Base
     # 237 M-m
     :ed_unassigned,
     # 238 M-n
-    :ed_search_next_history,
+    :vi_search_next,
     # 239 M-o
     :ed_unassigned,
     # 240 M-p
-    :ed_search_prev_history,
+    :vi_search_prev,
     # 241 M-q
     :ed_unassigned,
     # 242 M-r