Модуль 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 для конечного пакета, чтобы убедиться, что он действительно автономный.

В качестве необязательного параметра (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>)

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

GET_ITEM_KEY(<item> <key_var>)

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

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

В качестве необязательного параметра (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, а также каталог ресурсов фреймворка.

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>)

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

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

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

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