revdev 0.1.0

data/lib/revdev.rb

@@ -0,0 +1,44 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require "revdev/revdev.so"
+
+require "revdev/each_values_equal"
+
+require "revdev/version"
+require "revdev/event_device"
+require "revdev/input_event"
+require "revdev/input_id"
+
+# just import linux/input.h
+module Revdev
+  class EventDevice; end
+  class InputEvent; end
+  class InputId; end
+
+  PREFIX_CONVERTER = {
+    'BTN'	=> 'KEY',
+    'MT'	=> nil, # TODO how to use MT prefix values
+    'ID'	=> nil, # TODO how to use ID prefix values
+    'BUS'	=> nil  # TODO how to use BUS prefix values
+  }
+
+  REVERSE_MAPS = Hash.new
+  constants.each do |const|
+    m = const.to_s.match(/^(FF_STATUS|[A-Z]{2,4})_/)
+    next if m.nil?
+
+    prefix = m[1]
+    if prefix == 'EV'
+      REVERSE_MAPS[:EV] ||= Hash.new
+      REVERSE_MAPS[:EV][const_get const] = const.to_sym
+      next
+    end
+    prefix = PREFIX_CONVERTER[prefix] if PREFIX_CONVERTER.has_key? prefix
+    next if prefix.nil?
+
+    ev = "EV_#{prefix}".to_sym
+    REVERSE_MAPS[ev] ||= Hash.new
+    REVERSE_MAPS[ev][const_get const] = const.to_sym
+  end
+
+end

data/lib/revdev/each_values_equal.rb

@@ -0,0 +1,12 @@
+
+# -*- coding:utf-8; mode:ruby; -*-
+
+module Revdev
+  module EachValuesEqual
+    def == obj
+      obj.instance_variables.delete_if do |name|
+        obj.instance_variable_get(name) == instance_variable_get(name)
+      end.empty?
+    end
+  end
+end

data/lib/revdev/event_device.rb

@@ -0,0 +1,81 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+module Revdev
+  class EventDevice
+
+    def initialize arg
+      if arg.kind_of? File
+        @file = arg
+      else
+        @file = File.new arg, 'r+'
+      end
+    end
+
+    def read_ioctl_with command
+      r = ""
+      @file.ioctl command, r
+      return r
+    end
+
+    def driver_version
+      r = read_ioctl_with EVIOCGVERSION
+      r.unpack('i').first
+    end
+
+    def read_ioctl_as_string_with command
+      r = read_ioctl_with command
+      r.unpack('Z*').first
+    end
+
+    def device_name
+      read_ioctl_as_string_with EVIOCGNAME
+    end
+
+    def physical_location
+      read_ioctl_as_string_with EVIOCGPHYS
+    end
+
+    def uniq_id
+      read_ioctl_as_string_with EVIOCGUNIQ
+    end
+
+    def device_prop
+      read_ioctl_as_string_with EVIOCGPROP
+    end
+
+    def global_key_state
+      read_ioctl_as_string_with EVIOCGKEY
+    end
+
+    def all_leds_status
+      read_ioctl_as_string_with EVIOCGLED
+    end
+
+    def all_sounds_status
+      read_ioctl_as_string_with EVIOCGSND
+    end
+
+    def all_switch_status
+      read_ioctl_as_string_with EVIOCGSW
+    end
+
+    # grab all input events of the event device
+    def grab
+      @file.ioctl EVIOCGRAB, 1
+    end
+
+    # release the grabbed event device
+    def ungrab
+      @file.ioctl EVIOCGRAB, 0
+    end
+
+    def read_input_event
+      InputEvent.new @file.read InputEvent::SIZEOF
+    end
+
+    def write_input_event ie
+      @file.syswrite ie.to_byte_string
+    end
+
+  end
+end

data/lib/revdev/input_event.rb

