rkremap 0.3.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55d8872f73bd984afd69fdf3c17e53f39de16a4f8feef40bc851b6527e57aa17
-  data.tar.gz: 99c6a99b3fdd44e206d416eab361ca1ab4c9e4defc0d96bfa2fc0e563a5a1e4c
+  metadata.gz: 2052faf03d55e5ca684ee7c991fe42ecb187f2294376216e333d9aced2a45188
+  data.tar.gz: cc901a01fec47fcafc320ea355c5ea71dd8cc8e54c05f4f7774f02beda3ab328
 SHA512:
-  metadata.gz: c9ad9908d2a602e2740748924e5cd83c1f6526eda164c389cde0b22d1b4462d74c7f5eba3809f2c353396500efe5a5447cb22302a0c8db9aaf4fbfa739f1c6a9
-  data.tar.gz: 936cef85543d1089d81323ddd4f11a7b4da2afb44d6f7d7c9921132182e300e963a73ad8e51f8e80a6cf879251caad0c5235cddc0cc73a51dc315f2b5a487744
+  metadata.gz: dad24b3679af4213746a787811812afe8791d4964eba2ea018debffb94f7558dec29915a9be18e3aa1952a6817ea6ec823045c0ab8ae45afc9d22649f8c90374
+  data.tar.gz: 6dbef790e758293b32891d2aabd4cc939b3259b55b5c6d5ed297d2a96ffe9feaeb657675c98b16cd3c73480f3d6f0b35e98f12fadd0d0f41a3020cca894cf069

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,11 +74,49 @@ ThinkPad 本体のキーボードは `/dev/input/event3` だった。
 
 修飾キーの一覧。これらのキーは単体で押されただけでは `start` ブロックを実行しない。
 
-### auto_detect
+### Rkremap#auto_detect
 
 `true` の場合はキーボードデバイスの接続を自動検知する。
 `new` 時にデバイスファイルが指定されない場合は `true` になる。
 
+### Rkremap#remap
+
+引数の Hash で変換するキーを指定する:
+```ruby
+rk.remap(KEY_CAPSLOCK => KEY_LEFTCTRL)
+```
+
+変換元を配列で修飾キーを書くとその修飾キーとの組み合わせで変換する:
+```ruby
+rk.remap([KEY_LEFTCTRL, KEY_A] => KEY_HOME)
+```
+
+hold を指定すると指定秒数長押ししたときだけ変換する:
+```ruby
+rk.remap(hold: 0.5, map: {
+  KEY_MUHENKAN => KEY_RIGHTMETA,
+  KEY_HENKAN   => KEY_RIGHTMETA,
+})
+```
+
+次のように書くと、A も B も C もすべて A になってしまう:
+```ruby
+rk.remap(KEY_A => KEY_B)
+rk.remap(KEY_B => KEY_C)
+rk.remap(KEY_C => KEY_A)
+```
+
+A を B, B を C, C を A と変換したい場合は次のように書く:
+```ruby
+rk.remap(
+  KEY_A => KEY_B,
+  KEY_B => KEY_C,
+  KEY_C => KEY_A
+)
+```
+
+`#remap` で実現できないような複雑な処理は、後述の `#match` や `#start` で書くことができるかもしれない。
+
 ### Rkremap#start
 
 なにかキーを押されたらブロックを実行する。修飾キー単体ではブロックは実行されない。
@@ -65,13 +125,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 +158,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

@@ -1,57 +1,25 @@
-# 変換/無変換キーを0.5秒以上押してるとALTキーとして扱う。
-# 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとALTキーとして扱う。
+# 変換/無変換キーを0.5秒以上押してるとSUPERキーとして扱う。
+# 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとSUPERキーとして扱う。
 
 require 'rkremap'
-require 'tmtms_timer'  # gem install tmtms_timer
 
 include Rkremap::KeyCode
 
-rk = Rkremap.new
+rk = Rkremap.new(*ARGV, mouse: true)
 rk.grab = true
 
-timer = Tmtms::Timer.new
-jobs = {
-  KEY_HENKAN => nil,
-  KEY_MUHENKAN => nil,
-}
-
-henkan_map = {
+# HENKAN, MUHENKAN を 0.5秒以上押したら SUPER とする
+rk.remap(hold: 0.5, 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
+# マウスボタンイベントはそのまま
+rk.match(device: :mouse) do |event|
+  rk.event(code: event.code, type: event.type)
   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/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,45 +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
 
-  # 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)
+  # 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}))
+    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,67 +1,42 @@
 # tmtms 用
 
 require 'rkremap'
-require 'tmtms_timer'  # gem install tmtms_timer
 
 include Rkremap::KeyCode
 
-rk = Rkremap.new
+rk = Rkremap.new(*ARGV, mouse: true, exclude: /\AELAN0676/i)
 rk.grab = true
 rk.x11 = true
 
-timer = Tmtms::Timer.new
-jobs = {
-  KEY_HENKAN => nil,
-  KEY_MUHENKAN => nil,
-}
-henkan_map = {
+# rkremap がシステムに認識されたら中ボタンスクロールを有効にする
+sleep 0.1 until system "xinput | grep -q rkremap"
+system "xinput set-prop pointer:rkremap 'libinput Scroll Method Enabled' 0 0 1"
+
+# HENKAN, MUHENKAN を 0.5秒以上押したら SUPER とする
+rk.remap(hold: 0.5, 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
+# マウスボタンイベントはそのまま
+rk.match(device: :mouse) do |event|
+  rk.event(code: event.code, type: event.type)
   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
-
 # CAPSLOCK は CTRL に変換
-rk.match(code: KEY_CAPSLOCK) do |event|
-  rk.event(code: KEY_LEFTCTRL, type: event.type)
-  event.skip
-end
+rk.remap(KEY_CAPSLOCK => KEY_LEFTCTRL)
+
+# JISキーボードを英語配列にしたときに一部キーを変える
+rk.remap(
+  KEY_YEN => KEY_BACKSLASH,
+  KEY_BACKSLASH => KEY_GRAVE,
+  KEY_GRAVE => KEY_ESC,
+  [KEY_LEFTSHIFT, KEY_RO] => [KEY_LEFTSHIFT, KEY_MINUS],
+  [KEY_RIGHTSHIFT, KEY_RO] => [KEY_LEFTSHIFT, KEY_MINUS],
+  KEY_RO => KEY_BACKSLASH,
+)
 
-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,
@@ -80,36 +55,63 @@ mod_disable_meta = {
 }
 mod_disable_all = {}.merge(mod_disable_ctrl, mod_disable_shift, mod_disable_alt, mod_disable_meta)
 
-key_map = {
-  KEY_YEN => KEY_BACKSLASH,
-  KEY_BACKSLASH => KEY_GRAVE,
-  KEY_GRAVE => KEY_ESC,
-}
+# 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
+
+# その他のウィンドウ
+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
 
-  # 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)
+  # 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}))
+    rk.key(code == KEY_F ? KEY_RIGHT : KEY_LEFT, mod.merge(mod_disable_alt, KEY_LEFTCTRL => true))
     next
   end
 
@@ -120,22 +122,26 @@ rk.start do |code, mod, app|
       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