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

Какао определяет классы команды сценария Objective C для реализации команд AppleScript от Стандартного комплекта. Эти классы перечислены в Таблице 9-4. Как часть стандартной реализации сценариев Какао, NSScriptCommand и его подклассы могут обработать close, copy, count, create, delete, exists, move, open, и printкоманды для большинства приложений без любого разделения на подклассы. Это также обрабатывает get и set команды, которые являются технически не частью Стандартного комплекта, а скорее рассмотренными встроенными, или внутренними, командами AppleScript. Однако, если Ваше приложение должно изменить какую-либо из этих команд, можно сделать так одним из двух способов:

• Предоставьте метод, чтобы обработать команду и перечислить ее в Вашем sdef файле.

• Создайте подкласс NSScriptCommand или один из его подклассов и переопределения performDefaultImplementation.

Таблица 7-1 перечисляет команды AppleScript, поддерживаемые сценариями Какао, и суммирует их поведение по умолчанию и как можно настроить его.

Команда сценария информация о Scriptability

В работе с командами сценария сценарии Какао полагаются на scriptability информацию в Вашем sdef. Это включает command элементы, предоставляющие информацию об определенных командах AppleScript, и responds-to элементы, указывающие, что объекты определенного класса могут реагировать на указанную команду.

Ваш sdef включает a command элемент для каждой новой команды AppleScript Вы создаете. Для этих команд Вы указываете всю надлежащую информацию, описанную в Элементах Команды. Это включает название команды, код и описание. Это может также включать прямой параметр, другие параметры, и закончиться тип.

При реализации нового класса Objective C для команды Вы также предоставляете имя в command элемент. Если Вы не предоставляете имя класса, сценарии Какао используют значение по умолчанию, NSScriptCommand.

Ваш sdef должен также включать command определения элемента для большинства поддержек сценариев Какао команд AppleScript, если они могут использоваться в Вашем приложении:

• Ваш sdef не должен включать command элементы для get и set команды — они автоматически доступны каждому приложению.

• Ваш sdef должен включать command элементы для команд в Стандартном комплекте, такой как count, duplicate, и move. Можно получить эти определения путем копирования их с файла Sketch.sdef, как описано в Создают Файл Определения Сценариев.

Какао также предоставляет автоматическую поддержку для типов AppleScript, описанных во Встроенной Поддержке Основных Типов AppleScript.

Компоненты команды сценария

Объект команды сценария является экземпляром NSScriptCommand или один из его подклассов, включая классы, определенные Какао и определенными Вашим приложением. Команда сценария может иметь несколько компонентов, варьирующихся командой и описанных в command определение элемента для команды в sdef файле.

• Получатель или получатели для команды (если таковые имеются): объект или объекты, определяемые для получения команды в приложении.

  Если инициирующее событие Apple указывает получатели, оно делает так в его прямом параметре. Если событие Apple не указывает получатели, оно может все еще иметь прямой параметр, тогда интерпретирующийся, чтобы быть объектом, в который можно отправить команду.

  Если команда указывает получатели, можно получить их от объекта команды с evaluatedReceivers метод, преобразовывающий объектные спецификаторы в ссылки на фактические объекты. Если команда не указывает получатели, можно получить прямой параметр с directParameter метод, или можно получить его из списка параметров, как описано в следующем элементе.

• Параметры команды (если таковые имеются): параметры обеспечивают доступ к информации от параметров инициирующего события Apple. Параметры могут включать прямой параметр, другие параметры, и закончиться тип.

  Можно получить словарь параметров от объекта команды с evaluatedArguments метод. Вы получаете отдельные параметры от этого словаря ключом, где названия параметра, определенные в sdef, служат ключами. Можно использовать пустой ключ (пустая строка: @"") получать прямой параметр (или «параметр без имени») из словаря параметра, если прямой параметр не является спецификатором получателей.

• Описание класса для команды: Из описания класса можно получить информацию, такую как имена параметра, тип результата команды, название команды AppleScript, и имя Какао класса Objective C инстанцирует для выполнения команды. Эта информация используется сценариями Какао, но реже Вашим приложением. Посмотрите Создание Команды Сценария для описания того, как сценарии Какао получают эту информацию.

