rkremap 0.2.1 → 0.4.0

data/lib/rkremap/evdev.rb

@@ -1,33 +1,13 @@
 class Rkremap
-  EV_KEY = 1
-  EV_SYN = 0
-  SYN_REPORT = 0
-
   # https://www.kernel.org/doc/html/v4.12/input/input_uapi.html
   class Evdev
     EVIOCGBIT_ANY = 2147566880     # EVIOCGBIT(0, 1)
-    EVIOCGBIT_EV_KEY = 2153792801  # EVIOCGBIT(EV_KEY, (KEY_MAX-1)/8+1)
+    EVIOCGBIT_EV_KEY = 2153792801  # EVIOCGBIT(EV_KEY, (KEY_CNT-1)/8+1)
     EVIOCGRAB = 1074021776
+    EVIOCGNAME = 2164278534        # EVIOCGNAME(256)
 
-    @io2evdev = {}
-    def self.io2evdev
-      @io2evdev
-    end
-
-    # @return [Array<Evdev>]
-    def self.devices
-      Dir.children("/dev/input").map do |dev|
-        dev =~ /\Aevent\d+\z/ ? Evdev.new("/dev/input/#{dev}") : nil
-      end.compact
-    end
-
-    # @param inputs [Array<Evdev>]
-    # @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]]
-    end
+    # @return [String]
+    attr_reader :path
 
     # @param path [String]
     def initialize(path)
@@ -35,14 +15,25 @@ class Rkremap
       @io = nil
       @capa = nil
       @uinput = nil
+      @grab = false
+    end
+
+    def eql?(other)
+      other.is_a?(Evdev) && self.path == other.path
     end
 
     # @return [IO]
     def io
       return @io if @io
       @io = File.open(@path)
-      self.class.io2evdev[@io] = self
-      @io
+    end
+
+    # @return [String]
+    def name
+      return @name if @name
+      buf = ''
+      io.ioctl(EVIOCGNAME, buf)
+      @name = buf.sub(/\0+$/, '')
     end
 
     def close
@@ -62,15 +53,37 @@ class Rkremap
 
     # @return [Boolean]
     def keyboard?
-      buf = ' '
+      return @is_keyboard unless @is_keyboard.nil?
+      @is_keyboard = false
+      return false if name =~ /\Arkremap\0*\z/
+
+      buf = ''
+      io.ioctl(EVIOCGBIT_ANY, buf)
+      return false if buf.unpack1('C')[EV_KEY] == 0
+      @is_keyboard = capable?(KeyCode::KEY_0) && capable?(KeyCode::KEY_9) &&
+                     capable?(KeyCode::KEY_A) && capable?(KeyCode::KEY_Z) && capable?(KeyCode::KEY_SPACE)
+    end
+
+    # @return [Boolean]
+    def mouse?
+      return @is_mouse unless @is_mouse.nil?
+      @is_mouse = false
+      return false if name =~ /\Arkremap\0*\z/
+
+      buf = ''
       io.ioctl(EVIOCGBIT_ANY, buf)
       return false if buf.unpack1('C')[EV_KEY] == 0
-      capable?(KeyCode::KEY_0) && capable?(KeyCode::KEY_9) &&
-        capable?(KeyCode::KEY_A) && capable?(KeyCode::KEY_Z) && capable?(KeyCode::KEY_SPACE)
+      @is_mouse = capable?(KeyCode::BTN_MOUSE)
     end
 
     def grab
       io.ioctl(EVIOCGRAB, 1)
+      @grab = true
+    end
+
+    # @return [Boolean]
+    def grab?
+      @grab
     end
 
     # struct input_event {
@@ -86,39 +99,14 @@ class Rkremap
       time = Time.at(sec, usec)
       return time, type, code, value
     end
