mousetools 0.1.1 → 1.0.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+Version 0.1.0: Initial release
+Version 0.1.1: Resolved some CGEvent related issues
+Version 1.0.0: Moved CGEvent related-stuff into a separate module, added support for modifier keys (defined as :CGEventFlags in cgevents.rb), key_down, key_up methods work much better now.

data/lib/cgevent.rb

@@ -0,0 +1,136 @@
+require 'ffi'
+
+module CGEvent
+  extend FFI::Library
+  ffi_lib '/System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/CoreGraphics.framework/Versions/A/CoreGraphics'
+  
+  class CGPoint < FFI::Struct
+    layout :x, :double,
+           :y, :double
+  end
+  
+  # Mouse/Keyboard events
+  enum :CGEventType, [ :kCGEventNull,               0,		# Null Event 
+                       :kCGEventLeftMouseDown,      1,		# left mouse-down event
+                       :kCGEventLeftMouseUp,        2,		# left mouse-up event
+                       :kCGEventRightMouseDown,     3,		# right mouse-down event
+                       :kCGEventRightMouseUp,       4,		# right mouse-up event
+                       :kCGEventMouseMoved,         5,		# mouse-moved event
+                       :kCGEventLeftMouseDragged,   6,    # left mouse-dragged event
+                       :kCGEventRightMouseDragged,  7,    # right mouse-dragged event
+                       :kCGEventScrollWheel,        22,   # mouse scrolled event
+                       :kCGEventOtherMouseDown,     25,   # other mouse-down event
+                       :kCGEventOtherMouseUp,       26,   # other mouse-up event
+                       :kCGEventOtherMouseDragged,  27,   # other mouse-dragged event
+                       :kCGEventKeyDown,            10,   # key-down event
+                       :kCGEventKeyUp,              11 ]  # key-up down
+  
+  # Mouse buttons
+  enum :CGMouseButton, [ :kCGMouseButtonLeft, 0,
+                         :kCGMouseButtonRight,
+                         :kCGMouseButtonCenter ]
+  
+  # Virtual Key Codes
+  enum :CGKeyCode, [ :A,              0x00,
+                     :S,              0x01,
+                     :D,              0x02,
+                     :F,              0x03,
+                     :H,              0x04,
+                     :G,              0x05,
+                     :Z,              0x06,
+                     :X,              0x07,
+                     :C,              0x08,
+                     :V,              0x09,
+                     :B,              0x0B,
+                     :Q,              0x0C,
+                     :W,              0x0D,
+                     :E,              0x0E,
+                     :R,              0x0F,
+                     :Y,              0x10,
+                     :T,              0x11,
+                     :Num1,           0x12,
+                     :Num2,           0x13,
+                     :Num3,           0x14,
+                     :Num4,           0x15,
+                     :Num6,           0x16,
+                     :Num5,           0x17,
+                     :Equal,          0x18,
+                     :Num9,           0x19,
+                     :Num7,           0x1A,
+                     :Minus,          0x1B,
+                     :Num8,           0x1C,
+                     :Num0,           0x1D,
+                     :RightBracket,   0x1E,
+                     :O,              0x1F,
+                     :U,              0x20,
+                     :LeftBracket,    0x21,
+                     :I,              0x22,
+                     :P,              0x23,
+                     :L,              0x25,
+                     :J,              0x26,
+                     :Quote,          0x27,
+                     :K,              0x28,
+                     :Semicolon,      0x29,
+                     :Backslash,      0x2A,
+                     :Comma,          0x2B,
+                     :Slash,          0x2C,
+                     :N,              0x2D,
+                     :M,              0x2E,
+                     :Period,         0x2F,
+                     :Grave,          0x32,
+                     :KeypadDecimal,  0x41,
+                     :KeypadMultiply, 0x43,
+                     :KeypadPlus,     0x45,
+                     :KeypadClear,    0x47,
+                     :KeypadDivide,   0x4B,
+                     :KeypadEnter,    0x4C,
+                     :KeypadMinus,    0x4E,
+                     :KeypadEquals,   0x51,
+                     :Keypad0,        0x52,
+                     :Keypad1,        0x53,
+                     :Keypad2,        0x54,
+                     :Keypad3,        0x55,
+                     :Keypad4,        0x56,
+                     :Keypad5,        0x57,
+                     :Keypad6,        0x58,
+                     :Keypad7,        0x59,
+                     :Keypad8,        0x5B,
+                     :Keypad9,        0x5C,
+                     :return,         0x24,
+                     :tab,            0x30,
+                     :space,          0x31,
+                     :delete,         0x33,
+                     :escape,         0x35,
+                     :function,       0x3F,
+                     :home,           0x73,
+                     :end,            0x77,                    
+                     :page_up,        0x74,
+                     :page_down,      0x79,
+                     :forward_delete, 0x75,
+                     :left_arrow,     0x7B,
+                     :right_arrow,    0x7C,
+                     :down_arrow,     0x7D,
+                     :up_arrow,       0x7E ]
+
+  enum :CGEventFlags, [ :alphashift,  0x00010000,
+                        :shift,       0x00020000,
+                        :control,     0x00040000,
+                        :alt,         0x00080000,
+                        :command,     0x00100000,
+                        :help,        0x00400000,
+                        :secondaryfn, 0x00800000 ]
+  
+  # CGEventTapLocation
+  enum :CGEventTapLocation, [ :kCGHIDEventTap, 0,
+                              :kCGSessionEventTap,
+                              :kCGAnnotatedSessionEventTap ]                    
+  
+  # Attach to the CGEventCreateMouseEvent function
+  attach_function :CGEventCreateMouseEvent, [ :pointer, :CGEventType, CGPoint.by_value, :CGMouseButton ], :pointer
+  attach_function :CGEventCreateKeyboardEvent, [:pointer, :CGKeyCode, :bool ], :pointer
+  attach_function :CGEventSetFlags, [:pointer, :CGEventFlags], :void
+  attach_function :CGEventSetType, [:pointer, :CGEventType], :void
+  attach_function :CGEventPost, [ :CGEventTapLocation, :pointer], :void
+  attach_function :CFRelease, [:pointer], :void
+
+end

