cmake_layout¶
cmake_layout()
函数会设置 folders 和 cpp 属性,以遵循典型 CMake 项目的结构。
from conan.tools.cmake import cmake_layout
def layout(self):
cmake_layout(self)
注意
要尝试它,您可以使用 conan new cmake_lib -d name=hello -d version=1.0
模板。
分配的值取决于将使用的 CMake 生成器。它可以通过 tools.cmake.cmaketoolchain:generator
[conf] 条目定义,也可以在 recipe 中传递给 cmake_layout(self, cmake_generator)
函数。如果它是多配置生成器(如 Visual Studio 或 Xcode),或单配置生成器(如 Unix Makefiles),则分配的值是不同的。
以下是 cmake_layout
分配的值
conanfile.folders.source
: src_folder 参数或未指定时的.
。conanfile.folders.build
:build
: 如果 CMake 生成器是多配置的。build/Debug
或build/Release
: 如果 CMake 生成器是单配置的,取决于 build_type。字符串
"build"
可以通过build_folder
参数定义为其他值。
conanfile.folders.generators
:build/generators
conanfile.cpp.source.includedirs
:["include"]
conanfile.cpp.build.libdirs
andconanfile.cpp.build.bindirs
对于多配置 CMake 生成器,为
["Release"]
或["Debug"]
。对于单配置 CMake 生成器,为
.
。
参考¶
- cmake_layout(conanfile, generator=None, src_folder='.', build_folder='build')¶
- 参数:
conanfile – 当前的配方对象。始终使用
self
。generator – 允许定义 CMake 生成器。在大多数情况下,无需传递此参数,因为它将从配置
tools.cmake.cmaketoolchain:generator
获取值,或者它将自动从settings
推断生成器。src_folder –
conanfile.folders.source
的值,如果您的源代码(和 CMakeLists.txt)位于子文件夹中,请更改此值。build_folder – 指定“基本”构建文件夹的名称。默认值为“build”,但如果项目使用了该文件夹名称,则可以定义不同的名称。
conf¶
cmake_layout
受以下 [conf]
变量影响
tools.cmake.cmake_layout:build_folder_vars settings、options、
self.name
和self.version
以及常量const.xxx
的列表,用于自定义conanfile.folders.build
文件夹。参见下面的 Multi-setting/option cmake_layout 部分。tools.cmake.cmake_layout:build_folder (Conan 2.2.0 新增)(实验性) 将其值用作本地构建的
conanfile.folders.build
的基本文件夹。tools.cmake.cmake_layout:test_folder (Conan 2.2.0 新增)(实验性) 将其值用作 test_package 构建的
conanfile.folders.build
的基本文件夹。如果该值为$TMP
,Conan 将创建并使用一个临时文件夹。
多设置/选项 cmake_layout¶
folders.build
和 conanfile.folders.generators
可以自定义,以考虑 settings
和 options
,而不仅仅是 build_type
。使用 tools.cmake.cmake_layout:build_folder_vars
conf 来声明 settings、options 和/或 self.name
和 self.version
以及用户常量列表。
conan install . -c tools.cmake.cmake_layout:build_folder_vars="['settings.compiler', 'options.shared']"
对于前面的示例,cmake_layout
分配的值(安装 Release/static 默认配置)将是
conanfile.folders.build
:build/apple-clang-shared_false
: 如果 CMake 生成器是多配置的。build/apple-clang-shared_false/Debug
: 如果 CMake 生成器是单配置的。
conanfile.folders.generators
:build/generators
如果我们以不同的配置重复之前的安装
conan install . -o shared=True -c tools.cmake.cmake_layout:build_folder_vars="['settings.compiler', 'options.shared']"
cmake_layout
分配的值(安装 Release/shared 配置)将是
conanfile.folders.build
:build/apple-clang-shared_true
: 如果 CMake 生成器是多配置的。build/apple-clang-shared_true/Debug
: 如果 CMake 生成器是单配置的。
conanfile.folders.generators
:build-apple-clang-shared_true/generators
因此,我们可以为我们想要安装的任何数量的不同配置保留独立的文件夹。还可以使用 recipe 属性,例如 name 和 version 以及用户常量。
$ conan install . -c tools.cmake.cmake_layout:build_folder_vars="['const.myvalue, 'self.name']"
它将创建诸如 build/myvalue-pkgname
之类的文件夹。
在 CMakeToolchain 生成器处生成的 CMakePresets.json
文件,也将考虑此 tools.cmake.cmake_layout:build_folder_vars
配置,以为预设生成不同的名称,这对于安装 N 个配置并通过选择所选预设来构建我们的项目非常方便。