@@ -0,0 +1,48 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+module Revdev
+
+  # wraper of "struct input_event" on "input.h"
+  class InputEvent
+    include EachValuesEqual
+    attr_accessor :time, :type, :code, :value
+
+    # arg: String(byte string), Hash, Time
+    # type, code, value: Integer (ignored values if arg is String or Hash)
+    def initialize arg=nil, type = nil, code = nil, value = nil
+      if arg.kind_of? String
+        raw_initialize arg
+      elsif arg.kind_of? Hash
+        [:time, :type, :code, :value].each do |iv|
+          instance_variable_set("@#{iv}", arg[iv] || arg[iv.to_s])
+        end
+        @time ||= Time.now
+      else
+        @time = arg || Time.now
+        @type = type
+        @code = code
+        @value = value
+      end
+    end
+
+    # human readable @type of input event
+    def hr_type
+      REVERSE_MAPS[:EV][@type]
+    end
+
+    # human readable @code of input event
+    def hr_code
+      ht = hr_type
+      return nil if ht.nil?
+      map = REVERSE_MAPS[ht]
+      map && map[@code]
+    end
+
+    # human readable @code of input event
+    # not implement
+    def hr_value
+      nil
+    end
+
+  end
+end

data/lib/revdev/input_id.rb

@@ -0,0 +1,27 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+module Revdev
+
+  # wraper of "struct input_id" on "input.h"
+  class InputId
+    include Revdev::EachValuesEqual
+    attr_accessor :bustype, :vendor, :product, :version
+
+    def initialize(arg=nil, vendor=nil, product=nil, version=nil)
+      if arg.kind_of? String
+        raw_initialize arg
+      elsif arg.kind_of? Hash
+        [:bustype, :vendor, :product, :version].each do |iv|
+          instance_variable_set("@#{iv}", arg[iv] || arg[iv.to_s])
+        end
+      else
+        @bustype = arg
+        @vendor = vendor
+        @product = product
+        @version = version
+      end
+    end
+
+  end
+
+end

data/lib/revdev/version.rb

@@ -0,0 +1,3 @@
+module Revdev
+  VERSION = "0.1.0"
+end

data/revdev.gemspec

@@ -0,0 +1,21 @@
+# -*- coding:utf-8-unix; mode:ruby; -*-
+require File.expand_path('../lib/revdev/version', __FILE__)
+
+Gem::Specification.new do |g|
+  g.name	= "revdev"
+  g.version	= Revdev::VERSION
+  g.authors	= ["Keiichiro Ui"]
+  g.email	= ["keiichiro.ui@gmail.com"]
+  g.summary	= "ruby binding to handling event devices."
+  g.description	= "revdev is a ruby binding to handling event devices."
+  g.homepage	= "https://rubygems.org/gems/revdev"
+  g.files	= `git ls-files`.split($\)
+  # g.files	= Dir.glob 'lib/**/*.rb'
+  # g.files	+= Dir.glob 'ext/**/*.{rb,c,h}'
+  g.executables	= g.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  g.test_files	= g.files.grep(%r{^(test|spec|features)/})
+  g.require_paths	= ["lib"]
+  g.extensions	= Dir.glob 'ext/**/extconf.rb'
+  g.add_development_dependency 'rake'
+  g.add_development_dependency 'bundler'
+end

data/test/test_event_device.rb

