CMakeDeps¶

CMakeDeps 生成器会为每个依赖项生成必要的文件，以便能够使用 cmake 的 find_package() 函数来定位依赖项。它可以像这样使用：

from conan import ConanFile

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    requires = "hello/0.1"
    generators = "CMakeDeps"

完整的实例化，允许自定义配置，可以在 generate() 方法中完成

from conan import ConanFile
from conan.tools.cmake import CMakeDeps

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    requires = "hello/0.1"

    def generate(self):
        cmake = CMakeDeps(self)
        cmake.generate()

CMakeLists.txt¶

cmake_minimum_required(VERSION 3.15)
project(compressor C)

find_package(hello REQUIRED)

add_executable(${PROJECT_NAME} src/main.c)
target_link_libraries(${PROJECT_NAME} hello::hello)

默认情况下，对于 hello 依赖项，你需要使用 find_package(hello) 并链接目标 hello::hello。查看影响 CMakeDeps 的属性，例如 cmake_target_name，可以在依赖项及其组件的 conanfile.py 中自定义文件和目标名称。

注意

CMakeDeps 旨在与 CMakeToolchain 生成器一起运行。它会将 CMAKE_PREFIX_PATH 和 CMAKE_MODULE_PATH 设置到正确的文件夹 (conanfile.generators_folder)，以便 CMake 可以找到生成的配置/模块文件。

生成的文件¶

XXX-config.cmake: 默认情况下，CMakeDeps 生成器会创建配置文件，用于声明依赖项及其组件（如果已声明）的目标。
FindXXX.cmake: 仅当依赖项设置了 cmake_find_mode 属性为“module”或“both”时生成。请参阅依赖项中设置的影响 CMakeDeps 的属性。
其他必要的 *.cmake: 文件，例如版本、标志和目录数据或配置。

请注意，它还会生成一个 conandeps_legacy.cmake 文件。此文件提供了类似于 Conan 1 cmake 生成器的行为，允许使用 include(${CMAKE_BINARY_DIR}/generators/conandeps_legacy.cmake) 包含此文件，并提供一个单一的 CMake 变量 CONANDEPS_LEGACY，无需显式枚举即可链接所有直接和传递性依赖项，例如：target_link_libraries(app ${CONANDEPS_LEGACY})。这为 Conan 1.X 用户升级到 Conan 2 提供了一种便利，无需改变其整体开发流程，但除此之外不建议使用此方法。使用 CMake 的标准流程，即显式使用 find_package() 和 target_link_libraries(... pkg1::pkg1 pkg2::pkg2) 并指定目标，是正确的方法。

自定义¶

您可以在创建的 CMakeDeps 对象中调整一些属性来改变默认行为

configuration¶

允许定义标准 Release、Debug 等之外的自定义用户 CMake 配置。

def generate(self):
    deps = CMakeDeps(self)
    # By default, ``deps.configuration`` will be ``self.settings.build_type``
    if self.options["hello"].shared:
        # Assuming the current project ``CMakeLists.txt`` defines the ReleasedShared configuration.
        deps.configuration = "ReleaseShared"
    deps.generate()

CMakeDeps 是一个*多配置*生成器，它可以正确地为 Release/Debug 配置创建文件，以便像 Visual Studio 这样的 IDE 同时使用。在单配置环境中，必须定义一个配置，这必须通过命令行中的 cmake ... -DCMAKE_BUILD_TYPE=<build-type> 参数提供（Conan 在必要时会在 CMake.configure() 助手方法中自动完成）。

build_context_activated¶

当您有一个 build-require 时，默认情况下不生成配置文件（xxx-config.cmake）。但您可以使用 build_context_activated 属性激活它

tool_requires = ["my_tool/0.0.1"]

def generate(self):
    cmake = CMakeDeps(self)
    # generate the config files for the tool require
    cmake.build_context_activated = ["my_tool"]
    cmake.generate()

build_context_suffix¶

当同一个包既作为 build-require 又作为 regular require 时，会在生成器中引起冲突，因为配置文件的文件名、目标名称、变量名称等都会冲突。

例如，这在某些依赖项（capnproto, protobuf…）中是典型情况，它们包含一个用于在构建时生成源代码的工具（因此它是 build_require），但也提供一个库用于链接到最终应用程序，因此您也有一个 regular require。解决此冲突在交叉构建时尤为重要，因为该工具（将在构建机器上运行）属于与该库（将在主机机器上“运行”）不同的二进制包。

您可以使用 build_context_suffix 属性为依赖项指定后缀，以便构建上下文（tool require）中该依赖项的文件/目标/变量会被重命名

tool_requires = ["my_tool/0.0.1"]
requires = ["my_tool/0.0.1"]

def generate(self):
    cmake = CMakeDeps(self)
    # generate the config files for the tool require
    cmake.build_context_activated = ["my_tool"]
    # disambiguate the files, targets, etc
    cmake.build_context_suffix = {"my_tool": "_BUILD"}
    cmake.generate()

build_context_build_modules¶

