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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Yasu 4.0.0 β - System maintenance app; p...
Yasu was created with System Administrators who service large groups of workstations in mind, Yasu (Yet Another System Utility) was made to do a specific group of maintenance tasks quickly within a... Read more
Skype 7.37.0.178 - Voice-over-internet p...
Skype allows you to talk to friends, family and co-workers across the Internet without the inconvenience of long distance telephone charges. Using peer-to-peer data transmission technology, Skype... Read more
EtreCheck 3.0.5 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
Amadeus Pro 2.3.1 - Multitrack sound rec...
Amadeus Pro lets you use your Mac computer for any audio-related task, such as live audio recording, digitizing tapes and records, converting between a variety of sound formats, etc. Thanks to its... Read more
NeoFinder 6.9.3 - Catalog your external...
NeoFinder (formerly CDFinder) rapidly organizes your data, either on external or internal disks, or any other volumes. It catalogs all your data, so you stay in control of your data archive or disk... Read more
WhatsApp 0.2.1880 - Desktop client for W...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
Hazel 4.0.6 - Create rules for organizin...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a familiar... Read more
Apple iBooks Author 2.5 - Create and pub...
Apple iBooks Author helps you create and publish amazing Multi-Touch books for iPad. Now anyone can create stunning iBooks textbooks, cookbooks, history books, picture books, and more for iPad. All... Read more
MYStuff Pro 2.0.26 - $39.99
MYStuff Pro is the most flexible way to create detail-rich inventories for your home or small business. Add items to MYStuff by dragging and dropping existing information, uploading new images, or... Read more
MarsEdit 3.7.8 - Quick and convenient bl...
MarsEdit is a blog editor for OS X that makes editing your blog like writing email, with spell-checking, drafts, multiple windows, and even AppleScript support. It works with with most blog services... Read more

The new Clash of Kings is just for Weste...
If you’ve played the original Clash of Kings, you’ll probably recognise the city building, alliance forging and strategic battles in Clash of Kings: The West. What sets this version apart is that it’s tailor made for a Western audience and the... | Read more »
Frost - Survival card game (Games)
Frost - Survival card game 1.12.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.12.1 (iTunes) Description: *Warning: the game will work on iPhone 5C and above and iPad Pro / 4. Other devices are not supported* | Read more »
How to build and care for your team in D...
Before you hit the trail and become a dog sledding legend, there’s actually a fair bit of prep work to be done. In Dog Sled Saga, you’re not only racing, you’re also building and caring for a team of furry friends. There’s a lot to consider—... | Read more »
How to win every race in Dog Sled Saga
If I had to guess, I’d say Dog Sled Saga is the most adorable racing game on the App Store right now. It’s a dog sled racing sim full of adorable, loyal puppies. Just look at those fluffy little tails wagging. Behind that cute, pixelated facade is... | Read more »
Let the war games commence in Gunship Ba...
Buzz Lightyear famously said, “This isn’t flying, this is falling – with style!” In the case of Gunship Battle: Second War, though, this really is flying - with style! The flight simulator app from Joycity puts you in control of 20 faithfully... | Read more »
How to get a high score in Fired Up
Fired Up is Noodlecake Games’ high score chasing, firefighting adventure. You take control of a wayward firefighter who propels himself up the side of a highrise with blasts of water. Sound silly? It is. It’s also pretty difficult. You can’t... | Read more »
NBA 2K17 (Games)
NBA 2K17 1.0 Device: iOS iPhone Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: Following the record-breaking launch of NBA 2K16, the NBA 2K franchise continues to stake its claim as the most authentic sports video... | Read more »
Dog Sled Saga (Games)
Dog Sled Saga 1.0.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.1 (iTunes) Description: A game by Dan + Lisa As a rookie musher, foster a dogsledding team whose skills will grow if they're treated right. Week by... | Read more »
60 Seconds! Atomic Adventure (Games)
60 Seconds! Atomic Adventure 1.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2 (iTunes) Description: 60 Seconds! is a dark comedy atomic adventure of scavenge and survival. Collect supplies and rescue your family... | Read more »
Tons of Bullets! (Games)
Tons of Bullets! 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Tons of BulletsA retro 2D pixel platformer infused with tons of bullets and tons of features!Fight as Kenji the Ninja and... | Read more »

Price Scanner via MacPrices.net

21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $120 off MSRP including free shipping plus NY sales tax only: - 21″ 3.1GHz iMac 4K: $1379 $120 off MSRP - 21″ 2.8GHz iMac: $1199.99 $100 off MSRP - 21″ 1... Read more
13-inch 2.7GHz/256GB Retina MacBook Pro on sa...
Amazon.com has the 13″ 2.7GHz/256GB Retina Apple MacBook Pro on sale for $151 off MSRP including free shipping: - 13″ 2.7GHz/256GB Retina MacBook Pro (sku MF840LL/A): $1348 $151 off MSRP Read more
Apple TVs on sale for up to $50 off MSRP
Best Buy has 32GB and 64GB Apple TVs on sale for $40-$50 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Sale prices for online orders only, in-store... Read more
Apple refurbished 13-inch Retina MacBook Pros...
Apple has Certified Refurbished 13″ Retina MacBook Pros available for up to $270 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.7GHz... Read more
Duplicate Sweeper Free On Mac App Store For O...
To celebrate the launch of Apple’s latest macOS Sierra, Stafford, United Kingdom based Wide Angle Software has announced that its duplicate file finder software, Duplicate Sweeper, is now available... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina Apple MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1174.99 $125 off MSRP - 13... Read more
Evidence Surfaces Pointing To New A10X Chip F...
Citing a job description for a Project Lead position at Apple’s Austin, Texas engineering labs, Motley Fool’s Ashraf Eassa deduces that development is progressing well on Apple’s next-generation in-... Read more
Check Print’R for macOS Allows Anyone to Easi...
Delaware-based Match Software has announced the release and immediate availability of Check Print’R 3.21, an important update to their easy-to-use check printing application for macOS. Check Print’R... Read more
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more

Jobs Board

Lead *Apple* Solutions Consultant - Apple (...
# Lead Apple Solutions Consultant Job Number: 51829230 Detroit, Michigan, United States Posted: Sep. 19, 2016 Weekly Hours: 40.00 **Job Summary** The Lead ASC is an Read more
US- *Apple* Store Leader Program - Apple (Un...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on Read more
Integration Technician, *Apple* - Zones (Un...
…at Zones and for our customers each day. Position Overview The Apple Integration Technician will be responsible for performing customer specific configuration Read more
*Apple* Retail - Multiple Positions- Manhatt...
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
Sr. *Apple* Mac Engineer - Net2Source Inc....
…staffing, training and technology. We have following position open with our client. Sr. Apple Mac Engineer6+ Months CTH Start date : 19th Sept Travelling Job If Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.