构建准备

在上一教程部分中，我们为 Conan 包添加了对 fmt 的需求，以便为我们的“Hello World”C++ 库提供彩色输出。在本节中，我们将重点关注配方中的 generate() 方法。此方法的目的是生成在运行构建步骤时可能需要的所有信息。这意味着例如：

• 编写将在构建步骤中使用的文件，例如注入环境变量的脚本，传递给构建系统的文件等。

• 配置工具链以根据设置和选项提供额外信息，或从 Conan 默认生成的工具链中删除可能不适用于某些情况的信息。

我们将基于上一教程部分的一个简单示例来解释如何使用此方法。我们在配方中添加一个 with_fmt 选项，并根据其值决定是否需要 fmt 库。我们使用 generate() 方法修改工具链，使其将一个变量传递给 CMake，以便我们可以在源代码中条件性地添加该库并使用或不使用 fmt。

请先克隆源代码以重新创建此项目。你可以在 GitHub 上的 examples2 仓库中找到它们。

$ git clone https://github.com/conan-io/examples2.git
$ cd examples2/tutorial/creating_packages/preparing_the_build

你会注意到 conanfile.py 文件与之前的配方相比有一些变化。让我们检查相关部分。

...
from conan.tools.build import check_max_cppstd, check_min_cppstd
...

class helloRecipe(ConanFile):
    name = "hello"
    version = "1.0"

    ...
    options = {"shared": [True, False],
               "fPIC": [True, False],
               "with_fmt": [True, False]}

    default_options = {"shared": False,
                       "fPIC": True,
                       "with_fmt": True}
    ...

    def validate(self):
        if self.options.with_fmt:
            check_min_cppstd(self, "11")
            check_max_cppstd(self, "14")

    def source(self):
        git = Git(self)
        git.clone(url="https://github.com/conan-io/libhello.git", target=".")
        # Please, be aware that using the head of the branch instead of an immutable tag
        # or commit is not a good practice in general
        git.checkout("optional_fmt")

    def requirements(self):
        if self.options.with_fmt:
            self.requires("fmt/8.1.1")

    def generate(self):
        tc = CMakeToolchain(self)
        if self.options.with_fmt:
            tc.variables["WITH_FMT"] = True
        tc.generate()

    ...

如你所见

• 我们声明了一个新的 with_fmt 选项，默认值设置为 True。

• 根据 with_fmt 选项的值

  • 我们条件性地安装 fmt/8.1.1 Conan 包。

  • 我们条件性地要求最低和最高 C++ 标准，因为 fmt 库至少需要 C++11，并且如果我们尝试使用高于 C++14 的标准，它将无法编译（这只是一个示例，fmt 实际上可以使用更现代的标准进行构建）。

  • 我们条件性地将值为 True 的 WITH_FMT 变量注入到 CMakeToolchain 中，以便我们可以在 hello 库的 CMakeLists.txt 中使用它来添加 CMake 的 fmt::fmt 目标。

• 我们克隆了库的另一个分支。optional_fmt 分支包含一些代码更改。让我们看看 CMake 方面有什么变化。

CMakeLists.txt

cmake_minimum_required(VERSION 3.15)
project(hello CXX)

add_library(hello src/hello.cpp)
target_include_directories(hello PUBLIC include)
set_target_properties(hello PROPERTIES PUBLIC_HEADER "include/hello.h")

if (WITH_FMT)
    find_package(fmt)
    target_link_libraries(hello fmt::fmt)
    target_compile_definitions(hello PRIVATE USING_FMT=1)
endif()

install(TARGETS hello)

如你所见，我们使用了注入到 CMakeToolchain 中的 WITH_FMT。根据其值，我们将尝试查找 fmt 库并将其与我们的 hello 库链接。此外，请检查我们是否添加了 USING_FMT=1 编译定义，我们在源代码中根据是否选择添加 fmt 支持来使用它。

hello.cpp

#include <iostream>
#include "hello.h"

#if USING_FMT == 1
#include <fmt/color.h>
#endif

void hello(){
    #if USING_FMT == 1
        #ifdef NDEBUG
        fmt::print(fg(fmt::color::crimson) | fmt::emphasis::bold, "hello/1.0: Hello World Release! (with color!)\n");
        #else
        fmt::print(fg(fmt::color::crimson) | fmt::emphasis::bold, "hello/1.0: Hello World Debug! (with color!)\n");
        #endif
    #else
        #ifdef NDEBUG
        std::cout << "hello/1.0: Hello World Release! (without color)" << std::endl;
        #else
        std::cout << "hello/1.0: Hello World Debug! (without color)" << std::endl;
        #endif
    #endif
}

让我们首先使用 with_fmt=True 从源构建包，然后使用 with_fmt=False。当 test_package 运行时，它将根据选项的值显示不同的消息。

$ conan create . --build=missing -o with_fmt=True
-------- Exporting the recipe ----------
...

-------- Testing the package: Running test() ----------
hello/1.0 (test package): Running test()
hello/1.0 (test package): RUN: ./example
hello/1.0: Hello World Release! (with color!)

$ conan create . --build=missing -o with_fmt=False
-------- Exporting the recipe ----------
...

-------- Testing the package: Running test() ----------
hello/1.0 (test package): Running test()
hello/1.0 (test package): RUN: ./example
hello/1.0: Hello World Release! (without color)

这只是一个简单的示例，展示了如何使用 generate() 方法根据一个选项的值自定义工具链，但你可以在 generate() 方法中做很多其他事情，例如：

• 根据你的需求创建完整的自定义工具链用于构建。

• 访问有关包依赖项的特定信息，例如：

  • 通过 conf_info 进行配置。

  • 依赖项的选项。

  • 使用 copy 工具 从依赖项导入文件。你也可以导入文件来为包创建清单，收集所有依赖项的版本和许可证。

• 使用 Environment tools 为系统环境生成信息。

• 添加除 Release 和 Debug 之外的自定义配置，考虑设置，例如 ReleaseShared 或 DebugShared。

另请参阅

• 使用 generate() 方法从依赖项导入文件。

• generate() 方法参考