reline 0.2.8.pre.7 → 0.2.8.pre.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c109228f50bec62ad64f9231151865fc6767b95ea5e714c254f2ce8f4480d3e6
-  data.tar.gz: 8fe386600dca93bb0fce22c72a628392840ad0922d5285afedd5542bdb9e1f3b
+  metadata.gz: 6f03d46c602265d3a197f00021df365a9686e4fd0b5d0ef2a037a9ad25143b91
+  data.tar.gz: e97bfb610d3c9498e651b25de97e87380e624b56ea970ab7048b25dca7be9488
 SHA512:
-  metadata.gz: c1652f7c8c852328fe3371e8881e1fdf13e0c41c4e34894e08c36c15c7521f33035bdfad34cdf0264a3ef4bdf23e1cb45a4a25e3231f592831dd6e8fb6cbeb8f
-  data.tar.gz: 9aadb3ba73cd2c8ca051e0310d297dc76e6a7a210c4048620c143bf76afce3b7a780f642d2f8167894978301daa82c7229fdd443718ba25a14e2970ead7f9702
+  metadata.gz: be1a180b58930985ea7ba5d63be81b62c8ffb0b960daf33c5ad984652fa6021151519cc1fa41055c240d7675d628c6749ab69ca67c2c2bfa306a9deab8200c56
+  data.tar.gz: 68be299c9815a350c8afec2c5b27aa02905c8fcc04c6fbba331aded2aded1d0dc160d2e8b01be58a91f308b1ad1dd880209e237de770002422910c6014ddc51a

data/lib/reline/config.rb

@@ -50,6 +50,7 @@ class Reline::Config
     @additional_key_bindings[:emacs] = {}
     @additional_key_bindings[:vi_insert] = {}
     @additional_key_bindings[:vi_command] = {}
+    @oneshot_key_bindings = {}
     @skip_section = nil
     @if_stack = nil
     @editing_mode_label = :emacs
@@ -75,6 +76,7 @@ class Reline::Config
     @additional_key_bindings.keys.each do |key|
       @additional_key_bindings[key].clear
     end
+    @oneshot_key_bindings.clear
     reset_default_key_bindings
   end
 
@@ -128,8 +130,12 @@ class Reline::Config
     return home_rc_path
   end
 
+  private def default_inputrc_path
+    @default_inputrc_path ||= inputrc_path
+  end
+
   def read(file = nil)
-    file ||= inputrc_path
+    file ||= default_inputrc_path
     begin
       if file.respond_to?(:readlines)
         lines = file.readlines
@@ -149,7 +155,15 @@ class Reline::Config
 
   def key_bindings
     # override @key_actors[@editing_mode_label].default_key_bindings with @additional_key_bindings[@editing_mode_label]
-    @key_actors[@editing_mode_label].default_key_bindings.merge(@additional_key_bindings[@editing_mode_label])
+    @key_actors[@editing_mode_label].default_key_bindings.merge(@additional_key_bindings[@editing_mode_label]).merge(@oneshot_key_bindings)
+  end
+
+  def add_oneshot_key_binding(keystroke, target)
+    @oneshot_key_bindings[keystroke] = target
+  end
+
+  def reset_oneshot_key_bindings
+    @oneshot_key_bindings.clear
   end
 
   def add_default_key_binding_by_keymap(keymap, keystroke, target)

data/lib/reline/key_stroke.rb

