rkremap 0.2.0 → 0.3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9cb72d3bf69bf2d0641eb7856903d110f0a253d5377c2d97ea452a1f0fd5c13
-  data.tar.gz: 1dd89d3569fc5396a6c314618bcc975e04b63b0f2a55d9c3dd8cd5497f1e2164
+  metadata.gz: 55d8872f73bd984afd69fdf3c17e53f39de16a4f8feef40bc851b6527e57aa17
+  data.tar.gz: 99c6a99b3fdd44e206d416eab361ca1ab4c9e4defc0d96bfa2fc0e563a5a1e4c
 SHA512:
-  metadata.gz: 8cf20b635b0aa1584e81cc0317040931f62f011e004189e30428534c04456159cde7ac37c5f790cc1af06d396b9d60c36c4398a5d51947dcf99309eb3edb584b
-  data.tar.gz: cde725ba50b0d5b2fd3daf837af9e1244a1cc5cb3d40f497d9dbf00e6655edc0e436dcdc94056b8bc9efa3887ec2419fd7e53b11e8289c142217be2dd577f8ef
+  metadata.gz: c9ad9908d2a602e2740748924e5cd83c1f6526eda164c389cde0b22d1b4462d74c7f5eba3809f2c353396500efe5a5447cb22302a0c8db9aaf4fbfa739f1c6a9
+  data.tar.gz: 936cef85543d1089d81323ddd4f11a7b4da2afb44d6f7d7c9921132182e300e963a73ad8e51f8e80a6cf879251caad0c5235cddc0cc73a51dc315f2b5a487744

data/README.md

@@ -48,6 +48,15 @@ ThinkPad 本体のキーボードは `/dev/input/event3` だった。
 
 `true` に設定すると X のアプリ名等を取得できる。X 環境下でないなら `false` を設定する。
 
+### Rkremap#modifers
+
+修飾キーの一覧。これらのキーは単体で押されただけでは `start` ブロックを実行しない。
+
+### auto_detect
+
+`true` の場合はキーボードデバイスの接続を自動検知する。
+`new` 時にデバイスファイルが指定されない場合は `true` になる。
+
 ### Rkremap#start
 
 なにかキーを押されたらブロックを実行する。修飾キー単体ではブロックは実行されない。

data/example/henkan-super.rb

@@ -0,0 +1,57 @@
+# 変換/無変換キーを0.5秒以上押してるとALTキーとして扱う。
+# 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとALTキーとして扱う。
+
+require 'rkremap'
+require 'tmtms_timer'  # gem install tmtms_timer
+
+include Rkremap::KeyCode
+
+rk = Rkremap.new
+rk.grab = true
+
+timer = Tmtms::Timer.new
+jobs = {
+  KEY_HENKAN => nil,
+  KEY_MUHENKAN => nil,
+}
+
+henkan_map = {
+  KEY_HENKAN => KEY_RIGHTMETA,
+  KEY_MUHENKAN => KEY_RIGHTMETA,   # LEFTMETA だとデスクトップ環境のメニューが開いたりするため
+}
+
+rk.match(code: [KEY_HENKAN, KEY_MUHENKAN]) do |event|
+  if event.type == :press
+    job = timer.set(0.5) do
+      rk.synchronize do
+        rk.event(code: henkan_map[event.code], type: :press)
+      end
+    end
+    jobs[event.code] = job
+  elsif event.type == :release
+    if jobs[event.code]&.cancel
+      rk.key(event.code)
+    else
+      rk.event(code: henkan_map[event.code], type: :release)
+    end
+  end
+  event.skip
+end
+
+rk.match(type: :press) do
+  [KEY_HENKAN, KEY_MUHENKAN].each do |code|
+    if jobs[code]&.cancel
+      rk.event(code: henkan_map[code], type: :press)
+    end
+  end
+end
+
+def code2key(code)
+  Rkremap::CODE_KEY[code].to_s.sub(/\AKEY_/, '')
+end
+
+rk.start do |code, mod|
+  key = (mod.select{|_, v| v}.keys + [code]).map{|c| code2key(c)}.join('-')
+  puts key
+  rk.key(code, mod)
+end

data/example/mac-shortcut.rb

@@ -43,14 +43,20 @@ rk.start do |code, mod, app|
     next
   end
 
