BundleUtilities

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

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

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

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