AppleScript

Last updated

AppleScript
Paradigm Natural language programming, Scripting
Developer Apple Inc.
First appeared1993;30 years ago (1993) [1]
Stable release
2.8 [2] / October 16, 2014;9 years ago (2014-10-16) [3]
Typing discipline Weak, dynamic
OS System 7, Mac OS 8, Mac OS 9, macOS
License Proprietary (parts available under APSL)
Filename extensions .scpt, .scptd, .applescript
Website developer.apple.com/library/archive/documentation/AppleScript/Conceptual/AppleScriptLangGuide
Influenced by
Natural language, HyperTalk

AppleScript is a scripting language created by Apple Inc. that facilitates automated control over scriptable Mac applications. First introduced in System 7, it is currently included in all versions of macOS as part of a package of system automation tools. [4] [5] The term "AppleScript" may refer to the language itself, to an individual script written in the language, or, informally, to the macOS Open Scripting Architecture that underlies the language. [4] [5]

Contents

Overview

AppleScript is primarily a scripting language developed by Apple to do inter-application communication (IAC) using Apple events. [4] [5] AppleScript is related to, but different from, Apple events. Apple events are designed to exchange data between and control other applications in order to automate repetitive tasks.

AppleScript has some processing abilities of its own, in addition to sending and receiving Apple events to applications. AppleScript can do basic calculations and text processing, and is extensible, allowing the use of scripting additions that add new functions to the language. Mainly, however, AppleScript relies on the functionality of applications and processes to handle complex tasks. As a structured command language, AppleScript can be compared to Unix shells, the Microsoft Windows Script Host, or IBM REXX but it is distinct from all three. Essential to its functionality is the fact that Macintosh applications publish "dictionaries" of addressable objects and operations.

AppleScript has some elements of procedural programming, object-oriented programming (particularly in the construction of script objects), and natural language programming tendencies in its syntax, but does not strictly conform to any of these programming paradigms. [5] :xxvi

History

In the late 1980s Apple considered using HyperCard's HyperTalk scripting language as the standard language for end-user development across the company and within its classic Mac OS operating system, and for interprocess communication between Apple and non-Apple products. [6] HyperTalk could be used by novices to program a HyperCard stack. Apple engineers recognized that a similar, but more object-oriented scripting language could be designed to be used with any application, and the AppleScript project was born as a spin-off of a research effort to modernize the Macintosh as a whole and finally became part of System 7. [1]

AppleScript was released in October 1993 as part of System 7.1.1 (System 7 Pro, the first major upgrade to System 7). [1] QuarkXPress (ver. 3.2) was one of the first major software applications that supported AppleScript. This in turn led to AppleScript being widely adopted within the publishing and prepress world, often tying together complex workflows. This was a key factor in retaining the Macintosh's dominant position in publishing and prepress, even after QuarkXpress and other publishing applications were ported to Microsoft Windows.

After some uncertainty about the future of AppleScript on Apple's next generation OS, the move to Mac OS X (around 2002) and its Cocoa frameworks greatly increased the usefulness and flexibility of AppleScript. Cocoa applications allow application developers to implement basic scriptability for their apps with minimal effort, broadening the number of applications that are directly scriptable. At the same time, the shift to the Unix underpinnings and AppleScript's ability to run Unix commands directly, with the do shell script command, [7] allowed AppleScripts much greater control over the operating system itself. [5] :863 AppleScript Studio, released with Mac OS X 10.2 as part of Xcode, and later AppleScriptObjC framework, released in Mac OS X 10.6, allowed users to build Cocoa applications using AppleScript. [5] :969

In a 2006 article, Macworld included AppleScript among its rankings of Apple's 30 most significant products to date, placing it at #17. [8]

In a 2013 article for Macworld, veteran Mac software developer and commentator John Gruber concluded his reflection on "the unlikely persistence of AppleScript" by noting: "In theory, AppleScript could be much better; in practice, though, it's the best thing we have that works. It exemplifies the Mac's advantages over iOS for tinkerers and advanced users." [9]

In October 2016, longtime AppleScript product manager and automation evangelist Sal Soghoian left Apple when his position was eliminated "for business reasons". [10] Veterans in the Mac community such as John Gruber and Andy Ihnatko generally responded with concern, questioning Apple's commitment to the developer community and pro users. [11] Apple senior vice president of software engineering Craig Federighi responded in an email saying that "We have every intent to continue our support for the great automation technologies in macOS!", though Jeff Gamet at The Mac Observer opined that it did little to assuage his doubt about the future of Apple automation in general and AppleScript in particular. [12] For the time being, AppleScript remains one component of macOS automation technologies, along with Automator, Shortcuts, Services, and shell scripting.

Basic concepts

