Модуль: 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.

FIXUP_BUNDLE(<app> <libs> <dirs>)

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

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

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

Затем очистить все ключи и вызвать 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>)

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

GET_ITEM_KEY(<item> <key_var>)

На основе имени файла (item) сгенерировать уникальный ключ, учитывая набор библиотек, которые необходимо скопировать или исправить, чтобы сделать пакет автономным. Это по существу имя файла, включая расширение, где «.» заменено на «_».

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

CLEAR_BUNDLE_KEYS(<keys_var>)

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

Вызывающая функция get_bundle_keys должна вызвать clear_bundle_keys, когда закончит с списком ключей.

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

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

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

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

FIXUP_BUNDLE_ITEM(<resolved_embedded_item> <exepath> <dirs>)

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

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

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

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

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

VERIFY_BUNDLE_PREREQUISITES(<bundle> <result_var> <info_var>)

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

VERIFY_BUNDLE_SYMLINKS(<bundle> <result_var> <info_var>)

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