@@ -1,8 +1,59 @@
 class Reline::KeyStroke
   using Module.new {
+    refine Integer do
+      def ==(other)
+        if other.is_a?(Reline::Key)
+          if other.combined_char == "\e".ord
+            false
+          else
+            other.combined_char == self
+          end
+        else
+          super
+        end
+      end
+    end
+
     refine Array do
       def start_with?(other)
-        other.size <= size && other == self.take(other.size)
+        compressed_me = compress_meta_key
+        compressed_other = other.compress_meta_key
+        i = 0
+        loop do
+          my_c = compressed_me[i]
+          other_c = compressed_other[i]
+          other_is_last = (i + 1) == compressed_other.size
+          me_is_last = (i + 1) == compressed_me.size
+          if my_c != other_c
+            if other_c == "\e".ord and other_is_last and my_c.is_a?(Reline::Key) and my_c.with_meta
+              return true
+            else
+              return false
+            end
+          elsif other_is_last
+            return true
+          elsif me_is_last
+            return false
+          end
+          i += 1
+        end
+      end
+
+      def ==(other)
+        compressed_me = compress_meta_key
+        compressed_other = other.compress_meta_key
+        compressed_me.size == compressed_other.size and [compressed_me, compressed_other].transpose.all?{ |i| i[0] == i[1] }
+      end
+
+      def compress_meta_key
+        inject([]) { |result, key|
+          if result.size > 0 and result.last == "\e".ord
+            result[result.size - 1] = Reline::Key.new(key, key | 0b10000000, true)
+          else
+            result << key
+          end
+          result
+        }
       end
 
       def bytes
@@ -19,8 +70,8 @@ class Reline::KeyStroke
     key_mapping.keys.select { |lhs|
       lhs.start_with? input
     }.tap { |it|
-      return :matched  if it.size == 1 && (it.max_by(&:size)&.size&.== input.size)
-      return :matching if it.size == 1 && (it.max_by(&:size)&.size&.!= input.size)
+      return :matched  if it.size == 1 && (it[0] == input)
+      return :matching if it.size == 1 && (it[0] != input)
       return :matched  if it.max_by(&:size)&.size&.< input.size
       return :matching if it.size > 1
     }
@@ -32,7 +83,8 @@ class Reline::KeyStroke
   end
 
   def expand(input)
-    lhs = key_mapping.keys.select { |item| input.start_with? item }.sort_by(&:size).reverse.first
+    input = input.compress_meta_key
+    lhs = key_mapping.keys.select { |item| input.start_with? item }.sort_by(&:size).last
     return input unless lhs
     rhs = key_mapping[lhs]
 

data/lib/reline/line_editor.rb

@@ -550,8 +550,9 @@ class Reline::LineEditor
     attr_reader :name, :contents, :width
     attr_accessor :scroll_top, :column, :vertical_offset, :lines_backup, :trap_key
 
-    def initialize(name, proc_scope)
+    def initialize(name, config, proc_scope)
       @name = name
+      @config = config
       @proc_scope = proc_scope
       @width = nil
       @scroll_top = 0
@@ -575,13 +576,25 @@ class Reline::LineEditor
     def call(key)
       @proc_scope.set_dialog(self)
       @proc_scope.set_key(key)
-      @proc_scope.call
+      dialog_render_info = @proc_scope.call
+      if @trap_key
+        if @trap_key.any?{ |i| i.is_a?(Array) } # multiple trap
+          @trap_key.each do |t|
+            @config.add_oneshot_key_binding(t, @name)
+          end
+        elsif @trap_key.is_a?(Array)
+          @config.add_oneshot_key_binding(@trap_key, @name)
+        elsif @trap_key.is_a?(Integer) or @trap_key.is_a?(Reline::Key)
+          @config.add_oneshot_key_binding([@trap_key], @name)
+        end
+      end
+      dialog_render_info
     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))
+    @dialogs << Dialog.new(name, @config, DialogProcScope.new(self, @config, p, context))
   end
 
   DIALOG_HEIGHT = 20
@@ -661,6 +674,13 @@ class Reline::LineEditor
     reset_dialog(dialog, old_dialog)
     move_cursor_down(dialog.vertical_offset)
     Reline::IOGate.move_cursor_column(dialog.column)
+    if dialog_render_info.scrollbar and dialog_render_info.contents.size > height
+      bar_max_height = height * 2
+      moving_distance = (dialog_render_info.contents.size - height) * 2
+      position_ratio = dialog.scroll_top.zero? ? 0.0 : ((dialog.scroll_top * 2).to_f / moving_distance)
+      bar_height = (bar_max_height * ((dialog.contents.size * 2).to_f / (dialog_render_info.contents.size * 2))).floor.to_i
+      position = ((bar_max_height - bar_height) * position_ratio).floor.to_i
+    end
     dialog.contents.each_with_index do |item, i|
       if i == pointer
         bg_color = '45'
