C++ 应用程序 - Gradle 构建系统

C++ 应用程序插件为构建 C++ 应用程序提供 task、配置和约定。

用法

build.gradle.kts

plugins {
    `cpp-application`
}

build.gradle

plugins {
    id 'cpp-application'
}

构建变体

C++ 应用程序插件理解以下维度。阅读构建变体介绍以获取更多信息。

构建类型 - 始终为debug或release

构建类型控制生成二进制文件的可调试性和优化。

debug - 生成调试符号，并且不优化二进制文件
release - 生成调试符号并进行优化，但从二进制文件中提取调试符号

目标机器 - 默认为构建主机

目标机器表示应用程序期望运行的机器。目标机器由其操作系统和架构标识。Gradle 使用目标机器来决定根据主机上的可用性选择哪个工具链。

目标机器可以按如下方式配置

示例 2. 配置应用程序目标机器

build.gradle.kts

application {
    targetMachines = listOf(machines.linux.x86_64,
        machines.windows.x86, machines.windows.x86_64,
        machines.macOS.x86_64)
}

build.gradle

application {
    targetMachines = [
        machines.linux.x86_64,
        machines.windows.x86, machines.windows.x86_64,
        machines.macOS.x86_64
    ]
}

Task

下图显示了此插件添加的 task 之间的关系。

图 1. C++ 应用程序插件默认 task 图

变体相关的 Task

C++ 应用程序插件根据应用程序组件的变体创建 task。阅读构建变体介绍以获取更多信息。下图显示了变体相关的 task 之间的关系。

图 2. C++ 应用程序插件变体相关的 task 图

compileVariantCpp (例如 compileDebugCpp 和 compileReleaseCpp) - CppCompile: 依赖于：所有为编译贡献源文件的 task :: 使用选定的编译器编译 C++ 源文件。
linkVariant (例如 linkDebug 和 linkRelease) - LinkExecutable: 依赖于：所有为链接可执行文件做出贡献的 task，包括通过项目依赖关系解析的项目的 linkVariant 和 createVariant task :: 使用选定的链接器从编译的对象文件链接可执行文件。
installVariant (例如 installDebug 和 installRelease) - InstallExecutable: 依赖于：linkVariant 和所有为可执行文件的运行时做出贡献的 task，包括通过项目依赖关系解析的项目的 linkVariant task :: 安装可执行文件及其所有运行时依赖项，以便于执行。
assembleVariant (例如 assembleDebug 和 assembleRelease) - Task (生命周期): 依赖于：linkVariant :: 聚合 task，用于组装此应用程序的特定变体。

生命周期 Task

C++ 应用程序插件将其某些 task 附加到基础插件章节中记录的标准生命周期 task - C++ 应用程序插件自动应用该插件

assemble - Task (生命周期): 依赖于：linkDebug :: 聚合 task，用于组装项目中当前主机（如果存在）的 debug 变体的应用程序。此 task 由基础插件添加。
check - Task (生命周期): 聚合 task，执行验证 task，例如运行测试。某些插件将它们自己的验证 task 添加到 check。例如，C++ 单元测试插件将一个 task 附加到此生命周期 task 以运行测试。此 task 由基础插件添加。
build - Task (生命周期): 依赖于：check, assemble :: 聚合 task，执行项目的完整构建。此 task 由基础插件添加。
clean - Delete: 删除构建目录及其中的所有内容，即 layout.buildDirectory 项目属性指定的路径。此 task 由基础插件添加。

依赖管理

就像 C++ 应用程序插件创建的 task 一样，基于应用程序组件的变体创建多个配置。阅读构建变体介绍以获取更多信息。下图描述了 C++ 应用程序插件添加的配置

图 3. C++ 应用程序插件配置

白色配置是用户应该用来声明依赖项的配置
粉红色配置，也称为可消费配置，用 (C) 表示，是在组件针对库运行时使用的配置
蓝色配置，也称为可解析配置，用 (R) 表示，是组件内部使用的配置，供其自身使用

以下配置用于声明依赖项

implementation: 用于为主要组件的所有变体声明实现依赖项。您应该在此处声明任何变体的依赖项。
mainVariantImplementation (例如 mainDebugImplementation 和 mainReleaseImplementation) 扩展 implementation: 用于为主要组件的特定变体声明实现依赖项。您应该在此处声明特定变体的依赖项。

以下配置供依赖于应用程序组件的下游消费者使用

variantRuntimeElements (例如 debugRuntimeElements 和 releaseRuntimeElements) 扩展 `mainVariantImplementation: 用于执行应用程序。此配置旨在供消费者使用，以检索运行应用程序所需的所有元素。

以下配置由应用程序自身使用

cppCompileVariant (例如 cppCompileDebug 和 cppCompileRelease) 扩展 mainVariantImplementation: 用于编译应用程序。此配置包含应用程序的编译 include 根，因此在调用 C++ 编译器来编译它时使用。
nativeLinkVariant (例如 nativeLinkDebug 和 nativeLinkRelease) 扩展 mainVariantImplementation: 用于链接应用程序。此配置包含应用程序的库，因此在调用 C++ 链接器来链接它时使用。
nativeRuntimeVariant (例如 nativeRuntimeDebug 和 nativeRuntimeRelease) 扩展 mainVariantImplementation: 用于执行应用程序。此配置包含应用程序的运行时库。

约定

C++ 应用程序插件添加了源和 task 的约定，如下所示。

项目布局

C++ 应用程序插件假定项目布局如下所示。这些目录都不需要存在或包含任何内容。C++ 应用程序插件将编译它找到的任何内容，并忽略任何缺失的内容。

src/main/cpp: C++ 源代码，扩展名为 .cpp、.c++ 或 .cc
src/main/headers: Headers - 编译应用程序所需的头文件

您可以通过在 application 脚本块上分别配置 source 和 privateHeaders 来配置项目布局。

`compileVariantCpp` Task

C++ 应用程序插件为要构建的应用程序组件的每个变体添加一个 CppCompile 实例（例如 compileDebugCpp 和 compileReleaseCpp）。阅读构建变体介绍以获取更多信息。下面显示了一些最常见的配置选项。

compilerArgs	[]
debuggable	`true`
includes	`configurations.cppCompileVariant` + `application.privateHeaders`
macros	[:]
objectFileDir	`layout.buildDirectory.dir("obj/main/$variant")`
optimized	debug 构建类型为 `false`，否则为 `true`
positionIndependentCode	`false`
source	`application.cppSource`
systemIncludes	从工具链派生
targetPlatform	从二进制文件的 `TargetMachine` 派生
toolChain	根据目标机器自动选择

`linkVariant` Task

C++ 应用程序插件为应用程序的每个变体添加一个 LinkExecutable 实例 — 例如 linkDebug 和 linkRelease。阅读构建变体介绍以获取更多信息。下面显示了一些最常见的配置选项。

debuggable	`true`
libs	`configurations.nativeLinkVariant`
linkedFile	`layout.buildDirectory.dir("exe/main/$variant/baseName")` (*nix) 或 `layout.buildDirectory.dir("exe\main\$variant\baseName.exe")` (Windows)
linkerArgs	[]
source	`compileVariantCpp.objects`
targetPlatform	从二进制文件的 `TargetMachine` 派生
toolChain	根据目标机器自动选择

`installVariant` Task

C++ 应用程序插件为测试组件的每个变体添加一个 InstallExecutable 实例 — 例如 installDebug 和 installRelease。阅读构建变体介绍以获取更多信息。无需在 task 上配置任何属性。

此页面是否对您有帮助？