rb-scpt 1.0.0

data/sample/Select_all_HTML_files.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Selects all .htm/.html files in the top Finder window.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+finder = app('Finder')
+finder.activate
+folder = finder.Finder_windows[1].target.get
+folder.files[its.name_extension.is_in(['htm', 'html'])].select

data/sample/Set_iChat_status.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# Set iChat's status message to the name of the currently selected
+# iTunes track.
+#
+# Based on an AppleScript example from:
+# <http://developer.apple.com/cocoa/applescriptforapps.html>
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+begin
+	track_name = app("iTunes").current_track.name.get
+rescue CommandError => e
+	if e.to_i == -1728 # Can't get reference.
+		track_name = 'No track selected.'
+	else
+		raise
+	end
+end
+app("iChat").status_message.set(track_name)

data/sample/Simple_Finder_GUI_Scripting.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# Opens a new Finder smart folder that searches for 'ruby', via GUI Scripting
+
+# (Note: to use GUI Scripting, 'Enable access for assistive devices' option must
+# be enabled in the Universal Access panel of System Preferences.)
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require 'appscript'
+include Appscript
+
+se = app('System Events')
+
+app('Finder').activate
+se.keystroke('n', :using=>[:command_down, :option_down])
+se.keystroke('ruby')

data/sample/Stagger_Finder_windows.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# Rearranges Finder windows diagonally across screen with title bars one above
+# another. (Could easily be adapted to work with any scriptable application
+# that uses standard window class terminology.)
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+x, y = 0, 44
+offset  = 22
+
+# Get list of window references, ignoring any minimised windows
+window_list = app('Finder').windows[its.collapsed.not].get
+
+# Move windows while preserving their original sizes
+window_list.reverse.each do |window|
+    x1, y1, x2, y2 = window.bounds.get
+    window.bounds.set([x, y, x2 - x1 + x, y2 - y1 + y])
+    x += offset
+    y += offset
+end

data/sample/TextEdit_demo.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+
+# Demonstrates various references and commands in action.
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require "appscript"
+include Appscript
+
+textedit = app('TextEdit') # get an application object for TextEdit
+
+
+# tell application "TextEdit" to activate
+textedit.activate
+
+
+# tell application "TextEdit" to make new document at end of documents
+textedit.documents.end.make(:new => :document)
+
+
+# tell application "TextEdit" to set text of document 1 to "Hello World\n"
+textedit.documents[1].text.set('Hello World\n')
+
+
+# tell application "TextEdit" to get a reference to every window
+p textedit.windows
+
+
+# tell application "TextEdit" to get a reference to document 1
+p textedit.documents
+
+
+# tell application "TextEdit" to get every document
+p textedit.documents.get
+
+
+# tell application "TextEdit" to get a reference to document 1
+p textedit.documents[1]
+
+
+# tell application "TextEdit" to get document 1
+p textedit.documents[1].get
+
+
+# tell application "TextEdit" to get window id 3210
+# p textedit.windows.ID(3210).get
+
+
+# tell application "TextEdit" to get a reference to text of document 1
+p textedit.documents[1].text
+
+
+# tell application "TextEdit" to get text of document 1
+p textedit.documents[1].text.get
+
+
+# tell application "TextEdit" to make new document at end of documents
+textedit.documents.end.make(:new => :document)
+
+
+# tell application "TextEdit" to set text of document 1 to "Happy Happy Joy Joy\n"
+textedit.documents[1].text.set("Happy Happy Joy Joy\n")
+
+
+# tell application "TextEdit" to get text of every document
+p textedit.documents.text.get
+
+
+# tell application "TextEdit" to count each word of text of document 1
+p textedit.documents[1].text.count(:each => :word)
+
+
+# tell application "TextEdit" to get words 3 thru -1 of document 1
+p textedit.documents[1].words[3, -1].get
+
+
+# tell application "TextEdit" to set size of character 1 of every word 
+#         of document 1 to 24
+textedit.documents[1].words.characters[1].size.set(24)
+
+
+# tell application "TextEdit" to set color of any word of document 1 to {65535, 0, 0}
+textedit.documents[1].words.any.color.set([65535, 0, 0])
+
+
+# tell application "TextEdit" to make new paragraph at 
+#         (after last paragraph of text of document 1) with data "Silly Rabbit\n"
+textedit.documents[1].text.paragraphs.last.after.make(
+        :new => :paragraph, :with_data => "Silly Rabbit\n")
+
+
+# tell application "TextEdit" to get paragraph after paragraph 1 of document 1
+p textedit.documents[1].paragraphs[1].next(:paragraph).get
+
+
+# tell application "TextEdit" to make new document at end of documents 
+#         with properties {text:"foo\nbar\n\n\nbaz\n\nfub\n"}
+textedit.documents.end.make(:new => :document, 
+        :with_properties => {:text => "foo\nbar\n\n\nbaz\n\nfub\n"})
+
+
+# tell application "TextEdit" to get every paragraph of text of document 1
+p textedit.documents[1].text.paragraphs.get
+
+
+# tell application "TextEdit" to get every paragraph of document 1 
+#         where it is not "\n" -- get non-empty paragraphs
+p textedit.documents[1].paragraphs[its.ne("\n")].get
+
+
+# tell application "TextEdit" to get text of every document 
+#         whose text begins with "H"
+p textedit.documents[its.text.begins_with('H')].text.get
+
+
+
+# The following examples don't work in TextEdit but will work in, 
+# for example, Tex-Edit Plus:
+#
+#  # tell application "Tex-Edit Plus" to get words (character 5) 
+#  #         thru (paragraph 9) of document 1
+#  p app('Tex-Edit Plus').documents[1] \
+#           .words[con.characters[5], con.paragraphs[9]].get
+#
+#
+#  # tell application "Tex-Edit Plus" to get every word of text 
+#  #         of document 1 whose color is {0, 0, 0}
+#  p app('Tex-Edit Plus').documents[1].text.paragraphs \
+#          [its.color.equals((0, 0, 0))].get

