reline 0.2.8.pre.1 → 0.2.8.pre.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c1dd7202ef6de3ebf89e2ed39c83af1e48bcd46d5f967037edc0097301b8286
-  data.tar.gz: 4d2047341862d83b785903974e4766b5a3d481a033208bfcc1d8891a0b116e65
+  metadata.gz: fca2b6f76f8c59a18589d6d730f7f159e25b95e639ae7d6866f772e9bb2655ab
+  data.tar.gz: 61b69c3d01f74b957c6a2d646e58021cad4b49031d4fdf6437f2303d417d5f36
 SHA512:
-  metadata.gz: a9109bb68de735bd5dba6de8dffecfd23fecd8f09aa0b1f92d0bca6b008ef7c3d3785c16292db8ea90c9baf4d275ef382cd6d0d15487fbe6e491c74a670004bd
-  data.tar.gz: af8f8b99ceb34416253857caf4d87a07bde1fddf72d80ff14caeb2a5940178566bd63fc4a6884eddd60959ac3f352c056bb73bbe646915582b5b3b4d091beeed
+  metadata.gz: 561ffdbf39c095852f0a642178d5328329cea072fdc91c32bd11edfdcecb4846414006961b6fe7adbf63c825022a8634d5a563fdeb574d127088b536967e1f9c
+  data.tar.gz: 07e62e55ca7a45d3b747724823b26af09d109f9620ba82914cfaf7e6100251bb76bd0de7b01b9829b51e41248a32b028bbbb3617c7d4eedfc2c1d05ab701a236

data/lib/reline/ansi.rb

@@ -37,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

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
@@ -89,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

data/lib/reline/line_editor.rb

@@ -479,8 +479,9 @@ class Reline::LineEditor
   end
 
   class DialogProcScope
-    def initialize(line_editor, proc_to_exec, context)
+    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
@@ -498,6 +499,14 @@ class Reline::LineEditor
       @line_editor.call_completion_proc_with_checking_args(pre, target, post)
     end
 
+    def set_dialog(dialog)
+      @dialog = dialog
+    end
+
+    def dialog
+      @dialog
+    end
+
     def set_cursor_pos(col, row)
       @cursor_pos.x = col
       @cursor_pos.y = row
@@ -519,32 +528,50 @@ class Reline::LineEditor
       @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
+    attr_reader :name, :contents, :width
+    attr_accessor :scroll_top, :column, :vertical_offset, :lines_backup
 
     def initialize(name, proc_scope)
       @name = name
       @proc_scope = proc_scope
+      @width = nil
+      @scroll_top = 0
     end
 
     def set_cursor_pos(col, row)
       @proc_scope.set_cursor_pos(col, row)
     end
 
+    def width=(v)
+      @width = v
+    end
+
+    def contents=(contents)
+      @contents = contents
+      if contents and @width.nil?
+        @width = contents.map{ |line| Reline::Unicode.calculate_width(line, true) }.max
+      end
+    end
+
     def call
+      @proc_scope.set_dialog(self)
       @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, p, context))
+    @dialogs << Dialog.new(name, DialogProcScope.new(self, @config, p, context))
   end
 
   DIALOG_HEIGHT = 20
@@ -561,13 +588,26 @@ class Reline::LineEditor
       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
+    dialog_render_info = dialog.call
+    dialog.width = dialog_render_info.width if dialog_render_info and dialog_render_info.width
+    old_dialog = dialog.clone
+    if dialog_render_info and dialog_render_info.contents and not dialog_render_info.contents.empty?
+      height = dialog_render_info.height || DIALOG_HEIGHT
+      pointer = dialog_render_info.pointer
+      dialog.contents = dialog_render_info.contents
+      if dialog.contents.size > height
+        if dialog_render_info.pointer
+          if dialog_render_info.pointer < 0
+            dialog.scroll_top = 0
+          elsif (dialog_render_info.pointer - dialog.scroll_top) >= (height - 1)
+            dialog.scroll_top = dialog_render_info.pointer - (height - 1)
+          elsif (dialog_render_info.pointer - dialog.scroll_top) < 0
+            dialog.scroll_top = dialog_render_info.pointer
+          end
+          pointer = dialog_render_info.pointer - dialog.scroll_top
+        end
+        dialog.contents = dialog.contents[dialog.scroll_top, height]
+      end
     else
       dialog.lines_backup = {
         lines: modify_lines(whole_lines),
@@ -582,37 +622,37 @@ class Reline::LineEditor
     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)
+    dialog.column = dialog_render_info.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)
+    if (lower_space + @rest_height - dialog_render_info.pos.y) >= height
+      dialog.vertical_offset = dialog_render_info.pos.y + 1
+    elsif upper_space >= height
+      dialog.vertical_offset = dialog_render_info.pos.y + -(height + 1)
     else
-      if (lower_space + @rest_height) < DIALOG_HEIGHT
-        scroll_down(DIALOG_HEIGHT)
-        move_cursor_up(DIALOG_HEIGHT)
+      if (lower_space + @rest_height - dialog_render_info.pos.y) < height
+        scroll_down(height + dialog_render_info.pos.y)
+        move_cursor_up(height + dialog_render_info.pos.y)
       end