• Дескриптор события Apple: Этот объект Какао, типа NSAppleEventDescriptor, представляет само событие Apple. Ваше приложение должно будет не обязательно работать непосредственно с событием Apple, но это доступно, если Вы делаете.

Когда Вы хотите изменить поведение по умолчанию или реализовать новую команду сценария, Ваше приложение обычно только должно получить доступ к компонентам команды. В тех ситуациях, NSScriptCommand класс обеспечивает много методов для получения информации, в которой Вы нуждаетесь, включая упомянутых здесь (evaluatedReceivers, evaluatedArguments, и directParameter).

Создание команды сценария

Важно отметить, что Ваше приложение обычно не инстанцирует команды сценария непосредственно. Вместо этого это перечисляет команды, которые это может обработать в его sdef файле, и сценарии Какао инстанцируют объекта команды, когда приложение получает соответствующее событие Apple.

Какао извлекает информацию из события Apple и хранит его в объекте команды. Чтобы сделать это, это использует приложение scriptability информация (загруженный из Вашего sdef и сохраненный в глобальном экземпляре NSScriptSuiteRegistry) получить ключи для указанных объектов и получить данные из описаний команды и класса. Приложение scriptability информация автоматически включает информацию для поддержки get и set команды.

Поскольку в этой точке получатели и параметры команды, вероятно, известны только как ссылочные формы AppleScript (например, graphic 3 of document "SketchDocOne"), они представлены в объекте команды как спецификаторы вложенного объекта. Посмотрите Команды Сценария и Объектные Спецификаторы для получения дополнительной информации.

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

Как только сценарии Какао создали и подготовили команду сценария, они выполняют его в серии шагов:

1. Это использует кодирование значения ключа (KVC) для оценки спецификатора получателей в команде сценария (см. Команды Сценария и Объектные Спецификаторы для подробных данных).

2. Это определяет который метод использовать для выполнения команды. Для некоторых команд (такой как get и set), это вызывает методы KVC, на основе ключей, предоставленных в sdef файле, к значениям доступа указанных объектов.

   Для других команд это смотрит в описаниях класса получателей, чтобы видеть, указал ли кто-либо селектор для команды. В противном случае или при отсутствии получателей, это выбирает реализацию по умолчанию для команды. Этот механизм описан более подробно в Объекте сначала По сравнению с Глаголом первые Команды Сценария.

3. Это вызывает метод, обозначенный селектором (который имеет отдельный аргумент, объект команды сценария), или метод, реализующий поведение по умолчанию для команды (performDefaultImplementation).

4. Когда команда должна возвратить значение, сценарии Какао упаковывают информацию в событии Apple ответа и возвращают ее. Если ошибка происходит при выполнении команды, Какао возвращает информацию об ошибке (включая любую информацию, добавленную приложением) в событии Apple ответа. Для получения дополнительной информации посмотрите Обработку ошибок.

5. Если команда требует асинхронной обработки, приложение может приостановить его, так, чтобы приложение не получало дополнительные события Apple во время обработки. Для получения дополнительной информации посмотрите Приостановку и Возобновление Событий Apple и Команд Сценария.

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

Команды сценария и объектные спецификаторы

Когда команда сценария готова к выполнению в Вашем приложении, получатель или получатели были установлены как объектные спецификаторы, и любые параметры, возможно, также были установлены как объектные спецификаторы (параметрами могут быть фактические значения также). Представлять серию ссылочных форм (такой как first word of second paragraph of document "Stock Alert"), каждый объектный спецификатор вкладывается в его спецификаторе контейнерного объекта; самый внутренний объектный спецификатор указывает конечный объект, который будет оценен, в то время как наиболее удаленный объект обычно является приложением.

