MesonToolchain

重要

此类生成的文件仅与 Meson 版本 >= 0.55.0 兼容。

Meson 的工具链生成器为 MesonToolchain,可以在 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 生成器配合使用。请不要使用其他生成器,因为它们可能存在重叠的定义,从而导致冲突。

生成的文件

generate() 方法中提供的信息以及从当前 settingsconf 等翻译而来的信息,MesonToolchain 在执行 conan install(或在缓存中构建包时)后生成以下文件:

  • 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 的 后端。可能的值:ninjavsvs2010vs2015vs2017vs2019xcode

  • tools.apple:sdk_path 用于 Apple 交叉编译时的 SDK 路径。它用作 -isysroot 标志的值。

  • tools.android:ndk_path 用于 Android 交叉编译时的 NDK 路径。它用于获取一些二进制文件,如 ccppar,这些文件用于 conan_meson_cross.ini[binaries] 部分。

  • 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

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

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

它根据 Android 的 Conan 设置和 tools.android:ndk_path 配置值,初始化 MesonToolchainccppar 属性,这些属性是为 Android 进行交叉编译所必需的,如下面的主机配置文件示例所示:

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 对象 > 当前配方对象。始终使用 self

  • backend – (已弃用,请使用 self.backend 代替)str backend Meson 变量值。默认为 ninja

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

backend

要使用的后端。由配置 tools.meson.mesontoolchain:backend 定义。默认为 ninja

buildtype

要使用的构建类型。

b_ndebug

禁用断言。

b_staticpic

将静态库构建为位置无关。默认为 self.options.get_safe("fPIC")

default_library

默认库类型,例如“shared”。

cpp_std

要使用的 C++ 语言标准。默认由 to_cppstd_flag() 定义。

c_std

要使用的 C 语言标准。默认由 to_cstd_flag() 定义。

b_vscrt

要使用的 VS 运行时库。默认由 msvc_runtime_flag() 定义。

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

Conan 推断出的架构链接标志,添加到 c_link_argscpp_link_args

threads_flags

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

类似字典的对象,以 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、可见性和 arc 标志。

objc

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

objcpp

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

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 操作系统,还将创建 conanvcvars.bat