reline 0.5.12 → 0.6.0

data/lib/reline/line_editor.rb

@@ -13,7 +13,6 @@ class Reline::LineEditor
   attr_accessor :prompt_proc
   attr_accessor :auto_indent_proc
   attr_accessor :dig_perfect_match_proc
-  attr_writer :output
 
   VI_MOTIONS = %i{
     ed_prev_char
@@ -253,7 +252,7 @@ class Reline::LineEditor
     @rendered_screen = RenderedScreen.new(base_y: 0, lines: [], cursor_y: 0)
     @input_lines = [[[""], 0, 0]]
     @input_lines_position = 0
-    @undoing = false
+    @restoring = false
     @prev_action_state = NullActionState
     @next_action_state = NullActionState
     reset_line
@@ -414,7 +413,7 @@ class Reline::LineEditor
         # do nothing
       elsif level == :blank
         Reline::IOGate.move_cursor_column base_x
-        @output.write "#{Reline::IOGate.reset_color_sequence}#{' ' * width}"
+        Reline::IOGate.write "#{Reline::IOGate.reset_color_sequence}#{' ' * width}"
       else
         x, w, content = new_items[level]
         cover_begin = base_x != 0 && new_levels[base_x - 1] == level
@@ -424,7 +423,7 @@ class Reline::LineEditor
           content, pos = Reline::Unicode.take_mbchar_range(content, base_x - x, width, cover_begin: cover_begin, cover_end: cover_end, padding: true)
         end
         Reline::IOGate.move_cursor_column x + pos
-        @output.write "#{Reline::IOGate.reset_color_sequence}#{content}#{Reline::IOGate.reset_color_sequence}"
+        Reline::IOGate.write "#{Reline::IOGate.reset_color_sequence}#{content}#{Reline::IOGate.reset_color_sequence}"
       end
       base_x += width
     end
@@ -437,7 +436,7 @@ class Reline::LineEditor
   # Calculate cursor position in word wrapped content.
   def wrapped_cursor_position
     prompt_width = calculate_width(prompt_list[@line_index], true)
-    line_before_cursor = whole_lines[@line_index].byteslice(0, @byte_pointer)
+    line_before_cursor = Reline::Unicode.escape_for_print(whole_lines[@line_index].byteslice(0, @byte_pointer))
     wrapped_line_before_cursor = split_line_by_width(' ' * prompt_width + line_before_cursor, screen_width)
     wrapped_cursor_y = wrapped_prompt_and_input_lines[0...@line_index].sum(&:size) + wrapped_line_before_cursor.size - 1
     wrapped_cursor_x = calculate_width(wrapped_line_before_cursor.last)
@@ -460,19 +459,21 @@ class Reline::LineEditor
   end
 
   def render_finished
-    render_differential([], 0, 0)
-    lines = @buffer_of_lines.size.times.map do |i|
-      line = Reline::Unicode.strip_non_printing_start_end(prompt_list[i]) + modified_lines[i]
-      wrapped_lines = split_line_by_width(line, screen_width)
-      wrapped_lines.last.empty? ? "#{line} " : line
+    Reline::IOGate.buffered_output do
+      render_differential([], 0, 0)
+      lines = @buffer_of_lines.size.times.map do |i|
+        line = Reline::Unicode.strip_non_printing_start_end(prompt_list[i]) + modified_lines[i]
+        wrapped_lines = split_line_by_width(line, screen_width)
+        wrapped_lines.last.empty? ? "#{line} " : line
+      end
+      Reline::IOGate.write lines.map { |l| "#{l}\r\n" }.join
     end
-    @output.puts lines.map { |l| "#{l}\r\n" }.join
   end
 
   def print_nomultiline_prompt
     Reline::IOGate.disable_auto_linewrap(true) if Reline::IOGate.win?
     # Readline's test `TestRelineAsReadline#test_readline` requires first output to be prompt, not cursor reset escape sequence.
-    @output.write Reline::Unicode.strip_non_printing_start_end(@prompt) if @prompt && !@is_multiline
+    Reline::IOGate.write Reline::Unicode.strip_non_printing_start_end(@prompt) if @prompt && !@is_multiline
   ensure
     Reline::IOGate.disable_auto_linewrap(false) if Reline::IOGate.win?
   end
@@ -503,7 +504,9 @@ class Reline::LineEditor
       end
     end
 
-    render_differential new_lines, wrapped_cursor_x, wrapped_cursor_y - screen_scroll_top
+    Reline::IOGate.buffered_output do
+      render_differential new_lines, wrapped_cursor_x, wrapped_cursor_y - screen_scroll_top
+    end
   end
 
   # Reflects lines to be rendered and new cursor position to the screen
@@ -807,11 +810,11 @@ class Reline::LineEditor
     target = target.downcase if @config.completion_ignore_case
     list.select do |item|
       next unless item
-
       unless Encoding.compatible?(target.encoding, item.encoding)
-        # Crash with Encoding::CompatibilityError is required by readline-ext/test/readline/test_readline.rb
-        # TODO: fix the test
-        raise Encoding::CompatibilityError, "#{target.encoding.name} is not compatible with #{item.encoding.name}"
+        # Workaround for Readline test
+        if defined?(::Readline) && ::Readline == ::Reline
+          raise Encoding::CompatibilityError, "incompatible character encodings: #{target.encoding} and #{item.encoding}"
+        end
       end
 
       if @config.completion_ignore_case
@@ -970,10 +973,18 @@ class Reline::LineEditor
     @drop_terminate_spaces = false
   end
 
+  ARGUMENT_DIGIT_METHODS = %i[ed_digit vi_zero ed_argument_digit]
+  VI_WAITING_ACCEPT_METHODS = %i[vi_change_meta vi_delete_meta vi_yank ed_insert ed_argument_digit]
+
   private def process_key(key, method_symbol)
-    if key.is_a?(Symbol)
-      cleanup_waiting
-    elsif @waiting_proc
+    if @waiting_proc
+      cleanup_waiting unless key.size == 1
+    end
+    if @vi_waiting_operator
+      cleanup_waiting unless VI_WAITING_ACCEPT_METHODS.include?(method_symbol) || VI_MOTIONS.include?(method_symbol)
+    end
+
+    if @waiting_proc
       old_byte_pointer = @byte_pointer
       @waiting_proc.call(key)
       if @vi_waiting_operator
@@ -987,23 +998,14 @@ class Reline::LineEditor
       return
     end
 
+    # Reject multibyte input (converted to ed_insert) in vi_command mode
+    return if method_symbol == :ed_insert && @config.editing_mode_is?(:vi_command)
+
     if method_symbol and respond_to?(method_symbol, true)
       method_obj = method(method_symbol)
     end
-    if method_symbol and key.is_a?(Symbol)
-      if @vi_arg and argumentable?(method_obj)
-        run_for_operators(key, method_symbol) do |with_operator|
-          wrap_method_call(method_symbol, method_obj, key, with_operator)
-        end
-      else
-        wrap_method_call(method_symbol, method_obj, key) if method_obj
-      end
-      @kill_ring.process
-      if @vi_arg
-        @vi_arg = nil
-      end
-    elsif @vi_arg
-      if key.chr =~ /[0-9]/
+    if @vi_arg
+      if ARGUMENT_DIGIT_METHODS.include?(method_symbol)
         ed_argument_digit(key)
       else
         if argumentable?(method_obj)
@@ -1012,13 +1014,9 @@ class Reline::LineEditor
           end
         elsif method_obj
           wrap_method_call(method_symbol, method_obj, key)
-        else
-          ed_insert(key) unless @config.editing_mode_is?(:vi_command)
         end
         @kill_ring.process
-        if @vi_arg
-          @vi_arg = nil
-        end
+        @vi_arg = nil
       end
     elsif method_obj
       if method_symbol == :ed_argument_digit
@@ -1029,21 +1027,6 @@ class Reline::LineEditor
         end
       end
       @kill_ring.process
-    else
-      ed_insert(key) unless @config.editing_mode_is?(:vi_command)
-    end
-  end
-
-  private def normal_char(key)
-    if key.char < 0x80
-      method_symbol = @config.editing_mode.get_method(key.combined_char)
-      process_key(key.combined_char, method_symbol)
-    else
-      process_key(key.char.chr(encoding), nil)
-    end
-    if @config.editing_mode_is?(:vi_command) and @byte_pointer > 0 and @byte_pointer == current_line.bytesize
-      byte_size = Reline::Unicode.get_prev_mbchar_size(@buffer_of_lines[@line_index], @byte_pointer)
-      @byte_pointer -= byte_size
     end
   end
 
@@ -1060,23 +1043,23 @@ class Reline::LineEditor
   def input_key(key)
     save_old_buffer
     @config.reset_oneshot_key_bindings
-    @dialogs.each do |dialog|
-      if key.char.instance_of?(Symbol) and key.char == dialog.name
-        return
-      end
-    end
     if key.char.nil?
       process_insert(force: true)
       @eof = buffer_empty?
       finish
       return
     end
+    @dialogs.each do |dialog|
+      if key.method_symbol == dialog.name
+        return
+      end
+    end
     @completion_occurs = false
 
-    if key.char.is_a?(Symbol)
-      process_key(key.char, key.char)
-    else
-      normal_char(key)
+    process_key(key.char, key.method_symbol)
+    if @config.editing_mode_is?(:vi_command) and @byte_pointer > 0 and @byte_pointer == current_line.bytesize
+      byte_size = Reline::Unicode.get_prev_mbchar_size(@buffer_of_lines[@line_index], @byte_pointer)
+      @byte_pointer -= byte_size
     end
 
     @prev_action_state, @next_action_state = @next_action_state, NullActionState
@@ -1086,8 +1069,8 @@ class Reline::LineEditor
       @completion_journey_state = nil
     end
 
-    push_input_lines unless @undoing
-    @undoing = false
+    push_input_lines unless @restoring
+    @restoring = false
 
     if @in_pasting
       clear_dialogs
@@ -1201,18 +1184,6 @@ class Reline::LineEditor
     process_auto_indent
   end
 
-  def set_current_lines(lines, byte_pointer = nil, line_index = 0)
-    cursor = current_byte_pointer_cursor
-    @buffer_of_lines = lines
-    @line_index = line_index
-    if byte_pointer
-      @byte_pointer = byte_pointer
-    else
-      calculate_nearest_cursor(cursor)
-    end
-    process_auto_indent
-  end
-
   def retrieve_completion_block
     quote_characters = Reline.completer_quote_characters
     before = current_line.byteslice(0, @byte_pointer).grapheme_clusters
@@ -1255,7 +1226,6 @@ class Reline::LineEditor
   end
 
   def insert_multiline_text(text)
-    save_old_buffer
     pre = @buffer_of_lines[@line_index].byteslice(0, @byte_pointer)
     post = @buffer_of_lines[@line_index].byteslice(@byte_pointer..)
     lines = (pre + Reline::Unicode.safe_encode(text, encoding).gsub(/\r\n?/, "\n") + post).split("\n", -1)
@@ -1263,7 +1233,6 @@ class Reline::LineEditor
     @buffer_of_lines[@line_index, 1] = lines
     @line_index += lines.size - 1
     @byte_pointer = @buffer_of_lines[@line_index].bytesize - post.bytesize
-    push_input_lines
   end
 
   def insert_text(text)
@@ -1429,21 +1398,11 @@ class Reline::LineEditor
   #            digit or if the existing argument is already greater than a
   #            million.
   # GNU Readline:: +self-insert+ (a, b, A, 1, !, …) Insert yourself.
-  private def ed_insert(key)
-    if key.instance_of?(String)
-      begin
-        key.encode(Encoding::UTF_8)
-      rescue Encoding::UndefinedConversionError
-        return
-      end
-      str = key
-    else
-      begin
-        key.chr.encode(Encoding::UTF_8)
-      rescue Encoding::UndefinedConversionError
-        return
-      end
-      str = key.chr
+  private def ed_insert(str)
+    begin
+      str.encode(Encoding::UTF_8)
+    rescue Encoding::UndefinedConversionError
+      return
     end
     if @in_pasting
       @continuous_insertion_buffer << str
@@ -1457,21 +1416,16 @@ class Reline::LineEditor
   alias_method :ed_digit, :ed_insert
   alias_method :self_insert, :ed_insert
 
-  private def ed_quoted_insert(str, arg: 1)
-    @waiting_proc = proc { |key|
-      arg.times do
-        if key == "\C-j".ord or key == "\C-m".ord
-          key_newline(key)
-        elsif key == 0
-          # Ignore NUL.
-        else
-          ed_insert(key)
-        end
+  private def insert_raw_char(str, arg: 1)
+    arg.times do
+      if str == "\C-j" or str == "\C-m"
+        key_newline(str)
+      elsif str != "\0"
+        # Ignore NUL.
+        ed_insert(str)
       end
-      @waiting_proc = nil
-    }
+    end
   end
-  alias_method :quoted_insert, :ed_quoted_insert
 
   private def ed_next_char(key, arg: 1)
     byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
@@ -1520,13 +1474,13 @@ class Reline::LineEditor
     lambda do |key|
       search_again = false
       case key
-      when "\C-h".ord, "\C-?".ord
+      when "\C-h", "\C-?"
         grapheme_clusters = search_word.grapheme_clusters
         if grapheme_clusters.size > 0
           grapheme_clusters.pop
           search_word = grapheme_clusters.join
         end
-      when "\C-r".ord, "\C-s".ord
+      when "\C-r", "\C-s"
         search_again = true if search_key == key
         search_key = key
       else
@@ -1543,10 +1497,10 @@ class Reline::LineEditor
           end
           if @history_pointer
             case search_key
-            when "\C-r".ord
+            when "\C-r"
               history_pointer_base = 0
               history = Reline::HISTORY[0..(@history_pointer - 1)]
-            when "\C-s".ord
+            when "\C-s"
               history_pointer_base = @history_pointer + 1
               history = Reline::HISTORY[(@history_pointer + 1)..-1]
             end
@@ -1556,10 +1510,10 @@ class Reline::LineEditor
           end
         elsif @history_pointer
           case search_key
-          when "\C-r".ord
+          when "\C-r"
             history_pointer_base = 0
             history = Reline::HISTORY[0..@history_pointer]
-          when "\C-s".ord
+          when "\C-s"
             history_pointer_base = @history_pointer
             history = Reline::HISTORY[@history_pointer..-1]
           end
@@ -1568,11 +1522,11 @@ class Reline::LineEditor
           history = Reline::HISTORY
         end
         case search_key
-        when "\C-r".ord
+        when "\C-r"
           hit_index = history.rindex { |item|
             item.include?(search_word)
           }
-        when "\C-s".ord
+        when "\C-s"
           hit_index = history.index { |item|
             item.include?(search_word)
           }
@@ -1583,9 +1537,9 @@ class Reline::LineEditor
         end
       end
       case search_key
-      when "\C-r".ord
+      when "\C-r"
         prompt_name = 'reverse-i-search'
-      when "\C-s".ord
+      when "\C-s"
         prompt_name = 'i-search'
       end
       prompt_name = "failed #{prompt_name}" unless hit
@@ -1597,16 +1551,15 @@ class Reline::LineEditor
     backup = @buffer_of_lines.dup, @line_index, @byte_pointer, @history_pointer, @line_backup_in_history
     searcher = generate_searcher(key)
     @searching_prompt = "(reverse-i-search)`': "
-    termination_keys = ["\C-j".ord]
-    termination_keys.concat(@config.isearch_terminators.chars.map(&:ord)) if @config.isearch_terminators
+    termination_keys = ["\C-j"]
+    termination_keys.concat(@config.isearch_terminators.chars) if @config.isearch_terminators
     @waiting_proc = ->(k) {
-      chr = k.is_a?(String) ? k : k.chr(Encoding::ASCII_8BIT)
-      if k == "\C-g".ord
+      if k == "\C-g"
         # cancel search and restore buffer
         @buffer_of_lines, @line_index, @byte_pointer, @history_pointer, @line_backup_in_history = backup
         @searching_prompt = nil
         @waiting_proc = nil
-      elsif !termination_keys.include?(k) && (chr.match?(/[[:print:]]/) || k == "\C-h".ord || k == "\C-?".ord || k == "\C-r".ord || k == "\C-s".ord)
+      elsif !termination_keys.include?(k) && (k.match?(/[[:print:]]/) || k == "\C-h" || k == "\C-?" || k == "\C-r" || k == "\C-s")
         search_word, prompt_name, hit_pointer = searcher.call(k)
         Reline.last_incremental_search = search_word
         @searching_prompt = "(%s)`%s'" % [prompt_name, search_word]
@@ -1822,7 +1775,7 @@ class Reline::LineEditor
   alias_method :kill_whole_line, :em_kill_line
 
   private def em_delete(key)
-    if buffer_empty? and key == "\C-d".ord
+    if buffer_empty? and key == "\C-d"
       @eof = true
       finish
     elsif @byte_pointer < current_line.bytesize
@@ -2240,20 +2193,9 @@ class Reline::LineEditor
   end
 
   private def ed_argument_digit(key)
-    if @vi_arg.nil?
-      if key.chr.to_i.zero?
-        if key.anybits?(0b10000000)
-          unescaped_key = key ^ 0b10000000
-          unless unescaped_key.chr.to_i.zero?
-            @vi_arg = unescaped_key.chr.to_i
-          end
-        end
-      else
-        @vi_arg = key.chr.to_i
-      end
-    else
-      @vi_arg = @vi_arg * 10 + key.chr.to_i
-    end
+    # key is expected to be `ESC digit` or `digit`
+    num = key[/\d/].to_i
+    @vi_arg = (@vi_arg || 0) * 10 + num
   end
 
   private def vi_to_column(key, arg: 0)
@@ -2272,7 +2214,7 @@ class Reline::LineEditor
         before = current_line.byteslice(0, @byte_pointer)
         remaining_point = @byte_pointer + byte_size
         after = current_line.byteslice(remaining_point, current_line.bytesize - remaining_point)
-        set_current_line(before + k.chr + after)
+        set_current_line(before + k + after)
         @waiting_proc = nil
       elsif arg > 1
         byte_size = 0
@@ -2282,7 +2224,7 @@ class Reline::LineEditor
         before = current_line.byteslice(0, @byte_pointer)
         remaining_point = @byte_pointer + byte_size
         after = current_line.byteslice(remaining_point, current_line.bytesize - remaining_point)
-        replaced = k.chr * arg
+        replaced = k * arg
         set_current_line(before + replaced + after, @byte_pointer + replaced.bytesize)
         @waiting_proc = nil
       end
@@ -2298,11 +2240,6 @@ class Reline::LineEditor
   end
 
   private def search_next_char(key, arg, need_prev_char: false, inclusive: false)
-    if key.instance_of?(String)
-      inputted_char = key
-    else
-      inputted_char = key.chr
-    end
     prev_total = nil
     total = nil
     found = false
@@ -2313,7 +2250,7 @@ class Reline::LineEditor
         width = Reline::Unicode.get_mbchar_width(mbchar)
         total = [mbchar.bytesize, width]
       else
-        if inputted_char == mbchar
+        if key == mbchar
           arg -= 1
           if arg.zero?
             found = true
@@ -2350,11 +2287,6 @@ class Reline::LineEditor
   end
 
   private def search_prev_char(key, arg, need_next_char = false)
-    if key.instance_of?(String)
-      inputted_char = key
-    else
-      inputted_char = key.chr
-    end
     prev_total = nil
     total = nil
     found = false
@@ -2365,7 +2297,7 @@ class Reline::LineEditor
         width = Reline::Unicode.get_mbchar_width(mbchar)
         total = [mbchar.bytesize, width]
       else
-        if inputted_char == mbchar
+        if key == mbchar
           arg -= 1
           if arg.zero?
             found = true
@@ -2417,24 +2349,23 @@ class Reline::LineEditor
     @config.editing_mode = :vi_insert
   end
 
-  private def undo(_key)
-    @undoing = true
+  private def move_undo_redo(direction)
+    @restoring = true
+    return unless (0..@input_lines.size - 1).cover?(@input_lines_position + direction)
 
-    return if @input_lines_position <= 0
+    @input_lines_position += direction
+    buffer_of_lines, byte_pointer, line_index = @input_lines[@input_lines_position]
+    @buffer_of_lines = buffer_of_lines.dup
+    @line_index = line_index
+    @byte_pointer = byte_pointer
+  end
 
-    @input_lines_position -= 1
-    target_lines, target_cursor_x, target_cursor_y = @input_lines[@input_lines_position]
-    set_current_lines(target_lines.dup, target_cursor_x, target_cursor_y)
+  private def undo(_key)
+    move_undo_redo(-1)
   end
 
   private def redo(_key)
-    @undoing = true
-
-    return if @input_lines_position >= @input_lines.size - 1
-
-    @input_lines_position += 1
-    target_lines, target_cursor_x, target_cursor_y = @input_lines[@input_lines_position]
-    set_current_lines(target_lines.dup, target_cursor_x, target_cursor_y)
+    move_undo_redo(+1)
   end
 
   private def prev_action_state_value(type)