accessibility_core 0.1.0

data/ext/accessibility/bridge/ext/accessibility/bridge/extconf.rb

@@ -0,0 +1,22 @@
+require 'mkmf'
+
+$CFLAGS << ' -std=c99 -Wall -Werror -pedantic -ObjC'
+$LIBS   << ' -framework CoreFoundation -framework ApplicationServices -framework Cocoa'
+$LIBS   << ' -framework CoreGraphics' unless `sw_vers -productVersion`.to_f == 10.7
+
+if RUBY_ENGINE == 'macruby'
+  $CFLAGS << ' -fobjc-gc'
+else
+  unless RbConfig::CONFIG["CC"].match /clang/
+    clang = `which clang`.chomp
+    if clang.empty?
+      raise "Clang not installed. Cannot build C extension"
+    else
+      RbConfig::MAKEFILE_CONFIG["CC"]  = clang
+      RbConfig::MAKEFILE_CONFIG["CXX"] = clang
+    end
+  end
+  $CFLAGS << ' -DNOT_MACRUBY'
+end
+
+create_makefile 'accessibility/bridge'

data/ext/accessibility/bridge/lib/accessibility/bridge.rb

@@ -0,0 +1,33 @@
+require 'accessibility/bridge/version'
+
+if RUBY_ENGINE == 'macruby'
+
+  ##
+  # Whether or not we are running on MacRuby
+  def on_macruby?
+    true
+  end
+
+  framework 'Cocoa'
+
+  # A workaround that guarantees that `CGPoint` is defined
+  unless defined? MOUNTAIN_LION_APPKIT_VERSION
+    MOUNTAIN_LION_APPKIT_VERSION = 1187
+  end
+
+  if NSAppKitVersionNumber >= MOUNTAIN_LION_APPKIT_VERSION
+    framework '/System/Library/Frameworks/CoreGraphics.framework'
+  end
+
+  require 'accessibility/bridge/macruby'
+
+else
+
+  def on_macruby?
+    false
+  end
+
+  require 'accessibility/bridge/mri'
+
+end
+

data/ext/accessibility/bridge/lib/accessibility/bridge/common.rb

@@ -0,0 +1,57 @@
+class CGPoint
+  ##
+  # Returns the receiver, since the receiver is already a {CGPoint}
+  #
+  # @return [CGPoint]
+  def to_point
+    self
+  end
+end
+
+class CGSize
+  ##
+  # Returns the receiver, since the receiver is already a {CGSize}
+  #
+  # @return [CGSize]
+  def to_size
+    self
+  end
+end
+
+class CGRect
+  ##
+  # Returns the receiver, since the receiver is already a {CGRect}
+  #
+  # @return [CGRect]
+  def to_rect
+    self
+  end
+end
+
+##
+# accessibility-core extensions to `Array`
+class Array
+  ##
+  # Coerce the first two elements of the receiver into a {CGPoint}
+  #
+  # @return [CGPoint]
+  def to_point
+    CGPoint.new self[0], self[1]
+  end
+
+  ##
+  # Coerce the first two elements of the receiver into a {CGSize}
+  #
+  # @return [CGSize]
+  def to_size
+    CGSize.new self[0], self[1]
+  end
+
+  ##
+  # Coerce the first four elements of the receiver into a {CGRect}
+  #
+  # @return [CGRect]
+  def to_rect
+    CGRect.new CGPoint.new(self[0], self[1]), CGSize.new(self[2], self[3])
+  end
+end

data/ext/accessibility/bridge/lib/accessibility/bridge/macruby.rb

@@ -0,0 +1,185 @@
+require 'accessibility/bridge/common'
+
+##
+# accessibility-core extensions for `NSURL`
+class NSURL
+  ##
+  # Return the reciver, for the receiver is already a URL object
+  #
+  # @return [NSURL]
+  def to_url
+    self
+  end
+
+  # because printing is easier this way
+  alias_method :to_s, :inspect
+end
+
+##
+# accessibility-core extensions for `NSString`
+class NSString
+  ##
+  # Create an NSURL using the receiver as the initialization string
+  #
+  # If the receiver is not a valid URL then `nil` will be returned.
+  #
+  # This exists because of
+  # [rdar://11207662](http://openradar.appspot.com/11207662).
+  #
+  # @return [NSURL,nil]
+  def to_url
+    NSURL.URLWithString self
+  end
+end
+
+##
+# `accessibility-core` extensions for `NSObject`
+class NSObject
+  ##
+  # Return an object safe for passing to AXAPI
+  def to_ax
+    self
+  end
+
+  ##
+  # Return a usable object from an AXAPI pointer
+  def to_ruby
+    self
+  end
+end
+
+##
+# `accessibility-core` extensions for `CFRange`
+class CFRange
+  ##
+  # Convert the {CFRange} to a Ruby {Range} object
+  #
+  # @return [Range]
+  def to_ruby
+    Range.new location, (location + length - 1)
+  end
+end
+
+##
+# `accessibility-core` extensions for `Range`
+class Range
+  # @return [AXValueRef]
+  def to_ax
+    raise ArgumentError, "can't convert negative index" if last < 0 || first < 0
+    length = if exclude_end?
+               last - first
+             else
+               last - first + 1
+             end
+    CFRange.new(first, length).to_ax
+  end
+end
+
+##
+# AXElements extensions to the `Boxed` class
+#
+# The `Boxed` class is simply an abstract base class for structs that
+# MacRuby can use via bridge support.
+class Boxed
+  ##
+  # Returns the number that AXAPI uses in order to know how to wrap
+  # a struct.
+  #
+  # @return [Number]
+  def self.ax_value
+    raise NotImplementedError, "#{inspect}:#{self.class} cannot be wrapped"
+  end
+
+  ##
+  # Create an `AXValueRef` from the `Boxed` instance. This will only
+  # work if for the most common boxed types, you will need to check
+  # the AXAPI documentation for an up to date list.
+  #
+  # @example
+  #
+  #   CGPoint.new(12, 34).to_ax # => #<AXValueRef:0x455678e2>
+  #   CGSize.new(56, 78).to_ax  # => #<AXValueRef:0x555678e2>
+  #
+  # @return [AXValueRef]
+  def to_ax
+    klass = self.class
+    ptr   = Pointer.new klass.type
+    ptr.assign self
+    AXValueCreate(klass.ax_value, ptr)
+  end
+end
+
+# `accessibility-core` extensions for `CFRange`'s metaclass
+class << CFRange
+  # (see Boxed.ax_value)
+  def ax_value; KAXValueCFRangeType end
+end
+# `accessibility-core` extensions for `CGSize`'s metaclass
+class << CGSize
+  # (see Boxed.ax_value)
+  def ax_value; KAXValueCGSizeType end
+end
+# `accessibility-core` extensions for `CGRect`'s metaclass
+class << CGRect
+  # (see Boxed.ax_value)
+  def ax_value; KAXValueCGRectType end
+end
+# `accessibility-core` extensions for `CGPoint`'s metaclass
+class << CGPoint
+  # (see Boxed.ax_value)
+  def ax_value; KAXValueCGPointType end
+end
+
+##
+# Mixin for the special hidden class in MacRuby that represents `AXValueRef`
+#
+# This module adds a `#to_ruby` method that actually unwraps the object from
+# the `AXValueRef` to some sort of {Boxed} object, such as a {CGPoint} or a
+# {Range}.
+module ValueWrapper
+
+
+  ##
+  # Map of type encodings used for unwrapping structs wrapped in an `AXValueRef`
+  #
+  # The list is order sensitive, which is why we unshift nil, but
+  # should probably be more rigorously defined at runtime.
+  #
+  # @return [String,nil]
+  BOX_TYPES = [CGPoint, CGSize, CGRect, CFRange].map!(&:type).unshift(nil)
+
+  ##
+  # Unwrap an `AXValueRef` into the `Boxed` instance that it is supposed
+  # to be. This will only work for the most common boxed types, you will
+  # need to check the AXAPI documentation for an up to date list.
+  #
+  # @example
+  #
+  #   wrapped_point.to_ruby # => #<CGPoint x=44.3 y=99.0>
+  #   wrapped_range.to_ruby # => #<CFRange begin=7 length=100>
+  #   wrapped_thing.to_ruby # => wrapped_thing
+  #
+  # @return [Boxed]
+  def to_ruby
+    type = AXValueGetType(self)
+    return self if type.zero?
+
+    ptr = Pointer.new BOX_TYPES[type]
+    AXValueGetValue(self, type, ptr)
+    ptr.value.to_ruby
+  end
+
+  # hack to find the __NSCFType class and mix things in
+  klass = AXUIElementCreateSystemWide().class
+  klass.send :include, self
+
+end
+
+##
+# `accessibility-core` extensions to `NSArray`
+class NSArray
+  # @return [Array]
+  def to_ruby
+    map do |obj| obj.to_ruby end
+  end
+end

