reline 0.2.4 → 0.2.8.pre.1

data/lib/reline/terminfo.rb

@@ -0,0 +1,126 @@
+require 'fiddle'
+require 'fiddle/import'
+
+module Reline::Terminfo
+  extend Fiddle::Importer
+
+  class TerminfoError < StandardError; end
+
+  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 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.
+      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
+      else
+        @curses_dl = result
+        break
+      end
+    end
+    @curses_dl = nil if @curses_dl == false
+    @curses_dl
+  end
+end
+
+module Reline::Terminfo
+  dlload curses_dl
+  #extern 'int setupterm(char *term, int fildes, int *errret)'
+  @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)
+  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')
+    ret = @setupterm.(term, fildes, errret_int)
+    errret = errret_int.unpack('i')[0]
+    case ret
+    when 0 # OK
+      0
+    when -1 # ERR
+      case errret
+      when 1
+        raise TerminfoError.new('The terminal is hardcopy, cannot be used for curses applications.')
+      when 0
+        raise TerminfoError.new('The terminal could not be found, or that it is a generic type, having too little information for curses applications to run.')
+      when -1
+        raise TerminfoError.new('The terminfo database could not be found.')
+      else # unknown
+        -1
+      end
+    else # unknown
+      -2
+    end
+  end
+
+  class StringWithTiparm < String
+    def tiparm(*args) # for method chain
+      Reline::Terminfo.tiparm(self, *args)
+    end
+  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)
+    new_args = []
+    args.each do |a|
+      new_args << Fiddle::TYPE_INT << a
+    end
+    @tiparm.(str, *new_args).to_s
+  end
+
+  def self.enabled?
+    true
+  end
+end if Reline::Terminfo.curses_dl
+
+module Reline::Terminfo
+  def self.enabled?
+    false
+  end
+end unless Reline::Terminfo.curses_dl

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.4'
+  VERSION = '0.2.8.pre.1'
 end

data/lib/reline/windows.rb

@@ -13,23 +13,36 @@ class Reline::Windows
     @@legacy_console
   end
 
-  RAW_KEYSTROKE_CONFIG = {
-    [224, 72] => :ed_prev_history, # ↑
-    [224, 80] => :ed_next_history, # ↓
-    [224, 77] => :ed_next_char,    # →
-    [224, 75] => :ed_prev_char,    # ←
-    [224, 83] => :key_delete,      # Del
-    [224, 71] => :ed_move_to_beg,  # Home
-    [224, 79] => :ed_move_to_end,  # End
-    [  0, 41] => :ed_unassigned,   # input method on/off
-    [  0, 72] => :ed_prev_history, # ↑
-    [  0, 80] => :ed_next_history, # ↓
-    [  0, 77] => :ed_next_char,    # →
-    [  0, 75] => :ed_prev_char,    # ←
-    [  0, 83] => :key_delete,      # Del
-    [  0, 71] => :ed_move_to_beg,  # Home
-    [  0, 79] => :ed_move_to_end   # End
-  }
+  def self.set_default_key_bindings(config)
+    {
+      [224, 72] => :ed_prev_history, # ↑
+      [224, 80] => :ed_next_history, # ↓
+      [224, 77] => :ed_next_char,    # →
+      [224, 75] => :ed_prev_char,    # ←
+      [224, 83] => :key_delete,      # Del
+      [224, 71] => :ed_move_to_beg,  # Home
+      [224, 79] => :ed_move_to_end,  # End
+      [  0, 41] => :ed_unassigned,   # input method on/off
+      [  0, 72] => :ed_prev_history, # ↑
+      [  0, 80] => :ed_next_history, # ↓
+      [  0, 77] => :ed_next_char,    # →
+      [  0, 75] => :ed_prev_char,    # ←
+      [  0, 83] => :key_delete,      # Del
+      [  0, 71] => :ed_move_to_beg,  # Home
+      [  0, 79] => :ed_move_to_end   # End
+    }.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)
+      config.add_default_key_binding_by_keymap(:vi_command, key, func)
+    end
+
+    {
+      [27, 32] => :em_set_mark,             # M-<space>
+      [24, 24] => :em_exchange_mark,        # C-x C-x
+    }.each_pair do |key, func|
+      config.add_default_key_binding_by_keymap(:emacs, key, func)
+    end
+  end
 
   if defined? JRUBY_VERSION
     require 'win32api'
@@ -73,13 +86,36 @@ class Reline::Windows
     end
   end
 
+  VK_RETURN = 0x0D
   VK_MENU = 0x12
   VK_LMENU = 0xA4
   VK_CONTROL = 0x11
   VK_SHIFT = 0x10
