rbindkeys 0.0.1

data/lib/rbindkeys/log_utils.rb

@@ -0,0 +1,51 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'logger'
+
+module Rbindkeys
+
+  class LogUtils
+
+    DEFAULT_LOG_OUTPUT = STDOUT
+    DEFAULT_FORMAT = :simple
+    DEFAULT_LEVEL = Logger::INFO
+    @@output = DEFAULT_LOG_OUTPUT
+    @@format = DEFAULT_FORMAT
+    @@level = DEFAULT_LEVEL
+
+    class << self
+
+      def get_logger progname
+        logger = Logger.new @@output
+
+        logger.progname = progname
+        logger.level = @@level
+        set_formatter logger
+
+        logger
+      end
+
+      def set_formatter logger
+        case @@format
+        when :simple
+          logger.formatter = proc do |sev, date, prog, msg|
+            "* #{msg}\n"
+          end
+        when :default
+        else
+          l = Logger.new STDERR
+          l.fatal "unknown logger format"
+          exit false
+        end
+      end
+
+      # setter and reader methods for the class variables
+      [:output, :format, :level].each do |name|
+        eval "def #{name}; @@#{name} end"
+        eval "def #{name}= o; @@#{name} = o end"
+      end
+
+    end
+  end
+
+end

data/lib/rbindkeys/observer.rb

@@ -0,0 +1,140 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require "revdev"
+
+module Rbindkeys
+
+  # main event loop class
+  class Observer
+    include Revdev
+
+    LOG = LogUtils.get_logger name
+    VIRTUAL_DEVICE_NAME = "rbindkyes"
+    DEFAULT_TIMEOUT = 0.5
+
+    attr_reader :device
+    attr_reader :virtual
+    attr_reader :event_handler
+    attr_reader :config_file
+
+    def initialize config_name, device_location
+      @device = Device.new device_location
+      @virtual = VirtualDevice.new
+      operator = DeviceOperator.new @device, @virtual
+      @event_handler = KeyEventHandler.new operator
+      @config_file = config_name
+      @started = false
+      @window_observer = ActiveWindowX::EventListener.new
+      @timeout = DEFAULT_TIMEOUT
+    end
+
+    # main loop
+    def start
+      @device.grab
+      @device.release_all_key
+
+      @virtual.create VIRTUAL_DEVICE_NAME #, @device.device_id
+
+      @event_handler.load_config @config_file
+
+      @event_handler.bind_resolver.tree.each do |k,v|
+        puts "#{k} => #{v.inspect}"
+      end
+
+      trap :INT, method(:destroy)
+      trap :TERM, method(:destroy)
+
+      active_window = @window_observer.active_window
+      @event_handler.active_window_changed active_window if active_window
+
+      # start main loop
+      @started = true
+      while true
+        ios = select_ios
+        if ios.nil?
+          # select timeout
+          # no op
+          next
+        end
+
+        if LOG.debug?
+          LOG.debug ""
+          LOG.debug "select => #{ios.inspect}"
+        end
+
+        ios.each do |io|
+          case io
+          when @window_observer.connection then handle_x_event
+          when @device.file then handle_device_event
+          else LOG.error "unknown IO #{io.inspect}"
+          end
+        end
+      end
+    end
+
+    def select_ios
+      if @window_observer.pending_events_num != 0
+        [@window_observer.connection]
+      else
+        ios = select [@window_observer.connection, @device.file], nil, nil, @timeout
+        if ios.nil?
+          nil
+        else
+          ios.first
+        end
+      end
+    end
+
+    def handle_x_event
+      event = @window_observer.listen_with_no_select
+      return if event.nil? or event.window.nil?
+
+      @event_handler.active_window_changed event.window
+    end
+
+    def handle_device_event
+      event = @device.read_input_event
+
+      if event.type != Revdev::EV_KEY
+        @virtual.write_input_event event
+      else
+        @event_handler.handle event
+      end
+    end
+
+    def destroy *args
+      if not @started
+        LOG.error 'did not start to observe'
+        return
+      end
+
+      begin
+        LOG.info "try @device.ungrab"
+        @device.ungrab
+        LOG.info "=> success"
+      rescue => e
+        LOG.error e
+      end
+
+      begin
+        LOG.info "try @virtural.destroy"
+        @virtual.destroy
+        LOG.info "=> success"
+      rescue => e
+        LOG.error e
+      end
+
+      begin
+        LOG.info "try @window_observer.destory"
+        @window_observer.destroy
+        LOG.info "=> success"
+      rescue => e
+        LOG.error e
+      end
+
+      exit true
+    end
+
+  end # of class
+
+end # of module Rbindkeys

data/lib/rbindkeys/version.rb

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

data/lib/rbindkeys/virtual_device.rb

@@ -0,0 +1,14 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require "ruinput"
+
+module Rbindkeys
+
+  class VirtualDevice < Ruinput::UinputDevice
+
+    def release_all
+    end
+
+  end
+
+end

