rubyosa 0.1.0

data/src/rbosa.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2006, Apple Computer, Inc. All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1.  Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer. 
+ * 2.  Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution. 
+ * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
+ *     its contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission. 
+ * 
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __RBOSA_H_
+#define __RBOSA_H_
+
+#include "osx_ruby.h"
+#include <Carbon/Carbon.h>
+#include <sys/param.h>
+
+/* rbosa_sdef.c */
+VALUE rbosa_scripting_info (VALUE self, VALUE criterion, VALUE value);
+
+/* rbosa_conv.c */
+FourCharCode rbobj_to_fourchar (VALUE obj);
+VALUE rbosa_four_char_code (VALUE self, VALUE val);
+void rbobj_to_alias_handle (VALUE obj, AliasHandle *alias);
+
+/* helper macros */
+#define RVAL2CSTR(x)        (StringValueCStr (x))
+#define CSTR2RVAL(x)        (rb_str_new2 (x))
+#define RVAL2CBOOL(x)       (RTEST(x))
+#define CBOOL2RVAL(x)       (x ? Qtrue : Qfalse)
+#define RVAL2FOURCHAR(x)    (rbobj_to_fourchar(x))
+
+#endif /* __RBOSA_H_ */

data/src/rbosa_conv.c

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2006, Apple Computer, Inc. All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1.  Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer. 
+ * 2.  Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution. 
+ * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
+ *     its contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission. 
+ * 
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "rbosa.h"
+
+FourCharCode
+rbobj_to_fourchar (VALUE obj)
+{
+    FourCharCode result = 0;
+
+#define USAGE_MSG "requires 4 length size string/symbol or integer"
+
+    if (rb_obj_is_kind_of (obj, rb_cInteger)) {
+        result = NUM2UINT (obj);
+    }
+    else {
+        if (rb_obj_is_kind_of (obj, rb_cSymbol))
+            obj = rb_obj_as_string (obj);
+
+        if (rb_obj_is_kind_of (obj, rb_cString)) {
+            if (RSTRING (obj)->len != 4)
+                rb_raise (rb_eArgError, USAGE_MSG);
+            result = *(FourCharCode*)(RSTRING (obj)->ptr);
+            result = CFSwapInt32HostToBig (result);
+        }
+        else {
+            rb_raise (rb_eArgError, USAGE_MSG);
+        }
+    }
+
+#undef USAGE_MSG
+
+    return result;
+}
+
+VALUE
+rbosa_four_char_code (VALUE self, VALUE val)
+{
+    return INT2NUM (RVAL2FOURCHAR (val));
+}
+
+void
+rbobj_to_alias_handle (VALUE obj, AliasHandle *alias)
+{
+    FSRef       ref;
+    CFURLRef    URL;
+    Boolean     ok;
+    OSErr       error;
+
+    Check_Type (obj, T_STRING);
+    *alias = NULL;
+
+    URL = CFURLCreateFromFileSystemRepresentation (kCFAllocatorDefault, 
+                                                   (const UInt8 *)RSTRING (obj)->ptr, 
+                                                   RSTRING (obj)->len,
+                                                   0 /* XXX: normally passing 0 even if it's a directory should
+                                                        not hurt, as we are just getting the FSRef. */); 
+    if (URL == NULL)
+        rb_raise (rb_eArgError, "Invalid path given");
+    ok = CFURLGetFSRef (URL, &ref);
+    CFRelease (URL);
+    if (ok) {
+        error = FSNewAlias (NULL, &ref, alias);
+        if (error != noErr)
+            rb_raise (rb_eArgError, "Cannot create alias handle for given filename '%s' : %s (%d)",
+                      RSTRING (obj)->ptr, GetMacOSStatusErrorString (error), error); 
+    }
+    else {
+        rb_raise (rb_eArgError, "Cannot obtain the filesystem reference for given filename '%s'",
+                  RSTRING (obj)->ptr);
+    }
+}

data/src/rbosa_sdef.c