此外，还有一个关于 build_modules 的问题。您可能知道，依赖项的 recipe 可以声明一个 cppinfo.build_modules 条目，其中包含一个或多个 .cmake 文件。当 cmake find_package() 函数找到依赖项时，Conan 会自动包含这些文件。

默认情况下，Conan 只会包含 host 上下文（常规依赖项）中的 build modules，以避免冲突，但您可以更改此默认行为。

使用 build_context_build_modules 属性指定要包含 tool_requires 中的 build_modules 的依赖项名称

tool_requires = ["my_tool/0.0.1"]

def generate(self):
    cmake = CMakeDeps(self)
    # generate the config files for the tool require
    cmake.build_context_activated = ["my_tool"]
    # Choose the build modules from "build" context
    cmake.build_context_build_modules = ["my_tool"]
    cmake.generate()

check_components_exist¶

警告

check_components_exist 属性是实验性的，可能会发生变化。

此属性默认为 False。如果您希望在使用方指定组件调用 find_package() 时添加检查，请使用此属性。例如，如果我们使用了一个像 Boost 这样声明了多个组件的 Conan 包。如果我们将此属性设置为 True，则使用方的 find_package() 调用将检查所需的组件是否存在，否则会引发错误。您可以在 generate() 方法中设置此属性

requires = "boost/1.81.0"

...

def generate(self):
    deps = CMakeDeps(self)
    deps.check_components_exist = True
    deps.generate()

然后，在使用 Boost 时，由于 fakecomp 不存在，find_package() 将引发错误

cmake_minimum_required(VERSION 3.15)
...
find_package(Boost COMPONENTS random regex fakecomp REQUIRED)
...

参考¶

class CMakeDeps(conanfile)¶

generate()¶: 此方法会将生成的文件保存到 conanfile.generators_folder

set_property(dep, prop, value, build_context=False)¶

使用此方法，您可以从使用方覆盖 Conan recipe 设置的property 值。这可以用于 cmake_file_name, cmake_target_name, cmake_find_mode, cmake_module_file_name, cmake_module_target_name, cmake_additional_variables_prefixes, cmake_config_version_compat, system_package_version, cmake_build_modules, nosoname, 和 cmake_target_aliases。

参数:

dep – 要设置property 的依赖项名称。对于组件，使用语法：dep_name::component_name。
prop – property 的名称。
value – 属性的值。使用 None 来使上游 recipe 设置的任何值失效。
build_context – 如果要为属于构建上下文的依赖项设置属性，请设置为 True（默认为 False）。

get_cmake_package_name(dep, module_mode=None)¶: 获取 find_package(XXX) 的文件名

get_find_mode(dep)¶

参数:: dep – 依赖项
返回:: “none”、“config”、“module”、“both”或未设置时的“config”

属性¶

以下属性会影响 CMakeDeps 生成器

cmake_file_name: 为当前包生成的配置文件将遵循 <VALUE>-config.cmake 模式，因此要查找包，您可以写 find_package(<VALUE>)。
cmake_target_name: 要使用的目标的名称。
cmake_target_aliases: Conan 将为已存在的目标创建的别名列表。
cmake_find_mode: 默认为 config。可能的值有
- config: CMakeDeps 生成器将为依赖项创建配置脚本。
- module: 将为依赖项创建模块配置 (FindXXX.cmake) 脚本。
- both: 将同时生成配置和模块文件。
- none: 不生成任何文件。例如，它可以用于创建系统包装包，以便使用方在 CMake 安装配置路径而不是 Conan 生成的路径中找到配置文件（因为已被跳过）。
cmake_module_file_name: 与 cmake_file_name 相同，但在使用 cmake_find_mode=module/both 生成模块时使用。如果未指定，将默认为 cmake_file_name。
cmake_module_target_name: 与 cmake_target_name 相同，但在使用 cmake_find_mode=module/both 生成模块时使用。如果未指定，将默认为 cmake_target_name。
cmake_build_modules: .cmake 文件列表（相对于根包文件夹的路径），在使用方运行 find_package() 时会自动包含。此属性不能在组件中设置，只能在根 self.cpp_info 中设置。
cmake_set_interface_link_directories: (在 2.14 中已弃用)。很久以前用于 #pragma comment(lib, "foo")，但对于 CMakeDeps 生成器已不再需要。在新的 CMakeConfigDeps 生成器中，需要根据 CPS 实践在 cpp_info 中正确指定库的详细信息。
nosoname: 布尔值，仅应由定义为 SHARED 且表示在构建时没有使用 soname 标志选项的库的依赖项使用。
cmake_config_version_compat: 默认为 SameMajorVersion，它可以取值 "AnyNewerVersion", "SameMajorVersion", "SameMinorVersion", "ExactVersion"。它将在生成的 <PackageName>ConfigVersion.cmake 文件中使用该策略
system_package_version: 用于生成 <PackageName>ConfigVersion.cmake 文件的包版本。在创建系统包或其他包装包时很有用，在这种情况下，conan 包版本与最终引用的包版本不同，以保持与 find_package(<PackageName> <Version>) 调用的兼容性。
cmake_additional_variables_prefixes: 在配置文件中创建 CMake 变量时要使用的前缀列表。这些变量默认使用 file_name 作为前缀创建，但设置此属性将在默认的 file_name 前缀之外创建具有指定前缀的附加变量。

