rb-appscript 0.4.0 → 0.5.0

data/src/lib/_aem/mactypes.rb

@@ -11,21 +11,6 @@ module MacTypes
 	require "kae"
 	
 	class FileBase
-	
-		URLPrefix = 'file://localhost'
-		URLPatt = Regexp.new('file://.*?(/.*)', Regexp::IGNORECASE)
-	
-		def FileBase._path_to_url(path)
-			return URLPrefix + path.gsub(/[^a-zA-Z0-9_.-\/]/) { |c| "%%%02x" % c[0] }
-		end
-	
-		def FileBase._url_to_path(url)
-			match = url.match(URLPatt)
-			if not match
-				raise ArgumentError, "Not a file:// URL."
-			end
-			return match[1].gsub(/%../) { |s| "%c" % s[1,2].hex }
-		end
 		
 		def FileBase._coerce(desc, type, path=nil)
 			begin
@@ -72,13 +57,20 @@ module MacTypes
 		def Alias.path(path)
 			# Make Alias object from POSIX path.
 			return new(FileBase._coerce(
-					AE::AEDesc.new(KAE::TypeFileURL, FileBase._path_to_url(path)),
+					AE::AEDesc.new(KAE::TypeFileURL, AE.convert_posix_path_to_url(path)),
+					KAE::TypeAlias, path))
+		end
+		
+		def Alias.hfs_path(path)
+			# Make Alias object from HFS path.
+			return new(FileBase._coerce(
+					AE::AEDesc.new(KAE::TypeFileURL, AE.convert_hfs_path_to_url(path)),
 					KAE::TypeAlias, path))
 		end
 		
 		def Alias.url(url)
 			# Make Alias object from file URL. Note: only the path portion of the URL is used; the domain will always be localhost.
-			return Alias.path(_url_to_path(url))
+			return Alias.path(AE.convert_url_to_posix_path(url))
 		end
 		
 		def Alias.desc(desc)
@@ -97,7 +89,12 @@ module MacTypes
 		
 		def path
 			# Get as POSIX path.
-			return FileBase._url_to_path(FileBase._coerce(@desc, KAE::TypeFileURL).data)
+			return AE.convert_url_to_posix_path(FileBase._coerce(@desc, KAE::TypeFileURL).data)
+		end
+		
+		def hfs_path
+			# Get as HFS path.
+			return AE.convert_url_to_hfs_path(FileBase._coerce(@desc, KAE::TypeFileURL).data)
 		end
 		
 		alias_method :to_s, :path
@@ -136,9 +133,14 @@ module MacTypes
 			return new(path, nil)
 		end
 		
+		def FileURL.hfs_path(path)
+			# Make FileURL object from HFS path.
+			return new(AE.convert_url_to_posix_path(AE.convert_hfs_path_to_url(path)), nil)
+		end
+		
 		def FileURL.url(url)
 			# Make FileURL object from file URL. Note: only the path portion of the URL is used; the domain will always be localhost.
-			return FileURL.path(_url_to_path(url))
+			return FileURL.path(AE.convert_url_to_posix_path(url))
 		end
 		
 		def FileURL.desc(desc)
@@ -151,7 +153,7 @@ module MacTypes
 		def desc
 			# Get as AEDesc. If constructed from Ruby, descriptor's type is always typeFileURL; if returned by aem, its type mat be typeFSS, typeFSRef or typeFileURL.
 			if not @desc
-				@desc = AE::AEDesc.new(KAE::TypeFileURL, FileBase._path_to_url(@path))
+				@desc = AE::AEDesc.new(KAE::TypeFileURL, AE.convert_posix_path_to_url(@path))
 			end
 			return @desc
 		end
@@ -164,11 +166,15 @@ module MacTypes
 		def path
 			# Get as POSIX path.
 			if not @path
-				@path = FileBase._url_to_path(FileBase._coerce(@desc, KAE::TypeFileURL).data)
+				@path = AE.convert_url_to_posix_path(FileBase._coerce(@desc, KAE::TypeFileURL).data)
 			end
 			return @path
 		end
 		
+		def hfs_path
+			return AE.convert_url_to_hfs_path(AE.convert_posix_path_to_url(path))
+		end
+		
 		alias_method :to_s, :path
 		
 		def inspect

data/src/lib/_appscript/reservedkeywords.rb

