fusuma-plugin-remap 0.3.0 → 0.4.0

data/lib/fusuma/plugin/remap/uinput_touchpad.rb

@@ -0,0 +1,172 @@
+require "ruinput"
+
+class UinputTouchpad < Ruinput::UinputDevice
+  include Ruinput
+
+  # create from original event device
+  # copy absinfo using eviocgabs
+  def create_from_device(name:, device:)
+    id = Revdev::InputId.new(
+      {
+        bustype: Revdev::BUS_I8042,
+        vendor: device.device_id.vendor,
+        product: device.device_id.product,
+        version: device.device_id.version
+      }
+    )
+
+    absinfo = {
+      Revdev::ABS_X => device.absinfo_for_axis(Revdev::ABS_X),
+      Revdev::ABS_Y => device.absinfo_for_axis(Revdev::ABS_Y),
+      Revdev::ABS_MT_POSITION_X => device.absinfo_for_axis(Revdev::ABS_MT_POSITION_X),
+      Revdev::ABS_MT_POSITION_Y => device.absinfo_for_axis(Revdev::ABS_MT_POSITION_Y),
+      Revdev::ABS_MT_SLOT => device.absinfo_for_axis(Revdev::ABS_MT_SLOT),
+      Revdev::ABS_MT_TOOL_TYPE => device.absinfo_for_axis(Revdev::ABS_MT_TOOL_TYPE),
+      Revdev::ABS_MT_TRACKING_ID => device.absinfo_for_axis(Revdev::ABS_MT_TRACKING_ID)
+    }
+
+    uud = Ruinput::UinputUserDev.new({
+      name: name,
+      id: id,
+      ff_effects_max: 0,
+      absmax: Array.new(Revdev::ABS_CNT, 0).tap { |a| absinfo.each { |k, v| a[k] = v[:absmax] } },
+      absmin: Array.new(Revdev::ABS_CNT, 0).tap { |a| absinfo.each { |k, v| a[k] = v[:absmin] } },
+      absfuzz: Array.new(Revdev::ABS_CNT, 0).tap { |a| absinfo.each { |k, v| a[k] = v[:absfuzz] } },
+      absflat: Array.new(Revdev::ABS_CNT, 0).tap { |a| absinfo.each { |k, v| a[k] = v[:absflat] } },
+      resolution: Array.new(Revdev::ABS_CNT, 0).tap { |a| absinfo.each { |k, v| a[k] = v[:resolution] } }
+    })
+
+    @file.syswrite uud.to_byte_string
+
+    set_all_events
+
+    @file.ioctl UI_DEV_CREATE, nil
+    @is_created = true
+  end
+
+  def set_all_events
+    raise "invalid method call: this uinput is already created" if @is_created
+
+    mouse_btns = [
+      Revdev::BTN_0,
+      Revdev::BTN_MISC,
+      Revdev::BTN_1,
+      Revdev::BTN_2,
+      Revdev::BTN_3,
+      Revdev::BTN_4,
+      Revdev::BTN_5,
+      Revdev::BTN_6,
+      Revdev::BTN_7,
+      Revdev::BTN_8,
+      Revdev::BTN_9,
+      Revdev::BTN_LEFT,
+      Revdev::BTN_MOUSE,
+      Revdev::BTN_MIDDLE,
+      Revdev::BTN_RIGHT,
+      Revdev::BTN_SIDE,
+      Revdev::BTN_EXTRA,
+      Revdev::BTN_FORWARD,
+      Revdev::BTN_BACK,
+      Revdev::BTN_TASK
+      # Revdev::BTN_TRIGGER, # disable because libinput recognize this device as a joystick
+    ].freeze
+
+    touchpad_btns = [
+      Revdev::BTN_TOUCH,
+      Revdev::BTN_TOOL_FINGER,
+      Revdev::BTN_TOOL_DOUBLETAP,
+      Revdev::BTN_TOOL_TRIPLETAP,
+      Revdev::BTN_TOOL_QUADTAP,
+      0x148 # define BTN_TOOL_QUINTTAP	0x148	/* Five fingers on trackpad */
+    ].freeze
+
+    @file.ioctl UI_SET_EVBIT, Revdev::EV_KEY
+    @counter = 0
+    Revdev::KEY_CNT.times do |i|
+      # https://github.com/mooz/xkeysnail/pull/101/files
+      if mouse_btns.include?(i) || touchpad_btns.include?(i)
+        # puts "setting #{i} (#{Revdev::REVERSE_MAPS[:KEY][i]})"
+        @file.ioctl UI_SET_KEYBIT, i
+      else
+        # puts "skipping #{i} (#{Revdev::REVERSE_MAPS[:KEY][i]})"
+      end
+    end
+
+    touchpad_abs = [
+      Revdev::ABS_X,
+      Revdev::ABS_Y,
+      # Revdev::ABS_PRESSURE,
+      Revdev::ABS_MT_SLOT,
+      # Revdev::ABS_MT_TOUCH_MAJOR,
+      # Revdev::ABS_MT_TOUCH_MINOR,
+      Revdev::ABS_MT_POSITION_X,
+      Revdev::ABS_MT_POSITION_Y,
+      Revdev::ABS_MT_TRACKING_ID,
+      Revdev::ABS_MT_TOOL_TYPE
+    ].freeze
+
+    # kernel bug: device has min == max on ABS_Y
+    @file.ioctl UI_SET_EVBIT, Revdev::EV_ABS
+    Revdev::ABS_CNT.times do |i|
+      if touchpad_abs.include?(i)
+        puts "setting #{i} (#{Revdev::REVERSE_MAPS[:ABS][i]})"
+        @file.ioctl UI_SET_ABSBIT, i
+      else
+        puts "skipping #{i} (#{Revdev::REVERSE_MAPS[:ABS][i]})"
+      end
+    end
+
+    touchpad_rels = [
+      Revdev::REL_X,
+      Revdev::REL_Y,
+      Revdev::REL_WHEEL,
+      Revdev::REL_HWHEEL
+    ].freeze
+
+    @file.ioctl UI_SET_EVBIT, Revdev::EV_REL
+    Revdev::REL_CNT.times do |i|
+      if touchpad_rels.include?(i)
+        puts "setting #{i} (#{Revdev::REVERSE_MAPS[:REL][i]})"
+        @file.ioctl UI_SET_RELBIT, i
+      else
+        puts "skipping #{i} (#{Revdev::REVERSE_MAPS[:REL][i]})"
+      end
+    end
+
+    @file.ioctl UI_SET_EVBIT, Revdev::EV_REP
+
+    touchpad_mscs = [
+      0x05 # define MSC_TIMESTAMP		0x05
+    ]
+    @file.ioctl UI_SET_EVBIT, Revdev::EV_MSC
+    Revdev::MSC_CNT.times do |i|
+      if touchpad_mscs.include?(i)
+        # puts "setting #{i} (#{Revdev::REVERSE_MAPS[:MSC][i]})"
+        @file.ioctl UI_SET_MSCBIT, i
+      else
+        # puts "skipping #{i} (#{Revdev::REVERSE_MAPS[:MSC][i]})"
+      end
+    end
+  end
+end
+
+class Revdev::EventDevice
+  def absinfo_for_axis(abs)
+    data = read_ioctl_with(eviocgabs(abs))
+
+    {
+      value: data[0, 4].unpack1("l<"),
+      absmin: data[4, 4].unpack1("l<"),
+      absmax: data[8, 4].unpack1("l<"),
+      absfuzz: data[12, 4].unpack1("l<"),
+      absflat: data[16, 4].unpack1("l<"),
+      resolution: data[20, 4].unpack1("l<")
+    }
+  end
+
+  # FIXME: undefined constants in revdev
+  def eviocgabs(abs)
+    # #define EVIOCGABS(abs)	_IOR('E', 0x40 + abs, struct input_absinfo)
+    0x80404540 + abs # EVIOCGABS(abs)
+  end
+end

