hs.application

Таблица, содержащая UTF8-представления определённых символов ключей, используемых в меню для ярлыков клавиатуры, которые представлены графически, а не как текст (стрелки, клавиша Enter и т.д.)

• Для этой таблицы предоставлен метаметод __tostring, чтобы вы могли просмотреть её текущее содержимое, набрав hs.application.menuGlyphs в консоли Hammerspoon.

• Эта таблица предоставлена в качестве переменной, чтобы вы могли изменить любое представление, если вы знаете более подходящее или лучшее для вашего использования во время выполнения.

• Определённые графические символы взяты из заголовков фреймворка Carbon в файле Menus.h, расположенном (по состоянию на 10.11) по адресу /System/Library/Frameworks/Carbon.framework/Frameworks/HIToolbox.framework/Headers/Menus.h.

• В Menus.h определены следующие константы, но они, по-видимому, не соответствуют видимому UTF8-символу или хорошо определённому представлению, которое я смог обнаружить. Если вы знаете (предпочтительно одобренное Apple) правильное визуальное представление, отправьте вопрос, подробно описывая его, в репозиторий Hammerspoon на GitHub.

  • kMenuNullGlyph, 0x00, Пустое (всегда символ 1)
  • kMenuNonmarkingReturnGlyph, 0x0D, Немаркированная клавиша возврата
  • kMenuParagraphKoreanGlyph, 0x15, Неназначенный (абзац на корейском)
  • kMenuTrademarkJapaneseGlyph, 0x1F, Неназначенный (торговая марка на японском)
  • kMenuAppleLogoOutlineGlyph, 0x6C, Контур логотипа Apple

Возвращает запущенное приложение для заданного pid, если оно существует.

• pid - идентификатор процесса Unix (т.е. число)

• Объект hs.application, если он найден, в противном случае nil

Возвращает все запущенные приложения, имеющие заданный bundleID.

• bundleID - идентификатор пакета приложения OSX

• Таблица из нуля или более объектов hs.application, соответствующих заданному идентификатору

Возвращает идентификатор пакета приложения по умолчанию для заданного UTI

• uti - строка, содержащая UTI

• Строка, содержащая идентификатор пакета, или nil, если не найдено

Устанавливает или получает, следует ли использовать Spotlight для поиска альтернативных имён приложений.

• state - необязательный булевый параметр, указывающий, следует ли использовать Spotlight для определения альтернативных имён приложений для hs.application.find и аналогичных функций.

• Текущее, возможно изменённое, состояние

• Это значение сохраняется при перезагрузке и перезапуске Hammerspoon.
• Если это значение было установлено в true и вы устанавливаете его снова в true, это очистит карту альтернативных имён и перестроит её заново.
• Вы можете отключить отображение альтернативных имён Spotlight, установив это значение в false или nil. Если вы установите это значение в false, уведомления, указывающие на возможность получения большего количества результатов при включенном Spotlight, будут подавлены.

Возвращает объект приложения для активного (переднего) приложения. Это приложение, которое в настоящее время получает события ввода.

• Нет

• Объект hs.application

Получает метаданные приложения по его идентификатору пакета.

• bundleID - строка, содержащая идентификатор пакета приложения (например, "com.apple.Safari")

• Таблица, содержащая информацию об приложении, или nil, если идентификатор пакета не найден

Получает метаданные приложения по его пути на диске.

• bundlePath - строка, содержащая путь к пакету приложения (например, "/Applications/Safari.app")

• Таблица, содержащая информацию об приложении, или nil, если пакет не найден

Запускает приложение с заданным именем или активирует его, если оно уже запущено

• name - Строка, содержащая имя приложения, которое нужно запустить или активировать. Это также может быть полный путь к приложению (включая суффикс .app), если вам нужно однозначно отличить приложения в разных местах, имеющие одинаковое имя

• True, если приложение было запущено или активировано, в противном случае false (например, если приложение не существует)

• Параметр name должен соответствовать имени приложения на диске, например, "IntelliJ IDEA", а не "IntelliJ"

Запускает приложение с заданным идентификатором пакета или активирует его, если оно уже запущено

• bundleID - Строка, содержащая идентификатор пакета приложения, которое нужно запустить или активировать.

• True, если приложение было запущено или активировано, в противном случае false (например, если приложение не существует)

• Идентификаторы пакетов обычно имеют вид com.company.ApplicationName

