mouse 1.0.6 → 1.1.0

data/History.markdown

@@ -1,3 +1,10 @@
+# 1.1.0 - A bit more granularity
+
+  * Add `Mouse.secondary_click_down` and alias `Mouse.right_click_down`
+  * Add `Mouse.secondary_click_up` and alias `Mouse.right_click_up`
+  * Add `Mouse.arbitrary_click_down`
+  * Add `Mouse.arbitrary_click_up`
+
 # 1.0.6 - Boogs
 
   * Fix `Mouse.scroll` assuming arguments always included units

data/ext/mouse/mouse.c

@@ -6,7 +6,6 @@ static VALUE rb_cCGPoint;
 static ID sel_x;
 static ID sel_y;
 static ID sel_to_point;
-static ID sel_to_i;
 static ID sel_new;
 static ID unit_pixel;
 static ID unit_line;
@@ -130,12 +129,11 @@ rb_mouse_scroll(int argc, VALUE *argv, VALUE self)
   if (argc == 0 || argc > 3)
     rb_raise(rb_eArgError, "scroll requires 1..3 arguments, you gave %d", argc);
 
-  VALUE amount = rb_funcall(argv[0], sel_to_i, 0);
-  int   amt    = NUM2INT(amount);
+  int amt = NUM2INT(argv[0]);
 
   if (argc == 1) {
     mouse_scroll(amt);
-    return amount;
+    return argv[0];
   }
 
   ID units = rb_to_id(argv[1]);
@@ -160,7 +158,7 @@ rb_mouse_scroll(int argc, VALUE *argv, VALUE self)
       rb_raise(rb_eArgError, "unknown units `%s'", rb_id2name(units));
   }
 