-  end
-
-  # https://www.kernel.org/doc/html/v4.12/input/uinput.html
-  class Uinput
-    UI_SET_EVBIT = 1074025828
-    UI_SET_KEYBIT = 1074025829
-    UI_DEV_SETUP = 1079792899
-    UI_DEV_CREATE = 21761
-
-    def initialize
-      @dev = File.open('/dev/uinput', 'w')
-      setup
-    end
-
-    def setup
-      @dev.ioctl(UI_SET_EVBIT, EV_KEY)
-      KeyCode::KEY_CNT.times{|k| @dev.ioctl(UI_SET_KEYBIT, k)}
-      bustype = 0x03    # BUS_USB
-      vendor = 0x1234   # てきとー
-      product = 0x5678  # てきとー
-      version = 1       # てきとー
-      name = 'rkremap'
-      ff_efects_max = 0
-      setup = [bustype, vendor, product, version, name, ff_efects_max].pack("SSSSZ80L") # struct uinput_setup
-      @dev.ioctl(UI_DEV_SETUP, setup)
-      @dev.ioctl(UI_DEV_CREATE)
-    end
 
-    # @param type [Integer] EV_KEY/ EV_SYN
-    # @param code [Integer] キーコード / SYN_REPORT
-    # @param value [Integer] 0:release / 1:press / 2:repeat
-    def write_event(type, code, value)
-      @dev.syswrite(['', type, code, value].pack('a16SSl'))
+    # @param pattern [Symbol, Regexp]
+    def match?(pattern)
+      return true if pattern == true
+      return true if pattern == :keyboard && keyboard?
+      return true if pattern == :mouse && mouse?
+      return true if pattern.is_a?(Regexp) && pattern =~ name
+      return false
     end
   end
 end

data/lib/rkremap/evdev_list.rb

@@ -0,0 +1,84 @@
+require 'tmtms/timer'
+
+class Rkremap
+  class EvdevList
+    include Enumerable
+
+    attr_reader :device_list
+    attr_accessor :grab
+
+    # @param device_files [Array<String>] path list (/dev/input/event*)
+    # @param auto_detect [Boolean]
+    # @param detect_mouse [Boolean]
+    # @param exclude [Regexp]
+    def initialize(device_files, auto_detect: false, detect_mouse: false, exclude: nil)
+      @device_files = device_files
+      @auto_detect = auto_detect
+      @detect_mouse = detect_mouse
+      @exclude = exclude
+      @io2evdev = {}     # {IO => Evdev}
+      @device_list = {}  # {path => Evdev}
+      @prev_devices = []
+    end
+
+    def each(&block)
+      @device_list.each_value do |evdev|
+        block.call evdev
+      end
+    end
+
+    def detect_loop
+      detect
+      timer = Tmtms::Timer.new
+      timer.repeat(3) do
+        detect
+      end
+    end
+
+    def detect
+      devs = Dir.glob("/dev/input/event*")
+      (@device_list.keys - devs).each{|path| remove_device(path)}
+      new_devs = devs - @prev_devices
+      @prev_devices = devs
+      new_devs &= @device_files unless @auto_detect
+      new_devs -= @device_list.keys
+      new_devs.each do |path|
+        ev = Evdev.new(path)
+        next if @exclude && ev.name =~ @exclude
+        if ev.keyboard? || (@detect_mouse && ev.mouse?)
+          ev.grab if ev.match?(@grab)
+          puts "detect: #{ev.name} (#{ev.path}) #{ev.grab? ? 'grab' : 'not grab'}" if $VERBOSE
+          @io2evdev[ev.io] = ev
+          @device_list[path] = ev
+        end
+      end
+    end
+
+    # @param evdev [path]
+    def remove_device(path)
+      evdev = @device_list[path]
+      @io2evdev.delete evdev.io
+      evdev.close
+      @device_list.delete path
+    end
+
+    # @param timeout [Numeric]
+    # @return [Evdev]
+    def select(timeout)
+      r, = IO.select(@device_list.values.map(&:io), nil, nil, timeout)
+      r && @io2evdev[r[0]]
+    end
+
+    def read_event
+      while true
+        evdev = select(3)
+        next unless evdev
+        begin
+          return Event.new(evdev)
+        rescue Errno::ENODEV
+          remove_device(evdev.path)
+        end
+      end
+    end
+  end
+end

