reline 0.2.6 → 0.2.8.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc0f6fb7c331a37907554b292249a75b218646aa14298586790cc09d6c174894
-  data.tar.gz: 79fd7b502a7ab601f6642964bb0987dae5d0a62bc8cfda016d8806c8b76bb723
+  metadata.gz: 92eb26edb27bc79f95c9f54a4396b86e764acb928a4d704db8b8d1016331aa67
+  data.tar.gz: 04b7af1f6107bc8cd302494a057e6cfd812c60ec3768b3cd475105d8e119d20c
 SHA512:
-  metadata.gz: 2b4300db4d7bef4ab3ddc8f45db07e20e37b371d89e7a21f343dd3c7096209d0c19028def435d584c7bc1f0a9f18d0d6c783b47d28967eb3d34e4d0eaa613490
-  data.tar.gz: '081a683b1980b9c8d27822e62dcdc776024cc408e3f93b0c999f8da2c6b2fef92c4eded142f7bee8f95fcd7a18fc8431a87f2cd19d1c1064fa677f7de606dcf0'
+  metadata.gz: 40503d95634408feb981bcb3448679ed6c847123465b5b965399c75c4bbc9ac0ddbb5422386d209613e45b34a85f2ecb275fac7587272da88de7a16b2feb40b0
+  data.tar.gz: '030383e1c77101f296344c794443439af32c6fd7f2f86f0230666287df901e5aea9f25d78242ab9ea16253ab17faa97c02fc234137e166a71edbac2de2f44f16'

data/lib/reline/ansi.rb

@@ -1,4 +1,5 @@
 require 'io/console'
+require 'io/wait'
 require 'timeout'
 require_relative 'terminfo'
 
@@ -36,6 +37,7 @@ class Reline::ANSI
       # default bindings
       [27, 32] => :em_set_mark,             # M-<space>
       [24, 24] => :em_exchange_mark,        # C-x C-x
+      [27, 91, 90] => :completion_journey_up, # S-Tab
     }.each_pair do |key, func|
       config.add_default_key_binding_by_keymap(:emacs, key, func)
     end
@@ -183,12 +185,7 @@ class Reline::ANSI
     unless @@buf.empty?
       return false
     end
-    rs, = IO.select([@@input], [], [], 0.00001)
-    if rs and rs[0]
-      false
-    else
-      true
-    end
+    !@@input.wait_readable(0)
   end
 
   def self.ungetc(c)
@@ -197,8 +194,7 @@ class Reline::ANSI
 
   def self.retrieve_keybuffer
     begin
-      result = select([@@input], [], [], 0.001)
-      return if result.nil?
+      return unless @@input.wait_readable(0.001)
       str = @@input.read_nonblock(1024)
       str.bytes.each do |c|
         @@buf.push(c)
@@ -279,6 +275,22 @@ class Reline::ANSI
     end
   end
 
+  def self.hide_cursor
+    if Reline::Terminfo.enabled?
+      @@output.write Reline::Terminfo.tigetstr('civis')
+    else
+      # ignored
+    end
+  end
+
+  def self.show_cursor
+    if Reline::Terminfo.enabled?
+      @@output.write Reline::Terminfo.tigetstr('cnorm')
+    else
+      # ignored
+    end
+  end
+
   def self.erase_after_cursor
     @@output.write "\e[K"
   end
@@ -300,8 +312,6 @@ class Reline::ANSI
 
   def self.prep
     retrieve_keybuffer
-    int_handle = Signal.trap('INT', 'IGNORE')
-    Signal.trap('INT', int_handle)
     nil
   end
 

data/lib/reline/config.rb

@@ -65,6 +65,7 @@ class Reline::Config
     @history_size = -1 # unlimited
     @keyseq_timeout = 500
     @test_mode = false
+    @autocompletion = false
   end
 
   def reset
@@ -74,6 +75,7 @@ class Reline::Config
     @additional_key_bindings.keys.each do |key|
       @additional_key_bindings[key].clear
     end
+    reset_default_key_bindings
   end
 
   def editing_mode
@@ -88,6 +90,14 @@ class Reline::Config
     (val.respond_to?(:any?) ? val : [val]).any?(@editing_mode_label)
   end
 
+  def autocompletion=(val)
+    @autocompletion = val
+  end
+
+  def autocompletion
+    @autocompletion
+  end
+
   def keymap
     @key_actors[@keymap_label]
   end
@@ -157,8 +167,15 @@ class Reline::Config
   end
 
   def read_lines(lines, file = nil)
-    if lines.first.encoding != Reline.encoding_system_needs
-      lines = lines.map { |l| l.encode(Reline.encoding_system_needs) }
+    if not lines.empty? and lines.first.encoding != Reline.encoding_system_needs
+      begin
+        lines = lines.map do |l|
+          l.encode(Reline.encoding_system_needs)
+        rescue Encoding::UndefinedConversionError
+          mes = "The inputrc encoded in #{lines.first.encoding.name} can't be converted to the locale #{Reline.encoding_system_needs.name}."
+          raise Reline::ConfigEncodingConversionError.new(mes)
+        end
+      end
     end
     conditions = [@skip_section, @if_stack]
     @skip_section = nil

data/lib/reline/line_editor.rb

@@ -150,7 +150,8 @@ class Reline::LineEditor
     @screen_size = Reline::IOGate.get_screen_size
     @screen_height = @screen_size.first
     reset_variables(prompt, encoding: encoding)
