xkeyrap 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcbb8debd9c802033dd0c1bb18f8ec2b140de08a9ea040e4968679b5c4d7bda0
-  data.tar.gz: 26338c6cec1a0d546a8df49e9cc8ffad58d682b559922f00012f346ed52835f6
+  metadata.gz: fc2fe8eb39aa1e50cf8d7ad39e3823ff4b45f1eea0be50a2b5c7f755d54c5162
+  data.tar.gz: 36c2677e59b9044b89f7531cebeea83a9fbaf3af8c10cd29a70f1c5549d06eca
 SHA512:
-  metadata.gz: 0f0aa81ad89305218900ec4cc1f393c5d4f60d8c7a97b38cf30facdf8614f2f1da4647653c7880024d792a9a35ec0180562e36b10247765f0cba0b6a788b885c
-  data.tar.gz: 1da4fe400ff6b280ad78c33388e302e4db0f894dc7d2921c5c6ad6a14c2f3a9f3fb48227a613b0bf41e8dd7a4a0e1e40e2ea78d29f2d3d82474be3a4c34c244c
+  metadata.gz: '086a216bb4c9b12225cf5168b86b83726655e4abab7b6cba8a4e05a07c65b5c406da959708cf3730f20a6e66fe481d4e209d22dd3df543d57d57fa4fd1535dcc'
+  data.tar.gz: 2c4666c41b40c1ff0aa427c9f9b249eeeeb00d7b6b8ac014235ecf2cbfd399cf964d9197ddd7ff6f37acf4daa9f39c42b0c44144a0f506a1da1c0274ef488f5e

data/README.md

@@ -1 +1,27 @@
-# hello world
+# Xkeyrap
+
+Xkeyrap 是一个受 [https://github.com/mooz/xkeysnail](xkeysnail) 启发的项目。
+
+如果你和我有一样的 [https://www.songofcode.com/posts/linux-shortcuts-for-macos/](改键需求), 可以使用下面的配置文件：
+
+``` json
+{
+  "Firefox": {
+    "KEY_LEFTALT": "KEY_LEFTCTRL",
+    "KEY_CAPSLOCK": "KEY_LEFTALT"
+  },
+  "Google-chrome": {
+    "KEY_LEFTALT": "KEY_LEFTCTRL",
+    "KEY_CAPSLOCK": "KEY_LEFTALT"
+  }
+}
+```
+
+## Usage
+
+``` shell
+sudo gem install xkeyrap # need sudo
+
+xhost +SI:localuser:root
+sudo xkeyrap config.json
+```

data/bin/xkeyrap

@@ -2,4 +2,7 @@
 
 require 'xkeyrap'
 
-Xkeyrap::Cli.run
+input_device = ARGV[1] # '/dev/input/event4'
+config_file  = ARGV[2]  # 'config.json'
+
+Xkeyrap::Cli.run(input_device, config_file)

data/lib/xkeyrap/command.rb

@@ -1,41 +1,38 @@
 require "evdev"
 require 'libevdev'
-
 require 'uinput/device'
+require 'json'
 
 module Xkeyrap
   class Command
-    attr_accessor :keys
-    attr_accessor :modifier_keys
     attr_accessor :output_device
     attr_accessor :config
 
-    def initialize(device, config)
-      self.keys = Set.new
-      self.modifier_keys = Set.new
+    def initialize(device, config_file)
+      self.config = default_config.merge(JSON.parse(config_file)) rescue default_config
       self.output_device = device
-      unless config
-        self.config = {
-          global: {
-            KEY_CAPSLOCK: :KEY_LEFTCTRL,
-            KEY_LEFTCTRL: :KEY_CAPSLOCK
-          },
-          "Firefox": {
-            KEY_LEFTALT: :KEY_LEFTCTRL,
-            KEY_CAPSLOCK: :KEY_LEFTALT
-          }
-        }
-      end
     end
 
     def receive(state, key, wm_class_name = "global")
+      key = key.to_sym
       puts "input: #{state} ... #{key}"
       sub_json = self.config[wm_class_name.to_sym] || self.config[:global]
       mapped_key = sub_json[key] || self.config[:global][key] || key
       puts "output: #{state} ... #{mapped_key}"
-      self.output_device.send_event(:EV_KEY, mapped_key, state)
+      self.output_device.send_event(:EV_KEY, mapped_key.to_sym, state)
       self.output_device.send_event(:EV_SYN, :SYN_REPORT)
     end
 
+    def default_config
+      {
+        global: {
+          KEY_CAPSLOCK: :KEY_LEFTCTRL,
+          KEY_LEFTCTRL: :KEY_CAPSLOCK,
+          KEY_LEFTALT:  :KEY_LEFTMETA,
+          KEY_LEFTMETA: :KEY_LEFTALT
+        }
+      }
+    end
+
   end
 end

data/lib/xkeyrap/key.rb

@@ -29,7 +29,17 @@ module Xkeyrap
       :KEY_COMMA,
       :KEY_DOT,
       :KEY_SLASH,
-      :KEY_BACKSLASH
+      :KEY_BACKSLASH,
+      :KEY_HOME,
+      :KEY_UP,
+      :KEY_PAGEUP,
+      :KEY_LEFT,
+      :KEY_RIGHT,
+      :KEY_END,
+      :KEY_DOWN,
+      :KEY_PAGEDOWN,
+      :KEY_INSERT,
+      :KEY_DELETE,
     ]
 
     LETTER_KEYS = [
@@ -75,7 +85,22 @@ module Xkeyrap
       :KEY_RIGHTCTRL
     ]
 
-    ALL_KEYS = NUMBER_KEYS + MISC_KEYS + LETTER_KEYS + MODIFIER_KEYS
+    FUNCTION_KEYS = [
+      :KEY_F1,
+      :KEY_F2,
+      :KEY_F3,
+      :KEY_F4,
+      :KEY_F5,
+      :KEY_F6,
+      :KEY_F7,
+      :KEY_F8,
+      :KEY_F9,
+      :KEY_F10,
+      :KEY_F11,
+      :KEY_F12,
+    ]
+
+    ALL_KEYS = NUMBER_KEYS + MISC_KEYS + LETTER_KEYS + MODIFIER_KEYS + FUNCTION_KEYS
 
   end
 end

data/lib/xkeyrap/version.rb

@@ -1,3 +1,3 @@
 module Xkeyrap
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/xkeyrap.rb

@@ -10,7 +10,7 @@ require 'uinput/device'
 module Xkeyrap
   class Cli
 
-    def self.run
+    def self.run(input_device, config_file)
       display = XlibObj::Display.new(':0')
       device = Uinput::Device.new do
         self.name = "Xkeyrap virtual device"
@@ -24,13 +24,10 @@ module Xkeyrap
         self.add_event(:EV_SYN)
       end
 
-      keyboard = Evdev.new('/dev/input/event4')
-
-      puts keyboard.supports_event? :KEY_ENTER
-      puts keyboard.supports_event? :KEY_KPENTER
+      keyboard = Evdev.new(input_device)
       keyboard.grab
 
-      command = Command.new(device, nil)
+      command = Command.new(device, config_file)
 
       key_handler = keyboard.on(*Xkeyrap::Key::ALL_KEYS) do |state, key|
         root_window = display.screens.first.root_window

data/xkeyrap.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "xkeyrap/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xkeyrap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - teddy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler