TweetFollow Us on Twitter

Fun With AppleScript

Volume Number: 20 (2004)
Issue Number: 1
Column Tag: Programming

Getting Started

by Dave Mark

Fun With AppleScript

A few weeks ago, I read an article talking about the changes to AppleScript introduced with the release of Panther. I've always been a big AppleScript fan, but this article really piqued my interest. I've been promising myself to spend some quality time digging into dictionaries, scripting environments, and especially using Interface Builder and AppleScript Studio to add Cocoa elements to AppleScript, and now that I've had enough quality play-time, I wanted to start writing about all this cool stuff.

Start by Setting Up Script Menu

Before we start playing with AppleScript itself, it is worthwhile taking a minute to install Script Menu, the little script icon that appears on the right side of the menu bar and gives you access to a wide range of AppleScripts.

Navigate over to Applications/AppleScript/ and double-click on the script Install Script Menu. The Script Menu icon should appear in your menu bar. My Script Menu is shown in Figure 1. The Script Menu lists scripts from three different places on your hard drive. Local Scripts (also called Library Scripts) are found in the directory /Library/Scripts. User Scripts are found in your home directory, inside /Users/<user name>/Library/Scripts/. And, finally, Application Scripts are found within your User Scripts folder, in a subfolder called /Applications/<appname>/, where <appname> is a folder with the exact same name as the application the scripts are written for.


Figure 1. The Script Menu's menu.

Let's take a look at this in action. Figure 1 shows the vanilla install of Script Menu. The first item, Open Scripts Folder, opens your User Scripts folder in a Finder window. Remember, User Scripts are the scripts you install in your home area.

The second menu item, Hide Library Scripts, removes the Library Scripts from the Script Menu.

Next comes a separator and the list of all the Library Scripts. In this case, all the scripts are divided into subfolders and so appear in the Script Menu divided into submenus.

Add in a User and Application Script

The screen shot in Figure 1 shows Script Menu as it appears out of the box. Let's add a User Script to the menu. Go into the directory /Applications/AppleScript/ and launch the application Script Editor. Select New from the File menu, type in this simple script:

tell application "Finder"
	activate
end tell

Now select Save from the File menu and save the script in the directory /Users/xxx/Library/Scripts/, where xxx is your user name. I saved my script under the name Dave's Test Script.

A quick note about terminology: The directory /Users/xxx/ is called your home directory and can be represented in the Unix world by the tilde character (~). For example, if I typed in the command:

ls /Users/davemark/

it would be exactly the same as typing:

ls ~

You can also use ~xxx to refer to another user's home directory. So this is also equivalent way to refer to davemark's home directory:

ls ~davemark

And this is one way to list the contents of my User Scripts folder:

ls ~davemark/Library/Scripts

As soon as you save the script, it should appear in your Script Menu. Make sure you are still in Script Editor, then open the Script Menu, select your script (it should be at the very bottom), and watch what happens. Your script is executed, and it does what it is supposed to do. Namely, it tells the Finder to activate, to come to the front. And that is exactly what should happen.

Note that you could have created a folder in your ~/Library/Scripts/ folder and placed the script inside that folder. In that case, the folder would have appeared in the Script Menu as a submenu and the script would have appeared as an item inside that submenu. Try it!

Now for some ultimate coolness! Go back into Script Editor and close the window of the script you just created. Next, hold down the option key, click on the Script Menu and select your script again. Instead of running the script, Mac OS X opens the script in Script Editor. An excellent feature!

Your next step is to add an application-specific folder to your User Script directory. The idea here is to have a directory for all your scripted applications and have the scripts for that app appear in the Script Menu whenever that application is front most. You'll see what I mean in a minute.

Start off by creating a folder called Applications in your ~/Library/Scripts/ folder. Within that folder, create a folder with the exact name of one of your applications. For example, create a folder named Finder. Note that spelling is critical or this won't work. Now go into Script Editor and create this script:

