accessibility_core 0.1.2 → 0.3.1

data/.yardopts

@@ -6,3 +6,5 @@
 --readme README.markdown
 --hide-void-return
 lib/**/*.rb
+ext/**/*{.m,.c}
+

data/History.markdown

@@ -1,13 +1,46 @@
+# 0.3.1 - Fix it up
+
+  * Fix C extensions being installed to the wrong location
+  * Fix Accessibility module not always being defined at the appropriate time
+
+# 0.3.0 - Merge accessibility\_bridge
+
+  * Merge in `accessibility_bridge` v0.2.0
+
+    - Add the `Battery` module for collecting information about the battery status
+    - Add the `Accessibility::Highilghter` module to highlight rectangles on the screen
+    - Add `NSScreen.wakeup` method as a freedom patch to wake sleeping screens
+
+    - Add a 99% drop-in replacement for `NSRunningApplication`
+    - Add a 20% drop-in replacement for `NSWorkspace` to complement `NSRunningApplication`
+    - Add a 66% drop-in replacement for `NSProcessInfo` for collecting  process info
+    - Add a 66% drop-in-replacement for `NSHost` for collecting host info
+    - Add a 20% drop-in replacement for `NSScreen` to help the highlighter
+    - Add a 33% drop-in replacement for `NSColor` to help the highlighter
+
+    - Various bugs fixed (wrapping strings, URLs, rectangles...)
+    - Various memory leaks plugged
+
+    __NOTE__: Percentages are somewhat arbitrary based on my personal usage.
+
+
+# 0.2.0 - Update accessibility\_bridge
+
+  * Update bridge dependency to v0.2.0
+
+
 # 0.1.2 - Fix some bridging stuff
 
   * Update bridge dependency to get a fix
 
+
 # 0.1.1 - Fix the silly things release
 
   * Fix documentation not being generated
   * Fix C extension not being installed to the proper location
   * Remove redundant core extensions provided by `accessibility_bridge`
 
+
 # 0.1.0 - Initial Release
 
   * CRuby and MacRuby compatible

data/README.markdown

@@ -36,6 +36,17 @@ rake anymore.
   * bridging for `NSAttributedString`
   * more descriptive error handling for the C extension
 
+
+## Tests
+
+Currently, the tests are all run as one task. You can run individual
+test files if needed. This is not ideal, but not a high priority for
+me right now.
+
+To properly run tests, you must run them under CRuby and also under
+MacRuby and get the same results.
+
+
 ## Copyright
 
 Copyright (c) 2012, Mark Rada

data/Rakefile

@@ -1,42 +1,30 @@
-task :default => :test
-
-require 'rake/clean'
-CLEAN.include '*.plist', '*.gch'
-
-desc 'Run the Clang static analyzer'
-task :analyze do
-  sh "clang --analyze ext/accessibility/core/core.c"
+if defined? MACRUBY_REVISION
+  def on_macruby?
+    true
+  end
+else
+  def on_macruby?
+    false
+  end
 end
 
-desc 'Startup an IRb console with accessibility-core loaded'
-task :console => [:compile] do
-  sh 'irb -Ilib -raccessibility/core'
+def on_mri?
+  !on_macruby?
 end
 
-desc 'Open the fixture app'
-task :run_fixture => :fixture do
-  sh 'open test/fixture/Release/AXElementsTester.app'
-end
+task :default => :test
 
-desc 'Build the test fixture'
-task :fixture do
-  sh 'cd test/AXElementsTester && xcodebuild'
-end
+# @todo restore the clang analyze task, don't forget to add rubyhdrdir
 
-desc 'Remove the built fixture app'
-task :clobber_fixture do
-  $stdout.puts 'rm -rf test/fixture'
-  rm_rf 'test/fixture'
+desc 'Startup an IRb console with accessibility-core loaded'
+task :console => 'compile:core' do
+  sh 'irb -Ilib -raccessibility/core'
 end
