rkremap 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 945483dcd11240d5c54b359a15055219532f2f311275633503e7d485aa68917b
-  data.tar.gz: d594c9b549696f964cde750094169ba7198c0ac9ab5f5dfc59a7936d9610a09d
+  metadata.gz: 04a75325e18cfa14e1eeb93462af309c6d692083c5ef4a2609e6dfd53747a6c8
+  data.tar.gz: 1f86fc05c3098eed25b0d09bbebfc75fdad37122898ee9762376ce5241f21c60
 SHA512:
-  metadata.gz: a1412a373a0673172a9eba0449613ab9a76debf400b622977887031c294f8381a58a7c060ef6451e6264703690974aeddb305ce35619c07958a2b5a1239ecf12
-  data.tar.gz: 619ee1de0814c2542c2a4f347dca7c48e640590a01ff58f2b7362ed80ef447acaf1576df2a2a659eaac95c9a7ec0a8f52d732d8024356613fbef43f055b16dd2
+  metadata.gz: 3874c3c1a1c9b78a82faf4c3ceb40f28e1d9d5f1380a8ac3f604ffc904f2dcb4099db5b84f2f9542ae4d104ac8f242f4edd8060c8da0aa4f65e8ddc472a4cab2
+  data.tar.gz: f9700cd0991fb27fa03de2a402dd1bfebe0f23cc35d128b5b35ca9115608988ce2f1aeea55cd8525a3c645e1b4a465b0aa0995703e4cb0b58f73bdb7e2efda3f

data/README.md

@@ -25,7 +25,9 @@ KERNEL=="uinput", GROUP="input"
 
 ### `Rkremap.new`
 
