reline 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d28ea6c28099d6ee05888e139f26785b7f524b2d43b97169a262d3039fe4b12d
-  data.tar.gz: c929cedf8040597cdaf6d19ab14aa6724cf4b47dbf4c78b6a1fc2e74637bfc09
+  metadata.gz: cb0a1da0d5f51d50b82a78a3084a69ca37821b541e3c362bcb2b9a10a04664a3
+  data.tar.gz: bc1860cf76efa34984aef1dbafb60d1f7781b86ba44a9392dc5fbd8025631121
 SHA512:
-  metadata.gz: f9c4c8c540077105e8c326dd7ee0de350dbf8cd7a0aba14ad467f28b2dbb9c52eade5601e56ada651d2ea6f713e2a47891545bccdd9ea11c43d01dfe315fdd27
-  data.tar.gz: 7e8a2c186e0b4c84e3a7ddc62ab08dce768d1ea768ffc91bcf880e0227bb003c2b8fa288e45044cf1ab73144bd7ec46e9ac0faa582721acaf55726fc111706d4
+  metadata.gz: 4691bf1855429c5f1c25b16f66bc1e4793290579ae9a7345d1dd97c2694863bec59bab30edb232665b38a1f302a4e601c99111c84e5c277651ab2e53d4353982
+  data.tar.gz: 9ba7b27a82ce1d823f394c78ba1d995b6c4f71ddecb13c17c27fb39a13b7503c3b84402feb0239eb33d19d87f00d06c0608e35439413f6c72d2bdea50e84d10e

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
@@ -45,40 +46,44 @@ module Reline
       @completion_quote_character = nil
     end
 
+    def encoding
+      Reline::IOGate.encoding
+    end
+
     def completion_append_character=(val)
       if val.nil?
         @completion_append_character = nil
       elsif val.size == 1
-        @completion_append_character = val.encode(Encoding::default_external)
+        @completion_append_character = val.encode(Reline::IOGate.encoding)
       elsif val.size > 1
-        @completion_append_character = val[0].encode(Encoding::default_external)
+        @completion_append_character = val[0].encode(Reline::IOGate.encoding)
       else
         @completion_append_character = nil
       end
     end
 
     def basic_word_break_characters=(v)
-      @basic_word_break_characters = v.encode(Encoding::default_external)
+      @basic_word_break_characters = v.encode(Reline::IOGate.encoding)
     end
 
     def completer_word_break_characters=(v)
-      @completer_word_break_characters = v.encode(Encoding::default_external)
+      @completer_word_break_characters = v.encode(Reline::IOGate.encoding)
     end
 
     def basic_quote_characters=(v)
-      @basic_quote_characters = v.encode(Encoding::default_external)
+      @basic_quote_characters = v.encode(Reline::IOGate.encoding)
     end
 
     def completer_quote_characters=(v)
-      @completer_quote_characters = v.encode(Encoding::default_external)
+      @completer_quote_characters = v.encode(Reline::IOGate.encoding)
     end
 
     def filename_quote_characters=(v)
-      @filename_quote_characters = v.encode(Encoding::default_external)
+      @filename_quote_characters = v.encode(Reline::IOGate.encoding)
     end
 
     def special_prefixes=(v)
-      @special_prefixes = v.encode(Encoding::default_external)
+      @special_prefixes = v.encode(Reline::IOGate.encoding)
     end
 
     def completion_case_fold=(v)
@@ -94,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
 
@@ -118,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
 
@@ -171,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
 
@@ -184,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?
@@ -201,7 +206,7 @@ module Reline
       otio = Reline::IOGate.prep
 
       may_req_ambiguous_char_width
-      line_editor.reset(prompt)
+      line_editor.reset(prompt, encoding: Reline::IOGate.encoding)
       if multiline
         line_editor.multiline_on
         if block_given?
@@ -218,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
@@ -228,6 +232,8 @@ module Reline
         end
       end
 
+      line_editor.rerender
+
       begin
         loop do
           read_io(config.keyseq_timeout) { |inputs|
@@ -239,6 +245,8 @@ module Reline
           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)
@@ -332,8 +340,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)
-      print "\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
@@ -387,11 +401,15 @@ module Reline
   def_instance_delegators self, :readmultiline
   private :readmultiline
 
