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
$105.22
Apple Inc.
+0.39
MSFT
$46.13
Microsoft Corpora
+1.11
GOOG
$539.78
Google Inc.
-4.20

MacTech Search:
Community Search:

Software Updates via MacUpdate

OS X Server 4.0 - For OS X 10.10 Yosemit...
Designed for OS X and iOS devices, OS X Server makes it easy to share files, schedule meetings, synchronize contacts, develop software, host your own website, publish wikis, configure Mac, iPhone,... Read more
TotalFinder 1.6.12 - Adds tabs, hotkeys,...
TotalFinder is a universally acclaimed navigational companion for your Mac. Enhance your Mac's Finder with features so smart and convenient, you won't believe you ever lived without them. Tab-based... Read more
BusyCal 2.6.3 - Powerful calendar app wi...
BusyCal is an award-winning desktop calendar that combines personal productivity features for individuals with powerful calendar sharing capabilities for families and workgroups. BusyCal's unique... Read more
calibre 2.7 - Complete e-library managem...
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
Skitch 2.7.3 - Take screenshots, annotat...
With Skitch, taking, annotating, and sharing screenshots or images is as fun as it is simple.Communicate and collaborate with images using Skitch and its intuitive, engaging drawing and annotating... Read more
Delicious Library 3.3.2 - Import, browse...
Delicious Library allows you to import, browse, and share all your books, movies, music, and video games with Delicious Library. Run your very own library from your home or office using our... Read more
Art Text 2.4.8 - Create high quality hea...
Art Text is an OS X application for creating high quality textual graphics, headings, logos, icons, Web site elements, and buttons. Thanks to multi-layer support, creating complex graphics is no... Read more
Live Interior 3D Pro 2.9.6 - Powerful an...
Live Interior 3D Pro is a powerful yet very intuitive interior designing application. View Video Tutorials It has every feature of Live Interior 3D Standard, plus some exclusive ones: Create multi... Read more
The Hit List 1.1.7 - Advanced reminder a...
The Hit List manages the daily chaos of your modern life. It's easy to learn - it's as easy as making lists. And it's powerful enough to let you plan, then forget, then act when the time is right.... Read more
jAlbum Pro 12.2.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more

Latest Forum Discussions

See All

Rami Ismail Opens Up distribute​() for D...
Rami Ismail Opens Up distribute​() for Developers Posted by Jessica Fisher on October 24th, 2014 [ permalink ] Rami Ismail, Chief Executive of Business and Development at indie game studio | Read more »
Great Hitman GO Goes on Sale and Gets Ne...
Great Hitman GO Goes on Sale and Gets New Update – Say That Three Times Fast Posted by Jessica Fisher on October 24th, 2014 [ permalink ] | Read more »
Rival Stars Basketball Review
Rival Stars Basketball Review By Jennifer Allen on October 24th, 2014 Our Rating: :: RESTRICTIVE BUT FUNUniversal App - Designed for iPhone and iPad Rival Stars Basketball is a fun mixture of basketball and card collecting but its... | Read more »
Rubicon Development Makes Over a Dozen o...
Rubicon Development Makes Over a Dozen of Their Games Free For This Weekend Only Posted by Jessica Fisher on October 24th, 2014 [ permalink ] | Read more »
I Am Dolphin Review
I Am Dolphin Review By Jennifer Allen on October 24th, 2014 Our Rating: :: NEARLY FIN-TASTICUniversal App - Designed for iPhone and iPad Swim around and eat nearly everything that moves in I Am Dolphin, a fun Ecco-ish kind of game... | Read more »
nPlayer looks to be the ultimate choice...
Developed by Newin Inc, nPlayer may seem like your standard video player – but is aiming to be the best in its field by providing high quality video play performance and support for a huge number of video formats and codecs. User reviews include... | Read more »
Fighting Fantasy: Caverns of the Snow Wi...
Fighting Fantasy: Caverns of the Snow Witch Review By Jennifer Allen on October 24th, 2014 Our Rating: :: CLASSY STORYTELLINGUniversal App - Designed for iPhone and iPad Fighting Fantasy: Caverns of the Snow Witch is a sterling... | Read more »
A Few Days Left (Games)
A Few Days Left 1.01 Device: iOS Universal Category: Games Price: $3.99, Version: 1.01 (iTunes) Description: Screenshots are in compliance to App Store's 4+ age rating! Please see App Preview for real game play! **Important: Make... | Read more »
Toca Boo (Education)
Toca Boo 1.0.2 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0.2 (iTunes) Description: BOO! Did I scare you!? My name is Bonnie and my family loves to spook! Do you want to scare them back? Follow me and I'll... | Read more »
Intuon (Games)
Intuon 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Join the battle with your intuition in a new hardcore game Intuon! How well do you trust your intuition? Can you find a needle in a... | Read more »

Price Scanner via MacPrices.net

Weekend sale: 13-inch 128GB MacBook Air for $...
Best Buy has the 2014 13-inch 1.4GHz 128GB MacBook Air on sale for $849.99, or $150 off MSRP, on their online store. Choose free home shipping or free local store pickup (if available). Price valid... Read more
Nimbus Note Cross=Platform Notes Utility
Nimbus Note will make sure you never forget or lose your valuable data again. Create and edit notes, save web pages, screenshots and any other type of data – and share it all with your friends and... Read more
NewerTech’s Snuglet Makes MagSafe 2 Power Con...
NewerTech has introduced the Snuglet, a precision-manufactured ring designed to sit inside your MagSafe 2 connector port, providing a more snug fit to prevent your power cable from unintentional... Read more
Apple Planning To Sacrifice Gross Margins To...
Digitimes Research’s Jim Hsiao says its analysts believe Apple is planning to sacrifice its gross margins to save its tablet business, which has recently fallen into decline. They project that Apple’... Read more
Who’s On Now? – First Instant-Connect Search...
It’s nighttime and your car has broken down on the side of the highway. You need a tow truck right away, so you open an app on your iPhone, search for the closest tow truck and send an instant... Read more
13-inch 2.5GHz MacBook Pro on sale for $949,...
Best Buy has the 13″ 2.5GHz MacBook Pro available for $949.99 on their online store. Choose free shipping or free instant local store pickup (if available). Their price is $150 off MSRP. Price is... Read more
Save up to $125 on Retina MacBook Pros
B&H Photo has the new 2014 13″ and 15″ Retina MacBook Pros on sale for up to $125 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels... Read more
Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
Textilus New Word, Notes and PDF Processor fo...
Textilus is new word-crunching, notes, and PDF processor designed exclusively for the iPad. I haven’t had time to thoroughly check it out yet, but it looks great and early reviews are positive.... Read more
WD My Passport Pro Bus-Powered Thunderbolt RA...
WD’s My Passport Pro RAID solution is powered by an integrated Thunderbolt cable for true portability and speeds as high as 233 MB/s. HighlightsOverviewSpecifications Transfer, Back Up And Edit In... Read more

Jobs Board

*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**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
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.