Файлы комплекта сценария

Файл комплекта сценария описывает scriptable объекты с точки зрения их атрибутов, отношений и поддерживаемых команд. Можно думать о файле комплекта сценария как предоставляющий сценарии информации для использования внутренней поддержкой сценариев Какао; та информация может также использоваться Вашим приложением. Файлы с терминологией сценария описывают файлы, используемые для хранения терминологии сценариев, соответствующей информации в файле комплекта сценария. Та терминология определяет термины, фактически использованные сценаристами для управления приложением.

Информация в файле комплекта сценария состоит из вложенного списка пар ключ/значение. Комплекты сценария всегда являются списками свойств, но кроме того они должны соответствовать формату, описанному в Структуре Файла Комплекта Сценария. Для получения информации о создании их посмотрите Создание Ваших Собственных Файлов Комплекта Сценария.

Платформы, загружаемые пакеты и приложения, поддерживающие сценарии, могут включать файл комплекта сценария как независимый от языка ресурс. Имя файла принимает форму suiteName.scriptSuite, где suiteName однозначно определяет файл комплекта сценария. Пример был бы MyApplication.scriptSuite.

Комплекты сценария расположены в (нелокализованный) Resources каталог приложения, платформы или пакета. Например, для платформы назван MyStuff.framework, файл комплекта сценария (названный MyStuff.scriptSuite) находился бы в MyStuff.framework/Resources/.

Перечисление b-1 показывает описание класса для NSApplication урок, посещаемый от NSCoreSuite.scriptSuite, Файл комплекта сценария какао для комплекта Стандарта AppleScript. Описание класса показано, как экспортируется в “формате” Файла Списка свойств XML Редактором Списка свойств приложение. Можно найти полную версию этого файла комплекта сценария в системе следующим Resources символьная ссылка в /System/Library/Frameworks/Foundation.framework.

Перечисление b-1  класс NSApplication от файла комплекта сценария для Стандартного комплекта

        <key>NSApplication</key>

        <dict>

            <key>AppleEventCode</key>

            <string>capp</string>

            <key>Attributes</key>

            <dict>

                <key>isActive</key>

                <dict>

                    <key>AppleEventCode</key>

                    <string>pisf</string>

                    <key>ReadOnly</key>

                    <string>YES</string>

                    <key>Type</key>

                    <string>NSNumber&lt;Bool&gt;</string>

                </dict>

                <key>name</key>

                <dict>

                    <key>AppleEventCode</key>

                    <string>pnam</string>

                    <key>ReadOnly</key>

                    <string>YES</string>

                    <key>Type</key>

                    <string>NSString</string>

                </dict>

                <key>version</key>

                <dict>

                    <key>AppleEventCode</key>

                    <string>vers</string>

                    <key>ReadOnly</key>

                    <string>YES</string>

                    <key>Type</key>

                    <string>NSString</string>

                </dict>

            </dict>

            <key>Superclass</key>

            <string>NSCoreSuite.AbstractObject</string>

            <key>SupportedCommands</key>

            <dict>

                <key>NSCoreSuite.Open</key>

                <string>handleOpenScriptCommand:</string>

                <key>NSCoreSuite.Print</key>

                <string>handlePrintScriptCommand:</string>

                <key>NSCoreSuite.Quit</key>

                <string>handleQuitScriptCommand:</string>

            </dict>

            <key>ToManyRelationships</key>

            <dict>

                <key>orderedDocuments</key>

                <dict>

                    <key>AppleEventCode</key>

                    <string>docu</string>

                    <key>LocationRequiredToCreate</key>

                    <string>NO</string>

                    <key>ReadOnly</key>

                    <string>YES</string>

                    <key>Type</key>

                    <string>NSDocument</string>

                </dict>

                <key>orderedWindows</key>

                <dict>

                    <key>AppleEventCode</key>

                    <string>cwin</string>

                    <key>ReadOnly</key>

                    <string>YES</string>

                    <key>Type</key>

                    <string>NSWindow</string>

                </dict>

            </dict>

        </dict>

Каждый scriptable класс в файле комплекта сценария должен иметь “описание класса”, которое, в форме значения ключа, объявляет атрибуты и отношения класса с точки зрения типа и четырех кодов символа (или код события Apple). Например, четыре кода символа для NSApplication в Перечислении b-1 строка "capp". Можно читать больше о четырех кодах символов в Кодовых константах, Используемых в информации Scriptability. Первичный ключ для описания класса должен быть именем класса такой как NSApplication это идентифицирует реальный класс Objective C.

Описание класса также объявляет команды AppleScript, класс поддерживает и указывает суперкласс, если суперкласс также поддерживает сценарии своих объектов. В этом случае, суперкласс для NSApplication AbstractObject, который является корнем scriptable иерархии классов и соответствует NSObject класс.

Файлы с терминологией сценария

Файл с терминологией сценария отображает терминологию AppleScript — подобные английскому языку слова и формулирует сценариста, может использовать в сценарии, такой как the first word in the first paragraph— к классу и описаниям команды в файле комплекта сценария. Файл с терминологией сценария также обеспечивает ценную документацию о поддержке сценариев приложения, которую пользователи могут исследовать в приложениях Редактора сценариев и XCode.

