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

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

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