reline 0.5.9 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28ee53a9963a33e9eb1159bea507695d94cc4f67b05ce005175808b7ec2d5175
-  data.tar.gz: c165de2edcc223bc4e3e149208fe29994063445ea0cf02b93658010a245df5e4
+  metadata.gz: 2fb74f487afccdfb3b0530a043cfb7090f2a4860f2fdd168bc94112818b5f57d
+  data.tar.gz: 96b74e0f611f24022f204e9551d8692ef017c52a197ae169fbfdc1074a130857
 SHA512:
-  metadata.gz: af0f93e54d3a414c63dfb369746f00e8fa9cac609c646c0a48ad5f87275e7b6f5c88c47d4c30218075d3774fd41ba7978f49a0ffbfa070ee42921ba0e500c06e
-  data.tar.gz: 5b0a45b7ae2cfb0e23c9d3b4a863e381f4d9ba5d6298f864c261e408cb5c366031d6137d623d0d46e3729b7bbe086fc5da5c5e636163bce230ae0f297441e016
+  metadata.gz: ffdcec13818f2445bd9f639e75b36405c76a439378335fa7c05fad90a26f06965e54cd9dce1b8e1411e16df9ffc80c3c0ac356320654af2ebd40a33fd28cb247
+  data.tar.gz: 24be10266aebce2d07f1519010f6ce0e6b92b816b17e526ede204943880b54388aa5ebf5da086bde0212b5e1f837936e4972c09a57a2d6c94f7c9a41412966d9

data/lib/reline/config.rb

@@ -1,7 +1,7 @@
 class Reline::Config
   attr_reader :test_mode
 
-  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}|./
+  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
     attr_accessor :file, :lineno
@@ -29,6 +29,17 @@ class Reline::Config
   attr_accessor :autocompletion
 
   def initialize
