rb-appscript 0.3.0 → 0.4.0

data/src/SendThreadSafe.h

@@ -0,0 +1,139 @@
+/*
+    File:       AESendThreadSafe.h
+
+    Contains:   Code to send Apple events in a thread-safe manner.
+
+    Written by: DTS
+
+    Copyright:  Copyright (c) 2007 Apple Inc. All Rights Reserved.
+
+    Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc.
+                ("Apple") in consideration of your agreement to the following
+                terms, and your use, installation, modification or
+                redistribution of this Apple software constitutes acceptance of
+                these terms.  If you do not agree with these terms, please do
+                not use, install, modify or redistribute this Apple software.
+
+                In consideration of your agreement to abide by the following
+                terms, and subject to these terms, Apple grants you a personal,
+                non-exclusive license, under Apple's copyrights in this
+                original Apple software (the "Apple Software"), to use,
+                reproduce, modify and redistribute the Apple Software, with or
+                without modifications, in source and/or binary forms; provided
+                that if you redistribute the Apple Software in its entirety and
+                without modifications, you must retain this notice and the
+                following text and disclaimers in all such redistributions of
+                the Apple Software. Neither the name, trademarks, service marks
+                or logos of Apple Inc. may be used to endorse or promote
+                products derived from the Apple Software without specific prior
+                written permission from Apple.  Except as expressly stated in
+                this notice, no other rights or licenses, express or implied,
+                are granted by Apple herein, including but not limited to any
+                patent rights that may be infringed by your derivative works or
+                by other works in which the Apple Software may be incorporated.
+
+                The Apple Software is provided by Apple on an "AS IS" basis. 
+                APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
+                WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
+                MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING
+                THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
+                COMBINATION WITH YOUR PRODUCTS.
+
+                IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT,
+                INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+                TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+                DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY
+                OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
+                OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY
+                OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
+                OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF
+                SUCH DAMAGE.
+
+    Change History (most recent first):
+
+$Log: AESendThreadSafe.h,v $
+Revision 1.2  2007/02/12 11:58:43         
+Corrected grammo in comment.
+
+Revision 1.1  2007/02/09 10:55:27         
+First checked in.
+
+
+*/
+
+/*
+
+2007/06/24 -- Modified by HAS to make AESendMessageThreadSafeSynchronous API-compatible with AESendMessage.
+
+*/
+
+#ifndef _SENDTHREADSAFE_H
+#define _SENDTHREADSAFE_H
+
+#include <ApplicationServices/ApplicationServices.h>
+
+/////////////////////////////////////////////////////////////////
+
+/*
+    Introduction
+    ------------
+    Since Mac OS X 10.2 it has been possible to synchronously send an Apple event 
+    from a thread other than the main thread.  The technique for doing this is 
+    documented in Technote 2053 "Mac OS X 10.2".
+    
+    <http://developer.apple.com/technotes/tn2002/tn2053.html>
+    
+    Unfortunately, this technique isn't quite right.  Specifically, due to a bug 
+    in Apple Event Manager <rdar://problem/4976113>, it is not safe to dispose of 
+    the Mach port (using mach_port_destroy, as documented in the technote, or, more 
+    correctly, using mach_port_mod_refs) that you created to use as the reply port. 
+    Doing this triggers a race condition that, very rarely, can cause the system 
+    to destroy some other, completely unrelated, Mach port within your process.  
+    This could cause all sorts of problems.  One common symptom is that, after 
+    accidentally destroying the Mach port associated with a thread, your program 
+    dies with the following message:
+    
+    /SourceCache/Libc/Libc-320.1.3/pthreads/pthread.c:897: failed assertion `ret == MACH_MSG_SUCCESS'
+    
+    The best workaround to this problem is to not dispose of the Mach port that 
+    you use as the Apple event reply port.  If you have a limited number of 
+    secondary threads from which you need to send Apple events, it's relatively 
+    easy to allocate an Apple event reply port for each thread and then never 
+    dispose it.  However, if you have general case code, it might be tricky 
+    to track down all of the threads that send Apple events and make sure they 
+    have reply ports.  This module was designed as a general case solution to 
+    the problem.
+    
+    The module exports a single function, AESendMessageThreadSafeSynchronous, which, 
+    as its name suggests, sends an Apple event and waits for the reply (that is, 
+    a synchronous IPC) and is safe to call from an arbitrary thread.  It's basically 
+    a wrapper around the system function AESendMessage, with added smarts to manage 
+    a per-thread Apple event reply port.
+    
+    When <rdar://problem/4976113> is fixed, this module should be unnecessary but 
+    benign.
+    
+    For information about how this works, see the comments in the implementation.
+*/
+
+/////////////////////////////////////////////////////////////////
+
+#ifdef __cplusplus
+    extern "C" {
+#endif
+
+OSStatus SendMessageThreadSafe(
+	AppleEvent *            eventPtr,
+    AppleEvent *            replyPtr,
+	AESendMode              sendMode,
+    long                    timeOutInTicks
+);
+    // A thread-safe replacement for AESend.  This is very much like AESendMessage, 
+    // except that it takes care of setting up the reply port when you use it 
+    // from a thread other than the main thread.
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

data/src/lib/_aem/aemreference.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby
+#!/usr/local/bin/ruby -w
 # Copyright (C) 2006 HAS. 
 # Released under MIT License.
 
@@ -83,6 +83,10 @@ module AEMReference
 	
 	class Base
 	
+		def initialize
+			@_comparable = nil
+		end
+	
 		def AEM_comparable
 			# called by Base#==; returns the data needed to compare two aem references
 			if not @_comparable
@@ -122,6 +126,8 @@ module AEMReference
 		protected :_key, :_container
 	
 		def initialize(container, key)
+			super()
+			@_desc = nil
 			@_container = container
 			@_key = key
 		end
@@ -163,7 +169,7 @@ module AEMReference
 	class InsertionSpecifier < Specifier
 		# A reference to an element insertion point.
 		
-		# Syntax: all_elements_ref.start / all_elements_ref.end / element_ref.before / element_ref.after
+		# Syntax: all_elements_ref.beginning / all_elements_ref.end / element_ref.before / element_ref.after
 		
 		def initialize(container, key, keyname)
 			super(container, key)
@@ -256,8 +262,8 @@ module AEMReference
 			return LessOrEquals.new(self, val)
 		end
 		
-		def starts_with(val)
-			return StartsWith.new(self, val)
+		def begins_with(val)
+			return BeginsWith.new(self, val)
 		end
 		
 		def ends_with(val)
@@ -296,8 +302,8 @@ module AEMReference
 		# Thes can be called on any kind of element reference, and also on property references where the 
 		# property represents a one-to-one relationship, e.g. textedit.documents[1].text.end is valid
 			
-		def start
-			return InsertionSpecifier.new(self, Beginning, :start)
+		def beginning
+			return InsertionSpecifier.new(self, Beginning, :beginning)
 		end
 		
 		def end
@@ -591,18 +597,12 @@ module AEMReference
 		# Syntax: elements_ref.by_filter(test)
 		
 		# The test argument is a Test object constructed from an its-based reference.
-		# For convenience, an its-based reference can also be passed directly - this will
-		# be expanded to a Boolean equality test, e.g. AEM.its.visible -> AEM.its.visible.eq(true)
 	
 		KeyForm = AEMReference.pack_enum(KAE::FormTest)
 		
 		def initialize(wantcode, container, key)
 			if not key.is_a?(Test)
-				if key.is_a?(Specifier) and key.AEM_root == Its
-					key = key.eq(true)
-				else
-					raise TypeError, "Bad selector: not a test (its) based specifier: #{key.inspect}"
-				end
+				raise TypeError, "Bad selector: not a test (its) based specifier: #{key.inspect}"
 			end
 			super(wantcode, container.AEM_true_self, key)
 		end
@@ -730,6 +730,7 @@ module AEMReference
 	
 	class DeferredSpecifier < Base
 		def initialize(desc, codecs)
+			@_ref = nil
 			@_desc = desc
 			@_codecs   = codecs
 		end
@@ -792,6 +793,7 @@ module AEMReference
 		protected :_operand1, :_operand2
 	
 		def initialize(operand1, operand2)
+			super()
 			@_operand1 = operand1
 			@_operand2 = operand2
 		end
@@ -851,8 +853,8 @@ module AEMReference
 		Operator = AEMReference.pack_enum(KAE::KAELessThanEquals)
 	end
 	
-	class StartsWith < ComparisonTest
-		Name = :starts_with
+	class BeginsWith < ComparisonTest
+		Name = :begins_with
 		Operator = AEMReference.pack_enum(KAE::KAEBeginsWith)
 	end
 	
@@ -886,6 +888,7 @@ module AEMReference
 		protected :_operands
 	
 		def initialize(operands)
+			super()
 			@_operands = operands
 		end
 			
@@ -942,6 +945,7 @@ module AEMReference
 	class ReferenceRoot < PositionSpecifier
 	
 		def initialize
+			super(nil, nil, nil)
 		end
 		
 		def to_s
@@ -968,7 +972,7 @@ module AEMReference
 	class ApplicationRoot < ReferenceRoot
 		# Reference base; represents an application's application object. Used to construct full references.
 		
-		# Syntax: app
+		# Syntax: AEM.app
 		
 		Name = :app
 		Type = AE::AEDesc.new(KAE::TypeNull, '')
@@ -978,7 +982,7 @@ module AEMReference
 	class CurrentContainer < ReferenceRoot
 		# Reference base; represents elements' container object. Used to construct by-range references.
 		
-		# Syntax: con
+		# Syntax: AEM.con
 		
 		Name = :con
 		Type = AE::AEDesc.new(KAE::TypeCurrentContainer, '')
@@ -988,13 +992,37 @@ module AEMReference
 	class ObjectBeingExamined < ReferenceRoot
 		# Reference base; represents an element to be tested. Used to construct by-filter references.
 		
-		# Syntax: its
+		# Syntax: AEM.its
 		
 		Name = :its
 		Type = AE::AEDesc.new(KAE::TypeObjectBeingExamined, '')
 	end
 	
 	
+	class CustomRoot < ReferenceRoot
+		# Reference base; represents an arbitrary root object, e.g. an AEAddressDesc in a fully qualified reference
+		
+		# Syntax: AEM.custom_root(value)
+		
+		def initialize(value)
+			@value = value
+			super()
+		end
+		
+		def to_s
+			return "AEM.custom_root(#{@value.inspect})"
+		end
+		
+		def _pack_self(codecs)
+			return codecs.pack(@value)
+		end
+		
+		def AEM_resolve(obj)
+			return obj.send(:custom_root, @value)
+		end
+	end
+	
+	
 	###################################
 	# Reference root objects; used to construct new specifiers, e.g. AEM.app.property('pnam')
 	

data/src/lib/_aem/codecs.rb

@@ -138,7 +138,7 @@ class Codecs
 		# e.g. Adobe apps define additional unit types (ciceros, pixels, etc.)
 		@unit_type_codecs.add_types(type_defs)
 	end
-	
+
 	######################################################################
 	# Subclasses could override these to provide their own reference roots if needed
 	
@@ -151,6 +151,7 @@ class Codecs
 	
 	SInt32Bounds = (-2**31)..(2**31-1)
 	SInt64Bounds = (-2**63)..(2**63-1)
+	UInt64Bounds = (2**63)..(2**64-1)
 
 	NullDesc = AE::AEDesc.new(KAE::TypeNull, '')
 	TrueDesc = AE::AEDesc.new(KAE::TypeTrue, '')
@@ -218,6 +219,8 @@ class Codecs
 					AE::AEDesc.new(KAE::TypeSInt32, [val].pack('l')) 
 				elsif SInt64Bounds === val
 					AE::AEDesc.new(KAE::TypeSInt64, [val].pack('q'))
+				elsif UInt64Bounds === val
+					pack_uint64(val)
 				else
 					AE::AEDesc.new(KAE::TypeFloat, [val.to_f].pack('d'))
 				end
@@ -235,6 +238,16 @@ class Codecs
 	
 	#######
 	
+	def pack_uint64(val) 
+		# On 10.5+, clients could override this method to do a non-lossy conversion,
+		# (assuming target app knows how to handle new UInt64 type):
+		#
+		# def pack_uint64(val)
+		# 	AE::AEDesc.new(KAE::TypeUInt64, [val.to_f].pack('Q'))
+		# end
+		AE::AEDesc.new(KAE::TypeFloat, [val.to_f].pack('d')) # pack as 64-bit float for compatibility (lossy conversion)
+	end
+	
 	def pack_array(val)
 		lst = AE::AEDesc.new_list(false)
 		val.each do |item|
@@ -352,6 +365,9 @@ class Codecs
 				"#{vers}.#{subvers}.#{patch}"
 				
 			when KAE::TypeBoolean then desc.data != "\000"
+			
+			when KAE::TypeUInt16 then desc.data.unpack('S')[0] # 10.5+
+			when KAE::TypeUInt64 then desc.data.unpack('Q')[0] # 10.5+
 		else
 			did_unpack, val = @unit_type_codecs.unpack(desc)
 			if did_unpack
@@ -427,7 +443,7 @@ class Codecs
 	InsertionLocEnums = {
 			Codecs.four_char_code(KAE::KAEBefore) => 'before', 
 			Codecs.four_char_code(KAE::KAEAfter) => 'after', 
-			Codecs.four_char_code(KAE::KAEBeginning) => 'start',
+			Codecs.four_char_code(KAE::KAEBeginning) => 'beginning',
 			Codecs.four_char_code(KAE::KAEEnd) => 'end',
 			}
 
@@ -437,7 +453,7 @@ class Codecs
 			Codecs.four_char_code(KAE::KAEEquals) => 'eq',
 			Codecs.four_char_code(KAE::KAELessThan) => 'lt',
 			Codecs.four_char_code(KAE::KAELessThanEquals) => 'le',
-			Codecs.four_char_code(KAE::KAEBeginsWith) => 'starts_with',
+			Codecs.four_char_code(KAE::KAEBeginsWith) => 'begins_with',
 			Codecs.four_char_code(KAE::KAEEndsWith) => 'ends_with',
 			Codecs.four_char_code(KAE::KAEContains) => 'contains',
 			}