@@ -672,10 +692,26 @@ class Reline::LineEditor
         end
       end
       str = padding_space_with_escape_sequences(Reline::Unicode.take_range(item, 0, dialog.width), dialog.width)
-      @output.write "\e[#{bg_color}m#{str}\e[49m"
+      @output.write "\e[#{bg_color}m#{str}"
+      if dialog_render_info.scrollbar and dialog_render_info.contents.size > height
+        @output.write "\e[37m"
+        if position <= (i * 2) and (i * 2 + 1) < (position + bar_height)
+          @output.write '█'
+        elsif position <= (i * 2) and (i * 2) < (position + bar_height)
+          @output.write '▀'
+          str += ''
+        elsif position <= (i * 2 + 1) and (i * 2) < (position + bar_height)
+          @output.write '▄'
+        else
+          @output.write ' '
+        end
+        @output.write "\e[39m"
+      end
+      @output.write "\e[49m"
       Reline::IOGate.move_cursor_column(dialog.column)
       move_cursor_down(1) if i < (dialog.contents.size - 1)
     end
+    dialog.width += 1 if dialog_render_info.scrollbar and dialog_render_info.contents.size > height
     Reline::IOGate.move_cursor_column(cursor_column)
     move_cursor_up(dialog.vertical_offset + dialog.contents.size - 1)
     Reline::IOGate.show_cursor
@@ -1478,9 +1514,9 @@ class Reline::LineEditor
 
   def input_key(key)
     @last_key = key
+    @config.reset_oneshot_key_bindings
     @dialogs.each do |dialog|
-      # The dialog will intercept the key if trap_key is set.
-      if dialog.trap_key and dialog.trap_key.match?(key)
+      if key.char.instance_of?(Symbol) and key.char == dialog.name
         return
       end
     end

data/lib/reline/line_editor.rb.orig

@@ -251,6 +251,7 @@ class Reline::LineEditor
     @in_pasting = false
     @auto_indent_proc = nil
     @dialogs = []
+    @last_key = nil
     reset_line
   end
 
@@ -512,6 +513,14 @@ class Reline::LineEditor
       @cursor_pos.y = row
     end
 
+    def set_key(key)
+      @key = key
+    end
+
+    def key
+      @key
+    end
+
     def cursor_pos
       @cursor_pos
     end
@@ -539,7 +548,7 @@ class Reline::LineEditor
 
   class Dialog
     attr_reader :name, :contents, :width
-    attr_accessor :scroll_top, :column, :vertical_offset, :lines_backup
+    attr_accessor :scroll_top, :column, :vertical_offset, :lines_backup, :trap_key
 
     def initialize(name, proc_scope)
       @name = name
@@ -563,8 +572,9 @@ class Reline::LineEditor
       end
     end
 
-    def call
+    def call(key)
       @proc_scope.set_dialog(self)
+      @proc_scope.set_key(key)
       @proc_scope.call
     end
   end
@@ -588,10 +598,11 @@ class Reline::LineEditor
   private def render_each_dialog(dialog, cursor_column)
     if @in_pasting
       dialog.contents = nil
+      dialog.trap_key = nil
       return
     end
     dialog.set_cursor_pos(cursor_column, @first_line_started_from + @started_from)
-    dialog_render_info = dialog.call
+    dialog_render_info = dialog.call(@last_key)
     if dialog_render_info.nil? or dialog_render_info.contents.nil? or dialog_render_info.contents.empty?
       dialog.lines_backup = {
         lines: modify_lines(whole_lines),
@@ -602,13 +613,18 @@ class Reline::LineEditor
       }
       clear_each_dialog(dialog)
       dialog.contents = nil
+      dialog.trap_key = nil
       return
     end
     old_dialog = dialog.clone
-    dialog.width = dialog_render_info.width if dialog_render_info.width
-    height = dialog_render_info.height || DIALOG_HEIGHT
-    pointer = dialog_render_info.pointer
     dialog.contents = dialog_render_info.contents