Ключи к атрибуту или отношению часто являются не теми же словами, выраженными соответствующими ссылочными формами. Например, ключ для массива объектов документа orderedDocuments, но фактический использованный термин сценариев document. Отображение между ключевым именем и именем сценария предоставлено в sdef приложения. Когда сценарии Какао преобразовывают событие Apple в объективный-C объект команды сценария, они получают отображение между четырьмя кодами символа в событии Apple и соответствующим ключом для указанного класса, атрибута или отношения в приложении. Это может тогда определить местоположение независимой от языка информации (в частности, класс и описания команды) должен был составить команду сценария, включая объектные спецификаторы для ее параметров и получателей.

В нормальном ходе выполнения команды сценария приложение вызывает evaluatedReceivers на команде сценария для получения получателя или получателей команды и вызывает evaluatedArguments получить любые параметры команды. Эти методы поочередно вызывают objectsByEvaluatingSpecifier на объектных спецификаторах, представляющих аргументы команды или получатели. Объектный спецификатор, получающий сообщение, является самым внутренним спецификатором, как вложено в его контейнерах.

objectsByEvaluatingSpecifier метод восстанавливает работоспособность цепочка вложенных контейнеров путем выяснения у каждого спецификатора его контейнер, пока это не прибывает в спецификатор объекта верхнего уровня, не имеющий никакого контейнера. Объект верхнего уровня обычно является объектом приложения, но это может быть объектный спецификатор, вовлеченный в a whose пункт (NSWhoseSpecifier) или контейнер для оценки диапазона. Метод тогда вызывает objectsByEvaluatingWithContainers: на этом спецификаторе верхнего уровня, тогда продолжающем вниз цепочку вложенных спецификаторов, оценивая каждого посредством кодирования значения ключа и использования оцененного объекта как основание для следующей оценки. Оценка самого внутреннего спецификатора приводит к реальному получателю команды или получателям или любому объекту, используемому в качестве аргумента команды.

Для соответствующей информации посмотрите Более внимательное рассмотрение в Объектном Спецификаторе.

Обработка ошибок

Ваше приложение может сигнализировать информацию об ошибке во время выполнения команды сценария путем обеспечения объекта команды кодом ошибки, строкой ошибки или обоими. Информация об ошибке возвращается в событии Apple ответа. Если ошибка произойдет, и Ваше приложение ничего не делает, то сценарии Какао предоставят самый применимый код ошибки, это может, вместе со строкой ошибки для того числа. Коды ошибки, что использование сценариев Какао для общекомандных проблем выполнения перечислено с документацией для NSScriptCommand класс.

NSScriptCommand предоставления setScriptErrorNumber: и setScriptErrorString: методы для установки информации об ошибке.

Ваш обработчик команды должен только предоставить ошибочную информацию, если это является определенным для работы Вашего приложения. При случае можно быть в состоянии использовать один из кодов, определенных сценариями Какао. Можно также выбрать код ошибки из констант, предоставленных менеджером по корпоративным мероприятиям Apple (описанный в “Кодах Результата менеджера по корпоративным мероприятиям Apple” в Ссылке менеджера по корпоративным мероприятиям Apple). Когда Вы выбираете одну из этих констант, такой как errAENotASingleObject, Сценарии какао предоставят соответствующую строку ошибки ("Handler only handles single objects"). Можно также предоставить общие числа системной ошибки Mac OS (определенный в MacErrors.h). Например, если Вы возвращаетесь fnfErr, код ошибки для "file not found", AppleScript попытается предоставить надлежащую строку ошибки.

Возразите сначала по сравнению с глаголом первым командам сценария

Команды сценария какао могут быть описаны как объект сначала или глагол сначала, в зависимости от получателей для команды. Когда команда сценария выполняется, она сначала ищет получатели, которые могут выполнить желаемое действие непосредственно. Если это находит кого-либо, это вызывает указанный метод на каждый получатель. Команду этого типа вызывают объектной первой командой — объекты выполняют указанное действие с собой.

Эскиз реализует rotate команда как объектная первая команда — для подробных данных, посмотрите, что Вращается Реализация Объектной Первой Команды —.