data/ext/accessibility/bridge/lib/accessibility/bridge/mri.rb

@@ -0,0 +1,121 @@
+##
+# A structure that contains a point in a two-dimensional coordinate system
+CGPoint = Struct.new(:x, :y) do
+
+  # @param x [Number]
+  # @param y [Number]
+  def initialize x = 0.0, y = 0.0
+    super
+  end
+
+  # @!attribute [rw] x
+  #   The `x` co-ordinate of the screen point
+  #   @return [Number]
+
+  # @!attribute [rw] y
+  #   The `y` co-ordinate of the screen point
+  #   @return [Number]
+
+  ##
+  # Return a nice string representation of the point
+  #
+  # Overrides `Object#inspect` to more closely mimic MacRuby `Boxed#inspect`.
+  #
+  # @return [String]
+  def inspect
+    "#<CGPoint x=#{self.x.to_f} y=#{self.y.to_f}>"
+  end
+
+end
+
+
+##
+# A structure that contains the size of a rectangle in a 2D co-ordinate system
+CGSize = Struct.new(:width, :height) do
+
+  # @param width [Number]
+  # @param height [Number]
+  def initialize width = 0.0, height = 0.0
+    super
+  end
+
+  # @!attribute [rw] width
+  #   The `width` of the box
+  #   @return [Number]
+
+  # @!attribute [rw] height
+  #   The `heighth` of the box
+  #   @return [Number]
+
+  ##
+  # Return a nice string representation of the size
+  #
+  # Overrides `Object#inspect` to more closely mimic MacRuby `Boxed#inspect`.
+  #
+  # @return [String]
+  def inspect
+    "#<CGSize width=#{self.width.to_f} height=#{self.height.to_f}>"
+  end
+
+end
+
+
+##
+# Complete definition of a rectangle in a 2D coordinate system
+CGRect = Struct.new(:origin, :size) do
+
+  # @param origin [CGPoint,#to_point]
+  # @param size [CGSize,#to_size]
+  def initialize origin = CGPoint.new, size = CGSize.new
+    super(origin.to_point, size.to_size)
+  end
+
+  # @!attribute [rw] origin
+  #   The `origin` point
+  #   @return [CGPoint,#to_point]
+
+  # @!attribute [rw] size
+  #   The `size` of the rectangle
+  #   @return [CGSize,#to_size]
+
+  ##
+  # Return a nice string representation of the rectangle
+  #
+  # Overrides `Object#inspect` to more closely mimic MacRuby `Boxed#inspect`.
+  #
+  # @return [String]
+  def inspect
+    "#<CGRect origin=#{self.origin.inspect} size=#{self.size.inspect}>"
+  end
+
+end
+
+
+require 'uri'
+
+##
+# `accessibility-core` extensions to the `URI` family of classes
+class URI::Generic
+  ##
+  # Returns the receiver (since the receiver is already a `URI` object)
+  #
+  # @return [URI::Generic]
+  def to_url
+    self
+  end
+end
+
+##
+# `accessibility-core` extensions to the `String` class
+class String
+  ##
+  # Parse the receiver into a `URI` object
+  #
+  # @return [URI::Generic]
+  def to_url
+    URI.parse self
+  end
+end
+
+
+require 'accessibility/bridge/common'

data/ext/accessibility/bridge/lib/accessibility/bridge/version.rb

@@ -0,0 +1,6 @@
+module Accessibility
+  module Bridge
+    # @return [String]
+    VERSION = '0.1.0'
+  end
+end

data/ext/accessibility/bridge/test/array_test.rb

@@ -0,0 +1,31 @@
+require 'test/helper'
+
+class ArrayTest < MiniTest::Unit::TestCase
+
+  def test_to_point
+    x, y = rand_nums 2
+    p = [x, y].to_point
+    assert_kind_of CGPoint, p
+    assert_equal x, p.x
+    assert_equal y, p.y
+  end
+
+  def test_to_size
+    w, h = rand_nums 2
+    s = [w, h].to_size
+    assert_kind_of CGSize, s
+    assert_equal w, s.width
+    assert_equal h, s.height
+  end
+
+  def test_to_rect
+    x, y, w, h = rand_nums 4
+    r = [x, y, w, h].to_rect
+    assert_kind_of CGRect, r
+    assert_equal x, r.origin.x
+    assert_equal y, r.origin.y
+    assert_equal w, r.size.width
+    assert_equal h, r.size.height
+  end
+
+end