rubyosa 0.2.0 → 0.3.0

data/src/lib/rbosa_properties.rb

@@ -0,0 +1,136 @@
+# Copyright (c) 2006-2007, Apple 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 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.
+
+require 'enumerator'
+
+module OSA
+  @sym_to_code = {}
+  @code_to_sym = {}
+
+  def self.add_property(sym, code)
+    return if @sym_to_code.has_key?(sym) or @code_to_sym.has_key?(code)
+    @sym_to_code[sym] = code
+    @code_to_sym[code] = sym
+  end
+
+  def self.sym_to_code(sym)
+    @sym_to_code[sym]
+  end
+
+  def self.code_to_sym(code)
+    @code_to_sym[code]
+  end
+end
+
+[
+  # pArcAngle
+  :arc_angle, 'parc',
+  :background_color, 'pbcl',
+  :background_pattern, 'pbpt',
+  :best_type, 'pbst',
+  :bounds, 'pbnd',
+  :class, 'pcls',
+  :clipboard, 'pcli',
+  :color, 'colr',
+  :color_table, 'cltb',
+  :contents, 'pcnt',
+  :corner_curve_height, 'pchd',
+  :corner_curve_width, 'pcwd',
+  :dash_style, 'pdst',
+  :default_type, 'deft',
+  :definition_rect, 'pdrt',
+  :enabled, 'enbl',
+  :end_point, 'pend',
+  :fill_color, 'flcl',
+  :fill_pattern, 'flpt',
+  :font, 'font',
+
+  # pFormula
+  :formula, 'pfor',
+  :graphic_objects, 'gobs',
+  :has_close_box, 'hclb',
+  :has_title_bar, 'ptit',
+  :id, 'ID  ',
+  :index, 'pidx',
+  :insertion_loc, 'pins',
+  :is_floating, 'isfl',
+  :is_front_process, 'pisf',
+  :is_modal, 'pmod',
+  :is_modified, 'imod',
+  :is_resizable, 'prsz',
+  :is_stationery_pad, 'pspd',
+  :is_zoomable, 'iszm',
+  :is_zoomed, 'pzum',
+  :item_number, 'itmn',
+  :justification, 'pjst',
+  :line_arrow, 'arro',
+  :menu_id, 'mnid',
+  :name, 'pnam',
+
+  # pNewElementLoc
+  :new_element_loc, 'pnel',
+  :pen_color, 'ppcl',
+  :pen_pattern, 'pppa',
+  :pen_width, 'ppwd',
+  :pixel_depth, 'pdpt',
+  :point_list, 'ptlt',
+  :point_size, 'ptsz',
+  :protection, 'ppro',
+  :rotation, 'prot',
+  :scale, 'pscl',
+  :script, 'scpt',
+  :script_tag, 'psct',
+  :selected, 'selc',
+  :selection, 'sele',
+  :start_angle, 'pang',
+  :start_point, 'pstp',
+  :text_color, 'ptxc',
+  :text_font, 'ptxf',
+  :text_item_delimiters, 'txdl',
+  :text_point_size, 'ptps',
+
+  # pScheme
+  :scheme, 'pusc',
+  :host, 'HOST',
+  :path, 'FTPc',
+  :user_name, 'RAun',
+  :user_password, 'RApw',
+  :dns_form, 'pDNS',
+  :url, 'pURL',
+  :text_encoding, 'ptxe',
+  :ftp_kind, 'kind',
+
+  # pTextStyles
+  :text_styles, 'txst',
+  :transfer_mode, 'pptm',
+  :translation, 'ptrs',
+  :uniform_styles, 'ustl',
+  :update_on, 'pupd',
+  :user_selection, 'pusl',
+  :version, 'vers',
+  :visible, 'pvis'
+
+].each_slice(2) { |sym, code| OSA.add_property(sym, code) }

data/src/rbosa.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006, Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2006-2007, Apple Inc. All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -9,7 +9,7 @@
  * 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
+ * 3.  Neither the name of Apple 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. 
  * 
