reline 0.5.10 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 402ac8415b342c58b741ab1ae942818c44f092d43665d9546fde986572ce2bcf
-  data.tar.gz: 0a54115c2e2b02720e67a7870edc77430493b3d2fa89c033046d817b5b984b13
+  metadata.gz: d2e17ec5d6de83746c38c5e0764f7fa1ecda40f01c18b9e8cdf769e4bf2a155e
+  data.tar.gz: 7ce06466fae4c8115bb507141998d322595b9e924dfc1ad3001871265088a680
 SHA512:
-  metadata.gz: 0525a60f8fe7512bf23575935d15c7173c825ce6b15a062505d73e9a34836d8b751182280c4b67288af7b949b0417a57a4f384281123ef7b6e90c3072b65f20c
-  data.tar.gz: 299034a835b97c80a119614394a650c60104d571ec95ffbff8356531dc1de96cd78b8aa3fa8830520a40d43e4b7feb1958285af29633877a772be7ed995d7d33
+  metadata.gz: 31e90ffea6ac235aad5c2c243fbd41163142f94e044ed9f4980860263fab97154857483755dcacd259fa9b578b1c29be5b878cd7f883f18e7b92380cb5865ef3
+  data.tar.gz: 54b91a893c536b3e6b5c984c0fc2b053b8978ab586ae361446fb603c4eecfb0240a99c45b25e4996ff58d9ef15fa4e33bab5cef9cb4aef3dc7eab85998af3711

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
@@ -194,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?
@@ -310,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
@@ -319,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
@@ -359,11 +357,9 @@ 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

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

@@ -41,7 +41,7 @@ class Reline::ANSI < Reline::IO
   end
 
   def encoding
-    Encoding.default_external
+    @input.external_encoding || Encoding.default_external
   end
 
   def set_default_key_bindings(config, allow_terminfo: true)
@@ -75,7 +75,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]]
@@ -123,27 +126,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)
@@ -245,39 +230,30 @@ 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
-        end
-        (m.pre_match + m.post_match).chars.reverse_each do |ch|
-          stdin.ungetc ch
+  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
       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
+      buf.chars.reverse_each do |ch|
+        stdin.ungetc ch
       end
     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?

data/lib/reline/io/dumb.rb

@@ -21,7 +21,7 @@ class Reline::Dumb < Reline::IO
     elsif RUBY_PLATFORM =~ /mswin|mingw/
       Encoding::UTF_8
     else
-      Encoding::default_external
+      @input.external_encoding || Encoding::default_external
     end
   end
 
@@ -60,7 +60,7 @@ class Reline::Dumb < Reline::IO
   end
 
   def cursor_pos
-    Reline::CursorPos.new(1, 1)
+    Reline::CursorPos.new(0, 0)
   end
 
   def hide_cursor

data/lib/reline/io/windows.rb

@@ -157,6 +157,7 @@ class Reline::Windows < Reline::IO
   STD_OUTPUT_HANDLE = -11
   FILE_TYPE_PIPE = 0x0003
   FILE_NAME_INFO = 2
+  ENABLE_WRAP_AT_EOL_OUTPUT = 2
   ENABLE_VIRTUAL_TERMINAL_PROCESSING = 4
 
   # Calling Win32API with console handle is reported to fail after executing some external command.
@@ -170,7 +171,7 @@ class Reline::Windows < Reline::IO
   end
 
   private def getconsolemode
-    mode = "\000\000\000\000"
+    mode = +"\0\0\0\0"
     call_with_console_handle(@GetConsoleMode, mode)
     mode.unpack1('L')
   end
@@ -252,7 +253,7 @@ class Reline::Windows < Reline::IO
 
     key = KeyEventRecord.new(virtual_key_code, char_code, control_key_state)
 
-    match = KEY_MAP.find { |args,| key.matches?(**args) }
+    match = KEY_MAP.find { |args,| key.match?(**args) }
     unless match.nil?
       @output_buf.concat(match.last)
       return
@@ -344,35 +345,38 @@ class Reline::Windows < Reline::IO
     # [18,2] dwMaximumWindowSize.X
     # [20,2] dwMaximumWindowSize.Y
     csbi = 0.chr * 22
-    return if call_with_console_handle(@GetConsoleScreenBufferInfo, csbi) == 0
-    csbi
+    if call_with_console_handle(@GetConsoleScreenBufferInfo, csbi) != 0
+      # returns [width, height, x, y, attributes, left, top, right, bottom]
+      csbi.unpack("s9")
+    else
+      return nil
+    end
   end
 
+  ALTERNATIVE_CSBI = [80, 24, 0, 0, 7, 0, 0, 79, 23].freeze
+
   def get_screen_size
-    unless csbi = get_console_screen_buffer_info
-      return [1, 1]
-    end
-    csbi[0, 4].unpack('SS').reverse
+    width, _, _, _, _, _, top, _, bottom = get_console_screen_buffer_info || ALTERNATIVE_CSBI
+    [bottom - top + 1, width]
   end
 
   def cursor_pos
-    unless csbi = get_console_screen_buffer_info
-      return Reline::CursorPos.new(0, 0)
-    end
-    x = csbi[4, 2].unpack1('s')
-    y = csbi[6, 2].unpack1('s')
-    Reline::CursorPos.new(x, y)
+    _, _, x, y, _, _, top, = get_console_screen_buffer_info || ALTERNATIVE_CSBI
+    Reline::CursorPos.new(x, y - top)
   end
 
   def move_cursor_column(val)
-    call_with_console_handle(@SetConsoleCursorPosition, cursor_pos.y * 65536 + val)
+    _, _, _, y, = get_console_screen_buffer_info
+    call_with_console_handle(@SetConsoleCursorPosition, y * 65536 + val) if y
   end
 
   def move_cursor_up(val)
     if val > 0
-      y = cursor_pos.y - val
+      _, _, x, y, _, _, top, = get_console_screen_buffer_info
+      return unless y
+      y = (y - top) - val
       y = 0 if y < 0
-      call_with_console_handle(@SetConsoleCursorPosition, y * 65536 + cursor_pos.x)
+      call_with_console_handle(@SetConsoleCursorPosition, (y + top) * 65536 + x)
     elsif val < 0
       move_cursor_down(-val)
     end
@@ -380,58 +384,39 @@ class Reline::Windows < Reline::IO
 
   def move_cursor_down(val)
     if val > 0
-      return unless csbi = get_console_screen_buffer_info
-      screen_height = get_screen_size.first
-      y = cursor_pos.y + val
-      y = screen_height - 1 if y > (screen_height - 1)
-      call_with_console_handle(@SetConsoleCursorPosition, (cursor_pos.y + val) * 65536 + cursor_pos.x)
+      _, _, x, y, _, _, top, _, bottom = get_console_screen_buffer_info
+      return unless y
+      screen_height = bottom - top
+      y = (y - top) + val
+      y = screen_height if y > screen_height
+      call_with_console_handle(@SetConsoleCursorPosition, (y + top) * 65536 + x)
     elsif val < 0
       move_cursor_up(-val)
     end
   end
 
   def erase_after_cursor
-    return unless csbi = get_console_screen_buffer_info
-    attributes = csbi[8, 2].unpack1('S')
-    cursor = csbi[4, 4].unpack1('L')
+    width, _, x, y, attributes, = get_console_screen_buffer_info
+    return unless x
     written = 0.chr * 4
