fusuma-plugin-sendkey 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863f4caf17a75bd03010d34cc01a493ad7dfc327a4e4c9c05ed3ecae91f57286
-  data.tar.gz: 6a64a753da83d4561c5d7384366d3596aac6b4d8c7aaad082187d943f4771d91
+  metadata.gz: 0512b4f118bd0b676616741f47a643a759d8eb123eb581bb3136b38a34f0acc4
+  data.tar.gz: 45cafd5f8b3f8cd1e44643c20438b04ce59065854548123285ea5eea1e5585fc
 SHA512:
-  metadata.gz: e016af2afb00bc864a57dc0c5cc36935e6d35d132cb268de9c18e1aa8062c896fcc8febc952f7a1b823f055bb7eb51b2e4e81bbef1a8002807dfc136cc938884
-  data.tar.gz: 896772bbd1dc67818cff10a3d8bacc1d582370b5075af0df0e9d4a6f32f497a2024c5cf80d5794367d69547b334d95202dfa50ef5888576b26f4e3fd84b1d105
+  metadata.gz: 264b5e7d2ae3729ccc1f3fe0db02dab1ee1999e089fab2cd2df9f97f3994ff0c20976e37a6e2105c141161dc70db20d4058098529bba5372427bfe242d6d10d5
+  data.tar.gz: b1cb6a075c279a15e63f7685d5887dc0b2c4c767915fb4066b2d929788b725c2d8127d766e5045ee5b1c49f2f40e9882793066e6607f56d2dae967347d89667a

data/README.md

