TweetFollow Us on Twitter

June 95 - ACCORDING TO SCRIPT

ACCORDING TO SCRIPT

Scripting Quandaries

CAL SIMONE

[IMAGE 081-082_According_to_Scri1.GIF]

The world of scripting is heating up. More and more developers are getting hip to scriptability, but they're discovering it's not a simple matter -- implementing scripting support in an application involves many complex issues. That's where this column comes in.

My article, "Designing a Scripting Implementation," in the last issue ofdevelop (Issue 21) offered approaches you'll want to consider when designing your scripting implementation (your object model hierarchy and your human vocabulary), as well as some basic tips and guidelines for making your application scriptable. This column picks up where that article left off, elaborating on many of the same issues and providing further tips, tricks, and standards for scriptability. In this first installment of the column, I'll clarify a couple of points that some developers found confusing in the article; then I'll give some new guidelines.

STARTING WITH MENU COMMANDS
In my previous article, I suggested that one place to start your scripting implementation is to implement your menu commands. Permit me to clarify. Looking at menu commands is useful because they can suggest functionality that users should be able to script. But to maintain consistency with other object model-based applications, you shouldnot implement scripting commands that simply mimic the menu commands.

Resist the temptation to fill up your dictionary with all your menu items, even though it might be easier to write your event handlers this way. Instead, implement the object model (discussed at length in "Apple Event Objects and You" in develop Issue 10 and "Better Apple Event Coding Through Objects" in Issue 12). Keep the number of verbs small, implement standard verbs wherever applicable, and let the script writer apply those verbs (especially make, get, and set) to a large number of objects.

LOWERCASING VERBS, TOO
I mentioned in the last issue that you should begin all the terms in your dictionary (except for proper names) with lowercase letters. This applies not only to object names but to verbs as well. There are two reasons for this rule. First, AppleScript allows commands to be embedded within commands (particularly when the embedded command is from a scripting addition such aschoose file), and these complex command statements read better when all the verbs are in lowercase. For example:

set myFile to choose file with prompt "Pick it!"

Second, if you were to include an entire suite (such as the Required or Core suite) from the system dictionary and then add your own verbs starting with uppercase, you'd end up having a mixture of verbs beginning withuppercase and those beginning with lowercase displayedin your dictionary, not a pretty picture.

HANDLING REQUESTS TO GET AN OBJECT
Developers are sometimes confused about how to handle a request from an Apple event or a script to get an object. In the early days, especially when programs were communicating directly with other programs, developers thought that getting an object meant returning the internal data structure of the object, such as a WindowRecord or other C structure. In today's scripting world, you should never return raw internal data structures. What you should return depends on the object or property requested.

Applications, windows, documents, and interface elements. In most cases, when the object requested is an application, a window, a document, or an interface element (such as a button), you should return an error since you can't really bring these types of objects into your script. For example, get window 1 should result in an error. One exception is that if your application is a script-controlled interface builder, you might want to return references to the windows, documents, and interface elements.

You should provide a contents property for objects such as windows and documents. When this property is requested (as in get the contents of window 1), you should return the entire contents of the object specified,if appropriate.

Text elements. When the object requested is a text element, such as a word or a character (as in get word 4 of paragraph 3 of document "Sales"), you should return the contents of the object itself as a string, such as "Fred" (word) or "x" (character).

Graphics objects. When the object requested is a simple graphics object where a standard format is in widespread use, you should return the contents of the object itself, just as for text elements. For example, for a PICT you would return the picture's data; for a point or a rectangle you would return a list of integers. When the object requested is a compound graphics object, such as a grouped graphic, you should return a reference to the object, in the form of an object specifier.

Cells, fields, and form elements. You should provide a value property for objects such as cells in a spreadsheet, fields in a database, or elements of a form. (In essence, this property is the same thing as the contents property, but in natural language, people usually refer to the value of a cell or field and the contents of a window. Making a distinction between these two kinds of properties thus preserves a natural language style.) When this property is requested (for instance,get the value of cell 3 of row 7), you should provide the content data for the object specified. If you want script writers to be able to get the value in more than one form, provide the as parameter (for example,get the value of . . . as styled text).

Rows, records, and entire forms. When a row or column in a spreadsheet or table, a record in a database, or an entire form is requested, you can return a list of the data values in each field (for example,get record 43 of database "Employees"might return {"Fred", 45.00}). However, it might be more appropriate to return a reference to the object, since the list might be too large or might contain large data. By the same token, either a list or a reference should be returned when the current record property that some developers have implemented is requested.

An object's internal data. Rather than dealing with raw internal data structures, script writers should be able to get any piece of attribute data for an object through the object's properties, by using the get <property> construct. If you want to let them get all the attribute data at once with a single get command, provide a properties property (as, for example, QuarkXPress does), return a record with the values for all the properties, and provide a definition for the record as a new abstract class in the Type Definitions suite (discussed in my article in Issue 21).