data/lib/mousetools.rb

@@ -1,194 +1,79 @@
-require 'ffi'
-
-module Mouse
-  extend FFI::Library
-  ffi_lib '/System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/CoreGraphics.framework/Versions/A/CoreGraphics'
-  
-  class CGPoint < FFI::Struct
-    layout :x, :double,
-           :y, :double
-  end
-  
-  # Mouse/Keyboard events
-  enum :CGEventType, [ :kCGEventNull,               0,		# Null Event 
-                       :kCGEventLeftMouseDown,      1,		# left mouse-down event
-                       :kCGEventLeftMouseUp,        2,		# left mouse-up event
-                       :kCGEventRightMouseDown,     3,		# right mouse-down event
-                       :kCGEventRightMouseUp,       4,		# right mouse-up event
-                       :kCGEventMouseMoved,         5,		# mouse-moved event
-                       :kCGEventLeftMouseDragged,   6,    # left mouse-dragged event
-                       :kCGEventRightMouseDragged,  7,    # right mouse-dragged event
-                       :kCGEventScrollWheel,        22,   # mouse scrolled event
-                       :kCGEventOtherMouseDown,     25,   # other mouse-down event
-                       :kCGEventOtherMouseUp,       26,   # other mouse-up event
-                       :kCGEventOtherMouseDragged,  27,   # other mouse-dragged event
-                       :kCGEventKeyDown,            10,   # key-down event
-                       :kCGEventKeyUp,              11 ]  # key-up down
-  
-  # Mouse buttons
-  enum :CGMouseButton, [ :kCGMouseButtonLeft, 0,
-                         :kCGMouseButtonRight,
-                         :kCGMouseButtonCenter ]
-  
-  # Virtual Key Codes
-  enum :CGKeyCode, [ :return,         0x24,
-                     :tab,            0x30,
-                     :space,          0x31,
-                     :delete,         0x33,
-                     :escape,         0x35,
-                     :command,        0x37,
-                     :left_shift,     0x38,
-                     :left_option,    0x3A,
-                     :left_control,   0x3B,
-                     :right_shift,    0x3C,
-                     :right_option,   0x3D,
-                     :right_control,  0x3E,
-                     :function,       0x3F,
-                     :home,           0x73,
-                     :end,            0x77,                    
-                     :page_up,        0x74,
-                     :page_down,      0x79,
-                     :forward_delete, 0x75,
-                     :left_arrow,     0x7B,
-                     :right_arrow,    0x7C,
-                     :down_arrow,     0x7D,
-                     :up_arrow,       0x7E ]
-  
-  # CGEventTapLocation
-  enum :CGEventTapLocation, [ :kCGHIDEventTap, 0,
-                              :kCGSessionEventTap,
-                              :kCGAnnotatedSessionEventTap ]                    
-  
-  # Attach to the CGEventCreateMouseEvent function
-  attach_function :CGEventCreateMouseEvent, [ :pointer, :CGEventType, CGPoint.by_value, :CGMouseButton ], :pointer
-  attach_function :CGEventCreateKeyboardEvent, [:pointer, :CGKeyCode, :bool ], :pointer
-  attach_function :CGEventSetType, [:pointer, :CGEventType], :void
-  attach_function :CGEventPost, [ :CGEventTapLocation, :pointer], :void
-  attach_function :CFRelease, [:pointer], :void
-
-end
+require "cgevent"
+include CGEvent
 
 class Mousetools
   
