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

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

Если вы передаёте плагины в 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>)

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