CMake 与 pkg-config 编写和集成 .pc 文件

在软件开发中，管理库的编译和链接信息是一项重要任务。pkg-config 是一个常用的工具，用于提供库的元数据信息，而 .pc 文件则是其核心组成部分。本文介绍如何编写 .pc 文件，并在 CMake 项目中集成这些文件，以便轻松管理依赖关系。

什么是 pkg-config 和 .pc 文件？

pkg-config 是一个用于管理库的编译和链接参数的工具。它通过读取 .pc 文件（Package Config 文件）来获取库的元数据信息，如包含目录、库路径、依赖关系等。这样，开发者无需手动管理这些复杂的编译选项，简化了构建过程。

编写 .pc 文件
基础结构
一个标准的 .pc 文件通常包含以下几个部分：

变量定义：用于简化路径管理。
基本信息：库的名称、描述和版本。
编译和链接标志：指示如何包含和链接库。
依赖关系：列出库所依赖的其他库。
示例 .pc 文件
假设我们有一个名为 libfoo 的库，位于 /usr/local/include 和 /usr/local/lib，版本为 1.0.0，且依赖zib和yaml-cpp。下面是一个完整的 libfoo.pc 文件示例：

prefix=/usr/local
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include

Name: libfoo
Description: A simple example library
Version: 1.0.0
Requires: zib yaml-cpp
Cflags: -I${includedir}
Libs: -L${libdir} -lfoo

字段解释：
prefix：库的安装根目录。
exec_prefix：可执行文件的安装路径，通常与 prefix 相同。
libdir：库文件所在的目录。
includedir：头文件所在的目录。
Name：库的名称，用于识别。
Description：库的简要描述。
Version：库的版本号。
Requires：字段用于指定当前包依赖的其他包。它列出了在编译和链接当前包时所需的其他库。每个依赖项之间用空格分隔。
在使用foo这个库的同时会去查找zlib.pc 跟 yaml-cpp.pc，并把他们的依赖库写到LIBFOO_LIBRARIES这个变量，必须确保这两个库安装
Cflags：编译时需要的标志，通常是头文件路径。
Libs：链接时需要的标志，包含库路径和库名。
安装 .pc 文件
为了让 pkg-config 能够找到 .pc 文件，需要将其安装到 pkg-config 搜索的目录中，通常是 /usr/local/lib/pkgconfig/ 或 /usr/lib/pkgconfig/。可以通过以下步骤安装：

创建目录（如果尚未存在）：

sudo mkdir -p /usr/local/lib/pkgconfig

复制 .pc 文件到该目录：

sudo cp libfoo.pc /usr/local/lib/pkgconfig/

更新 PKG_CONFIG_PATH（如果使用自定义路径）：

export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:$PKG_CONFIG_PATH

在 CMake 中使用 pkg-config
CMake 提供了与 pkg-config 集成的机制，使得在构建项目时可以自动获取库的编译和链接信息。

启用 PkgConfig 模块
首先，需要在 CMakeLists.txt 中启用 PkgConfig 模块：

find_package(PkgConfig REQUIRED)

查找库并生成变量
使用 pkg_check_modules() 宏查找库，并生成相关变量。假设我们要查找 libfoo 库，并使用前缀 LIBFOO：

pkg_check_modules(LIBFOO REQUIRED libfoo)

生成的变量

pkg_check_modules() 会根据指定的前缀生成一系列变量：
LIBFOO_INCLUDE_DIRS：包含头文件的目录路径。
LIBFOO_LIBRARIES：链接库的路径和库名。
LIBFOO_CFLAGS：编译时的标志（如 -I 路径）。
LIBFOO_LDFLAGS：链接时的标志（如 -L 路径和 -l 库名）。
LIBFOO_VERSION：库的版本号。
LIBFOO_FOUND：表示库是否成功找到（TRUE 或 FALSE）。

LIBFOO_LIBRARIES因为Requires: zib yaml-cpp， LIBFOO_LIBRARIES这个变量会自动包括这两个库的链接信息
在cmake中进行打印:

message(STATUS "LIBFOO_LIBRARIES: ${LIBFOO_LIBRARIES}")

zlib跟yaml-cpp不依赖其他库，输出结果为：

LIBFOO_LIBRARIES: foo;zlib;yaml-cpp;

如果zlib;yaml-cpp;还有其他依赖，也都能打印出来

链接库到目标
将查找到的库信息应用到目标（如可执行文件或库）中：

添加头文件路径

target_include_directories(my_program PRIVATE ${LIBFOO_INCLUDE_DIRS})

链接库

target_link_libraries(my_program PRIVATE ${LIBFOO_LIBRARIES})

示例项目
以下是一个完整的 CMakeLists.txt 示例，展示如何集成 libfoo 库：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 启用 pkg-config
find_package(PkgConfig REQUIRED)

# 查找 libfoo 库
pkg_check_modules(LIBFOO REQUIRED libfoo)

# 创建可执行文件
add_executable(my_program main.cpp)

# 添加 libfoo 的头文件路径
target_include_directories(my_program PRIVATE ${LIBFOO_INCLUDE_DIRS})

# 链接 libfoo 库
target_link_libraries(my_program PRIVATE ${LIBFOO_LIBRARIES})

main.cpp 示例

#include <foo.h>  // 假设 libfoo 提供 foo.h

int main() {
    foo_function();  // 使用 libfoo 的函数
    return 0;
}

处理多个依赖和条件链接
如果项目依赖多个库，可以多次调用 pkg_check_modules()，为每个库指定不同的前缀。例如，假设项目同时依赖 libfoo 和 libbar：

# 查找 libfoo 和 libbar 库
pkg_check_modules(LIBFOO REQUIRED libfoo)
pkg_check_modules(LIBBAR REQUIRED libbar)

# 创建可执行文件
add_executable(my_program main.cpp)

# 添加头文件路径
target_include_directories(my_program PRIVATE
    ${LIBFOO_INCLUDE_DIRS}
    ${LIBBAR_INCLUDE_DIRS}
)

# 链接库
target_link_libraries(my_program PRIVATE
    ${LIBFOO_LIBRARIES}
    ${LIBBAR_LIBRARIES}
)

条件检查库是否存在
有时，某些库可能是可选的。可以在 CMake 中进行条件检查：

# 查找 libfoo 库，但不是必须的
pkg_check_modules(LIBFOO libfoo)

if(LIBFOO_FOUND)
    target_include_directories(my_program PRIVATE ${LIBFOO_INCLUDE_DIRS})
    target_link_libraries(my_program PRIVATE ${LIBFOO_LIBRARIES})
else()
    message(WARNING "libfoo not found! Some features will be disabled.")
endif()

总结

通过编写 .pc 文件并在 CMake 项目中集成 pkg-config，开发者可以简化库的管理和依赖处理。以下是关键步骤的总结：

编写 .pc 文件：定义库的路径、名称、版本、编译和链接标志。
安装 .pc 文件：将 .pc 文件放置在 pkg-config 可以搜索到的目录中。
在 CMake 中集成：
启用 PkgConfig 模块。
使用 pkg_check_modules() 查找库并生成变量。
将生成的变量应用到目标的编译和链接设置中。
处理多个依赖和条件链接：通过多次调用 pkg_check_modules() 和条件判断，实现灵活的依赖管理。