Получает список всех локализованных версий, содержащихся в пакете.

• bundleID - Строка, содержащая идентификатор пакета приложения (например, "com.apple.Safari")

• Таблица, содержащая идентификаторы языков для всех локализованных версий, содержащихся в пакете.

Получает список всех локализованных версий, содержащихся в пакете.

• bundlePath - Строка, содержащая путь к пакету приложения (например, "/Applications/Safari.app")

• Таблица, содержащая идентификаторы языков для всех локализованных версий, содержащихся в пакете.

Получает имя приложения по его идентификатору пакета.

• bundleID - Строка, содержащая идентификатор пакета приложения (например, "com.apple.Safari")

• Строка, содержащая имя приложения, или nil, если идентификатор пакета не найден

Получает путь к приложению в файловой системе по его идентификатору пакета.

• bundleID - Строка, содержащая идентификатор пакета приложения (например, "com.apple.Safari")

• Строка, содержащая путь к пакету приложения в файловой системе, или nil, если идентификатор пакета не найден

Получает упорядоченный список предпочтительных локализованных версий, содержащихся в пакете.

• bundleID - Строка, содержащая идентификатор пакета приложения (например, "com.apple.Safari")

• Таблица, содержащая идентификаторы языков для локализованных версий в пакете. Строки упорядочены в соответствии с предпочтениями языка пользователя и доступными локализациями.

Получает упорядоченный список предпочтительных локализованных версий, содержащихся в пакете.

• bundlePath - Строка, содержащая путь к пакету приложения (например, "/Applications/Safari.app")

• Таблица, содержащая идентификаторы языков для локализованных версий в пакете. Строки упорядочены в соответствии с предпочтениями языка пользователя и доступными локализациями.

Возвращает все запущенные приложения.

• None

• Таблица, содержащая ноль или более объектов hs.application, работающих в системе.

Находит запущенные приложения

• hint - критерий поиска нужного приложения(ий); он может быть: - номером процесса (pid) по hs.application:pid() - строкой идентификатора пакета (bundle ID) по hs.application:bundleID() - строкой-шаблоном, которая совпадает (с помощью string.find) с именем приложения по hs.application:name() (для удобства сопоставление выполняется со строками в нижнем регистре) - строкой-шаблоном, которая совпадает (с помощью string.find) с заголовком окна приложения по hs.window:title() (для удобства сопоставление выполняется со строками в нижнем регистре)
• exact - boolean, true для проверки имен приложений на точное соответствие, false для использования метода Lua string:find(). По умолчанию false
• stringLiteral - boolean, true для интерпретации строки hint буквально, false для интерпретации как шаблона Lua. По умолчанию false.

• один или несколько объектов hs.application для запущенных приложений, соответствующих критериям поиска, или nil если не найдено

• Если найдено несколько результатов, эта функция вернёт несколько значений. См. https://www.lua.org/pil/5.1.html для получения дополнительной информации о работе с этим
• для удобства вы можете вызвать это как hs.application(hint)
• используйте эту функцию, когда вы не знаете точного имени приложения, в котором вы заинтересованы, например, из консоли: hs.application'term' --> hs.application: iTerm2 (0x61000025fb88) hs.application: Terminal (0x618000447588). Но будьте осторожны при её использовании в ваших скриптах: terminal=hs.application'term' будет произвольно назначать либо "Terminal", либо "iTerm2" (или даже, если ни то, ни другое не запущено, любое другое приложение с окном, которое случайно содержит "term" в своём заголовке); чтобы убедиться, что вы получаете нужное приложение в ваших скриптах, используйте hs.application.get с точным именем: terminal=hs.application.get'Terminal' --> "Terminal" app, or nil if it's not running

Использование: -- по pid hs.application(42):name() --> Finder -- по bundle id hs.application'com.apple.Safari':name() --> Safari -- по имени hs.application'chrome':name() --> Google Chrome -- по заголовку окна hs.application'bash':name() --> Terminal

Получает запущенное приложение

• hint - критерий поиска нужного приложения; он может быть: - номером процесса (pid) согласно hs.application:pid() - строкой идентификатора пакета (bundle ID) согласно hs.application:bundleID() - строкой имени приложения согласно hs.application:name()

• объект hs.application для запущенного приложения, соответствующего критерию поиска, или nil если не найдено

• см. также hs.application.find

Запускает приложение или активирует его, если оно уже запущено