+    pointer = dialog_render_info.pointer
+    if dialog_render_info.width
+      dialog.width = dialog_render_info.width
+    else
+      dialog.width = dialog.contents.map { |l| calculate_width(l, true) }.max
+    end
+    height = dialog_render_info.height || DIALOG_HEIGHT
     height = dialog.contents.size if dialog.contents.size < height
     if dialog.contents.size > height
       if dialog_render_info.pointer
@@ -645,6 +661,13 @@ class Reline::LineEditor
     reset_dialog(dialog, old_dialog)
     move_cursor_down(dialog.vertical_offset)
     Reline::IOGate.move_cursor_column(dialog.column)
+    if dialog_render_info.scrollbar and dialog_render_info.contents.size > height
+      bar_max_height = height * 2
+      moving_distance = (dialog_render_info.contents.size - height) * 2
+      position_ratio = dialog.scroll_top.zero? ? 0.0 : ((dialog.scroll_top * 2).to_f / moving_distance)
+      bar_height = (bar_max_height * ((dialog.contents.size * 2).to_f / (dialog_render_info.contents.size * 2))).floor.to_i
+      position = ((bar_max_height - bar_height) * position_ratio).floor.to_i
+    end
     dialog.contents.each_with_index do |item, i|
       if i == pointer
         bg_color = '45'
@@ -656,10 +679,22 @@ class Reline::LineEditor
         end
       end
       str = padding_space_with_escape_sequences(Reline::Unicode.take_range(item, 0, dialog.width), dialog.width)
+      if dialog_render_info.scrollbar and dialog_render_info.contents.size > height
+        if position <= (i * 2) and (i * 2 + 1) < (position + bar_height)
+          str += '█'
+        elsif position <= (i * 2) and (i * 2) < (position + bar_height)
+          str += '▀'
+        elsif position <= (i * 2 + 1) and (i * 2) < (position + bar_height)
+          str += '▄'
+        else
+          str += ' '
+        end
+      end
       @output.write "\e[#{bg_color}m#{str}\e[49m"
       Reline::IOGate.move_cursor_column(dialog.column)
       move_cursor_down(1) if i < (dialog.contents.size - 1)
     end
+    dialog.width += 1 if dialog_render_info.scrollbar and dialog_render_info.contents.size > height
     Reline::IOGate.move_cursor_column(cursor_column)
     move_cursor_up(dialog.vertical_offset + dialog.contents.size - 1)
     Reline::IOGate.show_cursor
@@ -774,6 +809,7 @@ class Reline::LineEditor
   end
 
   private def clear_each_dialog(dialog)
+    dialog.trap_key = nil
     return unless dialog.contents
     prompt, prompt_width, prompt_list = check_multiline_prompt(dialog.lines_backup[:lines], prompt)
     visual_lines = []
@@ -1460,6 +1496,13 @@ class Reline::LineEditor
   end
 
   def input_key(key)
+    @last_key = key
+    @dialogs.each do |dialog|
+      # The dialog will intercept the key if trap_key is set.
+      if dialog.trap_key and dialog.trap_key.match?(key)
+        return
+      end
+    end
     @just_cursor_moving = nil
     if key.char.nil?
       if @first_char

data/lib/reline/unicode.rb

@@ -101,9 +101,9 @@ class Reline::Unicode
 
   def self.get_mbchar_width(mbchar)
     ord = mbchar.ord
-    if (0x00 <= ord and ord <= 0x1F)
+    if (0x00 <= ord and ord <= 0x1F) # in EscapedPairs
       return 2
-    elsif (0x20 <= ord and ord <= 0x7E)
+    elsif (0x20 <= ord and ord <= 0x7E) # printable ASCII chars
       return 1
     end
     m = mbchar.encode(Encoding::UTF_8).match(MBCharWidthRE)
@@ -185,7 +185,7 @@ class Reline::Unicode
     [lines, height]
   end
 
-  # Take a chunk of a String with escape sequences.
+  # Take a chunk of a String cut by width with escape sequences.
   def self.take_range(str, start_col, max_width, encoding = str.encoding)
     chunk = String.new(encoding: encoding)
     total_width = 0

data/lib/reline/version.rb

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

data/lib/reline.rb