AppleScript was designed to be used as an accessible end-user scripting language, offering users an intelligent mechanism to control applications, and to access and modify data and documents. AppleScript uses Apple events, a set of standardized data formats that the Macintosh operating system uses to send information to applications, roughly analogous to sending XPath queries over XML-RPC in the world of web services. [5] :xxvi Apple events allow a script to work with multiple applications simultaneously, passing data between them so that complex tasks can be accomplished without human interaction. [4] For example, an AppleScript to create a simple web gallery might do the following:

  1. Open a photo in a photo-editing application (by sending that application an Open File Apple event).
  2. Tell the photo-editing application to manipulate the image (e.g. reduce its resolution, add a border, add a photo credit)
  3. Tell the photo-editing application to save the changed image in a file in some different folder (by sending that application a Save and/or Close Apple event).
  4. Send the new file path (via another Apple event) to a text editor or web editor application.
  5. Tell that editor application to write a link for the photo into an HTML file.
  6. Repeat the above steps for an entire folder of images (hundreds or even thousands of photos).
  7. Upload the HTML file and folder of revised photos to a website, by sending Apple events to a graphical FTP client, by using built-in AppleScript commands, or by sending Apple events to Unix FTP utilities.

For the user, hundreds or thousands of steps in multiple applications have been reduced to the single act of running the script, and the task is accomplished in much less time and with no possibility of random human error. A large complex script could be developed to run only once, while other scripts are used again and again.

An application's scriptable elements are visible in the application's Scripting Dictionary (distributed as part of the application), which can be viewed in any script editor. Elements are generally grouped into suites, according to loose functional relationships between them. There are two basic kinds of elements present in any suite: classes and commands.

All scriptable applications share a few basic commands and objects, usually called the Standard Suite—commands to open, close or save a file, to print something, to quit, to set data to variables—as well as a basic application object that gives the scriptable properties of the application itself. Many applications have numerous suites capable of performing any task the application itself can perform. In exceptional cases, applications may support plugins which include their own scripting dictionaries.

AppleScript was designed with the ability to build scripts intuitively by recording user actions. Such AppleScript recordability has to be engineered into the app—the app must support Apple events and AppleScript recording; [13] as Finder supports AppleScript recording, it can be useful for reference. When AppleScript Editor (Script Editor) is open and the Record button clicked, user actions for recordable apps are converted to their equivalent AppleScript commands and output to the Script Editor window. The resulting script can be saved and re-run to duplicate the original actions, or modified to be more generally useful.

Comments