• app - строка, описывающая открываемое приложение; она может быть: - именем приложения согласно hs.application:name() - полным путем к приложению на диске (включая .app суффикс) - идентификатором пакета (bundle ID) приложения согласно hs.application:bundleID()
• wait - (необязательно) максимальное время в секундах ожидания запуска приложения, если оно ещё не запущено; если опущено, по умолчанию равно 0; если запуск приложения займёт больше этого времени, эта функция вернёт nil, но приложение всё равно запустится
• waitForFirstWindow - (необязательно) если true, дополнительно подождите, пока приложение не создаст первое окно (что обычно занимает немного больше времени)

• объект hs.application для запущенного или активированного приложения; nil если не найдено

• параметр wait будет блокировать всю активность Hammerspoon для того, чтобы вернуть объект приложения "синхронно"; используйте его только в том случае, если a) у вас нет критически важных событий обработки времени в другом месте в вашем init.lua и b) вам нужно немедленно действовать с объектом приложения или его окном(ами)
• при запуске приложения без окна (фоновый демон, меню и т. д.) убедитесь, что вы опустили waitForFirstWindow

Попытка активировать приложение (сделать его основное окно фокусированным) и возвращает, удалось ли это; если allWindows равно true, все окна приложения также будут выведены вперёд.

• allWindows - Если true, все окна приложения будут выведены вперёд. В противном случае будет выведено только ключевое окно приложения. По умолчанию false.

• Булево значение, указывающее, удалось ли активировать приложение

Возвращает все открытые окна, принадлежащие данному приложению.

• Нет

• Таблица из нуля или более объектов hs.window, принадлежащих приложению

• Эта функция может возвращать только окна в текущем пространстве Mission Control; если вам нужно обратиться к окнам в разных пространствах, вы можете использовать модуль hs.window.filter
  • если Displays have separate Spaces включено (в Системных настройках>Mission Control), текущее пространство определяется как объединение всех видимых пространств
  • минимизированные окна и скрытые окна (т.е. принадлежащие скрытым приложениям, например, с помощью cmd-h) всегда считаются в текущем пространстве

Возвращает идентификатор пакета (bundle identifier) приложения.

• Нет

• Строка, содержащая идентификатор пакета (bundle identifier) приложения

Ищет пункт меню в приложении

• menuItem - Это может быть либо строка, содержащая текст пункта меню (например, "Messages"), либо таблица, представляющая иерархический путь пункта меню (например, {"File", "Share", "Messages"}). В случае строки будут перебираться все меню приложения до тех пор, пока не будет найден совпадение (без указанного поведения, если существует несколько пунктов меню с одинаковым именем). В случае таблицы вся структура меню не будет просматриваться, поскольку указан точный путь.
• isRegex - Необязательный булевый параметр, по умолчанию false, который используется только в том случае, если menuItem является строкой. Если он установлен в значение true, menuItem будет обрабатываться как регулярное выражение, а не как строка для сопоставления

• Возвращает nil, если пункт меню не найден. Если он существует, возвращает таблицу с двумя ключами:
• enabled - возможность выбора/установки отметки для пункта меню. Это всегда будет false, если приложение не фокусируется
• ticked - установлена ли отметка для пункта меню (очевидно, что это значение не имеет смысла для пунктов меню, которые нельзя установить)

• Это может искать только те пункты меню, у которых нет дочерних элементов - т. е. вы не можете искать имя подменю

Находит окна из этого приложения

• titlePattern - строка-шаблон, которая соответствует (через string.find) названию окна(ов) согласно hs.window:title() (для удобства сопоставление будет выполняться с использованием строчных букв)

• одно или несколько объектов hs.window, принадлежащих этому приложению, которые соответствуют критерию поиска, или nil если не найдено

Возвращает текущее фокусированное окно приложения, или nil

• Нет

• Объект hs.window, представляющий окно приложения, которое в данный момент имеет фокус, или nil, если таковых нет

Получает структуру меню приложения

• fn - необязательная функция обратного вызова. Если указана, функция получит один аргумент и не вернёт ничего.

• Если аргумент не указан, возвращает таблицу, содержащую структуру меню приложения, или nil в случае ошибки. Если указана функция обратного вызова, функция обратного вызова получит эту таблицу (или nil), а этот метод вернёт объект приложения, на котором он был вызван.

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