-  @current_coordinates
   attr_accessor :current_coordinates
   
-  def initialize
-    @current_coordinates = Hash.new
-  end
-
-  def left_mouse_down(x = nil, y = nil)
-    raise "Coordinates not set" if (x.nil? || y.nil?) && @current_coordinates.nil?
-    @current_coordinates = {:x => x, :y => y} if (!x.nil? && !y.nil?)
-    point = Mouse::CGPoint.new
-    point[:x] = @current_coordinates[:x]
-    point[:y] = @current_coordinates[:y]
-    # Create the event
-    event = Mouse::CGEventCreateMouseEvent(nil, :kCGEventLeftMouseDown, point, :kCGMouseButtonLeft)
-    # Post the event
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    # Release the event ref
-    Mouse::CFRelease(event)
+  def left_mouse_down(x = nil, y = nil, modifier_key_1 = nil, modifier_key_2 = nil)
+    post_mouse_event(x, y, :kCGEventLeftMouseDown, :kCGMouseButtonLeft, modifier_key_1, modifier_key_2)
   end
   
   def left_mouse_up(x = nil, y = nil)
-    raise "Coordinates not set" if (x.nil? || y.nil?) && @current_coordinates.nil?
-    @current_coordinates = {:x => x, :y => y} if (!x.nil? && !y.nil?)
-    point = Mouse::CGPoint.new
-    point[:x] = @current_coordinates[:x]
-    point[:y] = @current_coordinates[:y]
-    # Create the event
-    event = Mouse::CGEventCreateMouseEvent(nil, :kCGEventLeftMouseUp, point, :kCGMouseButtonLeft)
-    # Post the event
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    # Release the event ref
-    Mouse::CFRelease(event)
+    post_mouse_event(x, y, :kCGEventLeftMouseUp, :kCGMouseButtonLeft)
   end
   
-  def right_mouse_down(x = nil, y = nil)
-    raise "Coordinates not set" if (x.nil? || y.nil?) && @current_coordinates.nil?
-    @current_coordinates = {:x => x, :y => y} if (!x.nil? && !y.nil?)
-    point = Mouse::CGPoint.new
-    point[:x] = @current_coordinates[:x]
-    point[:y] = @current_coordinates[:y]
-    # Create the event
-    event = Mouse::CGEventCreateMouseEvent(nil, :kCGEventRightMouseDown, point, :kCGMouseButtonRight)
-    # Post the event
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    # Release the event ref
-    Mouse::CFRelease(event)
+  def right_mouse_down(x = nil, y = nil, modifier_key_1 = nil, modifier_key_2 = nil)
+    post_mouse_event(x, y, :kCGEventRightMouseDown, :kCGMouseButtonRight, modifier_key_1, modifier_key_2)
   end
   
   def right_mouse_up(x = nil, y = nil)
-    raise "Coordinates not set" if (x.nil? || y.nil?) && @current_coordinates.nil?
-    @current_coordinates = {:x => x, :y => y} if (!x.nil? && !y.nil?)
-    point = Mouse::CGPoint.new
-    point[:x] = @current_coordinates[:x]
-    point[:y] = @current_coordinates[:y]
-    # Create the event
-    event = Mouse::CGEventCreateMouseEvent(nil, :kCGEventRightMouseUp, point, :kCGMouseButtonRight)
-    # Post the event
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    # Release the event ref
-    Mouse::CFRelease(event)
+    post_mouse_event(x, y, :kCGEventRightMouseUp, :kCGMouseButtonRight)
   end
   
-  def move_cursor(x = nil, y = nil)
-    raise "Must provide new coordinates to move the cursor" if (x.nil? || y.nil?)
-    point = Mouse::CGPoint.new
-    point[:x] = x
-    point[:y] = y
-    # Create the event
-    event = Mouse::CGEventCreateMouseEvent(nil, :kCGEventMouseMoved, point, :kCGMouseButtonLeft)
-    # Post the event
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    @current_coordinates = {:x => x, :y => y}
-    # Release the event ref
-    Mouse::CFRelease(event)
+  def move_cursor(x, y)
+    post_mouse_event(x, y, :kCGEventMouseMoved, :kCGMouseButtonLeft)
   end
 