-task :clobber => :clobber_fixture
 
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.libs << '.'
-  t.pattern = 'test/*_test.rb'
+desc 'Startup an IRb console with everything loaded'
+task :console_complete => :compile do
+  sh 'irb -Ilib -raccessibility/core -raccessibility/bridge -raccessibility/extras -raccessibility/highlighter'
 end
-task :test => [:compile, :fixture]
-
 
 # Gem stuff
 
@@ -51,22 +39,3 @@ task :install => :gem do
   Gem::Installer.new("pkg/#{SPEC.file_name}").install
 end
 
-
-# C extensions!
-
-require 'rake/extensiontask'
-
-Rake::ExtensionTask.new('core', SPEC) do |ext|
-  ext.ext_dir = 'ext/accessibility/core'
-  ext.lib_dir = 'lib/accessibility'
-end
-
-#Rake::ExtensionTask.new('highlighter', SPEC) do |ext|
-#  ext.ext_dir = 'ext/accessibility/highlighter'
-#  ext.lib_dir = 'lib/accessibility/core'
-#end
-
-# Rake::ExtensionTask.new('running_application', SPEC) do |ext|
-#   ext.ext_dir = 'ext/accessibility/running_application'
-#   ext.lib_dir = 'lib/accessibility/core'
-# end

data/ext/accessibility/bridge/{ext/accessibility/bridge/bridge.c → bridge.c}

@@ -1,8 +1,13 @@
-#include "ruby.h"
-#import <Cocoa/Cocoa.h>
+#include "bridge.h"
+#include "ruby/encoding.h"
+
+
+void
+spin(double seconds)
+{
+  CFRunLoopRunInMode(kCFRunLoopDefaultMode, seconds, false);
+}
 
-#ifndef ACCESSIBILITY_BRIDGE
-#define ACCESSIBILITY_BRIDGE 1
 
 #ifdef NOT_MACRUBY
 
@@ -13,6 +18,7 @@ VALUE rb_cCGSize;
 VALUE rb_cCGRect;
 VALUE rb_mURI; // URI module
 VALUE rb_cURI; // URI::Generic class
+VALUE rb_cScreen;
 
 ID sel_x;
 ID sel_y;
@@ -27,24 +33,23 @@ ID sel_to_s;
 ID sel_parse;
 
 