-      dialog.vertical_offset = pos.y + 1
+      dialog.vertical_offset = dialog_render_info.pos.y + 1
     end
     Reline::IOGate.hide_cursor
-    reset_dialog(dialog, old_dialog_contents, old_dialog_column, old_dialog_vertical_offset)
+    reset_dialog(dialog, old_dialog)
     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
+        if dialog_render_info.bg_color
+          bg_color = dialog_render_info.bg_color
         else
           bg_color = '46'
         end
       end
-      @output.write "\e[#{bg_color}m%-#{DIALOG_WIDTH}s\e[49m" % item.slice(0, DIALOG_WIDTH)
+      @output.write "\e[#{bg_color}m%-#{dialog.width}s\e[49m" % Reline::Unicode.take_range(item, 0, dialog.width)
       Reline::IOGate.move_cursor_column(dialog.column)
       move_cursor_down(1) if i < (dialog.contents.size - 1)
     end
@@ -628,8 +668,8 @@ class Reline::LineEditor
     }
   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?
+  private def reset_dialog(dialog, old_dialog)
+    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
@@ -645,76 +685,76 @@ class Reline::LineEditor
     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)
+    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
+      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)
+        Reline::IOGate.move_cursor_column(old_dialog.column)
         if visual_lines[start + i].nil?
-          s = ' ' * DIALOG_WIDTH
+          s = ' ' * dialog.width
         else
-          s = Reline::Unicode.take_range(visual_lines[start + i], old_dialog_column, DIALOG_WIDTH)
+          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
+        @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)
+      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)
+    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 = (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)
+        Reline::IOGate.move_cursor_column(old_dialog.column)
         if visual_lines[start + i].nil?
-          s = ' ' * DIALOG_WIDTH
+          s = ' ' * dialog.width
         else
-          s = Reline::Unicode.take_range(visual_lines[start + i], old_dialog_column, DIALOG_WIDTH)
+          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
+        @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
+    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
+      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)
+        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)
+          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)
+      move_cursor_up(old_dialog.vertical_offset + line_num - 1 - y_diff)
     end
-    if (old_dialog_column + DIALOG_WIDTH) > (dialog.column + DIALOG_WIDTH)
+    if (old_dialog.column + old_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
+      move_cursor_down(old_dialog.vertical_offset + y_diff)
+      width = (old_dialog.column + old_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)
+        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)
+          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)
+        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)
+      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
@@ -748,10 +788,10 @@ class Reline::LineEditor
     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]
+        @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"
+        @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)
@@ -1426,7 +1466,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)

data/lib/reline/unicode.rb

@@ -186,9 +186,9 @@ class Reline::Unicode
   end
 
   # Take a chunk of a String with escape sequences.
-  def self.take_range(str, col, length, encoding = str.encoding)
+  def self.take_range(str, start_col, max_width, encoding = str.encoding)
     chunk = String.new(encoding: encoding)
-    width = 0
+    total_width = 0
     rest = str.encode(Encoding::UTF_8)
     in_zero_width = false
     rest.scan(WIDTH_SCANNER) do |gc|
@@ -206,9 +206,10 @@ class Reline::Unicode
         if in_zero_width
           chunk << gc
         else
-          width = get_mbchar_width(gc)
-          break if (width + length) <= col
-          chunk << gc if col <= width
+          mbchar_width = get_mbchar_width(gc)
+          total_width += mbchar_width
+          break if (start_col + max_width) < total_width
+          chunk << gc if start_col < total_width
         end
       end
     end

data/lib/reline/version.rb

@@ -1,3 +1,3 @@
 module Reline
-  VERSION = '0.2.8.pre.1'
+  VERSION = '0.2.8.pre.5'
 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
@@ -106,6 +114,7 @@ class Reline::Windows
   SCROLLLOCK_ON = 0x0040
   SHIFT_PRESSED = 0x0010
 
+  VK_TAB = 0x09
   VK_END = 0x23
   VK_HOME = 0x24
   VK_LEFT = 0x25
@@ -199,6 +208,9 @@ class Reline::Windows
     [ { 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)

data/lib/reline.rb

@@ -18,6 +18,7 @@ module Reline
 
   Key = Struct.new('Key', :char, :combined_char, :with_meta)
   CursorPos = Struct.new(:x, :y)
+  DialogRenderInfo = Struct.new(:pos, :contents, :pointer, :bg_color, :width, :height, keyword_init: true)
 
   class Core
     ATTR_READER_NAMES = %i(
@@ -107,6 +108,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
@@ -180,6 +189,7 @@ module Reline
 
     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
@@ -210,9 +220,9 @@ module Reline
       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)
+        context.push(cursor_pos_to_render, result, pointer, dialog)
       end
-      [cursor_pos_to_render, result, pointer, nil]
+      DialogRenderInfo.new(pos: cursor_pos_to_render, contents: result, pointer: pointer, height: 15)
     }
     Reline::DEFAULT_DIALOG_CONTEXT = Array.new
 
@@ -474,6 +484,7 @@ module Reline
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reline
 version: !ruby/object:Gem::Version
-  version: 0.2.8.pre.1
+  version: 0.2.8.pre.5
 platform: ruby
 authors:
 - aycabta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-29 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: io-console