+  VK_DIVIDE = 0x6F
+
+  KEY_EVENT = 0x01
+  WINDOW_BUFFER_SIZE_EVENT = 0x04
+
+  CAPSLOCK_ON = 0x0080
+  ENHANCED_KEY = 0x0100
+  LEFT_ALT_PRESSED = 0x0002
+  LEFT_CTRL_PRESSED = 0x0008
+  NUMLOCK_ON = 0x0020
+  RIGHT_ALT_PRESSED = 0x0001
+  RIGHT_CTRL_PRESSED = 0x0004
+  SCROLLLOCK_ON = 0x0040
+  SHIFT_PRESSED = 0x0010
+
+  VK_END = 0x23
+  VK_HOME = 0x24
+  VK_LEFT = 0x25
+  VK_UP = 0x26
+  VK_RIGHT = 0x27
+  VK_DOWN = 0x28
+  VK_DELETE = 0x2E
+
   STD_INPUT_HANDLE = -10
   STD_OUTPUT_HANDLE = -11
-  WINDOW_BUFFER_SIZE_EVENT = 0x04
   FILE_TYPE_PIPE = 0x0003
   FILE_NAME_INFO = 2
   @@getwch = Win32API.new('msvcrt', '_getwch', [], 'I')
@@ -93,13 +129,15 @@ class Reline::Windows
   @@hConsoleHandle = @@GetStdHandle.call(STD_OUTPUT_HANDLE)
   @@hConsoleInputHandle = @@GetStdHandle.call(STD_INPUT_HANDLE)
   @@GetNumberOfConsoleInputEvents = Win32API.new('kernel32', 'GetNumberOfConsoleInputEvents', ['L', 'P'], 'L')
-  @@ReadConsoleInput = Win32API.new('kernel32', 'ReadConsoleInput', ['L', 'P', 'L', 'P'], 'L')
+  @@ReadConsoleInputW = Win32API.new('kernel32', 'ReadConsoleInputW', ['L', 'P', 'L', 'P'], 'L')
   @@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
@@ -145,78 +183,71 @@ class Reline::Windows
     name =~ /(msys-|cygwin-).*-pty/ ? true : false
   end
 
-  def self.getwch
-    unless @@input_buf.empty?
-      return @@input_buf.shift
-    end
-    while @@kbhit.call == 0
-      sleep(0.001)
-    end
-    until @@kbhit.call == 0
-      ret = @@getwch.call
-      if ret == 0 or ret == 0xE0
-        @@input_buf << ret
-        ret = @@getwch.call
-        @@input_buf << ret
-        return @@input_buf.shift
-      end
-      begin
-        bytes = ret.chr(Encoding::UTF_8).bytes
-        @@input_buf.push(*bytes)
-      rescue Encoding::UndefinedConversionError
-        @@input_buf << ret
-        @@input_buf << @@getwch.call if ret == 224
-      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] ],
+  ]
+
+  def self.process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)
+
+    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
-    @@input_buf.shift
+
+    # 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.getc
+  def self.check_input_event
     num_of_events = 0.chr * 8
-    while @@GetNumberOfConsoleInputEvents.(@@hConsoleInputHandle, num_of_events) != 0 and num_of_events.unpack('L').first > 0
+    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
-      if @@ReadConsoleInput.(@@hConsoleInputHandle, input_record, 1, read_event) != 0
+      if @@ReadConsoleInputW.(@@hConsoleInputHandle, input_record, 1, read_event) != 0
         event = input_record[0, 2].unpack('s*').first
-        if event == WINDOW_BUFFER_SIZE_EVENT
+        case event
+        when WINDOW_BUFFER_SIZE_EVENT
           @@winch_handler.()
+        when KEY_EVENT
+          key_down = input_record[4, 4].unpack('l*').first
+          repeat_count = input_record[8, 2].unpack('s*').first
+          virtual_key_code = input_record[10, 2].unpack('s*').first
+          virtual_scan_code = input_record[12, 2].unpack('s*').first
+          char_code = input_record[14, 2].unpack('S*').first
+          control_key_state = input_record[16, 2].unpack('S*').first
+          is_key_down = key_down.zero? ? false : true
+          if is_key_down
+            process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)
+          end
         end
       end
     end
-    unless @@output_buf.empty?
-      return @@output_buf.shift
-    end
-    input = getwch
-    meta = (@@GetKeyState.call(VK_LMENU) & 0x80) != 0
-    control = (@@GetKeyState.call(VK_CONTROL) & 0x80) != 0
-    shift = (@@GetKeyState.call(VK_SHIFT) & 0x80) != 0
-    force_enter = !input.instance_of?(Array) && (control or shift) && input == 0x0D
-    if force_enter
-      # It's treated as Meta+Enter on Windows
-      @@output_buf.push("\e".ord)
-      @@output_buf.push(input)
-    else
-      case input
-      when 0x00
-        meta = false
-        @@output_buf.push(input)
-        input = getwch
-        @@output_buf.push(*input)
-      when 0xE0
-        @@output_buf.push(input)
-        input = getwch
-        @@output_buf.push(*input)
-      when 0x03
-        @@output_buf.push(input)
-      else
-        @@output_buf.push(input)
-      end
-    end
-    if meta
-      "\e".ord
-    else
-      @@output_buf.shift
-    end
+  end
+
+  def self.getc
+    check_input_event
+    @@output_buf.shift
   end
 
   def self.ungetc(c)
@@ -313,6 +344,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
@@ -325,4 +370,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