Модуль: BundleUtilities

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

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

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

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

На основе имени файла (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.

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

COPY_RESOLVED_ITEM_INTO_BUNDLE(<resolved_item> <resolved_embedded_item>)

Копирует разрешённый элемент в пакет, если необходимо. Копирование не требуется, если разрешённый элемент «такой же», как и разрешённый встроенный элемент.

COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE(<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».)

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

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