rkremap 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d204d310504030119a941b532fec985cae5747c1d1e04958baefbb112327a629
-  data.tar.gz: c98176cf3e753eb59da16e614159a5516e9bc1701e63806ec02d3e3bd8c4d076
+  metadata.gz: 127371f8cab9cd5ff002b35b886b79a3a4424d779f4bf938b9006fb633917a51
+  data.tar.gz: a02bd1649a62f30916e125582409f9b9ab8d57c33caf10bdfc5f7e6392ece992
 SHA512:
-  metadata.gz: e04feb18bbae681fc1b5bbd2f8a95ea85b58aff976865d857fd044274214eb9f2502c34bb7ff4cb9b620f3658e55f82157b4c6b98dbe4eb5dce8ce8446ff042d
-  data.tar.gz: 941f5b2893c031a7891151635b8cfb83d5ce410d8c0751da86a2b2699ce440a10221684dba881849bd54f4afa10f3b18cd8defe98b0a7601cfed4f5eb15bd7b6
+  metadata.gz: 111e0d08dfaec939535f150eb8d2852c5bbda078d705191d8d03d0d035782088cf73f7c861029cc49b99860f8645be46c1ef557326bae1e17170d15116ee887d
+  data.tar.gz: a1124ae0dabd8f87286d7ae2cc375a0490ffc58a884c2fb0f9694f51cee9d97b309ea83842afeb46f86184a1523e96c06429688bf71aa05e1a6e9555d6f488cb

data/README.md

@@ -23,7 +23,9 @@ KERNEL=="uinput", GROUP="input"
 という内容で作れば `/dev/uinput` のグループを `input` にできるっぽい。
 
 
-### `Rkremap.new`
+## Rkremap
+
+### Rkremap.new
 
 引数を指定しなければ自動的にキーボードデバイスの検出を試みる。
 
@@ -40,14 +42,42 @@ sudo evtest /dev/input/eventX
 
 ThinkPad 本体のキーボードは `/dev/input/event3` だった。
 
+### Rkremap#exclude
+
+無視するデバイス名を正規表現で指定できる。
+
+例
+```ruby
+rkremap.exclude = /touchpad/i
+```
+
+### Rkremap#mouse
+
+真を指定するとマウスも対象にする。
+
 ### Rkremap#grab
 
-`true` に設定するとキーイベントを奪う。キーイベントを見るだけでいいなら `false` を設定する。
+`true` を設定するとキーイベントを奪う。キーイベントを見るだけでいいなら `false` を設定する。
+
+`:keyboard` を設定するとキーボードデバイスを grab する。
+
+`:mouse` を設定するとマウスデバイスを grab する。
+
+正規表現を設定するとデバイス名がマッチした場合にデバイスを grab する。
 
 ### Rkremap#x11
 
 `true` に設定すると X のアプリ名等を取得できる。X 環境下でないなら `false` を設定する。
 
+### Rkremap#modifers
+
+修飾キーの一覧。これらのキーは単体で押されただけでは `start` ブロックを実行しない。
+
+### Rkremap#auto_detect
+
+`true` の場合はキーボードデバイスの接続を自動検知する。
+`new` 時にデバイスファイルが指定されない場合は `true` になる。
+
 ### Rkremap#start
 
 なにかキーを押されたらブロックを実行する。修飾キー単体ではブロックは実行されない。
@@ -56,13 +86,27 @@ ThinkPad 本体のキーボードは `/dev/input/event3` だった。
 
 ### Rkremap#match
 
-キーイベントが引数に適合するとブロックを実行する。ブロック引数は Event オブジェクト。
-`Event#skip` するとこのイベントはスキップされる。
+キーイベントが引数に適合するとブロックを実行する。ブロック引数は `Rkremap::Event` オブジェクト。
+`Rkremap::Event#skip` するとこのイベントはスキップされる。
+
+複数回指定した場合は記述順に実行される。
 
 ### Rkremap#key
 
 キーを押したことにする。引数はキーコード(`Integer`)と修飾キー(`Hash`)。
 
