XcodeToolchain

XcodeToolchain 是 Xcode 的工具链生成器。它会生成可以添加到 Xcode 项目的 .xcconfig 配置文件。此生成器将当前的包配置、设置和选项翻译成 Xcode .xcconfig 文件的语法。

可以在 conanfiles 中按名称使用 XcodeToolchain 生成器

conanfile.py
class Pkg(ConanFile):
    generators = "XcodeToolchain"
conanfile.txt
[generators]
XcodeToolchain

它也可以在 conanfile 的 generate() 方法中完全实例化

from conan import ConanFile
from conan.tools.apple import XcodeToolchain

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"

    def generate(self):
        tc = XcodeToolchain(self)
        tc.generate()

在运行 conan install 命令后,XcodeToolchain 会生成三个文件。如上文为 XcodeDeps 生成器所述,每个不同的配置都会创建一组名称不同的文件。例如,先为 Release 配置,然后为 Debug 配置运行 conan install 命令

$ conan install conanfile.py # default is Release
$ conan install conanfile.py -s build_type=Debug

会创建这些文件

.
├── conan_config.xcconfig
├── conantoolchain_release_x86_64.xcconfig
├── conantoolchain_debug_x86_64.xcconfig
├── conantoolchain.xcconfig
└── conan_global_flags.xcconfig

这些文件是

  • 主要的 conan_config.xcconfig 文件,需要添加到项目中。它同时包含此生成器生成的文件以及 XcodeDeps 生成的文件(如果也设置了 XcodeDeps)。

  • conantoolchain_<debug/release>_x86_64.xcconfig:根据构建配置、架构和 SDK 设置,声明 CLANG_CXX_LIBRARYCLANG_CXX_LANGUAGE_STANDARDMACOSX_DEPLOYMENT_TARGET(当 os 设置为 Macos 时)变量,并包含条件逻辑。

  • conantoolchain.xcconfig:汇总了所有用于不同已安装配置的 conantoolchain_<config>_<arch>.xcconfig 文件。

  • conan_global_flags.xcconfig:仅在设置了任何与编译器或链接器标志相关的配置变量时才会生成此文件。有关更多详细信息,请查看下方的配置部分

每次使用不同配置调用 conan install 时,都会创建一个新的 conantoolchain_<config>_<arch>.xcconfig 文件,该文件会被汇总到 conantoolchain.xcconfig 中,因此您可以在 Xcode 项目中包含不同的配置。

XcodeToolchain 文件可以根据 Conan 设置值声明以下 Xcode 构建设置

  • *_DEPLOYMENT_TARGET 基于 os + os.version 设置的值,并将使构建系统传递相应的标志(例如,MACOSX_DEPLOYMENT_TARGET 对应 macOS 的 -mmacosx-version-min)及其值(如果已设置)。它定义了二进制文件应运行的最低操作系统版本。

  • CLANG_CXX_LANGUAGE_STANDARD 基于 compiler.cppstd 设置的值,用于设置 C++ 语言标准。

  • CLANG_CXX_LIBRARY 基于 compiler.libcxx 设置的值,用于设置要使用的 C++ 标准库的版本。

使用工具链的一个优点是,它们可以帮助实现与在缓存中创建包时完全相同的构建,以及本地开发流程。

conf

此工具链还会受到以下 [conf] 变量的影响

  • tools.build:cxxflags C++ 标志列表。

  • tools.build:cflags 纯 C 标志列表。

  • tools.build:sharedlinkflags 在创建共享库时将由链接器使用的标志列表。

  • tools.build:exelinkflags 在创建可执行文件时将由链接器使用的标志列表。

  • tools.build:defines 预处理器定义列表。

如果设置了这些变量中的任何一个,工具链将使用它们来生成 conan_global_flags.xcconfig 文件,该文件将被包含在 conan_config.xcconfig 文件中。