xkeyrap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcbb8debd9c802033dd0c1bb18f8ec2b140de08a9ea040e4968679b5c4d7bda0
+  data.tar.gz: 26338c6cec1a0d546a8df49e9cc8ffad58d682b559922f00012f346ed52835f6
+SHA512:
+  metadata.gz: 0f0aa81ad89305218900ec4cc1f393c5d4f60d8c7a97b38cf30facdf8614f2f1da4647653c7880024d792a9a35ec0180562e36b10247765f0cba0b6a788b885c
+  data.tar.gz: 1da4fe400ff6b280ad78c33388e302e4db0f894dc7d2921c5c6ad6a14c2f3a9f3fb48227a613b0bf41e8dd7a4a0e1e40e2ea78d29f2d3d82474be3a4c34c244c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.5

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in xkeyrap.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    xkeyrap (0.0.1)
+      evdev
+      libevdev
+      uinput-device
+      xlib-objects
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    callbacks_attachable (2.3.1)
+    coderay (1.1.2)
+    evdev (1.0.0)
+      callbacks_attachable (~> 2.3)
+      libevdev (~> 1.0)
+    ffi (1.9.25)
+    libevdev (1.0.0)
+      linux_input (~> 1.0)
+    linux_input (1.0.0)
+      ffi (~> 1.9)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    uinput (1.2.0)
+      linux_input (~> 1.0)
+    uinput-device (0.4.0)
+      uinput (~> 1.1)
+    xlib (1.2.0)
+      ffi (~> 1.9)
+    xlib-objects (0.7.6)
+      xlib (~> 1.2)
+      xlib-xinput2 (~> 1.0)
+    xlib-xinput2 (1.0.0)
+      xlib (~> 1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  xkeyrap!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 teddy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# hello world

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xkeyrap"
+
+# 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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/xkeyrap

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'xkeyrap'
+
+Xkeyrap::Cli.run

data/lib/xkeyrap/command.rb

@@ -0,0 +1,41 @@
+require "evdev"
+require 'libevdev'
+
+require 'uinput/device'
+
+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
+      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")
+      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_SYN, :SYN_REPORT)
+    end
+
+  end
+end

data/lib/xkeyrap/key.rb

@@ -0,0 +1,81 @@
+#https://github.com/christopheraue/ruby-linux_input/blob/master/lib/linux_input/generated/input.rb
+
+module Xkeyrap
+  class Key
+    NUMBER_KEYS = [
+      :KEY_0,
+      :KEY_1,
+      :KEY_2,
+      :KEY_3,
+      :KEY_4,
+      :KEY_5,
+      :KEY_6,
+      :KEY_7,
+      :KEY_8,
+      :KEY_9
+    ]
+
+    MISC_KEYS = [
+      :KEY_LEFTBRACE,
+      :KEY_RIGHTBRACE,
+      :KEY_ENTER,
+      :KEY_KPENTER,
+      :KEY_SEMICOLON,
+      :KEY_APOSTROPHE,
+      :KEY_BACKSPACE,
+      :KEY_TAB,
+      :KEY_DASHBOARD,
+      :KEY_GRAVE,
+      :KEY_COMMA,
+      :KEY_DOT,
+      :KEY_SLASH,
+      :KEY_BACKSLASH
+    ]
+
+    LETTER_KEYS = [
+      :KEY_Q,
+      :KEY_W,
+      :KEY_E,
+      :KEY_R,
+      :KEY_T,
+      :KEY_Y,
+      :KEY_U,
+      :KEY_I,
+      :KEY_O,
+      :KEY_P,
+      :KEY_A,
+      :KEY_S,
+      :KEY_D,
+      :KEY_F,
+      :KEY_G,
+      :KEY_H,
+      :KEY_J,
+      :KEY_K,
+      :KEY_L,
+      :KEY_Z,
+      :KEY_X,
+      :KEY_C,
+      :KEY_V,
+      :KEY_B,
+      :KEY_N,
+      :KEY_M,
+    ]
+
+    MODIFIER_KEYS = [
+      :KEY_ESC,
+      :KEY_LEFTSHIFT,
+      :KEY_RIGHTSHIFT,
+      :KEY_RIGHTALT,
+      :KEY_LEFTALT,
+      :KEY_SPACE,
+      :KEY_CAPSLOCK,
+      :KEY_LEFTMETA,
+      :KEY_RIGHTMETA,
+      :KEY_LEFTCTRL,
+      :KEY_RIGHTCTRL
+    ]
+
+    ALL_KEYS = NUMBER_KEYS + MISC_KEYS + LETTER_KEYS + MODIFIER_KEYS
+
+  end
+end

data/lib/xkeyrap/version.rb

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

data/lib/xkeyrap.rb

@@ -0,0 +1,69 @@
+require "xkeyrap/version"
+require 'xkeyrap/key'
+require "xkeyrap/command"
+
+require 'xlib-objects'
+require "evdev"
+require 'libevdev'
+require 'uinput/device'
+
+module Xkeyrap
+  class Cli
+
+    def self.run
+      display = XlibObj::Display.new(':0')
+      device = Uinput::Device.new do
+        self.name = "Xkeyrap virtual device"
+        self.type = LinuxInput::BUS_VIRTUAL
+
+        Xkeyrap::Key::ALL_KEYS.each do |k|
+          self.add_key(k)
+        end
+
+        self.add_event(:EV_KEY)
+        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.grab
+
+      command = Command.new(device, nil)
+
+      key_handler = keyboard.on(*Xkeyrap::Key::ALL_KEYS) do |state, key|
+        root_window = display.screens.first.root_window
+        top_level_windows = root_window.property(:_NET_CLIENT_LIST_STACKING)
+        focused_window = display.focused_window
+        wm_class_name = if focused_window.property("WM_CLASS")
+                          focused_window.property("WM_CLASS")[1]
+                        else
+                          get_parent_window_name(display, top_level_windows, focused_window)
+                        end
+
+        command.receive(state, key, wm_class_name)
+      end
+
+      loop do
+        begin
+          keyboard.handle_event
+        rescue Evdev::AwaitEvent
+          Kernel.select([keyboard.event_channel])
+          retry
+        end
+      end
+    end
+
+    def self.get_parent_window_name(display, top_level_windows, focused_window)
+      root     = FFI::MemoryPointer.new :Window
+      parent   = FFI::MemoryPointer.new :Window
+      number   = FFI::MemoryPointer.new :uint
+      children = FFI::MemoryPointer.new :pointer
+      q = Xlib.XQueryTree(display.to_native, focused_window.to_native, root, parent, children, number)
+      parent_window_id = parent.read(:int)
+      parent_window = top_level_windows.select {|tlw| tlw.id == parent_window_id }.first
+      parent_window.property("WM_CLASS")[1]
+    end
+  end
+end

data/xkeyrap.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xkeyrap/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xkeyrap"
+  spec.version       = Xkeyrap::VERSION
+  spec.authors       = ["teddy"]
+  spec.email         = ["mlc880926@gmail.com"]
+
+  spec.summary       = %q{a sample keyboard remapping tool for X environment}
+  spec.homepage      = "https://github.com/teddy-ma/xkeyrap"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables << 'xkeyrap'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+
+  spec.add_runtime_dependency "evdev", "~> 1.0"
+  spec.add_runtime_dependency "libevdev", "~> 1.0"
+  spec.add_runtime_dependency "uinput-device", "~> 0.4"
+  spec.add_runtime_dependency "xlib-objects", "~> 0.7"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: xkeyrap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- teddy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: evdev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: libevdev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: uinput-device
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: xlib-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: 
+email:
+- mlc880926@gmail.com
+executables:
+- xkeyrap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/xkeyrap
+- lib/xkeyrap.rb
+- lib/xkeyrap/command.rb
+- lib/xkeyrap/key.rb
+- lib/xkeyrap/version.rb
+- xkeyrap.gemspec
+homepage: https://github.com/teddy-ma/xkeyrap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: a sample keyboard remapping tool for X environment
+test_files: []