-    @old_trap = Signal.trap('SIGINT') {
+    @old_trap = Signal.trap(:INT) {
+      clear_dialog
       if @scroll_partial_screen
         move_cursor_down(@screen_height - (@line_index - @scroll_partial_screen) - 1)
       else
@@ -158,8 +159,16 @@ class Reline::LineEditor
       end
       Reline::IOGate.move_cursor_column(0)
       scroll_down(1)
-      @old_trap.call if @old_trap.respond_to?(:call) # can also be string, ex: "DEFAULT"
-      raise Interrupt
+      case @old_trap
+      when 'DEFAULT', 'SYSTEM_DEFAULT'
+        raise Interrupt
+      when 'IGNORE'
+        # Do nothing
+      when 'EXIT'
+        exit
+      else
+        @old_trap.call
+      end
     }
     Reline::IOGate.set_winch_handler do
       @rest_height = (Reline::IOGate.get_screen_size.first - 1) - Reline::IOGate.cursor_pos.y
@@ -241,6 +250,7 @@ class Reline::LineEditor
     @drop_terminate_spaces = false
     @in_pasting = false
     @auto_indent_proc = nil
+    @dialogs = []
     reset_line
   end
 
@@ -406,6 +416,7 @@ class Reline::LineEditor
         Reline::IOGate.erase_after_cursor
       end
       @output.flush
+      clear_dialog
       return
     end
     new_highest_in_this = calculate_height_by_width(prompt_width + calculate_width(@line.nil? ? '' : @line))
@@ -416,6 +427,7 @@ class Reline::LineEditor
     else
       if @just_cursor_moving and not @rerender_all
         rendered = just_move_cursor
+        render_dialog((prompt_width + @cursor) % @screen_size.last)
         @just_cursor_moving = false
         return
       elsif @previous_line_index or new_highest_in_this != @highest_in_this
@@ -438,18 +450,20 @@ class Reline::LineEditor
           new_lines = whole_lines
         end
         line = modify_lines(new_lines)[@line_index]
+        clear_dialog
         prompt, prompt_width, prompt_list = check_multiline_prompt(new_lines, prompt)
         render_partial(prompt, prompt_width, line, @first_line_started_from)
         move_cursor_down(@highest_in_all - (@first_line_started_from + @highest_in_this - 1) - 1)
         scroll_down(1)
         Reline::IOGate.move_cursor_column(0)
         Reline::IOGate.erase_after_cursor
-      elsif not rendered
-        unless @in_pasting
+      else
+        if not rendered and not @in_pasting
           line = modify_lines(whole_lines)[@line_index]
           prompt, prompt_width, prompt_list = check_multiline_prompt(whole_lines, prompt)
           render_partial(prompt, prompt_width, line, @first_line_started_from)
         end
+        render_dialog((prompt_width + @cursor) % @screen_size.last)
       end
       @buffer_of_lines[@line_index] = @line
       @rest_height = 0 if @scroll_partial_screen
@@ -464,6 +478,294 @@ class Reline::LineEditor
     end
   end
 
+  class DialogProcScope
+    def initialize(line_editor, config, proc_to_exec, context)
+      @line_editor = line_editor
+      @config = config
+      @proc_to_exec = proc_to_exec
+      @context = context
+      @cursor_pos = Reline::CursorPos.new
+    end
+
+    def context
+      @context
+    end
+
+    def retrieve_completion_block(set_completion_quote_character = false)
+      @line_editor.retrieve_completion_block(set_completion_quote_character)
+    end
+
+    def call_completion_proc_with_checking_args(pre, target, post)
+      @line_editor.call_completion_proc_with_checking_args(pre, target, post)
+    end
+
+    def set_cursor_pos(col, row)
+      @cursor_pos.x = col
+      @cursor_pos.y = row
+    end
+
+    def cursor_pos
+      @cursor_pos
+    end
+
+    def just_cursor_moving
+      @line_editor.instance_variable_get(:@just_cursor_moving)
+    end
+
+    def screen_width
+      @line_editor.instance_variable_get(:@screen_size).last
+    end
+
+    def completion_journey_data
+      @line_editor.instance_variable_get(:@completion_journey_data)
+    end
+
+    def config
+      @config
+    end
+
+    def call
+      instance_exec(&@proc_to_exec)
+    end
+  end
+
+  class Dialog
+    attr_reader :name
+    attr_accessor :column, :vertical_offset, :contents, :lines_backup
+
+    def initialize(name, proc_scope)
+      @name = name
+      @proc_scope = proc_scope
+    end
+
+    def set_cursor_pos(col, row)
+      @proc_scope.set_cursor_pos(col, row)
+    end
+
+    def call
+      @proc_scope.call
+    end
+  end
+
+  def add_dialog_proc(name, p, context = nil)
+    return if @dialogs.any? { |d| d.name == name }
+    @dialogs << Dialog.new(name, DialogProcScope.new(self, @config, p, context))
+  end
+
+  DIALOG_HEIGHT = 20
+  DIALOG_WIDTH = 40
+  private def render_dialog(cursor_column)
+    @dialogs.each do |dialog|
+      render_each_dialog(dialog, cursor_column)
+    end
+  end
+
+  private def render_each_dialog(dialog, cursor_column)
+    if @in_pasting
+      dialog.contents = nil
+      return
+    end
+    dialog.set_cursor_pos(cursor_column, @first_line_started_from + @started_from)
+    pos, result, pointer, bg = dialog.call
+    old_dialog_contents = dialog.contents
+    old_dialog_column = dialog.column
+    old_dialog_vertical_offset = dialog.vertical_offset
+    if result and not result.empty?
+      dialog.contents = result
+      dialog.contents = dialog.contents[0...DIALOG_HEIGHT] if dialog.contents.size > DIALOG_HEIGHT
+    else
+      dialog.lines_backup = {
+        lines: modify_lines(whole_lines),
+        line_index: @line_index,
+        first_line_started_from: @first_line_started_from,
+        started_from: @started_from,
+        byte_pointer: @byte_pointer
+      }
+      clear_each_dialog(dialog)
+      dialog.contents = nil
+      return
+    end
+    upper_space = @first_line_started_from - @started_from
+    lower_space = @highest_in_all - @first_line_started_from - @started_from - 1
+    dialog.column = pos.x
+    diff = (dialog.column + DIALOG_WIDTH) - (@screen_size.last - 1)
+    if diff > 0
+      dialog.column -= diff
+    end
+    if (lower_space + @rest_height) >= DIALOG_HEIGHT
+      dialog.vertical_offset = pos.y + 1
+    elsif upper_space >= DIALOG_HEIGHT
+      dialog.vertical_offset = pos.y + -(DIALOG_HEIGHT + 1)
+    else
+      if (lower_space + @rest_height) < DIALOG_HEIGHT
+        scroll_down(DIALOG_HEIGHT)
+        move_cursor_up(DIALOG_HEIGHT)
+      end
+      dialog.vertical_offset = pos.y + 1
+    end
+    Reline::IOGate.hide_cursor
+    reset_dialog(dialog, old_dialog_contents, old_dialog_column, old_dialog_vertical_offset)
+    move_cursor_down(dialog.vertical_offset)
+    Reline::IOGate.move_cursor_column(dialog.column)
+    dialog.contents.each_with_index do |item, i|
+      if i == pointer
+        bg_color = '45'
+      else
+        if bg
+          bg_color = bg
+        else
+          bg_color = '46'
+        end
+      end
+      @output.write "\e[#{bg_color}m%-#{DIALOG_WIDTH}s\e[49m" % item.slice(0, DIALOG_WIDTH)
+      Reline::IOGate.move_cursor_column(dialog.column)
+      move_cursor_down(1) if i < (dialog.contents.size - 1)
+    end
+    Reline::IOGate.move_cursor_column(cursor_column)
+    move_cursor_up(dialog.vertical_offset + dialog.contents.size - 1)
+    Reline::IOGate.show_cursor
+    dialog.lines_backup = {
+      lines: modify_lines(whole_lines),
+      line_index: @line_index,
+      first_line_started_from: @first_line_started_from,
+      started_from: @started_from,
+      byte_pointer: @byte_pointer
+    }
+  end
+
+  private def reset_dialog(dialog, old_dialog_contents, old_dialog_column, old_dialog_vertical_offset)
+    return if dialog.lines_backup.nil? or old_dialog_contents.nil?
+    prompt, prompt_width, prompt_list = check_multiline_prompt(dialog.lines_backup[:lines], prompt)
+    visual_lines = []
+    visual_start = nil
+    dialog.lines_backup[:lines].each_with_index { |l, i|
+      pr = prompt_list ? prompt_list[i] : prompt
+      vl, _ = split_by_width(pr + l, @screen_size.last)
+      vl.compact!
+      if i == dialog.lines_backup[:line_index]
+        visual_start = visual_lines.size + dialog.lines_backup[:started_from]
+      end
+      visual_lines.concat(vl)
+    }
+    old_y = dialog.lines_backup[:first_line_started_from] + dialog.lines_backup[:started_from]
+    y = @first_line_started_from + @started_from
+    y_diff = y - old_y
+    if (old_y + old_dialog_vertical_offset) < (y + dialog.vertical_offset)
+      # rerender top
+      move_cursor_down(old_dialog_vertical_offset - y_diff)
+      start = visual_start + old_dialog_vertical_offset
+      line_num = dialog.vertical_offset - old_dialog_vertical_offset
+      line_num.times do |i|
+        Reline::IOGate.move_cursor_column(old_dialog_column)
+        if visual_lines[start + i].nil?
+          s = ' ' * DIALOG_WIDTH
+        else
+          s = Reline::Unicode.take_range(visual_lines[start + i], old_dialog_column, DIALOG_WIDTH)
+        end
+        @output.write "\e[39m\e[49m%-#{DIALOG_WIDTH}s\e[39m\e[49m" % s
+        move_cursor_down(1) if i < (line_num - 1)
+      end
+      move_cursor_up(old_dialog_vertical_offset + line_num - 1 - y_diff)
+    end
+    if (old_y + old_dialog_vertical_offset + old_dialog_contents.size) > (y + dialog.vertical_offset + dialog.contents.size)
+      # rerender bottom
+      move_cursor_down(dialog.vertical_offset + dialog.contents.size - y_diff)
+      start = visual_start + dialog.vertical_offset + dialog.contents.size
+      line_num = (old_dialog_vertical_offset + old_dialog_contents.size) - (dialog.vertical_offset + dialog.contents.size)
+      line_num.times do |i|
+        Reline::IOGate.move_cursor_column(old_dialog_column)
+        if visual_lines[start + i].nil?
+          s = ' ' * DIALOG_WIDTH
+        else
+          s = Reline::Unicode.take_range(visual_lines[start + i], old_dialog_column, DIALOG_WIDTH)
+        end
+        @output.write "\e[39m\e[49m%-#{DIALOG_WIDTH}s\e[39m\e[49m" % s
+        move_cursor_down(1) if i < (line_num - 1)
+      end
+      move_cursor_up(dialog.vertical_offset + dialog.contents.size + line_num - 1 - y_diff)
+    end
+    if old_dialog_column < dialog.column
+      # rerender left
+      move_cursor_down(old_dialog_vertical_offset - y_diff)
+      width = dialog.column - old_dialog_column
+      start = visual_start + old_dialog_vertical_offset
+      line_num = old_dialog_contents.size
+      line_num.times do |i|
+        Reline::IOGate.move_cursor_column(old_dialog_column)
+        if visual_lines[start + i].nil?
+          s = ' ' * width
+        else
+          s = Reline::Unicode.take_range(visual_lines[start + i], old_dialog_column, width)
+        end
+        @output.write "\e[39m\e[49m%-#{width}s\e[39m\e[49m" % s
+        move_cursor_down(1) if i < (line_num - 1)
+      end
+      move_cursor_up(old_dialog_vertical_offset + line_num - 1 - y_diff)
+    end
+    if (old_dialog_column + DIALOG_WIDTH) > (dialog.column + DIALOG_WIDTH)
+      # rerender right
+      move_cursor_down(old_dialog_vertical_offset + y_diff)
+      width = (old_dialog_column + DIALOG_WIDTH) - (dialog.column + DIALOG_WIDTH)
+      start = visual_start + old_dialog_vertical_offset
+      line_num = old_dialog_contents.size
+      line_num.times do |i|
+        Reline::IOGate.move_cursor_column(old_dialog_column + DIALOG_WIDTH)
+        if visual_lines[start + i].nil?
+          s = ' ' * width
+        else
+          s = Reline::Unicode.take_range(visual_lines[start + i], old_dialog_column + DIALOG_WIDTH, width)
+        end
+        Reline::IOGate.move_cursor_column(dialog.column + DIALOG_WIDTH)
+        @output.write "\e[39m\e[49m%-#{width}s\e[39m\e[49m" % s
+        move_cursor_down(1) if i < (line_num - 1)
+      end
+      move_cursor_up(old_dialog_vertical_offset + line_num - 1 + y_diff)
+    end
+    Reline::IOGate.move_cursor_column((prompt_width + @cursor) % @screen_size.last)
+  end
+
+  private def clear_dialog
+    @dialogs.each do |dialog|
+      clear_each_dialog(dialog)
+    end
+  end
+
+  private def clear_each_dialog(dialog)
+    return unless dialog.contents
+    prompt, prompt_width, prompt_list = check_multiline_prompt(dialog.lines_backup[:lines], prompt)
+    visual_lines = []
+    visual_lines_under_dialog = []
+    visual_start = nil
+    dialog.lines_backup[:lines].each_with_index { |l, i|
+      pr = prompt_list ? prompt_list[i] : prompt
+      vl, _ = split_by_width(pr + l, @screen_size.last)
+      vl.compact!
+      if i == dialog.lines_backup[:line_index]
+        visual_start = visual_lines.size + dialog.lines_backup[:started_from] + dialog.vertical_offset
+      end
+      visual_lines.concat(vl)
+    }
+    visual_lines_under_dialog = visual_lines[visual_start, dialog.contents.size]
+    visual_lines_under_dialog = [] if visual_lines_under_dialog.nil?
+    Reline::IOGate.hide_cursor
+    move_cursor_down(dialog.vertical_offset)
+    dialog_vertical_size = dialog.contents.size
+    dialog_vertical_size.times do |i|
+      if i < visual_lines_under_dialog.size
+        Reline::IOGate.move_cursor_column(0)
+        @output.write "\e[39m\e[49m%-#{DIALOG_WIDTH}s\e[39m\e[49m" % visual_lines_under_dialog[i]
+      else
+        Reline::IOGate.move_cursor_column(dialog.column)
+        @output.write "\e[39m\e[49m#{' ' * DIALOG_WIDTH}\e[39m\e[49m"
+      end
+      Reline::IOGate.erase_after_cursor
+      move_cursor_down(1) if i < (dialog_vertical_size - 1)
+    end
+    move_cursor_up(dialog_vertical_size - 1 + dialog.vertical_offset)
+    Reline::IOGate.move_cursor_column((prompt_width + @cursor) % @screen_size.last)
+    Reline::IOGate.show_cursor
+  end
+
   private def calculate_scroll_partial_screen(highest_in_all, cursor_y)
     if @screen_height < highest_in_all
       old_scroll_partial_screen = @scroll_partial_screen
@@ -924,6 +1226,16 @@ class Reline::LineEditor
       @completion_journey_data = CompletionJourneyData.new(
         preposing, postposing,
         [target] + list.select{ |item| item.start_with?(target) }, 0)
+      if @completion_journey_data.list.size == 1
+        @completion_journey_data.pointer = 0
+      else
+        case direction
+        when :up
+          @completion_journey_data.pointer = @completion_journey_data.list.size - 1
+        when :down
+          @completion_journey_data.pointer = 1
+        end
+      end
       @completion_state = CompletionState::JOURNEY
     else
       case direction
@@ -938,13 +1250,13 @@ class Reline::LineEditor
           @completion_journey_data.pointer = 0
         end
       end
-      completed = @completion_journey_data.list[@completion_journey_data.pointer]
-      @line = @completion_journey_data.preposing + completed + @completion_journey_data.postposing
-      line_to_pointer = @completion_journey_data.preposing + completed
-      @cursor_max = calculate_width(@line)
-      @cursor = calculate_width(line_to_pointer)
-      @byte_pointer = line_to_pointer.bytesize
     end
+    completed = @completion_journey_data.list[@completion_journey_data.pointer]
+    @line = @completion_journey_data.preposing + completed + @completion_journey_data.postposing
+    line_to_pointer = @completion_journey_data.preposing + completed
+    @cursor_max = calculate_width(@line)
+    @cursor = calculate_width(line_to_pointer)
+    @byte_pointer = line_to_pointer.bytesize
   end
 
   private def run_for_operators(key, method_symbol, &block)
@@ -1119,7 +1431,20 @@ class Reline::LineEditor
         if result.is_a?(Array)
           completion_occurs = true
           process_insert
-          complete(result)
+          if @config.autocompletion
+            move_completed_list(result, :down)
+          else
+            complete(result)
+          end
+        end
+      end
+    elsif @config.editing_mode_is?(:emacs, :vi_insert) and key.char == :completion_journey_up
+      if not @config.disable_completion and @config.autocompletion
+        result = call_completion_proc
+        if result.is_a?(Array)
+          completion_occurs = true
+          process_insert
+          move_completed_list(result, :up)
         end
       end
     elsif not @config.disable_completion and @config.editing_mode_is?(:vi_insert) and ["\C-p".ord, "\C-n".ord].include?(key.char)
@@ -1138,6 +1463,7 @@ class Reline::LineEditor
     end
     unless completion_occurs
       @completion_state = CompletionState::NORMAL
+      @completion_journey_data = nil
     end
     if not @in_pasting and @just_cursor_moving.nil?
       if @previous_line_index and @buffer_of_lines[@previous_line_index] == @line
@@ -1157,7 +1483,13 @@ class Reline::LineEditor
 
   def call_completion_proc
     result = retrieve_completion_block(true)
-    preposing, target, postposing = result
+    pre, target, post = result
+    result = call_completion_proc_with_checking_args(pre, target, post)
+    Reline.core.instance_variable_set(:@completion_quote_character, nil)
+    result
+  end
+
+  def call_completion_proc_with_checking_args(pre, target, post)
     if @completion_proc and target
       argnum = @completion_proc.parameters.inject(0) { |result, item|
         case item.first
@@ -1171,12 +1503,11 @@ class Reline::LineEditor
       when 1
         result = @completion_proc.(target)
       when 2
-        result = @completion_proc.(target, preposing)
+        result = @completion_proc.(target, pre)
       when 3..Float::INFINITY
-        result = @completion_proc.(target, preposing, postposing)
+        result = @completion_proc.(target, pre, post)
       end
     end
-    Reline.core.instance_variable_set(:@completion_quote_character, nil)
     result
   end
 

data/lib/reline/terminfo.rb

@@ -6,12 +6,39 @@ module Reline::Terminfo
 
   class TerminfoError < StandardError; end
 
-  @curses_dl = nil
+  def self.curses_dl_files
+    case RUBY_PLATFORM
+    when /mingw/, /mswin/
+      # aren't supported
+      []
+    when /cygwin/
+      %w[cygncursesw-10.dll cygncurses-10.dll]
+    when /darwin/
+      %w[libncursesw.dylib libcursesw.dylib libncurses.dylib libcurses.dylib]
+    else
+      %w[libncursesw.so libcursesw.so libncurses.so libcurses.so]
+    end
+  end
+
+  @curses_dl = false
   def self.curses_dl
-    return @curses_dl if @curses_dl
-    if Fiddle.const_defined?(:VERSION) and Gem::Version.create(Fiddle::VERSION) >= Gem::Version.create('1.0.1')
+    return @curses_dl unless @curses_dl == false
+    if RUBY_VERSION >= '3.0.0'
+      # Gem module isn't defined in test-all of the Ruby repository, and
+      # Fiddle in Ruby 3.0.0 or later supports Fiddle::TYPE_VARIADIC.
+      fiddle_supports_variadic = true
+    elsif Fiddle.const_defined?(:VERSION) and Gem::Version.create(Fiddle::VERSION) >= Gem::Version.create('1.0.1')
       # Fiddle::TYPE_VARIADIC is supported from Fiddle 1.0.1.
-      %w[libncursesw.so libcursesw.so libncurses.so libcurses.so].each do |curses_name|
+      fiddle_supports_variadic = true
+    else
+      fiddle_supports_variadic = false
+    end
+    if fiddle_supports_variadic and not Fiddle.const_defined?(:TYPE_VARIADIC)
+      # If the libffi version is not 3.0.5 or higher, there isn't TYPE_VARIADIC.
+      fiddle_supports_variadic = false
+    end
+    if fiddle_supports_variadic
+      curses_dl_files.each do |curses_name|
         result = Fiddle::Handle.new(curses_name)
       rescue Fiddle::DLError
         next
@@ -20,6 +47,7 @@ module Reline::Terminfo
         break
       end
     end
+    @curses_dl = nil if @curses_dl == false
     @curses_dl
   end
 end
@@ -30,8 +58,15 @@ module Reline::Terminfo
   @setupterm = Fiddle::Function.new(curses_dl['setupterm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_INT, Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
   #extern 'char *tigetstr(char *capname)'
   @tigetstr = Fiddle::Function.new(curses_dl['tigetstr'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_VOIDP)
-  #extern 'char *tiparm(const char *str, ...)'
-  @tiparm = Fiddle::Function.new(curses_dl['tiparm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VARIADIC], Fiddle::TYPE_VOIDP)
+  begin
+    #extern 'char *tiparm(const char *str, ...)'
+    @tiparm = Fiddle::Function.new(curses_dl['tiparm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VARIADIC], Fiddle::TYPE_VOIDP)
+  rescue Fiddle::DLError
+    # OpenBSD lacks tiparm
+    #extern 'char *tparm(const char *str, ...)'
+    @tiparm = Fiddle::Function.new(curses_dl['tparm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VARIADIC], Fiddle::TYPE_VOIDP)
+  end
+  # TODO: add int tigetflag(char *capname) and int tigetnum(char *capname)
 
   def self.setupterm(term, fildes)
     errret_int = String.new("\x00" * 8, encoding: 'ASCII-8BIT')
@@ -56,12 +91,19 @@ module Reline::Terminfo
     end
   end
 
-  def self.tigetstr(capname)
-    result = @tigetstr.(capname).to_s
-    def result.tiparm(*args) # for method chain
+  class StringWithTiparm < String
+    def tiparm(*args) # for method chain
       Reline::Terminfo.tiparm(self, *args)
     end
-    result
+  end
+
+  def self.tigetstr(capname)
+    capability = @tigetstr.(capname)
+    case capability.to_i
+    when 0, -1
+      raise TerminfoError, "can't find capability: #{capname}"
+    end
+    StringWithTiparm.new(capability.to_s)
   end
 
   def self.tiparm(str, *args)

data/lib/reline/unicode.rb

@@ -185,6 +185,36 @@ class Reline::Unicode
     [lines, height]
   end
 
+  # Take a chunk of a String with escape sequences.
+  def self.take_range(str, col, length, encoding = str.encoding)
+    chunk = String.new(encoding: encoding)
+    width = 0
+    rest = str.encode(Encoding::UTF_8)
+    in_zero_width = false
+    rest.scan(WIDTH_SCANNER) do |gc|
+      case
+      when gc[NON_PRINTING_START_INDEX]
+        in_zero_width = true
+      when gc[NON_PRINTING_END_INDEX]
+        in_zero_width = false
+      when gc[CSI_REGEXP_INDEX]
+        chunk << gc[CSI_REGEXP_INDEX]
+      when gc[OSC_REGEXP_INDEX]
+        chunk << gc[OSC_REGEXP_INDEX]
+      when gc[GRAPHEME_CLUSTER_INDEX]
+        gc = gc[GRAPHEME_CLUSTER_INDEX]
+        if in_zero_width
+          chunk << gc
+        else
+          width = get_mbchar_width(gc)
+          break if (width + length) <= col
+          chunk << gc if col <= width
+        end
+      end
+    end
+    chunk
+  end
+
   def self.get_next_mbchar_size(line, byte_pointer)
     grapheme = line.byteslice(byte_pointer..-1).grapheme_clusters.first
     grapheme ? grapheme.bytesize : 0

data/lib/reline/version.rb

@@ -1,3 +1,3 @@
 module Reline
-  VERSION = '0.2.6'
+  VERSION = '0.2.8.pre.3'
 end

data/lib/reline/windows.rb

@@ -42,6 +42,14 @@ class Reline::Windows
     }.each_pair do |key, func|
       config.add_default_key_binding_by_keymap(:emacs, key, func)
     end
+
+    # Emulate ANSI key sequence.
+    {
+      [27, 91, 90] => :completion_journey_up, # S-Tab
+    }.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)
+    end
   end
 
   if defined? JRUBY_VERSION
@@ -91,6 +99,7 @@ class Reline::Windows
   VK_LMENU = 0xA4
   VK_CONTROL = 0x11
   VK_SHIFT = 0x10
+  VK_DIVIDE = 0x6F
 
   KEY_EVENT = 0x01
   WINDOW_BUFFER_SIZE_EVENT = 0x04
@@ -105,6 +114,7 @@ class Reline::Windows
   SCROLLLOCK_ON = 0x0040
   SHIFT_PRESSED = 0x0010
 
+  VK_TAB = 0x09
   VK_END = 0x23
   VK_HOME = 0x24
   VK_LEFT = 0x25
@@ -132,9 +142,11 @@ class Reline::Windows
   @@GetFileType = Win32API.new('kernel32', 'GetFileType', ['L'], 'L')
   @@GetFileInformationByHandleEx = Win32API.new('kernel32', 'GetFileInformationByHandleEx', ['L', 'I', 'P', 'L'], 'I')
   @@FillConsoleOutputAttribute = Win32API.new('kernel32', 'FillConsoleOutputAttribute', ['L', 'L', 'L', 'L', 'P'], 'L')
+  @@SetConsoleCursorInfo = Win32API.new('kernel32', 'SetConsoleCursorInfo', ['L', 'P'], 'L')
 
   @@GetConsoleMode = Win32API.new('kernel32', 'GetConsoleMode', ['L', 'P'], 'L')
   @@SetConsoleMode = Win32API.new('kernel32', 'SetConsoleMode', ['L', 'L'], 'L')
+  @@WaitForSingleObject = Win32API.new('kernel32', 'WaitForSingleObject', ['L', 'L'], 'L')
   ENABLE_VIRTUAL_TERMINAL_PROCESSING = 4
 
   private_class_method def self.getconsolemode
@@ -180,51 +192,47 @@ class Reline::Windows
     name =~ /(msys-|cygwin-).*-pty/ ? true : false
   end
 
+  KEY_MAP = [
+    # It's treated as Meta+Enter on Windows.
+    [ { control_keys: :CTRL,  virtual_key_code: 0x0D }, "\e\r".bytes ],
+    [ { control_keys: :SHIFT, virtual_key_code: 0x0D }, "\e\r".bytes ],
+
+    # It's treated as Meta+Space on Windows.
+    [ { control_keys: :CTRL,  char_code: 0x20 }, "\e ".bytes ],
+
+    # Emulate getwch() key sequences.
+    [ { control_keys: [], virtual_key_code: VK_UP },     [0, 72] ],
+    [ { control_keys: [], virtual_key_code: VK_DOWN },   [0, 80] ],
+    [ { control_keys: [], virtual_key_code: VK_RIGHT },  [0, 77] ],
+    [ { control_keys: [], virtual_key_code: VK_LEFT },   [0, 75] ],
+    [ { control_keys: [], virtual_key_code: VK_DELETE }, [0, 83] ],
+    [ { control_keys: [], virtual_key_code: VK_HOME },   [0, 71] ],
+    [ { control_keys: [], virtual_key_code: VK_END },    [0, 79] ],
+
+    # Emulate ANSI key sequence.
+    [ { control_keys: :SHIFT, virtual_key_code: VK_TAB }, [27, 91, 90] ],
+  ]
+
   def self.process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)
-    char = char_code.chr(Encoding::UTF_8)
-    if char_code == 0x0D and control_key_state.anybits?(LEFT_CTRL_PRESSED | RIGHT_CTRL_PRESSED | SHIFT_PRESSED)
-      # It's treated as Meta+Enter on Windows.
-      @@output_buf.push("\e".ord)
-      @@output_buf.push(char_code)
-    elsif char_code == 0x20 and control_key_state.anybits?(LEFT_CTRL_PRESSED | RIGHT_CTRL_PRESSED)
-      # It's treated as Meta+Space on Windows.
-      @@output_buf.push("\e".ord)
-      @@output_buf.push(char_code)
-    elsif control_key_state.anybits?(LEFT_ALT_PRESSED | RIGHT_ALT_PRESSED)
-      @@output_buf.push("\e".ord)
-      @@output_buf.concat(char.bytes)
-    elsif control_key_state.anybits?(ENHANCED_KEY)
-      case virtual_key_code # Emulate getwch() key sequences.
-      when VK_END
-        @@output_buf.push(0, 79)
-      when VK_HOME
-        @@output_buf.push(0, 71)
-      when VK_LEFT
-        @@output_buf.push(0, 75)
-      when VK_UP
-        @@output_buf.push(0, 72)
-      when VK_RIGHT
-        @@output_buf.push(0, 77)
-      when VK_DOWN
-        @@output_buf.push(0, 80)
-      when VK_DELETE
-        @@output_buf.push(0, 83)
-      end
-    elsif char_code == 0 and control_key_state != 0
-      # unknown
-    else
-      case virtual_key_code
-      when VK_RETURN
-        @@output_buf.push("\n".ord)
-      else
-        @@output_buf.concat(char.bytes)
-      end
+
+    key = KeyEventRecord.new(virtual_key_code, char_code, control_key_state)
+
+    match = KEY_MAP.find { |args,| key.matches?(**args) }
+    unless match.nil?
+      @@output_buf.concat(match.last)
+      return
     end
+
+    # no char, only control keys
+    return if key.char_code == 0 and key.control_keys.any?
+
+    @@output_buf.concat(key.char.bytes)
   end
 
   def self.check_input_event
     num_of_events = 0.chr * 8
     while @@output_buf.empty? #or true
+      next if @@WaitForSingleObject.(@@hConsoleInputHandle, 100) != 0 # max 0.1 sec
       next if @@GetNumberOfConsoleInputEvents.(@@hConsoleInputHandle, num_of_events) == 0 or num_of_events.unpack('L').first == 0
       input_record = 0.chr * 18
       read_event = 0.chr * 4
@@ -348,6 +356,20 @@ class Reline::Windows
     raise NotImplementedError
   end
 
+  def self.hide_cursor
+    size = 100
+    visible = 0 # 0 means false
+    cursor_info = [size, visible].pack('Li')
+    @@SetConsoleCursorInfo.call(@@hConsoleHandle, cursor_info)
+  end
+
+  def self.show_cursor
+    size = 100
+    visible = 1 # 1 means true
+    cursor_info = [size, visible].pack('Li')
+    @@SetConsoleCursorInfo.call(@@hConsoleHandle, cursor_info)
+  end
+
   def self.set_winch_handler(&handler)
     @@winch_handler = handler
   end
@@ -360,4 +382,43 @@ class Reline::Windows
   def self.deprep(otio)
     # do nothing
   end
+
+  class KeyEventRecord
+
+    attr_reader :virtual_key_code, :char_code, :control_key_state, :control_keys
+
+    def initialize(virtual_key_code, char_code, control_key_state)
+      @virtual_key_code = virtual_key_code
+      @char_code = char_code
+      @control_key_state = control_key_state
+      @enhanced = control_key_state & ENHANCED_KEY != 0
+
+      (@control_keys = []).tap do |control_keys|
+        # symbols must be sorted to make comparison is easier later on
+        control_keys << :ALT   if control_key_state & (LEFT_ALT_PRESSED | RIGHT_ALT_PRESSED) != 0
+        control_keys << :CTRL  if control_key_state & (LEFT_CTRL_PRESSED | RIGHT_CTRL_PRESSED) != 0
+        control_keys << :SHIFT if control_key_state & SHIFT_PRESSED != 0
+      end.freeze
+    end
+
+    def char
+      @char_code.chr(Encoding::UTF_8)
+    end
+
+    def enhanced?
+      @enhanced
+    end
+
+    # 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)
+      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) &&
+      (virtual_key_code.nil? || @virtual_key_code == virtual_key_code) &&
+      (char_code.nil? || char_code == @char_code)
+    end
+
+  end
 end

data/lib/reline.rb

@@ -7,12 +7,15 @@ require 'reline/key_actor'
 require 'reline/key_stroke'
 require 'reline/line_editor'
 require 'reline/history'
+require 'reline/terminfo'
 require 'rbconfig'
 
 module Reline
   FILENAME_COMPLETION_PROC = nil
   USERNAME_COMPLETION_PROC = nil
 
+  class ConfigEncodingConversionError < StandardError; end
+
   Key = Struct.new('Key', :char, :combined_char, :with_meta)
   CursorPos = Struct.new(:x, :y)
 
@@ -41,6 +44,7 @@ module Reline
 
     def initialize
       self.output = STDOUT
+      @dialog_proc_list = []
       yield self
       @completion_quote_character = nil
       @bracketed_paste_finished = false
@@ -103,6 +107,14 @@ module Reline
       @completion_proc = p
     end
 
+    def autocompletion
+      @config.autocompletion
+    end
+
+    def autocompletion=(val)
+      @config.autocompletion = val
+    end
+
     def output_modifier_proc=(p)
       raise ArgumentError unless p.respond_to?(:call) or p.nil?
       @output_modifier_proc = p
@@ -127,6 +139,12 @@ module Reline
       @dig_perfect_match_proc = p
     end
 
+    def add_dialog_proc(name_sym, p, context = nil)
+      raise ArgumentError unless p.respond_to?(:call) or p.nil?
+      raise ArgumentError unless name_sym.instance_of?(Symbol)
+      @dialog_proc_list << [name_sym, p, context]
+    end
+
     def input=(val)
       raise TypeError unless val.respond_to?(:getc) or val.nil?
       if val.respond_to?(:getc)
@@ -168,6 +186,45 @@ module Reline
       Reline::IOGate.get_screen_size
     end
 
+    Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE = ->() {
+      # autocomplete
+      return nil unless config.autocompletion
+      if just_cursor_moving and completion_journey_data.nil?
+        # Auto complete starts only when edited
+        return nil
+      end
+      pre, target, post= retrieve_completion_block(true)
+      if target.nil? or target.empty?# or target.size <= 3
+        return nil
+      end
+      if completion_journey_data and completion_journey_data.list
+        result = completion_journey_data.list.dup
+        result.shift
+        pointer = completion_journey_data.pointer - 1
+      else
+        result = call_completion_proc_with_checking_args(pre, target, post)
+        pointer = nil
+      end
+      if result and result.size == 1 and result[0] == target
+        result = nil
+      end
+      target_width = Reline::Unicode.calculate_width(target)
+      x = cursor_pos.x - target_width
+      if x < 0
+        x = screen_width + x
+        y = -1
+      else
+        y = 0
+      end
+      cursor_pos_to_render = Reline::CursorPos.new(x, y)
+      if context and context.is_a?(Array)
+        context.clear
+        context.push(cursor_pos_to_render, result, pointer)
+      end
+      [cursor_pos_to_render, result, pointer, nil]
+    }
+    Reline::DEFAULT_DIALOG_CONTEXT = Array.new
+
     def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
       unless confirm_multiline_termination
         raise ArgumentError.new('#readmultiline needs block to confirm multiline termination')
@@ -227,6 +284,10 @@ 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
+      @dialog_proc_list.each do |d|
+        name_sym, dialog_proc, context = d
+        line_editor.add_dialog_proc(name_sym, dialog_proc, context)
+      end
 
       unless config.test_mode
         config.read
@@ -421,6 +482,8 @@ module Reline
   def_single_delegators :core, :ambiguous_width
   def_single_delegators :core, :last_incremental_search
   def_single_delegators :core, :last_incremental_search=
+  def_single_delegators :core, :add_dialog_proc
+  def_single_delegators :core, :autocompletion, :autocompletion=
 
   def_single_delegators :core, :readmultiline
   def_instance_delegators self, :readmultiline
@@ -442,6 +505,7 @@ module Reline
       core.completer_quote_characters = '"\''
       core.filename_quote_characters = ""
       core.special_prefixes = ""
+      core.add_dialog_proc(:autocomplete, Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE, Reline::DEFAULT_DIALOG_CONTEXT)
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reline
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8.pre.3
 platform: ruby
 authors:
 - aycabta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: io-console
@@ -69,11 +69,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Alternative GNU Readline or Editline implementation by pure Ruby.