FindPkgConfig¶
CMake 的 pkg-config
模块。
查找 pkg-config
可执行文件,并添加 pkg_get_variable()
、 pkg_check_modules()
和 pkg_search_module()
命令。以下变量也会被设置
PKG_CONFIG_FOUND
如果找到 pkg-config 可执行文件,则为 True。
PKG_CONFIG_VERSION_STRING
在版本 2.8.8 中添加。
找到的 pkg-config 的版本。
PKG_CONFIG_EXECUTABLE
pkg-config 程序的路径名。
PKG_CONFIG_ARGN
在版本 3.22 中添加。
传递给 pkg-config 的参数列表。
PKG_CONFIG_EXECUTABLE
和 PKG_CONFIG_ARGN
都由模块初始化,但可以被用户覆盖。请参阅 影响行为的变量,了解这些变量是如何初始化的。
- pkg_check_modules¶
检查所有给定的模块,并在调用作用域中设置各种结果变量。
pkg_check_modules(<prefix> [REQUIRED] [QUIET] [NO_CMAKE_PATH] [NO_CMAKE_ENVIRONMENT_PATH] [IMPORTED_TARGET [GLOBAL]] <moduleSpec> [<moduleSpec>...])
当给定
REQUIRED
参数时,如果找不到模块,命令将失败并报错。当给定
QUIET
参数时,将不会打印任何状态消息。在版本 3.3 中添加:
CMAKE_PREFIX_PATH
、CMAKE_FRAMEWORK_PATH
和CMAKE_APPBUNDLE_PATH
缓存和环境变量将被添加到pkg-config
搜索路径。NO_CMAKE_PATH
和NO_CMAKE_ENVIRONMENT_PATH
参数分别禁用缓存变量和环境变量的此行为。PKG_CONFIG_USE_CMAKE_PREFIX_PATH
变量设置为FALSE
将全局禁用此行为。在版本 3.7 中添加:
IMPORTED_TARGET
参数将创建一个名为PkgConfig::<prefix>
的导入目标,可以直接作为参数传递给target_link_libraries()
。在版本 3.13 中添加:
GLOBAL
参数将使导入的目标在全局作用域中可用。在版本 3.15 中添加:
pkg-config
报告的非库链接器选项存储在INTERFACE_LINK_OPTIONS
目标属性中。在版本 3.18 中更改: 用
-isystem
指定的包含目录存储在INTERFACE_INCLUDE_DIRECTORIES
目标属性中。CMake 的早期版本将它们留在INTERFACE_COMPILE_OPTIONS
属性中。每个
<moduleSpec>
可以是裸模块名称,也可以是带有版本约束的模块名称(支持运算符=
、<
、>
、<=
和>=
)。以下是名为foo
的模块的各种约束示例foo
匹配任何版本。foo<2
仅匹配 2 之前的版本。foo>=3.1
匹配 3.1 或更高版本。foo=1.2.3
要求 foo 必须完全是 1.2.3 版本。
以下变量可能会在返回时设置。存在两组值:一组用于常见情况(
<XXX> = <prefix>
),另一组用于pkg-config
在使用--static
选项调用时提供的信息(<XXX> = <prefix>_STATIC
)。<XXX>_FOUND
如果模块存在,则设置为 1
<XXX>_LIBRARIES
仅库(不带 '-l')
<XXX>_LINK_LIBRARIES
库及其绝对路径
<XXX>_LIBRARY_DIRS
库的路径(不带 '-L')
<XXX>_LDFLAGS
所有必需的链接器标志
<XXX>_LDFLAGS_OTHER
所有其他链接器标志
<XXX>_INCLUDE_DIRS
'-I' 预处理器标志(不带 '-I')
<XXX>_CFLAGS
所有必需的 cflags
<XXX>_CFLAGS_OTHER
其他编译器标志
除了
<XXX>_FOUND
之外,所有变量都可能是 ;-list,如果从pkg-config
返回的关联变量具有多个值。在版本 3.18 中更改: 用
-isystem
指定的包含目录存储在<XXX>_INCLUDE_DIRS
变量中。CMake 的早期版本将它们留在<XXX>_CFLAGS_OTHER
中。有一些特殊变量,它们的前缀取决于给定的
<moduleSpec>
的数量。当只有一个<moduleSpec>
时,<YYY>
将仅仅是<prefix>
,但如果给出两个或更多<moduleSpec>
项,<YYY>
将是<prefix>_<moduleName>
。<YYY>_VERSION
模块的版本
<YYY>_PREFIX
模块的前缀目录
<YYY>_INCLUDEDIR
模块的包含目录
<YYY>_LIBDIR
模块的库目录
在版本 3.8 中更改: 对于任何给定的
<prefix>
,可以使用不同的参数多次调用pkg_check_modules()
。CMake 的早期版本缓存并返回了第一个成功的结果。在版本 3.16 中更改: 如果无法确定找到的库的完整路径,但它仍然对链接器可见,则将其作为
-l<name>
传递。CMake 的早期版本在这种情况下会失败。示例
pkg_check_modules (GLIB2 glib-2.0)
查找任何版本的 glib2。如果找到,输出变量
GLIB2_VERSION
将保存找到的实际版本。pkg_check_modules (GLIB2 glib-2.0>=2.10)
查找至少 2.10 版本的 glib2。如果找到,输出变量
GLIB2_VERSION
将保存找到的实际版本。pkg_check_modules (FOO glib-2.0>=2.10 gtk+-2.0)
查找 glib2-2.0(至少 2.10 版本)和任何版本的 gtk2+-2.0。只有当两者都找到时,
FOO
才被视为找到。FOO_glib-2.0_VERSION
和FOO_gtk+-2.0_VERSION
变量将被设置为它们各自找到的模块版本。pkg_check_modules (XRENDER REQUIRED xrender)
需要任何版本的
xrender
。成功调用设置的示例输出变量XRENDER_LIBRARIES=Xrender;X11 XRENDER_STATIC_LIBRARIES=Xrender;X11;pthread;Xau;Xdmcp
- pkg_search_module¶
此命令的行为与
pkg_check_modules()
相同,不同之处在于它只搜索第一个成功匹配的模块,而不是检查所有指定的模块。pkg_search_module(<prefix> [REQUIRED] [QUIET] [NO_CMAKE_PATH] [NO_CMAKE_ENVIRONMENT_PATH] [IMPORTED_TARGET [GLOBAL]] <moduleSpec> [<moduleSpec>...])
在版本 3.16 中添加: 如果找到模块,
<prefix>_MODULE_NAME
变量将包含匹配模块的名称。如果需要运行pkg_get_variable()
,则可以使用此变量。示例
pkg_search_module (BAR libxml-2.0 libxml2 libxml>=2)
- pkg_get_variable¶
在版本 3.4 中添加。
检索 pkg-config 变量
varName
的值,并将其存储在调用作用域中的结果变量resultVar
中。pkg_get_variable(<resultVar> <moduleName> <varName> [DEFINE_VARIABLES <key>=<value>...])
如果
pkg-config
为指定的变量返回多个值,则resultVar
将包含一个 ;-list。选项
DEFINE_VARIABLES <key>=<value>...
在版本 3.28 中添加。
指定键值对以重新定义影响使用
pkg-config
检索的变量的变量。
例如
pkg_get_variable(GI_GIRDIR gobject-introspection-1.0 girdir)
影响行为的变量¶
- PKG_CONFIG_EXECUTABLE¶
此缓存变量可以设置为 pkg-config 可执行文件的路径。
find_program()
由模块在内部调用,并使用此变量。在版本 3.1 中添加: 如果尚未设置
PKG_CONFIG_EXECUTABLE
,则可以使用PKG_CONFIG
环境变量作为提示。在版本 3.22 中更改: 如果设置了
PKG_CONFIG
环境变量,则在使用它作为提示时,仅从中获取第一个参数。
- PKG_CONFIG_ARGN¶
在版本 3.22 中添加。
此缓存变量可以设置为需要时额外传递给 pkg-config 的参数列表。如果未提供,它将从
PKG_CONFIG
环境变量初始化(如果已设置)。该环境变量中的第一个参数被假定为 pkg-config 程序,而其后的所有剩余参数都用于初始化PKG_CONFIG_ARGN
。如果没有定义此类环境变量,则PKG_CONFIG_ARGN
将初始化为空字符串。模块一旦在缓存中设置了变量,就不会更新它。
- PKG_CONFIG_USE_CMAKE_PREFIX_PATH¶
在版本 3.1 中添加。
指定
pkg_check_modules()
和pkg_search_module()
是否应将CMAKE_PREFIX_PATH
、CMAKE_FRAMEWORK_PATH
和CMAKE_APPBUNDLE_PATH
缓存和环境变量中的路径添加到pkg-config
搜索路径。如果未设置此变量,并且
CMAKE_MINIMUM_REQUIRED_VERSION
为 3.1 或更高版本,则默认启用此行为,否则禁用。