-  # ALT+[A-Z]/Enter を Ctrl+[A-Z]/Enter に変換
-  if (mod[KEY_LEFTALT] || mod[KEY_RIGHTALT]) && (Rkremap::CODE_KEY[code] =~ /\AKEY_[A-Z]\z/ || code == KEY_ENTER)
-    mod.merge!(mod_disable_alt, {KEY_LEFTCTRL => true})
+  # SUPER+[A-Z]/Enter を Ctrl+[A-Z]/Enter に変換
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (Rkremap::CODE_KEY[code] =~ /\AKEY_[A-Z]\z/ || code == KEY_ENTER)
+    mod.merge!(mod_disable_meta, {KEY_LEFTCTRL => true})
     mod[KEY_LEFTCTRL] = true
     rk.key(code, mod)
     next
   end
 
+  # Alt + F, B は Ctrl + →, ← に変換
+  if (mod[KEY_LEFTALT] || mod[KEY_RIGHTALT]) && (code == KEY_F || code == KEY_B)
+    rk.key(code == KEY_F ? KEY_RIGHT : KEY_LEFT, mod.merge(mod_disable_alt, {KEY_LEFTCTRL => true}))
+    next
+  end
+
   # Ctrl は他のキーに変換
   if mod[KEY_LEFTCTRL] || mod[KEY_RIGHTCTRL]
     # Ctrl+K は行末まで削除

data/example/tmtms.rb

@@ -1,96 +1,46 @@
 # 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
-
-class State
-  attr_accessor :converted
-
-  def initialize
-    @press = nil
-    @converted = false
-    @thread = nil
-  end
-
-  def press(thread)
-    @press = true
-    @converted = false
-    @thread = thread
-  end
-
-  def release
-    @press = false
-    @converted = false
-    @thread.kill
-    @thread = nil
-  end
+require 'tmtms_timer'  # gem install tmtms_timer
 
-  def pressed?
-    @press
-  end
-end
+include Rkremap::KeyCode
 
 rk = Rkremap.new
 rk.grab = true
 rk.x11 = true
 
-# 変換/無変換キーを0.5秒以上押してるとALTキーとして扱う。
-# 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとALTキーとして扱う。
-
-state = {
-  KEY_HENKAN => State.new,
-  KEY_MUHENKAN => State.new,
+timer = Tmtms::Timer.new
+jobs = {
+  KEY_HENKAN => nil,
+  KEY_MUHENKAN => nil,
 }
-
 henkan_map = {
-  KEY_HENKAN => KEY_RIGHTALT,
-  KEY_MUHENKAN => KEY_LEFTALT,
+  KEY_HENKAN => KEY_RIGHTMETA,
+  KEY_MUHENKAN => KEY_RIGHTMETA,   # LEFTMETA だとデスクトップ環境のメニューが開いたりするため
 }
 
-rk.match(code: [KEY_HENKAN, KEY_MUHENKAN], type: :press) do |event|
-  thr = Thread.new(event.code) do |code|
-    sleep 0.5
-    rk.synchronize do
-      if state[code].pressed?
-        rk.event(code: henkan_map[code], type: :press)
-        state[code].converted = true
+rk.match(code: [KEY_HENKAN, KEY_MUHENKAN]) do |event|
+  if event.type == :press
+    job = timer.set(0.5) do
+      rk.synchronize do
+        rk.event(code: henkan_map[event.code], type: :press)
       end
     end
+    jobs[event.code] = job
+  elsif event.type == :release
+    if jobs[event.code]&.cancel
+      rk.key(event.code)
+    else
+      rk.event(code: henkan_map[event.code], type: :release)
+    end
   end
-  state[event.code].press(thr)
-  event.skip
-end
-
-rk.match(code: [KEY_HENKAN, KEY_MUHENKAN], type: :release) do |event|
-  if state[event.code].converted
-    rk.event(code: henkan_map[event.code], type: :release)
-    event.skip
-  else
-    rk.event(code: event.code, type: :press)
-    rk.event(code: event.code, type: :release)
-  end
-  state[event.code].release
-end
-
-rk.match(code: [KEY_HENKAN, KEY_MUHENKAN], type: :repeat) do |event|
   event.skip
 end
 
 rk.match(type: :press) do
   [KEY_HENKAN, KEY_MUHENKAN].each do |code|
-    if state[code].pressed?
+    if jobs[code]&.cancel
       rk.event(code: henkan_map[code], type: :press)
-      state[code].converted = true
     end
   end
 end
@@ -149,26 +99,32 @@ rk.start do |code, mod, app|
     next
   end
 
-  # ALT+[A-Z]/Enter を Ctrl+[A-Z]/Enter に変換
-  if (mod[KEY_LEFTALT] || mod[KEY_RIGHTALT]) && (Rkremap::CODE_KEY[code] =~ /\AKEY_[A-Z]\z/ || code == KEY_ENTER)
-    mod.merge!(mod_disable_alt, {KEY_LEFTCTRL => true})
+  # SUPER+[A-Z]/Enter を Ctrl+[A-Z]/Enter に変換
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (Rkremap::CODE_KEY[code] =~ /\AKEY_[A-Z]\z/ || code == KEY_ENTER)
+    mod.merge!(mod_disable_meta, {KEY_LEFTCTRL => true})
     mod[KEY_LEFTCTRL] = true
     rk.key(code, mod)
     next
   end
 
+  # Alt + F, B は Ctrl + →, ← に変換
+  if (mod[KEY_LEFTALT] || mod[KEY_RIGHTALT]) && (code == KEY_F || code == KEY_B)
+    rk.key(code == KEY_F ? KEY_RIGHT : KEY_LEFT, mod.merge(mod_disable_alt, {KEY_LEFTCTRL => true}))
+    next
+  end
+
   # Ctrl は他のキーに変換
   if mod[KEY_LEFTCTRL] || mod[KEY_RIGHTCTRL]
-    # Ctrl+K は行末まで削除 (日本語変換時はそのまま)
+    # Ctrl+I/O はそのまま
+    if code == KEY_I || code == KEY_O
+      rk.key(code, mod)
+      next
+    end
+    # Ctrl+K は行末まで削除
     if code == KEY_K
-      if File.exist?('/tmp/fcitx-enabled')
-        rk.key(code, mod)
-        next
-      else
-        rk.key(KEY_END, mod_disable_all.merge({KEY_LEFTSHIFT => true}))
-        rk.key(KEY_X, mod_disable_all.merge({KEY_LEFTCTRL => true}))
-        next
-      end
+      rk.key(KEY_END, mod_disable_all.merge({KEY_LEFTSHIFT => true}))
+      rk.key(KEY_X, mod_disable_all.merge({KEY_LEFTCTRL => true}))
+      next
     end
     # 単純な変換
     if ctrl_map[code]

data/lib/rkremap/evdev.rb

@@ -8,27 +8,49 @@ class Rkremap
     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.devices
-      Dir.children("/dev/input").map do |dev|
-        dev =~ /\Aevent\d+\z/ ? Evdev.new("/dev/input/#{dev}") : nil
+    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)
-      h = inputs.map{|ev| [ev.io, ev]}.to_h
-      r, = IO.select(inputs.map(&:io), nil, nil, nil)
-      @io2evdev[r[0]]
+    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
@@ -37,6 +59,10 @@ class Rkremap
       @uinput = nil
     end
 