• Таблица имеет структуру, аналогичную структурам меню приложения. Каждый элемент имеет несколько ключей, содержащих информацию об элементе меню. Не все ключи будут присутствовать для всех элементов. Возможные ключи:

• AXTitle - строка, содержащая текст элемента меню (элементы без заголовка являются разделителями меню)

• AXEnabled - логическое значение, 1, если элемент меню нажимабельный, 0 — если нет

• AXRole - строка, содержащая роль элемента меню — это будет либо AXMenuBarItem для верхнего уровня меню, либо AXMenuItem для элемента в меню

• AXMenuItemMarkChar - строка, содержащая символ «отметки» для элемента меню. Это для переключаемых элементов меню и обычно будет пустой строкой или символом Unicode галочки (✓)

• AXMenuItemCmdModifiers - таблица, содержащая строковые представления модификаторов клавиатуры для сочетания клавиш элемента меню, или nil, если модификаторы отсутствуют

• AXMenuItemCmdChar - строка, содержащая клавишу для сочетания клавиш элемента меню, или пустая строка, если сочетание клавиш отсутствует

• AXMenuItemCmdGlyph - целое число, соответствующее одному из определённых глифов в hs.application.menuGlyphs, если сочетание клавиш — специальный символ, обычно представленный графическим изображением (например, стрелки, Enter и т. д.), или пустая строка, если глиф не используется при отображении сочетания клавиш.

• Использование hs.inspect() для этих таблиц, хотя и полезно для исследования, может быть крайне медленным, занимая несколько минут для правильного отображения очень сложных меню

Получает конкретное окно из этого приложения

• title - строка названия желаемого окна согласно hs.window:title()

• желаемый объект hs.window, принадлежащий этому приложению, или nil если не найден

Скрывает приложение (и все его окна).

• None

• Логическое значение, указывающее, было ли приложение успешно скрыто

Возвращает, является ли приложение передним (т. е. является ли текущим активным приложением)

• None

• True, если приложение является передним, иначе false

Возвращает, скрыто ли приложение в данный момент.

• None

• Логическое значение, указывающее, скрыто ли приложение или нет

Проверяет, всё ли ещё работает приложение

• None

• Логическое значение, true, если приложение работает, false — если нет

• Если приложение завершено и перезапущено, этот метод по-прежнему вернёт false, так как объекты hs.application привязаны к конкретному экземпляру приложения (т. е. его PID)

Попытка завершить приложение корректно.

• None

• None

Попытка завершить приложение принудительно.

• None

• None

Определить состояние графического интерфейса приложения

• None

• Число, которое равно 1, если приложение находится в доке, 0, если нет, или -1, если приложение запрещено иметь элементы графического интерфейса

Возвращает главное окно данного приложения, или nil.

• None

• Объект hs.window, представляющий главное окно приложения, или nil, если у него нет окон

Псевдоним для hs.application:title()

Возвращает путь к приложению в файловой системе.

• None

• Строка, содержащая путь к приложению в файловой системе, или nil, если путь определить невозможно (например, если приложение завершено).

Возвращает идентификатор процесса приложения.

• None

• Идентификатор процесса приложения в UNIX (т. е. число)

Выбирает пункт меню (т.е. имитирует щелчок по пункту меню)

• menuitem - Пункт меню для выбора, указанный как строка или таблица. См. параметр menuitem параметра hs.application:findMenuItem() для получения дополнительной информации.
• isRegex - Необязательный логический параметр, по умолчанию false, используемый только в том случае, если menuItem является строкой. Если установлен в true, menuItem будет обрабатываться как регулярное выражение, а не как строка для точного соответствия

• True, если пункт меню был найден и выбран, или nil, если он не был найден (например, потому что пункт меню не был найден)

• В зависимости от типа пункта меню это либо активирует, либо устанавливает/снимает отметку с пункта меню

Устанавливает приложение в фокус (т.е. текущее активное приложение)

• allWindows - Необязательный логический параметр, true, чтобы вывести все окна приложения на передний план. По умолчанию false

• Логическое значение, true, если операция выполнена успешно, иначе false

Возвращает локализованное имя приложения (в UTF8).

• Нет

• Строка, содержащая имя приложения

Скрывает приложение (и все его окна), если оно скрыто.

• Нет

• Логическое значение, указывающее, было ли приложение успешно отображено

Возвращает только видимые окна приложения.

• Нет

• Таблица, содержащая ноль или более объектов hs.window