conan.tools.build¶
构建¶
conan.tools.build.build_jobs()¶
- build_jobs(conanfile)¶
返回可用于并行构建的 CPU 数量。 如果存在
tools.build:jobs
的配置值,则返回该值,否则,默认为辅助函数_cpu_count()
。_cpu_count()
读取 cgroup 以检测配置的 CPU 数量。 目前,有两个版本的 cgroup 可用。在 cgroup v1 的情况下,如果 cgroup 中的数据无效,则会启用处理器检测。 如果未启用处理器检测,
build_jobs()
将安全地返回 1。在 cgroup v2 的情况下,如果未设置限制,则使用处理器检测。 当设置限制时,行为与 cgroup v1 中描述的相同。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。- 返回值:
int
,表示作业数
conan.tools.build.cross_building()¶
- cross_building(conanfile=None, skip_x64_x86=False)¶
检查我们是否正在进行交叉构建,方法是比较build和host设置。 如果我们正在进行交叉构建,则返回
True
。- 参数:
conanfile – 当前配方对象。 始终使用
self
。skip_x64_x86 – 从 64 位构建到 32 位时不考虑交叉构建:x86_64 到 x86,sparcv9 到 sparc 或 ppc64 到 ppc32
- 返回值:
来自
tools.build.cross_building:cross_build
的bool
值(如果存在),否则,如果我们正在进行交叉构建,则返回True
,否则返回False
。
conan.tools.build.can_run()¶
- can_run(conanfile)¶
验证是否可以在同一架构上运行非原生应用程序。 对于您的架构可以运行多个目标的情况,这是一个有用的功能。 例如,Mac M1 机器可以同时运行 armv8 和 x86_64。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。- 返回值:
来自
tools.build.cross_building:can_run
的bool
值(如果存在),否则,如果我们正在进行交叉构建,则返回False
,否则返回True
。
Cppstd¶
conan.tools.build.check_min_cppstd()¶
- check_min_cppstd(conanfile, cppstd, gnu_extensions=False)¶
检查当前的 cppstd 是否符合所需的最低版本。
如果当前的 cppstd 不符合 cppstd 要求的最低版本,则会引发 ConanInvalidConfiguration 异常。
必须定义 settings.compiler.cppstd,否则会引发 ConanInvalidConfiguration 异常
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cppstd – 所需的最低 cppstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)
conan.tools.build.check_max_cppstd()¶
- check_max_cppstd(conanfile, cppstd, gnu_extensions=False)¶
检查当前的 cppstd 是否符合要求的最高版本。
如果当前的 cppstd 不符合 cppstd 要求的最高版本,则会引发 ConanInvalidConfiguration 异常。
必须定义 settings.compiler.cppstd,否则会引发 ConanInvalidConfiguration 异常
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cppstd – 所需的最高 cppstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)
conan.tools.build.valid_min_cppstd()¶
- valid_min_cppstd(conanfile, cppstd, gnu_extensions=False)¶
验证当前的 cppstd 是否符合所需的最低版本。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cppstd – 所需的最低 cppstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)。 此选项仅在 Linux 上有效。
- 返回值:
如果当前的 cppstd 与所需的 cppstd 版本匹配,则为 True。 否则为 False。
conan.tools.build.valid_max_cppstd()¶
- valid_max_cppstd(conanfile, cppstd, gnu_extensions=False)¶
验证当前的 cppstd 是否符合要求的最高版本。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cppstd – 所需的最高 cppstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)。 此选项仅在 Linux 上有效。
- 返回值:
如果当前的 cppstd 与所需的 cppstd 版本匹配,则为 True。 否则为 False。
conan.tools.build.default_cppstd()¶
- default_cppstd(conanfile, compiler=None, compiler_version=None)¶
获取 “conanfile.settings.compiler” 和 “conanfile settings.compiler_version” 的默认
compiler.cppstd
,或者如果指定了参数 “compiler” 和 “compiler_version”,则获取它们的默认值。- 参数:
conanfile – 当前配方对象。 始终使用
self
。compiler – 编译器的名称,例如 gcc
compiler_version – 编译器的版本,例如 12
- 返回值:
指定编译器的默认
compiler.cppstd
conan.tools.build.supported_cppstd()¶
- supported_cppstd(conanfile, compiler=None, compiler_version=None)¶
获取 “conanfile.settings.compiler” 和 “conanfile.settings.compiler_version” 或参数 “compiler” 和 “compiler_version”(如果已指定)支持的
compiler.cppstd
列表。- 参数:
conanfile – 当前配方对象。 始终使用
self
。compiler – 编译器的名称,例如:gcc
compiler_version – 编译器的版本,例如:12
- 返回值:
支持的
cppstd
值列表。
conan.tools.build.cppstd_flag()¶
- cppstd_flag(conanfile) str ¶
根据
conanfile.settings.compiler
、conanfile.settings.compiler.version
和conanfile.settings.compiler.cppstd
返回 C++ 标准特定的标志。它还会考虑何时在
settings.compiler.cppstd
中使用 GNU 扩展,并在编译器标志中反映出来。 目前,它支持 GCC、Clang、AppleClang、MSVC、Intel、MCST-LCC。如果配置文件中没有
settings.compiler
或settings.cppstd
,则结果将为空字符串。- 参数:
conanfile – 当前配方对象。 始终使用
self
。- 返回值:
str
,表示编译器使用的标准 C++ 标志。 例如 “-std=c++11”、"/std:c++latest"
cstd¶
警告
此功能是实验性的,可能会有重大更改。 有关更多信息,请参阅 Conan 稳定性 部分。
conan.tools.build.check_min_cstd()¶
- check_min_cstd(conanfile, cstd, gnu_extensions=False)¶
检查当前的 cstd 是否符合所需的最低版本。
如果当前的 cstd 不符合 cstd 要求的最低版本,则会引发 ConanInvalidConfiguration 异常。
如果 settings.compiler.cstd,该工具将使用 settings.compiler.cstd 进行比较
如果不是 settings.compiler.cstd,该工具将使用编译器进行比较(从 cstd_default 读取默认值)
如果不存在 settings.compiler(未在 settings 中声明),则会引发异常,因为它无法比较。
如果无法检测到 settings.compiler 的默认 cstd,则会引发异常。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cstd – 所需的最低 cstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)
conan.tools.build.check_max_cstd()¶
- check_max_cstd(conanfile, cstd, gnu_extensions=False)¶
检查当前的 cstd 是否符合要求的最高版本。
如果当前的 cstd 不符合 cstd 要求的最高版本,则会引发 ConanInvalidConfiguration 异常。
如果 settings.compiler.cstd,该工具将使用 settings.compiler.cstd 进行比较
如果不是 settings.compiler.cstd,该工具将使用编译器进行比较(从 cstd_default 读取默认值)
如果不存在 settings.compiler(未在 settings 中声明),则会引发异常,因为它无法比较。
如果无法检测到 settings.compiler 的默认 cstd,则会引发异常。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cstd – 所需的最高 cstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)
conan.tools.build.valid_min_cstd()¶
- valid_min_cstd(conanfile, cstd, gnu_extensions=False)¶
验证当前的 cstd 是否符合所需的最低版本。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cstd – 所需的最低 cstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)。 此选项仅在 Linux 上有效。
- 返回值:
如果当前的 cstd 与所需的 cstd 版本匹配,则为 True。 否则为 False。
conan.tools.build.valid_max_cstd()¶
- valid_max_cstd(conanfile, cstd, gnu_extensions=False)¶
验证当前的 cstd 是否符合要求的最高版本。
- 参数:
conanfile – 当前配方对象。 始终使用
self
。cstd – 所需的最高 cstd 版本
gnu_extensions – 需要 GNU 扩展(例如 gnu17)。 此选项仅在 Linux 上有效。
- 返回值:
如果当前的 cstd 与所需的 cstd 版本匹配,则为 True。 否则为 False。
conan.tools.build.supported_cstd()¶
- supported_cstd(conanfile, compiler=None, compiler_version=None)¶
获取 “conanfile.settings.compiler” 和 “conanfile.settings.compiler_version” 或参数 “compiler” 和 “compiler_version”(如果已指定)支持的
compiler.cstd
列表。- 参数:
conanfile – 当前配方对象。 始终使用
self
。compiler – 编译器的名称,例如:gcc
compiler_version – 编译器的版本,例如:12
- 返回值:
支持的
cstd
值列表。