CMake¶

The CMake 构建助手是 cmake 命令行调用的一个包装器。它将抽象像 cmake --build . --config Release 这样的调用为 Python 方法调用。它还会添加参数 -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake (来自生成器 CMakeToolchain) 到 configure() 调用中，以及其他可能的参数，如 -DCMAKE_BUILD_TYPE=<config>。使用的参数是从生成的 CMakePresets.json 文件中获取的。

该助手旨在用于 build() 方法中，以便当 Conan 直接构建包时 (create, install) 自动调用 CMake 命令。

from conan import ConanFile
from conan.tools.cmake import CMake, CMakeToolchain, CMakeDeps

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    requires = "hello/0.1"
    options = {"shared": [True, False], "fPIC": [True, False]}
    default_options = {"shared": False, "fPIC": True}

    def generate(self):
        tc = CMakeToolchain(self)
        tc.generate()
        deps = CMakeDeps(self)
        deps.generate()

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

参考¶

class CMake(conanfile)¶

CMake 助手，与 CMakeToolchain 特性一起使用

参数：: conanfile – 当前的配方对象。始终使用 self。

configure(variables=None, build_script_folder=None, cli_args=None, stdout=None, stderr=None)¶

读取由 CMakeToolchain 生成的 CMakePresets.json 文件以获取

生成器，以便追加 -G="xxx"。

工具链的路径并追加 -DCMAKE_TOOLCHAIN_FILE=/path/conan_toolchain.cmake

声明的 cache variables 并追加 -Dxxx。

并调用 cmake。

参数：

variables – 应为 CMake 变量及其值的字典，这些变量及其值将被映射到命令行 -DVAR=VALUE 参数。请注意，在一般情况下，传递给 CMake 的信息应通过 CMakeToolchain 在 conan_toolchain.cmake 文件中提供。此 variables 参数旨在用于在工具链方法中不起作用的特殊情况。
build_script_folder – CMakeLists.txt 的路径，以防它不在 layout() 方法中声明的 self.folders.source 内。
cli_args – 参数列表 [arg1, arg2, ...]，将作为额外的 CLI 参数传递给 cmake 调用
stdout – 用于将标准输出重定向到此流
stderr – 用于将标准错误重定向到此流

build(build_type=None, target=None, cli_args=None, build_tool_args=None, stdout=None, stderr=None)¶

参数：

build_type – 仅用于覆盖多配置生成器（例如 Visual Studio, XCode）中 settings.build_type 定义的值。对于单配置生成器，此值将被忽略，它们将使用安装步骤期间在工具链文件中定义的值。
target – 单个构建目标的名称（字符串形式），或多个构建目标的名称（字符串列表形式），将传递给 --target 参数。
cli_args – 参数列表 [arg1, arg2, ...]，将直接作为额外的 CLI 参数传递给 cmake --build ... arg1 arg2 命令。
build_tool_args – 底层构建系统的参数列表 [barg1, barg2, ...]，将通过 -- 指示符后传递给命令行：cmake --build ... -- barg1 barg2
stdout – 用于将标准输出重定向到此流
stderr – 用于将标准错误重定向到此流

install(build_type=None, component=None, cli_args=None, stdout=None, stderr=None)¶

等同于运行 cmake --install

参数：

component – 要安装的特定组件（如果有）
build_type – 仅用于覆盖 settings.build_type 中定义的值。如果构建是单配置的（例如 Unix Makefiles），则可能失败，因为在这种情况下，构建类型必须在配置时指定，而不是构建时。
cli_args – 底层构建系统的参数列表 [arg1, arg2, ...]，将传递给命令行：cmake --install ... arg1 arg2
stdout – 用于将标准输出重定向到此流
stderr – 用于将标准错误重定向到此流

test(build_type=None, target=None, cli_args=None, build_tool_args=None, env='', stdout=None, stderr=None)¶

等同于运行 cmake –build . –target=RUN_TESTS。

参数：

build_type – 仅用于覆盖 settings.build_type 中定义的值。如果构建是单配置的（例如 Unix Makefiles），则可能失败，因为在这种情况下，构建类型必须在配置时指定，而不是构建时。
target – 要运行的构建目标的名称，默认为 RUN_TESTS 或 test
cli_args – 与上面的 build() 相同，是参数列表 [arg1, arg2, ...]，将作为底层构建系统的额外参数传递
build_tool_args – 与上面的 build() 相同
stdout – 用于将标准输出重定向到此流
stderr – 用于将标准错误重定向到此流

ctest(cli_args=None, env='', stdout=None, stderr=None)¶

等同于运行 ctest …

参数：

cli_args – 参数列表 [arg1, arg2, ...]，将作为额外的 ctest 命令行参数传递
env – 要激活的环境文件，默认为 conanbuild + conanrun
stdout – 用于将标准输出重定向到此流
stderr – 用于将标准错误重定向到此流

conf¶

The CMake() 构建助手受这些 [conf] 变量影响

tools.build:verbosity 将接受 quiet 或 verbose 中的一个值，当为 CMake 使用 Visual Studio 生成器 (MSBuild 构建系统) 时，将其传递给 CMake.build() 命令。它通过调用 cmake --build . --config Release -- /verbosity:Diagnostic 作为参数传递给底层构建系统。
tools.compilation:verbosity 将接受 quiet 或 verbose 中的一个值传递给 CMake，如果设置为 verbose，则设置 -DCMAKE_VERBOSE_MAKEFILE
运行 Ninja 生成器时，tools.build:jobs 参数用于 --jobs 参数。
运行 MSBuild 时，tools.microsoft.msbuild:max_cpu_count 参数用于 /m (/maxCpuCount)。如果 max_cpu_count=0，则将使用不带参数的 /m，这意味着使用所有可用的 CPU。
tools.cmake:cmake_program 指定 CMake 可执行文件的位置，而不是使用 PATH 中找到的。
如果设置为 True，tools.cmake:install_strip 会将 --strip 传递给 cmake --install 调用。