TweetFollow Us on Twitter

More Fun With AppleScript

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

Getting Started

by Dave Mark

More Fun With AppleScript

In last month's column, we installed Script Menu to help us organize our scripts, and then started digging into the Finder's AppleScript dictionary. Fantastic stuff! Hopefully, you've had a chance to play. If not, launch Script Editor, select Library from the Window menu, then double-click on the Finder entry in the Library list. A Finder dictionary window should appear.

Click on the line in the left pane labeled Finder Basics. The classes and commands associated with the Finder Basics AppleScript suite will appear (see Figure 1). Notice that the Finder Basics are divided into Properties and Elements. Think of properties as class data and the elements as objects within the class.


Figure 1. The Finder Basics dictionary entries.

For example, go into the Script Editor and type this script:

tell application "Finder"
   get name
end tell

When you run this script, here's what appears in the results field:

"Finder"

This is the value of the name property of the Finder. If you are running Panther, here's the result of the command get version:

"10.3"

Here's an interesting one. First, do a get startup disk:

startup disk of application "Finder"

Now do a get name of startup disk:

"Macintosh HD"

See the difference? Startup disk is a reference to the startup disk, whereas name of startup disk is a string containing the name of the startup disk. If you look in Figure 1, you'll see that startup disk is of type disk. The disk class is defined in the Containers and folders suite. The class is shown in Figure 2. Notice that the dictionary shows the plural form of disk as disks. The dictionary also shows the elements and properties of the disk class.


Figure 2. The disk class entries of the Containers and folders suite.

Try the command get format of startup disk. Remember, format is a property of the disk class and startup disk is defined as being of class disk. Here's the result on my Mac:

Mac OS Extended format

Now try get journaling enabled of startup disk. Here's the result:

true

As you might expect, Boolean properties return either true or false. The command get ignore privileges of startup disk returns:

false

Finder Basics - Elements

Go back to Figure 1 and take a look at the elements in the Finder Basics suite. These are the objects that you might expect the Finder to encounter. What do you think the result will be of running this script:

tell application "Finder"
   get items
end tell

It helps to have a sense of the item class. An item is basically a generic object - pretty much anything that could exist in a Finder window or on the desktop. Here's the result I got when I ran the script on my Mac:

{startup disk of application "Finder", disk "Macintosh HD" of application 
"Finder", folder "AE Monitor 1.0" of desktop of application "Finder", document file 
"DSC_0751.JPG" of desktop of application "Finder", folder "InDesign CS Example Scripts" 
of desktop of application "Finder", folder "UI Element Inspector" of desktop of application 
"Finder", alias file "Warcraft III" of desktop of application "Finder", folder "wedding_pics" 
of desktop of application "Finder", document file "Xcode notes" of desktop of application "Finder"}

Look through this list of items. Note the curly braces, necessary to making this a proper list. Take a look at the nomenclature, especially the use of the word "of" all over the place. Think containers/enclosures, items within items within items.

Figure 2 shows the listing of the Finder items suite in a dictionary window. Check out the list of properties. Note that an item has an index. Look in the list of items in the previous list, returned by the get items command. What do you think will happen when I run the command get item 2. Here's my result:

disk "Macintosh HD" of application "Finder"


Figure 3. The item class in the Finder items suite.

As you might expect, get item 2 returns the second item in the list returned by get items. Now, what do you suppose you'd get from this command:

get container of item 2

In my case, I got:

folder "Dave Mark's Computer" of application "Finder"

Brave New Make

So far, all we've done is suck information out of the Finder. Let's try making something.

In the Finder's dictionary window, click on the Commands line in the Standard Suite. The commands supported by all subsequent suites are listed. One of these is the make command. The details are shown in Figure 4.


Figure 4. Details on the make command.

Here's a script to create a new folder at the current insertion location (the desktop).

tell application "Finder"
   make new folder with properties {name:"blap"}
end tell

