快速 CMake 教程

启动一个示例 CMake 项目

1. 请选择 文件 | 新建项目 从主菜单。

2. 在左侧窗格中选择 C++ 可执行文件。

   在我们的示例中，项目名称为 cmake_testapp ，选择的语言标准为 C++17。

   

   点击 创建。

3. CLion 将生成一个包含单个源文件 main.cpp 和一个 CMakeLists.txt 脚本的初始项目。

   

   自动生成的 CMakeLists.txt 包含以下命令：

   命令	描述
   cmake_minimum_required(VERSION 3.26)	指定 CMake 的最低要求版本，如默认的 toolchain 中所设置。 在大多数情况下，如果未有意更改 CMake 可执行文件，这就是捆绑的 CMake 版本。
   project(cmake_testapp)	根据我们在项目创建期间提供的内容定义项目名称。
   set(CMAKE_CXX_STANDARD 17)	设置 CMAKE_CXX_STANDARD 变量的值为 17 ，这是我们在创建项目时选择的值。
   add_executable(cmake_testapp main.cpp)	添加 cmake_testapp 可执行目标以从 main.cpp 构建。 我们将在 下文进一步讨论目标。

4. 点击 IDE 左侧工具栏上的 打开 CMake 工具窗口，您可以在其中检查项目加载的进度和状态：

   

1. 右键点击项目树中的根文件夹，然后选择 新建 | C/C++ 源文件：

   

2. 选中 添加到目标 复选框：

   

3. 点击 确定 ，新文件将被添加到 add_executable 命令中：

   

新的可执行目标

1. 右键点击项目树中的根文件夹，然后再次选择 新建 | C/C++ 源文件。

2. 设置文件名（在我们的示例中为 calc ）。

3. 在 添加到目标 字段中，清除 cmake_testapp 复选框。

4. 点击 添加新目标 链接：

   

5. 指定目标名称（cmake_testapp_calc ），然后点击 添加：

   

6. 新创建的目标将出现在列表中。

   确保仅选择了 cmake_testapp_calc 目标：

   

   点击 确定。

7. CLion 将向 CMakeLists.txt 添加一个新的 add_executable 命令并重新加载项目：

   

8. 重新加载后，新配置将出现在配置切换器中：

   

新的库目标

1. 右键点击项目树中的根文件夹，然后再次选择 新建 | C/C++ 源文件。

2. 提供文件名（ calc_lib ）。

3. 清除 添加到目标 字段中的复选框。

4. 点击 添加新目标。

   

5. 在下拉列表中，选择 add_library：

   

6. 设置目标名称（cmake_testapp_lib ），然后点击 添加。

   

7. 新创建的目标将出现在列表中。

   确保其他目标的复选框已清除。

   

   选中 创建关联头文件 复选框以同时添加一个头文件， calc_lib.h 。

   点击 确定。

8. CLion 将向 CMakeLists.txt 添加一个 add_library 命令并重新加载项目：

   

9. 与可执行目标的情况类似，CLion 会自动为库目标创建配置：

   

   然而，这是一个不可执行的配置，因此如果您尝试运行或调试它，您将收到 未指定可执行文件 错误消息：

   

10. 要获取库文件，您需要构建此配置。 在切换器中选择它，然后按 Ctrl+F9 或点击构建图标：

    

    结果， libcmake_testapp_lib.a 文件将出现在 cmake-构建-debug 文件夹中。

    

CMake 预设

CMake 预设 是一种使用两个文件配置和共享 CMake 选项的方法：

• 用于项目作用域的构建的 CMakePresets.json 。 此文件可以通过 VCS 共享。

• 用于开发者本地构建的 CMakeUserPresets.json 。 此文件不应提交到 VCS。

这两个文件格式相同，应位于项目的根目录中。

CMake 配置文件

一个配置文件包括 toolchain 和 构建类型 ，以及 CMake 选项，例如 生成器 和 环境变量。 您可以为项目配置多个配置文件，例如使用不同的编译器或以不同的设置构建目标。

请参阅下一章，了解为 Release 构建添加配置文件的示例。