@@ -38,8 +38,6 @@ static VALUE mOSAEventDispatcher;
 static ID sClasses;
 static ID sApp;
 
-#define INSPECT_AEDESC 0
-
 static void
 rbosa_element_free (void *ptr)
 {
@@ -170,7 +168,7 @@ rbosa_element_new (VALUE self, VALUE type, VALUE value)
     error = AECreateDesc (ffc_type, c_value, c_value_size, &desc);
     if (error != noErr)     
         rb_raise (rb_eArgError, "Cannot create Apple Event descriptor from type '%s' value '%s' : %s (%d)", 
-                  RVAL2CSTR (type), c_value, GetMacOSStatusErrorString (error), error);
+                  RVAL2CSTR (type), c_value, error_code_to_string (error), error);
 
     return rbosa_element_make (self, &desc, Qnil);
 }
@@ -190,11 +188,27 @@ rbosa_element_new_os (VALUE self, VALUE desired_class, VALUE container, VALUE ke
 
     if (error != noErr) 
         rb_raise (rb_eArgError, "Cannot create Apple Event object specifier for desired class '%s' : %s (%d)", 
-                  RVAL2CSTR (desired_class), GetMacOSStatusErrorString (error), error);
+                  RVAL2CSTR (desired_class), error_code_to_string (error), error);
 
     return rbosa_element_make (self, &obj_specifier, Qnil);
 }
 
