rkremap 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6476d10293c91c5afb744c6ebe1162d26ab253ad06aade6f5f2568db05bb7631
-  data.tar.gz: 35fd73d5a2d71ca797fd626397a789e8f22b5bd54cfa2ef0ca08f46adc6efa7f
+  metadata.gz: 2052faf03d55e5ca684ee7c991fe42ecb187f2294376216e333d9aced2a45188
+  data.tar.gz: cc901a01fec47fcafc320ea355c5ea71dd8cc8e54c05f4f7774f02beda3ab328
 SHA512:
-  metadata.gz: bdf4f1364db8aa24dc49dab823e4f16200994058a6ff8d8e3323272d0783139af49f6fcdbb7f22b573dab92554d39d92429d24aa7b5fedf80e27139cf62bd120
-  data.tar.gz: d868e6b7af37edfa90324014669ff7de5595f392116bedeaf011cf95cd49ce9621782f1dda6e402c4e6117509ae0a0337322447028975ab743324da318479d0b
+  metadata.gz: dad24b3679af4213746a787811812afe8791d4964eba2ea018debffb94f7558dec29915a9be18e3aa1952a6817ea6ec823045c0ab8ae45afc9d22649f8c90374
+  data.tar.gz: 6dbef790e758293b32891d2aabd4cc939b3259b55b5c6d5ed297d2a96ffe9feaeb657675c98b16cd3c73480f3d6f0b35e98f12fadd0d0f41a3020cca894cf069

data/README.md

@@ -79,6 +79,44 @@ rkremap.exclude = /touchpad/i
 `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
 
 なにかキーを押されたらブロックを実行する。修飾キー単体ではブロックは実行されない。

data/example/henkan-super.rb

@@ -2,51 +2,24 @@
 # 0.5秒以内でも変換/無変換キーを押しながら他のキーを押すとSUPERキーとして扱う。
 
 require 'rkremap'
-require '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  # 0.5秒以内に離された
-      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
 
-# 何かキーが押されたときに 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/tmtms.rb

@@ -1,57 +1,22 @@
 # tmtms 用
 
 require 'rkremap'
-require 'tmtms_timer'
 
 include Rkremap::KeyCode
 
-rk = Rkremap.new(*ARGV, mouse: true, exclude: /touchpad/i)
+rk = Rkremap.new(*ARGV, mouse: true, exclude: /\AELAN0676/i)
 rk.grab = true
 rk.x11 = true
 
-until system "xinput | grep -q rkremap"
-  sleep 0.1
-end
+# 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 とする
-timer = Tmtms::Timer.new
-jobs = {
-  KEY_HENKAN => nil,
-  KEY_MUHENKAN => nil,
-}
-
-henkan_map = {
+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  # 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.match(device: :mouse) do |event|
@@ -60,9 +25,17 @@ rk.match(device: :mouse) do |event|
 end
 
 # CAPSLOCK は CTRL に変換
-rk.match(code: KEY_CAPSLOCK) do |event|
-  event.code = KEY_LEFTCTRL
-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,
+)
 
 mod_disable_ctrl = {
   KEY_LEFTCTRL => false,
@@ -82,20 +55,6 @@ 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)

data/lib/rkremap/remap.rb

@@ -0,0 +1,105 @@
+class Rkremap
+  class Remap
+    # @param map [Hash] from => to
+    # @param hold [Numeric] seconds
+    def initialize(rk, map:, hold:)
+      @rk = rk
+      @pressed = {}
+
+      if hold
+        setup_holding_event(map, hold)
+      else
+        setup_event(map)
+      end
+    end
+
+    # @param map [Hash] {form => to}
+    def setup_event(map)
+      keycodes = map.keys.flatten
+
+      @rk.match(code: keycodes, type: :press) do |event, current_mod|
+        map.each do |from, to|
+          if event_match?(from, event, current_mod)
+            make_press_event(to, event)
+            break
+          end
+        end
+      end
+
+      @rk.match(code: keycodes, type: :release) do |event|
+        if @pressed[event.code]
+          @rk.event(code: @pressed[event.code], type: :release)
+          @pressed[event.code] = nil
+          event.skip
+        end
+      end
+    end
+
+    # @param map [Hash] {form => to}
+    # @param hold [Numeric] seconds
+    def setup_holding_event(map, hold)
+      keycodes = map.keys.flatten
+      timer = Tmtms::Timer.new
+      jobs = map.transform_values{nil}
+
+      @rk.match(code: keycodes, type: :press) do |event|
+        map.each do |from, to|
+          if from == event.code
+            jobs[event.code] = timer.set(hold) do
+              @rk.synchronize{ make_press_event(to) }
+            end
+            event.skip
+            break
+          end
+        end
+      end
+
+      @rk.match(code: keycodes, type: :repeat) do |event|
+        event.skip
+      end
+
+      @rk.match(code: keycodes, type: :release) do |event|
+        if jobs[event.code]&.cancel
+          @rk.key(event.code)
+        elsif map[event.code]
+          @rk.event(code: map[event.code], type: :release)
+        end
+        event.skip
+      end
+
+      @rk.match(type: :press) do
+        jobs.each do |code, job|
+          make_press_event(map[code]) if job&.cancel
+        end
+      end
+    end
+
+    # @param keys [Integer, Array<Integer>] KEY_A, [KEY_LEFTCTRL, KEY_A], [:SHIFT, KEY_A], ...
+    # @param event [Rkremap::Event]
+    # @param mod [Hash] current modifiers status
+    def event_match?(keys, event, mod)
+      if keys == event.code
+        return true
+      end
+      keys = Array(keys)
+      return false unless keys.include? event.code
+      (keys - [event.code]).all?{mod[_1]}
+    end
+
+    # @param to [Integer, Array<Integer>]
+    # @param event [Rkremap::Event, nil]
+    def make_press_event(to, event=nil)
+      Array(to).each do |key|
+        @pressed[event.code] = key if event
+        if @rk.modifiers.include? key
+          @rk.event(code: key, type: :press)
+          event&.skip
+        elsif event
+          event.code = key
+        else
+          @rk.key(code: key, type: :press)
+        end
+      end
+    end
+  end
+end

data/lib/rkremap/version.rb

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

data/lib/rkremap.rb

@@ -7,6 +7,7 @@ require_relative 'rkremap/evdev_list'
 require_relative 'rkremap/evdev'
 require_relative 'rkremap/event'
 require_relative 'rkremap/uinput'
+require_relative 'rkremap/remap'
 
 class Rkremap
   include KeyCode
@@ -57,6 +58,17 @@ class Rkremap
     @mutex = Mutex.new
   end
 
+  # @overload remap(map)
+  #   @param map [Hash] from => to
+  # @overload remap(map:, hold: nil)
+  #   @param map [Hash] from => to
+  #   @param hold [Numeric] seconds
+  def remap(**opts)
+    map, hold = opts[:map], opts[:hold]
+    map ||= opts
+    Remap.new(self, map: map, hold: hold)
+  end
+
   # @param device [Symbol, Regexp]
   # @param code [Integer]
   # @param type [Symbol] :press / :release / :repeat

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rkremap
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - TOMITA Masahiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-27 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tmtms_timer
@@ -41,6 +41,7 @@ files:
 - lib/rkremap/evdev_list.rb
 - lib/rkremap/event.rb
 - lib/rkremap/keycode.rb
+- lib/rkremap/remap.rb
 - lib/rkremap/uinput.rb
 - lib/rkremap/version.rb
 - lib/rkremap/winattr.rb