@@ -18,13 +18,26 @@ module Reline
 
   Key = Struct.new('Key', :char, :combined_char, :with_meta) do
     def match?(key)
-      (key.char.nil? or char.nil? or char == key.char) and
-      (key.combined_char.nil? or combined_char.nil? or combined_char == key.combined_char) and
-      (key.with_meta.nil? or with_meta.nil? or with_meta == key.with_meta)
+      if key.instance_of?(Reline::Key)
+        (key.char.nil? or char.nil? or char == key.char) and
+        (key.combined_char.nil? or combined_char.nil? or combined_char == key.combined_char) and
+        (key.with_meta.nil? or with_meta.nil? or with_meta == key.with_meta)
+      elsif key.is_a?(Integer) or key.is_a?(Symbol)
+        if not combined_char.nil? and combined_char == key
+          true
+        elsif combined_char.nil? and not char.nil? and char == key
+          true
+        else
+          false
+        end
+      else
+        false
+      end
     end
+    alias_method :==, :match?
   end
   CursorPos = Struct.new(:x, :y)
-  DialogRenderInfo = Struct.new(:pos, :contents, :pointer, :bg_color, :width, :height, keyword_init: true)
+  DialogRenderInfo = Struct.new(:pos, :contents, :pointer, :bg_color, :width, :height, :scrollbar, keyword_init: true)
 
   class Core
     ATTR_READER_NAMES = %i(
@@ -228,7 +241,7 @@ module Reline
         context.clear
         context.push(cursor_pos_to_render, result, pointer, dialog)
       end
-      DialogRenderInfo.new(pos: cursor_pos_to_render, contents: result, pointer: pointer, height: 15)
+      DialogRenderInfo.new(pos: cursor_pos_to_render, contents: result, pointer: pointer, scrollbar: true, height: 15)
     }
     Reline::DEFAULT_DIALOG_CONTEXT = Array.new
 
@@ -368,25 +381,9 @@ module Reline
           break
         when :matching
           if buffer.size == 1
-            begin
-              succ_c = nil
-              Timeout.timeout(keyseq_timeout / 1000.0) {
-                succ_c = Reline::IOGate.getc
-              }
-            rescue Timeout::Error # cancel matching only when first byte
-              block.([Reline::Key.new(c, c, false)])
-              break
-            else
-              if key_stroke.match_status(buffer.dup.push(succ_c)) == :unmatched
-                if c == "\e".ord
-                  block.([Reline::Key.new(succ_c, succ_c | 0b10000000, true)])
-                else
-                  block.([Reline::Key.new(c, c, false), Reline::Key.new(succ_c, succ_c, false)])
-                end
-                break
-              else
-                Reline::IOGate.ungetc(succ_c)
-              end
+            case read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block)
+            when :break then break
+            when :next  then next
             end
           end
         when :unmatched
@@ -403,6 +400,38 @@ module Reline
       end
     end
 
+    private def read_2nd_character_of_key_sequence(keyseq_timeout, buffer, c, block)
+      begin
+        succ_c = nil
+        Timeout.timeout(keyseq_timeout / 1000.0) {
+          succ_c = Reline::IOGate.getc
+        }
+      rescue Timeout::Error # cancel matching only when first byte
+        block.([Reline::Key.new(c, c, false)])
+        return :break
+      else
+        case key_stroke.match_status(buffer.dup.push(succ_c))
+        when :unmatched
+          if c == "\e".ord
+            block.([Reline::Key.new(succ_c, succ_c | 0b10000000, true)])
+          else
+            block.([Reline::Key.new(c, c, false), Reline::Key.new(succ_c, succ_c, false)])
+          end
+          return :break
+        when :matching
+          Reline::IOGate.ungetc(succ_c)
+          return :next
+        when :matched
+          buffer << succ_c
+          expanded = key_stroke.expand(buffer).map{ |expanded_c|
+            Reline::Key.new(expanded_c, expanded_c, false)
+          }
+          block.(expanded)
+          return :break
+        end
+      end
+    end
+
     private def read_escaped_key(keyseq_timeout, c, block)
       begin
         escaped_c = nil

metadata

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