rkremap 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04a75325e18cfa14e1eeb93462af309c6d692083c5ef4a2609e6dfd53747a6c8
-  data.tar.gz: 1f86fc05c3098eed25b0d09bbebfc75fdad37122898ee9762376ce5241f21c60
+  metadata.gz: 6476d10293c91c5afb744c6ebe1162d26ab253ad06aade6f5f2568db05bb7631
+  data.tar.gz: 35fd73d5a2d71ca797fd626397a789e8f22b5bd54cfa2ef0ca08f46adc6efa7f
 SHA512:
-  metadata.gz: 3874c3c1a1c9b78a82faf4c3ceb40f28e1d9d5f1380a8ac3f604ffc904f2dcb4099db5b84f2f9542ae4d104ac8f242f4edd8060c8da0aa4f65e8ddc472a4cab2
-  data.tar.gz: f9700cd0991fb27fa03de2a402dd1bfebe0f23cc35d128b5b35ca9115608988ce2f1aeea55cd8525a3c645e1b4a465b0aa0995703e4cb0b58f73bdb7e2efda3f
+  metadata.gz: bdf4f1364db8aa24dc49dab823e4f16200994058a6ff8d8e3323272d0783139af49f6fcdbb7f22b573dab92554d39d92429d24aa7b5fedf80e27139cf62bd120
+  data.tar.gz: d868e6b7af37edfa90324014669ff7de5595f392116bedeaf011cf95cd49ce9621782f1dda6e402c4e6117509ae0a0337322447028975ab743324da318479d0b

data/README.md

@@ -22,8 +22,11 @@ KERNEL=="uinput", GROUP="input"
 ```
 という内容で作れば `/dev/uinput` のグループを `input` にできるっぽい。
 
+`$VERBOSE` が真の場合はデバイスを検出したときと切断を検出したときにデバイス名を標準出力に出力する。
 
-### `Rkremap.new`
+## Rkremap
+
+### Rkremap.new
 
 引数を指定しなければ自動的にキーボードデバイスの検出を試みる。
 
@@ -40,9 +43,28 @@ 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
 
@@ -52,7 +74,7 @@ ThinkPad 本体のキーボードは `/dev/input/event3` だった。
 
 修飾キーの一覧。これらのキーは単体で押されただけでは `start` ブロックを実行しない。
 
-### auto_detect
+### Rkremap#auto_detect
 
 `true` の場合はキーボードデバイスの接続を自動検知する。
 `new` 時にデバイスファイルが指定されない場合は `true` になる。
@@ -65,13 +87,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`。
@@ -84,6 +120,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,82 @@ 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)
+  # Super+0/Minus は Ctrl+0/Minus に変換
+  elsif (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && Rkremap::CODE_KEY[event.code] =~ /\AKEY_(0|MINUS)\z/
+    rk.with_modifier(mod_disable_all.merge(KEY_LEFTCTRL => true)) do
+      rk.event(code: event.code, type: event.type)
+    end
+  # Super+KEY は Ctrl+Shift+KEY に変換
+  elsif (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && Rkremap::CODE_KEY[event.code] =~ /\AKEY_([A-Z]|EQUAL)\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 # rubocop:disable Lint/DuplicateBranch
+    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]/Minus/Equal/Enter を Ctrl+[A-Z]/Minus/Equal/Enter に変換
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (Rkremap::CODE_KEY[code] =~ /\AKEY_([0-9A-Z]|MINUS|EQUAL|ENTER)\z/)
+    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,107 +1,69 @@
 # tmtms 用
 
 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/i)
 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,
@@ -120,56 +82,107 @@ 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)
+  # Super+0/Minus は Ctrl+0/Minus に変換
+  elsif (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && Rkremap::CODE_KEY[event.code] =~ /\AKEY_(0|MINUS)\z/
+    rk.with_modifier(mod_disable_all.merge(KEY_LEFTCTRL => true)) do
+      rk.event(code: event.code, type: event.type)
+    end
+  # Super+KEY は Ctrl+Shift+KEY に変換
+  elsif (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && Rkremap::CODE_KEY[event.code] =~ /\AKEY_([A-Z]|EQUAL)\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 # rubocop:disable Lint/DuplicateBranch
+    rk.event(code: event.code, type: event.type)
   end
+  event.skip
+end
 
-  # Emacs や端末等ではそのまま
-  if app.class_name == 'Emacs' || app.class_name =~ /terminal/i || app.class_name == 'VirtualBox Machine'
+# その他のウィンドウ
+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,
+}
+
+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]/Minus/Equal/Enter を Ctrl+[A-Z]/Minus/Equal/Enter に変換
+  if (mod[KEY_LEFTMETA] || mod[KEY_RIGHTMETA]) && (Rkremap::CODE_KEY[code] =~ /\AKEY_([0-9A-Z]|MINUS|EQUAL|ENTER)\z/)
+    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
+    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