+static VALUE
+rbosa_element_dup (VALUE self, VALUE element)
+{
+    AEDesc *  desc;
+    AEDesc    new_desc;
+    OSErr     error;
+
+    desc = rbosa_element_aedesc (element);
+    error = AEDuplicateDesc (desc, &new_desc);
+    if (error != noErr) 
+        rb_raise (rb_eArgError, "Cannot duplicate element : %s (%d)", 
+                  error_code_to_string (error), error);
+
+    return rbosa_element_make (self, &new_desc, Qnil); 
+}
+
 static void
 __rbosa_raise_potential_app_error (AEDesc *reply)
 {
@@ -202,20 +216,23 @@ __rbosa_raise_potential_app_error (AEDesc *reply)
     AEDesc  errorNumDesc;
     AEDesc  errorStringDesc;
     int     errorNum;
+    const char *  errorMsg;
     char    exception[128];
 
-    if (AEGetParamDesc (reply, keyErrorNumber, typeInteger, &errorNumDesc) != noErr)
+    if (AEGetParamDesc (reply, keyErrorNumber, typeSInt32, &errorNumDesc) != noErr)
         return; 
 
-    if (AEGetDescData (&errorNumDesc, &errorNum, sizeof errorNum) != noErr
-        || (errorNum = CFSwapInt32HostToBig (errorNum)) == 0) {
-
+    if (AEGetDescData (&errorNumDesc, &errorNum, sizeof errorNum) != noErr) {
         AEDisposeDesc (&errorNumDesc);
         return;
     }
 
     /* The reply is an application error. */
 
+    errorMsg = error_code_to_string(errorNum);
+    if (errorMsg == NULL)
+        errorMsg = "Unknown error";
+
     exception[0] = '\0';
     error = AEGetParamDesc (reply, keyErrorString, typeChar, &errorStringDesc);
     if (error == noErr) {
@@ -225,10 +242,12 @@ __rbosa_raise_potential_app_error (AEDesc *reply)
         if (size > 0) {
             char *msg;
 
-            msg = (char *)malloc (size);
+            msg = (char *)malloc (size + 1);
             if (msg != NULL) {
-                if (AEGetDescData (&errorStringDesc, &msg, size) == noErr)
-                    snprintf (exception, sizeof exception, "application returned error %d with message '%s'", errorNum, msg);
+                if (AEGetDescData (&errorStringDesc, msg, size) == noErr) {
+                    msg[size] = '\0';
+                    snprintf (exception, sizeof exception, "application returned error: %s (%d), with message: %s", errorMsg, errorNum, msg);
+                }
                 free (msg);
             }
         }
@@ -236,7 +255,7 @@ __rbosa_raise_potential_app_error (AEDesc *reply)
     }
 
     if (exception[0] == '\0')
-        snprintf (exception, sizeof exception, "application returned error %d", errorNum);
+        snprintf (exception, sizeof exception, "application returned error: %s (%d)", errorMsg, errorNum);
 
     AEDisposeDesc (&errorNumDesc);
 
@@ -251,6 +270,7 @@ rbosa_app_send_event (VALUE self, VALUE event_class, VALUE event_id, VALUE param
     AppleEvent  reply;
     VALUE       rb_timeout;
     SInt32      timeout;
+    VALUE       rb_reply;
 
     error = AECreateAppleEvent (RVAL2FOURCHAR (event_class),
                                 RVAL2FOURCHAR (event_id),
@@ -260,7 +280,7 @@ rbosa_app_send_event (VALUE self, VALUE event_class, VALUE event_id, VALUE param
                                 &ae);
     if (error != noErr)
         rb_raise (rb_eArgError, "Cannot create Apple Event '%s%s' : %s (%d)", 
-                  RVAL2CSTR (event_class), RVAL2CSTR (event_id), GetMacOSStatusErrorString (error), error);
+                  RVAL2CSTR (event_class), RVAL2CSTR (event_id), error_code_to_string (error), error);
 
     if (!NIL_P (params)) {
         unsigned    i;
@@ -281,7 +301,7 @@ rbosa_app_send_event (VALUE self, VALUE event_class, VALUE event_id, VALUE param
             if (error != noErr) { 
                 AEDisposeDesc (&ae); 
                 rb_raise (rb_eArgError, "Cannot add Apple Event parameter '%s' : %s (%d)", 
-                          RVAL2CSTR (type), GetMacOSStatusErrorString (error), error);
+                          RVAL2CSTR (type), error_code_to_string (error), error);
             }
         } 
     }
@@ -289,28 +309,31 @@ rbosa_app_send_event (VALUE self, VALUE event_class, VALUE event_id, VALUE param
     rb_timeout = rb_iv_get (mOSA, "@timeout");
     timeout = NIL_P (rb_timeout) ? kAEDefaultTimeout : NUM2INT (rb_timeout);
    
-    error = AESend (&ae, &reply, (RVAL2CBOOL(need_retval) ? kAEWaitReply : kAENoReply) | kAENeverInteract | kAECanSwitchLayer,
+    error = AESend (&ae, &reply, (RVAL2CBOOL(need_retval) ? kAEWaitReply : kAENoReply) | kAECanInteract | kAECanSwitchLayer,
                     kAENormalPriority, timeout, NULL, NULL);
 
     AEDisposeDesc (&ae); 
 
     if (error != noErr)
         rb_raise (rb_eRuntimeError, "Cannot send Apple Event '%s%s' : %s (%d)", 
-                  RVAL2CSTR (event_class), RVAL2CSTR (event_id), GetMacOSStatusErrorString (error), error);
+                  RVAL2CSTR (event_class), RVAL2CSTR (event_id), error_code_to_string (error), error);
 
     __rbosa_raise_potential_app_error (&reply);
 
     if (RTEST (need_retval)) {
-        VALUE   rb_reply;
         AEDesc  replyObject;
 
         AEGetParamDesc (&reply, keyDirectObject, typeWildCard, &replyObject);
 
         rb_reply = rbosa_element_make (cOSAElement, &replyObject, self);
-        
-        return rb_reply; 
     }
-    return Qnil;
+    else {
+        rb_reply = Qnil;
+    }
+
+    AEDisposeDesc (&reply);
+        
+    return rb_reply;
 }
 
 static VALUE
@@ -349,7 +372,7 @@ rbosa_element_data (int argc, VALUE *argv, VALUE self)
         error = AECoerceDesc (desc, code, &coerced_desc);
         if (error != noErr)
             rb_raise (rb_eRuntimeError, "Cannot coerce desc to type %s : %s (%d)", 
-                      RVAL2CSTR (coerce_type), GetMacOSStatusErrorString (error), error);
+                      RVAL2CSTR (coerce_type), error_code_to_string (error), error);
         
         desc = &coerced_desc;
         to_4cc = code == 'type';
@@ -376,11 +399,42 @@ rbosa_element_data (int argc, VALUE *argv, VALUE self)
 
     if (error != noErr)
         rb_raise (rb_eRuntimeError, "Cannot get desc data : %s (%d)", 
-                  GetMacOSStatusErrorString (error), error);
+                  error_code_to_string (error), error);
     
     return retval; 
 }
 