-    call_with_console_handle(@FillConsoleOutputCharacter, 0x20, get_screen_size.last - cursor_pos.x, cursor, written)
-    call_with_console_handle(@FillConsoleOutputAttribute, attributes, get_screen_size.last - cursor_pos.x, cursor, written)
-  end
-
-  def scroll_down(val)
-    return if val < 0
-    return unless csbi = get_console_screen_buffer_info
-    buffer_width, buffer_lines, x, y, attributes, window_left, window_top, window_bottom = csbi.unpack('ssssSssx2s')
-    screen_height = window_bottom - window_top + 1
-    val = screen_height if val > screen_height
-
-    if @legacy_console || window_left != 0
-      # unless ENABLE_VIRTUAL_TERMINAL,
-      # if srWindow.Left != 0 then it's conhost.exe hosted console
-      # and puts "\n" causes horizontal scroll. its glitch.
-      # FYI irb write from culumn 1, so this gives no gain.
-      scroll_rectangle = [0, val, buffer_width, buffer_lines - val].pack('s4')
-      destination_origin = 0 # y * 65536 + x
-      fill = [' '.ord, attributes].pack('SS')
-      call_with_console_handle(@ScrollConsoleScreenBuffer, scroll_rectangle, nil, destination_origin, fill)
-    else
-      origin_x = x + 1
-      origin_y = y - window_top + 1
-      @output.write [
-        (origin_y != screen_height) ? "\e[#{screen_height};H" : nil,
-        "\n" * val,
-        (origin_y != screen_height or !x.zero?) ? "\e[#{origin_y};#{origin_x}H" : nil
-      ].join
-    end
+    call_with_console_handle(@FillConsoleOutputCharacter, 0x20, width - x, y * 65536 + x, written)
+    call_with_console_handle(@FillConsoleOutputAttribute, attributes, width - x, y * 65536 + x, written)
+  end
+
+  # This only works when the cursor is at the bottom of the scroll range
+  # For more details, see https://github.com/ruby/reline/pull/577#issuecomment-1646679623
+  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
   end
 
   def clear_screen
     if @legacy_console
-      return unless csbi = get_console_screen_buffer_info
-      buffer_width, _buffer_lines, attributes, window_top, window_bottom = csbi.unpack('ss@8S@12sx2s')
-      fill_length = buffer_width * (window_bottom - window_top + 1)
-      screen_topleft = window_top * 65536
+      width, _, _, _, attributes, _, top, _, bottom = get_console_screen_buffer_info
+      return unless width
+      fill_length = width * (bottom - top + 1)
+      screen_topleft = top * 65536
       written = 0.chr * 4
       call_with_console_handle(@FillConsoleOutputCharacter, 0x20, fill_length, screen_topleft, written)
       call_with_console_handle(@FillConsoleOutputAttribute, attributes, fill_length, screen_topleft, written)
@@ -472,6 +457,28 @@ class Reline::Windows < Reline::IO
     # do nothing
   end
 
+  def disable_auto_linewrap(setting = true, &block)
+    mode = getconsolemode
+    if 0 == (mode & ENABLE_VIRTUAL_TERMINAL_PROCESSING)
+      if block
+        begin
+          setconsolemode(mode & ~ENABLE_WRAP_AT_EOL_OUTPUT)
+          block.call
+        ensure
+          setconsolemode(mode | ENABLE_WRAP_AT_EOL_OUTPUT)
+        end
+      else
+        if setting
+          setconsolemode(mode & ~ENABLE_WRAP_AT_EOL_OUTPUT)
+        else
+          setconsolemode(mode | ENABLE_WRAP_AT_EOL_OUTPUT)
+        end
+      end
+    else
+      block.call if block
+    end
+  end
+
   class KeyEventRecord
 
     attr_reader :virtual_key_code, :char_code, :control_key_state, :control_keys
@@ -501,7 +508,7 @@ class Reline::Windows < Reline::IO
     # Verifies if the arguments match with this key event.
     # Nil arguments are ignored, but at least one must be passed as non-nil.
     # To verify that no control keys were pressed, pass an empty array: `control_keys: []`.
-    def matches?(control_keys: nil, virtual_key_code: nil, char_code: nil)
+    def match?(control_keys: nil, virtual_key_code: nil, char_code: nil)
       raise ArgumentError, 'No argument was passed to match key event' if control_keys.nil? && virtual_key_code.nil? && char_code.nil?
 
       (control_keys.nil? || [*control_keys].sort == @control_keys) &&

data/lib/reline/line_editor.rb

@@ -72,17 +72,21 @@ class Reline::LineEditor
 
   MINIMUM_SCROLLBAR_HEIGHT = 1
 
-  def initialize(config, encoding)
+  def initialize(config)
     @config = config
     @completion_append_character = ''
     @screen_size = [0, 0] # Should be initialized with actual winsize in LineEditor#reset
-    reset_variables(encoding: encoding)
+    reset_variables
   end
 
   def io_gate
     Reline::IOGate
   end
 
