xinput_wrapper 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd5d3382f535c9b0cc5fd6def2b5b7bad34237f9eb2e602fef6c9ed21d59e107
-  data.tar.gz: fe866a13173f38b75027676b7583470c6d350527f1d1fd0eccd978d135fb8e93
+  metadata.gz: 8bff9abfb50413d2ef185c472020cd348c53da5512b1f12d92ffbce10b491d2c
+  data.tar.gz: 4066ac4f9896ee680bff3a583bc1caf855c5bb17a43e40ff80aeaa4a9c01f263
 SHA512:
-  metadata.gz: 4cfc590d0eab22723afe694344a339cf24b7d08989f73c270a6106320806db47442c23607b3f8afd2b1fa63d8a7f79f48fde3c86c4fc6e32cbee60beb06dc4ff
-  data.tar.gz: 767186f2fde2a191249cea820d6eb6887d32691917b4fe48954be4f3034c56923b5a26a52fe64bb3cc79eeaf30bbeeeaa725d3b88e2bad65fbe57d290633ab22
+  metadata.gz: b8cd2b9b6c92418ed1d517d5f201b7e34e8ac7146ba8857d17b94638f4dd05eb626d8c75b1bd7afcc31ca475e7935302db2cb4015a75049a02fc843f3f278a9f
+  data.tar.gz: ce4b85f5cab6c0f613d0530c630ce227e15df0432e018b1aae15071484e7c72ef79708a21a771db7f5d50d2770aff051b4778f1d9ea9f4edfabdc4b927431459

data/lib/xinput_wrapper.rb

@@ -2,14 +2,44 @@
 
 # file: xinput_wrapper.rb
 
+# Captures keyboard or mouse events using program xinput.
+
+
+# note: To display a list of xinput devices, run the 
+#       xinput program without any options.
+
 require 'c32'
 
 
+MOTION = 6
+RAWKEY_PRESS = 13
+RAWKEY_RELEASE = 14
+RAWBUTTON_PRESS = 15
+RAWBUTTON_RELEASE = 16
+BUTTONS = %i(left middle right scrollup scrolldown)
+
+
 class XInputWrapper
   using ColouredText
+  
+  attr_accessor :stop
 
-  def initialize(device: '3', verbose: true, lookup: {}, debug: false )
+  # device list:
+  #       3 = Virtual core keyboard
+  #       4 = Virtual core XTEST pointer (active when using VNC)
+  #       5 = Virtual core XTEST keyboard (active when using VNC)
+  #       10 = USB Optical Mouse (locally attached)
+  #       11 = Microsoft Wired Keyboard 600 (locally attached)
+  #
+  
+  # keys - add the keys you want to be captured. If empty then 
+  #        all keys are captured.
+  
+  def initialize(device: nil, verbose: true, lookup: {}, debug: false, 
+                 callback: nil, keys: [] )
 
+    @callback, @keys = callback, keys
+    
     # defaults to QWERTY keyboard layout
     @modifiers = {
       62 => :shift,     # right control
@@ -29,7 +59,7 @@ class XInputWrapper
       40=>:d, 41=>:f, 42=>:g, 43=>:h, 44=>:j, 45=>:k, 46=>:l, 47=>:";", 
       48=>:"'", 49=>nil, 52=>:z, 53=>:x, 54=>:c, 55=>:v, 56=>:b, 57=>:n, 
       58=>:m, 59=>:",", 60=>:".", 61=>:/,  65=>:space,
-      9 => :escape,
+      9 => :esc,
       66 => :capslock,
       67 => :f1,
       68 => :f2,
@@ -42,18 +72,18 @@ class XInputWrapper
       75 => :f9,
       76 => :f10,
       77 => :numlock,
-      78 => :scroll_lock,
+      78 => :scrolllock,
       95 => :f11,
       96 => :f12,
-      107 => :print_screen,
+      107 => :sysrq, # print_screen
       110 => :home,
-      111 => :up_arrow,
-      112 => :pgup,
-      113 => :left_arrow,
-      114 => :right_arrow,
-      115 => :end,
-      116 => :down_arrow,
-      117 => :pgdown,
+      111 => :up, # arrow keys
+      112 => :pageup,
+      113 => :left, # arrow keys
+      114 => :right, # arrow keys
+      115 => :end, 
+      116 => :down, # arrow keys
+      117 => :pagedown,
       121 => :mute,
       122 => :vol_down,
       123 => :vol_up,
@@ -74,31 +104,111 @@ class XInputWrapper
     }.merge(@modifiers).merge(lookup)
     
     @device, @verbose, @debug = device, verbose, debug
