CMakeToolchain:使用 CMakePresets 构建你的项目

在本示例中,我们将了解如何使用 CMakeToolchain、预定义的布局(如 cmake_layout)以及 CMakePresets CMake 功能。

让我们基于 cmake_exe 模板创建一个基本项目,作为 C++ 项目的示例

$ conan new cmake_exe -d name=foo -d version=1.0

生成工具链

我们项目的 recipe 声明了生成器 “CMakeToolchain”。

我们可以调用 conan install 来安装 ReleaseDebug 配置。Conan 将在相应的 generators 文件夹中生成一个 conan_toolchain.cmake

$ conan install .
$ conan install . -s build_type=Debug

使用 CMakePresets 构建项目

一个 CMakeUserPresets.json 文件会在你的 CMakeLists.txt 文件所在的同一文件夹中生成,因此你可以使用 cmake >= 3.23--preset 参数,或者使用支持它的 IDE。

CMakeUserPresets.json 文件包含了位于相应 generators 文件夹中的 CMakePresets.json 文件。

CMakePresets.json 包含有关 conan_toolchain.cmake 位置的信息,甚至包含使用输出目录设置的 binaryDir

注意

本示例中我们使用 CMake 预设。这需要 CMake >= 3.23,因为从 CMakeUserPresets.jsonCMakePresets.json 的 “include” 仅自该版本起受支持。如果你不想使用预设,可以使用类似如下的方法

cmake <path> -G <CMake generator> -DCMAKE_TOOLCHAIN_FILE=<path to
conan_toolchain.cmake> -DCMAKE_BUILD_TYPE=Release

如果你无法使用预设功能,Conan 将在你每次运行 conan install 时显示确切的 CMake 命令。

如果你正在使用多配置生成器

$ cmake --preset conan-default
$ cmake --build --preset conan-debug
$ build\Debug\foo.exe
foo/1.0: Hello World Release!

$ cmake --build --preset conan-release
$ build\Release\foo.exe
foo/1.0: Hello World Release!

如果你正在使用单配置生成器

$ cmake --preset conan-debug
$ cmake --build --preset conan-debug
$ ./build/Debug/foo
foo/1.0: Hello World Debug!


$ cmake --preset conan-release
$ cmake --build --preset conan-release
$ ./build/Release/foo
foo/1.0: Hello World Release!

请注意,我们不需要像在教程中那样创建 build/Releasebuild/Debug 文件夹。输出目录由 cmake_layout() 声明,并由 CMake Presets 功能自动管理。

当你(使用 conan create 命令)在 Conan 缓存中构建包时,Conan (使用 CMake >= 3.15) 也会自动管理此行为。不需要 CMake >= 3.23。

阅读更多