MCL/sf/adapt/qemu: symbian-qemu-0.9.1-12/python-2.6.1/Mac/Demo/applescript.html@3c15ef939dd3 (annotated)

1 2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	1	<!doctype HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	2	<html><head><title>Using the Open Scripting Architecture from Python</title></head>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	3	<body>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	4	<h1>Using the Open Scripting Architecture from Python</h1>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	5	<hr>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	6
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	7	<p><b>NOTE:</b> this document describes the OSA support that is shipped with
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	8	the core python distribution. Most users are better of with the more
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	9	userfriendly <a href="http://freespace.virgin.net/hamish.sanderson/appscript.html">appscript library</a>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	10
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	11	<p>OSA support in Python is still not 100% complete, but
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	12	there is already enough in place to allow you to do some nifty things
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	13	with other programs from your python program. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	14
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	15
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	16	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	17	In this example, we will look at a scriptable application, extract its
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	18	“AppleScript Dictionary,” generate a Python interface package from
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	19	the dictionary, and use that package to control the application.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	20	The application we are going to script is Disk Copy, Apple's standard
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	21	utility for making copies of floppies, creating files that are mountable
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	22	as disk images, etc.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	23	Because we want
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	24	to concentrate on the OSA details, we won’t bother with a real
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	25	user-interface for our application. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	26
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	27
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	28	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	29	<em>When we say “AppleScript” in this document we actually mean
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	30	“the Open Scripting Architecture.” There is nothing
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	31	AppleScript-specific in the Python implementation. Most of this document
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	32	focuses on the classic Mac OS; <a href="#osx">Mac OS X</a> users have some
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	33	additional tools.</em>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	34	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	35
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	36	<h2>Python OSA architecture</h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	37
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	38	<p>Open Scripting suites and inheritance can be modelled rather nicely
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	39	with Python packages, so we generate
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	40	a package for each application we want to script. Each suite defined in
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	41	the application becomes a module in the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	42	package, and the package main module imports everything from all the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	43	submodules and glues together all the classes (in Python terminology—
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	44	events in OSA terminology or verbs in AppleScript terminology). </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	45
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	46	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	47	A suite in an OSA application can extend the functionality of a standard
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	48	suite. This is implemented in Python by importing everything from the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	49	module that implements the standard suites and overriding anything that has
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	50	been extended. The standard suites live in the StdSuite package. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	51
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	52	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	53	This all sounds complicated, but the good news is that basic
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	54	scripting is actually pretty simple. You can do strange and wondrous things
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	55	with OSA scripting once you fully understand it. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	56
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	57	<h2>Creating the Python interface package</h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	58
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	59
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	60	<p>There is a tool in the standard distribution that can automatically
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	61	generate the interface packages. This tool is called
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	62	<code>gensuitemodule.py</code>, and lives in <code>Mac:scripts</code>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	63	It looks through a file
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	64	for an ‘AETE’ or ‘AEUT’ resource,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	65	the internal representation of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	66	AppleScript dictionary, and parses the resource to generate the suite
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	67	modules.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	68	When we start <code>gensuitemodule</code>, it asks us for an input file;
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	69	for our example,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	70	we point it to the Disk Copy executable. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	71
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	72	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	73	Next, <code>gensuitemodule</code> wants a folder where it will store the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	74	package it is going to generate.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	75	Note that this is the package folder, not the parent folder, so we
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	76	navigate to <code>Python:Mac:Demo:applescript</code>, create a folder
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	77	<code>Disk_Copy</code>, and select that. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	78
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	79	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	80	We next specify the folder from which <code>gensuitemodule</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	81	should import the standard suites. Here,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	82	we always select <code>Python:Mac:Lib:lib-scriptpackages:StdSuites</code>. (There is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	83	one exception to this rule: when you are generating <code>StdSuites</code> itself
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	84	you select <code>_builtinSuites</code>.)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	85	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	86
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	87	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	88	It starts parsing the AETE resource, and for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	89	each AppleEvent suite it finds, <code>gensuitemodule.py</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	90	prompts us for the filename of the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	91	resulting python module. Remember to change folders for the first
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	92	module—you don't want to clutter up, say, the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	93	Disk Copy folder
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	94	with your python
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	95	interfaces. If you want to skip a suite, press <code>cancel</code> and the process
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	96	continues with the next suite. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	97
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	98	<h3>Summary</h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	99
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	100	<ol>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	101
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	102	<li>Run <code>gensuitemodule</code>.</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	103
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	104	<li>Select the application (or OSAX) for which you would like a Python interface.</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	105
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	106	<li>Select the package folder where the interface modules should be
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	107	stored.</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	108
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	109	<li>Specify the folder <code>Python:Mac:Lib:lib-scriptpackages:StdSuites</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	110	to import the standard suites (or <code>_builtinSuites</code> if you are
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	111	generating <code>StdSuites</code> itself). </li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	112
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	113	<li>Save the generated suites (use <code>cancel</code> to skip a suite).</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	114
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	115
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	116	</ol>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	117
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	118
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	119	<h3>Notes</h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	120
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	121
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	122	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	123
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	124	<li>The interface package may occasionally need some editing by hand. For example,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	125	<code>gensuitemodule</code> does not handle all Python reserved words, so
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	126	if
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	127	one of the AppleScript verbs is a Python reserved word, a <code>SyntaxError</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	128	may be raised when the package is imported.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	129	Simply rename the class into something acceptable, if this happens;
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	130	take a look at how the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	131	<code>print</code> verb is handled (automatically by <code>gensuitemodule</code>)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	132	in the standard suites. But: f you need to edit your package this should be considered a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	133	bug in gensuitemodule, so please report it so it can be fixed in future releases.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	134	</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	135
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	136
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	137	<li>If you want to re-create the StdSuite modules,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	138	you should look in one of two places. With versions of AppleScript older than 1.4.0
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	139	(which first shipped with OS 9.0), you will find the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	140	AEUT resources in <code>System Folder:Extensions:Scripting
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	141	Additions:Dialects:English Dialect</code>. For newer versions, you will
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	142	find them in <code>System Folder:Extensions:Applescript</code>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	143	</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	144
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	145	<li>Since MacPython 2.0, this new structure, with packages
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	146	per application and submodules per suite, is used. Older MacPythons had a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	147	single level of modules, with uncertain semantics. With the new structure,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	148	it is possible for programs to override standard suites, as programs often do.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	149
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	150	</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	151
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	152	<li><code>Gensuitemodule.py</code> may ask you questions
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	153	like “Where is enum 'xyz ' declared?”.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	154	This is either due to a misunderstanding on my part or (rather too commonly)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	155	bugs in the AETE resources. Pressing <code>cancel</code> is usually the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	156	right choice: it will cause the specific enum not to be treated as an enum
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	157	but as a “normal” type. As things like fsspecs and TEXT strings clearly are
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	158	not enumerators, this is correct. If someone understands what is really going on
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	159	here, please let me know.</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	160
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	161	</ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	162
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	163
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	164
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	165	<h2>The Python interface package contents</h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	166
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	167	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	168	Let’s glance at the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	169	<a href="applescript/Disk_Copy">Disk_Copy</a> package just created. You
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	170	may want to open Script Editor alongside to see how it
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	171	interprets the dictionary.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	172	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	173
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	174
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	175	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	176	The main package module is in <code>__init__.py</code>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	177	The only interesting bit is the <code>Disk_Copy</code> class, which
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	178	includes the event handling classes from the individual suites. It also
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	179	inherits <code>aetools.TalkTo</code>, which is a base class that handles all
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	180	details on how to start the program and talk to it, and a class variable
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	181	<code>_signature</code> which is the default application this class will talk
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	182	to (you can override this in various ways when you instantiate your class, see
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	183	<code>aetools.py</code> for details).
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	184	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	185
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	186	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	187	The <a href="applescript/Disk_Copy/Special_Events.py">Special_Events</a>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	188	module is a nice example of a suite module.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	189	The <code>Special_Events_Events</code> class is the bulk of the code
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	190	generated. For each verb, it contains a method. Each method knows what
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	191	arguments the verb expects, and it makes use of keyword
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	192	arguments to present a palatable
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	193	interface to the python programmer.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	194
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	195	Notice that each method
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	196	calls some routines from <code>aetools</code>, an auxiliary module
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	197	living in <code>Mac:Lib</code>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	198	The other thing to notice is that each method calls
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	199	<code>self.send</code>. This comes from the <code>aetools.TalkTo</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	200	baseclass. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	201
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	202
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	203	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	204	After the big class, there are a number of little class declarations. These
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	205	declarations are for the (AppleEvent) classes and properties in the suite.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	206	They allow you to create object IDs, which can then be passed to the verbs.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	207	For instance,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	208	when scripting the popular email program Eudora,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	209	you would use <code>mailbox("inbox").message(1).sender</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	210	to get the name of the sender of the first message in mailbox
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	211	inbox. It is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	212	also possible to specify this as <code>sender(message(1, mailbox("inbox")))</code>,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	213	which is sometimes needed because these classes don’t always inherit correctly
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	214	from baseclasses, so you may have to use a class or property from another
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	215	suite. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	216
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	217	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	218	Next we get the enumeration dictionaries, which allow you to pass
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	219	english names as arguments to verbs, so you don't have to bother with the 4-letter
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	220	type code. So, you can say
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	221	<code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	222	diskcopy.create(..., filesystem="Mac OS Standard")
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	223	</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	224	as it is called in Script Editor, instead of the cryptic lowlevel
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	225	<code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	226	diskcopy.create(..., filesystem="Fhfs")
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	227	</code></p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	228
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	229	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	230	Finally, we get the “table of contents” of the module, listing all
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	231	classes and such
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	232	by code, which is used by <code>gensuitemodule</code> itself: if you use this
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	233	suite as a base package in a later run this is how it knows what is defined in this
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	234	suite, and what the Python names are.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	235	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	236
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	237	<h3>Notes</h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	238
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	239	<ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	240
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	241	<li>The <code>aetools</code> module contains some other nifty
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	242	AppleEvent tools as well. Have a look at it sometime, there is (of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	243	course) no documentation yet.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	244	</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	245
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	246	<li>There are also some older object specifiers for standard objects in aetools.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	247	You use these in the form <code>aetools.Word(10,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	248	aetools.Document(1))</code>, where the corresponding AppleScript
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	249	terminology would be <code>word 10 of the first
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	250	document</code>. Examine
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	251	<code>aetools</code> and <code>aetools.TalkTo</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	252	along with
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	253	the comments at the end of your suite module if you need to create
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	254	more than the standard object specifiers.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	255	</li>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	256
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	257	</ul>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	258
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	259
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	260
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	261
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	262	<h2>Using a Python suite module</h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	263
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	264	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	265	Now that we have created the suite module, we can use it in a Python script.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	266	In older MacPython distributions this used to be a rather
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	267	complicated affair, but with the package scheme and with the application signature
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	268	known by the package it is very simple: you import the package and instantiate
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	269	the class, e.g.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	270	<code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	271	talker = Disk_Copy.Disk_Copy(start=1)
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	272	</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	273	You will usually specify the <code>start=1</code>: it will run the application if it is
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	274	not already running.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	275	You may want to omit it if you want to talk to the application
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	276	only if it is already running, or if the application is something like the Finder.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	277	Another way to ensure that the application is running is to call <code>talker._start()</code>.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	278	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	279
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	280	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	281	Looking at the sourcefile <a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	282	href="applescript/makedisk.py">makedisk.py</a>, we see that it starts
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	283	with some imports. Naturally, one of these is the Python interface to Disk
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	284	Copy.</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	285
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	286	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	287	The main program itself is a wonder of simplicity: we create the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	288	object (<code>talker</code>) that talks to Disk Copy,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	289	create a disk, and mount it. The bulk of
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	290	the work is done by <code>talker</code> and the Python interface package we
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	291	just created.</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	292
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	293	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	294	The exception handling does warrant a few comments, though. Since
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	295	AppleScript is basically a connectionless RPC protocol,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	296	nothing happens
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	297	when we create the <code>talker</code> object. Hence, if the destination application
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	298	is not running, we will not notice until we send our first
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	299	command (avoid this as described above). There is another thing to note about errors returned by
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	300	AppleScript calls: <code>MacOS.Error</code> is raised for
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	301	all of the errors that are known to be <code>OSErr</code>-type errors,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	302	while
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	303	server generated errors raise <code>aetools.Error</code>. </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	304
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	305	<h2>Scripting Additions</h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	306
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	307	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	308	If you want to use any of the scripting additions (or OSAXen, in
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	309	everyday speech) from a Python program, you can use the same method
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	310	as for applications, i.e. run <code>gensuitemodule</code> on the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	311	OSAX (commonly found in <code>System Folder:Scripting Additions</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	312	or something similar). There is one minor gotcha: the application
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	313	signature to use is <code>MACS</code>. You will need to edit the main class
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	314	in the <code>__init__.py</code> file of the created package and change the value
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	315	of <code>_signature</code> to <code>MACS</code>, or use a subclass to the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	316	same effect.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	317	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	318
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	319	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	320	There are two minor points to watch out for when using <code>gensuitemodule</code>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	321	on OSAXen: they appear all to define the class <code>System_Object_Suite</code>,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	322	and a lot of them have the command set in multiple dialects. You have to
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	323	watch out for name conflicts and make sure you select a reasonable dialect
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	324	(some of the non-English dialects cause <code>gensuitemodule</code> to generate incorrect
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	325	Python code). </p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	326
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	327	Despite these difficulties, OSAXen offer a lot of possibilities. Take a
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	328	look at some of the OSAXen in the Scripting Additions folder, or
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	329	<A HREF="http://www.osaxen.com/index.php">download</A> some from the net.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	330
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	331	<h2>Further Reading</h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	332
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	333	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	334	If you want to look at more involved examples of applescripting, look at the standard
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	335	modules <code>findertools</code> and <code>nsremote</code>, or (possibly better, as it
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	336	is more involved) <code>fullbuild</code> from the <code>Mac:scripts</code> folder.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	337	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	338
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	339	<h2><a name="alternatives">Alternatives</a></h2>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	340
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	341	<h3><a name="osx">Mac OS X</a></h3>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	342
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	343	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	344	Under Mac OS X, the above still works, but with some new difficulties.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	345	The application package structure can hide the ‘AETE’ or
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	346	‘AEUT’ resource from <code>gensuitemodule</code>, so that,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	347	for example, it cannot generate an OSA interface to iTunes. Script
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	348	Editor gets at the dictionary of such programs using a ‘Get
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	349	AETE’ AppleEvent, if someone wants to donate code to use the same
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	350	method for gensuitemodule: by all means!
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	351	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	352
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	353	<p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	354	One alternative is available through the Unix command line version of python.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	355	Apple has provided the <code>osacompile</code> and <code>osascript</code> tools,
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	356	which can be used to compile and execute scripts written in OSA languages. See the
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	357	man pages for more details.
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	358	</p>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	359
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	360
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	361	</body>
2fb8b9db1c86 Initial QEMU (symbian-qemu-0.9.1-12) import martin.trojer@nokia.com parents: diff changeset	362	</html>

author	William Roberts <williamr@symbian.org>
	Wed, 07 Jul 2010 22:30:23 +0100
branch	GCC_SURGE
changeset 88	3c15ef939dd3
parent 1	2fb8b9db1c86
permissions	-rw-r--r--