As you can see, it's not always clear how to respond to an object request. While not a hard rule, the basic guideline is this: If an object is an elementary piece of data, such as a word or a rectangle, return its value directly; if it's a structure, such as a record or a row, return a list of its values or a reference to the structure; and if it's a complex or abstract object (especially part of the user interface like a window or a button), return either an error or a reference to the object. What you decide to return will often depend on the way you want script sentences to read.

THE APPLICATION AS CONTAINER
How to create and extract object specifiers from Apple events is explained inInside Macintosh: Interapplication Communication . The outermost container for an object specifier is always the application itself, represented by a container of type typeNull. A null container is the only proper way to specify the application level of the containment; do not include a cApplication object specifier as a container. Figure 1 illustrates the rightway to specify the application as a container. The wrong way in this case would be to have a third container level labeled cApplication between cDocument and cNull.

Figure 1. [IMAGE 081-082_According_to_Scri2.GIF]

Specifying the application as a container



I'M OUTTA SPACE
Remember, everything you do in your event handlers, your object accessor functions, your error messages, and your dictionary will significantly affect the experience your users have in writing scripts. In future columns, I'll be discussing how to organize your dictionary; the increasingly crowded naming space for terms; how to organize and propose a new standard suite, event, or object definition; recording; and, as always, more tips, tricks, and conventions.

CAL SIMONE (AppleLink MAIN.EVENT) spends a lot of time helping others make sense of AppleScript, escaping from Washington DC about once a month to promote or teach AppleScript. He lives in Adams-Morgan, the city's only real ethnic neighborhood; full of cultural diversity, it boasts 45 restaurants representing 18 different nationalities in just one block.*

Thanks to Sue Dumont and Jon Pugh for reviewing this column. *

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Notability 4.0.1 - Note-taking and annot...
Notability is a powerful note-taker to annotate documents, sketch ideas, record lectures, take notes and more. It combines, typing, handwriting, audio recording, and photos so you can create notes... Read more
Notability 4.0.1 - Note-taking and annot...
Notability is a powerful note-taker to annotate documents, sketch ideas, record lectures, take notes and more. It combines, typing, handwriting, audio recording, and photos so you can create notes... Read more
NetShade 8.0 - Browse privately using an...
NetShade is an anonymous proxy and VPN app+service for Mac. Unblock your Internet through NetShade's high-speed proxy and VPN servers spanning seven countries. NetShade masks your IP address as you... Read more
Thunderbird 60.7.1 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Coda 2.7.3 - One-window Web development...
Coda is a powerful Web editor that puts everything in one place. An editor. Terminal. CSS. Files. With Coda 2, we went beyond expectations. With loads of new, much-requested features, a few surprises... Read more
Logic Pro X 10.4.5 - Music creation and...
Logic Pro X is the most advanced version of Logic ever. Sophisticated new tools for professional songwriting, editing, and mixing are built around a modern interface that's designed to get creative... Read more
Coda 2.7.3 - One-window Web development...
Coda is a powerful Web editor that puts everything in one place. An editor. Terminal. CSS. Files. With Coda 2, we went beyond expectations. With loads of new, much-requested features, a few surprises... Read more
Thunderbird 60.7.1 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
NetShade 8.0 - Browse privately using an...
NetShade is an anonymous proxy and VPN app+service for Mac. Unblock your Internet through NetShade's high-speed proxy and VPN servers spanning seven countries. NetShade masks your IP address as you... Read more
Logic Pro X 10.4.5 - Music creation and...
Logic Pro X is the most advanced version of Logic ever. Sophisticated new tools for professional songwriting, editing, and mixing are built around a modern interface that's designed to get creative... Read more

Latest Forum Discussions

See All

Marvel Super War Beta Impressions
Marvel Super War is the latest MOBA from Netease, but it’s not something you can just go and download on the App Store now. The game is in a closed beta, meaning you have to download it from a special linkhere and the developers are still ironing... | Read more »
Wild Bullets guide - Tips and tricks for...
Wild Bullets offers up fast and fun wild west action, but it has a good amount of strange mechanics to navigate. Between the game’s unique movement and all of its unlocks, there’s quite a bit to take in. With that said, we put in a good amount of... | Read more »
Superhero-themed runner Talking Tom Hero...
After a massively popular pre-registration period, Outfit7’s runner, Talking Tom Hero Dash, has now landed on iOS and Android. This latest game in the beloved Talking Tom and Friends franchise sees the Talking Tom Heroes team taking on a band of... | Read more »
Infectonator 3: Apocalypse guide - Tips...
When I first booted up Infectonator 3: Apocalypse, I was surprised by the sheer amount of stuff going on it. From crafting and leveling zombies to the intricacies of managing a wandering horde of braindead zombies, it can be overwhelming. | Read more »
A beginner’s guide to MU Origin 2
Webzen’s acclaimed MU Origin 2 recently launched on iOS and Android, shaking up the MMORPG genre in the process. It’s a huge game with a lot of different systems and modes to learn, so we’ve put together a handy beginner’s guide to give you a head... | Read more »
Q&A with the creator of Flappy Fight...
Earlier this month, a little game called Flappy Fighter hit the App Store and seemingly surprised everyone. What looked like a simple Flappy Bird send-up actually turned into the little mobile fighting game that could. | Read more »
MU Origin 2, Webzen’s highly anticipated...
Having successfully left its closed beta phase, MU Origin 2 is no longer available for pre-registration – because it’s now entered its full release. It’s a fully-fledged 3D MMORPG and the second spin-off based on the Webzen’s popular MU universe,... | Read more »
AFK Arena guide - Everything you need to...
Ok, so if you're like me, you've been playing (and sometimes waiting) your way through AFK Arena, only to learn there's a lot more to it than there appears on the surface. There's guilds, a PvP arena, and all sorts of other systems and game modes... | Read more »
Explore an epic fantasy world in MMORPG...
Webzen have just announced the official launch date for its stunning MMORPG ‘MU Origin 2’ which will arrive for iOS and Android on May 28th. It will be the second spinoff from the classic PC-based MU Online, and it looks to further refine the... | Read more »
Solar Explorer: New Dawn guide - Tips an...
Solar Explorer: New Dawn is a lunar lander game that really ratchets the intensity up to 11. With all of the asteroids flying around as you fly around at seemingly breakneck speeds, it can be easy to feel overwhelmed bythe whole thing. | Read more »

