步骤 3:为库添加使用要求

练习 1 - 为库添加使用要求

目标使用要求参数允许更好地控制库或可执行文件的链接和包含行,同时还能更好地控制 CMake 中目标的传递属性。利用使用要求的主要命令是:

目标

为库添加使用要求。

有用材料

要编辑的文件

  • MathFunctions/CMakeLists.txt

  • CMakeLists.txt

开始

在此练习中,我们将重构添加库中的代码,以使用现代 CMake 方法。我们将让库定义其自身的使用要求,以便在必要时将其传递给其他目标。在此情况下,MathFunctions 将自行指定所需的包含目录。然后,使用目标 Tutorial 只需链接到 MathFunctions,而无需担心任何其他包含目录。

起始源代码在 Step3 目录中提供。在此练习中,请完成 TODO 1TODO 3

首先,在 MathFunctions/CMakeLists 中添加对 target_include_directories() 的调用。请记住,CMAKE_CURRENT_SOURCE_DIR 是当前正在处理的源目录的路径。

然后,更新(并简化!)顶级 CMakeLists.txt 中对 target_include_directories() 的调用。

构建并运行

创建一个新目录,名为 Step3_build,运行 cmake 可执行文件或 cmake-gui 来配置项目,然后使用您选择的构建工具或从构建目录使用 cmake --build . 来构建它。以下是命令行中的回顾:

mkdir Step3_build
cd Step3_build
cmake ../Step3
cmake --build .

接下来,使用新构建的 Tutorial 并验证其是否按预期工作。

解决方案

让我们更新上一步的代码,以使用现代 CMake 的使用要求方法。

我们希望声明任何链接到 MathFunctions 的人都需要包含当前源目录,而 MathFunctions 本身不需要。这可以使用 INTERFACE 使用要求来表达。请记住,INTERFACE 意味着消费者需要但生产者不需要的东西。

MathFunctions/CMakeLists.txt 的末尾,使用带 INTERFACE 关键字的 target_include_directories(),如下所示:

TODO 1:点击显示/隐藏答案
待办 1:MathFunctions/CMakeLists.txt
target_include_directories(MathFunctions
                           INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}
                           )

现在我们已经为 MathFunctions 指定了使用要求,我们可以安全地从顶级 CMakeLists.txt 中删除对 EXTRA_INCLUDES 变量的使用。

删除此行

TODO 2:点击显示/隐藏答案
待办 2:CMakeLists.txt
list(APPEND EXTRA_INCLUDES "${PROJECT_SOURCE_DIR}/MathFunctions")

并从 target_include_directories 中删除 EXTRA_INCLUDES

TODO 3:点击显示/隐藏答案
待办 3:CMakeLists.txt
target_include_directories(Tutorial PUBLIC
                           "${PROJECT_BINARY_DIR}"
                           )

请注意,使用此技术,我们的可执行目标要使用我们的库,唯一需要做的就是调用带库目标名称的 target_link_libraries()。在较大的项目中,手动指定库依赖项的经典方法会很快变得非常复杂。

练习 2 - 使用接口库设置 C++ 标准

现在我们已经将代码切换到更现代的方法,让我们演示一种现代技术来为多个目标设置属性。

让我们重构现有代码以使用 INTERFACE 库。我们将在下一步中使用该库来演示 生成器表达式 的常见用法。

目标

添加一个 INTERFACE 库目标来指定所需的 C++ 标准。

有用资源

要编辑的文件

  • CMakeLists.txt

  • MathFunctions/CMakeLists.txt

入门

在此练习中,我们将重构代码以使用 INTERFACE 库来指定 C++ 标准。

从步骤 3 练习 1 结束时开始此练习。您将需要完成 TODO 4TODO 7

首先编辑顶级 CMakeLists.txt 文件。构建一个名为 tutorial_compiler_flagsINTERFACE 库目标,并指定 cxx_std_11 作为目标编译器特性。

修改 CMakeLists.txtMathFunctions/CMakeLists.txt,以便所有目标都包含对 tutorial_compiler_flagstarget_link_libraries() 调用。

构建并运行

由于我们的构建目录已在练习 1 中配置,只需通过调用以下命令重新构建我们的代码

cd Step3_build
cmake --build .

接下来,使用新构建的 Tutorial 并验证其是否按预期工作。

解决方案

让我们更新上一步的代码,以使用接口库设置 C++ 要求。

首先,我们需要删除对变量 CMAKE_CXX_STANDARDCMAKE_CXX_STANDARD_REQUIRED 的两次 set() 调用。需要删除的具体行如下:

CMakeLists.txt
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)

接下来,我们需要创建一个接口库 tutorial_compiler_flags。然后使用 target_compile_features() 添加编译器特性 cxx_std_11

TODO 4:点击显示/隐藏答案
TODO 4:CMakeLists.txt
add_library(tutorial_compiler_flags INTERFACE)
target_compile_features(tutorial_compiler_flags INTERFACE cxx_std_11)

最后,设置好接口库后,我们需要将可执行文件 TutorialSqrtLibrary 库和 MathFunctions 库链接到新的 tutorial_compiler_flags 库。相应的代码如下所示:

TODO 5:点击显示/隐藏答案

这个

TODO 6:点击显示/隐藏答案

和这个

TODO 7:点击显示/隐藏答案

有了这个,我们的所有代码仍然需要 C++ 11 才能构建。但请注意,通过这种方法,我们可以具体指定哪些目标获得特定要求。此外,我们在接口库中创建了一个单一的事实来源。