准备构建

在上一节教程中，我们向我们的 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 可以使用更现代的标准构建）

    • 我们将 WITH_FMT 变量的值 True 注入到 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。

    • 访问依赖项选项。

    • 使用 复制工具 从依赖项导入文件。您还可以导入文件创建包清单，收集所有依赖项版本和许可证。

  • 使用 环境工具 为系统环境生成信息。

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

另请参阅