+  def encoding
+    io_gate.encoding
+  end
+
   def set_pasting_state(in_pasting)
     # While pasting, text to be inserted is stored to @continuous_insertion_buffer.
     # After pasting, this buffer should be force inserted.
@@ -136,9 +140,9 @@ class Reline::LineEditor
     end
   end
 
-  def reset(prompt = '', encoding:)
+  def reset(prompt = '')
     @screen_size = Reline::IOGate.get_screen_size
-    reset_variables(prompt, encoding: encoding)
+    reset_variables(prompt)
     @rendered_screen.base_y = Reline::IOGate.cursor_pos.y
     if ENV.key?('RELINE_ALT_SCROLLBAR')
       @full_block = '::'
@@ -150,7 +154,7 @@ class Reline::LineEditor
       @upper_half_block = '▀'
       @lower_half_block = '▄'
       @block_elem_width = 1
-    elsif @encoding == Encoding::UTF_8
+    elsif encoding == Encoding::UTF_8
       @full_block = '█'
       @upper_half_block = '▀'
       @lower_half_block = '▄'
@@ -219,10 +223,9 @@ class Reline::LineEditor
     @eof
   end
 
-  def reset_variables(prompt = '', encoding:)
+  def reset_variables(prompt = '')
     @prompt = prompt.gsub("\n", "\\n")
     @mark_pointer = nil
-    @encoding = encoding
     @is_multiline = false
     @finished = false
     @history_pointer = nil
@@ -239,7 +242,7 @@ class Reline::LineEditor
     @searching_prompt = nil
     @just_cursor_moving = false
     @eof = false
-    @continuous_insertion_buffer = String.new(encoding: @encoding)
+    @continuous_insertion_buffer = String.new(encoding: encoding)
     @scroll_partial_screen = 0
     @drop_terminate_spaces = false
     @in_pasting = false
@@ -259,7 +262,7 @@ class Reline::LineEditor
 
   def reset_line
     @byte_pointer = 0
-    @buffer_of_lines = [String.new(encoding: @encoding)]
+    @buffer_of_lines = [String.new(encoding: encoding)]
     @line_index = 0
     @cache.clear
     @line_backup_in_history = nil
@@ -275,7 +278,7 @@ class Reline::LineEditor
   end
 
   private def insert_new_line(cursor_line, next_line)
-    @buffer_of_lines.insert(@line_index + 1, String.new(next_line, encoding: @encoding))
+    @buffer_of_lines.insert(@line_index + 1, String.new(next_line, encoding: encoding))
     @buffer_of_lines[@line_index] = cursor_line
     @line_index += 1
     @byte_pointer = 0
@@ -298,7 +301,7 @@ class Reline::LineEditor
   end
 
   private def split_by_width(str, max_width, offset: 0)
-    Reline::Unicode.split_by_width(str, max_width, @encoding, offset: offset)
+    Reline::Unicode.split_by_width(str, max_width, encoding, offset: offset)
   end
 
   def current_byte_pointer_cursor
@@ -461,7 +464,7 @@ class Reline::LineEditor
   def render_finished
     render_differential([], 0, 0)
     lines = @buffer_of_lines.size.times.map do |i|
-      line = prompt_list[i] + modified_lines[i]
+      line = Reline::Unicode.strip_non_printing_start_end(prompt_list[i]) + modified_lines[i]
       wrapped_lines, = split_by_width(line, screen_width)
       wrapped_lines.last.empty? ? "#{line} " : line
     end
@@ -469,8 +472,11 @@ class Reline::LineEditor
   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 @prompt if @prompt && !@is_multiline
+    @output.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
 
   def render
@@ -506,6 +512,7 @@ class Reline::LineEditor
   # by calculating the difference from the previous render.
 
   private def render_differential(new_lines, new_cursor_x, new_cursor_y)
+    Reline::IOGate.disable_auto_linewrap(true) if Reline::IOGate.win?
     rendered_lines = @rendered_screen.lines
     cursor_y = @rendered_screen.cursor_y
     if new_lines != rendered_lines
@@ -536,6 +543,8 @@ class Reline::LineEditor
     Reline::IOGate.move_cursor_column new_cursor_x
     Reline::IOGate.move_cursor_down new_cursor_y - cursor_y
     @rendered_screen.cursor_y = new_cursor_y
