CMake find_package语法

最新推荐文章于 2024-04-26 16:31:32 发布

CoomCon

最新推荐文章于 2024-04-26 16:31:32 发布

阅读量480

点赞数

分类专栏：玩转QT 文章标签： linux bash 运维

本文链接：https://blog.csdn.net/CoomCon/article/details/128686956

版权

玩转QT 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

1. find_package常用指令形式

该指令是用来搜索包，并将包头文件、库文件、包目录记录下来；

find_package常用形式为

find_package(<PackageName> [version] [EXACT] [QUIET] [MODULE]
             [REQUIRED] [[COMPONENTS] [components...]]
             [OPTIONAL_COMPONENTS components...]
             [NO_POLICY_SCOPE])

其中

< PackageName > 包名，必填参数。注意大小写。
[version] 指定版本，可选参数。添加该参数后会检查找到的包的版本是否和version兼容。
[EXACT] 版本号必须匹配，可选参数。必须完全匹配的版本而不是兼容版本就可以。
[QUIET] 没找到包也没关系；可选参数。
[REQUIRED] ，没找到包会停止CMake；可选参数，会覆盖掉 [QUIET] 参数，输出查找失败提示语。
[MODULE]：可选字段。CMake有两个包查找模式，指定查找模式为MODULE模式，只在MODULE查找。
[COMPONENTS]，[components]：可选字段，表示查找的包中必须要找到的组件(components），如果有任何一个找不到，CMake停止执行。

2. find_package两种包查找模式

在第一章了解了find_package语法后，下面需要了解一下find_package的内部实现机制，了解find_packge是如何查找包的；
主要有两种包查找模式：MODUEL模式和CONFIG模式。

2.1 MODULE模式

MODULE模式为 命令基础工作模式(Basic Signature)，也是默认工作模式。

2.1.1 Find< PackageName>.cmake文件

Module模式主要依赖于查找到名为Find.cmake的配置文件。在Find.cmake配置文件中会将以下几个CMake变量赋值：

<LibaryName>_FOUND # 是否找到对应包
<LibaryName>_INCLUDE_DIR or <LibaryName>_INCLUDES #将找到的包的头文件保存在变量中
<LibaryName>_LIBRARY or <LibaryName>_LIBRARIES #将找到的包的库文件保存在变量中

2.1.2 Find< PackageName>.cmake是什么

.cmake文件是什么？
.cmake 是给cmake执行用的,可认为是cmake的一种执行脚本
Find< PackageName>.cmake 是什么
cmake执行,用于查找包的脚本；执行完成后会赋值几个变量

<LibaryName>_FOUND # 是否找到对应包
<LibaryName>_INCLUDE_DIR or <LibaryName>_INCLUDES #将找到的包的头文件保存在变量中
<LibaryName>_LIBRARY or <LibaryName>_LIBRARIES #将找到的包的库文件保存在变量中

Find< PackageName>.cmake 哪里来？
1.CMake官方会内置一些常用的Find< PackageName>.cmake文件方便用户使用。
2.别人做好的包一般会提供该文件(反正这个文件不是你作为包的使用者来写出来的)。

cmake官方为我们预定义的Find< PackageName>.cmake，存储在path_to_your_cmake/share/cmake-/Modules目录下。
可以直接使用指令查询CMake内置了哪些模块：
cmake --help-module-list | grep -E ^Find
·
下图是我电脑上存在的一些CMake
这是我的路径D:\Program Files (x86)\cmake\cmake-3.20.1-windows-x86_64\share\cmake-3.20\Modules

2.1.3 查找.cmake文件

前面介绍可知，基本上所有的Find< PackageName>.cmake均会在CMake安装路径下的Modules目录；因此Module模式在find_package肯定会从上述路径查找对应的.cmake文件。除此外我们还可以在CMakeLists.txt中设置CMAKE_MODULE_PATH变量，指定Find< PackageName>.cmake的查找路径。
只需记住find_package只有两个查找路径：CMAKE_MODULE_PATH和CMake安装路径下的Modules目录；
对应CMakeLists.txt变量名为：

CMAKE_MODULE_PATH
CMAKE_ROOT

搜包路径次序依次为：

先在CMAKE_MODULE_PATH变量对应的路径中查找。
如果路径为空，或者路径中查找失败，则在CMake安装目录（即CMAKE_ROOT变量）下查找。

这两个变量可以在CMakeLists.txt文件中打印查看具体内容：

message(STATUS “CMAKE_MODULE_PATH = ${CMAKE_MODULE_PATH}”)
message(STATUS “CMAKE_ROOT = ${CMAKE_ROOT}”)

其中CMAKE_MODULE_PATH默认为空，可以利用set命令赋值。

2.2 CONFIG模式

如果MODULE模式下查找失败，一般情况下会自动转到Config模式进行包搜索；
config模式下，find_package的指令语法也更多：

find_package(<package> [version] [EXACT] [QUIET]
             [REQUIRED] [[COMPONENTS] [components...]]
             [CONFIG|NO_MODULE]
             [NO_POLICY_SCOPE]
             [NAMES name1 [name2 ...]]
             [CONFIGS config1 [config2 ...]]
             [HINTS path1 [path2 ... ]]
             [PATHS path1 [path2 ... ]]
             [PATH_SUFFIXES suffix1 [suffix2 ...]]
             [NO_DEFAULT_PATH]
             [NO_CMAKE_ENVIRONMENT_PATH]
             [NO_CMAKE_PATH]
             [NO_SYSTEM_ENVIRONMENT_PATH]
             [NO_CMAKE_PACKAGE_REGISTRY]
             [NO_CMAKE_BUILDS_PATH] # Deprecated; does nothing.
             [NO_CMAKE_SYSTEM_PATH]
             [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]
             [CMAKE_FIND_ROOT_PATH_BOTH |
              ONLY_CMAKE_FIND_ROOT_PATH |
              NO_CMAKE_FIND_ROOT_PATH])

Config模式是通过另外一种.cmake文件来进行查找依赖库的：
<LibraryName>Config.cmake或者< lower-case-package-name>-config.cmake
这个文件从哪里来?
安装第三方库时，会自动在系统目录生成一份，因此有时没有指定搜索路径时也可以正确引用包
有的包安装时会在cmake/XXXX/目录下生成上述文件，有的会直接将对应文件所在目录添加到环境变量PATH中，这两个都是find_package的搜索路径

2.1.3 查找.cmake文件

具体查找顺序为：
1、名为_DIR的CMake变量或环境变量路径；默认为空，非根目录：
必须要指定到Config.cmake或-config.cmake文件所在目。
2、名为CMAKE_PREFIX_PATH、CMAKE_FRAMEWORK_PATH、CMAKE_APPBUNDLE_PATH的CMake变量或环境变量路径；默认为空，根目录。
3、PATH环境变量路径；根目录；
这个路径的查找规则为：
遍历PATH环境变量中的各路径，如果该路径如果以bin或sbin结尾，则自动回退到上一级目录得到根目录。

根目录的查找规则：
CMake会首先检查根目录路径下是否有名为Config.cmake或-config.cmake的模块文件，如果没有，CMake会继续检查或匹配这些根目录下的以下路径

/(lib/|lib|share)/cmake//
/(lib/|lib|share)//
/(lib/|lib|share)/*/(cmake|CMake)/

其中为系统架构名，如Ubuntu下一般为：/usr/lib/x86_64-linux-gnu，整个(lib/|lib|share)为可选路径，例如OpenCV库而言会检查或匹配