accessibility_core 0.4.0 → 0.4.1

data/History.markdown

@@ -1,3 +1,9 @@
+# 0.4.1 - Polish
+
+  * Plug various memory leaks in `core.c`
+  * Improved error messages for `accessibility/core` on MRI
+
+
 # 0.4.0 - Fill in the gaps and other dubious requirements
 
   * Add `Object#load_plist` to match MacRuby's `Object#load_plist`

data/ext/accessibility/bridge/bridge.h

@@ -53,15 +53,16 @@ extern ID sel_parse;
   } while (false);
 
 #define WRAP_ARRAY(wrapper) do {				\
+    CFTypeRef  obj = NULL;				        \
     CFIndex length = CFArrayGetCount(array);			\
     VALUE      ary = rb_ary_new2(length);			\
-								\
-    for (CFIndex idx = 0; idx < length; idx++)			\
-      rb_ary_store(						\
-		   ary,						\
-		   idx,						\
-		   wrapper(CFArrayGetValueAtIndex(array, idx))	\
-		   );	                                        \
+    								\
+    for (CFIndex idx = 0; idx < length; idx++) {		\
+      obj = CFArrayGetValueAtIndex(array, idx);			\
+      CFRetain(obj);						\
+      rb_ary_store(ary, idx, wrapper(obj));			\
+    }								\
+    								\
     return ary;							\
   } while (false);
 

data/ext/accessibility/core/core.c

@@ -25,20 +25,124 @@ static
 VALUE
 handle_error(VALUE self, AXError code)
 {
-  // TODO port the error handler from AXElements
-  switch (code)
-    {
-    case kAXErrorInvalidUIElement:
-      rb_raise(rb_eArgError, "invalid element (probably dead)");
-    case kAXErrorAttributeUnsupported:
-      rb_raise(rb_eArgError, "attribute unsupported");
-    case kAXErrorActionUnsupported:
-      rb_raise(rb_eArgError, "action unsupported");
-    case kAXErrorParameterizedAttributeUnsupported:
-      rb_raise(rb_eArgError, "parameterized attribute unsupported");
-    default:
-      rb_raise(rb_eRuntimeError, "you done goofed [%d]", code);
-    }
+  @autoreleasepool {
+    NSString* description = (NSString*)CFCopyDescription(unwrap_ref(self));
+    [description autorelease];
+
+    const char* inspected_self = CFStringGetCStringPtr(
+						       (CFStringRef)description,
+						       kCFStringEncodingUTF8
+						       );
+
+    switch (code)
+      {
+      case kAXErrorSuccess:
+	rb_raise(
+		 rb_eRuntimeError,
+		 "internal accessibility_core error"
+		 );
+      case kAXErrorFailure:
+	rb_raise(
+		 rb_eRuntimeError,
+		 "An accessibility system failure, possibly an allocation " \
+		 "failure, occurred with %s; stopping to be safe",
+		 inspected_self
+		 );
+      case kAXErrorIllegalArgument:
+	rb_raise(
+		 rb_eArgError,
+		 "illegal argument was passed to the method for %s",
+		 inspected_self
+		 );
+      case kAXErrorInvalidUIElement:
+	rb_raise(
+		 rb_eArgError,
+		 "invalid element `%s' (probably dead)",
+		 inspected_self
+		 );
+      case kAXErrorInvalidUIElementObserver:
+	rb_raise(
+		 rb_eArgError,
+		 "invalid observer passed to the method for %s",
+		 inspected_self
+		 );
+      case kAXErrorCannotComplete:
+	spin(0);
+	pid_t pid = 0;
+	AXUIElementGetPid(unwrap_ref(self), &pid);
+	NSRunningApplication* app = [NSRunningApplication runningApplicationWithProcessIdentifier:pid];
+	if (app)
+	  rb_raise(
+		   rb_eRuntimeError,
+		   "accessibility messaging failure. "			\
+		   "Perhaps the application is busy on unresponsive?"
+		   );
+	else
+	  rb_raise(
+		   rb_eRuntimeError,
+		   "application for pid=%d is no longer running. "	\
+		   "Maybe it crashed?",
+		   pid
+		   );
+      case kAXErrorAttributeUnsupported:
+	rb_raise(
+		 rb_eArgError,
+		 "attribute unsupported"
+		 );
+      case kAXErrorActionUnsupported:
+	rb_raise(
+		 rb_eArgError,
+		 "action unsupported"
+		 );
+      case kAXErrorNotificationUnsupported:
+	rb_raise(
+		 rb_eArgError,
+		 "notification unsupported"
+		 );
+      case kAXErrorNotImplemented:
+	rb_raise(
+		 rb_eNotImpError,
+		 "method not supported by the receiver"
+		 );
+      case kAXErrorNotificationAlreadyRegistered:
+	rb_raise(
+		 rb_eArgError,
+		 "notification has already been registered"
+		 );
+      case kAXErrorNotificationNotRegistered:
+	rb_raise(
+		 rb_eRuntimeError,
+		 "notification is not registered yet"
+		 );
+      case kAXErrorAPIDisabled:
+	rb_raise(
+		 rb_eRuntimeError,
+		 "AXAPI has been disabled"
+		 );
+      case kAXErrorNoValue:
+	rb_raise(
+		 rb_eRuntimeError,
+		 "accessibility_core internal error; "	\
+		 "should be handled internally"
+		 );
+      case kAXErrorParameterizedAttributeUnsupported:
+	rb_raise(
+		 rb_eArgError,
+		 "parameterized attribute unsupported"
+		 );
+      case kAXErrorNotEnoughPrecision:
+	rb_raise(
+		 rb_eRuntimeError,
+		 "AXAPI said there was not enough precision ¯\\(°_o)/¯"
+		 );
+      default:
+	rb_raise(
+		 rb_eRuntimeError,
+		 "accessibility_core majorly goofed [%d]",
+		 code
+		 );
+      }
+  }
 
   return Qnil;
 }