+    def eql?(other)
+      other.is_a?(Evdev) && self.path == other.path
+    end
+
     # @return [IO]
     def io
       return @io if @io
@@ -47,6 +73,7 @@ class Rkremap
 
     def close
       @io&.close
+      self.class.remove_device(self)
     end
 
     # @param key [Integer]
@@ -63,6 +90,9 @@ class Rkremap
     # @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) &&

data/lib/rkremap/version.rb

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

data/lib/rkremap/winattr.rb

@@ -11,26 +11,26 @@ class Rkremap
 
     # @return [Integer] Window
     def focus_win
-      win_buf = ' ' * X11.sizeof('Window')
-      X11.XGetInputFocus(@display, win_buf, @buf)
-      win_buf.unpack1('L')
+      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 = X11::XClassHint.malloc
-      parent = ' ' * X11.sizeof('Window')
-      children = ' ' * X11.sizeof('void*')
+      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, @buf, parent, children, @buf)
-        X11.XFree(Fiddle::Pointer[children].ptr)
+        X11.XFree(children.ptr)
         break unless class_hint.name.null? && class_hint.class_name.null?
-        win = parent.unpack1('L')
+        win = parent.window
       end
       unless class_hint.name.null?
         win_name = class_hint.name.to_s
@@ -46,25 +46,27 @@ class Rkremap
     # @return [String]
     def app_title(window)
       win = app_win(window)[0]
-      prop = X11::XTextProperty.malloc
-      text_list = ' ' * X11.sizeof('void*')
+      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, @buf)
-      title = Fiddle::Pointer[text_list].ptr.ptr.to_s.force_encoding('utf-8')
-      X11.XFreeStringList(Fiddle::Pointer[text_list].ptr)
+      title = text_list.ptr.ptr.to_s.force_encoding('utf-8')
+      X11.XFreeStringList(text_list.ptr)
       title
     end
   end
 
   module X11
     extend Fiddle::Importer
-    dlload 'libX11.so'
+    dlload 'libX11.so.6'
     typealias 'XID', 'unsigned long'
     typealias 'Window', 'XID'
     typealias 'Status', 'int'
     typealias 'Atom', 'unsigned long'