+  ensure
+    Reline::IOGate.disable_auto_linewrap(false) if Reline::IOGate.win?
   end
 
   private def clear_rendered_screen_cache
@@ -797,7 +806,7 @@ class Reline::LineEditor
 
   private def complete_internal_proc(list, is_menu)
     preposing, target, postposing = retrieve_completion_block
-    list = list.select { |i|
+    candidates = list.select { |i|
       if i and not Encoding.compatible?(target.encoding, i.encoding)
         raise Encoding::CompatibilityError, "#{target.encoding.name} is not compatible with #{i.encoding.name}"
       end
@@ -808,10 +817,10 @@ class Reline::LineEditor
       end
     }.uniq
     if is_menu
-      menu(target, list)
+      menu(target, candidates)
       return nil
     end
-    completed = list.inject { |memo, item|
+    completed = candidates.inject { |memo, item|
       begin
         memo_mbchars = memo.unicode_normalize.grapheme_clusters
         item_mbchars = item.unicode_normalize.grapheme_clusters
@@ -838,7 +847,8 @@ class Reline::LineEditor
       end
       result
     }
-    [target, preposing, completed, postposing]
+
+    [target, preposing, completed, postposing, candidates]
   end
 
   private def perform_completion(list, just_show_list)
@@ -846,7 +856,11 @@ class Reline::LineEditor
     when CompletionState::NORMAL
       @completion_state = CompletionState::COMPLETION
     when CompletionState::PERFECT_MATCH
-      @dig_perfect_match_proc&.(@perfect_matched)
+      if @dig_perfect_match_proc
+        @dig_perfect_match_proc.(@perfect_matched)
+      else
+        @completion_state = CompletionState::COMPLETION
+      end
     end
     if just_show_list
       is_menu = true
@@ -862,24 +876,26 @@ class Reline::LineEditor
       @completion_state = CompletionState::PERFECT_MATCH
     end
     return if result.nil?
-    target, preposing, completed, postposing = result
+    target, preposing, completed, postposing, candidates = result
     return if completed.nil?
     if target <= completed and (@completion_state == CompletionState::COMPLETION)
-      if list.include?(completed)
-        if list.one?
+      append_character = ''
+      if candidates.include?(completed)
+        if candidates.one?
+          append_character = completion_append_character.to_s
           @completion_state = CompletionState::PERFECT_MATCH
         else
           @completion_state = CompletionState::MENU_WITH_PERFECT_MATCH
-          perform_completion(list, true) if @config.show_all_if_ambiguous
+          perform_completion(candidates, true) if @config.show_all_if_ambiguous
         end
         @perfect_matched = completed
       else
         @completion_state = CompletionState::MENU
-        perform_completion(list, true) if @config.show_all_if_ambiguous
+        perform_completion(candidates, true) if @config.show_all_if_ambiguous
       end
-      if not just_show_list and target < completed
-        @buffer_of_lines[@line_index] = (preposing + completed + completion_append_character.to_s + postposing).split("\n")[@line_index] || String.new(encoding: @encoding)
-        line_to_pointer = (preposing + completed + completion_append_character.to_s).split("\n")[@line_index] || String.new(encoding: @encoding)
+      unless just_show_list
+        @buffer_of_lines[@line_index] = (preposing + completed + append_character + postposing).split("\n")[@line_index] || String.new(encoding: encoding)
+        line_to_pointer = (preposing + completed + append_character).split("\n")[@line_index] || String.new(encoding: encoding)
         @byte_pointer = line_to_pointer.bytesize
       end
     end
@@ -1054,8 +1070,8 @@ class Reline::LineEditor
   private def normal_char(key)
     @multibyte_buffer << key.combined_char
     if @multibyte_buffer.size > 1
-      if @multibyte_buffer.dup.force_encoding(@encoding).valid_encoding?
-        process_key(@multibyte_buffer.dup.force_encoding(@encoding), nil)
+      if @multibyte_buffer.dup.force_encoding(encoding).valid_encoding?
+        process_key(@multibyte_buffer.dup.force_encoding(encoding), nil)
         @multibyte_buffer.clear
       else
         # invalid
@@ -1313,7 +1329,7 @@ class Reline::LineEditor
     if (lines.size - 1) > @line_index
       postposing = postposing + "\n" + lines[(@line_index + 1)..-1].join("\n")
     end
-    [preposing.encode(@encoding), target.encode(@encoding), postposing.encode(@encoding)]
+    [preposing.encode(encoding), target.encode(encoding), postposing.encode(encoding)]
   end
 
   def confirm_multiline_termination
@@ -1325,7 +1341,7 @@ class Reline::LineEditor
     save_old_buffer
     pre = @buffer_of_lines[@line_index].byteslice(0, @byte_pointer)
     post = @buffer_of_lines[@line_index].byteslice(@byte_pointer..)
-    lines = (pre + text.gsub(/\r\n?/, "\n") + post).split("\n", -1)
+    lines = (pre + Reline::Unicode.safe_encode(text, encoding).gsub(/\r\n?/, "\n") + post).split("\n", -1)
     lines << '' if lines.empty?
     @buffer_of_lines[@line_index, 1] = lines
     @line_index += lines.size - 1
@@ -1370,7 +1386,7 @@ class Reline::LineEditor
       last += current_line.bytesize if last < 0
       first += current_line.bytesize if first < 0
       range = range.exclude_end? ? first...last : first..last
-      line = current_line.bytes.reject.with_index{ |c, i| range.include?(i) }.map{ |c| c.chr(Encoding::ASCII_8BIT) }.join.force_encoding(@encoding)
+      line = current_line.bytes.reject.with_index{ |c, i| range.include?(i) }.map{ |c| c.chr(Encoding::ASCII_8BIT) }.join.force_encoding(encoding)
       set_current_line(line)
     else
       set_current_line(current_line.byteslice(0, start))
@@ -1581,7 +1597,7 @@ class Reline::LineEditor
   alias_method :end_of_line, :ed_move_to_end
 
   private def generate_searcher(search_key)
-    search_word = String.new(encoding: @encoding)
+    search_word = String.new(encoding: encoding)
     multibyte_buf = String.new(encoding: 'ASCII-8BIT')
     hit_pointer = nil
     lambda do |key|
@@ -1598,8 +1614,8 @@ class Reline::LineEditor
         search_key = key
       else
         multibyte_buf << key
-        if multibyte_buf.dup.force_encoding(@encoding).valid_encoding?
-          search_word << multibyte_buf.dup.force_encoding(@encoding)
+        if multibyte_buf.dup.force_encoding(encoding).valid_encoding?
+          search_word << multibyte_buf.dup.force_encoding(encoding)
           multibyte_buf.clear
         end
       end
@@ -1665,57 +1681,29 @@ class Reline::LineEditor
   end
 
   private def incremental_search_history(key)
-    unless @history_pointer
-      @line_backup_in_history = whole_buffer
-    end
+    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.concat(@config.isearch_terminators.chars.map(&:ord)) if @config.isearch_terminators
     @waiting_proc = ->(k) {
-      case k
-      when *termination_keys
-        if @history_pointer
-          buffer = Reline::HISTORY[@history_pointer]
-        else
-          buffer = @line_backup_in_history
-        end
-        @buffer_of_lines = buffer.split("\n")
-        @buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
-        @line_index = @buffer_of_lines.size - 1
+      chr = k.is_a?(String) ? k : k.chr(Encoding::ASCII_8BIT)
+      if k == "\C-g".ord
+        # 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
-        @byte_pointer = 0
-      when "\C-g".ord
-        @buffer_of_lines = @line_backup_in_history.split("\n")
-        @buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
-        @line_index = @buffer_of_lines.size - 1
-        move_history(nil, line: :end, cursor: :end, save_buffer: false)
+      elsif !termination_keys.include?(k) && (chr.match?(/[[:print:]]/) || k == "\C-h".ord || k == "\C-?".ord || k == "\C-r".ord || k == "\C-s".ord)
+        search_word, prompt_name, hit_pointer = searcher.call(k)
+        Reline.last_incremental_search = search_word
+        @searching_prompt = "(%s)`%s'" % [prompt_name, search_word]
+        @searching_prompt += ': ' unless @is_multiline
+        move_history(hit_pointer, line: :end, cursor: :end) if hit_pointer
+      else
+        # terminaton_keys and other keys will terminalte
+        move_history(@history_pointer, line: :end, cursor: :start)
         @searching_prompt = nil
         @waiting_proc = nil
-        @byte_pointer = 0
-      else
-        chr = k.is_a?(String) ? k : k.chr(Encoding::ASCII_8BIT)
-        if chr.match?(/[[:print:]]/) or k == "\C-h".ord or k == "\C-?".ord or k == "\C-r".ord or k == "\C-s".ord
-          search_word, prompt_name, hit_pointer = searcher.call(k)
-          Reline.last_incremental_search = search_word
-          @searching_prompt = "(%s)`%s'" % [prompt_name, search_word]
-          @searching_prompt += ': ' unless @is_multiline
-          move_history(hit_pointer, line: :end, cursor: :end, save_buffer: false) if hit_pointer
-        else
-          if @history_pointer
-            line = Reline::HISTORY[@history_pointer]
-          else
-            line = @line_backup_in_history
-          end
-          @line_backup_in_history = whole_buffer
-          @buffer_of_lines = line.split("\n")
-          @buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
-          @line_index = @buffer_of_lines.size - 1
-          @searching_prompt = nil
-          @waiting_proc = nil
-          @byte_pointer = 0
-        end
       end
     }
   end
@@ -1770,14 +1758,14 @@ class Reline::LineEditor
   end
   alias_method :history_search_forward, :ed_search_next_history
 
-  private def move_history(history_pointer, line:, cursor:, save_buffer: true)
+  private def move_history(history_pointer, line:, cursor:)
     history_pointer ||= Reline::HISTORY.size
     return if history_pointer < 0 || history_pointer > Reline::HISTORY.size
     old_history_pointer = @history_pointer || Reline::HISTORY.size
     if old_history_pointer == Reline::HISTORY.size
-      @line_backup_in_history = save_buffer ? whole_buffer : ''
+      @line_backup_in_history = whole_buffer
     else
-      Reline::HISTORY[old_history_pointer] = whole_buffer if save_buffer
+      Reline::HISTORY[old_history_pointer] = whole_buffer
     end
     if history_pointer == Reline::HISTORY.size
       buf = @line_backup_in_history
@@ -1787,7 +1775,7 @@ class Reline::LineEditor
       @history_pointer = history_pointer
     end
     @buffer_of_lines = buf.split("\n")
-    @buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
+    @buffer_of_lines = [String.new(encoding: encoding)] if @buffer_of_lines.empty?
     @line_index = line == :start ? 0 : line == :end ? @buffer_of_lines.size - 1 : line
     @byte_pointer = cursor == :start ? 0 : cursor == :end ? current_line.bytesize : cursor
   end
@@ -2312,7 +2300,7 @@ class Reline::LineEditor
     }
     system("#{ENV['EDITOR']} #{path}")
     @buffer_of_lines = File.read(path).split("\n")
-    @buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
+    @buffer_of_lines = [String.new(encoding: encoding)] if @buffer_of_lines.empty?
     @line_index = 0
     finish
   end
@@ -2396,9 +2384,9 @@ class Reline::LineEditor
 
   private def search_next_char(key, arg, need_prev_char: false, inclusive: false)
     if key.instance_of?(String)
-      inputed_char = key
+      inputted_char = key
     else
-      inputed_char = key.chr
+      inputted_char = key.chr
     end
     prev_total = nil
     total = nil
@@ -2410,7 +2398,7 @@ class Reline::LineEditor
         width = Reline::Unicode.get_mbchar_width(mbchar)
         total = [mbchar.bytesize, width]
       else
-        if inputed_char == mbchar
+        if inputted_char == mbchar
           arg -= 1
           if arg.zero?
             found = true
@@ -2448,9 +2436,9 @@ class Reline::LineEditor
 
   private def search_prev_char(key, arg, need_next_char = false)
     if key.instance_of?(String)
-      inputed_char = key
+      inputted_char = key
     else
-      inputed_char = key.chr
+      inputted_char = key.chr
     end
     prev_total = nil
     total = nil
@@ -2462,7 +2450,7 @@ class Reline::LineEditor
         width = Reline::Unicode.get_mbchar_width(mbchar)
         total = [mbchar.bytesize, width]
       else
-        if inputed_char == mbchar
+        if inputted_char == mbchar
           arg -= 1
           if arg.zero?
             found = true

data/lib/reline/unicode.rb

@@ -54,6 +54,22 @@ class Reline::Unicode
     }.join
   end
 
