UNITY_BUILD

При установке этого свойства в значение true, целевые исходные файлы будут объединены в пакеты для более быстрого компилирования. Это делается путем создания (набора) единых исходников, #include исходных, а затем компилирования этих единых исходников вместо оригинальных. Это известно как сборка Unity или Jumbo.

CMake предоставляет различные алгоритмы для выбора исходных файлов, которые будут сгруппированы в пакет. Выбор алгоритма определяется свойством целевого объекта UNITY_BUILD_MODE, которое имеет следующие допустимые значения:

• BATCH В этом режиме CMake определяет, какие файлы будут сгруппированы вместе. Свойство UNITY_BUILD_BATCH_SIZE контролирует верхний предел количества исходников, которые могут быть объединены в один файл единых исходников.
• GROUP В этом режиме каждый целевой объект явно указывает, как сгруппировать исходные файлы. Каждый исходный файл, имеющий то же значение свойства UNITY_GROUP, будет сгруппирован вместе. Все исходные файлы, для которых это свойство не задано, будут скомпилированы по отдельности. Свойство UNITY_BUILD_BATCH_SIZE игнорируется при использовании этого режима.

Если явно не задано свойство UNITY_BUILD_MODE, CMake по умолчанию использует BATCH.

Сборки Unity поддерживаются для следующих языков:

C

Новое в версии 3.16.

CXX

Новое в версии 3.16.

OBJC

Новое в версии 3.29.

OBJCXX

Новое в версии 3.29.

Для целевых объектов, которые смешивают исходные файлы из более чем одного языка, CMake разделяет языки таким образом, чтобы каждый созданный файл единых исходников содержал исходники только одного языка.

Это свойство инициализируется значением переменной CMAKE_UNITY_BUILD при создании целевого объекта.

Ошибки ODR (Правило одной дефиниции)

Когда несколько исходных файлов включаются в один исходный файл, как это делается при сборках Unity, это может потенциально привести к ошибкам ODR. CMake предоставляет ряд мер для решения таких проблем:

• Любой исходный файл, у которого свойство COMPILE_OPTIONS, COMPILE_DEFINITIONS, COMPILE_FLAGS или INCLUDE_DIRECTORIES исходного файла не пустое, не будет объединён в единый исходный файл.
• Любой исходный файл, который сканируется для исходных файлов модулей C++ с помощью CXX_SCAN_FOR_MODULES, CXX_SCAN_FOR_MODULES или членство в наборе файлов CXX_MODULES не будет объединён в единый исходный файл. Подробности см. в cmake-cxxmodules(7).
• Проекты могут предотвратить объединение отдельного исходного файла в единый исходный файл, установив свойство SKIP_UNITY_BUILD_INCLUSION исходного файла в значение true. Это может быть более эффективным способом предотвращения проблем с конкретными файлами, чем отключение сборки Unity для всего целевого объекта.
• Проекты могут установить UNITY_BUILD_UNIQUE_ID, чтобы сгенерировать действительный идентификатор C, уникальный для каждого файла в сборке Unity. Это может быть использовано для предотвращения проблем с анонимными именованными пространствами в сборках Unity.
• Свойства целевого объекта UNITY_BUILD_CODE_BEFORE_INCLUDE и UNITY_BUILD_CODE_AFTER_INCLUDE могут использоваться для вставки кода в файлы единых исходников до и после каждого #include оператора.
• Порядок добавления исходных файлов в целевой объект с помощью команд, таких как add_library(), add_executable() или target_sources(), будет сохранён в сгенерированных файлах единых исходников. Это можно использовать для ручного обеспечения определённой группировки на основе свойства целевого объекта UNITY_BUILD_BATCH_SIZE.