+    @mouse_pos = [0, 0]
     
   end
 
   def listen()
-
+    
+    @stop = false
+    
     command = "xinput test-xi2 --root #{@device}"
 
     type = 0
     raw_keys = []
+    t1 = Time.now
+    lines = []    
 
     IO.popen(command).each_line do |x|
  
+      break if @stop
       #print "GOT ", x
-      raw_type = x[/EVENT type (\d+)/,1]
+      if x[/EVENT type \d \(Motion\)/] and (Time.now > (t1 + 0.06125)) then 
 
-      type = raw_type.to_i unless raw_type.nil?
-      next unless type == 13 or type == 14
+        type = x[/EVENT type (\d+)/,1].to_i
     
-      keycode = x[/detail: (\d+)/,1].to_i
-      next if keycode == 0
+        r = lines.join[/^\s+root: (\d+\.\d{2}\/\d+\.\d{2})/,1]
+
+        if r then
+      
+          x1, y1 = r.split('/').map(&:to_f) 
+          puts "x1: %s y1: %s" % [x1, y1] if @debug
+          on_mousemove(x1, y1)
+          @callback.on_mousemove(x1, y1) if @callback
+          @mouse_pos = [x1,y1]
+          t1 = Time.now  
+    
+        end        
+
+        lines = [x]                                                                
+
+      elsif x[/EVENT type \d+ \(Raw(?:Key|Button)(?:Release|Press)\)/]
+
+        type = x[/EVENT type (\d+)/,1].to_i
+
+        lines = [x]
+    
+
+      elsif [MOTION, RAWKEY_PRESS, RAWKEY_RELEASE, RAWBUTTON_PRESS, 
+             RAWBUTTON_RELEASE].include? type
+
+        lines << x
+    
+        if x == "\n" then
+          case lines.first[/(?<=EVENT type )\d+/].to_i
+          when RAWKEY_PRESS
+      
+            r = lines.join[/detail: (\d+)/,1]
+
+            keycode = r.to_i if r
+
+            type = lines.join[/EVENT type (\d+)/,1] .to_i
+      
+          when RAWKEY_RELEASE
+      
+            r = lines.join[/detail: (\d+)/,1]
+
+            keycode = r.to_i if r
+
+            type = lines.join[/EVENT type (\d+)/,1] .to_i          
+    
+
+          when RAWBUTTON_PRESS
+      
+            r = lines.join[/detail: (\d+)/,1]
+
+            buttoncode = r.to_i if r
+
+            type = lines.join[/EVENT type (\d+)/,1] .to_i
+      
+          when RAWBUTTON_RELEASE
+      
+            r = lines.join[/detail: (\d+)/,1]
+
+            buttoncode = r.to_i if r
+
+            type = lines.join[/EVENT type (\d+)/,1] .to_i       
+      
+          end    
+
+    
+        else
+            next
+        end
+    
+      else
+        next
+      end
+    
+      next unless keycode or buttoncode
+      puts 'keycode: ' + keycode.inspect if @debug
+      puts 'buttoncode: ' + buttoncode.inspect if @debug
           
       # type = 13 means a key has been pressed
-      if type == 13 then
+      if type == RAWKEY_PRESS then
     
-        if @modifiers.include? raw_keys.last or @modifiers.include? keycode then
+        if @modifiers.include? raw_keys.last or \
+            @modifiers.include? keycode then
           raw_keys << keycode
         end
     
