CMake¶
的 CMake
构建助手是对 cmake 命令行调用的封装。它将诸如 cmake --build . --config Release
的调用抽象为 Python 方法调用。它还会将参数 -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake
(来自生成器 CMakeToolchain
)添加到 configure()
调用中,以及其他可能的参数,例如 -DCMAKE_BUILD_TYPE=<config>
。将使用的参数从生成的 CMakePresets.json
文件中获取。
此助手旨在用于 build()
方法中,以便当 Conan 直接构建包(创建、安装)时自动调用 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)¶
与 CMakeToolchain 功能一起使用的 CMake 助手
- 参数:
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
参数。请记住,在一般情况下,应在CMakeToolchain
中向 CMake 传递信息,以便在conan_toolchain.cmake
文件中提供。此variables
参数旨在用于工具链方法无法工作的特殊情况。build_script_folder – CMakeLists.txt 的路径,以防它不在
layout()
方法中声明的self.folders.source
中。cli_args – 将作为额外 CLI 参数传递给 cmake 调用的参数列表
[arg1, arg2, ...]
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 – 将直接传递给
cmake --build ... arg1 arg2
命令的参数列表[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 – 将作为额外 ctest 命令行参数传递的参数列表
[arg1, arg2, ...]
env – 要激活的环境文件,默认为 conanbuild + conanrun
stdout – 用于将标准输出重定向到此流
stderr – 用于将标准错误重定向到此流
conf¶
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
中找到的。tools.cmake:install_strip
(已弃用,请使用tools.build:install_strip`) 如果设置为
True`,将把
--strip
传递给cmake --install
调用。tools.build:install_strip
(自 Conan 2.18.0 起) 如果设置为True`,将把
--strip
传递给cmake --install
调用。