-  def left_mouse_drag(x = nil, y = nil)
-    raise "Must provide new coordinates to drag the cursor" if (x.nil? || y.nil?)
-    point = Mouse::CGPoint.new
-    point[:x] = x
-    point[:y] = y
-    # Create the event
-    event = Mouse::CGEventCreateMouseEvent(nil, :kCGEventLeftMouseDragged, point, :kCGMouseButtonLeft)
-    # Post the event
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    @current_coordinates = {:x => x, :y => y}
-    # Release the event ref
-    Mouse::CFRelease(event)
+  def left_mouse_drag(x, y, modifier_key_1 = nil, modifier_key_2 = nil)
+    post_mouse_event(x, y, :kCGEventLeftMouseDragged, :kCGMouseButtonLeft, modifier_key_1, modifier_key_2)
   end
   
-  def right_mouse_drag(x = nil, y = nil)
-    raise "Must provide new coordinates to drag the cursor" if (x.nil? || y.nil?)
-    point = Mouse::CGPoint.new
-    point[:x] = x
-    point[:y] = y
-    # Create the event
-    event = Mouse::CGEventCreateMouseEvent(nil, :kCGEventRightMouseDragged, point, :kCGMouseButtonRight)
-    # Post the event
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    @current_coordinates = {:x => x, :y => y}
-    # Release the event ref
-    Mouse::CFRelease(event)
+  def right_mouse_drag(x, y, modifier_key_1 = nil, modifier_key_2 = nil)
+    post_mouse_event(x, y, :kCGEventRightMouseDragged, :kCGMouseButtonRight, modifier_key_1, modifier_key_2)
   end
   
-  def key_down(virtual_key = nil)
-    raise "Must provide a key" if virtual_key.nil?
-    keycode = virtual_key.intern 
-    event = Mouse::CGEventCreateKeyboardEvent(nil, keycode, true)
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    Mouse::CFRelease(event)
+  def key_down(virtual_key, modifier_key_1 = nil, modifier_key_2 = nil)
+    if (modifier_key_1.nil? && modifier_key_2.nil?)
+      post_keyboard_event(virtual_key, true)
+    elsif (!modifier_key_1.nil? && modifier_key_2.nil?)
+      post_keyboard_event(virtual_key, true, modifier_key_1)
+    else
+      post_keyboard_event(virtual_key, true, modifier_key_1, modifier_key_2)
+    end
   end
   
-  def key_up(virtual_key = nil)
-    raise "Must provide a key" if virtual_key.nil?
-    keycode = virtual_key.intern 
-    event = Mouse::CGEventCreateKeyboardEvent(nil, keycode, false)
-    Mouse::CGEventPost(:kCGHIDEventTap, event)
-    Mouse::CFRelease(event)
+  def key_up(virtual_key)
+    post_keyboard_event(virtual_key, false)
   end
   
+  # Private Methods
+  private
+    def set_current_coordinates(x, y)
+      @current_coordinates = CGPoint.new if @current_coordinates.nil?
+      @current_coordinates[:x] = x
+      @current_coordinates[:y] = y
+    end
+  
+    def post_mouse_event(x, y, event_type, mouse_button, modifier_key_1 = nil, modifier_key_2 = nil)
+      raise "Must provide inital x and y coordinates" if (x.nil? || y.nil?) && @current_coordinates.nil?
+      # Create the event
+      set_current_coordinates(x, y) unless x.nil? || y.nil?
+      event = CGEventCreateMouseEvent(nil, event_type, @current_coordinates, mouse_button)
+      CGEventSetFlags(event, modifier_key_1) if (modifier_key_1)
+      CGEventSetFlags(event, modifier_key_2) if (modifier_key_2)
+      # Post the event
+      CGEventPost(:kCGHIDEventTap, event)
+      # Release the event ref
+      CFRelease(event)
+    end
+  
+    def post_keyboard_event(virtual_key, position, modifier_key_1 = nil, modifier_key_2 = nil)
+      event = CGEventCreateKeyboardEvent(nil, virtual_key, position)
+      CGEventSetFlags(event, modifier_key_1) if (modifier_key_1)
+      CGEventSetFlags(event, modifier_key_2) if (modifier_key_2)
+      CGEventPost(:kCGHIDEventTap, event)
+      CFRelease(event)
+    end
+    
 end

metadata

@@ -3,10 +3,10 @@ name: mousetools
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
-  - 0
-  - 1
   - 1
-  version: 0.1.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Scott Larson
@@ -41,6 +41,8 @@ extra_rdoc_files: []
 
 files: 
 - lib/mousetools.rb
+- lib/cgevent.rb
+- CHANGELOG
 has_rdoc: true
 homepage: http://rubygems.org/gems/mousetools
 licenses: []