fusuma-plugin-sendkey 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37cb58747c750acf4c991fd174a8e19182336f518a54f4b2c816e3ead7f628eb
-  data.tar.gz: 9309dd43e32c3cd8b6791fe6c1a56f439fff6d7a05af41f9654e96360efd76bd
+  metadata.gz: d27660bea09b33620ab905e3b112cf0f9884b3617097daadd6d8ca03d2d5c14b
+  data.tar.gz: 70b1f7ddffaa8d874a44feaec361c60d0bca6744f30ec6a5c6f3c3efb1fe2a9f
 SHA512:
-  metadata.gz: 9f93e2a400820e3b4e138da96e71f90067bf514d35751bc6f31f6d58d9d4bc72ec18e621f04ede71eaa26131bbede74b7fb8bda420e8c38e3895f78299169616
-  data.tar.gz: 934f126d52d893d577fa9b5cec25209a88fbb3298d0004238e004676a898ced197ff481bed6aa1e3015fb55a05d33762aac9823b4a10d3bc796a940dc5e28ffc
+  metadata.gz: 0257fa54b43876536bb7729c74f05ff06d0a12e57885b5d544b9bdd209815780811496296339efca5353102f14fb811c1be7b82839b51542463c3cbbc90ad6b4
+  data.tar.gz: '049d2d9cf06c538800189db3addb7508e4c98a4390c3da8eb1a41dae2eb007fe11246fbfb86fe2ac76c131a81c7fa7255d2f7951f23d37fea92780920761617a'

data/README.md