@@ -0,0 +1,95 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'test/unit'
+require 'revdev'
+
+class EventDeviceTest < Test::Unit::TestCase
+  include Revdev
+
+  @@target = "test/tmp/file"
+
+  def initialize *args
+    super
+
+    @@target = File.expand_path @@target
+    dir = File.dirname @@target
+    if not File.directory? dir
+      Dir.mkdir dir
+    end
+    FileUtils.touch @@target
+
+  end
+
+  def test_consts
+    puts "## InputEvent Constants"
+    puts "# of consts: #{Revdev.constants.length}"
+    puts "# of REVERSE_MAP entries: #{Revdev::REVERSE_MAPS.size}"
+    puts "each # of REVERSE_MAP entries"
+    REVERSE_MAPS.each do |k,v|
+      puts "%15s => %4s" % [k.inspect,v.size]
+    end
+  end
+
+  def test_init
+    assert_nothing_raised do
+      EventDevice.new File.new @@target
+      EventDevice.new @@target
+    end
+  end
+
+  def test_ioctl_string_getters
+    return_data = "abc\000\234\90\444"
+    expected_data = "abc"
+    file = File.new @@target
+    $data = return_data
+
+    def file.ioctl command, data
+      if command.kind_of? Numeric
+        data << $data
+      else
+        raise "invalid command:#{command.class}"
+      end
+    end
+
+    [:device_name, :physical_location, :uniq_id, :device_prop, :global_key_state,
+    :all_leds_status, :all_sounds_status, :all_switch_status].each do |m|
+      evdev = EventDevice.new file
+      assert_equal expected_data, evdev.method(m).call
+    end
+  end
+
+  def test_read_input_event
+    file = File.new @@target
+    ie = InputEvent.new nil, 1, 2, 3
+    $data = ie.to_byte_string
+    $self = self
+
+    def file.read len
+      $self.assert_equal $data.length, len
+      $data
+    end
+
+    evdev = EventDevice.new file
+    assert_nothing_raised do
+      iee = evdev.read_input_event
+      assert_equal ie, iee
+    end
+  end
+
+  def test_write_key_input_event
+    file = File.new @@target
+    ie = InputEvent.new nil, 1, 2, 3
+    $data = ie.to_byte_string
+    $self = self
+
+    def file.syswrite data
+      $self.assert_equal $data, data
+    end
+
+    evdev = EventDevice.new file
+    assert_nothing_raised do
+      evdev.write_input_event ie
+    end
+  end
+
+end

data/test/test_input_event.rb

@@ -0,0 +1,60 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'test/unit'
+require 'revdev'
+
+class InputEventTest < Test::Unit::TestCase
+  include Revdev
+
+  U16_MAX = 2**16 - 1
+  S32_MAX = 2**31 - 1
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_init
+    puts
+    ie = iee = ieee = nil
+    assert_nothing_raised do
+      t = Time.now
+      ie =  InputEvent.new t, 1, 3, S32_MAX
+      p ie
+      iee = InputEvent.new :time => t,:type => 1, :code => 3, :value => S32_MAX
+      p iee
+      ieee = InputEvent.new ie.to_byte_string
+      p ieee
+    end
+    assert_equal ie, iee
+    assert_equal ie, ieee
+  end
+
+  def test_hr_blar
+    htype = :EV_KEY
+    type = self.class.const_get htype
+    hcode = :KEY_2
+    code = self.class.const_get hcode
+    value = 0
+
+    ie = InputEvent.new nil, type, code, value
+
+    assert_nothing_raised do
+      assert_equal htype, ie.hr_type
+      assert_equal hcode, ie.hr_code
+      assert_equal nil, ie.hr_value
+    end
+  end
+
+  def test_to_byte_string
+    t = Time.now
+    ie =  InputEvent.new t, 1, 3, 0
+    iee = nil
+    assert_nothing_raised do
+      iee = InputEvent.new ie.to_byte_string
+    end
+    assert_equal ie, iee
+  end
+
+end

data/test/test_input_id.rb

@@ -0,0 +1,34 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'test/unit'
+require 'revdev'
+
+class InputIdTest < Test::Unit::TestCase
+  include Revdev
+
+  U16_MAX = 2**16 - 1
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_init
+    puts
+
+    i = ii = iii = nil
+    assert_nothing_raised do
+      i = InputId.new 1, 2, 3, U16_MAX
+      p i
+      ii = InputId.new :bustype => 1, :vendor => 2, :product => 3, :version => U16_MAX
+      p ii
+      iii = InputId.new i.to_byte_string
+      p iii
+    end
+
+    assert_equal i, ii
+    assert_equal i, iii
+  end
+
+end

data/test/test_revdev.rb