data/lib/rkremap/event.rb

@@ -0,0 +1,58 @@
+class Rkremap
+  class Event
+    Raw = Struct.new(:time, :type, :code, :value)
+
+    attr_accessor :app
+    attr_reader :raw, :ev_type
+    attr_writer :code
+
+    # @param evdev [Rkremap::Evdev]
+    # @param app [Rkremap::App]
+    def initialize(evdev)
+      @evdev = evdev
+      @raw = []
+      while true
+        s = evdev.read_event
+        @raw.push Raw.new(*s)
+        break if s[1] == EV_SYN
+      end
+      @ev_type = (@raw.find{_1[1] != EV_MSC && _1[1] != EV_SYN} || @raw.first)[1]
+    end
+
+    # @return [Rkremap::Event::Raw]
+    def key
+      @key ||= @raw.find{_1.type == EV_KEY}
+    end
+
+    def device
+      @evdev
+    end
+
+    def code
+      @code ||= key.code
+    end
+
+    def value
+      key.value
+    end
+
+    def type
+      @type ||= value == 1 ? :press : value == 0 ? :release : :repeat
+    end
+
+    def match?(device:, code:, type:, app:)
+      (device.nil? || self.device.match?(device)) &&
+        (code.nil? || Array(code).include?(self.code)) &&
+        (type.nil? || Array(type).include?(self.type)) &&
+        (app.nil? || @app.nil? || @app.match?(app))
+    end
+
+    def skip
+      @skipped = true
+    end
+
+    def skipped?
+      @skipped
+    end
+  end
+end

data/lib/rkremap/keycode.rb

@@ -249,6 +249,87 @@ class Rkremap
     KEY_WIMAX                    = KEY_WWAN
     KEY_RFKILL                   = 247 # Key that controls all radios
     KEY_MICMUTE                  = 248 # Mute / unmute the microphone
+
+    BTN_MISC                     = 0x100
+    BTN_0                        = 0x100
+    BTN_1                        = 0x101
+    BTN_2                        = 0x102
+    BTN_3                        = 0x103
+    BTN_4                        = 0x104
+    BTN_5                        = 0x105
+    BTN_6                        = 0x106
+    BTN_7                        = 0x107
+    BTN_8                        = 0x108
+    BTN_9                        = 0x109
+
+    BTN_LEFT                     = 0x110
+    BTN_MOUSE                    = 0x110
+    BTN_RIGHT                    = 0x111
+    BTN_MIDDLE                   = 0x112
+    BTN_SIDE                     = 0x113
+    BTN_EXTRA                    = 0x114
+    BTN_FORWARD                  = 0x115
+    BTN_BACK                     = 0x116
+    BTN_TASK                     = 0x117
+
+    BTN_JOYSTICK                 = 0x120
+    BTN_TRIGGER                  = 0x120
+    BTN_THUMB                    = 0x121
+    BTN_THUMB2                   = 0x122
+    BTN_TOP                      = 0x123
+    BTN_TOP2                     = 0x124
+    BTN_PINKIE                   = 0x125
+    BTN_BASE                     = 0x126
+    BTN_BASE2                    = 0x127
+    BTN_BASE3                    = 0x128
+    BTN_BASE4                    = 0x129
+    BTN_BASE5                    = 0x12a
+    BTN_BASE6                    = 0x12b
+    BTN_DEAD                     = 0x12f
+
+    BTN_GAMEPAD                  = 0x130
+    BTN_SOUTH                    = 0x130
+    BTN_A                        = BTN_SOUTH
+    BTN_EAST                     = 0x131
+    BTN_B                        = BTN_EAST
+    BTN_C                        = 0x132
+    BTN_NORTH                    = 0x133
+    BTN_X                        = BTN_NORTH
+    BTN_WEST                     = 0x134
+    BTN_Y                        = BTN_WEST
+    BTN_Z                        = 0x135
+    BTN_TL                       = 0x136
+    BTN_TR                       = 0x137
+    BTN_TL2                      = 0x138
+    BTN_TR2                      = 0x139
+    BTN_SELECT                   = 0x13a
+    BTN_START                    = 0x13b
+    BTN_MODE                     = 0x13c
+    BTN_THUMBL                   = 0x13d
+    BTN_THUMBR                   = 0x13e
+
+    BTN_DIGI                     = 0x140
+    BTN_TOOL_PEN                 = 0x140
+    BTN_TOOL_RUBBER              = 0x141
+    BTN_TOOL_BRUSH               = 0x142
+    BTN_TOOL_PENCIL              = 0x143
+    BTN_TOOL_AIRBRUSH            = 0x144
+    BTN_TOOL_FINGER              = 0x145
+    BTN_TOOL_MOUSE               = 0x146
+    BTN_TOOL_LENS                = 0x147
+    BTN_TOOL_QUINTTAP            = 0x148 # Five fingers on trackpad
+    BTN_STYLUS3                  = 0x149
+    BTN_TOUCH                    = 0x14a
+    BTN_STYLUS                   = 0x14b
+    BTN_STYLUS2                  = 0x14c
+    BTN_TOOL_DOUBLETAP           = 0x14d
+    BTN_TOOL_TRIPLETAP           = 0x14e
+    BTN_TOOL_QUADTAP             = 0x14f # Four fingers on trackpad
+
+    BTN_WHEEL                    = 0x150
+    BTN_GEAR_DOWN                = 0x150
+    BTN_GEAR_UP                  = 0x151
+
     KEY_OK                       = 0x160
     KEY_SELECT                   = 0x161
     KEY_GOTO                     = 0x162
@@ -502,7 +583,6 @@ class Rkremap
 
   CODE_KEY = {}
   KeyCode.constants.each do |k|
-    next unless k =~ /\AKEY_/
     code = KeyCode.const_get(k)
     CODE_KEY[code] = k unless CODE_KEY[code]
   end

data/lib/rkremap/uinput.rb

@@ -0,0 +1,40 @@
+class Rkremap
+  # https://www.kernel.org/doc/html/v4.12/input/uinput.html
+  class Uinput
+    UI_SET_EVBIT = 1074025828
+    UI_SET_KEYBIT = 1074025829
+    UI_SET_RELBIT = 1074025830
+    UI_DEV_SETUP = 1079792899
+    UI_DEV_CREATE = 21761
+
+    REL_CNT = 0x10
+
+    def initialize
+      @dev = File.open('/dev/uinput', 'w')
+      setup
+    end
+
+    def setup
+      @dev.ioctl(UI_SET_EVBIT, EV_KEY)
+      KeyCode::KEY_CNT.times{|k| @dev.ioctl(UI_SET_KEYBIT, k)}
+      @dev.ioctl(UI_SET_EVBIT, EV_REL)
+      REL_CNT.times{|r| @dev.ioctl(UI_SET_RELBIT, r)}
+      bustype = 0x03    # BUS_USB
+      vendor = 0x1234   # てきとー
+      product = 0x5678  # てきとー
+      version = 1       # てきとー
+      name = 'rkremap'
+      ff_efects_max = 0
+      setup = [bustype, vendor, product, version, name, ff_efects_max].pack("SSSSZ80L") # struct uinput_setup
+      @dev.ioctl(UI_DEV_SETUP, setup)
+      @dev.ioctl(UI_DEV_CREATE)
+    end
+
+    # @param type [Integer] EV_KEY/ EV_SYN
+    # @param code [Integer] キーコード / SYN_REPORT
+    # @param value [Integer] 0:release / 1:press / 2:repeat
+    def write_event(type, code, value)
+      @dev.syswrite(['', type, code, value].pack('a16SSl'))
+    end
+  end
+end

data/lib/rkremap/version.rb

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

data/lib/rkremap/winattr.rb

@@ -46,11 +46,14 @@ class Rkremap
     # @return [String]
     def app_title(window)
       win = app_win(window)[0]
+      return '' if win == 0
       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 = text_list.ptr.ptr.to_s.force_encoding('utf-8')
+      ptr = text_list.ptr
+      return '' if ptr.null?
+      title = ptr.ptr.to_s.force_encoding('utf-8')
       X11.XFreeStringList(text_list.ptr)
       title
     end

data/lib/rkremap.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "rkremap/version"
+require_relative 'rkremap/version'
 require_relative 'rkremap/keycode'
 require_relative 'rkremap/winattr'
+require_relative 'rkremap/evdev_list'
 require_relative 'rkremap/evdev'
+require_relative 'rkremap/event'
+require_relative 'rkremap/uinput'
 
 class Rkremap
   include KeyCode
 
+  # /usr/include/linux/input-event-codes.h
+  EV_SYN = 0
+  EV_KEY = 1
+  EV_REL = 2
+  EV_ABS = 3
+  EV_MSC = 4
+  SYN_REPORT = 0
+
   EVENT_TYPE_VALUE = {
     release: 0,
     press:   1,
@@ -17,12 +28,22 @@ class Rkremap
   attr_accessor :grab
   attr_accessor :modifiers
   attr_accessor :x11
+  attr_accessor :auto_detect
+  attr_accessor :exclude
+  attr_accessor :mouse
 
   # @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?)
-    raise 'Unable to detect keyboard device' if @inputs.empty?
+  # @param exclude [Regexp]
+  # @param mouse [Boolean]
+  def initialize(devices=[], exclude: nil, mouse: false)
+    if devices.empty?
+      @auto_detect = true
+    else
+      devices = Array(devices)
+    end
+    @devices = devices
+    @exclude = exclude
+    @mouse = mouse
     @uinput = Uinput.new
     @grab = false
     @x11 = false
@@ -32,34 +53,45 @@ class Rkremap
       KEY_LEFTALT,   KEY_RIGHTALT,
       KEY_LEFTMETA,  KEY_RIGHTMETA,
     ]
-    @events = []
+    @event_procs = []
     @mutex = Mutex.new
   end
 
+  # @param device [Symbol, Regexp]
   # @param code [Integer]
   # @param type [Symbol] :press / :release / :repeat
-  def match(code: nil, type: nil, &block)
-    @events.push [{code: code, type: type}, block]
+  # @param app [Regexp, String]
+  def match(device: nil, code: nil, type: nil, app: nil, &block)
+    @event_procs.push [{device: device, code: code, type: type, app: app}, block]
   end
 
   def start(&block)
-    @mod_state = @modifiers.map{|m| [m, false]}.to_h
-    @winattr = WinAttr.new if @x11
-    @inputs.each(&:grab) if @grab
+    @evdev_list = EvdevList.new(@devices, auto_detect: @auto_detect, exclude: @exclude, detect_mouse: @mouse)
+    @evdev_list.grab = @grab
+    @evdev_list.detect_loop
+    @mod_state = @modifiers.map.to_h{|m| [m, false]}
+    winattr = WinAttr.new if @x11
     while true
       @keys = []
-      input = Evdev.select(@inputs)
-      time, type, code, value = input.read_event
-      next if type != EV_KEY
-      event = Event.new(time, code, value, @winattr)
-      @events.each do |cond, b|
-        synchronize{ b.call event } if event.match?(**cond)
-        break if event.skipped
+      event = @evdev_list.read_event
+      if event.ev_type != EV_KEY
+        if event.device.grab?
+          event.raw.each do |r|
+            @uinput.write_event(r.type, r.code, r.value)
+          end
+        end
+        next
       end
-      next if event.skipped
-      synchronize{ proc_event(code, value, event) }
-      @keys.each do |c, mod, app|
-        synchronize{ block.call(c, mod, app) } if block
+      app = App.new(winattr) if winattr
+      event.app = app
+      @event_procs.each do |cond, b|
+        synchronize{ b.call(event, @mod_state.dup, app) } if event.match?(**cond)
+        break if event.skipped?
+      end
+      next if event.skipped?
+      synchronize{ proc_event(event, app) }
+      @keys.each do |c, mod, app_|
+        synchronize{ block.call(c, mod, app_) } if block
       end
     end
   end