Price Scanner via MacPrices.net

Amazon is offering Apple’s new 2019 15″ MacBo...
Amazon has the new 2019 15″ 6-Core and 8-Core MacBook Pros on sale today for $200 off Apple’s MSRP. Shipping is free: – 2019 15″ 2.3GHz 8-Core MacBook Pro Space Gray or Silver: $2599.99 $200 off MSRP... Read more
Our exclusive MacBook Price Trackers show you...
Our Apple award-winning MacBook price trackers are the best place to look for the best sales and lowest prices on MacBooks, MacBook Airs, and MacBook Pros. Scan our price trackers for the latest... Read more
Sprint is offering iPhone 8 Plus pre-owned le...
Sprint is offering the 64GB iPhone 8 Plus, preowned, for $10 per month when combined with a Sprint 18 month Flex lease. Offer is valid from 6/14/19 to 6/30/19. Upgrade to a 256GB model for $12 per... Read more
Amazon is offering a 50% discount on Apple Sm...
Amazon has Apple Smart Keyboards for current-generation 10″ iPad Airs and previous-generation 10″ iPad Pros on sale today for $79.50 shipped. That’s a 50% discount over Apple’s regular MSRP of $159... Read more
Roundup of the best 13″ MacBook Air sales...
Amazon has new 2018 13″ MacBook Airs on sale for $100-$150 off Apple’s MSRP, with prices starting at $1099, each including free shipping. Be sure to select Amazon as the seller during checkout,... Read more
Sale! New 2019 15″ & 13″ MacBook Pros now...
B&H Photo has the new 2019 15″ and 13″ MacBook Pros now on sale for up to $200 off Apple’s MSRP. Overnight shipping is free to many addressed in the US. B&H’s prices are currently the lowest... Read more
New 2019 15″ 2.6GHz 6-Core MacBook Pro on sal...
Adorama has the new 2019 15″ 2.6GHz 6-Core Space Gray MacBook Pro on sale today for $2244 shipped. Their price is $155 off Apple’s MSRP, and Adorama charges sales tax for NY & NJ residents only... Read more
12″ 1.2GHz Space Gray MacBook on sale today f...
Amazon has the 12″ 1.2GHz Space Gray Retina MacBook on sale today for $300 off Apple’s MSRP, only $999. Shipping is free: – 12″ 1.2GHz Space Gray MacBook (8GB RAM/256GB SSD): $999.99 $300 off MSRP... Read more
Clearance 27″ 5K iMacs on sale for up to $600...
B&H Photo has clearance, previous-generation, 27″ 5K Apple iMacs available for up to $600 off original MSRP. These are the same models offered by Apple in their retail and online stores. B&H... Read more
Apple’s new 15″ 2.3GHz 8-Core MacBook Pro is...
B&H Photo has the new 2019 15″ 2.3GHz Silver 8-Core MacBook Pro in stock today and on sale for $2599 including free shipping. That’s $200 off Apple’s MSRP, and it’s currently the lowest price... Read more

Jobs Board

Field Business Development Manager, *Apple*...
Field Business Development Manager, Apple Chicago, IL, USEden Prairie, MN, US Requisition Number:73320 As an Apple Business Development Manager at Insight, you Read more
Geek Squad *Apple* Master Consultation Agen...
**702908BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Job Category:** Services/Installation/Repair **Location Number:** 000360-Williston-Store Read more
*Apple* Mobile Master - Best Buy (United Sta...
**699587BR** **Job Title:** Apple Mobile Master **Job Category:** Store Associates **Location Number:** 000394-Western Hills-Store **Job Description:** **What does a Read more
Best Buy *Apple* Computing Master - Best Bu...
**702927BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 001224-Lakewood-Store **Job Description:** **What does a Read more
Sr Merch Planner - *Apple* Hardware, *Appl...
…data-job-id="12210719" data-google-job-id="" data-apply-click-url="/job/ApplyClick">Sr Merch Planner - Apple Hardware, Apple Accessories, WearablesApply Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.