+  def self.safe_encode(str, encoding)
+    # Reline only supports utf-8 convertible string.
+    converted = str.encode(encoding, invalid: :replace, undef: :replace)
+    return converted if str.encoding == Encoding::UTF_8 || converted.encoding == Encoding::UTF_8 || converted.ascii_only?
+
+    # This code is essentially doing the same thing as
+    # `str.encode(utf8, **replace_options).encode(encoding, **replace_options)`
+    # but also avoids unneccesary irreversible encoding conversion.
+    converted.gsub(/\X/) do |c|
+      c.encode(Encoding::UTF_8)
+      c
+    rescue Encoding::UndefinedConversionError
+      '?'
+    end
+  end
+
   require 'reline/unicode/east_asian_width'
 
   def self.get_mbchar_width(mbchar)
@@ -116,10 +132,8 @@ class Reline::Unicode
       case
       when non_printing_start
         in_zero_width = true
-        lines.last << NON_PRINTING_START
       when non_printing_end
         in_zero_width = false
-        lines.last << NON_PRINTING_END
       when csi
         lines.last << csi
         unless in_zero_width
@@ -131,7 +145,7 @@ class Reline::Unicode
         end
       when osc
         lines.last << osc
-        seq << osc
+        seq << osc unless in_zero_width
       when gc
         unless in_zero_width
           mbchar_width = get_mbchar_width(gc)