+修飾キーのハッシュのキーはキーコード(`KEY_LEFTCTRL` 等)、値は `true`, または `false`。
+
+```ruby
+{
+  KEY_LEFTSHIFT => false,
+  KEY_LEFTCTRL => true,
+}
+```
+
+と指定すると、左シフトは離した状態、左Ctrlは押した状態、それ以外の修飾キーはそのまま。
+`#key()` 処理後は処理前の修飾キーの状態に戻る。
+
 ### Rkremap#event
 
 キーイベントを発生させる。`code` 引数はキーコード(`Integer`)。`type` 引数はイベントタイプ(`Symbol`)で `:press`, `:release`。
@@ -75,6 +119,34 @@ ThinkPad 本体のキーボードは `/dev/input/event3` だった。
 
 コードからキー名のシンボルに変換するための Hash。
 
+## Rkremap::Event
+
+### Rkremap::Event#code
+
+キーコード。`Rkremap::KeyCode::KEY_*` に該当。
+
+### Rkremap::Event#type
+
+イベントタイプ。 `:press`, `:release`, `:repeat` のいずれか。
+
+### Rkremap::Event#app
+
+`Rkremap::App`。イベントが発生したアプリケーション。
+
+### Rkremap::Event#skip
+
+このイベントをこれ以降処理しない。
+
+## Rkremap::App
+
+### Rkremap::App#class_name
+
+アプリケーションのクラス名。
+
+### Rkremap::App#title
+
+アプリケーションのタイトル。
+
 ## 参考
 
 * [mooz/xkeysnail: Yet another keyboard remapping tool for X environment](https://github.com/mooz/xkeysnail)

data/example/henkan-super.rb

@@ -0,0 +1,52 @@
+# 変換/無変換キーを0.5秒以上押してるとSUPERキーとして扱う。
+# 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとSUPERキーとして扱う。
+
+require 'rkremap'
+require '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  # 0.5秒以内に離された
+      rk.key(event.code)
+    else
+      rk.event(code: henkan_map[event.code], type: :release)
+    end
+  end
+  event.skip
+end
+
+# 何かキーが押されたときに HENKAN, MUHENKAN が押されてれば SUPER が押されてることにする
+rk.match(type: :press) do
+  [KEY_HENKAN, KEY_MUHENKAN].each do |code|
+    if jobs[code]&.cancel  # 0.5秒以内
+      rk.event(code: henkan_map[code], type: :press)
+    end
+  end
+end
+
+rk.start do |code, mod|
+  rk.key(code, mod)
+end

data/example/keylogger.rb

@@ -6,9 +6,9 @@ def code2key(code)
   Rkremap::CODE_KEY[code].to_s.sub(/\AKEY_/, '')
 end
 
-rk = Rkremap.new
+rk = Rkremap.new(*ARGV)
 rk.grab = false
-rk.x11 = true
+rk.x11 = true if ENV['DISPLAY']
 rk.start do |code, mod, app|
   key = (mod.select{|_, v| v}.keys + [code]).map{|c| code2key(c)}.join('-')
   key << " at #{app.title} [#{app.class_name}]" if rk.x11

data/example/mac-shortcut.rb

@@ -36,39 +36,76 @@ mod_disable_all = {}.merge(mod_disable_ctrl, mod_disable_shift, mod_disable_alt,
 rk = Rkremap.new
 rk.grab = true
 rk.x11 = true
-rk.start do |code, mod, app|
-  # Emacs や端末等ではそのまま
-  if app.class_name == 'Emacs' || app.class_name =~ /terminal/i || app.class_name == 'VirtualBox Machine'
+
+# Emacs や VirtualBox ではそのまま
+rk.match(app: /Emacs|VirtualBox Machine/) do |event|
+  rk.event(code: event.code, type: event.type)
+  event.skip
+end
+
+# 端末
+rk.match(app: /terminal/i) do |event, mod|
+  # Super+Ctrl はそのまま
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (mod[KEY_LEFTCTRL] || mod[KEY_RIGHTCTRL])
+    rk.event(code: event.code, type: event.type)
+  end
+  # Super+KEY は Ctrl+Shift+KEY に変換
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && Rkremap::CODE_KEY[event.code] =~ /\AKEY_[A-Z]\z/
+    rk.with_modifier(mod_disable_meta.merge(KEY_LEFTCTRL => true, KEY_LEFTSHIFT => true)) do
+      rk.event(code: event.code, type: event.type)
+    end
+  else
+    rk.event(code: event.code, type: event.type)
+  end
+  event.skip
+end
+
+rk.start do |code, mod|
+  # Super + Ctrl + 何か はそのまま
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (mod[KEY_LEFTCTRL] || mod[KEY_RIGHTCTRL])
     rk.key(code, mod)
     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})