This tells the Finder to create a new folder at the current insertion location (since I didn't specify a new location) with the specified properties. Since I only specified a single property, this will be pretty simple. I ran this script and a new folder named "blap" appeared on my desktop. Here's the result returned by my script:

folder "blap" of folder "Desktop" of folder "davemark" of folder "Users" 
of startup disk of application "Finder"

Does this make sense? You can see the containment hierarchy as it walks its way out from the new folder to the top of my hard drive and Finder itself.

Now that "blap" exists, let's try running the script again. Hrm. As you can see in Figure 5, we got an error, telling us that the folder already exists.


Figure 5. An error is reported when I try creating a folder that already exists. Hrm.

Having Script Editor report the error is very useful if you are testing your script or just playing. But if you deliver this script as a compiled entity to a user, you'll want the program to handle the errors itself. Here's a new version of the script:

tell application "Finder"
   try
      make new folder with properties {name:"blap"}
   on error error_message
      display dialog error_message
   end try
end tell

Running this script produces the dialog shown in Figure 6. Much better. Now the script uses a try block and a corresponding on error block to pass the incoming error message to the display dialog command.


Figure 6. A simple error dialog.

Here's the result of running this script (I clicked the OK button):

{button returned:"OK"}

Till Next Month...

Hopefully, you are getting a bit more familiar with the AppleScript Finder dictionary and the way you can take advantage of properties, elements, and commands. Now that you have a sense of the Finder, open up some other dictionaries. A great one to play with is the TextEdit dictionary. A lovely place to create text elements and copy them to the clipboard for use in other applications. Try your hand at manipulating TextEdit. See what you can do with it.

We will return to AppleScript at some point (I love it too much not to) but next month's column is going back to Cocoa. I am heading down to Atlanta to Aaron Hillegass' Big Nerd Ranch for a week of intensive Cocoa training. I am very excited about this. Model View Controller, Model View Controller. See you next month! 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

Black Hole Joyrider (Games)
Black Hole Joyrider 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Guide your spacecraft through the gravity well of a powerful black hole using only your retro-thrusters and dwindling fuel... | Read more »
My Koi (Games)
My Koi 1.0 Device: iOS iPhone Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: My Koi is a beautiful and relaxing fish pond app. Customise and name each fish. Feed them daily. Watch them grow. Collect new fish.... | Read more »
Never Gone (Games)
Never Gone 1.0.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.2 (iTunes) Description: ###IMPPORTANT### Never Gone's HD art resources require devices with more than 1GB RAM, so please note that iPhone 4/4s, iPad 2/... | Read more »
INKS. (Games)
INKS. 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: From the makers of BAFTA-winning Lumino City comes INKS. INKS updates pinball for a new generation. It combines the joy of pinball with... | Read more »
How to maximise your profits in Bakery B...
Running a bakery can be an expensive venture. You’ll need to continuously upgrade your oven, your kitchen supplies, and even your ingredients to keep customers happy. Most of these renovations in Bakery Blitz cost a pretty penny, but we have a few... | Read more »
How to manage your time in Bakery Blitz
It can be tricky, especially when you risk burning your kitchen to the ground if you forget a cake in the oven, so make sure to use these time management tricks to keep your bakery running smoothly. Don’t collect the money right away [Read more] | Read more »
Model 15 (Music)
Model 15 1.0 Device: iOS iPhone Category: Music Price: $29.99, Version: 1.0 (iTunes) Description: The Moog Model 15 App is the first Moog modular synthesizer and synthesis educational tool created exclusively for iPad, iPhone and... | Read more »
How to deal with wind in Angry Birds Act...
Angry Birds Action! is a physics-based puzzler in which you're tasked with dragging and launching birds around an obstacle-littered field to achieve a set objective. It's simple enough at first, but when wind gets introduced things can get pretty... | Read more »
How to get three stars in every level of...
Angry Birds Action! is, essentially, a pinball-style take on the pull-and-fling action of the original games. When you first boot it up, you'll likely be wondering exactly what it is you have to do to get a good score. Well, never fear as 148Apps... | Read more »
The beginner's guide to Warbits
Warbits is a turn-based strategy that's clearly inspired by Nintendo's Advance Wars series. Since turn-based strategy games can be kind of tricky to dive into, see below for a few tips to help you in the beginning. Positioning is crucial [Read... | Read more »

Price Scanner via MacPrices.net

Global Tablet Sales Slump Continues, iPad’s F...
Another miserable showing for the global slate tablet category in calendar Q1/16, with global tablet shipments falling another 1ten percent to 46.5 million units during the according to Strategy... Read more
Revel Systems to Showcase iPad POS Platform w...
Revel Systems, specialists in iPad Point of Sale management solution for brick-and-mortar retail, food businesses and more, today announced that it will showcase its innovative iPad Point of Sale... Read more
13-inch 2.5GHz MacBook Pro on sale for $999,...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Apple refurbished 2015 iMacs available for up...
Apple now has a full line of Certified Refurbished 2015 21″ & 27″ iMacs available for up to $350 off MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are... Read more
Indian Smartphone Market Grows Annually by 12...
India’s smartphone market grew by 12 percent year-over-year, with 24.4 million units shipping in Q1 2016. The top five vendors stayed the same, with Samsung in the lead, followed by Micromax, Intex... Read more
Get Notifications When Your Friend’s Phone Ba...
Calgary, Canada based Stonelight Pictures has announced the release of Battery Share 1.0.1, its new utility for iOS 9 supported devices. The company notes that people are spending more time on their... Read more
11-inch 1.6GHz/128GB MacBook Air on sale for...
Amazon has the current-generation 11″ 1.6GHz/128GB MacBook Air (sku MJVM2LL/A) on sale for $749.99 for a limited time. Their price is $150 off MSRP, and it’s the lowest price available for this model... Read more
Price drops on clearance 2015 13-inch MacBook...
B&H Photo has dropped prices on clearance 2015 13″ MacBook Airs by up to $250. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $799, $200... Read more
Mac minis on sale for up to $100 off MSRP
B&H Photo has Mac minis on sale for up to $100 off MSRP including free shipping plus NY sales tax only: - 1.4GHz Mac mini: $449 $50 off MSRP - 2.6GHz Mac mini: $649 $50 off MSRP - 2.8GHz Mac mini... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina MacBook Pros on sale for $130-$200 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1169 $130 off MSRP - 13″ 2.7GHz/... Read more

Jobs Board

Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Simply Mac *Apple* Specialist- Service Repa...
Simply Mac is the largest premier retailer of Apple products in the nation. In order to support our growing customer base, we are currently looking for a driven Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation WHY YOU LL LIKE IT You ll be the Big Apple You ll solve problems You ll get to show your ability to handle the stress and Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform 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.