Comments can be made multiple ways. A one-line comment can begin with 2 hyphens (--). In AppleScript 2.0, first released in Mac OS X Leopard, it may also begin with a number sign (#). This permits a self-contained AppleScript script to be stored as an executable text file beginning with the shebang line #!/usr/bin/osascript Example:

--This is a one line comment# So is this! (in Mac OS X Leopard or later)

For comments that take up multiple lines, AppleScript uses parentheses with asterisks inside. Example:

(* This is amultiplelinecomment *)

Hello, world!

In AppleScript, the traditional "Hello, World!" program could be written in many different forms, including:

display dialog"Hello, world!"-- a modal window with "OK" and "Cancel" buttons-- ordisplay alert"Hello, world!"-- a modal window with a single "OK" button and an icon representing the app displaying the alert-- orsay"Hello, world!"-- an audio message using a synthesized computer voice

AppleScript has several user interface options, including dialogs, alerts, and list of choices. (The character ¬, produced by typing ⌥ Option+return in the Script Editor, denotes continuation of a single statement across multiple lines.)

-- DialogsetdialogReplytodisplay dialog"Dialog Text"¬defaultanswer"Text Answer"¬hiddenanswerfalse¬buttons{"Skip","Okay","Cancel"}¬defaultbutton"Okay"¬cancelbutton"Skip"¬withtitle"Dialog Window Title"¬withiconnote¬givingupafter15
-- Choose from listsetchosenListItemtochoose from list{"A","B","3"}¬withtitle"List Title"¬withprompt"Prompt Text"¬defaultitems"B"¬OKbuttonname"Looks Good!"¬cancelbuttonname"Nope, try again"¬multipleselectionsallowedfalse¬withemptyselectionallowed
-- AlertsetresultAlertReplytodisplay alert"Alert Text"¬aswarning¬buttons{"Skip","Okay","Cancel"}¬defaultbutton2¬cancelbutton1¬givingupafter2

Each user interaction method can return the values of buttons clicked, items chosen or text entered for further processing. For example:

display alert"Hello, world!"buttons{"Rudely decline","Happily accept"}settheAnswertobutton returnedoftheresultiftheAnsweris"Happily accept"thenbeep5elsesay"Piffle!"endif

Natural language metaphor

Whereas Apple events are a way to send messages into applications, AppleScript is a particular language designed to send Apple events. In keeping with the objective of ease-of-use for beginners, the AppleScript language is designed on the natural language metaphor, just as the graphical user interface is designed on the desktop metaphor. A well-written AppleScript should be clear enough to be read and understood by anyone, and easily edited. The language is based largely on HyperCard's HyperTalk language, extended to refer not only to the HyperCard world of cards and stacks, but also theoretically to any document. To this end, the AppleScript team introduced the AppleEvent Object Model (AEOM), which specifies the objects any particular application "knows".

The heart of the AppleScript language is the use of terms that act as nouns and verbs that can be combined. For example, rather than a different verb to print a page, document or range of pages (such as printPage, printDocument, printRange), AppleScript uses a single "print" verb which can be combined with an object, such as a page, a document or a range of pages.

printpage1printdocument2printpages1thru5ofdocument2

Generally, AEOM defines a number of objects—like "document" or "paragraph"—and corresponding actions—like "cut" and "close". The system also defines ways to refer to properties of objects, so one can refer to the "third paragraph of the document 'Good Day'", or the "color of the last word of the front window". AEOM uses an application dictionary to associate the Apple events with human-readable terms, allowing the translation back and forth between human-readable AppleScript and bytecode Apple events. To discover what elements of a program are scriptable, dictionaries for supported applications may be viewed. (In the Xcode and Script Editor applications, this is under File → Open Dictionary.)

To designate which application is meant to be the target of such a message, AppleScript uses a "tell" construct:

tellapplication"Microsoft Word"quitendtell

Alternatively, the tell may be expressed in one line by using an infinitive:

tellapplication"Microsoft Word"toquit

For events in the "Core Suite" (activate, open, reopen, close, print, and quit), the application may be supplied as the direct object to transitive commands:

quitapplication"Microsoft Word"

The concept of an object hierarchy can be expressed using nested blocks:

tellapplication"QuarkXPress"telldocument1tellpage2telltextbox1setword5to"Apple"endtellendtellendtellendtell

The concept of an object hierarchy can also be expressed using either nested prepositional phrases or a series of possessives:

pixel7ofrow3ofTIFFimage"my bitmap"TIFFimage"my bitmap"'s 3rdrow's 7thpixel

which in another programming language might be expressed as sequential method calls, like in this pseudocode:

getTIFF("my bitmap").getRow(3).getPixel(7);

AppleScript includes syntax for ordinal counting, "the first paragraph", as well as cardinal, "paragraph one". Likewise, the numbers themselves can be referred to as text or numerically, "five", "fifth" and "5" are all supported; they are synonyms in AppleScript. Also, the word "the" can legally be used anywhere in the script in order to enhance readability: it has no effect on the functionality of the script.

Examples of scripts

A failsafe calculator:

tellapplication"Finder"-- Set variablessetthe1totext returnedof(display dialog"1st"defaultanswer"Number here"buttons{"Continue"}defaultbutton1)setthe2totext returnedof(display dialog"2nd"defaultanswer"Number here"buttons{"Continue"}defaultbutton1)trysetthe1tothe1asintegersetthe2tothe2asintegeronerrordisplay dialog"You may only input numbers into a calculator."withtitle"ERROR"buttons{"OK"}defaultbutton1returnendtry-- Add?ifthebutton returnedof(display dialog"Add?"buttons{"No","Yes"}defaultbutton2)is"Yes"thensetansto(the1+the2)display dialoganswithtitle"Answer"buttons{"OK"}defaultbutton1sayans-- Subtract? elseifthebutton returnedof(display dialog"Subtract?"buttons{"No","Yes"}defaultbutton2)is"Yes"thensetansto(the1-the2)display dialoganswithtitle"Answer"buttons{"OK"}defaultbutton1sayans-- Multiply? elseifthebutton returnedof(display dialog"Multiply?"buttons{"No","Yes"}defaultbutton2)is"Yes"thensetansto(the1*the2)display dialoganswithtitle"Answer"buttons{"OK"}defaultbutton1sayans-- Divide? elseifthebutton returnedof(display dialog"Divide?"buttons{"No","Yes"}defaultbutton2)is"Yes"thensetansto(the1/the2)display dialoganswithtitle"Answer"buttons{"OK"}defaultbutton1sayanselsedelay1say"You haven't selected a function. The operation has cancelled."endifendtell

A simple username and password dialog box sequence. Here, the username is John and password is app123:

tellapplication"Finder"setpassAnsto"app123"setuserAnsto"John"ifthetext returnedof(display dialog"Username"defaultanswer"")isuserAnsthendisplay dialog"Correct"buttons{"Continue"}defaultbutton1ifthetext returnedof(display dialog"Username : John"&return&"Password"defaultanswer""buttons{"Continue"}defaultbutton1withhiddenanswer)ispassAnsthendisplay dialog"Access granted"buttons{"OK"}defaultbutton1elsedisplay dialog"Incorrect password"buttons{"OK"}defaultbutton1endifelsedisplay dialog"Incorrect username"buttons{"OK"}defaultbutton1endifendtell

Development tools

Script editors

Script editors provide a unified programing environment for AppleScripts, including tools for composing, validating, compiling, running, and debugging scripts. They also provide mechanisms for opening and viewing AppleScript dictionaries from scriptable applications, saving scripts in a number of formats (compiled script files, application packages, script bundles, and plain text files), and usually provide features such as syntax highlighting and prewritten code snippets.

From Apple

AppleScript Editor (Script Editor)
The editor for AppleScript packaged with macOS, called AppleScript Editor in Mac OS X Snow Leopard (10.6) through OS X Mavericks (10.9) and Script Editor in all earlier and later versions of macOS. Scripts are written in document editing windows where they can be compiled and run, and these windows contain various panes in which logged information, execution results, and other information is available for debugging purposes. Access to scripting dictionaries and prewritten code snippets is available through the application menus. Since OS X Yosemite (10.10), Script Editor includes the ability to write in both AppleScript and JavaScript. [14]
Xcode
A suite of tools for developing applications with features for editing AppleScripts or creating full-fledged applications written with AppleScript.

From third parties

Script Debugger, from Late Night Software
A third-party commercial IDE for AppleScript. Script Debugger is a more advanced AppleScript environment that allows the script writer to debug AppleScripts via single stepping, breakpoints, stepping in and out of functions/subroutines, variable tracking, etc. Script Debugger also contains an advanced dictionary browser that allows the user to see the dictionary in action in real world situations. That is, rather than just a listing of what the dictionary covers, one can open a document in Pages, for example, and see how the dictionary's terms apply to that document, making it easier to determine which parts of the dictionary to use. Script Debugger is not designed to create scripts with a GUI, other than basic alerts and dialogs, but is focused more on the coding and debugging of scripts.
Smile and SmileLab
A third-party freeware/commercial IDE for AppleScript, itself written entirely in AppleScript. [15] Smile is free, and primarily designed for AppleScript development. SmileLab is commercial software with extensive additions for numerical analysis, graphing, machine automation and web production. Smile and SmileLab use an assortment of different windows—AppleScript windows for running and saving full scripts, AppleScript terminals for testing code line-by-line, unicode windows for working with text and XML. Users can create complex interfaces—called dialogs—for situations where the built-in dialogs in AppleScript are insufficient.
ASObjC Explorer 4, from Shane Stanley
A discontinued third-party commercial IDE for AppleScript, especially for AppleScriptObjC. [16] The main feature is Cocoa-object/event logging, debugging and code-completion. Users can read Cocoa events and objects like other scriptable applications. This tool was originally built for AppleScript Libraries (available in OS X Mavericks). AppleScript Libraries aims for re-usable AppleScript components and supports built-in AppleScript dictionary (sdef). ASObjC Explorer 4 can be an external Xcode script editor, too.
FaceSpan, from Late Night Software
A discontinued third-party commercial IDE for creating AppleScript applications with graphic user interfaces. [17]

Script launchers

AppleScripts can be run from a script editor, but it is usually more convenient to run scripts directly, without opening a script editor application. There are a number of options for doing so:

Applets
AppleScripts can be saved from a script editor as applications (called applets, or droplets when they accept input via drag and drop). [5] :69 Applets can be run from the Dock, from the toolbar of Finder windows, from Spotlight, from third-party application launchers, or from any other place where applications can be run.
Folder actions
Using AppleScript folder actions, scripts can be launched when specific changes occur in folders (such as adding or removing files). [18] Folder actions can be assigned by clicking on a folder and choosing Folder Actions Setup... from the contextual menu; the location of this command differs slightly in Mac OS X 10.6.x from earlier versions. This same action can be achieved with third-party utilities such as Hazel. [19]
Hotkey launchers
Keyboard shortcuts can be assigned to AppleScripts in the script menu using the Keyboard & Mouse Settings Preference Pane in System Preferences. In addition, various third-party utilities are available—Alfred, [20] FastScripts, [21] Keyboard Maestro, [22] QuicKeys, [23] Quicksilver, [24] TextExpander [25] —which can run AppleScripts on demand using key combinations.
Script menu
This system-wide menu provides access to AppleScripts from the macOS menu bar, visible no matter what application is running. [26] (In addition, many Apple applications, some third-party applications, and some add-ons provide their own script menus. These may be activated in different ways, but all function in essentially the same manner.) Selecting a script in the script menu launches it. Since Mac OS X 10.6.x, the system-wide script menu can be enabled from the preferences of Script Editor; in prior versions of Mac OS X, it could be enabled from the AppleScript Utility application. When first enabled, the script menu displays a default library of fairly generic, functional AppleScripts, which can also be opened in Script Editor and used as examples for learning AppleScript. Scripts can be organized so that they only appear in the menu when particular applications are in the foreground.
Unix command line and launchd
AppleScripts can be run from the Unix command line, or from launchd for scheduled tasks, [5] :716 by using the osascript command line tool. [27] The osascript tool can run compiled scripts (.scpt files) and plain text files (.applescript files—these are compiled by the tool at runtime). Script applications can be run using the Unix open command.

AppleScript resources

AppleScript Libraries

Re-usable AppleScript modules (available since OS X Mavericks), written in AppleScript or AppleScriptObjC and saved as script files or bundles in certain locations, [28] that can be called from other scripts. When saved as a bundle, a library can include an AppleScript dictionary (sdef) file, [29] thus functioning like a scripting addition but written in AppleScript or AppleScriptObjC.

AppleScript Studio

A framework for attaching Cocoa interfaces to AppleScript applications, part of the Xcode package in Mac OS X 10.4 and 10.5, now deprecated in favor of AppleScriptObjC. [30] :438

AppleScriptObjC

A Cocoa development software framework, also called AppleScript/Objective-C or ASOC, [31] part of the Xcode package since Mac OS X Snow Leopard. [32] AppleScriptObjC allows AppleScripts to use Cocoa classes and methods directly. [33] The following table shows the availability of AppleScriptObjC in various versions of macOS: [34]

Where AppleScriptObjC can be used in each macOS version
In Xcode In appletsIn AppleScript
Libraries
In Script Editor
10.6 Yes check.svg
10.7 Yes check.svgYes check.svg
10.8 Yes check.svgYes check.svg
10.9 Yes check.svgYes check.svgYes check.svg
10.10 Yes check.svgYes check.svgYes check.svgYes check.svg

AppleScriptObjC can be used in all subsequent Mac OS X versions.

Automator

A graphical, modular editing environment in which workflows are built up from actions. It is intended to duplicate many of the functions of AppleScript without the necessity for programming knowledge. Automator has an action specifically designed to contain and run AppleScripts, for tasks that are too complex for Automator's simplified framework. [35]

Scriptable core system applications

These background-only applications, packaged with macOS, are used to allow AppleScript to access features that would not normally be scriptable. As of Mac OS X 10.6.3 they include the scriptable applications for:

  • VoiceOver (scriptable auditory and braille screen reader package)
  • System Events (control of non-scriptable applications and access to certain system functions and basic file operations)
  • Printer Setup Utility (scriptable utility for handling print jobs)
  • Image Events (core image manipulation)
  • HelpViewer (scriptable utility for showing help displays)
  • Database Events (minimal SQLite3 database interface)
  • AppleScript Utility (for scripting a few AppleScript related preferences)

Scripting Additions (OSAX)

Plug-ins for AppleScript developed by Apple or third parties. [36] They are designed to extend the built-in command set, expanding AppleScript's features and making it somewhat less dependent on functionality provided by applications. macOS includes a collection of scripting additions referred to as Standard Additions (StandardAdditions.osax) that adds a set of commands and classes that are not part of AppleScript's core features, including user interaction dialogs, reading and writing files, file system commands, date functions, and text and mathematical operations; without this OSAX, AppleScript would have no capacity to perform many basic actions not directly provided by an application.

Language essentials

Classes (data types)

While applications can define specialized classes (or data types), AppleScript also has a number of built-in classes. These basic data classes are directly supported by the language and tend to be universally recognized by scriptable applications. The most common ones are as follows:

Language structures

Many AppleScript processes are managed by blocks of code, where a block begins with a command command and ends with an end command statement. The most important structures are described below.

Conditionals

AppleScript offers two kinds of conditionals.

-- Simple conditionalifx<1000thensetxtox+1-- Compound conditionalifxis greater than3then-- commandselse-- other commandsendif

Loops

The repeat loop of AppleScript comes in several slightly different flavors. They all execute the block between repeat and end repeat lines a number of times. The looping can be prematurely stopped with command exit repeat.

Repeat forever.

repeat-- commands to be repeatedendrepeat

Repeat a given number of times.

repeat10times-- commands to be repeatedendrepeat

Conditional loops. The block inside repeat while loop executes as long as the condition evaluates to true. The condition is re-evaluated after each execution of the block. The repeat until loop is otherwise identical, but the block is executed as long as the condition evaluates to false.

setxto5repeatwhilex>0setxtox-1endrepeatsetxto5repeatuntilx0setxtox-1endrepeat

Loop with a variable. When starting the loop, the variable is assigned to the start value. After each execution of the block, the optional step value is added to the variable. Step value defaults to 1.

-- repeat the block 2000 times, i gets all values from 1 to 2000repeatwithifrom1to2000-- commands to be repeatedendrepeat-- repeat the block 4 times, i gets values 100, 75, 50 and 25repeatwithifrom100to25by-25-- commands to be repeated endrepeat

Enumerate a list. On each iteration set the loopVariable to a new item in the given list

settotalto0repeatwithloopVariablein{1,2,3,4,5}settotaltototal+loopVariableendrepeat
Application targetingError handling
-- Simple formtellapplication"Safari"toactivate-- Compoundtellapplication"MyApp"-- commands for appendtell
try-- commands to be testedonerror-- error commands endtry

One important variation on this block structure is in the form of on end ... blocks that are used to define handlers (function-like subroutines). Handlers begin with on functionName() and ending with end functionName, and are not executed as part of the normal script flow unless called from somewhere in the script.

Function handlerFolder actions blockRun handler
onmyFunction(parameters...)-- subroutine commands endmyFunction
onaddingfolderitemstothisFolderafterreceivingtheseItems-- commands to apply to the folder or items  endaddingfolderitemsto
onrun-- commandsendrun

Handlers can also be defined using "to" in place of "on" and can be written to accept labeled parameters, not enclosed in parens.

Handler with labeled parametersHandler using "to" and labeled parameters
onrockaroundtheclockdisplay dialog(clockas string)endrock-- called with:rockaroundthecurrent date
tocheckforyourNumberfrombottomthrutopifbottomyourNumberandyourNumbertopthendisplay dialog"Congratulations! You scored."endifendcheck--called with:checkfor8from7thru10

There are four types of predefined handlers in AppleScript—run, open, idle, and quit—each of which is created in the same way as the run handler shown above.

Run handler
Defines the main code of the script, which is called when the script is run. Run handler blocks are optional, unless arguments are being passed to the script. If an explicit run handler block is omitted, then all code that is not contained inside handler blocks is executed as though it were in an implicit run handler.
Open handler
Defined using "on open theItems".
onopentheItemsrepeatwiththisItemintheItemstellapplication"Finder"toupdatethisItemendrepeatendopen

When a script containing an "open handler' is saved as an applet, the applet becomes a droplet. A droplet can be identified in the Finder by its icon, which includes an arrow, indicating items can be dropped onto the icon. The droplet's open handler is executed when files or folders are dropped onto droplet's icon. References to the items dropped on the droplet's icon are passed to the droplet's script as the parameter of the open handler. A droplet can also be launched the same way as an ordinary applet, executing its run handler.

Idle handler
A subroutine that is run periodically by the system when the application is idle.
on idle--code to execute when the script's execution has completedreturn60-- number of seconds to pause before executing idle handler againend idle

An idle handler can be used in applets or droplets saved as stay-open applets, and is useful for scripts that watch for particular data or events. The length of the idle time is 30 seconds by default, [39] but can be changed by including a 'return x' statement at the end of the subroutine, where x is the number of seconds the system should wait before running the handler again.

Quit handler
A handler that is run when the applet receives a Quit request. This can be used to save data or do other ending tasks before quitting.
onquit--commands to execute before the script quitscontinuequit-- required for the script to actually quitendquit
Script objects

Script objects may be defined explicitly using the syntax:

scriptscriptName-- commands and handlers specific to the scriptendscript

Script objects can use the same 'tell' structures that are used for application objects, and can be loaded from and saved to files. Runtime execution time can be reduced in some cases by using script objects.

Miscellaneous information

tellapplication"Finder"setxtomymyHandler()-- orsetxtomyHandler()ofmeendtellonmyHandler()--commandsendmyHandler

Using the same technique for scripting addition commands can reduce errors and improve performance.

tellapplication"Finder"setanyNumbertomy(random numberfrom5to50)endtell

Open Scripting Architecture

An important aspect of the AppleScript implementation is the Open Scripting Architecture (OSA). [40] Apple provides OSA for other scripting languages and third-party scripting/automation products such as QuicKeys and UserLand Frontier, to function on an equal status with AppleScript. AppleScript was implemented as a scripting component, and the basic specs for interfacing such components to the OSA were public, allowing other developers to add their own scripting components to the system. Public client APIs for loading, saving and compiling scripts would work the same for all such components, which also meant that applets and droplets could hold scripts in any of those scripting languages.

One feature of the OSA is scripting additions, or OSAX for Open Scripting Architecture eXtension, [36] which were inspired by HyperCard's External Commands. Scripting additions are libraries that allow programmers to extend the function of AppleScript. Commands included as scripting additions are available system-wide, and are not dependent on an application (see also § AppleScript Libraries). The AppleScript Editor is also able to directly edit and run some of the OSA languages.

JavaScript for Automation

Under OS X Yosemite and later versions of macOS, the JavaScript for Automation (JXA) component remains the only serious OSA language alternative to AppleScript, [14] though the Macintosh versions of Perl, Python, Ruby, and Tcl all support native means of working with Apple events without being OSA components. [30] :516

JXA also provides an Objective-C (and C language) foreign language interface. [14] Being an environment based on WebKit's JavaScriptCore engine, the JavaScript feature set is in sync with the system Safari browser engine. JXA provides a JavaScript module system and it is also possible to use CommonJS modules via browserify. [41]

See also

Related Research Articles

A file manager or file browser is a computer program that provides a user interface to manage files and folders. The most common operations performed on files or groups of files include creating, opening, renaming, copying, moving, deleting and searching for files, as well as modifying file attributes, properties and file permissions. Folders and files may be displayed in a hierarchical tree based on their directory structure.

HyperTalk is a discontinued high-level, procedural programming language created in 1987 by Dan Winkler and used in conjunction with Apple Computer's HyperCard hypermedia program by Bill Atkinson. Because the main target audience of HyperTalk was beginning programmers, HyperTalk programmers were usually called "authors" and the process of writing programs was known as "scripting". HyperTalk scripts resembled written English and used a logical structure similar to that of the Pascal programming language.

<span class="mw-page-title-main">Finder (software)</span> Macintosh file manager and GUI shell

The Finder is the default file manager and graphical user interface shell used on all Macintosh operating systems. Described in its "About" window as "The Macintosh Desktop Experience", it is responsible for the launching of other applications, and for the overall user management of files, disks, and network volumes. It was introduced with the first Macintosh computer, and also exists as part of GS/OS on the Apple IIGS. It was rewritten completely with the release of Mac OS X in 2001.

In computing, a window is a graphical control element. It consists of a visual area containing some of the graphical user interface of the program it belongs to and is framed by a window decoration. It usually has a rectangular shape that can overlap with the area of other windows. It displays the output of and may allow input to one or more processes.

<span class="mw-page-title-main">Drag and drop</span> Action in computer graphic user interfaces

In computer graphical user interfaces, drag and drop is a pointing device gesture in which the user selects a virtual object by "grabbing" it and dragging it to a different location or onto another virtual object. In general, it can be used to invoke many kinds of actions, or create various types of associations between two abstract objects.

<span class="mw-page-title-main">File Explorer</span> File manager application that is included with releases of the Microsoft Windows operating system

File Explorer, previously known as and still sometimes called Windows Explorer, is a file manager application and default desktop environment that is included with releases of the Microsoft Windows operating system from Windows 95 onwards. It provides a graphical user interface for accessing the file systems. It is also the component of the operating system that presents many user interface items on the screen such as the taskbar and desktop. Controlling the computer is possible without File Explorer running. After the name change that was introduced in Windows 8, Windows Explorer name can still be seen when you look for it in the Windows Task Manager.

The Taskbar is a graphical user interface element that has been part of Microsoft Windows since Windows 95, displaying and facilitating switching between running programs. The Taskbar and the associated Start Menu were created and named in 1993 by Daniel Oran, a program manager at Microsoft who had previously collaborated on Great ape language research with the behavioral psychologist B.F. Skinner at Harvard.

<span class="mw-page-title-main">Aqua (user interface)</span> User interface of macOS by Apple

Aqua is the graphical user interface, design language and visual theme of Apple's macOS operating system. It was originally based on the theme of water, with droplet-like components and a liberal use of reflection effects and translucency. Its goal is to "incorporate color, depth, translucence, and complex textures into a visually appealing interface" in macOS applications. At its introduction, Steve Jobs noted that "... it's liquid, one of the design goals was when you saw it you wanted to lick it".

<span class="mw-page-title-main">ActionScript</span> Object-oriented programming language created for the Flash multimedia platform

ActionScript is an object-oriented programming language originally developed by Macromedia Inc.. It is influenced by HyperTalk, the scripting language for HyperCard. It is now an implementation of ECMAScript, though it originally arose as a sibling, both being influenced by HyperTalk. ActionScript code is usually converted to byte-code format by a compiler.

PlainTalk is the collective name for several speech synthesis (MacinTalk) and speech recognition technologies developed by Apple Inc. In 1990, Apple invested a lot of work and money in speech recognition technology, hiring many researchers in the field. The result was "PlainTalk", released with the AV models in the Macintosh Quadra series from 1993. It was made a standard system component in System 7.1.2, and has since been shipped on all PowerPC and some 68k Macintoshes.

In classic Mac OS System 7 and later, and in macOS, an alias is a small file that represents another object in a local, remote, or removable file system and provides a dynamic link to it; the target object may be moved or renamed, and the alias will still link to it. In Windows, a "shortcut", a file with a .lnk extension, performs a similar function.

<span class="mw-page-title-main">Spotlight (Apple)</span> macOS search feature

Spotlight is a system-wide desktop search feature of Apple's macOS and iOS operating systems. Spotlight is a selection-based search system, which creates an index of all items and files on the system. It is designed to allow the user to quickly locate a wide variety of items on the computer, including documents, pictures, music, applications, and System Settings. In addition, specific words in documents and in web pages in a web browser's history or bookmarks can be searched. It also allows the user to narrow down searches with creation dates, modification dates, sizes, types and other attributes. Spotlight also offers quick access to definitions from the built-in New Oxford American Dictionary and to calculator functionality. There are also command-line tools to perform functions such as Spotlight searches.

Apple events are the message-based interprocess communication mechanism in Mac OS, first making an appearance in System 7 and supported by every version of the classic Mac OS since then and by macOS. Apple events describe "high-level" events such as "open document" or "print file", whereas earlier OSs had supported much more basic events, namely "click" and "keypress". Apple events form the basis of the Mac OS scripting system, the Open Scripting Architecture.

In the macOS, iOS, NeXTSTEP, and GNUstep programming frameworks, property list files are files that store serialized objects. Property list files use the filename extension .plist, and thus are often referred to as p-list files.

The Apple Developer Tools are a suite of software tools from Apple to aid in making software dynamic titles for the macOS and iOS platforms. The developer tools were formerly included on macOS install media, but are now exclusively distributed over the Internet. As of macOS 10.12, Xcode is available as a free download from the Mac App Store.

SuperTalk is the scripting language used in SuperCard. SuperTalk is a descendant of HyperTalk.

<span class="mw-page-title-main">Workbench (AmigaOS)</span> Graphical user interface for the Amiga computer

Workbench is the desktop environment and graphical file manager of AmigaOS developed by Commodore International for their Amiga line of computers. Workbench provides the user with a graphical interface to work with file systems and launch applications. It uses a workbench metaphor for representing file system organisation.

<span class="mw-page-title-main">Control Strip</span>

The Control Strip is a user interface component introduced in the "classic" System 7 Macintosh operating system. It currently exists as part of the Touch Bar interface in macOS.

<span class="mw-page-title-main">AmigaOS</span> Operating system for Amiga computers

AmigaOS is a family of proprietary native operating systems of the Amiga and AmigaOne personal computers. It was developed first by Commodore International and introduced with the launch of the first Amiga, the Amiga 1000, in 1985. Early versions of AmigaOS required the Motorola 68000 series of 16-bit and 32-bit microprocessors. Later versions were developed by Haage & Partner and then Hyperion Entertainment. A PowerPC microprocessor is required for the most recent release, AmigaOS 4.

References

  1. 1 2 3 Cook, William (2007). "AppleScript" (PDF). Proceedings of the third ACM SIGPLAN conference on History of programming languages. Association for Computing Machinery. pp. 1–21. doi:10.1145/1238844.1238845. ISBN   9781595937667. S2CID   220938191.
  2. Apple Inc. (2022). Script Editor (Version 2.11). Retrieved November 11, 2022.
  3. "OS X 10.10 Yosemite release date". October 16, 2014. Retrieved November 16, 2014.
  4. 1 2 3 4 Goldstein, Adam (2005). AppleScript: the missing manual. Sebastopol, CA: O'Reilly Media. ISBN   0596008503. OCLC   56912218.
  5. 1 2 3 4 5 6 7 8 9 Sanderson, Hamish; Rosenthal, Hanaan (2009). "Interacting with the Unix Command Line". Learn AppleScript (3rd ed.). Berkeley: Apress. pp. 863–896. doi:10.1007/978-1-4302-2362-7_27. ISBN   9781430223610. OCLC   308193726.
  6. Flynn, Laurie (February 27, 1989). "Apple Ponders Standardizing on HyperTalk". InfoWorld . Vol. 11, no. 9. p. 31.
  7. "AppleScript Language Guide commands reference: do shell script". developer.apple.com. Retrieved September 15, 2019.
  8. "Apple's greatest hits: 30 significant products". macworld.com. Retrieved September 12, 2019.
  9. Gruber, John (March 2013). "The unlikely persistence of AppleScript". Macworld . 30 (3): 100.
  10. Lovejoy, Ben (November 17, 2016). "Sal Soghoian says 'ask Apple' about future of Mac user automation as company eliminates position". 9to5mac.com. Retrieved May 8, 2017.
  11. Evans, Jonny (November 17, 2016). "Does Apple really want to kill Automator, AppleScript? Shock termination of veteran Apple developer guru sends shockwaves across the Mac community". Computerworld.com. Retrieved May 8, 2017.
  12. Gamet, Jeff (November 23, 2016). "Apple's intent isn't the same as committing to mac automation". macobserver.com. Retrieved May 8, 2017.
  13. "Scriptable Applications". developer.apple.com. Retrieved July 26, 2018.
  14. 1 2 3 Siracusa, John (October 16, 2014). "OS X 10.10 Yosemite: The Ars Technica Review: JavaScript automation". Ars Technica . Retrieved May 8, 2017.
  15. "Smile and SmileLab Home Page". satimage.fr. Retrieved May 8, 2017.
  16. "ASObjC Explorer 4 Discontinued". macosxautomation.com. Archived from the original on June 21, 2017. Retrieved May 8, 2017.
  17. "Mark Alldritt's Journal » FaceSpan". blog.latenightsw.com. Retrieved May 8, 2017.
  18. "AppleScript Language Guide: Folder Actions Reference". developer.apple.com. Retrieved May 8, 2017.
  19. Miller, Dan (December 22, 2010). "Capsule review: Hazel 2.3". Macworld.com. Retrieved May 8, 2017.
  20. Beam, Brian (February 10, 2015). "Alfred review: This Mac app launcher continues to shine, but Alfred Remote doesn't stack up". Macworld.com. Retrieved May 10, 2017.
  21. Frakes, Dan (June 2, 2011). "Capsule review: FastScripts 2.5". Macworld.com. Retrieved May 8, 2017.
  22. Breen, Christopher (June 4, 2013). "Mac Gems: Keyboard Maestro 6 is a genius at repetitive tasks". Macworld.com. Retrieved May 10, 2017.
  23. Breen, Christopher (May 7, 2010). "Capsule review: QuicKeys 4". Macworld.com. Retrieved May 8, 2017.
  24. "AppleScripts – Quicksilver Wiki". qsapp.com. Retrieved May 10, 2017.
  25. Fleishman, Glenn (June 12, 2015). "TextExpander 5 review". Macworld.com. Retrieved May 8, 2017.
  26. "Mac Automation Scripting Guide: Using the Systemwide Script Menu". developer.apple.com. Retrieved May 8, 2017.
  27. "osascript(1) Mac OS X Manual Page". developer.apple.com. Retrieved May 8, 2017.
  28. "AppleScript Libraries". macosautomation.com. Archived from the original on July 26, 2020. Retrieved May 8, 2017.
  29. "WWDC 2013 Session 416: Introducing AppleScript Libraries". asciiwwdc.com. Retrieved May 8, 2017.
  30. 1 2 Neuburg, Matt (2006). AppleScript: the definitive guide (2nd ed.). Beijing: O'Reilly Media. ISBN   0596102119. OCLC   68694976.
  31. Tsai, Michael (September 29, 2014). "AppleScript and Yosemite". mjtsai.com. Retrieved May 9, 2017.
  32. "AppleScriptObjC Release Notes". developer.apple.com. Retrieved May 8, 2017.
  33. Waldie, Ben (September 6, 2012). "Building a basic AppleScriptObjC (Cocoa-AppleScript) application with Xcode". peachpit.com. Retrieved May 9, 2017.
  34. Table adapted from: Naganoya, Takaaki. "ASObjCExtras Scripting Guide" (PDF). piyocast.com. Archived (PDF) from the original on October 9, 2022. Retrieved May 9, 2017.
  35. "Introduction to Automator AppleScript Actions Tutorial". developer.apple.com. Retrieved May 8, 2017.
  36. 1 2 "Technical Note TN1164: Scripting Additions for Mac OS X". developer.apple.com. Retrieved May 8, 2017.
  37. "AppleScript Release Notes: 10.5 Changes". developer.apple.com. Retrieved May 8, 2017.
  38. "POSIX file — Class Reference — AppleScript Language Guide". developer.apple.com. Retrieved January 8, 2018.
  39. "AppleScript Language Guide: Handlers in Script Applications". developer.apple.com. Retrieved July 21, 2013.
  40. "AppleScript Overview: Open Scripting Architecture". developer.apple.com. Retrieved May 8, 2017.
  41. "Importing Scripts". GitHub. JXA-Cookbook. December 6, 2019. Retrieved December 9, 2019.

Further reading