Модуль BundleUtilities

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

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

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

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 или выше, так как используются функции, операторы перехода и 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 для конечного пакета, чтобы убедиться, что он действительно автономный.

В качестве необязательного параметра (IGNORE_ITEM) можно передать список имён файлов, которые будут проигнорированы (например, IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe").

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

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

verify_app(<app>)

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

В качестве необязательного параметра (IGNORE_ITEM) можно передать список имён файлов, которые будут проигнорированы (например, IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe")

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.

В качестве необязательного параметра (IGNORE_ITEM) можно передать список имён файлов, которые будут проигнорированы (например, IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe")

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> уже был inside пакетом. Другими словами, если вы передаёте плагины функции 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 библиотеками, предполагаемо существующими везде.

В качестве необязательного параметра (IGNORE_ITEM) можно передать список имён файлов, которые будут проигнорированы (например, IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe")

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

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