data/lib/fusuma/plugin/remap/version.rb

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Remap
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-remap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: fusuma-plugin-keypress
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ email:
 - yhkyky@gmail.com
 executables:
 - fusuma-remap
+- fusuma-touchpad-remap
 extensions: []
 extra_rdoc_files: []
 files:
@@ -98,13 +99,18 @@ files:
 - bin/console
 - bin/setup
 - exe/fusuma-remap
+- exe/fusuma-touchpad-remap
 - fusuma-plugin-remap.gemspec
 - lib/fusuma/plugin/inputs/remap_keyboard_input.rb
 - lib/fusuma/plugin/inputs/remap_keyboard_input.yml
+- lib/fusuma/plugin/inputs/remap_touchpad_input.rb
+- lib/fusuma/plugin/inputs/remap_touchpad_input.yml
 - lib/fusuma/plugin/remap.rb
+- lib/fusuma/plugin/remap/keyboard_remapper.rb
 - lib/fusuma/plugin/remap/layer_manager.rb
-- lib/fusuma/plugin/remap/remapper.rb
-- lib/fusuma/plugin/remap/ruinput_device_patched.rb
+- lib/fusuma/plugin/remap/touchpad_remapper.rb
+- lib/fusuma/plugin/remap/uinput_keyboard.rb
+- lib/fusuma/plugin/remap/uinput_touchpad.rb
 - lib/fusuma/plugin/remap/version.rb
 homepage: https://github.com/iberianpig/fusuma-plugin-remap
 licenses:
