-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing6.html
executable file
·474 lines (360 loc) · 20.6 KB
/
listing6.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>SimpleScriptingVerbs - /ReadMe.txt</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/ScriptingAutomation/index.html">Scripting & Automation</a> > <a href="../../samplecode/ScriptingAutomation/idxCocoa-date.html">Cocoa</a> > <A HREF="javascript:location.replace('index.html');">SimpleScriptingVerbs</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">SimpleScriptingVerbs</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/ReadMe.txt</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/CommandWithArgs.h</option>
<option value="listing2.html">/CommandWithArgs.m</option>
<option value="listing3.html">/DirectParameterCommand.h</option>
<option value="listing4.html">/DirectParameterCommand.m</option>
<option value="listing5.html">/main.m</option>
<option value="listing6.html">/ReadMe.txt</option>
<option value="listing7.html">/scriptLog.h</option>
<option value="listing8.html">/SimpleCommand.h</option>
<option value="listing9.html">/SimpleCommand.m</option>
<option value="listing10.html">/SimpleScriptingVerbs.sdef</option>
<option value="listing11.html">/SimpleScriptingVerbsTest.applescript</option></select>
</p>
</form>
<p><strong><a href="SimpleScriptingVerbs.zip">Download Sample</a></strong> (“SimpleScriptingVerbs.zip”, 59.0K)<BR>
<strong><a href="SimpleScriptingVerbs.dmg">Download Sample</a></strong> (“SimpleScriptingVerbs.dmg”, 54.7K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">File: readme.txt
Abstract: readme file
Version: 1.0
Disclaimer: IMPORTANT: This Apple software is supplied to you by
Apple Inc. ("Apple") in consideration of your agreement to the
following terms, and your use, installation, modification or
redistribution of this Apple software constitutes acceptance of these
terms. If you do not agree with these terms, please do not use,
install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and
subject to these terms, Apple grants you a personal, non-exclusive
license, under Apple's copyrights in this original Apple software (the
"Apple Software"), to use, reproduce, modify and redistribute the Apple
Software, with or without modifications, in source and/or binary forms;
provided that if you redistribute the Apple Software in its entirety and
without modifications, you must retain this notice and the following
text and disclaimers in all such redistributions of the Apple Software.
Neither the name, trademarks, service marks or logos of Apple Inc.
may be used to endorse or promote products derived from the Apple
Software without specific prior written permission from Apple. Except
as expressly stated in this notice, no other rights or licenses, express
or implied, are granted by Apple herein, including but not limited to
any patent rights that may be infringed by your derivative works or by
other works in which the Apple Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE
MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
Copyright (C) 2008 Apple Inc. All Rights Reserved.
This sample is a follow-on to the SimpleScripting sample. It shows how to add
verbs to the terminology provided by a scriptable application. (A verb is a
command or action that can be invoked in a script.)
Step 1: Setting up
Create a new .sdef file that includes the standard scripting suite and add it
to your Xcode project. Usually, this file will have the same name as your
application. Going along with that convention, the .sdef file in this sample
has been named "SimpleScriptingVerbs.sdef". In the contents of that file, enter
an empty dictionary that includes the standard AppleScript suite as follows:
<dictionary xmlns:xi="http://www.w3.org/2003/XInclude">
<xi:include
href="file:///System/Library/ScriptingDefinitions/CocoaStandard.sdef"
xpointer="xpointer(/dictionary/suite)"/>
<!-- add your own suite definitions here -->
</dictionary>
The important parts of this definition are as follows:
1. The 'xi' namespace declaration in the opening dictionary element declares
that enclosed elements using the 'xi' namespace will follow conventions defined
by the XInclude standard. This will allow us to include the standard
definitions.
2. The 'xi:include' element includes the Standard Suite in the .sdef.
NOTE: Prior to Mac OS X 10.5 developers would copy the standard suite from the
ScriptingDefinitions sample
(http://developer.apple.com/samplecode/ScriptingDefinitions/index.html) directly
into their .sdef file. For backwards compatibility with Mac OS X 10.4, you may
continue to use that technique, but moving forward the XInclude technique
described above is recommended.
Step 2: Add a starting suite
Add a new suite to your .sdef file at the end of the dictionary just before the
closing </dictionary> tag:
<suite name="Simple Scripting Verbs" code="SVrb" description="Terminology for
the SimpleScriptingVerbs Sample.">
<!-- We'll put our verb definitions here -->
</suite>
It is inside of this suite definition where you will put your application
specific scripting information. You can add additional suites if you like and
use them to group related scripting functionality, but for most purposes one
suite should be sufficient.
Important points to note here:
- the suite has a unique four-character code associated with it 'SVrb' that
uniquely identifies our suite. We will used that four letter code when putting
together eight character code identifiers for our scripting commands (verbs).
Step 3: Add some verbs to the script suite.
These are the verbs we have added to this example:
(a) the 'do simple command' verb.
<command name="do simple command" code="SVrbSimp" description="run a simple
command with no parameters">
<cocoa class="SimpleCommand"/>
<result type="integer" description="returns the number seven"/>
</command>
This is a simple verb with no parameters. It returns an integer number. Verbs
don't get much simpler than this.
Important points to note here:
- Note the code value has eight characters in it. This is actually two four
character codes combined together. The first four characters will be the 'event
class' in the in the Apple event sent to your application for this command. And
the last four letters will be the 'event code' in the Apple event sent for the
command.
- the Cocoa class that implements the command is identified by the "<cocoa
class="SimpleCommand"/>" element in the xml. Here we identify the
'SimpleCommand' class that is implemented in the files SimpleCommand.h and
SimpleCommand.m. When Cocoa receives this command it will instantiate an
instance of the class SimpleCommand and then it will call the
-performDefaultImplementation method on that instance. You put your code for
performing the command in the performDefaultImplementation method of that class.
(b) the 'do direct parameter command' verb.
<command name="do direct parameter command" code="SVrbDpCm" description="run
a simple command with a direct parameter">
<cocoa class="DirectParameterCommand"/>
<direct-parameter description="a text parameter passed to the command">
<type type="text"/>
</direct-parameter>
<result type="text" description="the direct parameter enclosed in quotes"/>
</command>
This is a simple verb that receives a single string parameter and returns a
string value (a copy of the parameter enclosed in quotes).
Important points to note here:
- Note the code value has eight characters in it. This is actually two four
character codes combined together. The first four characters will be the 'event
class' in the in the Apple event sent to your application for this command. And
the last four letters will be the 'event code' in the Apple event sent for the
command. Here we have used the Suite's four letter code as the event class and
then we have used a unique four letter code as the event code.
- the Cocoa class that implements the command is identified by the "<cocoa
class="DirectParameterCommand"/>" element in the xml. Here we identify the
'DirectParameterCommand' class that is implemented in the files
DirectParameterCommand.h and DirectParameterCommand.m. When Cocoa receives this
command it will instantiate an instance of the class DirectParameterCommand and
then it will call the -performDefaultImplementation method on that instance.
You put your code for performing the command in the performDefaultImplementation
method of that class.
- inside of your performDefaultImplementation method you can access the
direct parameter by calling the [self directParameter].
(c) the 'do command with args' verb.
<command name="do command with args" code="SVrbAgCm" description="run a
command with a bunch of arguments">
<cocoa class="CommandWithArgs"/>
<direct-parameter description="a text parameter passed to the command">
<type type="text"/>
</direct-parameter>
<parameter name="blinking" code="savo" type="boolean" optional="yes"
description="a boolean parameter.">
<cocoa key="SaveOptions"/>
</parameter>
<parameter name="preferred hand" code="LRnd" type="preferredhands"
optional="yes"
description="a parameter using our enumeration.">
<cocoa key="TheHand"/>
</parameter>
<parameter name="prose" code="Pros" type="text" optional="yes"
description="a text parameter.">
<cocoa key="ProseText"/>
</parameter>
<parameter name="ivalue" code="iVal" type="integer" optional="yes"
description="an integer parameter.">
<cocoa key="IntegerValue"/>
</parameter>
<parameter name="rvalue" code="rVal" type="real" optional="yes"
description="an real number parameter.">
<cocoa key="RealValue"/>
</parameter>
<result type="text" description="the direct parameter enclosed in quotes"/>
</command>
This is a verb that receives a number of arguments and returns a string value
(either a copy of the prose parameter enclosed in quotes or, if the prose
parameter is not provided, a copy of the direct parameter enclosed in quotes).
Important points to note here:
- Note the code value has eight characters in it. This is actually two four
character codes combined together. The first four characters will be the 'event
class' in the in the Apple event sent to your application for this command. And
the last four letters will be the 'event code' in the Apple event sent for the
command. Here we have used the Suit's four letter code as the event class and
then we have used a unique four letter code as the event code.
- the Cocoa class that implements the command is identified by the "<cocoa
class="CommandWithArgs"/>" element in the xml. Here we identify the
'CommandWithArgs' class that is implemented in the files CommandWithArgs.h and
CommandWithArgs.m. When Cocoa receives this command it will instantiate an
instance of the class CommandWithArgs and then it will call the
-performDefaultImplementation method on that instance. You put your code for
performing the command in the performDefaultImplementation method of that class.
- each parameter has a cocoa key associated with it. For example, the
'rvalue' command has a cocoa key of 'RealValue' associated with it. Inside of
your performDefaultImplementation method you can retrieve all of the arguments
by calling [self evaluatedArguments]. The evaluatedArguments method will
return a NSDictionary with each of the arguments associated with their
respective Cocoa key. For example, inside of the performDefaultImplementation
method, you could call [[self evaluatedArguments] objectForKey:@"RealValue"] to
retrieve the value of the 'rvalue' parameter. Of course, if a parameter has
been marked as optional and the user has not provided that parameter, then there
will be no entry in the NSDictionary for its cocoa key.
- the 'preferred hand' parameter illustrates how you can use an AppleScript
enumeration as a parameter. For more information about using enumerations, see
the SimpleScriptingProperties example.
- even though we have provided a number of parameter definitions, verbs will
always receive a direct parameter. Inside of your performDefaultImplementation
method you can access this value by calling [self directParameter].
Step 4: Where to next?
Well, now that you have the very basics in hand, you're ready to start adding
scriptability to your application. But, careful planning before you start
adding in scripting features will be well worth your while. So, please consider
reading the following documentation.
- The items listed in the section "Making Your Application Scriptable" on this
page are essential reading. Everyone new to scripting should read through these
documents and familiarize themselves with the topics discussed.
http://developer.apple.com/referencelibrary/GettingStarted/GS_AppleScript/index.html
- "Designing for Scriptability in Cocoa Scripting Guide provides a high-level
checklist of design issues and tactics:
http://developer.apple.com/documentation/Cocoa/Conceptual/ScriptableCocoaApplications/index.html
- This Scripting Interface Guidelines document provides more detailed
information you should consider when adding scriptability to your application:
http://developer.apple.com/technotes/tn2002/tn2106.html
- The AppleScript terminology and Apple Event Codes document provides a listing
of four character codes that area already defined for use with specific terms.
As you are adding terminology to your application you should always check there
to see if a four character code has already been defined for a term you would
like to use AND to make sure a four character code you would like to use is not
already being used by some other terminology.
http://developer.apple.com/releasenotes/AppleScript/ASTerminology_AppleEventCodes/TermsAndCodes.html
- NSScriptCommand class is the one you use for implementing verbs (aka
commands)
http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Classes/NSScriptCommand_Class/Reference/Reference.html
Step 5: And after that?
This sample is part of a suite of samples is structured as an incremental
tutorial with concepts illustrated in one sample leading to the next in the
order they are listed below. If you have not visited any of the preceeding
samples, then please refer to those for additional information.
SimpleScripting
http://developer.apple.com/samplecode/SimpleScripting/
SimpleScriptingProperties
http://developer.apple.com/samplecode/SimpleScriptingProperties/
SimpleScriptingObjects
http://developer.apple.com/samplecode/SimpleScriptingObjects/
SimpleScriptingVerbs (you are here)
http://developer.apple.com/samplecode/SimpleScriptingVerbs/
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/SimpleScriptingVerbs/listing6.html%3Fid%3DDTS10004239-2.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/SimpleScriptingVerbs/listing6.html%3Fid%3DDTS10004239-2.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/SimpleScriptingVerbs/listing6.html%3Fid%3DDTS10004239-2.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>