PkgConfigDeps¶

PkgConfigDeps 是 pkg-config 的依赖项生成器。生成名为 <PKG-NAME>.pc 的 pkg-config 文件，其中包含有效的 pkg-config 文件语法。

此生成器可在 conanfile 中通过名称使用

conanfile.py¶

class Pkg(ConanFile):
    generators = "PkgConfigDeps"

conanfile.txt¶

[generators]
PkgConfigDeps

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

from conan import ConanFile
from conan.tools.gnu import PkgConfigDeps

class App(ConanFile):
    settings = "os", "arch", "compiler", "build_type"
    requires = "zlib/1.3.1"

    def generate(self):
        pc = PkgConfigDeps(self)
        pc.generate()

生成的文件¶

名为 <PKG-NAME>.pc 的 pkg-config 格式文件，其中包含有效的 pkg-config 文件语法。 prefix 变量会自动调整为 package_folder

prefix=/Users/YOUR_USER/.conan/data/zlib/1.3.1/_/_/package/647afeb69d3b0a2d3d316e80b24d38c714cc6900
libdir=${prefix}/lib
includedir=${prefix}/include
bindir=${prefix}/bin

Name: zlib
Description: Conan package: zlib
Version: 1.2.11
Libs: -L"${libdir}" -lz -F Frameworks
Cflags: -I"${includedir}"

自定义¶

命名¶

默认情况下，*.pc 文件将按照以下规则命名

对于包，它使用包名称，例如，包 zlib/1.3.1 -> zlib.pc。
对于组件，包名称 + 短横线 + 组件名称，例如，openssl/3.0.0 与 self.cpp_info.components["crypto"] -> openssl-crypto.pc。

您可以使用 pkg_config_name 和 pkg_config_aliases 属性更改此默认行为。请参阅下面的属性部分。

如果一个配方使用组件，则生成的文件将是 <[PKG-NAME]-[COMP-NAME]>.pc，并带有相应的标志和依赖关系。

此外，还会生成一个 <PKG-NAME>.pc 文件，以保持与使用开始支持组件的配方的消费者的兼容性。此 <PKG-NAME>.pc 文件将包的所有组件声明为依赖项，而其余字段将为空，依赖于来自组件 <[PKG-NAME]-[COMP-NAME]>.pc 文件的标志的传播。

如果您想禁用生成 <PKG-NAME>.pc 文件，可以将 pkg_config_name 属性设置为 none 字符串值

def package_info(self):
    self.cpp_info.set_property("pkg_config_name", "none")
    self.cpp_info.components["crypto"].set_property("pkg_config_name", "mylib-crypto")

这将仅生成 mylib-foo.pc 文件，而不会生成 mylib.pc 文件。这只能在全局 cpp_info 级别完成，而不能在组件级别完成。

参考¶

class PkgConfigDeps(conanfile)¶

generate()¶: 保存所有 *.pc 文件

set_property(dep, prop, value)¶

使用此方法，您可以覆盖由消费者 Conan 配方设置的属性值。可以对 pkg_config_name、pkg_config_aliases 和 pkg_config_custom_content 属性执行此操作。

参数:

dep – 要设置属性的依赖项的名称。对于组件，请使用以下语法：dep_name::component_name。
prop – 属性的名称。
value – 属性的值。使用 None 来使上游配方设置的任何值失效。

属性¶

build_context_activated¶

当您有一个 build-require 时，默认情况下，不会生成 *.pc 文件。但是，您可以使用 build_context_activated 属性激活它

tool_requires = ["my_tool/0.0.1"]
def generate(self):
    pc = PkgConfigDeps(self)
    # generate the *.pc file for the tool require
    pc.build_context_activated = ["my_tool"]
    pc.generate()

build_context_folder¶

Conan 2.2.0 之后的新功能

当您将同一个包作为 build-require 和作为 常规 require 时，由于 *.pc 文件的文件名以及名称、requires 名称等都会发生冲突，因此会导致生成器发生冲突。

例如，对于某些要求（capnproto、protobuf…），这是一种典型的情况，这些要求包含一个用于在构建时生成源代码的工具（因此是 build_require），但同时也提供一个要链接到最终应用程序的库，因此您也有一个 常规 require。解决此冲突对于交叉构建尤其重要，因为将在构建机器上运行的工具属于与将在主机机器上“运行”的库不同的二进制包。

您可以使用 build_context_folder 属性指定一个文件夹，以保存列在 build_context_activated 中的所有这些构建要求的 *.pc 文件

tool_requires = ["my_tool/0.0.1"]
requires = ["my_tool/0.0.1"]
def generate(self):
    pc = PkgConfigDeps(self)
    # generate the *.pc file for the tool require
    pc.build_context_activated = ["my_tool"]
    # save all the *.pc files coming from the "my_tool" build context and its requirements
    pc.build_context_folder = "build"  # [generators_folder]/build/
    pc.generate()

build_context_suffix¶

已弃用：请改用 build_context_folder 属性

与上述引用的 build_context_folder 属性概念相同，但它的目的是为要求指定后缀，以便构建上下文（工具要求）中的文件/requires/名称将被重命名

tool_requires = ["my_tool/0.0.1"]
requires = ["my_tool/0.0.1"]
def generate(self):
    pc = PkgConfigDeps(self)
    # generate the *.pc file for the tool require
    pc.build_context_activated = ["my_tool"]
    # disambiguate the files, requires, names, etc
    pc.build_context_suffix = {"my_tool": "_BUILD"}
    pc.generate()

重要

不应同时使用此属性与 build_context_folder 属性。

属性¶

以下属性会影响 PkgConfigDeps 生成器

pkg_config_name 属性将定义生成的 *.pc 文件的名称（xxxxx.pc），或字符串 none 以禁用包的全局 *.pc 文件的生成。
pkg_config_aliases 属性设置任何包/组件名称的别名，用于 pkg-config 生成器。此属性仅接受类似列表的 Python 对象。
pkg_config_custom_content 属性会将用户定义的任何内容添加到此生成器创建的 .pc 文件中，作为自由格式的变量。该内容可以是字符串或类似字典的 Python 对象。请注意，此处声明的变量将覆盖 Conan 已经定义的变量。单击此处以获取有关 *.pc 文件中变量类型的更多信息。
system_package_version：属性设置要在为包创建的 *.pc 文件中使用的自定义版本，位于 Version 字段中。
component_version 属性设置要在为该组件创建的 *.pc 文件中使用的自定义版本，位于 Version 字段中（优先于 system_package_version 属性）。

这些属性可以在全局 cpp_info 级别或组件级别定义。

示例

def package_info(self):
    custom_content = {"datadir": "${prefix}/share"}  # or "datadir=${prefix}/share"
    self.cpp_info.set_property("pkg_config_custom_content", custom_content)
    self.cpp_info.set_property("pkg_config_name", "myname")
    self.cpp_info.components["mycomponent"].set_property("pkg_config_name", "componentname")
    self.cpp_info.components["mycomponent"].set_property("pkg_config_aliases", ["alias1", "alias2"])
    self.cpp_info.components["mycomponent"].set_property("component_version", "1.14.12")