@@ -126,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: A Fusuma plugin for remapping keyboard events into virtual input devices.

data/lib/fusuma/plugin/remap/remapper.rb

@@ -1,233 +0,0 @@
-require "revdev"
-require "msgpack"
-require "set"
-require_relative "./layer_manager"
-
-require_relative "./ruinput_device_patched"
-
-module Fusuma
-  module Plugin
-    module Remap
-      class Remapper
-        include Revdev
-        # @param layer_manager [Fusuma::Plugin::Remap::LayerManager]
-        # @param keyboard_writer [IO]
-        # @param source_keyboards [Array<Revdev::Device>]
-        # @param internal_touchpad [Revdev::Device]
-        def initialize(layer_manager:, keyboard_writer:, source_keyboards:, internal_touchpad:)
-          @layer_manager = layer_manager # request to change layer
-          @keyboard_writer = keyboard_writer # write event to original keyboard
-          @source_keyboards = source_keyboards # original keyboard
-          @internal_touchpad = internal_touchpad # internal touchpad
-          @uinput = RuinputDevicePatched.new "/dev/uinput"
-          @pressed_virtual_keys = Set.new
-        end
-
-        def run
-          create_virtual_keyboard
-          set_trap
-          grab_keyboards
-
-          old_ie = nil
-          next_mapping = nil
-          current_mapping = {}
-
-          loop do
-            ios = IO.select([*@source_keyboards.map(&:file), @layer_manager.reader])
-            io = ios.first.first
-
-            if io == @layer_manager.reader
-              begin
-                @layer_manager.receive_layer
-              rescue EOFError
-                @destroy.call
-              end
-
-              MultiLogger.debug "Remapper#run: layer changed to #{@layer_manager.current_layer}"
-              next_mapping = @layer_manager.find_mapping
-              next
-            end
-
-            if next_mapping && virtual_keyboard_all_key_released?
-              if current_mapping != next_mapping
-                current_mapping = next_mapping
-              end
-              next_mapping = nil
-            end
-
-            input_event = @source_keyboards.find { |kbd| kbd.file == io }.read_input_event
-            input_key = find_key_from_code(input_event.code)
-
-            if input_event.type == EV_KEY
-              # FIXME: exit when RIGHTCTRL-LEFTCTRL is pressed
-              if (old_ie&.code == KEY_RIGHTCTRL && old_ie.value != 0) && (input_event.code == KEY_LEFTCTRL && input_event.value != 0)
-                @destroy.call
-              end
-
-              old_ie = input_event
-              if input_event.value != 2 # repeat
-                packed = {key: input_key, status: input_event.value}.to_msgpack
-                @keyboard_writer.puts(packed)
-              end
-            end
-
-            remapped = current_mapping.fetch(input_key.to_sym, nil)
-            if remapped.nil?
-              @uinput.write_input_event(input_event)
-              next
-            end
-
-            remapped_event = InputEvent.new(nil, input_event.type, find_code_from_key(remapped), input_event.value)
-
-            # When Set.delete? fails, it means that the key was pressed before remapping started and was released.
-            unless record_virtual_keyboard_event?(remapped, remapped_event.value)
-              # set original key before remapping
-              remapped_event.code = input_event.code
-            end
-
-            # remap to command will be nil
-            # e.g) remap: { X: { command: echo 'foo' } }
-            # this is because the command will be executed by fusuma process
-            next if remapped_event.code.nil?
-
-            @uinput.write_input_event(remapped_event)
-          end
-        end
-
-        # @param [Revdev::InputEvent] event
-        # @return [void]
-        def record_virtual_keyboard_event?(remapped_value, event_value)
-          case event_value
-          when 0
-            @pressed_virtual_keys.delete?(remapped_value)
-          when 1
-            @pressed_virtual_keys.add?(remapped_value)
-          else
-            # 2 is repeat
-            true
-          end
-        end
-
-        def virtual_keyboard_all_key_released?
-          @pressed_virtual_keys.empty?
-        end
-
-        def create_virtual_keyboard
-          @uinput.create "fusuma_virtual_keyboard",
-            Revdev::InputId.new(
-              # recognized as an internal keyboard on libinput,
-              # touchpad is disabled when typing
-              # see: (https://wayland.freedesktop.org/libinput/doc/latest/palm-detection.html#disable-while-typing)
-              {
-                bustype: Revdev::BUS_I8042,
-                vendor: @internal_touchpad.device_id.vendor,
-                product: @internal_touchpad.device_id.product,
-                version: @internal_touchpad.device_id.version
-              }
-            )
-        end
-
-        def grab_keyboards
-          @source_keyboards.each do |keyboard|
-            wait_release_all_keys(keyboard) && keyboard.grab
-          end
-        end
-
-        def set_trap
-          @destroy = lambda do
-            @source_keyboards.each do |kbd|
-              kbd.ungrab
-            rescue Errno::EINVAL
-              # already ungrabbed
-            end
-
-            begin
-              @uinput.destroy
-            rescue IOError
-              # already destroyed
-            end
-
-            exit 0
-          end
-
-          Signal.trap(:INT) { @destroy.call }
-          Signal.trap(:TERM) { @destroy.call }
-        end
-
-        # Find remappable key from mapping and return remapped key code
-        # If not found, return original key code
-        # If the key is found but its value is not valid, return nil
-        # @example
-        #  find_remapped_code({ "A" => "b" }, 30) # => 48
-        #  find_remapped_code({ "A" => "b" }, 100) # => 100
-        #  find_remapped_code({ "A" => {command: 'echo foobar'}  }, 30) # => nil
-        #
-        # @param [Hash] mapping
-        # @param [Integer] code
-        # @return [Integer, nil]
-        def find_remapped_code(mapping, code)
-          key = find_key_from_code(code) # key = "A"
-          remapped_key = mapping.fetch(key.to_sym, nil) # remapped_key = "b"
-          return code unless remapped_key # return original code if key is not found
-
-          find_code_from_key(remapped_key) # remapped_code = 48
-        end
-
-        # Find key name from key code
-        # @example
-        #  find_key_from_code(30) # => "A"
-        #  find_key_from_code(48) # => "B"
-        # @param [Integer] code
-        # @return [String]
-        def find_key_from_code(code)
-          # { 30 => :A, 48 => :B, ... }
-          @keys_per_code ||= Revdev.constants.select { |c| c.start_with? "KEY_" }.map { |c| [Revdev.const_get(c), c.to_s.delete_prefix("KEY_")] }.to_h
-          @keys_per_code[code]
-        end
-
-        # Find key code from key name (e.g. "A", "B", "BTN_LEFT")
-        # If key name is not found, return nil
-        # @example
-        #  find_code_from_key("A") # => 30
-        #  find_code_from_key("B") # => 48
-        #  find_code_from_key("BTN_LEFT") # => 272
-        #  find_code_from_key("NOT_FOUND") # => nil
-        # @param [String] key
-        # @return [Integer] when key is available
-        # @return [nil] when key is not available
-        def find_code_from_key(key)
-          # { KEY_A => 30, KEY_B => 48, ... }
-          @codes_per_key ||= Revdev.constants.select { |c| c.start_with?("KEY_", "BTN_") }.map { |c| [c, Revdev.const_get(c)] }.to_h
-
-          case key
-          when String
-            if key.start_with?("BTN_")
-              @codes_per_key[key.upcase.to_sym]
-            else
-              @codes_per_key["KEY_#{key}".upcase.to_sym]
-            end
-          when Integer
-            @codes_per_key["KEY_#{key}".upcase.to_sym]
-          end
-        end
-
-        def released_all_keys?(device)
-          # key status if all bytes are 0, the key is not pressed
-          bytes = device.read_ioctl_with(Revdev::EVIOCGKEY)
-          bytes.unpack("C*").all? { |byte| byte == 0 }
-        end
-
-        def wait_release_all_keys(device, &block)
-          loop do
-            if released_all_keys?(device)
-              break true
-            else
-              # wait until all keys are released
-              device.read_input_event
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fusuma/plugin/remap/ruinput_device_patched.rb