@@ -74,6 +74,7 @@ ReservedKeywords = [
 	"is_a?",
 	"is_in",
 	"is_not_in",
+	"is_running?",
 	"its",
 	"keywords",
 	"kind_of?",

data/src/lib/aem.rb

@@ -23,6 +23,8 @@ module AEM
 	Codecs = Codecs
 	DefaultCodecs = DefaultCodecs
 	MacOSError = AE::MacOSError
+	CantLaunchApplicationError = Connect::CantLaunchApplicationError
+	
 	
 	AEDesc = AE::AEDesc
 	
@@ -56,7 +58,7 @@ module AEM
 	#######
 	# Application class
 	
-	class Application
+	class Application < AEMReference::Base
 		# Identifies an application and provides an #event method for constructing Apple events targetted at it.
 	
 		require "weakref"
@@ -102,12 +104,37 @@ module AEM
 		
 		def Application.launch(path)
 			# Launches a local application without sending it the usual 'run' event (aevtoapp).
-			Connect.launch_app(path)
+			Connect.launch_app_with_launch_event(path)
+		end
+		
+		def Application.is_running?(path) # TO DO: delete
+			$stderr.puts('Warning! AEM::Application.is_running? is deprecated; use process_exists_for_path? instead.')
+			return Connect.process_exists_for_path?(path)
+		end
+		
+		def Application.process_exists_for_path?(path)
+			# Does a local process launched from the specified application file exist?
+			# Note: if path is invalid, an AE::MacOSError is raised.
+			return Connect.process_exists_for_path?(path)
+		end
+	
+		def Application.process_exists_for_pid?(pid)
+			# Is there a local application process with the given unix process id?
+			return Connect.process_exists_for_pid?(pid)
 		end
 		
-		def Application.is_running?(path)
-			# Checks if a local application is running.
-			return Connect.is_running?(path)
+		def Application.process_exists_for_url?(url)
+			# Does an application process specified by the given eppc:// URL exist?
+			# Returns false if process doesn't exist or if access to it isn't allowed.
+			# (Implementation note: this method sends an Apple event to the specified process and checks for errors.)
+			return Connect.process_exists_for_url?(url)
+		end
+		
+		def Application.process_exists_for_desc?(desc)
+			# Does an application process specified by the given AEAddressDesc exist?
+			# Returns false if process doesn't exist or if access to it isn't allowed.
+			# (Implementation note: this method sends an Apple event to the specified process and checks for errors.)
+			return Connect.process_exists_for_desc?(desc)
 		end
 		
 		#######
@@ -161,6 +188,14 @@ module AEM
 		
 		# (hash method is provided by attr_reader :hash)
 		
+		def AEM_comparable
+			return ['AEMApplication', @identity]
+		end
+		
+		def AEM_pack_self(codecs)
+			return @address_desc
+		end
+		
 		def reconnect
 			# If application has quit since this Application object was created, its AEAddressDesc
 			# is no longer valid so this Application object will not work even when application is restarted.

data/src/lib/appscript.rb

@@ -5,8 +5,11 @@
 require "_aem/mactypes"
 
 module Appscript
+
+	Version = '0.5.0'
+
 	# The following methods and classes are of interest to end users:
-	# app, con, its, CommandError, ApplicationNotFoundError
+	# app, con, its, CommandError, ApplicationNotFoundError, CantLaunchApplicationError
 	# Other classes are only of interest to implementors who need to hook in their own code.
 	
 	require "kae"
@@ -26,7 +29,7 @@ module Appscript
 	
 	class AppData < AEM::Codecs
 	
-		HelpAgentID = 'net.sourceforge.appscript.appscripthelpagent'
+		ASDictionaryBundleID = 'net.sourceforge.appscript.asdictionary'
 	
 		attr_reader :constructor, :identifier, :reference_codecs
 		attr_writer :reference_codecs
@@ -75,25 +78,35 @@ module Appscript
 			:current => 'current',
 		}
 		
-		def _make_help_agent
+		def _init_help_agent
 			begin