-引数に `/dev/input/event*` を指定する。キーボードデバイス以外を指定してもたぶん無意味。
+引数を指定しなければ自動的にキーボードデバイスの検出を試みる。
+
+引数を指定する場合は `/dev/input/event*` を指定する。キーボードデバイス以外を指定してもたぶん無意味。
 キーボードのデバイスファイル名を調べるには
 ```
 cat /proc/bus/input/devices
@@ -46,6 +48,15 @@ ThinkPad 本体のキーボードは `/dev/input/event3` だった。
 
 `true` に設定すると X のアプリ名等を取得できる。X 環境下でないなら `false` を設定する。
 
+### Rkremap#modifers
+
+修飾キーの一覧。これらのキーは単体で押されただけでは `start` ブロックを実行しない。
+
+### auto_detect
+
+`true` の場合はキーボードデバイスの接続を自動検知する。
+`new` 時にデバイスファイルが指定されない場合は `true` になる。
+
 ### Rkremap#start
 
 なにかキーを押されたらブロックを実行する。修飾キー単体ではブロックは実行されない。
@@ -79,6 +90,7 @@ ThinkPad 本体のキーボードは `/dev/input/event3` だった。
   * [xkeysnail - もうひとつの Linux 向けキーリマッパ - Qiita](https://qiita.com/mooz@github/items/c5f25f27847333dd0b37)
 * [k0kubun/xremap: Dynamic key remapper for X11 and Wayland](https://github.com/k0kubun/xremap)
   * [Linux向けの最強のキーリマッパーを作った - k0kubun's blog](https://k0kubun.hatenablog.com/entry/xkremap)
+  * [Linux用キーリマッパーxremapをRustで書き直した - k0kubun's blog](https://k0kubun.hatenablog.com/entry/xremap)
 * [kui/rbindkeys: key remap with ruby](https://github.com/kui/rbindkeys)
   * [Ruby で設定できる Linux 環境向けキーリマッパー作った — 電卓片手に](http://k-ui.jp/blog/2012/06/06/rbindkeys-configurable-key-remapper-in-ruby/)
 * [Linux の入力デバイスをカスタマイズ - Qiita](https://qiita.com/propella/items/a73fc333c95d14d06835)

data/example/henkan-alt.rb

@@ -4,7 +4,7 @@
 require 'rkremap'
 include Rkremap::KeyCode
 
-rk = Rkremap.new('/dev/input/event3')
+rk = Rkremap.new
 rk.grab = true
 
 class State

data/example/keylogger.rb

@@ -6,7 +6,7 @@ def code2key(code)
   Rkremap::CODE_KEY[code].to_s.sub(/\AKEY_/, '')
 end
 
-rk = Rkremap.new('/dev/input/event3')
+rk = Rkremap.new
 rk.grab = false
 rk.x11 = true
 rk.start do |code, mod, app|

data/example/mac-shortcut.rb

@@ -33,7 +33,7 @@ mod_disable_meta = {
 }
 mod_disable_all = {}.merge(mod_disable_ctrl, mod_disable_shift, mod_disable_alt, mod_disable_meta)
 
-rk = Rkremap.new("/dev/input/event3")
+rk = Rkremap.new
 rk.grab = true
 rk.x11 = true
 rk.start do |code, mod, app|

data/example/tmtms.rb

@@ -1,14 +1,4 @@
 # tmtms 用
-#
-# fcitx が有効な場合に /tmp/fcitx-enabled ファイルを作るスクリプトを動かしておく:
-#     while :; do
-#       if [ $(fcitx-remote) -eq 2 ]; then
-#         touch /tmp/fcitx-enabled
-#       else
-#         rm -f /tmp/fcitx-enabled
-#       fi
-#       sleep 0.1
-#     done
 
 require 'rkremap'
 include Rkremap::KeyCode
@@ -40,7 +30,7 @@ class State
   end
 end
 
-rk = Rkremap.new("/dev/input/event3")
+rk = Rkremap.new
 rk.grab = true
 rk.x11 = true
 
@@ -159,8 +149,13 @@ rk.start do |code, mod, app|
 
   # Ctrl は他のキーに変換
   if mod[KEY_LEFTCTRL] || mod[KEY_RIGHTCTRL]
-    # Ctrl+K は行末まで削除 (日本語変換時はそのまま)
-    if code == KEY_K && !File.exist?('/tmp/fcitx-enabled')
+    # Ctrl+I/O はそのまま
+    if code == KEY_I || code ==KEY_O
+      rk.key(code, mod)
+      next
+    end
+    # Ctrl+K は行末まで削除
+    if code == KEY_K
       rk.key(KEY_END, mod_disable_all.merge({KEY_LEFTSHIFT => true}))
       rk.key(KEY_X, mod_disable_all.merge({KEY_LEFTCTRL => true}))
       next

data/lib/rkremap/evdev.rb

@@ -0,0 +1,154 @@
+class Rkremap
+  EV_KEY = 1
+  EV_SYN = 0
+  SYN_REPORT = 0
+
+  # https://www.kernel.org/doc/html/v4.12/input/input_uapi.html
+  class Evdev
+    EVIOCGBIT_ANY = 2147566880     # EVIOCGBIT(0, 1)
+    EVIOCGBIT_EV_KEY = 2153792801  # EVIOCGBIT(EV_KEY, (KEY_MAX-1)/8+1)
+    EVIOCGRAB = 1074021776
+    EVIOCGNAME = 2164278534        # EVIOCGNAME(256)
+
+    @io2evdev = {}
+    def self.io2evdev
+      @io2evdev
+    end
+
+    @device_list = {}
+
+    # @return [Array<Evdev>]
+    def self.detect
+      devs = []
+      new_devs = Dir.children("/dev/input").map do |dev|
+        if dev =~ /\Aevent\d+\z/
+          path = "/dev/input/#{dev}"
+          devs.push path
+          next if @device_list[path]
+          @device_list[path] = true
+          Evdev.new(path)
+        end
+      end.compact
+      (@device_list.keys - devs).each do |path|
+        @device_list.delete path
+      end
+      new_devs
+    end
+
+    def self.remove_device(evdev)
+      @io2evdev.delete evdev.io
+      @device_list.delete evdev.path
+    end
+
+    # @param inputs [Array<Evdev>]
+    # @param timeout [Numeric]
+    # @return [Evdev]
+    def self.select(inputs, timeout)
+      r, = IO.select(inputs.map(&:io), nil, nil, timeout)
+      r && @io2evdev[r[0]]
+    end
+
+    # @return [String]
+    attr_reader :path
+
+    # @param path [String]
+    def initialize(path)
+      @path = path
+      @io = nil
+      @capa = nil
+      @uinput = nil
+    end
+
+    def eql?(other)
+      other.is_a?(Evdev) && self.path == other.path
+    end
+
+    # @return [IO]
+    def io
+      return @io if @io
+      @io = File.open(@path)
+      self.class.io2evdev[@io] = self
+      @io
+    end
+
+    def close
+      @io&.close
+      self.class.remove_device(self)
+    end
+
+    # @param key [Integer]
+    # @return [Boolean]
+    def capable?(key)
+      unless @capa
+        buf = ' ' * ((KeyCode::KEY_MAX-1)/8+1)
+        io.ioctl(EVIOCGBIT_EV_KEY, buf)
+        @capa = buf.unpack('C*')
+      end
+      @capa[key/8][key%8] != 0
+    end
+
+    # @return [Boolean]
+    def keyboard?
+      buf = ' '
+      io.ioctl(EVIOCGNAME, buf)
+      return false if buf =~ /\Arkremap\0*\z/
+
+      io.ioctl(EVIOCGBIT_ANY, buf)
+      return false if buf.unpack1('C')[EV_KEY] == 0
+      capable?(KeyCode::KEY_0) && capable?(KeyCode::KEY_9) &&
+        capable?(KeyCode::KEY_A) && capable?(KeyCode::KEY_Z) && capable?(KeyCode::KEY_SPACE)
+    end
+
+    def grab
+      io.ioctl(EVIOCGRAB, 1)
+    end
+
+    # struct input_event {
+    #   struct timeval time;
+    #   unsigned short type;
+    #   unsigned short code;
+    #   unsigned int value;
+    # };
+    # @return [Array<Time, Integer, Integer, Integer>]
+    def read_event
+      raw = io.sysread(24)  # sizeof(struct input_event)
+      sec, usec, type, code, value = raw.unpack('Q!Q!SSl')
+      time = Time.at(sec, usec)
+      return time, type, code, value
+    end
+  end
+
+  # https://www.kernel.org/doc/html/v4.12/input/uinput.html
+  class Uinput
+    UI_SET_EVBIT = 1074025828
+    UI_SET_KEYBIT = 1074025829
+    UI_DEV_SETUP = 1079792899
+    UI_DEV_CREATE = 21761
+
+    def initialize
+      @dev = File.open('/dev/uinput', 'w')
+      setup
+    end
+
+    def setup
+      @dev.ioctl(UI_SET_EVBIT, EV_KEY)
+      KeyCode::KEY_CNT.times{|k| @dev.ioctl(UI_SET_KEYBIT, k)}
+      bustype = 0x03    # BUS_USB
+      vendor = 0x1234   # てきとー
+      product = 0x5678  # てきとー
+      version = 1       # てきとー
+      name = 'rkremap'
+      ff_efects_max = 0
+      setup = [bustype, vendor, product, version, name, ff_efects_max].pack("SSSSZ80L") # struct uinput_setup
+      @dev.ioctl(UI_DEV_SETUP, setup)
+      @dev.ioctl(UI_DEV_CREATE)
+    end
+
+    # @param type [Integer] EV_KEY/ EV_SYN
+    # @param code [Integer] キーコード / SYN_REPORT
+    # @param value [Integer] 0:release / 1:press / 2:repeat
+    def write_event(type, code, value)
+      @dev.syswrite(['', type, code, value].pack('a16SSl'))
+    end
+  end
+end

data/lib/rkremap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rkremap
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/rkremap/winattr.rb

@@ -1,12 +1,4 @@
-require 'ffi'
-
-module FFI
-  typedef :pointer, :Display
-  typedef :ulong, :XID
-  typedef :XID, :Window
-  typedef :int, :Status
-  typedef :ulong, :Atom
-end
+require 'fiddle/import'
 
 class Rkremap
   # アプリの name, class, title を取得する
@@ -14,38 +6,39 @@ class Rkremap
     def initialize
       @app_win = {}
       @display = X11.XOpenDisplay(nil) or raise "Cannot open display: #{ENV['DISPLAY']}"
+      @buf = ' '*8
     end
 
+    # @return [Integer] Window
     def focus_win
-      win = FFI::MemoryPointer.new(:Window)
-      revert_to = FFI::MemoryPointer.new(:int)
-      X11.XGetInputFocus(@display, win, revert_to)
-      win.read(:Window)
+      win = X11::Window.malloc(Fiddle::RUBY_FREE)
+      X11.XGetInputFocus(@display, win, @buf)
+      win.window
     end
 
     # @return [Array<window, name, class>]
     def app_win(window)
       return @app_win[window] if @app_win[window]
-      class_hint = XClassHint.new
-      root = FFI::MemoryPointer.new(:Window)
-      parent = FFI::MemoryPointer.new(:Window)
-      children = FFI::MemoryPointer.new(:pointer)
-      nchildren = FFI::MemoryPointer.new(:int)
+      class_hint = X11::XClassHint.malloc(Fiddle::RUBY_FREE)
+      parent = X11::Window.malloc(Fiddle::RUBY_FREE)
+      children = X11::Pointer.malloc(Fiddle::RUBY_FREE)
       win = window
       while win > 0
+        class_hint.name = nil
+        class_hint.class_name = nil
         X11.XGetClassHint(@display, win, class_hint)
-        X11.XQueryTree(@display, win, root, parent, children, nchildren)
-        X11.XFree(children.read_pointer)
-        break unless class_hint[:name].null? && class_hint[:class].null?
-        win = parent.read(:Window)
+        X11.XQueryTree(@display, win, @buf, parent, children, @buf)
+        X11.XFree(children.ptr)
+        break unless class_hint.name.null? && class_hint.class_name.null?
+        win = parent.window
       end
-      unless class_hint[:name].null?
-        win_name = class_hint[:name].read_string
-        X11.XFree(class_hint[:name])
+      unless class_hint.name.null?
+        win_name = class_hint.name.to_s
+        X11.XFree(class_hint.name)
       end
-      unless class_hint[:class].null?
-        win_class = class_hint[:class].read_string
-        X11.XFree(class_hint[:class])
+      unless class_hint.class_name.null?
+        win_class = class_hint.class_name.to_s
+        X11.XFree(class_hint.class_name)
       end
       @app_win[window] = [win, win_name, win_class]
     end
@@ -53,43 +46,35 @@ class Rkremap
     # @return [String]
     def app_title(window)
       win = app_win(window)[0]
-      prop = XTextProperty.new
-      text_list = FFI::MemoryPointer.new(:pointer)
-      count = FFI::MemoryPointer.new(:int)
+      prop = X11::XTextProperty.malloc(Fiddle::RUBY_FREE)
+      text_list = X11::Pointer.malloc(Fiddle::RUBY_FREE)
       X11.XGetWMName(@display, win, prop)
-      X11.Xutf8TextPropertyToTextList(@display, prop, text_list, count)
-      title = text_list.read(:pointer).read(:string)&.force_encoding('utf-8')
-      X11.XFreeStringList(text_list.read(:pointer))
+      X11.Xutf8TextPropertyToTextList(@display, prop, text_list, @buf)
+      title = text_list.ptr.ptr.to_s.force_encoding('utf-8')
+      X11.XFreeStringList(text_list.ptr)
       title
     end
   end
 
-  class XClassHint < FFI::Struct
-    layout(
-      :name, :pointer,
-      :class, :pointer,
-    )
-  end
-
-  class XTextProperty < FFI::Struct
-    layout(
-      :value, :pointer,
-      :encoding, :Atom,
-      :format, :int,
-      :nitems, :ulong,
-    )
-  end
-
   module X11
-    extend FFI::Library
-    ffi_lib 'X11'
-    attach_function :XOpenDisplay, [:string], :Display
-    attach_function :XGetInputFocus, [:Display, :pointer, :pointer], :int
-    attach_function :XGetClassHint, [:Display, :Window, XClassHint.by_ref], :int
-    attach_function :XQueryTree, [:Display, :Window, :pointer, :pointer, :pointer, :pointer], :Status
-    attach_function :XGetWMName, [:Display, :Window, XTextProperty.by_ref], :void
-    attach_function :Xutf8TextPropertyToTextList, [:Display, XTextProperty.by_ref, :pointer, :pointer], :int
-    attach_function :XFree, [:pointer], :int
-    attach_function :XFreeStringList, [:pointer], :void
+    extend Fiddle::Importer
+    dlload 'libX11.so.6'
+    typealias 'XID', 'unsigned long'
+    typealias 'Window', 'XID'
+    typealias 'Status', 'int'
+    typealias 'Atom', 'unsigned long'
+    Window = struct ['Window window']
+    Pointer = struct ['void *ptr']
+    XClassHint = struct ['char *name', 'char *class_name']
+    XTextProperty = struct ['unsigned char *value', 'Atom encoding', 'int format', 'unsigned long nitems']
+
+    extern 'Display* XOpenDisplay(char*)'
+    extern 'int XGetInputFocus(Display*, Window*, int*)'
+    extern 'int XGetClassHint(Display*, Window, XClassHint*)'
+    extern 'Status XQueryTree(Display*, Window, Window*, Window*, Window**, unsigned int*)'
+    extern 'Status XGetWMName(Display*, Window, XTextProperty*)'
+    extern 'int Xutf8TextPropertyToTextList(Display*, XTextProperty*, char***, int*)'
+    extern 'int XFree(void*)'
+    extern 'void XFreeStringList(char**)'
   end
 end

data/lib/rkremap.rb

@@ -3,20 +3,11 @@
 require_relative "rkremap/version"
 require_relative 'rkremap/keycode'
 require_relative 'rkremap/winattr'
+require_relative 'rkremap/evdev'
 
 class Rkremap
   include KeyCode
 
-  # ioctl constants
-  EVIOCGRAB = 1074021776
-  UI_SET_EVBIT = 1074025828
-  UI_SET_KEYBIT = 1074025829
-  UI_DEV_SETUP = 1079792899
-  UI_DEV_CREATE = 21761
-  EV_KEY = 1
-  EV_SYN = 0
-  SYN_REPORT = 0
-
   EVENT_TYPE_VALUE = {
     release: 0,
     press:   1,
@@ -26,12 +17,19 @@ class Rkremap
   attr_accessor :grab
   attr_accessor :modifiers
   attr_accessor :x11
-
-  # @param device [String]
-  def initialize(device)
-    @input = File.open(device)
-    @uinput = File.open('/dev/uinput', 'w')
-    setup_uinput
+  attr_accessor :auto_detect
+
+  # @param devices [Array<String>, String]
+  def initialize(devices=nil)
+    if devices
+      devices = Array(devices)
+      @inputs = devices.map{|d| Evdev.new(d)}
+    else
+      @auto_detect = true
+      @inputs = Evdev.detect.select(&:keyboard?)
+    end
+    raise 'Unable to detect keyboard device' if @inputs.empty?
+    @uinput = Uinput.new
     @grab = false
     @x11 = false
     @modifiers = [
@@ -51,15 +49,14 @@ class Rkremap
   end
 
   def start(&block)
-    @mod_state = @modifiers.map{|m| [m, false]}.to_h
+    detect_device_loop if @auto_detect
+    @mod_state = @modifiers.map.to_h{|m| [m, false]}
     @winattr = WinAttr.new if @x11
-    @input.ioctl(EVIOCGRAB, 1) if @grab
+    @inputs.each(&:grab) if @grab
     while true
       @keys = []
-      raw = @input.sysread(24)
-      sec, usec, type, code, value = raw.unpack('Q!Q!SSl')
+      time, type, code, value = read_event
       next if type != EV_KEY
-      time = Time.at(sec, usec)
       event = Event.new(time, code, value, @winattr)
       @events.each do |cond, b|
         synchronize{ b.call event } if event.match?(**cond)
@@ -73,6 +70,32 @@ class Rkremap
     end
   end
 
+  def detect_device_loop
+    Thread.new do
+      while true
+        sleep 3
+        new_devs = Evdev.detect.select(&:keyboard?)
+        unless new_devs.empty?
+          new_devs.each(&:grab) if @grab
+          @inputs += new_devs
+        end
+      end
+    end
+  end
+
+  def read_event
+    while true
+      begin
+        input = Evdev.select(@inputs, 3)
+        next unless input
+        return input.read_event
+      rescue Errno::ENODEV
+        input.close rescue nil
+        @inputs.delete input
+      end
+    end
+  end
+
   def synchronize(&block)
     @mutex.synchronize(&block)
   end
@@ -100,20 +123,6 @@ class Rkremap
 
   private
 
-  def setup_uinput
-    @uinput.ioctl(UI_SET_EVBIT, EV_KEY)
-    KEY_CNT.times{|k| @uinput.ioctl(UI_SET_KEYBIT, k)}
-    bustype = 0x03    # BUS_USB
-    vendor = 0x1234   # てきとー
-    product = 0x5678  # てきとー
-    version = 1       # てきとー
-    name = 'rkremap'
-    ff_efects_max = 0
-    setup = [bustype, vendor, product, version, name, ff_efects_max].pack("SSSSZ80L") # struct uinput_setup
-    @uinput.ioctl(UI_DEV_SETUP, setup)
-    @uinput.ioctl(UI_DEV_CREATE)
-  end
-
   def proc_event(code, value, event)
     if @mod_state.include?(code)
       @mod_state[code] = value != 0
@@ -130,8 +139,8 @@ class Rkremap
   # @param code [Integer]
   # @param value [Integer] 0:release / 1:press / 2:repeat
   def write_event(code, value)
-    @uinput.syswrite(['', EV_KEY, code, value].pack('a16SSl'))
-    @uinput.syswrite(['', EV_SYN, SYN_REPORT, 0].pack('a16SSl'))
+    @uinput.write_event(EV_KEY, code, value)
+    @uinput.write_event(EV_SYN, SYN_REPORT, 0)
   end
 
   class Event

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rkremap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - TOMITA Masahiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+date: 2022-03-05 00:00:00.000000000 Z
+dependencies: []
 description: key remapper
 email:
 - tommy@tmtm.org
@@ -37,6 +23,7 @@ files:
 - example/mac-shortcut.rb
 - example/tmtms.rb
 - lib/rkremap.rb
+- lib/rkremap/evdev.rb
 - lib/rkremap/keycode.rb
 - lib/rkremap/version.rb
 - lib/rkremap/winattr.rb