+static VALUE
+__rbosa_insertion_loc_new (VALUE rcv, FourCharCode code)
+{
+    AEDesc *  self_desc;
+    AEDesc    rec;
+    AEDesc    pos_desc;
+    AEDesc    new_desc;
+
+    self_desc = rbosa_element_aedesc (rcv);
+    AECreateList (NULL, 0, true, &rec);
+    AEPutParamDesc (&rec, keyAEObject, self_desc);
+    AECreateDesc (code, NULL, 0, &pos_desc);
+    AEPutParamPtr (&rec, keyAEPosition, typeEnumerated, &pos_desc, 4);
+    AECoerceDesc (&rec, typeInsertionLoc, &new_desc);
+    AEDisposeDesc (&rec);
+
+    return rbosa_element_make (cOSAElement, &new_desc, Qnil);
+}
+
+static VALUE
+rbosa_element_after (VALUE self)
+{
+    return __rbosa_insertion_loc_new (self, kAEAfter); 
+}
+
+static VALUE
+rbosa_element_before (VALUE self)
+{
+    return __rbosa_insertion_loc_new (self, kAEBefore);
+}
+
 static VALUE
 rbosa_element_eql (VALUE self, VALUE other)
 {
@@ -432,25 +486,22 @@ bails:
     return CBOOL2RVAL (ok);
 }
 
-#if INSPECT_AEDESC
 static VALUE
 rbosa_element_inspect (VALUE self)
 {
     Handle  h;
-    VALUE   s;
     char    buf[1024];
 
-    s = rb_call_super (0, NULL);
-    if (AEPrintDescToHandle (rbosa_element_aedesc (self), &h) != noErr)
-        return s;
+    if (AEPrintDescToHandle (rbosa_element_aedesc (self), &h) != noErr) {
+      snprintf (buf, sizeof buf, "<%s:%p>", rb_obj_classname (self), (void *)self);
+    }
+    else {
+      snprintf (buf, sizeof buf, "<%s:%p desc=\"%s\">", rb_obj_classname (self), (void *)self, *h);
+      DisposeHandle (h);
+    }
     
-    RSTRING(s)->ptr[RSTRING(s)->len - 1] = '\0';
-    snprintf (buf, sizeof buf, "%s aedesc=\"%s\">", RSTRING(s)->ptr, *h);
-    DisposeHandle (h);
-
     return CSTR2RVAL (buf);
 }
-#endif
 
 static long
 __rbosa_elementlist_count (AEDescList *list)
@@ -461,7 +512,7 @@ __rbosa_elementlist_count (AEDescList *list)
     error = AECountItems (list, &count);
     if (error != noErr)
         rb_raise (rb_eRuntimeError, "Cannot count items : %s (%d)", 
-                  GetMacOSStatusErrorString (error), error);
+                  error_code_to_string (error), error);
 
     return count;
 }
@@ -474,7 +525,7 @@ __rbosa_elementlist_add (AEDescList *list, VALUE element, long pos)
     error = AEPutDesc (list, pos, rbosa_element_aedesc (element));
     if (error != noErr)
         rb_raise (rb_eRuntimeError, "Cannot add given descriptor : %s (%d)", 
-                  GetMacOSStatusErrorString (error), error);
+                  error_code_to_string (error), error);
 }
 
 static VALUE