-				@_help_agent = AEM::Application.by_path(FindApp.by_id(HelpAgentID))
+				apppath = FindApp.by_id(ASDictionaryBundleID)
+				asdictionary_is_running = AEM::Application.process_exists_for_path?(apppath)
+				@_help_agent = AEM::Application.by_path(apppath)
+				if not asdictionary_is_running # hide ASDictionary after launching it # TO DO: something less kludgy
+					AEM::Application.by_path(FindApp.by_id('com.apple.systemevents')).event('coresetd', {
+							'----' => AEM.app.elements('prcs').by_name('ASDictionary').property('pvis'), 
+							'data' => false}).send
+					sleep(1) # KLUDGE: need a short delay here to workaround ASDictionary 0.9.0's event handling glitches # TO DO: delete after ASDictionary is fixed
+				end
 				return true
-			rescue FindApp::ApplicationNotFoundError
-				puts "No help available: AppscriptHelpAgent.app not found."
-				return false
+			rescue FindApp::ApplicationNotFoundError => e
+				$stderr.puts("No help available: ASDictionary application not found (#{e}).")
+			rescue AEM::CantLaunchApplicationError => e
+				$stderr.puts("No help available: can't launch ASDictionary application (#{e}).")
 			end
+			return false
 		end
 		
 		def _display_help(flags, ref)
 			begin
-				puts @_help_agent.event('ASHAHelp', {
+				$stderr.puts(@_help_agent.event('AppSHelp', {
 						'Cons' => Constructors[@constructor],
-						'Iden' => @constructor == :by_aem_app ? @identifier.address_desc : @identifier,
+						'Iden' => @identifier,
 						'Styl' => 'rb-appscript',
 						'Flag' => flags,
 						'aRef' => pack(ref),
-					}).send
+					}).send)
 				return nil
 			rescue AEM::CommandError => e
 				return e
@@ -101,15 +114,25 @@ module Appscript
 		end
 		
 		def help(flags, ref)
-			if not @_help_agent
-				return ref if not _make_help_agent
-			end
-			e = _display_help(flags, ref)
-			if e and [-600, -609].include?(e.number) # not running
-				return ref if not _make_help_agent
+			begin
+				if not @_help_agent
+					return ref if not _init_help_agent
+				end
 				e = _display_help(flags, ref)
+				if e and [-600, -609].include?(e.number) # not running
+					return ref if not _init_help_agent
+					e = _display_help(flags, ref)
+				end
+				if e
+					if e.number == -1708 # event wasn't handled, presumably because available ASDictionary is too old
+						$stderr.puts("No help available: ASDictionary 0.9.0 or later required.")
+					else
+						$stderr.puts("No help available: ASDictionary raised an error: #{e}.")
+					end
+				end
+			rescue => err
+				$stderr.puts("No help available: unknown error: #{err}")
 			end
-			puts "No help available: AppscriptHelpAgent raised an error: #{e}." if e
 			return ref
 		end
 		
@@ -298,9 +321,9 @@ module Appscript
 			s= @_call[0]
 			@_call[1, @_call.length].each do |name, args|					if name == :[]
 					if args.length == 1
-						s += "[#{args[0]}]"
+						s += "[#{args[0].inspect}]"
 					else
-						s += "[#{args[0]}, #{args[1]}]"
+						s += "[#{args[0].inspect}, #{args[1].inspect}]"
 					end
 				else
 					if args.length > 0
@@ -485,7 +508,7 @@ module Appscript
 			rescue => e
 				if e.is_a?(AEM::CommandError)
 					if [-600, -609].include?(e.number) and @AS_app_data.constructor == :by_path
-						if not AEM::Application.is_running?(@AS_app_data.identifier)
+						if not AEM::Application.process_exists_for_path?(@AS_app_data.identifier)
 							if code == 'ascrnoop'
 								AEM::Application.launch(@AS_app_data.identifier)
 							elsif code != 'aevtoapp'
@@ -510,8 +533,8 @@ module Appscript
 		#######
 		# introspection
 	
-		def respond_to?(name)
-			if super 
+		def respond_to?(name, includePriv=false)
+			if Object.respond_to?(name)
 				return true
 			else
 				return @AS_app_data.reference_by_name.has_key?(name.is_a?(String) ? name.intern : name)
@@ -519,7 +542,7 @@ module Appscript
 		end
 		
 		def methods
-			return super + @AS_app_data.reference_by_name.keys.collect { |name| name.to_s }
+			return (Object.instance_methods + @AS_app_data.reference_by_name.keys.collect { |name| name.to_s }).uniq
 		end
 		
 		def commands