1. 例如，让我们在项目根目录下创建三个目录： 包含 、 包含/general 和 包含/math 。 在项目树上下文菜单中使用 新建 | 目录 选项。

   

2. 打开 CMakeLists.txt 并添加以下命令：

   target_include_directories (cmake_testapp_lib PUBLIC includes/math) target_include_directories (cmake_testapp_lib PUBLIC includes/general)

   这两个命令使位于 general 和 math 的头文件可从 cmake_testapp_lib 目标的源文件中访问。

   例如，如果我们将一个名为 header_math.h 的头文件放在 包含/math 文件夹中，我们可以使用 #include "header_math.h" 从 calc_lib.cpp 中包含它。

1. 在您的 CMakeLists.txt 文件或文件中设置断点。

2. 打开顶层 CMakeLists.txt ，点击第一个命令旁边的边距图标，然后选择 Debug：

   

3. CLion 将启动一个 CMake 调试会话：

   

   有关更多信息，请参阅 CMake 调试功能。

将 CTest 添加到示例项目

1. 在项目根目录下创建一个 ctest 目录。

2. 将以下文件添加到 ctest 目录中：

   • 一个源文件 addvalues_zero.cpp 。 暂时不要将此文件链接到任何 CMake 目标。

   • 一个头文件 assert_macro.h 。 暂时不要将此文件链接到任何 CMake 目标。

   • 一个 CMakeLists.txt 脚本。

   

3. 将以下行添加到 ctest/CMakeLists.txt 中：

   cmake_minimum_required(VERSION 3.14.0 FATAL_ERROR) add_executable(ctest_exe_addvalues_zero addvalues_zero.cpp) target_link_libraries(ctest_exe_addvalues_zero LINK_PUBLIC cmake_testapp_lib) add_test(NAME ctest_addvalues_zero COMMAND ctest_exe_addvalues_zero) set_tests_properties(ctest_addvalues_zero PROPERTIES PASS 0)

   第一行声明了 CTest 的最低支持版本，对应于 CMake 的版本 3.14。

   我们在这里使用 add_test 命令将 ctest_exe_addvalues_zero 可执行文件注册到 CTest。

4. 接下来，我们需要在顶层 CMakeLists.txt 中启用 CTest 并声明子项目：

   enable_testing() add_subdirectory(ctest)

   enable_testing 命令创建了一个内置目标 test ，执行 CTest。

5. 重新加载项目。

添加要测试的代码

让我们准备一段代码以使用 CTest 进行测试。

1. 在 calc_lib.cpp 中添加一个简单函数。

   int add_values (int a, int b) { return a+b;}

2. 在关联的头文件 calc_lib.h 中添加函数声明：

   int add_values (int a, int b);

   

将代码添加到测试源中

1. assert_macro.h :

   #include <iostream> #include <sstream> #define assertEqual( ... ) \ do { \ if( !( __VA_ARGS__ ) ) { \ std::cerr << "Unit test assert [ " \ << ( #__VA_ARGS__ ) \ << " ] failed in line [ " \ << __LINE__ \ << " ] file [ " \ << __FILE__ << " ]" \ << std::endl; \ err_code = 1; \ } \ } while( false )

2. addvalues_zero.cpp :

   #include "assert_macro.h" #include "../calc_lib.h" int test_addvalues_zero() { int err_code = 0; assertEqual (add_values(0, 0) == 0); assertEqual (add_values(-5, 5) == 0); return err_code; } int main() { return test_addvalues_zero(); }

编辑 CTest 配置

1. 在主菜单中，进入 运行 | 编辑配置.

2. 在 CTest 应用程序 节点下，您将找到自动创建的 所有 CTest 配置。

   由于要测试的代码位于 ctest_exe_addvalues_zero 可执行文件中，我们需要在配置设置中选择该可执行文件作为构建目标：

   

3. 我们还检查一下 要运行的测试列表 字段。 点击笔图标打开 可用测试列表 对话框，在其中我们可以查看和调整测试集：

   

运行 CTest 配置并查看结果

1. 在配置切换器中选择 所有 CTest ，然后点击 或按 Shift+F10。

   

2. 在 测试运行器 窗口中找到结果：