cmake 头文件库文件路径搜索 CMAKE_INCLUDE_PATH CMAKE_LIBRARY_PATH

青旅半醒 2021-08-30 02:24 1594阅读 0赞

**目录**

cmake中定义搜索路径

修改环境变量增加搜索路径

FIND 系列指令，通过FIND寻找路径并进行添加

大型开源库路径添加方式

find\_package采用两种模式搜索库

--------------------

路径搜索，这里介绍头文件的路径搜索和库文件的路径搜索。

### cmake中定义搜索路径 ###

cmake中定义头文件的搜索路径：INCLUDE\_DIRECTORIES 命令添加搜索路径  
库文件的搜索路径是：LINK\_DIRECTORIES 命令添加库搜索路径

link\_libraries：（添加需要链接的库文件路径，注意这里是全路径），该用法已经被废弃。  
为最终目标链接库使用： TARGET\_LINK\_LIBRARIES 链接库（动态库和静态库）  
需要链接的库，会根据系统动态库的搜索路径依次进行搜索。这里可以直接写库的名称（程序定义路径，环境变量定义的路径，系统默认搜索路径）

target\_link\_libraries 要在 add\_executable 之后，link\_libraries 要在 add\_executable 之前

### 修改环境变量增加搜索路径 ###

CMAKE\_INCLUDE\_PATH 和CMAKE\_LIBRARY\_PATH

特殊的环境变量`CMAKE_INCLUDE_PATH` 和 `CMAKE_LIBRARY_PATH`务必注意，这两个是环境变量而不是 cmake 变量。  
使用方法是要在 bash 中用 export 或者在 csh 中使用 set 命令设置或者 `CMAKE_INCLUDE_PATH=/home/include cmake ..`等方式。如果头文件没有存放在常规路径(`/usr/include, /usr/local/include`等)， 则可以通过这些变量就行弥补。  
为了将程序更智能一点，我们可以使用 `CMAKE_INCLUDE_PATH` 来进行，使用 bash 的方法 如下:  
`export CMAKE_INCLUDE_PATH=/usr/include/hello`

eg:
    设置export CMAKE_INCLUDE_PATH=/usr/include/hello
    头文件中将 INCLUDE_DIRECTORIES(/usr/include/hello)替换为: 
    FIND_PATH(myHeader hello.h)
    IF(myHeader)
    INCLUDE_DIRECTORIES(${myHeader})
    ENDIF(myHeader)

这里简单说明一下，FIND\_PATH 用来在指定路径中搜索文件名，比如:  
`FIND_PATH(myHeader NAMES hello.h PATHS /usr/include /usr/include/hello)`  
这里我们没有指定路径，但是，cmake 仍然可以帮我们找到 hello.h 存放的路径，就是因为我们设置了环境变量 `CMAKE_INCLUDE_PATH`。  
如果你不使用 `FIND_PATH`，`CMAKE_INCLUDE_PATH` 变量的设置是没有作用的，你不能指望它会直接为编译器命令添加参数`-I<CMAKE_INCLUDE_PATH>`。  
以此为例，`CMAKE_LIBRARY_PATH` 可以用在 `FIND_LIBRARY` 中。  
同样，因为这些变量直接为 FIND\_ 指令所使用，所以所有使用 FIND\_ 指令的 cmake 模块都会受益。

### FIND 系列指令，通过FIND寻找路径并进行添加 ###

FIND\_系列指令主要包含一下指令:

FIND\_FILE(<VAR> name1 path1 path2 ...)

VAR 变量代表找到的文件全路径，包含文件名

FIND\_LIBRARY(<VAR> name1 path1 path2 ...)

VAR 变量表示找到的库全路径，包含库文件名  
FIND\_LIBRARY 示例:

FIND_LIBRARY(libX X11 /usr/lib) 
    IF(NOT libX)
    MESSAGE(FATAL_ERROR “libX not found”) 
    ENDIF(NOT libX)

FIND\_PATH(<VAR> name1 path1 path2 ...)

VAR 变量代表包含这个文件的路径。

FIND\_PROGRAM(<VAR> name1 path1 path2 ...)

VAR 变量代表包含这个程序的全路径。

FIND\_PACKAGE

FIND_PACKAGE(<name> [major.minor]
            [QUIET] [NO_MODULE] 
            [[REQUIRED|COMPONENTS] [componets...]] )

FIND\_PACKAGE 其实是系统与定义的cmake模块。对于系统预定义的 Find<name>.cmake 模块，使用方法一般如上例所示: 每一个模块都会定义以下几个变量

*  <name>\_FOUND
 *  <name>\_INCLUDE\_DIR or <name>\_INCLUDES
 *  <name>\_LIBRARY or <name>\_LIBRARIES

你可以通过<name>\_FOUND 来判断模块是否被找到，如果没有找到，按照工程的需要关闭 某些特性、给出提醒或者中止编译，上面的例子就是报出致命错误并终止构建。  
如果<name>\_FOUND 为真，则将<name>\_INCLUDE\_DIR 加入 INCLUDE\_DIRECTORIES， 将<name>\_LIBRARY 加入 TARGET\_LINK\_LIBRARIES 中。  
举个例子：

FIND_PACKAGE(CURL)
    IF(CURL_FOUND)
       INCLUDE_DIRECTORIES(${CURL_INCLUDE_DIR})
       TARGET_LINK_LIBRARIES(curltest ${CURL_LIBRARY})
    ELSE(CURL_FOUND)
         MESSAGE(FATAL_ERROR ”CURL library not found”)
    ENDIF(CURL_FOUND)