-    mod[KEY_LEFTCTRL] = true
-    rk.key(code, mod)
+  # 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)
+    rk.key(code, mod.merge(mod_disable_meta, KEY_LEFTCTRL => true))
+    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+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}))
+      rk.key(KEY_END, mod_disable_all.merge(KEY_LEFTSHIFT => true)) # SHIFT+END
+      rk.key(KEY_X, mod_disable_all.merge(KEY_LEFTCTRL => true))    # Ctrl+X
       next
     end
+
     # 単純な変換
     if ctrl_map[code]
-      rk.key(ctrl_map[code], mod_disable_ctrl)
+      rk.key(ctrl_map[code], mod.merge(mod_disable_ctrl))
       next
     end
+
     # その他の Ctrl+[A-Z] は無視
     if Rkremap::CODE_KEY[code] =~ /\AKEY_[A-Z]\z/
       next
     end
   end
 
+  # それ以外はそのまま
   rk.key(code, mod)
 end

data/example/tmtms.rb

@@ -1,117 +1,69 @@
 # 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'
 
-  def pressed?
-    @press
-  end
-end
+include Rkremap::KeyCode
 
-rk = Rkremap.new
+rk = Rkremap.new(*ARGV, mouse: true, exclude: /touchpad/)
 rk.grab = true
 rk.x11 = true
 
-# 変換/無変換キーを0.5秒以上押してるとALTキーとして扱う。
-# 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとALTキーとして扱う。
+until system "xinput | grep -q rkremap"
+  sleep 0.1
+end
+system "xinput set-prop pointer:rkremap 'libinput Scroll Method Enabled' 0 0 1"
 
