reline 0.0.7 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 985d3ce68260542cce79b3d3291c29ca30ee82250e50089c2de7bb16f60d755d
-  data.tar.gz: d3444d9e894a66fd2a0e5be4fddd5d36b9b254f0aaff7ed1d590fec26c13b3f6
+  metadata.gz: 41e0f73e51def110f060454c69c3a3a29d3b0cedce2c432cc594df4f6cccf012
+  data.tar.gz: c47d69d20e28f8940c86eedba5349892ecf5e5745e83a8c701eab327e326c6ba
 SHA512:
-  metadata.gz: 9a5651134aeb6d0eba7e33b4fa6e85c2ac43677432a7b94e8aa24d1c9f05326126c81669aa297f9cb03bea7f92c2ee8600364205c8a8eafa7c6185441472f9d1
-  data.tar.gz: 63cc8b0b0b936e8ac1a490c9a1c849631b2c4c33c520eb2dd666b9b93b641417f3640542067de4f64ff2e28fd4dd883ed3821c7704bb82a64485ee52d5273c3b
+  metadata.gz: b494460955ab34ccf2e4c0443e76598c692d2846162be5081ecc8234181b47771721e5969fa76acd54bcce7f6d2c3dbc7e6469b23897c144c6233db5c08c915b
+  data.tar.gz: 7c0f5bd0caf7f79113b479e9785aa2260536356ff7196fa1d034fe669f60fca7078771575d8002edf18a5c256105e22d550d9b4e0382071e2c240ef0a34b0287

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

@@ -32,55 +32,69 @@ module Reline
       dig_perfect_match_proc
     ).each(&method(:attr_reader))
 
-    ATTR_ACCESSOR_NAMES = %i(
-      completion_case_fold
-    ).each(&method(:attr_accessor))
-
     attr_accessor :config
     attr_accessor :key_stroke
     attr_accessor :line_editor
     attr_accessor :ambiguous_width
+    attr_accessor :last_incremental_search
     attr_reader :output
 
     def initialize
       self.output = STDOUT
       yield self
+      @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)
+      @config.completion_ignore_case = v
+    end
+
+    def completion_case_fold
+      @config.completion_ignore_case
+    end
+
+    def completion_quote_character
+      @completion_quote_character
     end
 
     def completion_proc=(p)
@@ -161,7 +175,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
 
@@ -174,8 +188,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?
@@ -191,7 +205,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?
@@ -202,6 +216,7 @@ module Reline
       end
       line_editor.output = output
       line_editor.completion_proc = completion_proc
+      line_editor.completion_append_character = completion_append_character
       line_editor.output_modifier_proc = output_modifier_proc
       line_editor.prompt_proc = prompt_proc
       line_editor.auto_indent_proc = auto_indent_proc
@@ -321,8 +336,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
@@ -335,12 +356,14 @@ module Reline
   # Documented API
   #--------------------------------------------------------
 
-  (Core::ATTR_READER_NAMES + Core::ATTR_ACCESSOR_NAMES).each { |name|
+  (Core::ATTR_READER_NAMES).each { |name|
     def_single_delegators :core, "#{name}", "#{name}="
   }
   def_single_delegators :core, :input=, :output=
   def_single_delegators :core, :vi_editing_mode, :emacs_editing_mode
   def_single_delegators :core, :readline
+  def_single_delegators :core, :completion_case_fold, :completion_case_fold=
+  def_single_delegators :core, :completion_quote_character
   def_instance_delegators self, :readline
   private :readline
 
@@ -367,16 +390,22 @@ module Reline
   def_single_delegator :line_editor, :rerender, :redisplay
   def_single_delegators :core, :vi_editing_mode?, :emacs_editing_mode?
   def_single_delegators :core, :ambiguous_width
+  def_single_delegators :core, :last_incremental_search
+  def_single_delegators :core, :last_incremental_search=
 
   def_single_delegators :core, :readmultiline
   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`><=;|&{("
@@ -390,14 +419,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
@@ -407,4 +433,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,16 +1,49 @@
+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,        # ←
+
+    # 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
+
+    # 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
@@ -28,7 +61,8 @@ class Reline::ANSI
     unless @@buf.empty?
       return @@buf.shift
     end
-    @@input.getbyte
+    c = @@input.raw(intr: true, &:getbyte)
+    (c == 0x16 && @@input.raw(min: 0, tim: 0, &:getbyte)) || c
   end
 
   def self.ungetc(c)
@@ -36,16 +70,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
@@ -60,14 +101,18 @@ class Reline::ANSI
   def self.cursor_pos
     begin
       res = ''
+      m = nil
       @@input.raw do |stdin|
         @@output << "\e[6n"
         @@output.flush
         while (c = stdin.getc) != 'R'
           res << c if c
         end
+        m = res.match(/\e\[(?<row>\d+);(?<column>\d+)/)
+        (m.pre_match + m.post_match).chars.reverse_each do |ch|
+          stdin.ungetc ch
+        end
       end
-      m = res.match(/(?<row>\d+);(?<column>\d+)/)
       column = m[:column].to_i - 1
       row = m[:row].to_i - 1
     rescue Errno::ENOTTY
@@ -79,12 +124,12 @@ class Reline::ANSI
   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
@@ -92,24 +137,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
@@ -120,24 +165,12 @@ class Reline::ANSI
   def self.prep
     retrieve_keybuffer
     int_handle = Signal.trap('INT', 'IGNORE')
-    otio = `stty -g`.chomp
-    setting = ' -echo -icrnl cbreak'
-    stty = `stty -a`
-    if /-parenb\b/ =~ stty
-      setting << ' pass8'
-    end
-    if /\bdsusp *=/ =~ stty
-      setting << ' dsusp undef'
-    end
-    setting << ' -ixoff'
-    `stty #{setting}`
     Signal.trap('INT', int_handle)
-    otio
+    nil
   end
 
   def self.deprep(otio)
     int_handle = Signal.trap('INT', 'IGNORE')
-    system("stty #{otio}", err: File::NULL)
     Signal.trap('INT', int_handle)
     Signal.trap('WINCH', @@old_winch_handler) if @@old_winch_handler
   end

data/lib/reline/config.rb

@@ -3,8 +3,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
@@ -54,7 +52,7 @@ 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
+    @history_size = -1 # unlimited
     @keyseq_timeout = 500
     @test_mode = false
   end
@@ -83,8 +81,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
@@ -157,7 +181,7 @@ class Reline::Config
     case directive
     when 'if'
       condition = false
-      case args # TODO: variables
+      case args
       when 'mode'
       when 'term'
       when 'version'
@@ -184,9 +208,8 @@ 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'
+      @history_size = value.to_i
     when 'bell-style'
       @bell_style =
         case value
@@ -225,6 +248,9 @@ class Reline::Config
       end
     when 'keyseq-timeout'
       @keyseq_timeout = value.to_i
+    when *VARIABLE_NAMES then
+      variable_name = :"@#{name.tr(?-, ?_)}"
+      instance_variable_set(variable_name, value.nil? || value == '1' || value == 'on')
     end
   end