data/src/lib/_aem/mactypes.rb

@@ -1,4 +1,4 @@
-#!/usr/local/bin/ruby
+#!/usr/local/bin/ruby -w
 # Copyright (C) 2006 HAS. 
 # Released under MIT License.
 
@@ -61,7 +61,6 @@ module MacTypes
 		#
 		# Since Ruby doesn't already bridge the Mac OS's Alias Manager, simplest solution is to always store data internally as an AEDesc of typeAlias, and convert this to other forms on demand (e.g. when casting to string).
 		
-		attr_reader :desc
 		private_class_method :new
 		
 		def initialize(desc)
@@ -89,10 +88,7 @@ module MacTypes
 		
 		# Methods
 		
-		def desc
-			# Return AEDesc of typeAlias. If clients want a different type, they can subsequently call this AEDesc's coerce method.
-			return @desc
-		end
+		attr_reader :desc # Return AEDesc of typeAlias. If clients want a different type, they can subsequently call this AEDesc's coerce method.
 		
 		def url
 			# Get as URL string.

data/src/lib/_aem/send.rb

@@ -160,7 +160,7 @@ module Send
 		
 		def _send_apple_event(flags, timeout)
 			# Hook method; may be overridden to customise how events are sent.
-			return @AEM_event.send(flags, timeout)
+			return @AEM_event.send_thread_safe(flags, timeout)
 		end
 		
 		def inspect

data/src/lib/_aem/typewrappers.rb

@@ -10,7 +10,7 @@ module TypeWrappers
 		
 		def initialize(code)
 			if not (code.is_a?(String) and code.length == 4)
-				raise ArgumentError, "Code must be a four-character string: #{code}"
+				raise ArgumentError, "Code must be a four-character string: #{code.inspect}"
 			end
 			@code = code
 		end
@@ -26,7 +26,7 @@ module TypeWrappers
 		alias_method :eql?, :== 
 			
 		def to_s
-			return "AEM::#{self.class::Name}.new(#{@code.dump})"
+			return "AEM::#{self.class::Name}.new(#{@code.inspect})"
 		end
 		
 		def inspect

data/src/lib/_appscript/referencerenderer.rb

@@ -75,6 +75,12 @@ class ReferenceRenderer
 	
 	##
 	
+	def custom_root(value)
+		app
+		@result += ".AS_new_reference(#{value.inspect})"
+		return self
+	end
+	
 	def app
 		case @_app_data.constructor
 			when :current
@@ -99,8 +105,8 @@ class ReferenceRenderer
 	
 	##
 	
-	def start
-		@result += ".start"
+	def beginning
+		@result += ".beginning"
 		return self
 	end
 	
@@ -173,8 +179,8 @@ class ReferenceRenderer
 		return self
 	end
 	
-	def starts_with(val)
-		@result += ".starts_with(#{_format(val)})"
+	def begins_with(val)
+		@result += ".begins_with(#{_format(val)})"
 		return self
 	end