XcodeDeps¶

XcodeDeps 工具是用于 Xcode 的依赖信息生成器。它会生成多个 .xcconfig 配置文件，消费者可以使用 xcodebuild 或 Xcode 来使用这些文件。使用它们只需将生成的配置文件添加到 Xcode 项目中，或通过命令行设置 -xcconfig 参数。

XcodeDeps 生成器可以在 conanfiles 中通过名称使用

conanfile.py¶

class Pkg(ConanFile):
    generators = "XcodeDeps"

conanfile.txt¶

[generators]
XcodeDeps

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

conanfile.py¶

from conan import ConanFile
from conan.tools.apple import XcodeDeps

class Pkg(ConanFile):
    settings = "os", "compiler", "arch", "build_type"
    requires = "libpng/1.6.37@" # Note libpng has zlib as transitive dependency

    def generate(self):
        xcode = XcodeDeps(self)
        xcode.generate()

使用 XcodeDeps 生成器时，每次调用 conan install 都会为每个依赖和配置生成几个配置文件。例如，对于上面的 conanfile.py

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

此生成器是多配置的。它会为每个依赖的不同 Debug/Release 配置生成不同的文件。它还会生成一个单独的文件 (conandeps.xcconfig)，该文件聚合了所有直接依赖的配置文件（在此例中仅为 libpng）。上面的命令生成以下文件

.
├── conan_config.xcconfig
├── conan_libpng.xcconfig
├── conan_libpng_libpng.xcconfig
├── conan_libpng_libpng_debug_x86_64.xcconfig
├── conan_libpng_libpng_release_x86_64.xcconfig
├── conan_zlib.xcconfig
├── conan_zlib_zlib.xcconfig
├── conan_zlib_zlib_debug_x86_64.xcconfig
├── conan_zlib_zlib_release_x86_64.xcconfig
└── conandeps.xcconfig

使用默认 Release 和 x86_64 配置的第一次 conan install 命令生成以下文件

conan_libpng_libpng_release_x86_64.xcconfig: 声明带有条件逻辑的变量，这些变量仅在 Xcode 中的活动配置或通过命令行传递给 xcodebuild 的配置下考虑。
conan_libpng_libpng.xcconfig: 包含 conan_libpng_libpng_release_x86_64.xcconfig 并声明以下 Xcode 构建设置：SYSTEM_HEADER_SEARCH_PATHS, GCC_PREPROCESSOR_DEFINITIONS, OTHER_CFLAGS, OTHER_CPLUSPLUSFLAGS, FRAMEWORK_SEARCH_PATHS, LIBRARY_SEARCH_PATHS, OTHER_LDFLAGS。它还包含传递性依赖生成的 xcconfig 文件（在此例中为 conan_zlib_zlib.xcconfig）。
conan_libpng.xcconfig: 在此例中，它只包含 conan_libpng_libpng.xcconfig，但如果所需的包有组件，则此文件将包含该包的所有组件。
图中每个依赖都将生成相同的 3 个文件。在此例中，由于 zlib 是 libpng 的依赖，因此将生成：conan_zlib_zlib_release_x86_64.xcconfig、conan_zlib_zlib.xcconfig 和 conan_zlib.xcconfig。
conandeps.xcconfig: 包含所有直接依赖的配置文件，在此例中，它只包含 conan_libpng.xcconfig。
主文件 conan_config.xcconfig，需要添加到项目中。它包含由此生成器生成的文件以及（如果设置了）由 XcodeToolchain 生成的文件。

第二个 conan install -s build_type=Debug 命令生成以下文件

conan_libpng_libpng_debug_x86_64.xcconfig: 变量与上面针对 Debug 配置的变量相同。
conan_libpng_libpng.xcconfig: 此文件已由前一个命令创建，现在对其进行修改以添加对 conan_libpng_debug_x86_64.xcconfig 的包含。
conan_libpng.xcconfig: 此文件将保持不变。
与上一个命令一样，图中每个依赖都将生成相同的 3 个文件。在此例中，由于 zlib 是 libpng 的依赖，因此将生成：conan_zlib_zlib_debug_x86_64.xcconfig、conan_zlib_zlib.xcconfig 和 conan_zlib.xcconfig。
conandeps.xcconfig: 包含所有直接依赖的配置文件，在此例中，它只包含 conan_libpng.xcconfig。
主文件 conan_config.xcconfig，需要添加到项目中。它包含由此生成器生成的文件以及（如果设置了）由 XcodeToolchain 生成的文件。

如果你想将这些依赖添加到你的 Xcode 项目中，只需为你想要使用的所有配置（通常是 Debug 和 Release）添加 conan_config.xcconfig 配置文件即可。

定义的额外变量¶

除了上面提到的定义 Xcode 构建设置的变量外，还声明了其他一些对你在 Xcode 项目中可能很有用的变量

PACKAGE_ROOT_<package_name>: 设置为 package_folder 属性的位置。

组件支持¶

此生成器支持带组件的包。这意味着

如果一个依赖的 package_info() 在某些组件上声明了 cpp_info.requires，那么生成的 .xcconfig 文件将仅包含对这些组件的包含。
当前包的 requires 将完全依赖于所有组件。请注意，package_info() 仅适用于消费者，而不适用于当前包本身。

自定义配置¶

如果你的 Xcode 项目定义了自定义配置，例如 ReleaseShared 或 MyCustomConfig，则可以在 XcodeDeps 生成器中定义它，以便不同的项目配置可以使用不同的依赖集。假设我们的当前项目可以构建为共享库，使用自定义配置 ReleaseShared，并且包也通过 shared 选项来控制这一点

from conan import ConanFile
from conan.tools.apple import XcodeDeps

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

    def generate(self):
        xcode = XcodeDeps(self)
        # We assume that -o *:shared=True is used to install all shared deps too
        if self.options.shared:
            xcode.configuration = str(self.settings.build_type) + "Shared"
        xcode.generate()

这将为这个自定义配置生成新的 .xcconfig 文件，当你切换到 IDE 中的这个配置时，构建系统将根据我们希望链接共享库还是静态库来获取正确的值。