示例

def package_info(self):
    ...
    # MyFileName-config.cmake
    self.cpp_info.set_property("cmake_file_name", "MyFileName")
    # Names for targets are absolute, Conan won't add any namespace to the target names automatically
    self.cpp_info.set_property("cmake_target_name", "Foo::Foo")
    # Automatically include the lib/mypkg.cmake file when calling find_package()
    # This property cannot be set in a component.
    self.cpp_info.set_property("cmake_build_modules", [os.path.join("lib", "mypkg.cmake")])

    # Create a new target "MyFooAlias" that is an alias to the "Foo::Foo" target
    self.cpp_info.set_property("cmake_target_aliases", ["MyFooAlias"])

    self.cpp_info.components["mycomponent"].set_property("cmake_target_name", "Foo::Var")

    # Create a new target "VarComponent" that is an alias to the "Foo::Var" component target
    self.cpp_info.components["mycomponent"].set_property("cmake_target_aliases", ["VarComponent"])

    # Skip this package when generating the files for the whole dependency tree in the consumer
    # note: it will make useless the previous adjustements.
    # self.cpp_info.set_property("cmake_find_mode", "none")

    # Generate both MyFileNameConfig.cmake and FindMyFileName.cmake
    self.cpp_info.set_property("cmake_find_mode", "both")

使用 CMakeDeps.set_property() 从使用方覆盖属性¶

使用 CMakeDeps.set_property() 方法，您可以从使用方覆盖 Conan recipe 设置的属性值。这可以应用于上面列出的每个属性。

假设我们有一个依赖于 zlib/1.2.11 的 compressor/1.0 包。zlib 的 recipe 定义了一些属性

Zlib conanfile.py¶

class ZlibConan(ConanFile):
    name = "zlib"

    ...

    def package_info(self):
        self.cpp_info.set_property("cmake_find_mode", "both")
        self.cpp_info.set_property("cmake_file_name", "ZLIB")
        self.cpp_info.set_property("cmake_target_name", "ZLIB::ZLIB")
        ...

此 recipe 定义了多个属性。例如，cmake_find_mode 属性设置为 both。这意味着为 Zlib 生成模块和配置文件。也许我们需要改变这种行为，只生成配置文件。您可以在 compressor recipe 中使用 CMakeDeps.set_property() 方法来做到这一点

compressor conanfile.py¶

class Compressor(ConanFile):
    name = "compressor"

    requires = "zlib/1.2.11"
    ...

    def generate(self):
        deps = CMakeDeps(self)
        deps.set_property("zlib", "cmake_find_mode", "config")
        deps.generate()
        ...

您还可以使用 set_property() 方法来使上游 recipe 设置的属性值失效，并使用 Conan 默认分配的值。为此，将属性值设置为 None，如下所示

compressor conanfile.py¶

class Compressor(ConanFile):
    name = "compressor"

    requires = "zlib/1.2.11"
    ...

    def generate(self):
        deps = CMakeDeps(self)
        deps.set_property("zlib", "cmake_target_name", None)
        deps.generate()
        ...

这样做之后，生成的 Zlib 库的目标名称将是 zlib::zlib，而不是 ZLIB::ZLIB

此外，CMakeDeps.set_property() 也可用于包含组件的包。在这种情况下，您需要提供包名及其组件，两者用双冒号（::）分隔。示例如下

def generate(self):
    deps = CMakeDeps(self)
    deps.set_property("pkg::component", "cmake_target_name", <new_component_target_name>)
    deps.generate()
    ...

为已安装的 CMake 配置文件禁用 CMakeDeps¶

有些项目可能希望为下游使用方禁用 CMakeDeps 生成器。可以通过将 cmake_find_mode 设置为 none 来实现。如果项目希望提供自己的配置目标，应将其附加到 cpp_info 的 buildirs 属性。

此方法旨在与使用 CMakeToolchain 生成器的下游使用方一起工作，CMakeToolchain 将使用 buildirs 属性填充。

示例

def package(self):
    ...
    cmake.install()

def package_info(self):
    self.cpp_info.set_property("cmake_find_mode", "none") # Do NOT generate any files
    self.cpp_info.builddirs.append(os.path.join("lib", "cmake", "foo"))

将项目配置映射到导入目标的配置¶

如上所述，CMakeDeps 支持多配置环境（Debug、Release 等）。这是通过在安装依赖项时根据 build_type 设置填充导入目标的属性来实现的。然而，当使用方项目使用单配置 CMake 生成器配置时，有必要定义 CMAKE_BUILD_TYPE 的值，使其与已安装依赖项的值匹配。

如果使用方的 CMake 项目配置的构建类型与依赖项不同，则需要通过设置 CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> CMake 变量来告诉 CMake 如何将当前项目的配置映射到导入的目标。

cd build-coverage/
conan install .. -s build_type=Debug
cmake .. -DCMAKE_BUILD_TYPE=Coverage -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_MAP_IMPORTED_CONFIG_COVERAGE=Debug