@@ -571,24 +594,73 @@ module Appscript
 		
 		alias_method :inspect, :to_s
 		
+		#######
+		# Utility methods
+		
+		def is_running?
+			identifier = @AS_app_data.identifier
+			case @AS_app_data.constructor
+				when :by_path
+					return AEM::Application.process_exists_for_path?(identifier)
+				when :by_pid
+					return AEM::Application.process_exists_for_pid?(identifier)
+				when :by_url
+					return AEM::Application.process_exists_for_url?(identifier)
+				when :by_aem_app
+					return AEM::Application.process_exists_for_desc?(identifier.address_desc)
+			else # when :current
+				return true
+			end
+		end
+		
 		#######
 		# Public properties and methods; these are called by end-user and other clients (e.g. generic references)
 		
 		def method_missing(name, *args)
 			selector_type, code = @AS_app_data.reference_by_name[name]
-			case selector_type
+			case selector_type # check if name is a property/element/command name, and if it is handle accordingly
 				when :property
 					return Reference.new(@AS_app_data, @AS_aem_reference.property(code))
 				when :element
 					return Reference.new(@AS_app_data, @AS_aem_reference.elements(code))
 				when :command
 					return _send_command(args, name, code[0], code[1])
-			else
-				msg = "Unknown property, element or command: '#{name}'"
-				if @AS_app_data.reference_by_name.has_key?("#{name}_".intern)
-					msg += " (Did you mean '#{name}_'?)"
+			else 
+				# see if it's a method that has been added to Object class [presumably] at runtime, but excluded
+				# by AE_SafeObject to avoid potential conflicts with property/element/command names
+				begin
+					# Notes:
+					# rb-appscript has to prevent arbitrary methods that are added to Ruby's base Object class
+					# by client code from automatically appearing in Appscript::Reference as well, as these new
+					# methods may inadvertently mask property/element/command names, causing appscript to
+					# behave incorrectly. However, once it is confirmed that a given method will not mask an existing 
+					# property/element/command name, it can be added retrospectively to the Reference instance
+					# upon which it was called, which is what happens here.
+					# 
+					# This means that methods such as #pretty_print and #pretty_inspect, which are
+					# injected into Object when the 'pp' module is loaded, will still be available in appscript
+					# references, even though they are not on AS_SafeObject's official list of permitted methods,
+					# *as long as* properties/elements/commands of the same name do not already exist for that
+					# reference. 
+					#
+					# Where properties/elements/commands of the same name do already exist, appscript
+					# will still defer to those, of course, and this may cause problems for the caller if
+					# they were wanting the other behaviour. (But, that's the risk one runs with any sort
+					# of subclassing exercise when the contents of the superclass are not known for certain
+					# beforehand.) Clients that require access to these methods will need to add their names
+					# to the ReservedKeywords list (see _appscript/reservedkeywords.rb) at runtime, thereby
+					# forcing appscript to append underscores to the conflicting property/element/command
+					# names in order to disambiguate them, and modifying any code that refers to those
+					# properties/elements/commands accordingly.
+					meth = Object.instance_method(name)
+				rescue NameError # message not handled
+					msg = "Unknown property, element or command: '#{name}'"
+					if @AS_app_data.reference_by_name.has_key?("#{name}_".intern)
+						msg += " (Did you mean '#{name}_'?)"
+					end
+					raise RuntimeError, msg
 				end
-				raise RuntimeError, msg
+				return meth.bind(self).call(*args)
 			end
 		end
 		
@@ -785,6 +857,8 @@ module Appscript
 				return ref.AS_resolve(@AS_app_data)
 			elsif ref.is_a?(AEMReference::Base)
 				return Reference.new(@AS_app_data, ref)
+			elsif ref == nil
+				return  Reference.new(@AS_app_data, AEM.app)
 			else
 				return Reference.new(@AS_app_data, AEM.custom_root(ref))
 			end
@@ -924,6 +998,6 @@ module Appscript
 		end
 	end
 	
-	
 	ApplicationNotFoundError = FindApp::ApplicationNotFoundError
+	CantLaunchApplicationError = Connect::CantLaunchApplicationError
 end

data/src/lib/kae.rb