@@ -0,0 +1,148 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'test/unit'
+require 'revdev'
+
+class RevdevTest # < Test::Unit::TestCase
+
+  # DEVICE_FILE = "/dev/input/event0"
+  DEVICE_FILE = "/dev/input/event1"
+  # DEVICE_FILE = "/dev/input/event2"
+  # DEVICE_FILE = "/dev/input/event3"
+  # DEVICE_FILE = "/dev/input/event4"
+  # DEVICE_FILE = "/dev/input/event5"
+  DEVICE_NAME = "AT Translated Set 2 keyboard"
+
+  def initialize test_method_name
+    super
+  end
+
+  def setup
+    @evdev = Revdev::EventDevice.new DEVICE_FILE
+  end
+
+  def teardown
+  end
+
+  def test_driver_version
+    r = @evdev.driver_version
+    puts "\tdriver_version:\t"+r.to_s
+  end
+
+  def test_device_name
+    r = @evdev.device_name
+    puts "\tdevice_name:\t"+r
+    assert_equal String, r.class
+    assert_not_equal 0, r.length
+  end
+
+  def test_physical_location
+    begin
+      r = @evdev.physical_location
+      puts "\tphysical_location:\t"+r
+      assert_equal String, r.class
+    rescue Errno::ENOENT
+      # no assertion
+    end
+  end
+
+  def test_uniq_id
+    begin
+      r = @evdev.uniq_id
+      puts "\tuniq_id:\t"+r
+      assert_equal String, r.class
+    rescue Errno::ENOENT
+      # no assertion
+    end
+  end
+
+  def test_device_prop
+    begin
+      r = @evdev.device_prop
+      puts "\tdevice_prop:\t"+r
+      assert_equal String, r.class
+    rescue Errno::ENOENT
+      # no assertion
+    end
+  end
+
+  def test_global_key_state
+    begin
+      r = @evdev.global_key_state
+      puts "\tglobal_key_state:\t"+r
+      assert_equal String, r.class
+    rescue Errno::ENOENT
+      # no assertion
+    end
+  end
+
+  def test_all_leds_status
+    begin
+      r = @evdev.all_leds_status
+      puts "\tall_leds_status:\t"+r
+      assert_equal String, r.class
+    rescue Errno::ENOENT
+      # no assertion
+    end
+  end
+
+  def test_all_sounds_status
+    begin
+      r = @evdev.all_sounds_status
+      puts "\tall_sounds_status:\t"+r
+      assert_equal String, r.class
+    rescue Errno::ENOENT
+      # no assertion
+    end
+  end
+
+  def test_all_switch_status
+    begin
+      r = @evdev.all_switch_status
+      puts "\tall_switch_status:\t"+r
+    rescue Errno::ENOENT
+      # no assertion
+    end
+  end
+
+  def test#_read_input_event
+    Dir.glob("/dev/input/event{2,3,4}").each do |file|
+      evdev = Revdev::EventDevice.new file
+      puts "listening #{evdev.device_name} ..."
+      ie = evdev.read_input_event
+      assert_equal Time, ie.time.class
+      assert_equal Fixnum, ie.type.class
+      assert_equal Fixnum, ie.code.class
+      assert_equal Fixnum, ie.value.class
+      p ie
+      puts "hr_type:	#{ie.hr_type.inspect}"
+      puts "hr_code:	#{ie.hr_code.inspect}"
+      puts "hr_val:	#{ie.hr_value.inspect}"
+    end
+  end
+
+  def test_write_key_input_event
+    evdev = Revdev::EventDevice.new "/dev/input/event2"
+    puts "writing 'abc' to #{evdev.device_name} ..."
+
+    type_key = Revdev::InputEvent::EV_KEY
+    type_syn = Revdev::InputEvent::EV_SYN
+    code_a = Revdev::InputEvent::KEY_A
+    code_report = Revdev::InputEvent::SYN_REPORT
+    value_press = 1
+    value_release = 0
+    [Revdev::InputEvent.new(nil, type_key, code_a, value_press),
+     Revdev::InputEvent.new(nil, type_key, code_a, value_release),
+     Revdev::InputEvent.new(nil, type_key, code_a, value_press),
+     Revdev::InputEvent.new(nil, type_key, code_a, value_release),
+     Revdev::InputEvent.new(nil, type_syn, code_report, 0)
+    ].each do |ie|
+      p ie
+      evdev.write_input_event ie
+    end
+  end
+
+  def test_constants
+    puts "Revdev::InputEvent::SIZEOF	: #{Revdev::InputEvent::SIZEOF}"
+  end
+end