+  def self.encoding_system_needs
+    self.core.encoding
+  end
+
   def self.core
     @core ||= Core.new { |core|
       core.config = Reline::Config.new
       core.key_stroke = Reline::KeyStroke.new(core.config)
-      core.line_editor = Reline::LineEditor.new(core.config)
+      core.line_editor = Reline::LineEditor.new(core.config, Reline::IOGate.encoding)
 
       core.basic_word_break_characters = " \t\n`><=;|&{("
       core.completer_word_break_characters = " \t\n`><=;|&{("
@@ -405,14 +423,11 @@ module Reline
   def self.line_editor
     core.line_editor
   end
-
-  HISTORY = History.new(core.config)
 end
 
 if RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
   require 'reline/windows'
-  if Reline::Windows.get_screen_size == [0, 0]
-    # Maybe Mintty on Cygwin
+  if Reline::Windows.msys_tty?
     require 'reline/ansi'
     Reline::IOGate = Reline::ANSI
   else
@@ -422,4 +437,5 @@ else
   require 'reline/ansi'
   Reline::IOGate = Reline::ANSI
 end
+Reline::HISTORY = Reline::History.new(Reline.core.config)
 require 'reline/general_io'

data/lib/reline/ansi.rb

@@ -1,20 +1,59 @@
 require 'io/console'
 
 class Reline::ANSI
+  def self.encoding
+    Encoding.default_external
+  end
+
+  def self.win?
+    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,        # ←
-    [27, 91, 51, 126] => :key_delete,     # Del
-    [27, 91, 49, 126] => :ed_move_to_beg, # Home
-    [27, 91, 52, 126] => :ed_move_to_end, # End
+
+    # 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,        # ←
   }
 
   @@input = STDIN
@@ -32,8 +71,13 @@ 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.ungetc(c)
@@ -41,16 +85,23 @@ class Reline::ANSI
   end
 
   def self.retrieve_keybuffer
+    begin
       result = select([@@input], [], [], 0.001)
       return if result.nil?
       str = @@input.read_nonblock(1024)
       str.bytes.each do |c|
         @@buf.push(c)
       end
+    rescue EOFError
+    end
   end
 
   def self.get_screen_size
-    @@input.winsize
+    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
+    [24, 80]
   rescue Errno::ENOTTY
     [24, 80]
   end
@@ -69,10 +120,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
@@ -80,20 +134,27 @@ 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
 
   def self.move_cursor_column(x)
-    print "\e[#{x + 1}G"
+    @@output.write "\e[#{x + 1}G"
   end
 
   def self.move_cursor_up(x)
     if x > 0
-      print "\e[#{x}A" if x > 0
+      @@output.write "\e[#{x}A" if x > 0
     elsif x < 0
       move_cursor_down(-x)
     end
@@ -101,24 +162,24 @@ class Reline::ANSI
 
   def self.move_cursor_down(x)
     if x > 0
-      print "\e[#{x}B" if x > 0
+      @@output.write "\e[#{x}B" if x > 0
     elsif x < 0
       move_cursor_up(-x)
     end
   end
 
   def self.erase_after_cursor
-    print "\e[K"
+    @@output.write "\e[K"
   end
 
   def self.scroll_down(x)
     return if x.zero?
-    print "\e[#{x}S"
+    @@output.write "\e[#{x}S"
   end
 
   def self.clear_screen
-    print "\e[2J"
-    print "\e[1;1H"
+    @@output.write "\e[2J"
+    @@output.write "\e[1;1H"
   end
 
   @@old_winch_handler = nil

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
@@ -184,9 +214,12 @@ class Reline::Config
 
   def bind_variable(name, value)
     case name
-    when *VARIABLE_NAMES then
-      variable_name = :"@#{name.tr(?-, ?_)}"
-      instance_variable_set(variable_name, value.nil? || value == '1' || value == 'on')
+    when 'history-size'
+      begin
+        @history_size = Integer(value)
+      rescue ArgumentError
+        @history_size = 500
+      end
     when 'bell-style'
       @bell_style =
         case value
@@ -225,6 +258,32 @@ 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