tell application "Script Editor"
	activate
end tell

Save the script in the ~/Library/Scripts/Applications/Finder folder. I saved my script under the name Dave's Finder Script. Once the script is saved, click on the Script Menu. If you are in the Finder, your Finder scripts will appear at the bottom of the menu. If you are in another app, the Finder scripts will be replaced by the scripts (if any) for that app.

Figure 2 shows my Script Menu, as selected from within the Finder. Note that the User Script I created, Dave's Script, is second from the bottom, and the Finder script is at the very bottom. When I run Dave's Script, the Finder comes to the front. Then, within the Finder, when I run Dave's Finder Script, Script Editor comes to the front. Try this yourself.


Figure 2. The Script Menu with the addition of my test script from my User Scripts folder and my Finder

Script from my Applications/Finder/ folder.

Exploring the Dictionary

Now that you have a home for all your scripts, let's start exploring AppleScript itself. One place to start is with an application's dictionary. Each application's dictionary entry gives specific information about the classes and commands that the application supports.

Launch Script Editor. If it is not already open, open the Library window by selecting Library from the Window menu. Figure 3 shows my Script Editor library.


Figure 3. Script Editor's Library window.

Double-click on the Finder entry in the Library window. The window shown in Figure 4 will appear. There is a lot of information to digest in this window. Spend a few minutes opening the various disclosure triangles (I've opened some of them in Figure 4) and clicking on the various commands and classes in the left scrolling pane.

If you've ever done any pre-OS X Mac development, you've likely encountered the concept of Apple events. Want an app to quit? Send it a quit Apple event. Want an app to open or print a file? Send it an open or print Apple event. AppleScript is basically a sophisticated language you can use to control a scriptable application by sending it events and scripting the results.


Figure 4. The Finder's dictionary, showing the application class in the Finder Basics suite.

The most basic set of commands are organized into something called the Standard Suite. Most applications support the Standard Suite. The Standard Suite commands are close, count, data size, delete, duplicate, exists, make, move, open, print, quit, and select.

Many applications add their own sets of commands to the Standard Suite. For example, the Finder adds in a set of classes and commands called Finder Basics and another called Finder items. The main pain of Figure 4 shows the details of the application class in the Finder Basics suite. Notice that the list is divided into Elements and Properties. Elements are the objects contained in a class, while properties are more like preferences - unique within a class. Elements can be plural while a property is usually singular. A typical Finder element might be the list of items on the desktop. A typical Finder property might be the current selection.

Let's play with this a bit.

Create a new script and type in this code:

tell application "Finder"
	get home
end tell

When you run this script, Script Editor should display results in its Result pane. My results are shown in Figure 5. Notice that home is a Finder property containing the home directory. If you look towards the bottom of Figure 4, you'll see that it is also marked [r/o], meaning the property is read-only.


Figure 5. A simple Finder script, with the results shown in the Result pane.

Now edit the script like so:

tell application "Finder"
	get items of home
end tell

While the first script gave you the value of the home property, this script returns the list of items in the home folder. Here's the result I got when I ran this script:

{folder "Desktop" of folder "davemark" of folder "Users" of startup disk of 
   application "Finder", folder "Documents" of folder "davemark" of folder "Users" of startup 
   disk of application "Finder", folder "Library" of folder "davemark" of folder "Users" of 
   startup disk of application "Finder", folder "Magazines" of folder "davemark" of folder 
   "Users" of startup disk of application "Finder", folder "Movies" of folder "davemark" of 
   folder "Users" of startup disk of application "Finder", folder "Music" of folder "davemark" 
   of folder "Users" of startup disk of application "Finder", folder "Pictures" of folder 
   "davemark" of folder "Users" of startup disk of application "Finder", folder "Public" of 
   folder "davemark" of folder "Users" of startup disk of application "Finder", folder "Sites" 
   of folder "davemark" of folder "Users" of startup disk of application "Finder"}

As you can see, this is a comma-delimited list, wrapped in curly braces. This kind of result is typical in AppleScript. As you can see in the top of Figure 4, an item element can be specified "by numeric index, before/after another element, by name, as a range of elements, satisfying a test." For example, we can refer to item 3, as in this script:

tell application "Finder"
	get item 3 of home
end tell

As you might expect, here's the result of this script:

folder "Library" of folder "davemark" of folder 
   "Users" of startup disk of application "Finder"

Till Next Month...

There is a ton of cool stuff to play with here. In the Finder dictionary, look in the Finder items suite, at the item class to learn everything you could possibly want to know about items. For example, you'll see a bounds property, which describes the bounding rectangle of the specified item. You might extend the script above to:

tell application "Finder"
	get bounds of item 3 of home
end tell

You get the idea. The dictionary is an incredibly powerful tool for unlocking the mysteries of AppleScript. Play more. I'll be back next month with more fun stuff! J


Dave Mark is a long-time Mac developer and author and has written a number of books on Macintosh development, including Learn C on the Macintosh, Learn C++ on the Macintosh, and The Macintosh Programming Primer series. Be sure to check out Dave's web site at http://www.spiderworks.com.

 
AAPL
$101.20
Apple Inc.
+0.62
MSFT
$45.20
Microsoft Corpora
-0.02
GOOG
$583.54
Google Inc.
+0.17

MacTech Search:
Community Search:

Software Updates via MacUpdate

calibre 2.0.0 - Complete e-library manag...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more
Apple iMovie 10.0.5 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more
Apple Keynote 6.2.2 - Apple's prese...
Apple Keynote makes it simple to create and deliver beautiful presentations. Powerful tools and dazzling effects bring your ideas to life. You can work seamlessly between Mac and iOS devices. And... Read more
Apple Numbers 3.2.2 - Apple's sprea...
With Apple Numbers, sophisticated spreadsheets are just the start. The whole sheet is your canvas. Just add dramatic interactive charts, tables, and images that paint a revealing picture of your data... Read more
OpenOffice 4.1.1 - Free and open-source...
OpenOffice.org is both an Open Source product and a project. The product is a multi-platform office productivity suite. It includes the key desktop applications, such as a word processor,... Read more
Pages 5.2.2 - Apple's word processo...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices. And... Read more
Quicken 2015 2.0.1 - Complete personal f...
The new Quicken 2015 helps you manage all your personal finances in one place, so you can see where you're spending and where you can save. Quicken automatically categorizes your financial... Read more
CleanMyMac 2.2.7 - Delete files that was...
CleanMyMac makes space for the things you love. Sporting a range of ingenious new features, CleanMyMac 2 lets you safely and intelligently scan and clean your entire system, delete large, unused... Read more
MacFamilyTree 7.2.4 - Create and explore...
MacFamilyTree gives genealogy a facelift: it's modern, interactive, incredibly fast, and easy to use. We're convinced that generations of chroniclers would have loved to trade in their genealogy... Read more
Videobox 4.1.1 - Download Flash video th...
Videobox allows you to quickly and easily download Flash video from most all of the popular video sites on the internet. Videobox will convert the video into a native Quicktime format so it's ready... Read more

Latest Forum Discussions

See All

Trolls vs Vikings Update Adds Over One H...
Trolls vs Vikings Update Adds Over One Hundred Levels, Reduces Item Cost, and More Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
SNK Celebrates the 20th Anniversary of T...
SNK Celebrates the 20th Anniversary of The King of Fighters With a Big Sale Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
It Came From Canada: Star Wars: Commande...
With a brand new Star Wars trilogy on the horizon, prepare yourselves for Disney and George Lucas’s space fantasy throwback to be more omnipresent than ever before. So it should come as no surprise that new adventures in that galaxy far, far away... | Read more »
Swing Copters Review
Swing Copters Review By Jordan Minor on August 22nd, 2014 Our Rating: :: DIE TRYINGUniversal App - Designed for iPhone and iPad The creator of Flappy Bird is back with a vengeance.   | Read more »
The Outcast Review
The Outcast Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: HANDS OFF. WAY OFF.Universal App - Designed for iPhone and iPad It’s easy to see what The Outcast is trying for, but its execution needs a lot of work.   | Read more »
Brain+ Review
Brain+ Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: DIM BULBUniversal App - Designed for iPhone and iPad Brain+ is just another entry in an over-saturated brain-training marketplace – and not a particularly fun entry... | Read more »
The Witcher Battle Arena – New Gameplay...
The Witcher Battle Arena – New Gameplay Trailer Revealed Posted by Jessica Fisher on August 22nd, 2014 [ permalink ] Based in the Witcher universe, | Read more »
Max Gentlemen Review
Max Gentlemen Review By Jennifer Allen on August 22nd, 2014 Our Rating: :: OUTSTAYING ITS WELCOMEiPhone App - Designed for the iPhone, compatible with the iPad Max Gentlemen seems pretty quirky initially but that appeal wears thin... | Read more »
Club Penguin Gets Frozen All Over in Lat...
Club Penguin Gets Frozen All Over in Latest Takeover Event Posted by Ellis Spice on August 22nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Doctor Who: Legacy Review
Doctor Who: Legacy Review By Jennifer Allen on August 22nd, 2014 Our Rating: :: RUN OF THE MILLUniversal App - Designed for iPhone and iPad Doctor Who: Legacy is an ok match-3 puzzle game, but it lacks some much needed personality... | Read more »

Price Scanner via MacPrices.net

Leftover 15-inch 2.0GHz Retina MacBook Pros a...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Pro.Calendar – New Productivity App for iPad...
Austin, Texas based mobile business and productivity app developer LightArrow, Inc. has announced Pro.Calendar, a powerful and intuitive calendar app with eight versatile calendar options including... Read more
SanDisk Ultra II SSD — Supercharge Your Syste...
SanDisk Corporation has announced the new SanDisk Ultra II SSD with enhanced SSD Dashboard. The new drive is designed to deliver a cost-effective and easy upgrade solution for PC owners looking to... Read more
Samsung and Barnes & Noble Introduce New...
Samsung Electronics America and NOOK Media, a subsidiary of Barnes & Noble, Inc. have announced the introduction of the new Samsung Galaxy Tab 4 NOOK, a 7-inch tablet combining Samsung’s leading... Read more
21-inch iMacs on sale for up to $150 off MSRP
B&H Photo has 21″ iMacs on sale for up to $150 off MSRP including free shipping plus NY sales tax only. B&H will also include a free copy of Parallels Desktop software: - 21″ 2.7GHz iMac: $... Read more
27-inch 3.2GHz iMac on sale for $1698, save $...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
Mac Backup Guru 2.0 Drive Backup/Cloneing Uti...
Mac Backup Guru developer MacDaddy has released Mac Backup Guru 2.0, offering new and enhanced advanced features, such as bootable backups, synchronised volumes and folders, and a Snapshot mode that... Read more
Operate GE’s New Free-Standing KItchen Range...
Think you accidentally left the oven on? Switch it off while on the go. The new free-standing Profile™ Series gas and electric ranges are GE’s second cooking appliances, following their wall oven, to... Read more
Parallels Announces Parallels Desktop 10 for...
The no. 1-selling software for running Windows applications on a Mac becomes an even easier choice for millions of consumers and IT professionals worldwide with the launch of the most powerful... Read more
Apple now offering certified refurbished 2014...
 The Apple Store is now offering Apple Certified Refurbished 2014 MacBook Airs for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As more and more people discover Apple , they visit our stores seeking ways to incorporate our products into their lives. It's your job, as a Store Read more
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Project Manager, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
*Apple* Solutions Consultant (ASC)- Retail S...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.