data/sample/iTunes_top40_to_html.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+# This script renders the track and album names of the  top 40 most played
+# iTunes tracks to an HTML file, then opens it in Safari.
+#
+# Requires the Amrita templating engine: http://amrita.sourceforge.jp
+
+# Note: if using the appscript gem, rubygems must be required first:
+begin; require 'rubygems'; rescue LoadError; end
+
+require 'appscript'
+include Appscript
+require 'osax'
+require "amrita/template"
+include Amrita
+
+# Amrita HTML template
+tmpl = TemplateText.new <<END
+<html>
+<head>
+<title> iTunes Top 40 Tracks</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<style type="text/css" media="all">
+	body {padding:0; margin:0;}
+	table {color:black; background-color:#448; width:100%; padding:2px;}
+	th, td {padding:2px; border-width:0;}
+	th {color:#fff; background-color:#114;}
+	td {color:black; background-color:#bbd;}
+</style>
+</head>
+<body>
+<table border="1">
+	<thead>
+	<tr><th>#</th><th>Track</th><th>Album</th></tr>
+	</thead>
+	<tbody>
+	<tr id="table_row"><td id="table_column"></td></tr>
+	</tbody>
+</table>
+</body>
+</html>
+END
+
+# Choose the file to write
+sa = OSAX.osax('StandardAdditions')
+out_file = sa.choose_file_name(:default_name=>'My-iTunes-Top-40.html')
+
+# Get the played count, name and album for every track in iTunes
+tracks = app('iTunes').library_playlists[1].tracks
+info = tracks.played_count.get.zip(tracks.name.get, tracks.album.get)
+# Extract the top 40 most played entries
+top40 = info.sort.reverse[0, 40]
+
+# Assemble input data for Amrita
+data = {
+	:table_row=>top40.collect { |row_data| {:table_column=>row_data} }
+}
+
+# Render HTML file
+tmpl.prettyprint = true
+File.open(out_file.to_s, 'w') { |f| tmpl.expand(f, data) }
+
+# Open file in Safari for viewing
+# safari = app('Safari')
+# safari.activate
+# safari.open(out_file)
+
+# Open file in default web browser for viewing
+sa.open_location(out_file.url)
+
+

data/src/SendThreadSafe.c

@@ -0,0 +1,380 @@
+/*
+    File:       AESendThreadSafe.c
+
+    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.c,v $
+Revision 1.3  2007/02/27 10:45:15         
+In the destructor, add an assert that the thread-local storage has been set to NULL. Also fixed a comment typo.
+
+Revision 1.2  2007/02/12 11:59:09         
+Added a type cast for the malloc result.
+
+Revision 1.1  2007/02/09 10:55:24         
+First checked in.
+
+
+*/
+
+/*
+
+2007/06/24 -- Modified by HAS to make AESendMessageThreadSafeSynchronous API-compatible with AESendMessage; renamed SendMessageThreadSafe.
+
+*/
+
+/////////////////////////////////////////////////////////////////
+
+#include "SendThreadSafe.h"
+
+#include <pthread.h>
+#include <mach/mach.h>
+
+/////////////////////////////////////////////////////////////////
+
+/*
+    How It Works
+    ------------
+    The basic idea behind this module is that it uses per-thread storage to keep 
+    track of an Apple event reply for any given thread.  The first time that the 
+    thread calls AESendMessageThreadSafeSynchronous, the per-thread storage will 
+    not be initialised and the code will grab an Apple event reply port and 
+    assign it to the per-thread storage.  Subsequent calls to AESendMessageThreadSafeSynchronous 
+    will continue to use that port.  When the thread dies, pthreads will automatically 
+    call the destructor for the per-thread storage, and that will clean up the port.
+    
+    Because we can't dispose of the reply port (without triggering the Apple 
+    Event Manager bug that's the reason we wrote this code in the first place), 
+    the destructor doesn't actually dispose of the port.  Rather, it adds the 
+    port to a pool of ports that are available for reuse.  The next time a thread 
+    needs to allocate a port, it will grab it from the pool rather than allocating 
+    it from scratch.
+
+    This technique means that the code still 'leaks' Apple event reply ports, but 
+    the size of the leak is limited to the maximum number of threads that you run 
+    simultaneously.  This isn't a problem in practice.
+*/
+
+/////////////////////////////////////////////////////////////////
+
+// The PerThreadStorage structure is a trivial wrapper around the Mach port.  
+// I added this because I need to attach this structure a thread using 
+// per-thread storage.  The API for that (<x-man-page://3/pthread_setspecific>) 
+// is pointer based.  I could've just cast the Mach port to a (void *), but 
+// that's ugly because of a) pointer size issues (are pointers always bigger than 
+// ints?), and b) because it implies an equivalent between NULL and MACH_PORT_NULL.
+// Given this, I simply decided to create a structure to wrap the Mach port.
+
+enum {
+    kPerThreadStorageMagic = 'PTSm'
+};
+
+struct PerThreadStorage {
+    OSType          magic;          // must be kPerThreadStorageMagic
+    mach_port_t     port;
+};
+typedef struct PerThreadStorage PerThreadStorage;
+
+// The following static variables manage the per-thread storage key 
+// (sPerThreadStorageKey) and the pool of Mach ports (wrapped in 
+// PerThreadStorage structures) that are not currently attached to a thread.
+
+static pthread_once_t       sInited = PTHREAD_ONCE_INIT;    // covers initialisation of all of the 
+                                                            // following static variables
+
+static OSStatus             sPerThreadStorageKeyInitErrNum; // latches result of initialisation
+
+static pthread_key_t        sPerThreadStorageKey = 0;       // key for our per-thread storage
+
+static pthread_mutex_t      sPoolMutex;                     // protects sPool
+static CFMutableArrayRef    sPool;                          // array of (PerThreadStorage *), holds 
+                                                            // the ports that aren't currently bound to 
+                                                            // a thread
+
+static void PerThreadStorageDestructor(void *keyValue);     // forward declaration
+
+static void InitRoutine(void)
+    // Call once (via pthread_once) to initialise various static variables.
+{
+    OSStatus    err;
+    
+    // Create the per-thread storage key.  Note that we assign a destructor to this key; 
+    // pthreads call the destructor to clean up that item of per-thread storage whenever 
+    // a thread terminates.
+    
+    err = (OSStatus) pthread_key_create(&sPerThreadStorageKey, PerThreadStorageDestructor);
+    
+    // Create the pool of Mach ports that aren't bound to any thread, and its associated 
+    // lock.  The pool starts out empty.
+    
+    if (err == noErr) {
+        err = (OSStatus) pthread_mutex_init(&sPoolMutex, NULL);
+    }
+    if (err == noErr) {
+        sPool = CFArrayCreateMutable(NULL, 0, NULL);
+        if (sPool == NULL) {
+            err = coreFoundationUnknownErr;
+        }
+    }
+    assert(err == 0);
+    
+    sPerThreadStorageKeyInitErrNum = err;
+}
+
+static OSStatus AllocatePortFromPool(PerThreadStorage **storagePtr)
+    // Grab a Mach port from sPool; if sPool is empty, create one.
+{
+    OSStatus            err;
+    OSStatus            junk;
+    PerThreadStorage *  storage;
+    
+    assert( storagePtr != NULL);
+    assert(*storagePtr == NULL);
+    
+    storage = NULL;
+    
+    // First try to get an entry from pool.  We try to grab the last one because 
+    // that minimises the amount of copying that CFArrayRemoveValueAtIndex has to 
+    // do.
+    
+    err = (OSStatus) pthread_mutex_lock(&sPoolMutex);
+    if (err == noErr) {
+        CFIndex             poolCount;
+        
+        poolCount = CFArrayGetCount(sPool);
+        if (poolCount > 0) {
+            storage = (PerThreadStorage *) CFArrayGetValueAtIndex(sPool, poolCount - 1);
+            CFArrayRemoveValueAtIndex(sPool, poolCount - 1);
+        }
+        
+        junk = (OSStatus) pthread_mutex_unlock(&sPoolMutex);
+        assert(junk == noErr);
+    }
+
+    // If we failed to find an entry in the pool, create a new one.
+
+    if ( (err == noErr) && (storage == NULL) ) {
+        storage = (PerThreadStorage *) malloc(sizeof(*storage));
+        if (storage == NULL) {
+            err = memFullErr;
+        } else {
+            storage->magic = kPerThreadStorageMagic;
+            storage->port  = MACH_PORT_NULL;
+
+            err = (OSStatus) mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &storage->port);
+            if (err != noErr) {
+                assert(storage->port == MACH_PORT_NULL);
+                free(storage);
+                storage = NULL;
+            }
+        }
+    }
+    if (err == noErr) {
+        *storagePtr = storage;
+    }
+    
+    assert( (err == noErr) == (*storagePtr != NULL) );
+    assert( (*storagePtr == NULL) || ((*storagePtr)->magic == kPerThreadStorageMagic) );
+    assert( (*storagePtr == NULL) || ((*storagePtr)->port  != MACH_PORT_NULL) );
+    
+    return err;
+}
+
+static void ReturnPortToPool(PerThreadStorage * storage)
+    // Returns a port to sPool.
+{
+    OSStatus err;
+
+    assert(storage != NULL);
+    assert(storage->magic == kPerThreadStorageMagic);
+    assert(storage->port  != MACH_PORT_NULL);
+
+    err = (OSStatus) pthread_mutex_lock(&sPoolMutex);
+    if (err == noErr) {
+        CFArrayAppendValue(sPool, storage);
+        
+        err = (OSStatus) pthread_mutex_unlock(&sPoolMutex);
+    }
+    assert(err == noErr);
+}
+
+// Main Thread Notes
+// -----------------
+// There are two reasons why we don't assign a reply port to the main thread. 
+// First, the main thread already has a reply port created for it by Apple 
+// Event Manager.  Thus, we don't need a specific reply port.  Also, the 
+// destructor for per-thread storage isn't called for the main thread, so 
+// we wouldn't get a chance to clean up (although that's not really a problem 
+// in practice).
+
+static OSStatus BindReplyMachPortToThread(mach_port_t *replyPortPtr)
+    // Get a reply port for this thread, remembering that we've done this 
+    // in per-thread storage.
+    // 
+    // On success, *replyPortPtr is the port to use for this thread's reply 
+    // port.  It will be MACH_PORT_NULL if you call it from the main thread.
+{
+    OSStatus    err;
+    
+    assert( replyPortPtr != NULL);
+    assert(*replyPortPtr == MACH_PORT_NULL);
+
+    // Initialise ourselves the first time that we're called.
+    
+    err = (OSStatus) pthread_once(&sInited, InitRoutine);
+    
+    // If something went wrong, return the latched error.
+    
+    if ( (err == noErr) && (sPerThreadStorageKeyInitErrNum != noErr) ) {
+        err = sPerThreadStorageKeyInitErrNum;
+    }
+    
+    // Now do the real work.
+    
+    if (err == noErr) {
+        if ( pthread_main_np() ) {
+            // This is the main thread, so do nothing; leave *replyPortPtr set 
+            // to MACH_PORT_NULL.
+            assert(*replyPortPtr == MACH_PORT_NULL);
+        } else {
+            PerThreadStorage *  storage;
+
+            // Get the per-thread storage for this thread.
+            
+            storage = (PerThreadStorage *) pthread_getspecific(sPerThreadStorageKey);
+            if (storage == NULL) {
+
+                // The per-thread storage hasn't been allocated yet for this specific 
+                // thread.  Let's go allocate it and attach it to this thread.
+                
+                err = AllocatePortFromPool(&storage);
+                if (err == noErr) {
+                    err = (OSStatus) pthread_setspecific(sPerThreadStorageKey, (void *) storage);
+                    if (err != noErr) {
+                        ReturnPortToPool(storage);
+                        storage = NULL;
+                    }
+                }
+            }
+            assert( (err == noErr) == (storage != NULL) );
+            
+            // If all went well, copy the port out to our client.
+            
+            if (err == noErr) {
+                assert(storage->magic == kPerThreadStorageMagic);
+                assert(storage->port  != MACH_PORT_NULL);
+                *replyPortPtr = storage->port;
+            }
+        }
+    }
+
+    // no error + MACH_PORT_NULL is a valid response if we're on the main 
+    // thread.
+    //
+    // assert( (err == noErr) == (*replyPortPtr != MACH_PORT_NULL) );
+    assert( (*replyPortPtr == MACH_PORT_NULL) || (err == noErr) );
+    
+    return err;
+}
+
+static void PerThreadStorageDestructor(void *keyValue)
+    // Called by pthreads when a thread dies and it has a non-null value for our 
+    // per-thread storage key.  We use this callback to return the thread's 
+    // Apple event reply port to the pool.
+{
+    PerThreadStorage *  storage;
+
+    storage = (PerThreadStorage *) keyValue;
+    assert(storage != NULL);                    // pthread won't call us if it's NULL
+    assert(storage->magic == kPerThreadStorageMagic);
+    assert(storage->port  != MACH_PORT_NULL);
+    
+    // Return the port associated with this thread to the pool.
+    
+    ReturnPortToPool(storage);
+
+    // pthreads has already set this thread's per-thread storage for our key to 
+    // NULL before calling us. So we don't need to do anything to remove it.
+
+    assert( pthread_getspecific(sPerThreadStorageKey) == NULL );
+}
+
+OSStatus SendMessageThreadSafe(
+    AppleEvent *            eventPtr,
+    AppleEvent *            replyPtr,
+	AESendMode              sendMode,
+    long                    timeOutInTicks
+)
+    // See comment in header.
+{
+    OSStatus        err = noErr;
+    mach_port_t     replyPort;
+    assert(eventPtr != NULL);
+    assert(replyPtr != NULL);
+    
+	if (sendMode && kAEWaitReply) {
+		replyPort = MACH_PORT_NULL;
+		
+		// Set up the reply port if necessary.
+		
+		err = BindReplyMachPortToThread(&replyPort);
+		if ( (err == noErr) && (replyPort != MACH_PORT_NULL) ) {
+			err = AEPutAttributePtr(eventPtr, keyReplyPortAttr, typeMachPort, &replyPort, sizeof(replyPort));
+		}
+    }
+	
+    // Call through to AESendMessage.
+    
+    if (err == noErr) {
+        err = AESendMessage(eventPtr, replyPtr, sendMode, timeOutInTicks);
+    }
+    
+    return err;
+}