@@ -493,7 +544,7 @@ rbosa_elementlist_new (int argc, VALUE *argv, VALUE self)
     error = AECreateList (NULL, 0, false, &list);
     if (error != noErr) 
         rb_raise (rb_eRuntimeError, "Cannot create Apple Event descriptor list : %s (%d)", 
-                  GetMacOSStatusErrorString (error), error);
+                  error_code_to_string (error), error);
 
     if (!NIL_P (ary)) {
         for (i = 0; i < RARRAY (ary)->len; i++)
@@ -528,7 +579,7 @@ __rbosa_elementlist_get (VALUE self, long index, AEKeyword *keyword)
     
     if (error != noErr)
         rb_raise (rb_eRuntimeError, "Cannot get desc at index %d : %s (%d)", 
-                  index, GetMacOSStatusErrorString (error), error);
+                  index, error_code_to_string (error), error);
 
     return rbosa_element_make (cOSAElement, &desc, rb_ivar_get (self, sApp));
 }
@@ -554,7 +605,7 @@ __rbosa_elementrecord_set (VALUE key, VALUE value, AEDescList *list)
     error = AEPutKeyDesc (list, RVAL2FOURCHAR (key), rbosa_element_aedesc (value));
     if (error != noErr) 
         rb_raise (rb_eRuntimeError, "Cannot set value %p for key %p of record %p: %s (%d)", 
-                  value, key, list, GetMacOSStatusErrorString (error), error);
+                  value, key, list, error_code_to_string (error), error);
  
     return ST_CONTINUE;
 }
@@ -574,7 +625,7 @@ rbosa_elementrecord_new (int argc, VALUE *argv, VALUE self)
     error = AECreateList (NULL, 0, true, &list);
     if (error != noErr) 
         rb_raise (rb_eRuntimeError, "Cannot create Apple Event descriptor list : %s (%d)", 
-                  GetMacOSStatusErrorString (error), error);
+                  error_code_to_string (error), error);
 
     if (!NIL_P (hash)) 
         rb_hash_foreach (hash, __rbosa_elementrecord_set, (VALUE)&list);
@@ -620,18 +671,20 @@ Init_osa (void)
     sApp = rb_intern ("@app");
 
     mOSA = rb_define_module ("OSA");
-    rb_define_module_function (mOSA, "__scripting_info__", rbosa_scripting_info, 2); 
+    rb_define_module_function (mOSA, "__scripting_info__", rbosa_scripting_info, 1); 
+    rb_define_module_function (mOSA, "__remote_processes__", rbosa_remote_processes, 1); 
     rb_define_module_function (mOSA, "__four_char_code__", rbosa_four_char_code, 1);
 
     cOSAElement = rb_define_class_under (mOSA, "Element", rb_cObject);
     rb_define_singleton_method (cOSAElement, "__new__", rbosa_element_new, 2);
     rb_define_singleton_method (cOSAElement, "__new_object_specifier__", rbosa_element_new_os, 4);
+    rb_define_singleton_method (cOSAElement, "__duplicate__", rbosa_element_dup, 1);
     rb_define_method (cOSAElement, "__type__", rbosa_element_type, 0);
     rb_define_method (cOSAElement, "__data__", rbosa_element_data, -1);
+    rb_define_method (cOSAElement, "before", rbosa_element_before, 0);
+    rb_define_method (cOSAElement, "after", rbosa_element_after, 0);
     rb_define_method (cOSAElement, "==", rbosa_element_eql, 1);
-#if INSPECT_AEDESC
     rb_define_method (cOSAElement, "inspect", rbosa_element_inspect, 0);
-#endif
 
     cOSAElementList = rb_define_class_under (mOSA, "ElementList", cOSAElement);
     rb_define_singleton_method (cOSAElementList, "__new__", rbosa_elementlist_new, -1);
@@ -650,4 +703,5 @@ Init_osa (void)
     rbosa_define_param ("timeout", INT2NUM (kAEDefaultTimeout));
     rbosa_define_param ("lazy_events", Qtrue);
     rbosa_define_param ("utf8_strings", Qfalse);
+    rbosa_define_param ("wait_reply", Qnil);
 }