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

此属性允许为多个配置(调试、发布等)定义编译器预处理器定义。

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 路径的参数。它用于获取 conan_meson_cross.ini 的 [binaries] 部分中使用的某些二进制文件,例如 ccppar

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

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

  • 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 属性中,前提是 Conan 设置为任何 Apple 操作系统(iOS、watchOS 等),并且 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

它初始化 MesonToolchainccppar 属性,这些属性是针对 Android 进行交叉编译所必需的,前提是 Conan 设置为 Android,并且 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://meson.pythonlang.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 中。

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 系统根目录标志,以列表形式表示,例如 ["-isysroot", "./Platforms/MacOSX.platform"]

apple_min_version_flag

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

objc

定义 Meson 的 objc 变量。默认为 None,如果为任何 Apple 操作系统 clang

objcpp

定义 Meson 的 objcpp 变量。默认为 None,如果为任何 Apple 操作系统 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 文件。