@@ -50,7 +154,7 @@ rb_acore_application_for(VALUE self, VALUE pid)
 {
   NSDate* date = [NSDate date];
   [[NSRunLoop currentRunLoop] runUntilDate:date];
-  CFRelease(date);
+  [date release];
 
   pid_t                     the_pid = NUM2PIDT(pid);
   NSRunningApplication* running_app =
@@ -58,8 +162,8 @@ rb_acore_application_for(VALUE self, VALUE pid)
 
   if (running_app) {
     VALUE app = wrap_ref(AXUIElementCreateApplication(the_pid));
-    CFRelease(running_app);
-    return app;
+    [running_app release];
+      return app;
   }
 
   rb_raise(
@@ -161,6 +265,7 @@ static
 VALUE
 rb_acore_attribute(VALUE self, VALUE name)
 {
+  VALUE             obj;
   CFTypeRef        attr = NULL;
   CFStringRef attr_name = unwrap_string(name);
   AXError          code = AXUIElementCopyAttributeValue(
@@ -172,7 +277,10 @@ rb_acore_attribute(VALUE self, VALUE name)
   switch (code)
     {
     case kAXErrorSuccess:
-      return to_ruby(attr);
+      obj = to_ruby(attr);
+      if (TYPE(obj) != T_DATA)
+        CFRelease(attr);
+      return obj;
     case kAXErrorFailure:
     case kAXErrorNoValue:
     case kAXErrorInvalidUIElement:
@@ -247,6 +355,7 @@ rb_acore_set(VALUE self, VALUE name, VALUE value)
 						       attr_name,
 						       ax_value
 						       );
+  CFRelease(ax_value);
   switch (code)
     {
     case kAXErrorSuccess:
@@ -261,6 +370,7 @@ static
 VALUE
 rb_acore_role(VALUE self)
 {
+  VALUE       obj;
   CFTypeRef value = NULL;
   AXError    code = AXUIElementCopyAttributeValue(
 						  unwrap_ref(self),
@@ -270,7 +380,9 @@ rb_acore_role(VALUE self)
   switch (code)
     {
     case kAXErrorSuccess:
-      return wrap_string(value);
+      obj = wrap_string(value);
+      CFRelease(value);
+      return obj;
     case kAXErrorNoValue:
     case kAXErrorInvalidUIElement:
       return Qnil;
@@ -284,6 +396,7 @@ static
 VALUE
 rb_acore_subrole(VALUE self)
 {
+  VALUE       obj;
   CFTypeRef value = NULL;
   AXError    code = AXUIElementCopyAttributeValue(
 						  unwrap_ref(self),
@@ -293,7 +406,12 @@ rb_acore_subrole(VALUE self)
   switch (code)
     {
     case kAXErrorSuccess:
-      return wrap_string((CFStringRef)value);
+      if (value) {
+	obj = wrap_string(value);
+	CFRelease(value);
+	return obj;
+      }
+      return Qnil;
     case kAXErrorFailure:
     case kAXErrorNoValue:
     case kAXErrorInvalidUIElement:
@@ -334,6 +452,7 @@ static
 VALUE
 rb_acore_children(VALUE self)
 {
+  VALUE       obj;
   CFTypeRef value = NULL;
   AXError    code = AXUIElementCopyAttributeValue(
 						  unwrap_ref(self),
@@ -343,7 +462,9 @@ rb_acore_children(VALUE self)
   switch (code)
     {
     case kAXErrorSuccess:
-      return wrap_array_refs(value);
+      obj = wrap_array_refs(value);
+      CFRelease(value);
+      return obj;
     case kAXErrorFailure:
     case kAXErrorNoValue:
     case kAXErrorInvalidUIElement:
@@ -358,6 +479,7 @@ static
 VALUE
 rb_acore_value(VALUE self)
 {
+  VALUE       obj;
   CFTypeRef value = NULL;
   AXError    code = AXUIElementCopyAttributeValue(
 						  unwrap_ref(self),
@@ -367,7 +489,10 @@ rb_acore_value(VALUE self)
   switch (code)
     {
     case kAXErrorSuccess:
-      return to_ruby(value);
+      obj = to_ruby(value);
+      if (TYPE(obj) != T_DATA)
+        CFRelease(value);
+      return obj;
     default:
       return handle_error(self, code);
     }
@@ -436,6 +561,7 @@ static
 VALUE
 rb_acore_parameterized_attribute(VALUE self, VALUE name, VALUE parameter)
 {
+  VALUE             obj;
   CFTypeRef       param = to_ax(parameter);
   CFTypeRef        attr = NULL;
   CFStringRef attr_name = unwrap_string(name);
@@ -450,7 +576,10 @@ rb_acore_parameterized_attribute(VALUE self, VALUE name, VALUE parameter)
   switch (code)
     {
     case kAXErrorSuccess:
-      return to_ruby(attr);
+      obj = to_ruby(attr);
+      if (TYPE(obj) != T_DATA)
+        CFRelease(attr);
+      return obj;
     case kAXErrorNoValue:
     case kAXErrorInvalidUIElement:
       return Qnil;

data/lib/accessibility/core/macruby.rb

@@ -740,7 +740,7 @@ module Accessibility::Element
     KAXErrorInvalidUIElementObserver          => [
       ArgumentError,
       lambda { |*args|
-        'AXElements no longer supports notifications'
+        "Invalid observer passed to the method for #{args[0].inspect}"
       }
     ],
     KAXErrorCannotComplete                    => [
@@ -771,7 +771,7 @@ module Accessibility::Element
     KAXErrorNotificationUnsupported           => [
       ArgumentError,
       lambda { |*args|
-        'AXElements no longer supports notifications'
+        'Notification Unsupported'
       }
     ],
     KAXErrorNotImplemented                    => [

data/lib/accessibility/core/version.rb

@@ -6,6 +6,6 @@ module Accessibility
   # Namespace for `accessibility_core` specific classes
   module Core
     # return [String]
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: accessibility_core
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -107,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -989078667386493475
+      hash: 2206731083333154082
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -989078667386493475
+      hash: 2206731083333154082
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24