cmake find_package 原理简介以及使用说明

约定不等于承诺〃 2021-11-17 08:48 422阅读 0赞

原文：https://blog.csdn.net/chengde6896383/article/details/86497016

下面简单介绍Cmake 如何使用find\_package命令对外部库进行查找:

cmake本身不提供任何关于搜索库的便捷方法，也不会对库本身的环境变量进行设置。它仅仅是按照优先级顺序在指定的搜索路径进行查找Findxxx.cmake文件和xxxConfig.cmake文件(其中xxx代表库的名字，特别注意的是有大小写之分)，这两个文件大体上是没有区别的，cmake能够找到这两个文件中的任何一个，我们都能成功使用该库，也就是我们可以用库的内置好了Cmake变量。包含了库的头文件和库文件的路径信息，虽然库的作者一般会提供这两个文件，但是也会遇到安装完毕后找不到的情况。当我们在cmake..命令之后，Cmake 会读取执行CMakeLists.txt中的代码，当执行find\_package()这条命令后,Cmake 就会从某些路径中找这Findxxx.cmake文件或者xxxConfig.cmake文件，Cmake找到任意一个之后就会执行这个文件，然后这个文件执行后就会设置好一些Cmake变量。比如下面的变量（NAME表示库的名字 比如可以用Opencv 代表Opencv库）:

<NAME>\_FOUND  
<NAME>\_INCLUDE\_DIRS or <NAME>\_INCLUDES  
<NAME>\_LIBRARIES or <NAME>\_LIBRARIES or <NAME>\_LIBS  
<NAME>\_DEFINITIONS  
一般常用的就是xxx\_FOUND 、xxx\_INCLUDE\_DIRS、xxx\_LIBS，分别代表是否找到库的标志、库的头文件路径、库文件路径。find\_package()有两种模式:Module模式和Config模式，分别对应上面的Findxxx.cmake 和xxxConfig.cmake两个文件。cmake默认优先Module模式，而Config模式是备选项。

Module模式(仅仅查找Findxxx.cmake文件):  
Cmake会优先搜索CMAKE\_MODULE\_PATH指定的路径,如果在CMakeLists.txt中没有设置CMAKE\_MODULE\_PATH为存储Findxxx.cmake的路径，也就是说没有下面的指令：  
set(CMAKE\_MODULE\_PATH "Findxxx.cmake文件所在的路径")  
那么Cmake不会搜索CMAKE\_MODULE\_PATH指定的路径，此时Cmake会搜索第二优先级的路径，也就是<CMAKE\_ROOT>/share/cmake-x.y/Mdodules （注意:x.y表示版本号。我的是3.10）。其中CMAKE\_ROOT是你在安装Cmake的时候的系统路径，因为我并没有指定安装路径，所以是系统默认的路径，在我的系统中(ubuntu16.04)系统的默认路径是/usr/loacl，如果你在安装的过程中使用了  
cmake -DCMAKE\_INSTALL\_PREFIX=自己dir路径 ，那么此时CMAKE\_ROOT就代表那个你写入的路径 。刚刚说道第一优先级的路径搜索没有找到Findxxx.cmake文件，就会到第二优先级的路径下搜索。如果Cmake在两个路径下都没有找到Findxxx.cmake文件。那么Cmake就会进入Config模式。

Config模式（仅仅查找xxxConfig.cmake文件）：  
Cmake会优先搜索xxx\_DIR 指定的路径。如果在CMakeLists.txt中没有设置这个cmake变量。也就是说没有下面的指令:  
set(xxx\_DIR "xxxConfig.cmkae文件所在的路径")  
那么Cmake就不会搜索xxx\_DIR指定的路径，此时Cmake 就会自动到第二优先级的路径下搜索，也就是/usr/local/lib/cmake/xxx/中的xxxConfig.cmake文件。  
上面主要讲了Cmake的搜索模式。如果Cmake在两种模式提供的路径中没有找到对应的Findxxx.cmake和xxxConfig.cmake文件，此时系统就会提示最上面的那些错误信息。

现以but\_velodyne package查找为例:

find\_package(but\_velodyne REQUIRED)  
现在查找到: /usr/local/lib/cmake/but\_velodyne-0.1/but\_velodyne-config.cmake

cat but\_velodyne-config.cmake:

\# Users can set the following variables before calling the module:  
\# ButVELODYNE\_DIR - The preferred installation prefix for searching for ButVELODYNE. Set by the user.  
\#  
\# ButVELODYNE\_ROOT\_DIR - the root directory where the installation can be found  
\# ButVELODYNE\_CXX\_FLAGS - extra flags for compilation  
\# ButVELODYNE\_LINK\_FLAGS - extra flags for linking  
\# ButVELODYNE\_INCLUDE\_DIRS - include directories  
\# ButVELODYNE\_LIBRARY\_DIRS - link directories  
\# ButVELODYNE\_LIBRARIES - libraries to link plugins with  
\# ButVELODYNE\_Boost\_VERSION - the boost version but\_velodyne was compiled with  
   
get\_filename\_component(\_PREFIX "$\{CMAKE\_CURRENT\_LIST\_FILE\}" PATH)  
get\_filename\_component(\_PREFIX "$\{\_PREFIX\}" PATH)  
get\_filename\_component(\_PREFIX "$\{\_PREFIX\}" PATH)  
get\_filename\_component(ButVELODYNE\_ROOT\_DIR "$\{\_PREFIX\}" PATH)  
   
set( ButVELODYNE\_CXX\_FLAGS "-DBUT\_VELODYNE\_DLL  " )  
set( ButVELODYNE\_LINK\_FLAGS "" )  
set( ButVELODYNE\_INCLUDE\_DIRS "$\{ButVELODYNE\_ROOT\_DIR\}/include/but\_velodyne-0.1")  
set( ButVELODYNE\_LIBRARY\_DIRS "$\{ButVELODYNE\_ROOT\_DIR\}/lib")  
set( ButVELODYNE\_LIBRARIES but\_velodyne$\{ButVELODYNE\_LIBRARY\_SUFFIX\})  
   
set( ButVELODYNE\_Boost\_VERSION "1.58")  
   
mark\_as\_advanced(  
  ButVELODYNE\_ROOT\_DIR  
  ButVELODYNE\_CXXFLAGS  
  ButVELODYNE\_CXX\_FLAGS  
  ButVELODYNE\_LINK\_FLAGS  
  ButVELODYNE\_INCLUDE\_DIRS  
  ButVELODYNE\_LIBRARIES  
  ButVELODYNE\_Boost\_VERSION  
)  
如何查看find\_package()的结果:

find\_package(but\_velodyne REQUIRED)  
if (but\_velodyne\_FOUND)  
  MESSAGE (STATUS "@@@@@@dern: $\{ButVELODYNE\_DEFINITIONS\}")  
  MESSAGE (STATUS "@@@@@@dern: $\{ButVELODYNE\_INCLUDE\_DIRS\}")  
  MESSAGE (STATUS "@@@@@@dern: $\{ButVELODYNE\_LIBRARY\_DIRS\}")  
else()  
  MESSAGE (STATUS "@@@@@@dern: but\_velodyne not found")  
endif(but\_velodyne\_FOUND)

OpenCV

安装在opt的文件中会有share文件夹，这里面就有咱们需要的OpenCV文件夹，所以如果要自己有选择的控制版本，则在find\_package这句话前面去设置opencv的ＯpenCV文件夹在哪里，添加set(OpenCV\_DIR /opt/opencv-2.4.11/share/OpenCV)这句话。这个可以根据你install的位置去变化。