@@ -2,7 +2,7 @@
 
 [Fusuma](https://github.com/iberianpig/fusuma) plugin that sending virtual keyboard events
 
-* Emulate keyboard events with evemu-event
+* Send keyboard events with writing event /dev/input/eventN
 * This plugin is wayland compatible and alternative to xdotool
 
 ## Installation
@@ -12,7 +12,7 @@ Run the following code in your terminal.
 ### Install dependencies
 
 ```sh
-$ sudo apt-get install evemu-tools libevdev-dev ruby-ffi
+$ sudo apt-get install libevdev-dev ruby-ffi
 ```
 
 ### Install fusuma-plugin-sendkey
@@ -22,7 +22,7 @@ $ sudo gem install fusuma-plugin-sendkey
 ```
 
 
-## List avaiable keys
+## List available keys
 
 ```sh
 $ fusuma-sendkey -l
@@ -30,12 +30,13 @@ $ fusuma-sendkey -l
 
 ## Run fusuma-sendkey on Terminal
 
-* `fusuma-sendkey` can emulate keyboard inputs as a command
+* `fusuma-sendkey` command is available on your terminal
+* `fusuma-sendkey` can send multiple key events
 * Combine keys for pressing the same time with `+` 
 
 
 ```sh
-$ fusuma-sendkey LEFTCTRL+T
+$ fusuma-sendkey LEFTCTRL+T # press ctrl key + t key
 ```
 
 

data/bin/console

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require 'fusuma/plugin/executors/executor'
 require "fusuma/plugin/sendkey"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/exe/fusuma-sendkey

@@ -20,7 +20,7 @@ end
 opt.parse!(ARGV)
 
 if option[:list]
-  puts Fusuma::Plugin::Sendkey::Keyboard.new.available_codes
+  puts Fusuma::Plugin::Sendkey::Keyboard.new.search_codes
   return
 end
 
@@ -37,6 +37,5 @@ if param.nil?
   exit 1
 end
 
-Fusuma::Plugin::Sendkey::Keyboard.new.type_command(param: param).tap do |command|
-  exec(command)
-end
+keyboard = Fusuma::Plugin::Sendkey::Keyboard.new
+keyboard.valid?(param: param) && keyboard.type(param: param)

data/fusuma-plugin-sendkey.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'evdev'
-  spec.add_dependency 'fusuma', '~> 1.5.0'
+  spec.add_dependency 'evdev', '~> 1.0'
+  spec.add_dependency 'fusuma', '~> 1.5'
+  spec.add_dependency 'linux_input', '~> 1.1'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.14'

data/lib/fusuma/plugin/executors/sendkey_executor.rb

@@ -17,12 +17,10 @@ module Fusuma
         # @param event [Event]
         # @return [nil]
         def execute(event)
-          return if search_command(event).nil?
-
           MultiLogger.info(sendkey: search_param(event))
           pid = fork do
             Process.daemon(true)
-            exec(search_command(event))
+            keyboard.type(param: search_param(event))
           end
 
           Process.detach(pid)
@@ -34,22 +32,18 @@ module Fusuma
         def executable?(event)
           event.tag.end_with?('_detector') &&
             event.record.type == :index &&
-            search_command(event)
+            keyboard.valid?(param: search_param(event))
         end
 
-        # @param event [Event]
-        # @return [String]
-        # @return [NilClass]
-        def search_command(event)
+        private
+
+        def keyboard
           @keyboard ||= begin
                           device = Sendkey::Device.new(path: config_params(:device_path))
                           Sendkey::Keyboard.new(device: device)
                         end
-          @keyboard.type_command(param: search_param(event))
         end
 
-        private
-
         def search_param(event)
           index = Config::Index.new([*event.record.index.keys, :sendkey])
           Config.search(index)

data/lib/fusuma/plugin/sendkey/device.rb

@@ -7,18 +7,16 @@ module Fusuma
     module Sendkey
       # handle Evdev device
       class Device
-        attr_reader :device_id
         def initialize(path: nil)
           return if path && (@evdev = Evdev.new(path))
 
           (0..99).lazy.find do |i|
-            begin
-              evdev = Evdev.new("/dev/input/event#{i}")
-              @evdev = evdev if evdev.supports_event?(convert_keycode('LEFTALT'))
-            rescue Errno::ENOENT # No such file or directory
-              false
-              # TODO: rescue Errno::EACCES
-            end
+            evdev = Evdev.new("/dev/input/event#{i}")
+            # NOTE: find keyboard device
+            @evdev = evdev if evdev.supports_event?('KEY_LEFTALT')
+          rescue Errno::ENOENT # No such file or directory
+            false
+            # TODO: rescue Errno::EACCES
           end
         end
 
@@ -28,36 +26,11 @@ module Fusuma
           @path ||= @evdev.file.path
         end
 
-        def support?(code)
-          keycode = convert_keycode(code)
+        def support?(keycode)
           @evdev.supports_event?(keycode)
         rescue NameError
-          candidates = search_codes(code: code)
-
-          warn "Did you mean? #{candidates.join(' / ')}" unless candidates.empty?
-
           false
         end
-
-        def search_codes(code: nil)
-          query = code&.upcase
-          LinuxInput.constants
-                    .select { |c| c[/KEY_.*#{query}.*/] }
-                    .select { |c| @evdev.supports_event?(c) }
-                    .map { |c| c.to_s.gsub('KEY_', '') }
-        end
-
-        def emulate(code:, press: true)
-          keycode = convert_keycode(code)
-          v = press ? 1 : 0
-          "evemu-event #{path} --type EV_KEY --code #{keycode} --value #{v} --sync"
-        end
-
-        private
-
-        def convert_keycode(code)
-          "KEY_#{code.upcase}"
-        end
       end
     end
   end

data/lib/fusuma/plugin/sendkey/keyboard.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'linux_input'
+require 'fcntl'
 require_relative './device.rb'
 
 module Fusuma
@@ -12,41 +14,100 @@ module Fusuma
         end
 
         # @param param [String]
-        def type_command(param:)
+        def type(param:)
           return unless param.is_a?(String)
 
-          codes = param.split('+')
-          press_commands = codes.map { |code| press_command(code) }
-          release_commands = codes.reverse.map { |code| release_command(code) }
+          keycodes = split_param(param)
 
-          (press_commands | release_commands).join(' && ')
+          clear_modifiers
+          keycodes.each { |keycode| key_event(keycode: keycode, press: true) }
+          key_sync(press: true)
+          keycodes.reverse.map { |keycode| key_event(keycode: keycode, press: false) }
+          key_sync(press: false)
+          device_file.close
         end
 
-        def press_command(code)
-          return unless support?(code)
+        # @param param [String]
+        def valid?(param:)
+          return unless param.is_a?(String)
+
+          keycodes = split_param(param)
+          keycodes.all? { |keycode| support?(keycode) }
+        end
+
+        def device_file
+          return @device_file if @device_file && !@device_file.closed?
 
-          @device.emulate(code: code, press: true)
+          @device_file = File.open(@device.path, Fcntl::O_WRONLY | Fcntl::O_NDELAY)
         end
 
-        def release_command(code)
-          return unless support?(code)
+        def key_event(keycode:, press: true)
+          event = LinuxInput::InputEvent.new
+          event[:time] = LinuxInput::Timeval.new
+          event[:time][:tv_sec] = Time.now.to_i
+          event[:type] = LinuxInput::EV_KEY
+          event[:code] = keycode_const(keycode)
+          event[:value] = press ? 1 : 0
+          device_file.syswrite(event.pointer.read_bytes(event.size))
+        end
 
-          @device.emulate(code: code, press: false)
+        def key_sync(press: true)
+          event = LinuxInput::InputEvent.new
+          event[:time] = LinuxInput::Timeval.new
+          event[:time][:tv_sec] = Time.now.to_i
+          event[:type] = LinuxInput::EV_SYN
+          event[:code] = LinuxInput::SYN_REPORT
+          event[:value] = press ? 1 : 0
+          device_file.syswrite(event.pointer.read_bytes(event.size))
         end
 
-        def support?(code)
+        def support?(keycode)
           @supported_code ||= {}
-          @supported_code[code] ||= if @device.support?(code)
-                                      true
-                                    else
-                                      warn "sendkey: #{code} is unsupported."
-                                      warn 'Please check your config.yml.'
-                                      exit 1
-                                    end
+          @supported_code[keycode] ||= if @device.support?(keycode)
+                                         true
+                                       else
+                                         search_candidates(keycode: keycode)
+                                         exit(1)
+                                       end
+        end
+
+        def search_candidates(keycode:)
+          candidates = search_codes(keycode: keycode)
+
+          warn "Did you mean? #{candidates.join(' / ')}" unless candidates.empty?
+          warn "sendkey: #{remove_prefix(keycode)} is unsupported."
+        end
+
+        def search_codes(keycode: nil)
+          query = keycode&.upcase&.gsub('KEY_', '')
+          LinuxInput.constants
+                    .select { |c| c[/KEY_.*#{query}.*/] }
+                    .select { |c| @device.support?(c) }
+                    .map { |c| c.to_s.gsub('KEY_', '') }
+        end
+
+        def keycode_const(keycode)
+          Object.const_get "LinuxInput::#{keycode}"
+        end
+
+        def clear_modifiers
+          modifiers = %w[ CAPSLOCK LEFTALT LEFTCTRL LEFTMETA
+                          LEFTSHIFT RIGHTALT RIGHTCTRL RIGHTSHIFT ]
+          modifiers.each { |code| key_event(keycode: key_prefix(code), press: false) }
+        end
+
+        private
+
+        def split_param(param)
+          param.split('+').map { |code| key_prefix(code) }
+        end
+
+        def key_prefix(code)
+          "KEY_#{code.upcase}"
         end
 
-        def available_codes
-          @device.search_codes
+        def remove_prefix(keycode)
+          keycode.gsub('KEY_', '')
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Sendkey
-      VERSION = '0.2.1'
+      VERSION = '0.3.0'
     end
   end
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-sendkey
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: evdev
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: fusuma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: linux_input
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -224,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Fusuma plugin that sending virtual keyboard events