Как файл комплекта сценария, файл с терминологией сценария сохранен как вложенный список пар ключ/значение. Терминология сценария всегда является списками свойств, но кроме того они должны соответствовать формату, описанному в Структуре Файла с терминологией Сценария. Посмотрите Создание Ваших Собственных Файлов Комплекта Сценария для получения информации о том, как создать и отредактировать эти файлы.

Перечисление b-2 показывает терминологию для NSApplication урок, посещаемый от NSCoreSuite.scriptTerminology, файл с терминологией сценария для Стандартного комплекта (предоставленный Какао). Терминология показана, как экспортируется в “формате” Файла Списка свойств ASCII Редактором Списка свойств приложение. Можно найти полную версию этого файла в системе следующим Resources символьная ссылка в /System/Library/Frameworks/Foundation.framework.

Перечисление b-2  класс NSApplication от файла с терминологией сценария для Стандартного комплекта

        NSApplication = {

            Attributes = {

                isActive = {

                    Description = "Is this the frontmost (active) application?";

                    Name = frontmost;

                };

                name = {Description = "The name of the application."; Name = name; };

                version = {Description = "The version of the application."; Name = version; };

            };

            Description = "An application's top level scripting object.";

            Name = application;

            PluralName = applications;

        };

        NSColor = {Description = "A color."; Name = color; PluralName = colors; };

        NSDocument = {

            Attributes = {

                fileName = {Description = "The document's path."; Name = path; };

                isDocumentEdited = {

                    Description = "Has the document been modified since the last save?";

                    Name = modified;

                };

                lastComponentOfFileName = {Description = "The document's name."; Name = name; };

            };

            Description = "A document.";

            Name = document;

            PluralName = documents;

        };

Встроенные комплекты сценария сценариев какао

Сценарии какао обеспечивают два комплекта стандартной информации о сценариях: Стандарт (или Ядро) комплект и текстовый комплект. Эти комплекты определяют scriptability информацию для основных команд AppleScript, включая copy, count, create, delete, exists, и move. Они также предоставляют информацию для основных классов AppleScript, такой как application, document, window, и text, и для соответствующих классов Какао, такой как NSApplication, NSDocument, NSWindow, и NSTextStorage.

Стандарт и текстовые комплекты представлены во Встроенной Поддержке Стандарта и текстовых Комплектов и описаны более подробно в Использовании Архитектура Документа и Получают доступ к текстовому Комплекту.

Создание собственных файлов комплекта сценария

Для добавления к встроенной поддержке сценариев Какао с помощью комплекта сценария и подхода терминологии сценария приложение предоставляет файлы, описывающие scriptability информацию для объектов, свойств и команд, которые это поддерживает. Например, приложение, которое может нарисовать формы (такие как приложение Эскиза) могло бы указать, что поддерживает circle, rectangle, и line объекты, с color и location свойства. Это могло бы также поддерживать команды такой как rotate и scale, в дополнение к стандартным командам такой как get, set, и delete.

Для создания файла комплекта сценария или файла с терминологией сценария можно или использовать простой текст или XML-редактор, или использовать приложение, такое как Редактор Списка свойств, предоставляющий встроенную поддержку для создания списков свойств. Редактор Списка свойств включен с инструментами разработчика OS X. Если у Вас есть существующая scriptability информация, посмотрите Преобразование и Обновление информация о Scriptability для получения информации о том, как преобразовать между различными форматами.

Вы создаете файлы, содержащие записи для классов, команды и перечисления, используемые Вашим приложением, включая коды, метод и информацию о классе, используемую Какао и терминологией, используемой сценаристами. Ваши файлы должны следовать за форматами, описанными в Структуре Файла Комплекта Сценария и Структуре Файла с терминологией Сценария. При использовании Редактора Списка свойств приложение можно гарантировать создание допустимого списка свойств. Можно также сохранить scriptability информацию в нескольких форматах:

• Как файл комплекта сценария или файл с терминологией сценария: эти файлы хранятся в формате XML.

• Как текстовый файл с XML-тэгами: для примера см. Перечисление b-1.

• Как текстовый файл в плоскости формат ASCII: для примера см. Перечисление b-2.

Эти форматы могут быть открыты различными текстовыми редакторами или Редактором Списка свойств. В результате можно свободно работать с файлом комплекта сценария в том, какой бы ни формат является самым удобным для Вас.

Рисунок b-1 показывает Стандартный комплект (от файла NSCoreSuite.scriptSuite) как выведено на экран в Редакторе Списка свойств приложение. В этом числе, Классах и NSApplication определение класса расширено так, чтобы атрибуты, поддерживаемые команды и отношения для NSApplication видимы.

AbstractObject класс указывает базовый класс, который Ваши scriptable классы могут наследовать от того, когда их фактический суперкласс не имеет никакой поддержки scriptability.

Для примеров комплектов сценария и примера кода для scriptable приложений, см. проекты Эскиза и TextEdit в качестве примера.