@@ -1485,4 +1485,5 @@ module KAE
 	# new in 10.5
 	TypeUInt16 = 'ushr'
 	TypeUInt64 = 'ucom'
+	TypeCFAbsoluteTime = 'cfat'
 end

data/src/lib/osax.rb

@@ -23,18 +23,22 @@ module OSAX
 	OSAXCache = {}
 	OSAXNames = []
 	
-	se = Appscript.app.by_id('com.apple.systemevents')
-	[se.system_domain, se.local_domain, se.user_domain].each do |domain|
-		osaxen = domain.scripting_additions_folder.files[
-				Appscript.its.file_type.eq('osax').or(Appscript.its.name_extension.eq('osax'))]
-		osaxen.name.get.zip(osaxen.POSIX_path.get).each do |name, path|
-			name = name.sub(/(?i)\.osax$/, '') # remove name extension, if any
-			OSAXNames.push(name)
-			OSAXCache[name.downcase] = [path, nil]
+	se = AEM::Application.by_path(FindApp.by_id('com.apple.systemevents'))
+	['flds', 'fldl', 'fldu'].each do |domain_code|
+		osaxen = AEM.app.property(domain_code).property('$scr').elements('file').by_filter(
+				AEM.its.property('asty').eq('osax').or(AEM.its.property('extn').eq('osax')))
+		if se.event('coredoex', {'----' => osaxen.property('pnam')}).send # domain has ScriptingAdditions folder
+			names = se.event('coregetd', {'----' => osaxen.property('pnam')}).send
+			paths = se.event('coregetd', {'----' => osaxen.property('posx')}).send
+			names.zip(paths).each do |name, path|
+				name = name.sub(/(?i)\.osax$/, '') # remove name extension, if any
+				OSAXNames.push(name)
+				OSAXCache[name.downcase] = [path, nil]
+			end
 		end
 	end
 	OSAXNames.sort!.uniq!
-	
+
 	#######
 	# modified AppData class
 	
@@ -122,28 +126,40 @@ module OSAX
 	class ScriptingAddition < Appscript::Reference
 		# Represents a single scripting addition.
 		
-		def initialize(name, osax_data=nil)
+		def initialize(name, terms=nil)
 			# name: string -- a scripting addition's name, e.g. "StandardAdditions";
 			#	basically its filename minus the '.osax' suffix
 			#
+			# terms : module or nil -- an optional terminology glue module,
+			#	as exported by Terminology.dump; if given, ScriptingAddition
+			#	will use this instead of retrieving the terminology dynamically
+			#
 			# Note that name is case-insensitive and an '.osax' suffix is ignored if given.
 			@_osax_name = name
-			if not osax_data
+			if not terms
 				osax_name = name.downcase.sub(/(?i)\.osax$/, '')
-				path, terms = OSAXCache[osax_name]
+				path, terminology_tables = OSAXCache[osax_name]
 				if not path
 					raise ArgumentError, "Scripting addition not found: #{name.inspect}"
 				end
-				if not terms
-					aetes_desc = AE.get_app_terminology(path) # will raise NotImplementedError in 64-bit processes
+				if not terminology_tables
+					begin
+						aetes_desc = AE.get_app_terminology(path) # will raise NotImplementedError in 64-bit processes
+					rescue NotImplementedError
+						raise RuntimeError, "OSAX::ScriptingAddition can't dynamically retrieve scripting addition terminology within a 64-bit process."
+					end
 					aetes = DefaultCodecs.unpack(aetes_desc.coerce(KAE::TypeAEList))
-					terms = Terminology.tables_for_aetes(aetes)
-					OSAXCache[osax_name][1] = terms
+					terminology_tables = Terminology.tables_for_aetes(aetes)
+					OSAXCache[osax_name][1] = terminology_tables
 				end
-				@_terms = terms
-				osax_data = OSAXData.new(:current, nil, @_terms)
+				@_terms = terminology_tables
+				terms = OSAXData.new(:current, nil, @_terms)
+			elsif not terms.is_a?(OSAX::OSAXData) # assume it's a glue module
+				terminology_tables = Terminology.tables_for_module(terms)
+				@_terms = terminology_tables
+				terms = OSAXData.new(:current, nil, @_terms)
 			end
-			super(osax_data, AEM.app)
+			super(terms, AEM.app)
 		end
 		
 		def to_s