-#define WRAP_ARRAY(wrapper) do {				\
-    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))	\
-		   );	                                        \
-    return ary;							\
-  } while (false);
+void
+cf_finalizer(void* obj)
+{
+  CFRelease((CFTypeRef)obj);
+}
+
+void
+objc_finalizer(void* obj)
+{
+  [(id)obj release];
+}
 
 
 VALUE
 wrap_unknown(CFTypeRef obj)
 {
-  // TODO: this will leak, can we use something like alloca?
+  // TODO: this will leak...
   CFStringRef description = CFCopyDescription(obj);
   rb_raise(
            rb_eRuntimeError,
@@ -99,6 +104,7 @@ unwrap_size(VALUE size)
 }
 
 
+
 VALUE
 wrap_rect(CGRect rect)
 {
@@ -107,6 +113,13 @@ wrap_rect(CGRect rect)
   return rb_struct_new(rb_cCGRect, point, size);
 }
 
+
+VALUE
+coerce_to_rect(VALUE obj)
+{
+  return rb_funcall(obj, sel_to_rect, 0);
+}
+
 CGRect
 unwrap_rect(VALUE rect)
 {
@@ -180,8 +193,7 @@ wrap_value(AXValueRef value)
   switch (AXValueGetType(value))
     {
     case kAXValueIllegalType:
-      // TODO better error message
-      rb_raise(rb_eArgError, "herped when you should have derped");
+      rb_raise(rb_eArgError, "cannot wrap %s objects", rb_class2name(CLASS_OF(value)));
     case kAXValueCGPointType:
       return wrap_value_point(value);
     case kAXValueCGSizeType:
@@ -196,7 +208,7 @@ wrap_value(AXValueRef value)
       // TODO better error message
       rb_raise(
 	       rb_eRuntimeError,
-	       "Could not wrap You've found a bug in something...not sure who to blame"
+	       "Either accessibility_core is out of date or your system has had a serious error"
 	       );
     }
 
@@ -223,17 +235,10 @@ unwrap_value(VALUE value)
 VALUE wrap_array_values(CFArrayRef array) { WRAP_ARRAY(wrap_value) }
 
 
-static
-void
-ref_finalizer(void* obj)
-{
-  CFRelease((CFTypeRef)obj);
-}
-
 VALUE
 wrap_ref(AXUIElementRef ref)
 {
-  return Data_Wrap_Struct(rb_cElement, NULL, ref_finalizer, (void*)ref);
+  return Data_Wrap_Struct(rb_cElement, NULL, cf_finalizer, (void*)ref);
 }
 
 AXUIElementRef
@@ -253,14 +258,38 @@ wrap_string(CFStringRef string)
 {
   // flying by the seat of our pants here, this hasn't failed yet
   // but probably will one day when I'm not looking
-  const char* name = CFStringGetCStringPtr(string, kCFStringEncodingMacRoman);
-  if (name)
-    return rb_str_new(name, CFStringGetLength(string));
-  else
-    // use rb_external_str_new() ? assume always UTF-8?
-    rb_raise(rb_eRuntimeError, "NEED TO IMPLEMNET STRING COPYING");
+  VALUE ruby_string;
+  CFIndex    length = CFStringGetLength(string);
+  char*        name = (char*)CFStringGetCStringPtr(string, kCFStringEncodingMacRoman);
+
+  if (name) {
+    ruby_string = rb_usascii_str_new(name, length);
+  }
+  else {
+    // currently we will always assume UTF-8
+    // perhaps we could use CFStringGetSystemEncoding in the future?
+    name = malloc(length+1);
+    CFStringGetCString(
+		       string,
+		       name,
+		       length+1,
+		       kCFStringEncodingUTF8
+		       );
+    ruby_string = rb_enc_str_new(name, length, rb_utf8_encoding());
+    free(name);
+  }
+
+  return ruby_string;
+}
 
-  return Qnil; // unreachable
+VALUE
+wrap_nsstring(NSString* string)
+{
+  return rb_enc_str_new(
+			[string UTF8String],
+			[string length],
+			rb_utf8_encoding()
+			);
 }
 
 CFStringRef
@@ -279,7 +308,18 @@ unwrap_string(VALUE string)
   /* 				   ); */
 }
 
-VALUE wrap_array_strings(CFArrayRef array) { WRAP_ARRAY(wrap_string) }
+NSString*
+unwrap_nsstring(VALUE string)
+{
+  return (NSString*)unwrap_string(string);
+}
+
+VALUE wrap_array_strings(CFArrayRef array) { WRAP_ARRAY(wrap_string); }
+VALUE wrap_array_nsstrings(NSArray* ary)
+{
+  CFArrayRef array = (CFArrayRef)ary;
+  WRAP_ARRAY(wrap_string);
+}
 
 
 #define WRAP_NUM(type, cookie, macro) do {		        \
@@ -358,12 +398,23 @@ unwrap_number(VALUE number)
 VALUE wrap_array_numbers(CFArrayRef array) { WRAP_ARRAY(wrap_number) }
 
 
+
 VALUE
 wrap_url(CFURLRef url)
 {
+  // @note CFURLGetString does not need to be CFReleased since it is a Get
   return rb_funcall(rb_mURI, sel_parse, 1, wrap_string(CFURLGetString(url)));
 }
 
+VALUE
+wrap_nsurl(NSURL* url)
+{
+  NSString* str = [url absoluteString];
+  VALUE  rb_str = wrap_nsstring(str);
+  [str release];
+  return rb_funcall(rb_mURI, sel_parse, 1, rb_str);
+}
+
 CFURLRef
 unwrap_url(VALUE url)
 {
@@ -387,6 +438,12 @@ wrap_date(CFDateRef date)
   return rb_time_new((time_t)time, 0);
 }
 
+VALUE
+wrap_nsdate(NSDate* date)
+{
+  return wrap_date((CFDateRef)date);
+}
+
 CFDateRef
 unwrap_date(VALUE date)
 {
@@ -446,20 +503,41 @@ to_ruby(CFTypeRef obj)
 CFTypeRef
 to_ax(VALUE obj)
 {
-  // TODO we can better optimize this when running under MacRuby
+  switch (TYPE(obj))
+    {
+    case T_STRING:
+      return unwrap_string(obj);
+    case T_FIXNUM:
+      return unwrap_number(obj);
+    case T_STRUCT:
+      return unwrap_value(obj);
+    case T_FLOAT:
+      return unwrap_number(obj);
+    case T_TRUE:
+    case T_FALSE:
+      return unwrap_boolean(obj);
+    }
+
   VALUE type = CLASS_OF(obj);
-  if      (type == rb_cElement)            return unwrap_ref(obj);
-  else if (type == rb_cString)             return unwrap_string(obj);
-  else if (type == rb_cFixnum)             return unwrap_number(obj);
-  else if (type == rb_cCGPoint)            return unwrap_value(obj);
-  else if (type == rb_cCGSize)             return unwrap_value(obj);
-  else if (type == rb_cCGRect)             return unwrap_value(obj);
-  else if (type == rb_cRange)              return unwrap_value(obj);
-  else if (type == rb_cFloat)              return unwrap_number(obj);
-  else if (type == rb_cTime)               return unwrap_date(obj);
-  else if (type == rb_cURI)                return unwrap_url(obj);
-  else if (obj  == Qtrue || obj == Qfalse) return unwrap_boolean(obj);
-  else                                     return unwrap_unknown(obj);
+  if (type == rb_cTime)
+    return unwrap_date(obj);
+  else if (type == rb_cRange)
+    return unwrap_value_range(obj);
+
+  if (rb_obj_is_kind_of(obj, rb_cURI))
+    return unwrap_url(obj);
+
+  // give up if we get this far
+  return unwrap_unknown(obj);
+}
+
+
+static
+VALUE
+rb_spin(VALUE self, VALUE seconds)
+{
+  spin(NUM2DBL(seconds));
+  return self;
 }
 
 #endif
@@ -481,12 +559,14 @@ Init_bridge()
   sel_to_s     = rb_intern("to_s");
   sel_parse    = rb_intern("parse");
 
-  rb_cCGPoint = rb_const_get(rb_cObject, rb_intern("CGPoint"));
-  rb_cCGSize  = rb_const_get(rb_cObject, rb_intern("CGSize"));
-  rb_cCGRect  = rb_const_get(rb_cObject, rb_intern("CGRect"));
-  rb_mURI     = rb_const_get(rb_cObject, rb_intern("URI"));
-  rb_cURI     = rb_const_get(rb_mURI,    rb_intern("Generic"));
-#endif
-}
+  rb_mAccessibility = rb_define_module("Accessibility");
+  rb_cElement       = rb_define_class_under(rb_mAccessibility, "Element", rb_cObject);
+  rb_cCGPoint       = rb_const_get(rb_cObject, rb_intern("CGPoint"));
+  rb_cCGSize        = rb_const_get(rb_cObject, rb_intern("CGSize"));
+  rb_cCGRect        = rb_const_get(rb_cObject, rb_intern("CGRect"));
+  rb_mURI           = rb_const_get(rb_cObject, rb_intern("URI"));
+  rb_cURI           = rb_const_get(rb_mURI, rb_intern("Generic"));
 
+  rb_define_method(rb_cObject, "spin", rb_spin, 1); // semi-private method
 #endif
+}