@@ -70,20 +102,27 @@ class Rkremap
 
   # @param code [Integer]
   # @param type [Symbol] :press / :release / :repeat
-  # @param ev [Rkmap::Event]
-  def event(code: nil, type: nil, event: nil)
+  def event(code: nil, type: nil)
     value = EVENT_TYPE_VALUE[type] or raise "invalid type: #{type.inspect}"
-    proc_event(code, value, event)
+    update_modifiers(code, value)
+    write_event(code, value)
   end
 
   # @param code [Integer]
   # @param mod [Hash] {MOD_KEY => true, ...}
   def key(code, mod={})
+    with_modifier(mod) do
+      write_event(code, 1)
+      write_event(code, 0)
+    end
+  end
+
+  # @param mod [Hash] {MOD_KEY => true, ...}
+  def with_modifier(mod, &block)
     mod_diff(mod).each do |mcode, state|
       write_event(mcode, state ? 1 : 0)
     end
-    write_event(code, 1)
-    write_event(code, 0)
+    block.call
     mod_diff(mod).each do |mcode, _|
       write_event(mcode, @mod_state[mcode] ? 1 : 0)
     end
@@ -91,12 +130,23 @@ class Rkremap
 
   private
 
-  def proc_event(code, value, event)
+  def update_modifiers(code, value)
     if @mod_state.include?(code)
       @mod_state[code] = value != 0
+    end
+  end
+
+  # @param event [Rkremap::Event]
+  # @param app [Rkremap::App]
+  def proc_event(event, app)
+    code, value = event.code, event.value
+    if @mod_state.include?(code)
+      write_event(code, value)
+      update_modifiers(code, value)
+    elsif value == 0
       write_event(code, value)
-    elsif value != 0
-      @keys.push [code, @mod_state.dup, App.new(event&.win, @winattr)]
+    else
+      @keys.push [code, @mod_state.dup, app]
     end
   end
 
@@ -111,43 +161,44 @@ class Rkremap
     @uinput.write_event(EV_SYN, SYN_REPORT, 0)
   end
 
-  class Event
-    attr_reader :time
-    attr_reader :code
-    attr_reader :type
-    attr_reader :win
-    attr_reader :skipped
-
-    def initialize(time, code, value, winattr)
-      @time = time
-      @code = code
-      @value = value
-      @type = value == 1 ? :press : value == 0 ? :release : :repeat
-      @win = winattr&.focus_win
-      @skipped = false
-    end
-
-    def match?(code: nil, type: nil)
-      (code.nil? || Array(code).include?(@code)) && (type.nil? || Array(type).include?(@type))
-    end
-
-    def skip
-      @skipped = true
-    end
-  end
-
   class App
-    def initialize(win, winattr)
-      @win = win
+    # @param winattr [Rkremap::WinAttr]
+    def initialize(winattr)
       @winattr = winattr
+      @win = winattr.focus_win
     end
 
+    # @return [String, nil]
     def class_name
       @winattr.app_win(@win)[2] if @winattr && @win
     end
 
+    # @return [String, nil]
     def title
       @winattr.app_title(@win) if @winattr && @win
     end
+
+    # @param app [Array, Hash, String, Regexp]
+    # @return [Boolean]
+    def match?(app)
+      Array(app).each do |a|
+        a = {class_name: a, title: a} unless a.is_a? Hash
+        return true if match_sub(a[:class_name], class_name) || match_sub(a[:title], title)
+      end
+      false
+    end
+
+    # @param a [String, Regexp]
+    # @param b [String]
+    def match_sub(a, b)
+      case a
+      when String
+        a == b
+      when Regexp
+        a =~ b
+      else
+        false
+      end
+    end
   end
 end