conan.tools.CppInfo

CppInfo 类表示给定包的基本 C++ 使用信息,例如 includedirslibdirs、库名等。这些信息是包的消费者在能够找到头文件并正确链接库时需要的信息。

package_info() 中的 self.cpp_info 对象是一个 CppInfo 对象,所以在大多数情况下,不需要显式实例化它,按照 package_info() 部分的说明使用它就足够了。

本节介绍 CppInfo 的其他高级用例。

在自定义生成器中聚合信息

警告

此功能是实验性的,可能会发生重大更改。有关更多信息,请参阅 Conan 稳定性 部分。

一些生成器,例如内置的 NMakeDeps,包含与此代码等效的内容,它将所有依赖项的所有信息折叠到一个 CppInfo 对象中,该对象聚合了所有信息。

from conan.tools import CppInfo

...

def generate(self):
    aggregated_cpp_info = CppInfo(self)
    deps = self.dependencies.host.topological_sort
    deps = [dep for dep in reversed(deps.values())]
    for dep in deps:
        # We don't want independent components management, so we collapse
        # the "dep" components into one CppInfo called "dep_cppinfo"
        dep_cppinfo = dep.cpp_info.aggregated_components()
        # Then we merge and aggregate this dependency "dep" into the final result
        aggregated_cpp_info.merge(dep_cppinfo)

    aggregated_cpp_info.includedirs  # All include dirs from all deps, all components
    aggregated_cpp_info.libs  # All library names from all deps, all components
    aggregated_cpp_info.system_libs # All system-libs from all deps
    ....
    # Creates a file with this information that the build system will use

当构建系统无法轻松使用独立的依赖项或组件时,这种聚合可能很有用。例如,NMakeAutotools 提供依赖项信息的机制是通过 LIBSCXXFLAGS 和类似变量。这些变量是全局的,因此传递所有依赖项的所有信息是唯一的选择。

除了在 package_info() 中定义的接口外,公开的文档化接口是:

  • CppInfo(conanfile):构造函数。接收一个 conanfile 作为参数,通常是 self

  • aggregated_components():返回一个新的 CppInfo 对象,该对象是通过聚合所有组件而成的。

  • get_sorted_components():获取包的有序组件,优先处理同一包内依赖项较少的组件。返回一个 OrderedDict,格式为 {component_name: component}

  • merge(other_cppinfo: CppInfo):修改当前的 CppInfo 对象,并使用参数 other_cppinfo 的信息进行更新,允许聚合来自多个依赖项的信息。