> FIND\_PACKAGE 其实内部主要还是通过FIND\_PATH，FIND\_LIBRARY等基础命令实现的。

### 大型开源库路径添加方式 ###

如果是简单的引入，可以直接通过指令INCLUDE\_DIRECTORIES，LINK\_DIRECTORIES或者CMAKE\_INCLUDE\_PATH和CMAKE\_LIBRARY\_PATH进行设置。但是该方式存在缺点

*  需要把路径固定，不宜迁移，修改麻烦
 *  如果存在大量的路径的话，需要一次添加所有的路径比较复杂

因此可以通过FIND 进行查找路径，通过FIND\_PACKAGE 获得所有的头文件和库文件路径。  
比如对于OpenCV，这样的方式将会十分方便。这里介绍几种常用的方式：

1.  方式一：FIND\_PACKAGE  
    通过FIND\_PACKAGE的方式。

#添加OPENCV库
    #指定OpenCV版本，代码如下
    #find_package(OpenCV 3.3 REQUIRED)
    #如果不需要指定OpenCV版本，代码如下
    find_package(OpenCV REQUIRED)
    
    #添加OpenCV头文件
    include_directories(${OpenCV_INCLUDE_DIRS})
    
    # 添加一个可执行程序
    # 语法：add_executable( 程序名 源代码文件 ）
    add_executable( main main.cpp )
    
    # 将库文件链接到可执行程序上
    target_link_libraries( main ${OpenCV_LIBS})

> 要求opencv安装在系统默认目录下。

1.  方式二：cmake 关PKG-CONFIG的指令方式  
    其实和方式二一样，但是实现的方式上有出入。通过opencv自带的pkg-config 提供的opencv.pc文件。

# 编译该工程CMAKE最低版本
    CMAKE_MINIMUM_REQUIRED(VERSION 3.2 FATAL_ERROR)
    # 工程名字
    PROJECT(MAIN)
    
    #通过pkg-config管理的三方库
    # 非root下需要自己加入PKG_CONFIG_PATH，不然报错!!!
    SET(ENV{PKG_CONFIG_PATH} /home/topeet/programfile/opencv2/lib/pkgconfig)
    #PkgConfig名字是固定的，代表准备加入pkg-config模块，即查找/usr/bin/pkg-config
    FIND_PACKAGE(PkgConfig REQUIRED) 
    #通过执行pkg-config程序，并指定我需要的模块是opencv,注意opencv名字固定，是源于安装OpenCV生成的opencv.pc，PKG_OPENCV是前缀(观察下面)，
    PKG_SEARCH_MODULE(PKG_OPENCV REQUIRED opencv)   
    
    # 添加三方opencv的头文件路径-- -I/home/topeet/programfile/opencv2/include/opencv -I/home/topeet/programfile/opencv2/include
    INCLUDE_DIRECTORIES(${PKG_OPENCV_INCLUDE_DIRS})
    
    # 指定生成目标
    ADD_EXECUTABLE(main main.cpp)
    # 为指定的bin文件添加三方链接库
    TARGET_LINK_LIBRARIES(main detect ${PKG_OPENCV_LDFLAGS})

### find\_package采用两种模式搜索库 ###

Module模式：搜索CMAKE\_MODULE\_PATH指定路径下的FindXXX.cmake文件，执行该文件从而找到XXX库。其中，具体查找库并给XXX\_INCLUDE\_DIRS和XXX\_LIBRARIES两个变量赋值的操作由FindXXX.cmake模块完成。

Module 搜素路径：

*  CMAKE\_MODULE\_PATH指定的路径
 *  <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就代表那个你写入的路径 。（$CMAKE\_ROOT的具体值可以通过CMake中message命令输出）。这称为模块模式。

Config模式：搜索XXX\_DIR指定路径下的XXXConfig.cmake文件，执行该文件从而找到XXX库。其中具体查找库并给XXX\_INCLUDE\_DIRS和XXX\_LIBRARIES两个变量赋值的操作由XXXConfig.cmake模块完成。

Config 搜索路径：

*  搜索xxx\_DIR 指定的路径。如果在CMakeLists.txt中没有设置这个cmake变量。也就是说没有下面的指令: `set(xxx_DIR "xxxConfig.cmkae文件所在的路径")`那么Cmake就不会搜索xxx\_DIR指定的路径
 *  Cmake 会在/usr/local/lib/cmake/xxx/ /usr/local/share/xxx 中的xxxConfig.cmake文件。这个路径不同的操作系统存在差异。

两种模式看起来似乎差不多，不过cmake默认采取Module模式，如果Module模式未找到库，才会采取Config模式。若果在Module的搜索路径中没有找到对应的cmake file，则使用config模式。总之，Config模式是一个备选策略。通常，库安装时会拷贝一份XXXConfig.cmake到系统目录中，因此在没有显式指定搜索路径时也可以顺利找到。

在我遇到的问题中，由于Caffe安装时没有安装到系统目录，因此无法自动找到CaffeConfig.cmake，我在CMakeLists.txt最前面添加了一句话之后就可以了。

set(Caffe_DIR /home/wjg/projects/caffe/build)#添加CaffeConfig.cmake的搜索路径find_package(Caffe REQUIRED)
    if(NOT Caffe_FOUND)
      message(FATAL_ERROR"Caffe Not Found!")
    endif(NOT Caffe_FOUND)
    include_directories(${Caffe_INCLUDE_DIRS})
    add_executable(useSSD ssd_detect.cpp)
    target_link_libraries(useSSD${Caffe_LIBRARIES})