mac-robot 0.2.3 → 0.3.0

data/README.rdoc

@@ -13,6 +13,7 @@ A Library to Automate User Interactions
  robot.mouse_press
  robot.mouse_move(250, 250)
  robot.mouse_release
+ robot.scroll_wheel(:x => 10, :y => -20, :z => 5)
 
 === Automate keyboard
 

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/ext/event_dispatcher/event_dispatcher.m

@@ -36,6 +36,27 @@ CGEventType getEventTypeFromValue(VALUE value)
   return type;
 }
 
+CGScrollEventUnit getScrollEventUnitFromValue(VALUE value)
+{
+  const char *unitStr;
+  CGScrollEventUnit unit;
+
+  unitStr = StringValuePtr(value);
+
+  if(strncmp(unitStr, "pix", 3) == 0) {
+    // accepts pixel, pixels, pix
+    unit = kCGScrollEventUnitPixel;
+  } else if(strncmp(unitStr, "line", 4) == 0) {
+    // accepts line, lines
+    unit = kCGScrollEventUnitLine;
+  } else {
+    rb_warn("Given unit `%s' is invalid. pixel or line is allowed.", unitStr);
+    unit = kCGScrollEventUnitPixel;
+  }
+
+  return unit;
+}
+
 CGMouseButton getMouseButtonFromValue(VALUE value)
 {
   // http://developer.apple.com/library/mac/#documentation/Carbon/Reference/QuartzEventServicesRef/Reference/reference.html
@@ -78,6 +99,29 @@ static VALUE cEventDispatcher_dispatchMouseEvent(int argc, VALUE *argv, VALUE se
   return Qnil;
 }
 
+// http://stackoverflow.com/questions/6126226/how-to-create-an-nsevent-of-type-nsscrollwheel
+// wheel_cnt: 1 - Y, 2 - Y-X, 3 - Y-X-Z
+static VALUE cEventDispatcher_dispatchScrollWheelEvent(int argc, VALUE *argv, VALUE self)
+{
+  VALUE unit, wheel_cnt, scroll_y, scroll_x, scroll_z;
+  CGEventRef event;
+
+  rb_scan_args(argc, argv, "5", &unit, &wheel_cnt, &scroll_y, &scroll_x, &scroll_z);
+
+  event = CGEventCreateScrollWheelEvent(
+                                  NULL,
+                                  getScrollEventUnitFromValue(rb_funcall(unit, rb_intern("to_s"), 0)),
+                                  NUM2INT(wheel_cnt),
+                                  NUM2INT(scroll_y),
+                                  NUM2INT(scroll_x),
+                                  NUM2INT(scroll_z));
+
+  CGEventPost(kCGHIDEventTap, event);
+  CFRelease(event);
+
+  return Qnil;
+}
+
 // http://forums.macrumors.com/showthread.php?t=780577
 static VALUE cEventDispatcher_dispatchKeyboardEvent(int argc, VALUE *argv, VALUE self)
 {
@@ -105,5 +149,6 @@ void Init_event_dispatcher(void){
   rb_cEventDispatcher = rb_define_class_under(rb_cRobot, "EventDispatcher", rb_cObject);
   rb_define_singleton_method(rb_cEventDispatcher, "new", cEventDispatcher_new, -1);
   rb_define_method(rb_cEventDispatcher, "dispatchMouseEvent", cEventDispatcher_dispatchMouseEvent, -1);
+  rb_define_method(rb_cEventDispatcher, "dispatchScrollWheelEvent", cEventDispatcher_dispatchScrollWheelEvent, -1);
   rb_define_method(rb_cEventDispatcher, "dispatchKeyboardEvent", cEventDispatcher_dispatchKeyboardEvent, -1);
 }

data/lib/mac-robot.rb

@@ -46,6 +46,15 @@ module Mac
       keyboard_event(keycode, 0)
     end
 
+    def scroll_wheel_line(args = {})
+      scroll_wheel_event(:line, *scroll_count_extract(args))
+    end
+    alias scroll_wheel scroll_wheel_line
+
+    def scroll_wheel_pixel(args = {})
+      scroll_wheel_event(:pixel, *scroll_count_extract(args))
+    end
+
     def get_pixel_color(x, y)
       raise OutOfResolution if x < 0 || y < 0
       raise OutOfResolution if display_pixel_size.width < x || display_pixel_size.height < y
@@ -64,6 +73,32 @@ module Mac
       @dispatcher.dispatchMouseEvent(@x, @y, BUTTONS[button], type)
     end
 
+    def scroll_wheel_event(unit, scroll_y, scroll_x = 0, scroll_z = 0)
+      wheel_count = 3
+      @dispatcher.dispatchScrollWheelEvent(unit, wheel_count, scroll_y, scroll_x, scroll_z)
+    end
+
+    def scroll_count_extract(args = {})
+      # java.awt.Robot
+      # http://docs.oracle.com/javase/1.4.2/docs/api/java/awt/Robot.html#mouseWheel%28int%29
+      scroll_x = 0 # x > 0 => right
+      scroll_y = 0 # y > 0 => down
+      scroll_z = 0 # z > 0 => towards
+
+      args.each do |key, value|
+        case key
+        when :x
+          scroll_x -= value
+        when :y
+          scroll_y -= value
+        when :z
+          scroll_z -= value
+        end
+      end
+
+      return [scroll_y, scroll_x, scroll_z]
+    end
+
     def keyboard_event(keycode, keydown)
       @dispatcher.dispatchKeyboardEvent(keycode, keydown)
     end

data/mac-robot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mac-robot"
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["youpy"]
-  s.date = "2012-06-17"
+  s.date = "2012-09-18"
   s.description = "A Library to Automate User Interactions"
   s.email = "youpy@buycheapviagraonlinenow.com"
   s.extensions = ["ext/event_dispatcher/extconf.rb", "ext/util/extconf.rb"]

data/spec/mac-robot_spec.rb

@@ -15,6 +15,15 @@ describe Mac::Robot do
     end
   end
 
+  describe 'scroll wheel event' do
+    it 'should simulate scroll wheel event' do
+      subject.scroll_wheel_line(:y => 10)  # down 10 lines
+      subject.scroll_wheel(:y => -10)      # up 10 lines
+      subject.scroll_wheel_pixel(:x => 10, :y => -20, :z => 5)
+      subject.scroll_wheel_pixel(:y => 20, :x => -10, :z => -5)
+    end
+  end
+
   describe 'keyboard event' do
     it 'should simulate keyboard event' do
       [0x04, 0x0e, 0x25, 0x25, 0x1f].each do |keycode|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mac-robot
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-17 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3702793379613243156
+      hash: 625334772670347707
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: