TweetFollow Us on Twitter

Combining Two Faces OF OS X: AppleScript and Java

Volume Number: 21 (2005)
Issue Number: 4
Column Tag: Programming

Combining Two Faces OF OS X: AppleScript and Java

by David Miller

Bridging the Gap

Roll Your Own Solution

Welcome

With the announcement and previews of the new version of Apple's operating system, Tiger, Mac users are starting to get excited about its new features. End users are looking forward to the conveniences brought on by features such as Spotlight and Dashboard, while developers are salivating over frameworks bundled with Tiger such as Core Data and Core Image. And while each new version of OS X has introduced enhancements that are compelling enough to convince users and developers to upgrade, a few ragged edges have also found their way into the foundation.

Two of OS X's highly-touted features are its excellent Java support, and the ease with which automated workflows are created via AppleScript. This article will focus on one of the ragged edges between these two components.

Part 1: AppleScript

AppleScript has been a part of the Mac OS since System 7, and not surprisingly, has had its share of ups and downs since its debut; the transition from OS 9 to OS X was particularly rough on it. Scripts running in the early versions of OS X often had to interact with applications nestled within both the Aqua and the "Classic" emulation layers; while this solution was not a huge obstacle for scripters, it was by no means an elegant solution.

To make matters worse, early versions of Carbon and Cocoa applications often included shoddy AppleScript support due to the amount of effort required to make the jump from OS 9 to OS X. In fact, this situation is just as relevant as it ever was, as developers are understandably more concerned about getting their applications to take advantage of OS X's newest features than to prolong the development cycle to include a "bonus" such as AppleScript support. Frameworks such as Rendezvous, WebKit, and Cocoa Bindings have allowed developers to provide more bang for their applications' buck, yet AppleScript often seems to be left behind. iTunes was an excellent example of this situation, as it did not receive substantial AppleScript support until version 3, (and many of Apple's staple applications such as Safari still don't play nicely with AppleScript).

Yet, ironically enough, OS X has become a bigger and better playground for scripters with each successive release:

  • the Script Menu item has effectively replaced the Script Runner application, and has brought with it the ability to execute scripts written in a variety of flavors besides AppleScript (Perl, Python, and a variety of shell flavors: bash, zsh, tcsh, etc.);
  • the addition of AppleScript Studio to OS X's developer tools has allowed scripters to create full-fledged Cocoa applications with AppleScript and Aqua's native widget set and, in doing so, introduced improvements to the language and AppleEvent model;
  • And Tiger will introduce Automator, an application and framework that will make scripting almost as simple as point-and-click.

AppleScript Studio, as mentioned above, was built upon an Objective-C--AppleScript bridge that allows scripts access to the methods and properties of Cocoa objects. However, this wasn't the first instance of Cocoa applications being written in a language other than Objective-C.

Part 2: Java

One of OS X's major selling points is its tight coupling with Java; heavy-weight tools such as the JBoss J2EE application server and Apache Tomcat can be installed and running on a Mac with a minimal amount of configuration. However, OS X's Java support doesn't end at the command-line. While Cocoa's "native" language is Objective-C, Cocoa's foundation classes have also been ported to Java which, in theory, gives developers the choice between two object-oriented languages for their Cocoa applications.

The above statement is qualified with "in theory" because while it is entirely possible to build a Cocoa application with Java, it is by no means a common occurrence. Cocoa's ancestor, with which it still shares many traits (including the NS prefix for class names) was created for Objective-C's object model within the NextStep environment, and then retro-fitted onto the Java object model for the release of OS X. Creating the Java-Cocoa classes was a nice gesture on Apple's part, but developers have chosen to forego Java and learn Objective-C for Cocoa hacking for several reasons:

  • The Cocoa Java classes are treated as second-class citizens when compared to their Objective-C counterparts, both in terms of their development and documentation,
  • And building Cocoa applications with Objective-C is much like placing a round peg in its round hole, whereas building them with Java is akin to forcing the round peg into a square hole.

And because the square hole seems to be an afterthought, it often gets overlooked when it comes time for framework releases and updates; it is no secret that the documentation and implementation for the Cocoa-Java classes is lacking; frameworks such as the Address Book have become widely accepted in Objective-C applications yet still have no Java hooks. Take for instance, the NSAppleScript class, which is used in the following (simplified) Java class:

Listing 1: NextTrack.java

NextTrack.java

A simple Java class that makes use of NSFoundation's classes for interacting with AppleScript.

Import com.apple.cocoa.foundation.*;

public class NextTrack {

  public static void main(String[] args) {
    String script = "tell application \"iTunes\"\n"
      + " next track \nend tell";
    NSAppleScript myScript =  new NSAppleScript(script);
    NSMutableDictionary errors= new NSMutableDictionary();
    NSAppleEventDescriptor results =
         myScript.execute(errors);
  }
}

The above code should accomplish the same result when run through OS X's Java interpreter as the following snippet of AppleScript when run in Script Editor:

Listing 2: NextTrack.scpt

NextTrack.scpt()
A simple script that will tell iTunes to start playing the next track.

tell application "iTunes"
   next track
end tell

...and the following Objective-C method when invoked by another class:

Listing 3: NextTrack.m

NextTrack.play()

The Objective-C equivalent to the Java code in Listing 1, and the AppleScript shown in Listing 2:

- (void) play
{
   NSAppleScript *play =
      [[NSAppleScript alloc]
         initWithSource:
   @"tell application \"iTunes\"\n next track\n end tell"];
   [play executeAndReturnError:nil];
}

And not surprisingly, the native AppleScript and Objective-C versions shown in Listings 2 and 3 execute precisely as expected; now let's see how the Java version fairs. Compiling the Java code can be accomplished through the following command in Terminal:

javac -classpath .:/System/Library/Java/
   AppleScriptTest.java

... and subsequently executed with...

java -classpath .:/System/Library/Java/ AppleScriptTest

We would expect that the next song in our iTunes playlist would begin playing after executing the above command. However, once the shell gives control to the Java interpreter to execute our program, things go downhill -- the program hangs as soon as the NSAppleScript's execute method is invoked. And even worse, the AppleScript is never executed, which leaves leaving Java developers who wish to incorporate AppleScript into their programs in a bind.

But all is not lost; Thanks to OS X's command-line interface and its osascript utility, it is possible to make a home-made solution to pass information from AppleScript to Java. Traditionally this would process would be done by using an instance of the NSAppleEventDescription class, yet we have seen that this will not work in Java. Let's see how we can overcome this bug in OS X.

Rolling Your Own Solution

Our homegrown solution has two requirements: (1) that we can execute AppleScripts from within Java's sandbox, and (2) that we are able to send the result of a script back to the sandbox. Luckily, both steps can be taken care of by the osascript command.

Included in OS X since its initial release, the osascript command executes AppleScripts in the same way that scripts from traditional languages (such as Perl, Python, and Bash) are executed: through the shell. In terms of the shell, the main difference between executing shell scripts and AppleScripts is that the former can be made executable through the use of UNIX permissions and the she-bang line (the first line of a script, which indicates which program should be interpret the script), while the osascript program must interpret AppleScripts. However, osascript follows the same rules as every other UNIX utility, namely:

  • The program will return 0 to the shell if the AppleScript was executed successfully, or 1 if the script execution terminated abnormally,
  • And the script's result will be echoed to one of stdout or stderr, depending on the return value mentioned above.

And like most other UNIX commands, all you need to know about osascript can be found out through its man page by typing man osascript. For now, all we need to know is that the command osascript test.appleScript will attempt to execute the file test.appleScript in the exact same way as though the script was executed in one of the "traditional" methods, such as through the Script Menu or executing it from within Script Editor.

The Solution, Part 1: Executing AppleScript From Java

Thus, it is relatively trivial to write a wrapper for the osascript program that will capture the script's result and store it in a String; the code shown in Listing 5 does just that.

Listing 5: AppleScript.java

AppleScript.run()

We can use the osascript command to run an AppleScript file via the shell. The output of the script will be echoed to standard out if successful, or sent to standard error if not. Either way, it can be trapped by using an InputStream and then inspected as required.

public String run(File script) throws AppleScriptException,
   IOException,
   FileNotFoundException,
   java.lang.InterruptedException {

ArrayList cmd = new ArrayList(); 
cmd.add("/usr/bin/osascript"); 

// add necessary command-line switches here...

// create an array to store the parameters
cmd.add(script.getPath());
String[] cmdArray = (String[]) cmd.toArray(new String[0]);

// run the script
Process result = Runtime.getRuntime().exec(cmdArray);
result.waitFor();

String line;
StringBuffer output = new StringBuffer();

/* if something bad happened while trying to run the script, throw an AppleScriptException 
   letting the user know what the problem was */
if (result.exitValue() != 0) {
   
  // read in the description of the error
   BufferedReader err = new BufferedReader(new
       InputStreamReader(result.getErrorStream()));
   while ((line = err.readLine()) != null) {
       output.append(line + "\n");
   }
   
   // and throw an exception describing what the problem was throw new 
      AppleScriptException(output.toString().trim());
         
// otherwise the script ran successfully
} else {

   /* read in the output */
   BufferedReader out = new BufferedReader(new
       InputStreamReader(result.getInputStream()));
   while ((line = out.readLine()) != null) {
      output.append(line + "\n");
   }
}

The Solution, Part 2: Returning AppleScript Results to Java

Now you may be asking yourself, "What is the result of an AppleScript?" A script's result is defined to be the value of the last statement in the script. For example, the result of the following script will be a reference to the track that is currently playing iTunes:

Listing 4: GetCurrentTrack.scpt

GetCurrentTrack.scpt

A simple AppleScript used to retrieve the current track in iTunes.

tell application "iTunes"
   set mytrack to current track
end tell

If executed through Script Editor, the result of the above script will be an instance of iTunes' Track class, which contains all of the information retained by iTunes (such as its artist, album, rating, etc.) for the track that is currently playing. However, if the above script is executed through the osascript command after saving it to a file, the following result will be echoed back to the Terminal:

Listing 4: Sample Result

The result of converting an AppleScript object to a textual representation.

"class cFlT" id 105

The two listings included above are merely different representations of the same result. Listing 4 is the result of converting an AppleScript object to text for echoing to the shell; and in the process of converting the object all information about the track that we were hoping to use in our Java program is lost. However, there is a way around this problem: by changing our script so that its result can be parsed as text, we can then capture that information without changing our Java code.

For example, we can retrieve the information for the currently playing track in iTunes and echo it to the shell by passing the following file to osascript :

Listing 5:GetCurrentTrack.scpt

GetCurrentTrack.txt

The following script will result in the information for the current track being echoed out to standard out with the fields delimited by a tab character (\t).

set tab to "\t"
tell application "iTunes"
   try
      set r to current track
      set myvalue to (album of r & tab & artist of r & tab & bit rate of r & 
         tab & comment of r & tab & compilation of r & tab & composer of r & tab & 
         database ID of r & tab & (date added of r as string) & tab & disc count 
         of r & tab & disc number of r & tab & duration of r & tab & enabled of r 
         & tab & (EQ of r as string) & tab & (genre of r as string) & tab & (kind of 
         r as string) & tab & (modification date of r as string) & tab & played 
         count of r & tab & (played date of r as string) & tab & rating of r & tab & 
         sample rate of r & tab & size of r & tab & track count of r & tab & track 
         number of r & tab & year of r & tab & name of r)
   on error
      (* do nothing *)
   end try
end tell

As can be seen from the listing, the script will return the fields of the current track in a tab-delimited format. The Java wrapper method will store this information as a String, which can then be parsed to extract the relevant fields of the Track that we are looking for. The following code illustrates how to do exactly that:

Listing 6: CurrentTrack.java

CurrentTrack.getCurrentTrack()

The following method will return an object containing all of the information for the track that is currently playing in iTunes. After the tab-delimited result is stored, it is broken up into its individual fields, which are used to set the fields of the Track instance. The Calendar.parseAppleScriptDate method is used to convert a textual representation of an AppleScript date field to a java.util.Date object; and numbers must be parsed as Integers before setting our track's attributes.

public static Track getCurrentTrack() throws AppleScriptException {

   try {
      
      File script = new File();

      // <snip>
      // store a get a reference to a file containing the
    // AppleScript shown in Listing 5
      // </snip>

      AppleScript as = new AppleScript(script);
      String result = as.run();

      // split the output on the tab character (\t) to 
      // break it into the individual fields
      String[] bits = result.split("\t");
      
      // if we only have one item, then no track was returned
      if (bits.length <= 1) {
         throw new AppleScriptException("No current track");
      }

      // the object used to store all of the info
      Track current = new Track();
      
      // loop through all fields and set the corresponding
      // attributes of the Track object...
      current.setAlbum(bits[0]);
      current.setArtist(bits[1]);
      current.setBitRate(Integer.parseInt(bits[2]));
      current.setComment(bits[3]);
      current.setCompilation(
         new Boolean(bits[4]).booleanValue());
      current.setComposer(bits[5]);
      current.setId(Integer.parseInt(bits[6]));            
      current.setDateAdded(
         Calendar.parseAppleScriptDate(bits[7]));

      // <snip>other modifiers go here</snip>

      current.setTrackCount(Integer.parseInt(bits[21]));
      current.setTrackNumber(Integer.parseInt(bits[22]));
      current.setYear(Integer.parseInt(bits[23]));
      current.setName(bits[24]);

      return current;

   // if the script doesn't execute properly, then throw
   // an exception to propagate the error
   } catch (Exception e) {
      throw new AppleScriptException(e);
   }
}

It should be noted that our solution does require more code than would be required if Apple's NS* Java classes worked as intended. But, oddly enough, the extra code is AppleScript, not Java, due to the process of manually flattening AppleScript objects into a single string rather than using an NSAppleEventDescriptor to contain the object's individual fields. While it is by no means an elegant solution, it gets the job done reliably and proves to be an interesting exercise in making the different faces of OS X talk to each other in ways that weren't originally intended.

Wrapping Up

Mac OS X has proven to be a healthy and productive platform for developers, and given Apple's recent track record there are no signs that this situation will change in the near future. However, with all of the new technical demos shown in Tiger's previews intended for Objective-C, one hopes that Java developers will also have something to play with upon booting up Apple's new operating system. Or, if not something new, then at least a working copy of what was promised years ago when the first version of OS X was being previewed to developers years ago.

About the Code

The class and supporting JAR files can be found on the CD, which also includes an ANT build file to take care of the heavy lifting; see the accompanying documentation for more information on how to build the class. There are several classes used in the above listing that are free to download and use:

  • AppleScript.java and AppleScriptException.java are part of the com.fivevoltlogic.tools.orchard package,
  • And Track.java is part of the com.fivevoltlogic.mytunes package.

Copies are included on the CD and can also be downloaded from http://www.fivevoltlogic.com/code/.


David Miller is a developer based in Calgary, AB, Canada. You can reach him by sending an email to davidfmiller@gmail.com or pointing your browser to http://www.fivevoltlogic.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

GraphicConverter 10.5.4 - $39.95
GraphicConverter is an all-purpose image-editing program that can import 200 different graphic-based formats, edit the image, and export it to any of 80 available file formats. The high-end editing... Read more
Dash 4.1.3 - Instant search and offline...
Dash is an API documentation browser and code snippet manager. Dash helps you store snippets of code, as well as instantly search and browse documentation for almost any API you might use (for a full... Read more
Microsoft OneNote 16.9 - Free digital no...
OneNote is your very own digital notebook. With OneNote, you can capture that flash of genius, that moment of inspiration, or that list of errands that's too important to forget. Whether you're at... Read more
DEVONthink Pro 2.9.17 - Knowledge base,...
Save 10% with our exclusive coupon code: MACUPDATE10 DEVONthink Pro is your essential assistant for today's world, where almost everything is digital. From shopping receipts to important research... Read more
OmniGraffle 7.6 - Create diagrams, flow...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more
iFinance 4.3.7 - Comprehensively manage...
iFinance allows you to keep track of your income and spending -- from your lunchbreak coffee to your new car -- in the most convenient and fastest way. Clearly arranged transaction lists of all your... Read more
Opera 50.0.2762.58 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
Microsoft Office 2016 16.9 - Popular pro...
Microsoft Office 2016 - Unmistakably Office, designed for Mac. The new versions of Word, Excel, PowerPoint, Outlook and OneNote provide the best of both worlds for Mac users - the familiar Office... Read more
SoftRAID 5.6.4 - High-quality RAID manag...
SoftRAID allows you to create and manage disk arrays to increase performance and reliability. SoftRAID allows the user to create and manage RAID 4 and 5 volumes, RAID 1+0, and RAID 1 (Mirror) and... Read more
OmniGraffle Pro 7.6 - Create diagrams, f...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more

Latest Forum Discussions

See All

Around the Empire: What have you missed...
Around this time every week we're going to have a look at the comings and goings on the other sites in Steel Media's pocket-gaming empire. We'll round up the very best content you might have missed, so you're always going to be up to date with the... | Read more »
The 7 best games that came out for iPhon...
Well, it's that time of the week. You know what I mean. You know exactly what I mean. It's the time of the week when we take a look at the best games that have landed on the App Store over the past seven days. And there are some real doozies here... | Read more »
Popular MMO Strategy game Lords Mobile i...
Delve into the crowded halls of the Play Store and you’ll find mobile fantasy strategy MMOs-a-plenty. One that’s kicking off the new year in style however is IGG’s Lords Mobile, which has beaten out the fierce competition to receive Google Play’s... | Read more »
Blocky Racing is a funky and fresh new k...
Blocky Racing has zoomed onto the App Store and Google Play this week, bringing with it plenty of classic kart racing shenanigans that will take you straight back to your childhood. If you’ve found yourself hooked on games like Mario Kart or Crash... | Read more »
Cytus II (Games)
Cytus II 1.0.1 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0.1 (iTunes) Description: "Cytus II" is a music rhythm game created by Rayark Games. It's our fourth rhythm game title, following the footsteps of three... | Read more »
JYDGE (Games)
JYDGE 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Build your JYDGE. Enter Edenbyrg. Get out alive. JYDGE is a lawful but awful roguehate top-down shooter where you get to build your... | Read more »
Tako Bubble guide - Tips and Tricks to S...
Tako Bubble is a pretty simple and fun puzzler, but the game can get downright devious with its puzzle design. If you insist on not paying for the game and want to manage your lives appropriately, check out these tips so you can avoid getting... | Read more »
Everything about Hero Academy 2 - The co...
It's fair to say we've spent a good deal of time on Hero Academy 2. So much so, that we think we're probably in a really good place to give you some advice about how to get the most out of the game. And in this guide, that's exactly what you're... | Read more »
Everything about Hero Academy 2: Part 3...
In the third part of our Hero Academy 2 guide we're going to take a look at the different modes you can play in the game. We'll explain what you need to do in each of them, and tell you why it's important that you do. [Read more] | Read more »
Everything about Hero Academy 2: Part 2...
In this second part of our guide to Hero Academy 2, we're going to have a look at the different card types that you're going to be using in the game. We'll split them up into different sections too, to make sure you're getting the most information... | Read more »

Price Scanner via MacPrices.net

Apple restocked Certified Refurbished 13″ Mac...
Apple has restocked a full line of Certified Refurbished 2017 13″ MacBook Airs starting at $849. An Apple one-year warranty is included with each MacBook, and shipping is free: – 13″ 1.8GHz/8GB/128GB... Read more
How to find the lowest prices on 2017 Apple M...
Apple has Certified Refurbished 13″ and 15″ 2017 MacBook Pros available for $200 to $420 off the cost of new models. Apple’s refurbished prices are the lowest available for each model from any... Read more
The lowest prices anywhere on Apple 12″ MacBo...
Apple has Certified Refurbished 2017 12″ Retina MacBooks available for $200-$240 off the cost of new models. Apple will include a standard one-year warranty with each MacBook, and shipping is free.... Read more
Apple now offering a full line of Certified R...
Apple is now offering Certified Refurbished 2017 10″ and 12″ iPad Pros for $100-$190 off MSRP, depending on the model. An Apple one-year warranty is included with each model, and shipping is free: –... Read more
27″ iMacs on sale for $100-$130 off MSRP, pay...
B&H Photo has 27″ iMacs on sale for $100-$130 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 27″ 3.8GHz iMac (MNED2LL/A): $2199 $100 off MSRP – 27″ 3.... Read more
2.8GHz Mac mini on sale for $899, $100 off MS...
B&H Photo has the 2.8GHz Mac mini (model number MGEQ2LL/A) on sale for $899 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP. Read more
Apple offers Certified Refurbished iPad minis...
Apple has Certified Refurbished 128GB iPad minis available today for $339 including free shipping. Apple’s standard one-year warranty is included. Their price is $60 off MSRP. Read more
Amazon offers 13″ 256GB MacBook Air for $1049...
Amazon has the 13″ 1.8GHz/256B #Apple #MacBook Air on sale today for $150 off MSRP including free shipping: – 13″ 1.8GHz/256GB MacBook Air (MQD42LL/A): $1049.99, $150 off MSRP Read more
9.7-inch 2017 WiFi iPads on sale starting at...
B&H Photo has 9.7″ 2017 WiFi #Apple #iPads on sale for $30 off MSRP for a limited time. Shipping is free, and pay sales tax in NY & NJ only: – 32GB iPad WiFi: $299, $30 off – 128GB iPad WiFi... Read more
Wednesday deal: 13″ MacBook Pros for $100-$15...
B&H Photo has 13″ #Apple #MacBook Pros on sale for up to $100-$150 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13-inch 2.3GHz/128GB Space Gray... Read more

Jobs Board

*Apple* Store Leader - Retail District Manag...
Job Description: Job Summary As more and more people discover Apple , they visit our retail stores seeking ways to incorporate our products into their lives. It's Read more
Sr. Experience Designer, Today at *Apple* -...
# Sr. Experience Designer, Today at Apple Job Number: 56495251 Santa Clara Valley, California, United States Posted: 18-Jan-2018 Weekly Hours: 40.00 **Job Summary** Read more
Security Applications Engineer, *Apple* Ret...
# Security Applications Engineer, Apple Retail Job Number: 113237456 Santa Clara Valley, California, United States Posted: 17-Jan-2018 Weekly Hours: 40.00 **Job Read more
*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 113384559 Brandon, Florida, United States Posted: 10-Jan-2018 Weekly Hours: 40.00 **Job Summary** Are you passionate about Read more
Art Director, *Apple* Music + Beats1 Market...
# Art Director, Apple Music + Beats1 Marketing Design Job Number: 113258081 Santa Clara Valley, California, United States Posted: 05-Jan-2018 Weekly Hours: 40.00 Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.