@@ -0,0 +1,150 @@
+/*
+ * Copyright (c) 2006, Apple Computer, Inc. All rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1.  Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer. 
+ * 2.  Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution. 
+ * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
+ *     its contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission. 
+ * 
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <ApplicationServices/ApplicationServices.h>
+#include <CoreFoundation/CoreFoundation.h>
+#include <unistd.h>
+#include "rbosa.h"
+
+static void 
+rbosa_app_name_signature (CFURLRef URL, VALUE *name, VALUE *signature)
+{
+    CFBundleRef     bundle;
+    CFDictionaryRef info;
+    CFStringRef     str;
+
+    bundle = CFBundleCreate (kCFAllocatorDefault, URL);
+    info = CFBundleGetInfoDictionary (bundle);
+    
+    if (NIL_P(*name)) {
+        str = CFDictionaryGetValue (info, CFSTR ("CFBundleName"));
+        if (str == NULL) {
+            /* Try 'CFBundleExecutable' if 'CFBundleName' does not exist (which is a bug). */
+            str = CFDictionaryGetValue (info, CFSTR ("CFBundleExecutable"));
+        }
+        *name = str != NULL ? CSTR2RVAL (CFStringGetCStringPtr (str, CFStringGetFastestEncoding (str))) : Qnil;
+    }
+    if (NIL_P(*signature)) {
+        str = CFDictionaryGetValue (info, CFSTR ("CFBundleSignature"));
+        *signature = str != NULL ? CSTR2RVAL (CFStringGetCStringPtr (str, CFStringGetFastestEncoding (str))) : Qnil;
+    }
+
+    CFRelease (bundle);
+}
+
+static bool 
+rbosa_translate_app (VALUE criterion, VALUE value, VALUE *app_signature, VALUE *app_name, FSRef *fs_ref, const char **error)
+{
+    OSStatus    err;
+    CFURLRef    URL;
+
+    *app_name = Qnil;
+    *app_signature = Qnil;
+    err = noErr;
+ 
+    if (criterion == ID2SYM (rb_intern ("by_signature"))) {
+        err = LSFindApplicationForInfo (RVAL2FOURCHAR (value), NULL, NULL, fs_ref, &URL);
+        *app_signature = value; /* Don't need to get the app signature, we already have it. */
+    }
+    else { 
+        CFMutableStringRef  str;
+        
+        str = CFStringCreateMutable (kCFAllocatorDefault, 0);
+        CFStringAppendCString (str, RVAL2CSTR (value), kCFStringEncodingUTF8);
+
+        if (criterion == ID2SYM (rb_intern ("by_path"))) {
+            err = FSPathMakeRef ((const UInt8 *)RVAL2CSTR (value), fs_ref, NULL);
+            if (err == noErr) {
+                URL = CFURLCreateWithFileSystemPath (kCFAllocatorDefault, str, kCFURLPOSIXPathStyle, FALSE);
+            }
+        }
+        else if (criterion == ID2SYM (rb_intern ("by_name"))) {
+            CFStringRef dot_app;
+            
+            dot_app = CFSTR (".app");
+            if (!CFStringHasSuffix (str, dot_app))
+                CFStringAppend (str, dot_app);
+   
+            err = LSFindApplicationForInfo (kLSUnknownCreator, NULL, str, fs_ref, &URL);
+            *app_name = value; /* Don't need to get the app name, we already have it. */
+        }
+        else if (criterion == ID2SYM (rb_intern ("by_bundle_id"))) {
+            err = LSFindApplicationForInfo (kLSUnknownCreator, str, NULL, fs_ref, &URL);
+        }
+        else {
+            *error = "Invalid criterion";
+            CFRelease (str);
+            return FALSE;
+        }
+        
+        CFRelease (str);
+    }
+    
+    if (err != noErr) {
+        *error = "Error when translating the application";
+        return FALSE;
+    }
+
+    rbosa_app_name_signature (URL, app_name, app_signature);
+    
+    CFRelease (URL);
+
+    if (NIL_P (*app_signature)) {
+        *error = "Error when getting the application signature";
+        return FALSE;
+    }
+ 
+    return TRUE;
+}
+
+VALUE
+rbosa_scripting_info (VALUE self, VALUE criterion, VALUE value)
+{
+    const char *    error;
+    VALUE           ary;
+    VALUE           name;  
+    VALUE           signature;
+    FSRef           fs;
+    OSAError        osa_error;
+    CFDataRef       sdef_data;
+
+    if (!rbosa_translate_app (criterion, value, &signature, &name, &fs, &error))
+        rb_raise (rb_eRuntimeError, error);
+ 
+    osa_error = OSACopyScriptingDefinition (&fs, kOSAModeNull, &sdef_data);
+    if (osa_error != noErr)
+        rb_raise (rb_eRuntimeError, "Cannot get scripting definition : error %d", osa_error);
+
+    ary = rb_ary_new3 (3, name, signature, 
+                       rb_str_new ((const char *)CFDataGetBytePtr (sdef_data), 
+                                   CFDataGetLength (sdef_data)));
+
+    CFRelease (sdef_data);
+
+    return ary;
+}

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: rubyosa
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-10-25 00:00:00 +02:00
+summary: A Ruby/AppleEvent bridge.
+require_paths: 
+- lib
+email: lsansonetti@apple.com
+homepage: http://rubyosa.rubyforge.org
+rubyforge_project: rubyosa
+description: RubyOSA is a bridge that connects Ruby to the Apple Event Manager, automatically populating the API according to the target application's scriptable definition.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Laurent Sansonetti
+files: 
+- README
+- COPYRIGHT
+- AUTHORS
+- extconf.rb
+- src/rbosa.c
+- src/rbosa.h
+- src/rbosa_conv.c
+- src/rbosa_sdef.c
+- src/lib/rbosa.rb
+- sample/Finder_show_desktop.rb
+- sample/iChat_uptime.rb
+- sample/iTunes_control.rb
+- sample/iTunes_fade_volume.rb
+- sample/iTunes_inspect.rb
+- sample/QT_playall.rb
+- sample/sdef.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- rdoc-osa
+extensions: 
+- extconf.rb
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.8
+    version: