BundleUtilities

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

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

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

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

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

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

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

verify_app(<app>)

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

get_bundle_main_executable(<bundle> <result_var>)

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

get_item_key(<item> <key_var>)

Для данного файла <item>, сгенерировать уникальный ключ <key_var>, учитывая набор библиотек, которые необходимо скопировать или исправить, чтобы сделать bundle автономным. Это по сути имя файла, включая расширение, с . замененным на _.

Этот ключ используется в качестве префикса для переменных 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> bundle (и переданных в качестве дополнительных <libs>) и собрать список ключей, представляющих их. Установить значения, связанные с каждым ключом, чтобы мы могли пройти по всем им, скопировать необходимые библиотеки в bundle, а затем выполнить соответствующие install_name_tool исправления.

copy_resolved_item_into_bundle(<resolved_item> <resolved_embedded_item>)

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

copy_resolved_framework_into_bundle(<resolved_item> <resolved_embedded_item>)

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

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

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

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

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

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

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

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

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

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

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

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