UNITY_BUILD

在 3.16 版本中加入。

当此属性设置为 true 时,目标源文件将被合并成批次以加快编译速度。这是通过创建(一组)统一源文件来完成的,这些文件 #include 原始源文件,然后编译这些统一源文件而不是原始源文件。这被称为 UnityJumbo 构建。

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 版本中加入。

CUDA

在 3.31 版本中加入。

OBJC

在 3.29 版本中加入。

OBJCXX

在 3.29 版本中加入。

对于混合了多种语言源文件的目标,CMake 会分离语言,以便每个生成的统一源文件仅包含单一语言的源文件。

此属性由创建目标时 CMAKE_UNITY_BUILD 变量的值初始化。

注意

项目不应直接将 UNITY_BUILD 属性或其关联的 CMAKE_UNITY_BUILD 变量设置为 true。根据构建机器和所用编译器的能力,启用 unity 构建可能合适,也可能不合适。因此,此功能应由开发者控制,通常通过开发者选择是否在 CMAKE_UNITY_BUILD 变量在 cmake(1) 命令行或一些其他等效方法中设置来完成。但是,如果已知为目标启用 unity 构建可能会导致问题,则**建议**将 UNITY_BUILD 目标属性设置为 false。

ODR (单一定义规则) 错误

当多个源文件包含到一个源文件中时(就像 unity 构建一样),可能会导致 ODR 错误。CMake 提供了一些措施来帮助解决此类问题