@@ -154,6 +168,10 @@ class Reline::Unicode
     [lines, height]
   end
 
+  def self.strip_non_printing_start_end(prompt)
+    prompt.gsub(/\x01([^\x02]*)(?:\x02|\z)/) { $1 }
+  end
+
   # Take a chunk of a String cut by width with escape sequences.
   def self.take_range(str, start_col, max_width)
     take_mbchar_range(str, start_col, max_width).first
@@ -173,10 +191,8 @@ class Reline::Unicode
       case
       when non_printing_start
         in_zero_width = true
-        chunk << NON_PRINTING_START
       when non_printing_end
         in_zero_width = false
-        chunk << NON_PRINTING_END
       when csi
         has_csi = true
         chunk << csi

data/lib/reline/version.rb

@@ -1,3 +1,3 @@
 module Reline
-  VERSION = '0.5.10'
+  VERSION = '0.5.11'
 end

data/lib/reline.rb

@@ -308,7 +308,7 @@ module Reline
       otio = io_gate.prep
 
       may_req_ambiguous_char_width
-      line_editor.reset(prompt, encoding: encoding)
+      line_editor.reset(prompt)
       if multiline
         line_editor.multiline_on
         if block_given?
@@ -412,7 +412,7 @@ module Reline
     end
 
     private def may_req_ambiguous_char_width
-      @ambiguous_width = 2 if io_gate.dumb? || !STDIN.tty? || !STDOUT.tty?
+      @ambiguous_width = 1 if io_gate.dumb? || !STDIN.tty? || !STDOUT.tty?
       return if defined? @ambiguous_width
       io_gate.move_cursor_column(0)
       begin
@@ -421,7 +421,7 @@ module Reline
         # LANG=C
         @ambiguous_width = 1
       else
-        @ambiguous_width = io_gate.cursor_pos.x
+        @ambiguous_width = io_gate.cursor_pos.x == 2 ? 2 : 1
       end
       io_gate.move_cursor_column(0)
       io_gate.erase_after_cursor
@@ -487,7 +487,7 @@ module Reline
     @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.encoding)
+      core.line_editor = Reline::LineEditor.new(core.config)
 
       core.basic_word_break_characters = " \t\n`><=;|&{("
       core.completer_word_break_characters = " \t\n`><=;|&{("

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: reline
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.5.11
 platform: ruby
 authors:
 - aycabta
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: io-console