BundleUtilities

Функции для сборки автономного приложения bundle.

Коллекция функций утилит CMake, полезных для работы с .app пакетами на Mac и папками типа bundle на любой ОС.

Данный модуль предоставляет следующие функции:

fixup_bundle
copy_and_fixup_bundle
verify_app
get_bundle_main_executable
get_dotapp_dir
get_bundle_and_executable
get_bundle_all_executables
get_item_key
get_item_rpaths
clear_bundle_keys
set_bundle_key_values
get_bundle_keys
copy_resolved_item_into_bundle
copy_resolved_framework_into_bundle
fixup_bundle_item
verify_bundle_prerequisites
verify_bundle_symlinks

Требует CMake 2.6 или выше, так как использует функции, операторы break и PARENT_SCOPE. Также зависит от GetPrerequisites.cmake.

НЕ ИСПОЛЬЗУЙТЕ ЭТИ ФУНКЦИИ НА ЭТАПЕ КОНФИГУРАЦИИ (из CMakeLists.txt)! Вместо этого вызывайте их из правила install(CODE) или install(SCRIPT).

fixup_bundle(<app> <libs> <dirs>)

Исправляет <app> пакет на месте и делает его автономным, чтобы его можно было перетащить и скопировать на другой компьютер и запустить на нём, при условии совместимости всех системных библиотек.

Если вы передаёте плагины в fixup_bundle в качестве параметра libs, вы должны установить или скопировать их в пакет перед вызовом fixup_bundle. Параметр <libs> — список библиотек, которые необходимо исправить, но которые нельзя определить по анализу вывода otool (т.е., plugins).

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

Затем очистите все ключи и вызовите verify_app для окончательного пакета, чтобы убедиться, что он действительно автономный.

copy_and_fixup_bundle(<src> <dst> <libs> <dirs>)

Создаёт копию пакета <src> по адресу <dst> и затем исправляет новую скопированную папку bundle на месте по адресу <dst>.

verify_app(<app>)

Проверяет, является ли приложение <app> валидным на основе анализа инструментов, запущенных на нём. Вызывает message(FATAL_ERROR), если приложение не прошло проверку.

get_bundle_main_executable(<bundle> <result_var>)

Результатом будет полный путь к главному исполняемому файлу пакета или строка с префиксом error:, если его невозможно определить.

get_dotapp_dir(<exe> <dotapp_dir_var>)

Возвращает ближайшую родительскую директорию, имя которой оканчивается на .app, учитывая полный путь к исполняемому файлу. Если такой родительской директории нет, возвращается директория, содержащая исполняемый файл.

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

get_bundle_and_executable(<app> <bundle_var> <executable_var> <valid_var>)

Принимает имя директории .app или имя исполняемого файла внутри директории .app и возвращает путь к директории .app в <bundle_var> и путь к его главному исполняемому файлу в <executable_var>.

get_bundle_all_executables(<bundle> <exes_var>)

Рекурсивно сканирует пакет <bundle> для поиска всех исполняемых файлов <exes_var> и накапливает их в переменной.

get_item_key(<item> <key_var>)

На основе имени файла <item> генерирует уникальный ключ <key_var> с учётом набора библиотек, которые нужно скопировать или исправить, чтобы сделать пакет автономным. По существу, это имя файла, включая расширение, с заменой . на _.

Этот ключ используется в качестве префикса для переменных CMake, чтобы мы могли связать набор переменных с заданным элементом на основе его ключа.

clear_bundle_keys(<keys_var>)

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

Вызывающий get_bundle_keys должен вызвать clear_bundle_keys после завершения работы со списком ключей.

set_bundle_key_values(<keys_var> <context> <item> <exepath> <dirs>
                      <copyflag> [<rpaths>])

Добавляет ключ <keys_var> в список (при необходимости) для данного элемента. При добавлении также устанавливаются все переменные, связанные с этим ключом.

get_bundle_keys(<app> <libs> <dirs> <keys_var>)

Проходит по всем исполняемым и библиотечным файлам в пакете <app> (и переданным как дополнительные <libs>) и накапливает список ключей, представляющих их. Устанавливает значения, связанные с каждым ключом, чтобы мы могли пройти по всем им, скопировать необходимые библиотеки в пакет, а затем выполнить соответствующие исправления install_name_tool.

copy_resolved_item_into_bundle(<resolved_item> <resolved_embedded_item>)

Копирует разрешенный элемент в пакет, если необходимо. Копирование не требуется, если <resolved_item> «такой же», как <resolved_embedded_item>.

copy_resolved_framework_into_bundle(<resolved_item> <resolved_embedded_item>)

Копирует разрешённый фреймворк в пакет, если необходимо. Копирование не требуется, если <resolved_item> «такой же», как <resolved_embedded_item>.

По умолчанию BU_COPY_FULL_FRAMEWORK_CONTENTS не установлен. Если вы хотите встраивать полные фреймворки в свои пакеты, установите BU_COPY_FULL_FRAMEWORK_CONTENTS в ON перед вызовом fixup_bundle. По умолчанию COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE копирует сам файл dylib фреймворка плюс директорию фреймворка Resources.

fixup_bundle_item(<resolved_embedded_item> <exepath> <dirs>)

Получает прямые/несистемные зависимости <resolved_embedded_item>. Для каждой зависимости изменяет способ её обращения на значение переменной с ключом _EMBEDDED_ITEM для этой зависимости. (Вероятнее всего, изменяя на ссылку типа @executable_path.)

Эта функция требует, чтобы <resolved_embedded_item> уже был частью пакета. Другими словами, если вы передаёте плагины в fixup_bundle в качестве параметра libs, вы должны установить или скопировать их в пакет перед вызовом fixup_bundle. Параметр libs — список библиотек, которые необходимо исправить, но которые нельзя определить по анализу вывода otool. (т.е., plugins)

Также измените идентификатор исправленного элемента на его собственное значение _EMBEDDED_ITEM.

Накопление изменений в локальной переменной и выполнение одного вызова install_name_tool в конце функции со всеми изменениями сразу.

Если переменная BU_CHMOD_BUNDLE_ITEMS установлена, элементы пакета будут помечены как доступные для записи перед тем, как install_name_tool попытается изменить их.

verify_bundle_prerequisites(<bundle> <result_var> <info_var>)

Проверяет, что сумма всех зависимостей всех файлов в пакете содержится в пакете или являются system библиотеками, предполагаемыми существующими повсюду.

verify_bundle_symlinks(<bundle> <result_var> <info_var>)

Проверяет, что все символические ссылки, найденные в пакете <bundle> указывают на другие файлы, которые также уже находятся в пакете… Любая ссылка на внешний файл приводит к тому, что эта функция отклоняет проверку.