CMakeToolchain: 将任意 CMake 变量注入依赖项¶

您可以在 GitHub 上的 examples2 仓库中找到重现此项目的源代码。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/examples/tools/cmake/cmake_toolchain/user_toolchain_profile

在一般情况下，Conan 包配方通过 settings、confs 和 options 提供必要的抽象来控制构建的各个方面。许多配方定义了 options 来激活或禁用功能、可选依赖项或二进制特性。像 tools.build:cxxflags 这样的配置可用于注入任意 C++ 编译标志。

在某些特殊情况下，可能希望直接将 CMake 变量注入到进行 CMake 构建的依赖项中。当这些依赖项使用 CMakeToolchain 集成时，这是可能的。让我们在这个简单的例子中看看。

如果我们有以下包配方，包含一个简单的 conanfile.py 和一个打印变量的 CMakeLists.txt

conanfile.py¶

from conan import ConanFile
from conan.tools.cmake import CMake

class AppConan(ConanFile):
    name = "foo"
    version = "1.0"
    settings = "os", "compiler", "build_type", "arch"
    exports_sources = "CMakeLists.txt"

    generators = "CMakeToolchain"

    def build(self):
        cmake = CMake(self)
        cmake.configure()
        cmake.build()

CMakeLists.txt¶

cmake_minimum_required(VERSION 3.15)
project(foo LANGUAGES NONE)
message(STATUS "MYVAR1 ${MY_USER_VAR1}!!")

我们可以定义一个配置文件和一个 myvars.cmake 文件（两者都在同一个文件夹中），如下所示：

myprofile¶

include(default)
[conf]
tools.cmake.cmaketoolchain:user_toolchain+={{profile_dir}}/myvars.cmake

请注意，{{profile_dir}} 是一个 jinja 模板表达式，它会被评估为当前 profile 文件夹，从而允许计算到 myvars.cmake 文件的必要路径。tools.cmake.cmaketoolchain:user_toolchain 是要注入到生成的 conan_toolchain.cmake 中的文件 **列表**，因此使用 += 运算符将其添加到列表中。

我们可以按需在 myvars.cmake 中定义任意数量的变量

myvars.cmake¶

set(MY_USER_VAR1 "MYVALUE1")

应用此 profile 后，我们可以看到包的 CMake 构建有效地使用了外部 myvars.cmake 文件中提供的变量。

$ conan create . -pr=myprofile
...
-- MY_USER_VAR1 MYVALUE1

请注意，在使用 user_toolchain 的同时定义 tools.cmake.cmaketoolchain:system_name 等 conf 值是受支持的。

此外，user_toolchain 文件可以为交叉编译定义变量，例如 CMAKE_SYSTEM_NAME、CMAKE_SYSTEM_VERSION 和 CMAKE_SYSTEM_PROCESSOR。如果这些变量在 user toolchain 文件中定义，它们将被尊重，并且 conan_toolchain.cmake 推导出的变量将不会覆盖用户定义的变量。如果这些变量未在 user toolchain 文件中定义，则将使用 Conan 自动推导出的变量。

tools.cmake.cmaketoolchain:user_toolchain conf 值也可以通过命令行 -c 参数传递，但 myvars.cmake 的位置需要是绝对路径才能找到，因为 jinja 替换不会在命令行中进行。