@@ -120,10 +230,29 @@ class XInputWrapper
     
             puts key.to_s + ' key presssed' if @verbose
             name = "on_#{key}_key".to_sym
-            method(name).call if self.protected_methods.include? name
+            puts 'name: ' + name.inspect if @debug
+    
+            if private_methods.include? name and (@keys.empty? or \
+                                              @keys.include? key.to_sym) then
+              puts 'before method' if @debug
+              method(name).call 
+            end
             
             keystring = ((key.length > 1 or key == ' ') ? "{%s}" % key : key)    
-            block_given? ? yield(keystring) : on_key_press(keystring, keycode)
+    
+            if block_given? then
+    
+              yield(keystring)
+    
+            else
+
+              if @keys.empty? or @keys.include? key.to_sym then
+                on_key_press(keystring, keycode)
+              end    
+    
+            end
+    
+            @callback.on_keypress(keystring, keycode) if @callback
 
           end        
     
@@ -135,8 +264,13 @@ class XInputWrapper
           if block_given? then
             yield(format_key(keys.last, keys[0..-2]))
           else
-            on_key_press(keys.last, keycode, keys[0..-2])    
+    
+            if @keys.empty? or (!@keys.empty? and \
+                                @keys.include? keys.last) then
+              on_key_press(keys.last, keycode, keys[0..-2])                
+            end
           end
+          @callback.on_keypress(keys.last, keycode, keys[0..-2])  if @callback
     
           raw_keys = []
 
@@ -145,7 +279,7 @@ class XInputWrapper
 
 
       # a key has been released
-      elsif type == 14
+      elsif type == RAWKEY_RELEASE
     
         # here we are only looking to detect a 
         # single modifier key press and release
@@ -160,51 +294,122 @@ class XInputWrapper
             yield(format_key(key.to_s))
     
           else
-            name = "on_#{key}_key".to_sym
-            method(name).call if self.protected_methods.include? name
+            name = "on_#{key.to_s}_key".to_sym
+            puts 'calling method' if @debug
+    
+            if private_methods.include? name and (@keys.empty? or \
+                                              @keys.include? key.to_sym) then
+              method(name).call #if self.methods.include? name
+            end
+    
             on_key_press(key, keycode)
+            @callback.on_keypress(key, keycode) if @callback
           end
         end
     
         index = raw_keys.rindex(keycode)
         raw_keys.delete_at index if index
-
+    
+      elsif type == RAWBUTTON_PRESS
+    
+        button = BUTTONS[buttoncode-1]
+    
+        case button
+        when :scrollup
+          on_mouse_scrollup() 
+          @callback.on_mouse_scrollup() if @callback
+        when :scrolldown
+          on_mouse_scrolldown()
+          @callback.on_mouse_scrolldown() if @callback
+        else
+          on_mousedown(button, *@mouse_pos) 
+          @callback.on_mousedown(button, *@mouse_pos) if @callback
+        end
+    
+      elsif type == RAWBUTTON_RELEASE
+    
+        button = BUTTONS[buttoncode-1]
+        on_mouseup(BUTTONS[buttoncode-1], *@mouse_pos)
+    
       end    
     
     end
   end
   
-  protected
+  private
+    
+  def message(s)
+    puts 'msg: ' + s
+  end
   
-  def on_control_key()
-    puts 'ctrl key pressed'
+  def on_ctrl_key()
+    message 'ctrl key pressed'
   end  
     
-  def on_key_press(key, keycode, modifier)
+  def on_key_press(key, keycode, modifier=nil)
     
     if @debug then
       puts ('key: ' + key.inspect).debug
     end
     
   end