data/lib/rbindkeys/window_matcher.rb

@@ -0,0 +1,35 @@
+# -*- coding:utf-8; mode:ruby; -*-
+#
+# matcher for windows to use the app_class(app_name), title of the windows
+#
+
+module Rbindkeys
+  class WindowMatcher
+
+    attr_reader :app_name, :title
+
+    def initialize h
+      @app_name = (h[:class] or h[:app_name] or h[:app_class])
+      @title = (h[:title] or h[:name])
+
+      if not @app_name.nil? and not @title.nil?
+        raise ArgumentError, 'expect to be given :class, :app_name,'+
+          ' :app_class, :title or :name '
+      end
+    end
+
+    def match? app_name, title
+      (@app_name.nil? or match_app?(app_name)) and
+        (@title.nil? or match_title?(title))
+    end
+
+    def match_app? app_name
+      app_name and app_name.match @app_name
+    end
+
+    def match_title? title
+      title and title.match @title
+    end
+
+  end
+end

data/rbindkeys.gemspec

@@ -0,0 +1,26 @@
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require File.expand_path('../lib/rbindkeys/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Keiichiro Ui"]
+  gem.email         = ["keiichiro.ui@gmail.com"]
+  gem.description   = "key remap"
+  gem.summary       = "key remap"
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rbindkeys"
+  gem.require_paths = ["lib"]
+  gem.version       = Rbindkeys::VERSION
+
+  gem.add_dependency 'revdev'
+  gem.add_dependency 'ruinput'
+  gem.add_dependency 'active_window_x'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
+end

data/sample/emacs.rb

@@ -0,0 +1,100 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+## user settings
+
+# if you use a keyboard which have a left ctrl key at the left of "A" key,
+# then you must set false
+@swap_left_ctrl_with_caps = true
+
+# for apple keyboard
+@swap_left_opt_with_left_cmd = true
+
+##
+
+# pre_bind_key: pre-proccessed keybinding
+if @swap_left_ctrl_with_caps
+  pre_bind_key KEY_CAPSLOCK, KEY_LEFTCTRL
+  pre_bind_key KEY_LEFTCTRL, KEY_CAPSLOCK
+end
+
+if @swap_left_opt_with_left_cmd
+  pre_bind_key KEY_LEFTMETA, KEY_LEFTALT
+  pre_bind_key KEY_LEFTALT, KEY_LEFTMETA
+end
+
+# cursor move
+bind_key [KEY_LEFTCTRL, KEY_F], KEY_RIGHT
+bind_key [KEY_LEFTCTRL, KEY_B], KEY_LEFT
+bind_key [KEY_LEFTCTRL, KEY_P], KEY_UP
+bind_key [KEY_LEFTCTRL, KEY_N], KEY_DOWN
+bind_key [KEY_LEFTCTRL, KEY_A], KEY_HOME
+bind_key [KEY_LEFTCTRL, KEY_E], KEY_END
+
+# page scroll
+bind_key [KEY_LEFTCTRL, KEY_V], KEY_PAGEDOWN
+bind_key [KEY_LEFTALT, KEY_V], KEY_PAGEUP
+
+# edit
+bind_key [KEY_LEFTCTRL, KEY_D], KEY_DELETE
+bind_key [KEY_LEFTCTRL, KEY_H], KEY_BACKSPACE
+bind_key [KEY_LEFTCTRL, KEY_M], KEY_ENTER
+bind_key [KEY_LEFTCTRL, KEY_I], KEY_TAB
+bind_key [KEY_LEFTCTRL, KEY_LEFTBRACE], KEY_ESC
+
+# give a block sample
+@caps_led_state = 0
+bind_key KEY_CAPSLOCK do |event, operator|
+  @caps_led_state = @caps_led_state ^ 1
+  puts "########## CAPSLOCK LED #{@caps_led_state.zero? ? 'off' : 'on'} ##########"
+  operator.send_event EV_LED, LED_CAPSL, @caps_led_state
+end
+
+# cut, copy and paste
+bind_key [KEY_LEFTCTRL, KEY_W], [KEY_LEFTCTRL,KEY_X]
+bind_key [KEY_LEFTALT, KEY_W], [KEY_LEFTCTRL,KEY_C]
+bind_key [KEY_LEFTCTRL, KEY_Y], [KEY_LEFTCTRL,KEY_V]
+
+# kill line
+bind_key [KEY_LEFTCTRL, KEY_K] do |event, operator|
+  # Shift+End : select text to end of line
+  operator.press_key KEY_LEFTSHIFT
+  operator.press_key KEY_END
+  operator.release_key KEY_END
+  operator.release_key KEY_LEFTSHIFT
+
+  # Ctrl+x : cut
+  operator.press_key KEY_LEFTCTRL
+  operator.press_key KEY_X
+  operator.release_key KEY_X
+  operator.release_key KEY_LEFTCTRL
+end
+
+# 2 stroke key binds
+# if your input was not hit any bind_key, the input will be ignored
+bind_prefix_key [KEY_LEFTCTRL, KEY_X] do
+
+  # C-xk: close tab, etc.
+  bind_key KEY_K, [KEY_LEFTCTRL, KEY_W]
+
+  # C-xC-s: save
+  bind_key [KEY_LEFTCTRL, KEY_S], [KEY_LEFTCTRL, KEY_S]
+
+  # C-xb: next tab, etc.
+  bind_key KEY_B, [KEY_LEFTCTRL, KEY_TAB]
+
+  # C-xC-g: ignore C-x prefix bind
+  bind_key [KEY_LEFTCTRL, KEY_G], :ignore
+
+  # C-xC-c: close window
+  bind_key [KEY_LEFTCTRL, KEY_C], [KEY_LEFTALT, KEY_F4]
+end
+
+# settings per window class (or title)
+
+# through all key inputs if active
+window(:through, :class => /gnome-terminal/)
+
+# add new bind_key to default binds
+window(@default_bind_resolver, :class => /google-chrome/) do
+  bind_key [KEY_LEFTCTRL, KEY_S], [KEY_LEFTCTRL, KEY_F]
+end

data/sample/swap_left_ctrl_and_caps.rb

@@ -0,0 +1,4 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+pre_bind_key KEY_CAPSLOCK, KEY_LEFTCTRL
+pre_bind_key KEY_LEFTCTRL, KEY_CAPSLOCK

data/spec/bind_resolver_spec.rb

@@ -0,0 +1,101 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'rbindkeys'
+require 'revdev'
+
+include Rbindkeys
+
+describe BindResolver do
+  before do
+    @resolver = BindResolver.new :foo
+  end
+
+  describe "#bind" do
+    context "with two Fixnum Array" do
+      before do
+        @input = [0, 1]
+        @output = [2, 3]
+      end
+      it "should update @tree" do
+        @resolver.bind @input, @output
+        @resolver.bind [0,2], [2,3]
+        @resolver.tree[@input.last].first.input.should == @input
+        @resolver.tree[@input.last].first.output.should == @output
+      end
+    end
+    context "with a Fixnum Array and a BindResolver" do
+      before do
+        @input = [0, 1]
+        @output = BindResolver.new :bar
+      end
+      it "should update @tree" do
+        @resolver.bind @input, @output
+        @resolver.bind [0,2], [2,3]
+        @resolver.tree[@input.last].first.input.should == @input
+        @resolver.tree[@input.last].first.output.should == @output
+      end
+    end
+    context "with 2 BindResolver which is same as other one" do
+      before do
+        @input = [0, 1]
+        @output = BindResolver.new :bar
+      end
+      it "should update @tree" do
+        @resolver.bind @input, @output
+        lambda{@resolver.bind @input, [2,4]}.should raise_error(DuplicateNodeError)
+      end
+    end
+    context "with Fixnum Arrays" do
+      before do
+      end
+      it "should update @tree which store binds sort by modkey numbers" do
+        @resolver.bind [0,2], [0,3]
+        @resolver.bind [0,1,2], [1,3]
+        @resolver.bind [3,2], [2,3]
+
+        @resolver.tree[2][0].output.should == [1,3]
+        @resolver.tree[2][1].output.should == [0,3]
+        @resolver.tree[2][2].output.should == [2,3]
+      end
+    end
+  end
+
+  describe "#resolve" do
+    before do
+      @resolver2 = BindResolver.new(:ignore)
+      @resolver.bind [0, 1], [2, 3]
+      @resolver.bind [3, 1], [2, 4]
+      @resolver.bind [0, 2], [2, 5]
+      @resolver.bind [0, 1, 2], @resolver2
+    end
+    context "with an input which hit a bind" do
+      before do
+        @input = 1
+        @pressed_key_set = [0]
+      end
+      it "should return the bind" do
+        @resolver.resolve(@input, @pressed_key_set).kind_of?(KeyBind).should be_true
+        @resolver.resolve(@input, @pressed_key_set).output.should == [2, 3]
+      end
+    end
+    context "with an input which hit a BindResolver" do
+      before do
+        @input = 2
+        @pressed_key_set = [0,1]
+      end
+      it "should return the bind" do
+        @resolver.resolve(@input, @pressed_key_set).kind_of?(KeyBind).should be_true
+        @resolver.resolve(@input, @pressed_key_set).output.should == @resolver2
+      end
+    end
+    context "with an input which hit no binds" do
+      before do
+        @input = 2
+        @pressed_key_set = [1]
+      end
+      it "should return default value" do
+        @resolver.resolve(@input, @pressed_key_set).should == :foo
+      end
+    end
+  end
+end