Если никакой получатель не может выполнить желаемое действие, или при отсутствии указанных получателей, команда сценария вызывает performDefaultImplementation метод. Когда команда вызывает этот метод, ее вызывают глаголом первой командой — отдельный метод выполняет действие (или глагол) на любом числе объектов. Для создания глагола первая команда Вы определяете подкласс одного из классов команды сценария Какао и переопределяете performDefaultImplementation метод (который ни в чем не выполняет NSScriptCommand) выполнять Вашу версию действия команды.

Эскиз реализует align команда как глагол первая команда — для подробных данных, посмотрите Реализацию Глагола, который Выравнивает Первая Команда —. Несколько из стандартных команд являются также глаголом, первые команды — видят Таблицу 9-4 для подробных данных.

Рисунок 7-1 показывает дерево решений сценариев Какао для выполнения команды сценария.

Шаги для реализации новой или измененной команды сценария

Для суммирования от предыдущих разделов Вы используете эти шаги, чтобы реализовать новую команду или изменить поведение команд сценария, предоставленных сценариями Какао:

• Для любого объект сначала (кроме get и set команды) или глагол первая команда:

  В sdef определите a command элемент для команды AppleScript, если это уже не имеет того.

• Для объектной первой команды:

  • В sdef добавьте a responds-to элемент к class определение каждого scriptable класса, который может обработать команду. Укажите то же имя метода для каждого класса.

  • Реализуйте указанный метод в классах, которые могут реагировать на команду. Объявление должно соответствовать один из этих шаблонов:

    -(id)<methodName>:(NSScriptCommand*)command

    -(void)<methodName>:(NSScriptCommand*)command

• Для глагола первая команда (и в случае необходимости, для объектной первой команды)

  • Реализуйте класс команды сценария Objective C, наследовавшийся от NSScriptCommand или один из его подклассов.

  • Укажите имя класса команды Objective-C в command элемент в sdef.

  Для глагола первая команда переопределите performDefaultImplementation метод.

Команда первого шага глагола

Предположим, что Ваше приложение позволяет сценаристам работать с условиями такой как file и folder, обеспечение знакомой терминологии для доступа к данным, фактически хранящимся в базе данных. Однако Ваша конкретная реализация не делает операций поддержки на этих данных с помощью средств доступа KVC, ключи которых могут быть отображены на "file" и "folder". Или возможно Вы попробовали стандарт move поддерживайте и найденный, что Вам нужна увеличенная производительность для перемещения больших количеств объектов.

Используя глагол сначала приближаются, можно разделить на подклассы NSMoveCommand и переопределение performDefaultImplementation. NSMoveCommand класс уже является глаголом первая команда, и это обычно целесообразно иметь объект более высокого уровня в Вашем приложении, контролируют перемещение содержащих в нем объектов, вместо того, чтобы говорить каждому объекту переместить себя.

В Вашем переопределении performDefaultImplementation, можно извлечь информацию из команды и перевести его в надлежащие операции на базовых данных. Например, можно исследовать объекты переместиться:

• Если они file или folder объекты, Вы вносите надлежащие изменения в базе данных для отражения изменений, ожидаемых в пользователе (объектная модель AppleScript) представление мира.

• Для других объектов можно использовать следующее утверждение для применения стандартного поведения, предоставленного NSMoveCommand:

  return [super performDefaultImplementation];

Команда объектного первого шага

Предположим, с другой стороны, что определенные объекты в Вашем приложении действительно знают, как переместить себя, и они используют механизм, отличающийся от основанных на KVC перемещений, поддерживаемых NSMoveCommand, которые работают со стандартными контейнерами. В этой ситуации Вы могли использовать объектный первый механизм для разрешения объектов определенного класса дескриптора move управляйте непосредственно в методе, определенном для того класса.

Для реализации этого подхода Вы используете шаги, описанные ранее в приблизительно Объектных первых Командах Сценария. В Ваших методах обработчиков Вы извлекаете информацию, в которой Вы нуждаетесь от объекта команды (расположение для перемещения в), который передается в качестве параметра методу, затем выполните перемещение для текущего объекта.