+    
+  def on_mousedown(button, x,y)
+    
+    if @debug then
+      puts "on_mousedown() %s click x: %s y: %s" % [button, x, y]
+    end
+    
+  end    
+    
+  def on_mousemove(x,y)
+    
+    if @debug then
+      puts "on_mousemove() x: %s y: %s" % [x, y]
+    end
+    
+  end
+    
+  def on_mouseup(button, x,y)
+    
+    if @debug then
+      puts "on_mousedown() %s click x: %s y: %s" % [button, x, y]
+    end
+    
+  end        
+    
+  def on_mouse_scrolldown()
+    
+    if @debug then
+      puts "on_mouse_scrolldown()"
+    end
+    
+  end       
+    
+  def on_mouse_scrollup()
+    
+    if @debug then
+      puts "on_mouse_scrollup()"
+    end
+    
+  end           
+
   
   def on_shift_key()  end
   def on_super_key()  end
   
-  def on_f1_key()   end
-  def on_f2_key()   end
-  def on_f3_key()   end
-  def on_f4_key()   end
-  def on_f5_key()   end
-  def on_f6_key()   end    
-  def on_f7_key()   end
-  def on_f8_key()   end
-  def on_f9_key()   end
-  def on_f10_key()  end
-  def on_f11_key()  end
-  def on_f12_key()  end    
-  
-  private
+  def on_f1_key()  message 'f1'  end    
+  def on_f2_key()  message 'f2'  end
+  def on_f3_key()  message 'f3'  end
+  def on_f4_key()  message 'f4'  end
+  def on_f5_key()  message 'f5'  end
+  def on_f6_key()  message 'f6'  end    
+  def on_f7_key()  message 'f7'  end
+  def on_f8_key()  message 'f8'  end
+  def on_f9_key()  message 'f9'  end
+  def on_f10_key() message 'f10' end
+  def on_f11_key() message 'f11' end
+  def on_f12_key() message 'f12' end        
     
   def format_key(key, modifier=[])
     
@@ -213,6 +418,7 @@ class XInputWrapper
     
   end
     
+  def on_alt_key()  message 'alt'  end  
   def on_leftcontrol_key()  on_control_key()  end
   def on_rightcontrol_key() on_control_key()  end     
   def on_left_alt_key()     on_alt_key()      end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xinput_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - James Robertson
@@ -11,52 +11,52 @@ cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
   MIIEXjCCAsagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFnZW1t
-  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMTkwMjEwMTU1NTM1WhcN
-  MjAwMjEwMTU1NTM1WjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
-  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQD2pELS
-  hfHN+He5s77qpnUO4j6GDr1B9PDIKqJDBz+kJCUGXsLzyHnKK8iIblXtETyIJn9F
-  euzS6ohPh64xfBcKrnF7bSUAXsdC/PZIsNgvSp4Vuguxpe6wDHfaqBhV2KcOjGrP
-  tnZRvJJHWBczBzMw+BAj0d5Zp5QZaVXDx3mN13t2j6tUncwLF3NYIlaFA7lN4uuV
-  hiFyqlkk+ELO8eptDF5Wkel5ZjtALo9jOq04KAlImZ7cnFLD1zbAXWiKPyEvSAeL
-  fGONgtYGEBwIKKeisGTucndYa1iwQOnFLjCixclGH+6+YInlbHUzl/JrFHSEXIYb
-  0jU2pHEu+xQlB2xdKiJF6Z/JWWabJ+hyMifxnyPYLW53QGV5fu2uAHDVUCplwhBW
-  hOBeqmV8SCjX7aYytN7TiqO4Th2kP2tPLQqynFQ3ceNiTcjk1fkliXlv+lc8IFiS
-  25oy9Th0M3O7+rs11i1eeaAlvrZ0TWv5qFpJUrMB53UpndLxeroiPw/AzocCAwEA
-  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUQLWJJ/fU
-  p6suCssS39/w2O9MQhUwJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
+  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMjAwODAzMjEwMTE2WhcN
+  MjEwODAzMjEwMTE2WjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
+  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDdnN5k
+  jxSdi5vMTqhRRJ8yFAV3MYUs/W6NU+rMUk1uqTC/J+fFox8tg7t4VzQoQq539Onk
+  5iPFJhwo3jAYKIyc+LX4e3CtQMdrheyY/XkaTSu1yPR+c4lT8nhKUf4gI28hNXcx
+  lNekrvzzXBVZMGs5F+gKzOYUFS+i0jGPaVaison+iaGVLcjc2/t3AGIQeOHo7QYv
+  6Sswkj9Er4jkwJKHGAvLvh+KTcm/aImIfV4v5FUm6xJMi42lsDWbaRyACtAtNgKF
+  cl/pMlb3d5Si3vIcbKlktHR2K5KLtBuFqu/vWdlKygYzpnr3rWjAls8wr2fv6WiS
+  BqX3XVtZB4Fh/xriLY3Fj3Qo9RWuGf9S3BIGGxcnsr53bsO1zKXvbNr5UzP9d0+8
+  dF5lJ4bu8rw524nYypy39Is9PlHI7L6nxQjy82AmzloxEc31nYM7FF2pjkStv5H5
+  zfb4PVsCblnUstufNJWKrg32E2wbzXhzq8+E/U7Y7FM4zABWcyeHtt4Mv0MCAwEA
+  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU+hzRpZTx
+  g/xK+Tn1+5WHz7CK1y8wJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
   c29uLmV1MCYGA1UdEgQfMB2BG2dlbW1hc3RlckBqYW1lc3JvYmVydHNvbi5ldTAN
-  BgkqhkiG9w0BAQsFAAOCAYEAAuFxNNh+nIt4Ba3bWUilYAVhEYROr32uTWFmyL8w
-  T4bMAe8OC9PzuIAg3C4jzks008Fbfi7Hcm4Pqc548kbavWtLquzdNwNqasywcweb
-  FIIGeYpRy2BmHeP8+RK66T+HfdAGGmy60L/q5kTJtV1g9wDTg5glxv7OvlShgKTM
-  ZgaJi9JerKv6dsB6r1OnnVy73BfQ0eiN2/vwDHCB9Op2E5JKFqUlklGaKvbEsMoV
-  Ou4ilgqq7OROhrul809YLlc0VHRfAiaOqeO5l1Ccfq9Q2LUZwGhtw+EIKSrgWQZA
-  1aSaQX/s+LpAVRGJlWrVa+uQ21aUdItSdkKaRNK4MxQHPu8s/9sgeZRMEO5wJc7i
-  bvgBqmvgsZwFmSRWE1K/PusL86uaYCw5pTWA+BquQ7taMwhGKqdDlHLp+SQ1Wd82
-  rryowfoo6nLmegcIZjm+zz/gkT/0udwMMVm2gwo0bIRQuQOLmd7IUNzYQKZQOGMA
-  g4ETbI8IEC3VCaoECdunsS3t
+  BgkqhkiG9w0BAQsFAAOCAYEAXg+9mfaTHPcbez7P0XnwGL0C4zdPwHtBUXioPwjP
+  okklRkFzMQnxArm8U9557g8cXY//vKp/cFBdCExE8lLxAOB9gHswJju0g99Yx7gY
+  iEV3TWv5qkLQ+n8zdTd8TxEyjWB6ZXOJcE+/cTq9Ly1j4bhf9QTdul02TBukEp6d
+  opP5/Yvt1GX0ED98olew/pm+KoKKNkcJzSgEH44O+pCfTi4h2STOFRvXVYaB3AH8
+  hpuUFcbxzPhBxOChGPAGZLaf7zurw8B2Q1vP75RV9gJ1M6NKU6Hlb6vMJQ3jz8qv
+  GIVFoKMCcJH2EImrG47doRVhQPIlxfz7d3f+FdYgnp7wtuFi/byklu1D2G8ZE8Ax
+  1s9Njv/guBMNkw+RV6IlpMtT0yeVvHeYTt0tPKeyrtBrSfsexA3393T7To6Ms+1s
+  B//EUqLB2VKtMmcrYMc2FfbLwllNLY4TRq+/lgVLoDb7oLHsiggYSLZS6lPBIQj/
+  YnYsDKwN5siDA79sB0fqq2ml
   -----END CERTIFICATE-----
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: c32
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: 
 email: james@jamesrobertson.eu
 executables: []
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A wrapper for the Linux utility xinput.