mousetools 0.1.0

data/lib/mousetools.rb

@@ -0,0 +1,195 @@
+require 'rubygems'
+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
+
+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)
+  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)
+  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)
+  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)
+  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)
+  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)
+  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)
+  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)
+  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)
+  end
+  
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: mousetools
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Larson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-16 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: A gem that allows for basic mouse-manipulation functionality in OS X (including left/right click, dragging, key-click, etc.)
+email: scottl@mozy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mousetools.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/mousetools
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Mousetools for Mac
+test_files: []
+