-  return amount;
+  return argv[0];
 }
 
 /*
@@ -247,6 +245,65 @@ rb_mouse_click(int argc, VALUE *argv, VALUE self)
   return CURRENT_POSITION;
 }
 
+/*
+ * Generate the down click part of a secondary/right click event
+ *
+ * This might be useful in concert with {Mouse.secondary_click_up} if
+ * you want to inject some behaviour between the down and up click
+ * events.
+ *
+ * You can optionally specify a point to click; the mouse cursor will
+ * instantly jump to the given point.
+ *
+ * @param point [CGPoint] (_default_: {#current_position}) (__optional__)
+ * @return [CGPoint]
+ */
+static
+VALUE
+rb_mouse_secondary_click_down(int argc, VALUE* argv, VALUE self)
+{
+  switch (argc)
+    {
+    case 0:
+      mouse_secondary_click_down();
+      break;
+    case 1:
+    default:
+      mouse_secondary_click_down2(rb_mouse_unwrap_point(argv[0]));
+    }
+
+  return CURRENT_POSITION;
+}
+
+/*
+ * Generate the up click part of a secondary/right click event
+ *
+ * This might be useful in concert with {Mouse.secondary_click_down} if
+ * you want to inject some behaviour between the down and up click events.
+ *
+ * You can optionally specify a point to click; the mouse cursor will
+ * instantly jump to the given point.
+ *
+ * @param point [CGPoint] (_default_: {#current_position}) (__optional__)
+ * @return [CGPoint]
+ */
+static
+VALUE
+rb_mouse_secondary_click_up(int argc, VALUE* argv, VALUE self)
+{
+  switch (argc)
+    {
+    case 0:
+      mouse_secondary_click_up();
+      break;
+    case 1:
+    default:
+      mouse_secondary_click_up2(rb_mouse_unwrap_point(argv[0]));
+    }
+
+  return CURRENT_POSITION;
+}
+
 /*
  * Generate a secondary click (both down and up events)
  *
@@ -275,6 +332,75 @@ rb_mouse_secondary_click(int argc, VALUE *argv, VALUE self)
   return CURRENT_POSITION;
 }
 
+/*
+ * Generate the down click part of an arbitrary click event
+ *
+ * This might be useful in concert with {Mouse.arbitrary_click_up} if
+ * you want to inject some behaviour between the down and up click
+ * events.
+ *
+ * You can optionally specify a point to click; the mouse cursor will
+ * instantly jump to the given point.
+ *
+ * @param point [CGPoint] (_default_: {#current_position}) (__optional__)
+ * @return [CGPoint]
+ */
+static
+VALUE
+rb_mouse_arbitrary_click_down(int argc, VALUE* argv, VALUE self)
+{
+  if (argc == 0)
+    rb_raise(rb_eArgError, "arbitrary_click_down requires at least one arg");
+
+  uint_t button = NUM2INT(argv[0]);
+
+  switch (argc)
+    {
+    case 1:
+      mouse_arbitrary_click_down(button);
+      break;
+    case 2:
+    default:
+      mouse_arbitrary_click_down2(button, rb_mouse_unwrap_point(argv[1]));
+    }
+
+  return CURRENT_POSITION;
+}
+
+/*
+ * Generate the up click part of an arbitrary click event
+ *
+ * This might be useful in concert with {Mouse.arbitrary_click_down} if
+ * you want to inject some behaviour between the down and up click events.
+ *
+ * You can optionally specify a point to click; the mouse cursor will
+ * instantly jump to the given point.
+ *
+ * @param point [CGPoint] (_default_: {#current_position}) (__optional__)
+ * @return [CGPoint]
+ */
+static
+VALUE
+rb_mouse_arbitrary_click_up(int argc, VALUE* argv, VALUE self)
+{
+  if (argc == 0)
+    rb_raise(rb_eArgError, "arbitrary_click_up requires at least one arg");
+
+  uint_t button = NUM2INT(argv[0]);
+
+  switch (argc)
+    {
+    case 1:
+      mouse_arbitrary_click_up(button);
+      break;
+    case 2:
+    default:
+      mouse_arbitrary_click_up2(button, rb_mouse_unwrap_point(argv[1]));
+    }
+
+  return CURRENT_POSITION;
+}
+
 /*
  * Generate a click using an arbitrary mouse button (down and up events)
  *
@@ -305,7 +431,7 @@ rb_mouse_arbitrary_click(int argc, VALUE *argv, VALUE self)
     return Qnil;
   }
 
-  uint_t button = NUM2INT(rb_funcall(argv[0], sel_to_i, 0));
+  uint_t button = NUM2INT(argv[0]);
 
   switch (argc)
     {
@@ -372,7 +498,7 @@ rb_mouse_multi_click(int argc, VALUE *argv, VALUE self)
   }
 
   // TODO: there has got to be a more idiomatic way to do this coercion
-  size_t num_clicks = NUM2SIZET(rb_funcall(argv[0], sel_to_i, 0));
+  size_t num_clicks = NUM2SIZET(argv[0]);
 
   switch (argc)
     {
@@ -457,7 +583,6 @@ Init_mouse()
   sel_x        = rb_intern("x");
   sel_y        = rb_intern("y");
   sel_to_point = rb_intern("to_point");
-  sel_to_i     = rb_intern("to_i");
   sel_new      = rb_intern("new");
 
   unit_pixel   = rb_intern("pixel");
@@ -482,19 +607,25 @@ Init_mouse()
 
   rb_extend_object(rb_mMouse, rb_mMouse);
 
-  rb_define_method(rb_mMouse, "current_position", rb_mouse_current_position,  0);
-  rb_define_method(rb_mMouse, "move_to",          rb_mouse_move_to,          -1);
-  rb_define_method(rb_mMouse, "drag_to",          rb_mouse_drag_to,          -1);
-  rb_define_method(rb_mMouse, "scroll",           rb_mouse_scroll,           -1);
-  rb_define_method(rb_mMouse, "click_down",       rb_mouse_click_down,       -1);
-  rb_define_method(rb_mMouse, "click_up",         rb_mouse_click_up,         -1);
-  rb_define_method(rb_mMouse, "click",            rb_mouse_click,            -1);
-  rb_define_method(rb_mMouse, "secondary_click",  rb_mouse_secondary_click,  -1);
-  rb_define_method(rb_mMouse, "middle_click",     rb_mouse_middle_click,     -1);
-  rb_define_method(rb_mMouse, "arbitrary_click",  rb_mouse_arbitrary_click,  -1);
-  rb_define_method(rb_mMouse, "multi_click",      rb_mouse_multi_click,      -1);
-  rb_define_method(rb_mMouse, "double_click",     rb_mouse_double_click,     -1);
-  rb_define_method(rb_mMouse, "triple_click",     rb_mouse_triple_click,     -1);
-
-  rb_define_alias(rb_mMouse, "right_click", "secondary_click");
+  rb_define_method(rb_mMouse, "current_position",     rb_mouse_current_position,      0);
+  rb_define_method(rb_mMouse, "move_to",              rb_mouse_move_to,              -1);
+  rb_define_method(rb_mMouse, "drag_to",              rb_mouse_drag_to,              -1);
+  rb_define_method(rb_mMouse, "scroll",               rb_mouse_scroll,               -1);
+  rb_define_method(rb_mMouse, "click_down",           rb_mouse_click_down,           -1);
+  rb_define_method(rb_mMouse, "click_up",             rb_mouse_click_up,             -1);
+  rb_define_method(rb_mMouse, "click",                rb_mouse_click,                -1);
+  rb_define_method(rb_mMouse, "secondary_click_down", rb_mouse_secondary_click_down, -1);
+  rb_define_method(rb_mMouse, "secondary_click_up",   rb_mouse_secondary_click_up,   -1);
+  rb_define_method(rb_mMouse, "secondary_click",      rb_mouse_secondary_click,      -1);
+  rb_define_method(rb_mMouse, "middle_click",         rb_mouse_middle_click,         -1);
+  rb_define_method(rb_mMouse, "arbitrary_click_down", rb_mouse_arbitrary_click_down, -1);
+  rb_define_method(rb_mMouse, "arbitrary_click_up",   rb_mouse_arbitrary_click_up,   -1);
+  rb_define_method(rb_mMouse, "arbitrary_click",      rb_mouse_arbitrary_click,      -1);
+  rb_define_method(rb_mMouse, "multi_click",          rb_mouse_multi_click,          -1);
+  rb_define_method(rb_mMouse, "double_click",         rb_mouse_double_click,         -1);
+  rb_define_method(rb_mMouse, "triple_click",         rb_mouse_triple_click,         -1);
+
+  rb_define_alias(rb_mMouse, "right_click_down", "secondary_click_down");
+  rb_define_alias(rb_mMouse, "right_click_up",   "secondary_click_up");
+  rb_define_alias(rb_mMouse, "right_click",      "secondary_click");
 }

data/ext/mouse/mouser.c

@@ -27,10 +27,10 @@ static const double DEFAULT_DURATION = 0.2; // seconds
 #endif
 
 #define POSTRELEASE(x) do {			\
-  CGEventRef event = x;  	 		\
-  POST(event);					\
-  RELEASE(event);				\
-} while(false);
+    CGEventRef event = x;  	 		\
+    POST(event);				\
+    RELEASE(event);				\
+  } while(false);
 
 
 static
@@ -152,7 +152,7 @@ mouse_scroll3(int amount, CGScrollEventUnit units, double duration)
 {
   size_t     steps = round(FPS * duration);
   double   current = 0.0;
-  double      done = 0;
+  double      done = 0.0;
   int32_t   scroll = 0;
 
   for (size_t step = 0; step < steps; step++) {
@@ -225,57 +225,134 @@ mouse_click()
 
 
 void
-mouse_secondary_click3(CGPoint point, uint_t sleep_quanta)
+mouse_secondary_click_down3(CGPoint point, uint_t sleep_quanta)
 {
   CGEventRef base_event = NEW_EVENT(
 				    kCGEventRightMouseDown,
 				    point,
 				    kCGMouseButtonRight
 				    );
-  POST(base_event);
+  POSTRELEASE(base_event);
   mouse_sleep(sleep_quanta);
+}
+
+void
+mouse_secondary_click_down2(CGPoint point)
+{
+  mouse_secondary_click_down3(point, FPS / 10);
+}
 
-  CHANGE(base_event, kCGEventRightMouseUp);
+void
+mouse_secondary_click_down()
+{
+  mouse_secondary_click_down2(mouse_current_position());
+}
+
+
+void
+mouse_secondary_click_up2(CGPoint point)
+{
+  CGEventRef base_event = NEW_EVENT(
+				    kCGEventRightMouseUp,
+				    point,
+				    kCGMouseButtonRight
+				    );
   POSTRELEASE(base_event);
 }
 
+void
+mouse_secondary_click_up()
+{
+  mouse_secondary_click_up2(mouse_current_position());
+}
+
+
+void
+mouse_secondary_click3(CGPoint point, uint_t sleep_quanta)
+{
+  mouse_secondary_click_down3(point, sleep_quanta);
+  mouse_secondary_click_up2(point);
+}
+
 void
 mouse_secondary_click2(CGPoint point)
 {
-  mouse_secondary_click3(point, FPS / 10);
+  mouse_secondary_click_down2(point);
+  mouse_secondary_click_up2(point);
 }
 
 void
 mouse_secondary_click()
 {
-  mouse_secondary_click2(mouse_current_position());
+  mouse_secondary_click_down();
+  mouse_secondary_click_up();
 }
 
 
 void
-mouse_arbitrary_click3(CGEventMouseSubtype button, CGPoint point, uint_t sleep_quanta)
+mouse_arbitrary_click_down3(
+			    CGEventMouseSubtype button,
+			    CGPoint point,
+			    uint_t sleep_quanta
+			    )
 {
   CGEventRef base_event = NEW_EVENT(
 				    kCGEventOtherMouseDown,
 				    point,
 				    button
 				    );
-  POST(base_event);
+  POSTRELEASE(base_event);
   mouse_sleep(sleep_quanta);
-  CHANGE(base_event, kCGEventOtherMouseUp);
+}
+
+void
+mouse_arbitrary_click_down2(CGEventMouseSubtype button, CGPoint point)
+{
+  mouse_arbitrary_click_down3(button, point, FPS / 10);
+}
+
+void
+mouse_arbitrary_click_down(CGEventMouseSubtype button)
+{
+  mouse_arbitrary_click_down2(button, mouse_current_position());
+}
+
+
+void mouse_arbitrary_click_up2(CGEventMouseSubtype button, CGPoint point)
+{
+  CGEventRef base_event = NEW_EVENT(
+				    kCGEventOtherMouseUp,
+				    point,
+				    button
+				    );
   POSTRELEASE(base_event);
 }
 
+void mouse_arbitrary_click_up(CGEventMouseSubtype button)
+{
+  mouse_arbitrary_click_up2(button, mouse_current_position());
+}
+
+
+void
+mouse_arbitrary_click3(CGEventMouseSubtype button, CGPoint point, uint_t sleep_quanta)
+{
+  mouse_arbitrary_click_down3(button, point, sleep_quanta);
+  mouse_arbitrary_click_up2(button, point);
+}
+
 void
 mouse_arbitrary_click2(CGEventMouseSubtype button, CGPoint point)
 {
-  mouse_arbitrary_click3(button, point, FPS / 10);
+  mouse_arbitrary_click_down2(button, point);
+  mouse_arbitrary_click_up2(button, point);
 }
 
 void
 mouse_arbitrary_click(CGEventMouseSubtype button)
 {
-  mouse_arbitrary_click2(button, mouse_current_position());
+  mouse_arbitrary_click_down(button);
+  mouse_arbitrary_click_up(button);
 }
 
 

data/ext/mouse/mouser.h

@@ -32,10 +32,24 @@ void mouse_click_up2(CGPoint point);
 void mouse_click();
 void mouse_click2(CGPoint point);
 
+void mouse_secondary_click_down();
+void mouse_secondary_click_down2(CGPoint point);
+void mouse_secondary_click_down3(CGPoint point, uint_t sleep_quanta);
+
+void mouse_secondary_click_up();
+void mouse_secondary_click_up2(CGPoint point);
+
 void mouse_secondary_click();
 void mouse_secondary_click2(CGPoint point);
 void mouse_secondary_click3(CGPoint point, uint_t sleep_quanta);
 
+void mouse_arbitrary_click_down(CGEventMouseSubtype button);
+void mouse_arbitrary_click_down2(CGEventMouseSubtype button, CGPoint point);
+void mouse_arbitrary_click_down3(CGEventMouseSubtype button, CGPoint point, uint_t sleep_quanta);
+
+void mouse_arbitrary_click_up(CGEventMouseSubtype button);
+void mouse_arbitrary_click_up2(CGEventMouseSubtype button, CGPoint point);
+
 void mouse_arbitrary_click(CGEventMouseSubtype button);
 void mouse_arbitrary_click2(CGEventMouseSubtype button, CGPoint point);
 void mouse_arbitrary_click3(CGEventMouseSubtype button, CGPoint point, uint_t sleep_quanta);

data/lib/mouse/version.rb

@@ -1,4 +1,4 @@
 module Mouse
-  VERSION = '1.0.6'
+  VERSION = '1.1.0'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mouse
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard