MesonToolchain

重要

此类生成的文件的兼容性要求 Meson 版本 >= 0.55.0

MesonToolchain 是 Meson 的工具链生成器,可以在 generate() 方法中按如下方式使用

from conan import ConanFile
from conan.tools.meson import MesonToolchain

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

    def generate(self):
        tc = MesonToolchain(self)
        tc.preprocessor_definitions["MYDEFINE"] = "MYDEF_VALUE"
        tc.generate()

重要

当你的配方有依赖项时,MesonToolchain 仅与 PkgConfigDeps 生成器一起工作。请勿使用其他生成器,因为它们可能存在重叠定义而导致冲突。

生成的文件

MesonToolchain 在执行 conan install 后(或在缓存中构建包时),根据 generate() 方法中提供的信息以及从当前 settingsconf 等转换的信息,生成以下文件。

  • conan_meson_native.ini: 如果进行原生构建。

  • conan_meson_cross.ini: 如果进行交叉构建 (conan.tools.build)。

conan_meson_native.ini

此文件包含与当前包、平台等的 Conan 选项和设置相关的所有 Meson 属性定义。这包括但不限于以下内容

  • 从 Conan 设置中检测 default_library

    • 基于名为 shared 的选项的存在/值。

  • 从 Conan 设置中检测 buildtype

  • 根据需要定义 C++ 标准。

  • Visual Studio 运行时 (b_vscrt),从 Conan 输入设置中获取。

conan_meson_cross.ini

此文件包含与之前的 conan_meson_native.ini 相同的信息,但增加了描述主机、目标和构建机器(例如处理器架构)的信息。

查阅 meson 文档以获取有关原生和交叉文件的更多详情

默认目录

MesonToolchain 管理 Meson 使用的一些目录。这些变量在 conan_meson_native.iniconan_meson_cross.ini 文件的 [project options] 部分声明(参见关于 Meson 目录 的更多信息)

bindir: 来自 self.cpp.package.bindirs 的值。默认为 None。 sbindir: 来自 self.cpp.package.bindirs 的值。默认为 None。 libexecdir: 来自 self.cpp.package.bindirs 的值。默认为 None。 datadir: 来自 self.cpp.package.resdirs 的值。默认为 None。 localedir: 来自 self.cpp.package.resdirs 的值。默认为 None。 mandir: 来自 self.cpp.package.resdirs 的值。默认为 None。 infodir: 来自 self.cpp.package.resdirs 的值。默认为 None。 includedir: 来自 self.cpp.package.includedirs 的值。默认为 None。 libdir: 来自 self.cpp.package.libdirs 的值。默认为 None。

请注意,它需要 layout 才能初始化这些 self.cpp.package.xxxxx 变量。例如

from conan import ConanFile
from conan.tools.meson import MesonToolchain
class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    def layout(self):
        self.folders.build = "build"
        self.cpp.package.resdirs = ["res"]
    def generate(self):
        tc = MesonToolchain(self)
        self.output.info(tc.project_options["datadir"])  # Will print '["res"]'
        tc.generate()

注意

所有变量仅在有值时才会被保存。如果值为 ``None``,它们将不会在 [project options] 部分中提及。

定制

属性

project_options

此属性允许定义 Meson 项目选项

def generate(self):
    tc = MesonToolchain(self)
    tc.project_options["MYVAR"] = "MyValue"
    tc.generate()

这被翻译为

  • conan_meson_native.iniconan_meson_cross.ini 文件中为 MYVAR 定义一个项目选项。

默认情况下,wrap_mode: nofallback 被定义为一个项目选项,以确保在 Conan 包中找到依赖项。可以通过以下方式更改或移除它

def generate(self):
    tc = MesonToolchain(self)
    tc.project_options.pop("wrap_mode")
    tc.generate()

请注意,在这种情况下,Meson 可能会在“wraps”中找到依赖项,用户有责任检查其行为并确保依赖项的来源。

subproject_options

此属性允许定义 Meson 子项目选项

def generate(self):
    tc = MesonToolchain(self)
    tc.subproject_options["SUBPROJECT"] = [{'MYVAR': 'MyValue'}]
    tc.generate()

这被翻译为

  • conan_meson_native.iniconan_meson_cross.ini 文件中为一个子项目 SUBPROJECT 和选项 MYVAR 定义。

请注意,与 project_options 不同,subproject_options 是一个由字典列表组成的字典。这是因为 Meson 允许存在多个子项目,并且每个子项目都可以有多个选项。

preprocessor_definitions

此属性允许为多种配置(Debug, Release 等)定义编译器预处理器定义。

def generate(self):
    tc = MesonToolchain(self)
    tc.preprocessor_definitions["MYDEF"] = "MyValue"
    tc.generate()

这被翻译为

  • conan_meson_native.iniconan_meson_cross.ini 文件中为 MYDEF 定义一个预处理器定义。

conf

MesonToolchain 受以下 [conf] 变量影响

  • tools.meson.mesontoolchain:backend. 要使用的 meson backend。可能的值:ninja, vs, vs2010, vs2015, vs2017, vs2019, xcode

  • tools.apple:sdk_path 在 Apple 交叉编译情况下的 SDK 路径参数。它被用作标志 -isysroot 的值。

  • tools.android:ndk_path 在 Android 交叉编译情况下的 NDK 路径参数。它用于获取在 conan_meson_cross.ini[binaries] 部分中使用的一些二进制文件,如 c, cppar

  • tools.build:cxxflags 额外的 C++ 标志列表,由 cpp_args 使用。

  • tools.build:cflags 额外的纯 C 标志列表,由 c_args 使用。

  • tools.build:sharedlinkflags 额外的链接器标志列表,由 c_link_argscpp_link_args 使用。

  • tools.build:exelinkflags 额外的链接器标志列表,由 c_link_argscpp_link_args 使用。

  • tools.build:linker_scripts 链接器脚本列表,每个脚本都会加上 -T 前缀并传递给 c_link_argscpp_link_args。仅与支持使用 -T 标志指定链接器脚本的链接器一起使用此标志,例如 ldgoldlld

  • tools.build:defines 预处理器定义列表,每个定义都会加上 -D 前缀并传递给 cpp_argsc_args

  • tools.build:compiler_executables 类似字典的 Python 对象,以编译器为键,编译器可执行文件路径为值。这些键将按如下方式映射

  • tools.build:sysroot 接受系统根目录的路径,并设置 --sysroot 标志,该标志由 c_argscpp_argsc_link_argscpp_link_args 使用。

    • c: 将在 conan_meson_xxxx.ini[binaries] 部分中设置 c

    • cpp: 将在 conan_meson_xxxx.ini[binaries] 部分中设置 cpp

    • objc: 将在 conan_meson_xxxx.ini[binaries] 部分中设置 objc

    • objcpp: 将在 conan_meson_xxxx.ini[binaries] 部分中设置 objcpp

在 Meson 中为 Conan 选项使用正确的数据类型

在将 Conan 选项赋值为 Meson 值之前,务必将其转换为有效的 Python 数据类型

options = {{"shared": [True, False], "fPIC": [True, False], "with_msg": ["ANY"]}}
default_options = {{"shared": False, "fPIC": True, "with_msg": "Hi everyone!"}}

def generate(self):
    tc = MesonToolchain(self)
    tc.project_options["DYNAMIC"] = bool(self.options.shared)  # shared is bool
    tc.project_options["GREETINGS"] = str(self.options.with_msg)  # with_msg is str
    tc.subproject_options["SUBPROJECT"] = [{'MYVAR': str(self.options.with_msg)}]  # with_msg is str
    tc.subproject_options["SUBPROJECT"].append({'MYVAR': bool(self.options.shared)})  # shared is bool
    tc.generate()

相反,强烈不建议将 Conan 选项直接赋值为 Meson 值

options = {{"shared": [True, False], "fPIC": [True, False], "with_msg": ["ANY"]}}
default_options = {{"shared": False, "fPIC": True, "with_msg": "Hi everyone!"}}
# ...
def generate(self):
    tc = MesonToolchain(self)
    tc.project_options["DYNAMIC"] = self.options.shared  # == <PackageOption object>
    tc.project_options["GREETINGS"] = self.options.with_msg  # == <PackageOption object>
    tc.subproject_options["SUBPROJECT"] = [{'MYVAR': self.options.with_msg}]  # == <PackageOption object>
    tc.subproject_options["SUBPROJECT"].append({'MYVAR': self.options.shared})  # == <PackageOption object>
    tc.generate()

这些不是布尔值或字符串值,而是代表这些选项值的内部 Conan 类。如果你直接赋值这些值,执行 generate() 函数时,你会在控制台中收到一条警告,提示 WARN: deprecated: Please, do not use a Conan option value directly.。这种方法被认为是不良实践,因为它可能导致项目构建过程中出现意外错误。

为 Apple 和 Android 进行交叉构建

MesonToolchain 生成器添加了交叉编译 Apple (MacOS M1, iOS 等) 和 Android 所需的所有标志。

Apple

它将链接标志 -arch XXX-isysroot [SDK_PATH] 和最低部署目标标志(例如 -mios-version-min=8.0)添加到 MesonToolchainc_argsc_link_argscpp_argscpp_link_args 属性中,前提是存在任意 Apple OS (iOS, watchOS 等) 的 Conan 设置和 tools.apple:sdk_path 配置值,如下面的主机配置文件示例所示

ios_host_profile
[settings]
os = iOS
os.version = 10.0
os.sdk = iphoneos
arch = armv8
compiler = apple-clang
compiler.version = 12.0
compiler.libcxx = libc++

[conf]
tools.apple:sdk_path=/my/path/to/iPhoneOS.sdk

Android

它初始化 MesonToolchainc, cppar 属性,这些属性是交叉编译 Android 所必需的,前提是存在 Android 的 Conan 设置和 tools.android:ndk_path 配置值,如下面的主机配置文件示例所示

android_host_profile
[settings]
os = Android
os.api_level = 21
arch = armv8

[conf]
tools.android:ndk_path=/my/path/to/NDK

交叉构建和 native=true

Conan 2.3.0 起新增

进行交叉构建时,有时需要构建一个用于生成源文件的工具。为此,你可能希望使用系统的原生编译器构建一些目标。然后,你需要 Conan 创建两个上下文文件

def generate(self):
    tc = MesonToolchain(self)
    tc.generate()
    # Forcing to create the native context too
    if cross_building(self):
        tc = MesonToolchain(self, native=True)
        tc.generate()

另请参阅 Meson 文档中的 此参考资料 以获取更多信息。

Objective-C 参数

在 Apple OS 中,还存在特定的 Objective-C/Objective-C++ 参数:objcobjcppobjc_argsobjc_link_argsobjcpp_argsobjcpp_link_args,作为 MesonToolchain 类的公共属性,其中变量 objcobjcpp 默认分别初始化为 clangclang++

另请参阅

参考

class MesonToolchain(conanfile, backend=None, native=False)

MesonToolchain 生成器

参数:
  • conanfile< ConanFile object > 当前的配方对象。始终使用 self

  • backendstr backend Meson 变量的值。默认为 ninja

  • nativebool 指示你是否希望 Conan 在交叉构建上下文中创建 conan_meson_native.ini。请注意,这仅在你的项目的 meson.build 使用 native=true 时才有意义(另请参阅 https://mesonbuild.cn/Cross-compilation.html#mixing-host-and-build-targets)。

extra_cxxflags

额外 CXX 标志列表。添加到 cpp_args

extra_cflags

额外 C 标志列表。添加到 c_args

extra_ldflags

额外链接器标志列表。添加到 c_link_argscpp_link_args

extra_defines

额外预处理器定义列表。以 -D[FLAG_N] 格式添加到 c_argscpp_args 中。

arch_flag

由 Conan 推断并添加到 c_argscpp_argsc_link_argscpp_link_args 中的架构标志

properties

类似字典的对象,以 key=value 格式定义 Meson properties

project_options

类似字典的对象,以 key=value 格式定义 Meson project options

preprocessor_definitions

类似字典的对象,定义 Meson preprocessor definitions

subproject_options

类似字典的对象,定义 Meson subproject options

pkg_config_path

定义 Meson 变量 pkg_config_path

cross_build

类似字典的对象,以 build, host, target 作为 Meson 机器上下文

c

设置 Meson 变量 c,默认为 CC 构建环境值。如果作为空格分隔的字符串提供,它将被转换为列表。否则,它保持为单个字符串。

cpp

设置 Meson 变量 cpp,默认为 CXX 构建环境值。如果作为空格分隔的字符串提供,它将被转换为列表。否则,它保持为单个字符串。

ld

设置 Meson 变量 ld,默认为 LD 构建环境值。如果作为空格分隔的字符串提供,它将被转换为列表。否则,它保持为单个字符串。

c_ld

定义 Meson 变量 c_ld。默认为 CC_LD 环境值

cpp_ld

定义 Meson 变量 cpp_ld。默认为 CXX_LD 环境值

ar

定义 Meson 变量 ar。默认为 AR 构建环境值

strip

定义 Meson 变量 strip。默认为 STRIP 构建环境值

as_

定义 Meson 变量 as。默认为 AS 构建环境值

windres

定义 Meson 变量 windres。默认为 WINDRES 构建环境值

pkgconfig

定义 Meson 变量 pkgconfig。默认为 PKG_CONFIG 构建环境值

c_args

定义 Meson 变量 c_args。默认为 CFLAGS 构建环境值

定义 Meson 变量 c_link_args。默认为 LDFLAGS 构建环境值

cpp_args

定义 Meson 变量 cpp_args。默认为 CXXFLAGS 构建环境值

定义 Meson 变量 cpp_link_args。默认为 LDFLAGS 构建环境值

apple_arch_flag

Apple 架构标志,列表形式,例如 ["-arch", "i386"]

apple_isysroot_flag

Apple sysroot 标志,列表形式,例如 ["-isysroot", "./Platforms/MacOSX.platform"]

apple_min_version_flag

Apple 最低二进制版本标志,列表形式,例如 ["-mios-version-min", "10.8"]

apple_extra_flags

Apple bitcode, visibility 和 arc 标志

objc

定义 Meson 变量 objc。如果为任意 Apple OS,则默认为 clang,否则为 None

objcpp

定义 Meson 变量 objcpp。如果为任意 Apple OS,则默认为 clang++,否则为 None

objc_args

定义 Meson 变量 objc_args。默认为 OBJCFLAGS 构建环境值

定义 Meson 变量 objc_link_args。默认为 LDFLAGS 构建环境值

objcpp_args

定义 Meson 变量 objcpp_args。默认为 OBJCXXFLAGS 构建环境值

定义 Meson 变量 objcpp_link_args。默认为 LDFLAGS 构建环境值

generate()

创建包含适当内容的 conan_meson_native.ini(如果是原生构建)或 conan_meson_cross.ini(如果是交叉构建)。如果是 Windows OS,还会创建 conanvcvars.bat 文件。