+    reset_variables
+  end
+
+  def reset
+    if editing_mode_is?(:vi_command)
+      @editing_mode_label = :vi_insert
+    end
+    @oneshot_key_bindings.clear
+  end
+
+  def reset_variables
     @additional_key_bindings = { # from inputrc
       emacs: Reline::KeyActor::Base.new,
       vi_insert: Reline::KeyActor::Base.new,
@@ -51,16 +62,11 @@ class Reline::Config
     @keyseq_timeout = 500
     @test_mode = false
     @autocompletion = false
-    @convert_meta = true if seven_bit_encoding?(Reline::IOGate.encoding)
+    @convert_meta = seven_bit_encoding?(Reline::IOGate.encoding)
     @loaded = false
     @enable_bracketed_paste = true
-  end
-
-  def reset
-    if editing_mode_is?(:vi_command)
-      @editing_mode_label = :vi_insert
-    end
-    @oneshot_key_bindings.clear
+    @show_mode_in_prompt = false
+    @default_inputrc_path = nil
   end
 
   def editing_mode
@@ -188,13 +194,14 @@ class Reline::Config
         # value ignores everything after a space, raw_value does not.
         var, value, raw_value = $1.downcase, $2.partition(' ').first, $2
         bind_variable(var, value, raw_value)
-        next
-      when /\s*("#{KEYSEQ_PATTERN}+")\s*:\s*(.*)\s*$/o
-        key, func_name = $1, $2
-        func_name = func_name.split.first
-        keystroke, func = bind_key(key, func_name)
-        next unless keystroke
-        @additional_key_bindings[@keymap_label].add(@keymap_prefix + keystroke, func)
+      when /^\s*(?:M|Meta)-([a-zA-Z_])\s*:\s*(.*)\s*$/o
+        bind_key("\"\\M-#$1\"", $2)
+      when /^\s*(?:C|Control)-([a-zA-Z_])\s*:\s*(.*)\s*$/o
+        bind_key("\"\\C-#$1\"", $2)
+      when /^\s*(?:(?:C|Control)-(?:M|Meta)|(?:M|Meta)-(?:C|Control))-([a-zA-Z_])\s*:\s*(.*)\s*$/o
+        bind_key("\"\\M-\\C-#$1\"", $2)
+      when /^\s*("#{KEYSEQ_PATTERN}+")\s*:\s*(.*)\s*$/o
+        bind_key($1, $2)
       end
     end
     unless if_stack.empty?
@@ -245,22 +252,6 @@ class Reline::Config
       rescue ArgumentError
         @history_size = 500
       end
-    when 'bell-style'
-      @bell_style =
-        case value
-        when 'none', 'off'
-          :none
-        when 'audible', 'on'
-          :audible
-        when 'visible'
-          :visible
-        else
-          :audible
-        end
-    when 'comment-begin'
-      @comment_begin = value.dup
-    when 'completion-query-items'
-      @completion_query_items = value.to_i
     when 'isearch-terminators'
       @isearch_terminators = retrieve_string(raw_value)
     when 'editing-mode'
@@ -320,7 +311,12 @@ class Reline::Config
     parse_keyseq(str).map { |c| c.chr(Reline.encoding_system_needs) }.join
   end
 
-  def bind_key(key, func_name)
+  def bind_key(key, value)
+    keystroke, func = parse_key_binding(key, value)
+    @additional_key_bindings[@keymap_label].add(@keymap_prefix + keystroke, func) if keystroke
+  end
+
+  def parse_key_binding(key, func_name)
     if key =~ /\A"(.*)"\z/
       keyseq = parse_keyseq($1)
     else
@@ -329,27 +325,19 @@ class Reline::Config
     if func_name =~ /"(.*)"/
       func = parse_keyseq($1)
     else
-      func = func_name.tr(?-, ?_).to_sym # It must be macro.
+      func = func_name.split.first.tr(?-, ?_).to_sym # It must be macro.
     end
     [keyseq, func]
   end
 
   def key_notation_to_code(notation)
     case notation
+    when /(?:\\(?:C|Control)-\\(?:M|Meta)|\\(?:M|Meta)-\\(?:C|Control))-([A-Za-z_])/
+      [?\e.ord, $1.ord % 32]
     when /\\(?:C|Control)-([A-Za-z_])/
-      (1 + $1.downcase.ord - ?a.ord)
+      ($1.upcase.ord % 32)
     when /\\(?:M|Meta)-([0-9A-Za-z_])/
-      modified_key = $1
-      case $1
-      when /[0-9]/
-        ?\M-0.bytes.first + (modified_key.ord - ?0.ord)
-      when /[A-Z]/
-        ?\M-A.bytes.first + (modified_key.ord - ?A.ord)
-      when /[a-z]/
-        ?\M-a.bytes.first + (modified_key.ord - ?a.ord)
-      end
-    when /\\(?:C|Control)-(?:M|Meta)-[A-Za-z_]/, /\\(?:M|Meta)-(?:C|Control)-[A-Za-z_]/
-    # 129 M-^A
+      [?\e.ord, $1.ord]
     when /\\(\d{1,3})/ then $1.to_i(8) # octal
     when /\\x(\h{1,2})/ then $1.to_i(16) # hexadecimal
     when "\\e" then ?\e.ord
@@ -369,11 +357,14 @@ class Reline::Config
   end
 
   def parse_keyseq(str)
-    ret = []
-    str.scan(KEYSEQ_PATTERN) do
-      ret << key_notation_to_code($&)
+    str.scan(KEYSEQ_PATTERN).flat_map do |notation|
+      key_notation_to_code(notation)
     end
-    ret
+  end
+
+  def reload
+    reset_variables
+    read
   end
 
   private def seven_bit_encoding?(encoding)

data/lib/reline/face.rb

@@ -107,7 +107,7 @@ class Reline::Face
 
     def sgr_rgb_256color(key, value)
       # 256 colors are
-      # 0..15: standard colors, hight intensity colors
+      # 0..15: standard colors, high intensity colors
       # 16..232: 216 colors (R, G, B each 6 steps)
       # 233..255: grayscale colors (24 steps)
       # This methods converts rgb_expression to 216 colors

data/lib/reline/history.rb

@@ -19,7 +19,7 @@ class Reline::History < Array
 
   def []=(index, val)
     index = check_index(index)
-    super(index, String.new(val, encoding: Reline.encoding_system_needs))
+    super(index, Reline::Unicode.safe_encode(val, Reline.encoding_system_needs))
   end
 
   def concat(*val)
@@ -45,7 +45,7 @@ class Reline::History < Array
       end
     end
     super(*(val.map{ |v|
-      String.new(v, encoding: Reline.encoding_system_needs)
+      Reline::Unicode.safe_encode(v, Reline.encoding_system_needs)
     }))
   end
 
@@ -56,7 +56,7 @@ class Reline::History < Array
     if @config.history_size.positive?
       shift if size + 1 > @config.history_size
     end
-    super(String.new(val, encoding: Reline.encoding_system_needs))
+    super(Reline::Unicode.safe_encode(val, Reline.encoding_system_needs))
   end
 
   private def check_index(index)

data/lib/reline/io/ansi.rb

@@ -2,18 +2,6 @@ require 'io/console'
 require 'io/wait'
 
 class Reline::ANSI < Reline::IO
-  CAPNAME_KEY_BINDINGS = {
-    'khome' => :ed_move_to_beg,
-    'kend'  => :ed_move_to_end,
-    'kdch1' => :key_delete,
-    'kpp' => :ed_search_prev_history,
-    'knp' => :ed_search_next_history,
-    'kcuu1' => :ed_prev_history,
-    'kcud1' => :ed_next_history,
-    'kcuf1' => :ed_next_char,
-    'kcub1' => :ed_prev_char,
-  }
-
   ANSI_CURSOR_KEY_BINDINGS = {
     # Up
     'A' => [:ed_prev_history, {}],
@@ -29,29 +17,27 @@ class Reline::ANSI < Reline::IO
     'H' => [:ed_move_to_beg, {}],
   }
 
-  if Reline::Terminfo.enabled?
-    Reline::Terminfo.setupterm(0, 2)
-  end
+  attr_writer :input, :output
 
   def initialize
     @input = STDIN
     @output = STDOUT
     @buf = []
+    @output_buffer = nil
     @old_winch_handler = nil
   end
 
   def encoding
+    @input.external_encoding || Encoding.default_external
+  rescue IOError
+    # STDIN.external_encoding raises IOError in Ruby <= 3.0 when STDIN is closed
     Encoding.default_external
   end
 
-  def set_default_key_bindings(config, allow_terminfo: true)
+  def set_default_key_bindings(config)
     set_bracketed_paste_key_bindings(config)
     set_default_key_bindings_ansi_cursor(config)
-    if allow_terminfo && Reline::Terminfo.enabled?
-      set_default_key_bindings_terminfo(config)
-    else
-      set_default_key_bindings_comprehensive_list(config)
-    end
+    set_default_key_bindings_comprehensive_list(config)
     {
       [27, 91, 90] => :completion_journey_up, # S-Tab
     }.each_pair do |key, func|
@@ -75,7 +61,10 @@ class Reline::ANSI < Reline::IO
 
   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
+      bindings = [
+        ["\e[#{char}", default_func], # CSI + char
+        ["\eO#{char}", default_func] # SS3 + char, application cursor key mode
+      ]
       if modifiers[:ctrl]
         # CSI + ctrl_key_modifier + char
         bindings << ["\e[1;5#{char}", modifiers[:ctrl]]
@@ -95,23 +84,6 @@ class Reline::ANSI < Reline::IO
     end
   end
 
-  def set_default_key_bindings_terminfo(config)
-    key_bindings = CAPNAME_KEY_BINDINGS.map do |capname, key_binding|
-      begin
-        key_code = Reline::Terminfo.tigetstr(capname)
-        [ key_code.bytes, key_binding ]
-      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 set_default_key_bindings_comprehensive_list(config)
     {
       # xterm
@@ -123,27 +95,9 @@ class Reline::ANSI < Reline::IO
       [27, 91, 49, 126] => :ed_move_to_beg, # Home
       [27, 91, 52, 126] => :ed_move_to_end, # End
 
-      # KDE
-      # 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
-
-      [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)
@@ -151,14 +105,6 @@ class Reline::ANSI < Reline::IO
     end
   end
 
-  def input=(val)
-    @input = val
-  end
-
-  def output=(val)
-    @output = val
-  end
-
   def with_raw_input
     if @input.tty?
       @input.raw(intr: true) { yield }
@@ -245,52 +191,57 @@ class Reline::ANSI < Reline::IO
     self
   end
 
-  def cursor_pos
-    if both_tty?
-      res = +''
-      m = nil
-      @input.raw do |stdin|
-        @output << "\e[6n"
-        @output.flush
-        loop do
-          c = stdin.getc
-          next if c.nil?
-          res << c
-          m = res.match(/\e\[(?<row>\d+);(?<column>\d+)R/)
-          break if m
+  private def cursor_pos_internal(timeout:)
+    match = nil
+    @input.raw do |stdin|
+      @output << "\e[6n"
+      @output.flush
+      timeout_at = Time.now + timeout
+      buf = +''
+      while (wait = timeout_at - Time.now) > 0 && stdin.wait_readable(wait)
+        buf << stdin.readpartial(1024)
+        if (match = buf.match(/\e\[(?<row>\d+);(?<column>\d+)R/))
+          buf = match.pre_match + match.post_match
+          break
         end
-        (m.pre_match + m.post_match).chars.reverse_each do |ch|
-          stdin.ungetc ch
-        end
-      end
-      column = m[:column].to_i - 1
-      row = m[:row].to_i - 1
-    else
-      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, IOError
-        # Just returns column 1 for ambiguous width because this I/O is not
-        # tty and can't seek.
-        row = 0
-        column = 1
       end
+      @buf.concat buf.bytes
     end
-    Reline::CursorPos.new(column, row)
+    [match[:column].to_i - 1, match[:row].to_i - 1] if match
+  end
+
+  def cursor_pos
+    col, row = cursor_pos_internal(timeout: 0.5) if both_tty?
+    Reline::CursorPos.new(col || 0, row || 0)
   end
 
   def both_tty?
     @input.tty? && @output.tty?
   end
 
+  def write(string)
+    if @output_buffer
+      @output_buffer << string
+    else
+      @output.write(string)
+    end
+  end
+
+  def buffered_output
+    @output_buffer = +''
+    yield
+    @output.write(@output_buffer)
+  ensure
+    @output_buffer = nil
+  end
+
   def move_cursor_column(x)
-    @output.write "\e[#{x + 1}G"
+    write "\e[#{x + 1}G"
   end
 
   def move_cursor_up(x)
     if x > 0
-      @output.write "\e[#{x}A"
+      write "\e[#{x}A"
     elsif x < 0
       move_cursor_down(-x)
     end
@@ -298,38 +249,22 @@ class Reline::ANSI < Reline::IO
 
   def move_cursor_down(x)
     if x > 0
-      @output.write "\e[#{x}B"
+      write "\e[#{x}B"
     elsif x < 0
       move_cursor_up(-x)
     end
   end
 
   def hide_cursor
-    seq = "\e[?25l"
-    if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
-      begin
-        seq = Reline::Terminfo.tigetstr('civis')
-      rescue Reline::Terminfo::TerminfoError
-        # civis is undefined
-      end
-    end
-    @output.write seq
+    write "\e[?25l"
   end
 
   def show_cursor
-    seq = "\e[?25h"
-    if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
-      begin
-        seq = Reline::Terminfo.tigetstr('cnorm')
-      rescue Reline::Terminfo::TerminfoError
-        # cnorm is undefined
-      end
-    end
-    @output.write seq
+    write "\e[?25h"
   end
 
   def erase_after_cursor
-    @output.write "\e[K"
+    write "\e[K"
   end
 
   # This only works when the cursor is at the bottom of the scroll range
@@ -337,28 +272,47 @@ class Reline::ANSI < Reline::IO
   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
+    write "\n" * x
   end
 
   def clear_screen
-    @output.write "\e[2J"
-    @output.write "\e[1;1H"
+    write "\e[2J"
+    write "\e[1;1H"
   end
 
   def set_winch_handler(&handler)
-    @old_winch_handler = Signal.trap('WINCH', &handler)
+    @old_winch_handler = Signal.trap('WINCH') do |arg|
+      handler.call
+      @old_winch_handler.call(arg) if @old_winch_handler.respond_to?(:call)
+    end
+    @old_cont_handler = Signal.trap('CONT') do |arg|
+      @input.raw!(intr: true) if @input.tty?
+      # Rerender the screen. Note that screen size might be changed while suspended.
+      handler.call
+      @old_cont_handler.call(arg) if @old_cont_handler.respond_to?(:call)
+    end
+  rescue ArgumentError
+    # Signal.trap may raise an ArgumentError if the platform doesn't support the signal.
+  end
+
+  def read_single_char(keyseq_timeout)
+    # Disable intr to read `C-c` `C-z` `C-\` for quoted insert
+    @input.raw(intr: false) do
+      super
+    end
   end
 
   def prep
     # Enable bracketed paste
-    @output.write "\e[?2004h" if Reline.core.config.enable_bracketed_paste && both_tty?
+    write "\e[?2004h" if Reline.core.config.enable_bracketed_paste && both_tty?
     retrieve_keybuffer
     nil
   end
 
   def deprep(otio)
     # Disable bracketed paste
-    @output.write "\e[?2004l" if Reline.core.config.enable_bracketed_paste && both_tty?
+    write "\e[?2004l" if Reline.core.config.enable_bracketed_paste && both_tty?
     Signal.trap('WINCH', @old_winch_handler) if @old_winch_handler
+    Signal.trap('CONT', @old_cont_handler) if @old_cont_handler
   end
 end

data/lib/reline/io/dumb.rb

@@ -3,8 +3,11 @@ require 'io/wait'
 class Reline::Dumb < Reline::IO
   RESET_COLOR = '' # Do not send color reset sequence
 
+  attr_writer :output
+
   def initialize(encoding: nil)
     @input = STDIN
+    @output = STDOUT
     @buf = []
     @pasting = false
     @encoding = encoding
@@ -21,8 +24,11 @@ class Reline::Dumb < Reline::IO
     elsif RUBY_PLATFORM =~ /mswin|mingw/
       Encoding::UTF_8
     else
-      Encoding::default_external
+      @input.external_encoding || Encoding.default_external
     end
+  rescue IOError
+    # STDIN.external_encoding raises IOError in Ruby <= 3.0 when STDIN is closed
+    Encoding.default_external
   end
 
   def set_default_key_bindings(_)
@@ -36,6 +42,14 @@ class Reline::Dumb < Reline::IO
     yield
   end
 
+  def write(string)
+    @output.write(string)
+  end
+
+  def buffered_output
+    yield
+  end
+
   def getc(_timeout_second)
     unless @buf.empty?
       return @buf.shift
@@ -60,7 +74,7 @@ class Reline::Dumb < Reline::IO
   end
 
   def cursor_pos
-    Reline::CursorPos.new(1, 1)
+    Reline::CursorPos.new(0, 0)
   end
 
   def hide_cursor