@@ -1,49 +0,0 @@
-require "ruinput"
-
-class RuinputDevicePatched < Ruinput::UinputDevice
-  include Ruinput
-  def set_all_events
-    raise "invalid method call: this uinput is already created" if @is_created
-
-    mouse_btns = [
-      Revdev::BTN_0,
-      Revdev::BTN_MISC,
-      Revdev::BTN_1,
-      Revdev::BTN_2,
-      Revdev::BTN_3,
-      Revdev::BTN_4,
-      Revdev::BTN_5,
-      Revdev::BTN_6,
-      Revdev::BTN_7,
-      Revdev::BTN_8,
-      Revdev::BTN_9,
-      Revdev::BTN_LEFT,
-      Revdev::BTN_MOUSE,
-      Revdev::BTN_MIDDLE,
-      Revdev::BTN_RIGHT
-    ].freeze
-
-    keyboard_keys = Revdev.constants.select { |c| c.start_with? "KEY_" }.map { |c| Revdev.const_get(c) }.freeze
-
-    @file.ioctl UI_SET_EVBIT, Revdev::EV_KEY
-    (Revdev::KEY_RESERVED...Revdev::KEY_CNT).each do |n|
-      # https://github.com/mooz/xkeysnail/pull/101/files
-      next unless keyboard_keys.include?(n) || mouse_btns.include?(n)
-
-      @file.ioctl UI_SET_KEYBIT, n
-    end
-
-    # @file.ioctl UI_SET_EVBIT, Revdev::EV_MSC
-    # Revdev::MSC_CNT.times do |i|
-    #   @file.ioctl UI_SET_MSCBIT, i
-    # end
-
-    # kernel bug: device has min == max on ABS_Y
-    # @file.ioctl UI_SET_EVBIT, Revdev::EV_ABS
-    # Revdev::ABS_CNT.times do |i|
-    #   @file.ioctl UI_SET_ABSBIT, i
-    # end
-
-    @file.ioctl UI_SET_EVBIT, Revdev::EV_REP
-  end
-end