-    XClassHint = struct(['char *name', 'char *class_name'])
-    XTextProperty = struct(['unsigned char *value', 'Atom encoding', 'int format', 'unsigned long nitems'])
+    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*)'

data/lib/rkremap.rb

@@ -17,11 +17,17 @@ class Rkremap
   attr_accessor :grab
   attr_accessor :modifiers
   attr_accessor :x11
+  attr_accessor :auto_detect
 
   # @param devices [Array<String>, String]
   def initialize(devices=nil)
-    devices = Array(devices) if devices.is_a? String
-    @inputs = devices ? devices.map{|d| Evdev.new(d)} : Evdev.devices.select(&:keyboard?)
+    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
@@ -43,13 +49,13 @@ 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
     @inputs.each(&:grab) if @grab
     while true
       @keys = []
-      input = Evdev.select(@inputs)
-      time, type, code, value = input.read_event
+      time, type, code, value = read_event
       next if type != EV_KEY
       event = Event.new(time, code, value, @winattr)
       @events.each do |cond, b|
@@ -64,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rkremap
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0.1
 platform: ruby
 authors:
 - TOMITA Masahiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies: []
 description: key remapper
 email:
@@ -18,7 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- example/henkan-alt.rb
+- example/henkan-super.rb
 - example/keylogger.rb
 - example/mac-shortcut.rb
 - example/tmtms.rb
@@ -27,12 +27,12 @@ files:
 - lib/rkremap/keycode.rb
 - lib/rkremap/version.rb
 - lib/rkremap/winattr.rb
-homepage: https://github.com/tmtm/rkremap
+homepage: https://gitlab.com/tmtms/rkremap
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/tmtm/rkremap
-  source_code_uri: https://github.com/tmtm/rkremap
+  homepage_uri: https://gitlab.com/tmtms/rkremap
+  source_code_uri: https://gitlab.com/tmtms/rkremap
   documentation_uri: https://www.rubydoc.info/gems/rkremap
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -50,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: key remapper

data/example/henkan-alt.rb

@@ -1,93 +0,0 @@
-# 変換/無変換キーを0.5秒以上押してるとALTキーとして扱う。
-# 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとALTキーとして扱う。
-
-require 'rkremap'
-include Rkremap::KeyCode
-
-rk = Rkremap.new
-rk.grab = true
-
-class State
-  attr_accessor :converted
-
-  def initialize
-    @press = nil
-    @converted = false
-    @thread = nil
-  end
-
-  def press(thread)
-    @press = true
-    @converted = false
-    @thread = thread
-  end
-
-  def release
-    @press = false
-    @converted = false
-    @thread.kill
-    @thread = nil
-  end
-
-  def pressed?
-    @press
-  end
-end
-
-state = {
-  KEY_HENKAN => State.new,
-  KEY_MUHENKAN => State.new,
-}
-
-MAP = {
-  KEY_HENKAN => KEY_RIGHTALT,
-  KEY_MUHENKAN => KEY_LEFTALT,
-}
-
-rk.match(code: [KEY_HENKAN, KEY_MUHENKAN], type: :press) do |event|
-  thr = Thread.new(event.code) do |code|
-    sleep 0.5
-    rk.synchronize do
-      if state[code].pressed?
-        rk.event(code: MAP[code], type: :press)
-        state[code].converted = true
-      end
-    end
-  end
-  state[event.code].press(thr)
-  event.skip
-end
-
-rk.match(code: [KEY_HENKAN, KEY_MUHENKAN], type: :release) do |event|
-  if state[event.code].converted
-    rk.event(code: MAP[event.code], type: :release)
-    event.skip
-  else
-    rk.event(code: event.code, type: :press)
-    rk.event(code: event.code, type: :release)
-  end
-  state[event.code].release
-end
-
-rk.match(code: [KEY_HENKAN, KEY_MUHENKAN], type: :repeat) do |event|
-  event.skip
-end
-
-rk.match(type: :press) do
-  [KEY_HENKAN, KEY_MUHENKAN].each do |code|
-    if state[code].pressed?
-      rk.event(code: MAP[code], type: :press)
-      state[code].converted = true
-    end
-  end
-end
-
-def code2key(code)
-  Rkremap::CODE_KEY[code].to_s.sub(/\AKEY_/, '')
-end
-
-rk.start do |code, mod|
-  key = (mod.select{|_, v| v}.keys + [code]).map{|c| code2key(c)}.join('-')
-  puts key
-  rk.key(code, mod)
-end