@@ -1,4 +1,4 @@
-# Fusuma::Plugin::Sendkey [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-sendkey.svg)](https://badge.fury.io/rb/fusuma-plugin-sendkey) [![Build Status](https://travis-ci.com/iberianpig/fusuma-plugin-sendkey.svg?branch=master)](https://travis-ci.com/iberianpig/fusuma-plugin-sendkey)
+# Fusuma::Plugin::Sendkey [![Gem Version](https://badge.fury.io/rb/fusuma-plugin-sendkey.svg)](https://badge.fury.io/rb/fusuma-plugin-sendkey) [![Build Status](https://github.com/iberianpig/fusuma-plugin-sendkey/actions/workflows/main.yml/badge.svg)](https://github.com/iberianpig/fusuma-plugin-sendkey/actions/workflows/main.yml)
 
 [Fusuma](https://github.com/iberianpig/fusuma) plugin to send keyboard events
 
@@ -85,6 +85,20 @@ swipe:
       sendkey: "LEFTCTRL+W" # close tab
 ```
 
+### clearmodifiers
+
+- `clearmodifiers: true` option clears other modifier keys before sending
+
+```yaml
+swipe:
+  4:
+    up:
+      keypress:
+        LEFTSHIFT:
+          sendkey: "LEFTMETA+DOWN"
+          clearmodifiers: true # clear LEFTSHIFT before sending LEFTMETA+DOWN
+```
+
 
 ### Specify keyboard by device name
 
@@ -105,6 +119,9 @@ plugin:
       device_name: 'YOUR KEYBOARD NAME'
 ```
 
+**If [fusuma-plugin-remap](https://github.com/iberianpig/fusuma-plugin-remap) is available, it will be automatically connected to `fusuma_virtual_keyboard`, so `device_name` option is not required.**
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-sendkey. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/bin/console

@@ -4,9 +4,7 @@ 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.
+Fusuma::Plugin::Manager.require_base_plugins
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
-Pry.start
+require "irb"
+IRB.start(__FILE__)

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

@@ -5,8 +5,13 @@ require_relative "../sendkey/keyboard"
 module Fusuma
   module Plugin
     module Executors
-      # Control Window or Workspaces by executing wctrl
+      # Execute to send key event to device
       class SendkeyExecutor < Executor
+        def initialize
+          @device_name = config_params(:device_name)
+          super
+        end
+
         def execute_keys
           [:sendkey]
         end
@@ -22,21 +27,10 @@ module Fusuma
         # @return [nil]
         def execute(event)
           MultiLogger.info(sendkey: search_param(event))
-          pid = fork do
-            Process.daemon(true)
-            _execute(event)
-          end
-
-          Process.detach(pid)
-        end
-
-        # execute sendkey command
-        # @param event [Event]
-        # @return [nil]
-        def _execute(event)
           keyboard.type(
             param: search_param(event),
-            keep: search_keypress(event)
+            keep: search_keypress(event),
+            clear: clearmodifiers(event)
           )
         end
 
@@ -52,10 +46,7 @@ module Fusuma
         private
 
         def keyboard
-          @keyboard ||= begin
-            name_pattren = config_params(:device_name)
-            Sendkey::Keyboard.new(name_pattern: name_pattren)
-          end
+          @keyboard ||= Sendkey::Keyboard.new(name_pattern: @device_name)
         end
 
         def search_param(event)
@@ -63,14 +54,28 @@ module Fusuma
           Config.search(index)
         end
 
+        # search keypress from config for keep modifiers when sendkey
         # @param event [Event]
         # @return [String]
         def search_keypress(event)
+          # if fusuma_virtual_keyboard exists, don't have to keep modifiers
+          return "" if keyboard.use_virtual_keyboard?
+
           keys = event.record.index.keys
           keypress_index = keys.find_index { |k| k.symbol == :keypress }
           code = keypress_index && keys[keypress_index + 1].symbol
           code.to_s
         end
+
+        # clearmodifiers from config
+        # @param event [Event]
+        # @return [String, TrueClass, Symbole]
+        def clearmodifiers(event)
+          @clearmodifiers ||= {}
+          index = event.record.index
+          @clearmodifiers[index.cache_key] ||=
+            Config.search(Config::Index.new([*index.keys, "clearmodifiers"])) || :none
+        end
       end
     end
   end

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

@@ -24,33 +24,57 @@ module Fusuma
           KEY_RIGHTMETA
         ].freeze
 
+        DEFAULT_NAME_PATTERN = "keyboard|Keyboard|KEYBOARD"
+        VIRTUAL_KEYBOARD = "fusuma_virtual_keyboard" # fusuma-plugin-remap creates uinput device
+
         def self.find_device(name_pattern:)
+          Fusuma::Device.reset
           Fusuma::Device.all.find { |d| d.name.match(/#{name_pattern}/) }
         end
 
         def initialize(name_pattern: nil)
-          name_pattern ||= "keyboard|Keyboard|KEYBOARD"
-          device = Keyboard.find_device(name_pattern: name_pattern)
+          device = if name_pattern
+            Keyboard.find_device(name_pattern: name_pattern)
+          else
+            Keyboard.find_device(name_pattern: VIRTUAL_KEYBOARD) || Keyboard.find_device(name_pattern: DEFAULT_NAME_PATTERN)
+          end
 
           if device.nil?
             warn "sendkey: Keyboard: /#{name_pattern}/ is not found"
             exit(1)
           end
+          MultiLogger.info "sendkey: Keyboard: #{device.name}"
 
+          @use_virtual_keyboard = device.name.match(/#{VIRTUAL_KEYBOARD}/o)
           @device = Device.new(path: "/dev/input/#{device.id}")
         end
 
-        # @param param [String]
-        # @param keep [String]
-        def type(param:, keep: "")
+        def use_virtual_keyboard?
+          @use_virtual_keyboard
+        end
+
+        # @param param [String] key names separated by '+' to type
+        # @param keep [String] key names separated by '+' to keep
+        # @param clear [String, Symbol, TrueClass] key names separated by '+' to clear or :all to relase all modifiers
+        def type(param:, keep: "", clear: :none)
           return unless param.is_a?(String)
 
           param_keycodes = param_to_keycodes(param)
-          keep_keycodes = param_to_keycodes(keep)
+          type_keycodes = param_keycodes - param_to_keycodes(keep)
+
+          clear_keycodes =
+            case clear
+            when true
+              MODIFIER_KEY_CODES
+            when :none, false
+              []
+            else
+              # release keys specified by clearmodifiers
+              param_to_keycodes(clear)
+            end
+
+          clear_modifiers(clear_keycodes - param_keycodes)
 
-          type_keycodes = param_keycodes - keep_keycodes
-          # release other modifier keys before sending key
-          clear_modifiers(MODIFIER_KEY_CODES - param_keycodes)
           type_keycodes.each { |keycode| keydown(keycode) && key_sync }
           type_keycodes.reverse_each { |keycode| keyup(keycode) && key_sync }
         end
@@ -122,7 +146,7 @@ module Fusuma
         end
 
         def keycode_const(keycode)
-          Object.const_get "LinuxInput::#{keycode}"
+          Object.const_get "Revdev::#{keycode}"
         end
 
         # @param [Array<String>] keycodes to be released

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

@@ -3,7 +3,7 @@
 module Fusuma
   module Plugin
     module Sendkey
-      VERSION = "0.7.1"
+      VERSION = "0.8.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusuma-plugin-sendkey
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - iberianpig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fusuma