-state = {
-  KEY_HENKAN => State.new,
-  KEY_MUHENKAN => State.new,
+# HENKAN, MUHENKAN を 0.5秒以上押したら SUPER とする
+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  # 0.5秒以内に離された
+      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
 
+# 何かキーが押されたときに HENKAN, MUHENKAN が押されてれば SUPER が押されてることにする
 rk.match(type: :press) do
   [KEY_HENKAN, KEY_MUHENKAN].each do |code|
-    if state[code].pressed?
+    if jobs[code]&.cancel  # 0.5秒以内
       rk.event(code: henkan_map[code], type: :press)
-      state[code].converted = true
     end
   end
 end
 
+# マウスボタンイベントはそのまま
+rk.match(device: :mouse) do |event|
+  rk.event(code: event.code, type: event.type)
+  event.skip
+end
+
 # CAPSLOCK は CTRL に変換
 rk.match(code: KEY_CAPSLOCK) do |event|
-  rk.event(code: KEY_LEFTCTRL, type: event.type)
-  event.skip
+  event.code = KEY_LEFTCTRL
 end
 
-ctrl_map = {
-  KEY_A => KEY_HOME,
-  KEY_E => KEY_END,
-  KEY_B => KEY_LEFT,
-  KEY_F => KEY_RIGHT,
-  KEY_N => KEY_DOWN,
-  KEY_P => KEY_UP,
-  KEY_D => KEY_DELETE,
-  KEY_H => KEY_BACKSPACE,
-  KEY_I => KEY_TAB,
-}
 mod_disable_ctrl = {
   KEY_LEFTCTRL => false,
   KEY_RIGHTCTRL => false,
@@ -130,56 +82,102 @@ mod_disable_meta = {
 }
 mod_disable_all = {}.merge(mod_disable_ctrl, mod_disable_shift, mod_disable_alt, mod_disable_meta)
 
+# JISキーボードを英語配列にしたときに一部キーを変える
 key_map = {
   KEY_YEN => KEY_BACKSLASH,
   KEY_BACKSLASH => KEY_GRAVE,
   KEY_GRAVE => KEY_ESC,
 }
+rk.match do |event, mod|
+  event.code = key_map[event.code] || event.code
+  # RO キーは「\」(SHIFTキーを押してる場合は「_」)
+  if event.code == KEY_RO
+    event.code = (mod[KEY_LEFTSHIFT] || mod[KEY_RIGHTSHIFT]) ? KEY_MINUS : KEY_BACKSLASH
+  end
+end
+
+# Emacs や VirtualBox ではそのまま
+rk.match(app: /Emacs|VirtualBox Machine/) do |event|
+  rk.event(code: event.code, type: event.type)
+  event.skip
+end
 
-rk.start do |code, mod, app|
-  # JISキーボードを英語配列にしたときに一部キーを変える
-  code = key_map[code] || code
-  if code == KEY_RO
-    code = mod[KEY_LEFTSHIFT] || mod[KEY_RIGHTSHIFT] ? KEY_MINUS : KEY_BACKSLASH
+# 端末
+rk.match(app: /terminal/i) do |event, mod|
+  # Super+Ctrl はそのまま
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (mod[KEY_LEFTCTRL] || mod[KEY_RIGHTCTRL])
+    rk.event(code: event.code, type: event.type)
   end
+  # Super+KEY は Ctrl+Shift+KEY に変換
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && Rkremap::CODE_KEY[event.code] =~ /\AKEY_[A-Z]\z/
+    rk.with_modifier(mod_disable_meta.merge(KEY_LEFTCTRL => true, KEY_LEFTSHIFT => true)) do
+      rk.event(code: event.code, type: event.type)
+    end
+  else
+    rk.event(code: event.code, type: event.type)
+  end
+  event.skip
+end
+
+# その他のウィンドウ
+ctrl_map = {
+  KEY_A => KEY_HOME,
+  KEY_E => KEY_END,
+  KEY_B => KEY_LEFT,
+  KEY_F => KEY_RIGHT,
+  KEY_N => KEY_DOWN,
+  KEY_P => KEY_UP,
+  KEY_D => KEY_DELETE,
+  KEY_H => KEY_BACKSPACE,
+  KEY_I => KEY_TAB,
+}
 
-  # Emacs や端末等ではそのまま
-  if app.class_name == 'Emacs' || app.class_name =~ /terminal/i || app.class_name == 'VirtualBox Machine'
+rk.start do |code, mod|
+  # Super + Ctrl + 何か はそのまま
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (mod[KEY_LEFTCTRL] || mod[KEY_RIGHTCTRL])
     rk.key(code, mod)
     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})
-    mod[KEY_LEFTCTRL] = true
-    rk.key(code, mod)
+  # 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)
+    rk.key(code, mod.merge(mod_disable_meta, KEY_LEFTCTRL => true))
+    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/I/O は日本語変換時はそのまま
-    if (code == KEY_K || code == KEY_I || code ==KEY_O) && 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}))
+      rk.key(KEY_END, mod_disable_all.merge(KEY_LEFTSHIFT => true)) # SHIFT+END
+      rk.key(KEY_X, mod_disable_all.merge(KEY_LEFTCTRL => true))    # Ctrl+X
       next
     end
+
     # 単純な変換
     if ctrl_map[code]
-      rk.key(ctrl_map[code], mod_disable_ctrl)
+      rk.key(ctrl_map[code], mod.merge(mod_disable_ctrl))
       next
     end
+
     # その他の Ctrl+[A-Z] は無視
     if Rkremap::CODE_KEY[code] =~ /\AKEY_[A-Z]\z/
       next
     end
   end
 
+  # それ以外はそのまま
   rk.key(code, mod)
 end