CMake 实践与踩坑记录（四）

如何使用外部共享库和头文件

**本篇主要参考文档的第六章（26～30页） **

本节仍然继续折腾Hello World。

上一节我们已经完成了libhello动态库的构建以及安装，本节我们的任务很简单：编写一个程序使用我们上一节构建的共享库。

1、准备工作:

请在cmake目录建立t4目录，本节所有资源将存储在t4目录：

cd cmake
mkdir t4

2、重复以前的步骤，建立src目录，编写源文件main.c，内容如下：

#include <hello.h>
int main()
{
    HelloFunc();
    return 0;
}

编写工程主文件CMakeLists.txt（t4目录下）

PROJECT(NEWHELLO)
ADD_SUBDIRECTORY(src)

编写src/CMakeLists.txt

ADD_EXECUTABLE(main main.c)

上述工作已经严格按照我们前面章节提到的内容完成了，tree一下目录：

３、外部构建

按照习惯，仍然建立build目录，使用cmake ..方式构建。

过程：

cmake ..
make

构建失败，如果需要查看细节，可以使用第一节提到的方法

make VERBOSE=1

来构建

错误输出为是：

/home/wh/cmake/t4/src/main.c:1:19: fatal error: hello.h: 没有那个文件或目录

４、引入头文件搜索路径

hello.h位于/usr/include/hello目录中，并没有位于系统标准的头文件路径，(有人会说了，白痴啊，你就不会include <hello/hello.h>，朋友，要这么干，这一节就没什么可写了，只能选择一个glib或者libX11来写了，这些代码写出来很多朋友是看不懂的)

为了让我们的工程能够找到hello.h头文件，我们需要引入一个新的指令

INCLUDE_DIRECTORIES，其完整语法为：

INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

这条指令可以用来向工程添加多个特定的头文件搜索路径，路径之间用空格分割，如果路径中包含了空格，可以使用双引号将它括起来，默认的行为是追加到当前的头文件搜索路径的后面，你可以通过两种方式来进行控制搜索路径添加的方式：

1. CMAKE_INCLUDE_DIRECTORIES_BEFORE，通过SET这个cmake变量为on，可以将添加的头文件搜索路径放在已有路径的前面。
2. 通过AFTER或者BEFORE参数，也可以控制是追加还是置前。现在我们在src/CMakeLists.txt中添加一个头文件搜索路径，方式很简单，加入：

INCLUDE_DIRECTORIES(/usr/include/hello)

进入build目录，重新进行构建，这是找不到hello.h的错误已经消失，但是出现了一个新的错误：

main.c:(.text+0xa)：对‘HelloFunc’未定义的引用

这是因为我们并没有link到共享库libhello上。

5、为target添加共享库

我们现在需要完成的任务是将目标文件链接到libhello，这里我们需要引入两个新的指令

LINK_DIRECTORIES和TARGET_LINK_LIBRARIES

LINK_DIRECTORIES的全部语法是：

LINK_DIRECTORIES(directory1 directory2 ...)

这个指令非常简单，添加非标准的共享库搜索路径，比如，在工程内部同时存在共享库和可执行二进制，在编译时就需要指定一下这些共享库的路径。这个例子中我们没有用到这个指令。

TARGET_LINK_LIBRARIES的全部语法是:

TARGET_LINK_LIBRARIES(target library1<debug | optimized> library2...)

这个指令可以用来为target添加需要链接的共享库，本例中是一个可执行文件，但是同样可以用于为自己编写的共享库添加共享库链接。
综上所述，为了解决我们前面遇到的HelloFunc未定义错误，我们需要作的是向src/CMakeLists.txt中添加如下指令：

TARGET_LINK_LIBRARIES(main hello)

也可以写成

TARGET_LINK_LIBRARIES(main libhello.so)

这里的hello指的是我们上一节构建的共享库libhello.

然后进入build目录重新进行构建。

cmake ..
make

这是我们就得到了一个连接到libhello的可执行程序main，位于build/src目录：

cd到build/src运行main的结果是输出：

Hello World

让我们来检查一下main的链接情况，输入：

cd ..
ldd src/main

显示的更清楚些：

linux-vdso.so.1 =>  (0x00007fffd5dd7000)
libhello.so.1 => /usr/lib/libhello.so.1 (0x00007f1ee314b000)
libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f1ee2d81000)
/lib64/ld-linux-x86-64.so.2 (0x00007f1ee334d000)

可以清楚的看到main确实链接了共享库libhello，而且链接的是动态库libhello.so.1

注：ldd命令用于打印程序或者库文件所依赖的共享库列表。
语法为：ldd(选项)(参数)
选项：

--version：打印指令版本号；
-v：详细信息模式，打印所有相关信息；
-u：打印未使用的直接依赖；
-d：执行重定位和报告任何丢失的对象；
-r：执行数据对象和函数的重定位，并且报告任何丢失的对象和函数；
--help：显示帮助信息。

参数：文件：指定可执行程序或者文库。

那如何链接到静态库呢？

方法很简单：将TARGET_LINK_LIBRRARIES指令修改为:

TARGET_LINK_LIBRARIES(main libhello.a)

重新构建后再来看一下main的链接情况

ldd src/main 
	linux-vdso.so.1 =>  (0x00007ffddeb36000)
	libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007ff2872d8000)
	/lib64/ld-linux-x86-64.so.2 (0x00007ff2876a2000)

说明，main确实链接到了静态库libhello.a

6、特殊的环境变量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH

务必注意，这两个是环境变量而不是cmake变量。使用方法是要在bash中用export或者在csh中使用set命令设置或者CMAKE_INCLUDE_PATH=/home/include cmake ..等方式。

这两个变量主要是用来解决以前autotools工程中–extra-include-dir等参数的支持的。也就是，如果头文件没有存放在常规路径(/usr/include, /usr/local/include等)，则可以通过这些变量就行弥补。我们以本例中的hello.h为例，它存放在/usr/include/hello目录，所以直接查找肯定是找不到的。前面我们直接使用了绝对路径INCLUDE_DIRECTORIES(/usr/include/hello)告诉工程这个头文件目录。为了将程序更智能一点，我们可以使用CMAKE_INCLUDE_PATH来进行，使用bash的方法如下：

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模块都会受益。

7、小结

本节我们探讨了:

如何通过INCLUDE_DIRECTORIES指令加入非标准的头文件搜索路径。

如何通过LINK_DIRECTORIES指令加入非标准的库文件搜索路径。

如果通过TARGET_LINK_LIBRARIES为库或可执行二进制加入库链接。

并解释了如果链接到静态库。

到这里为止，您应该基本可以使用cmake工作了，但是还有很多高级的话题没有探讨，比如编译条件检查、编译器定义、平台判断、如何跟pkgconfig配合使用等等。

到这里，或许你可以理解前面讲到的“cmake的使用过程其实就是学习cmake语言并编写cmake程序的过程”，既然是“cmake语言”，自然涉及到变量、语法等。

8、尾声

cmake的第一至第六章算是结束了，本系列也算是结束了，这四篇博客也算是对之前学习的一个总结吧！在学中做，在做中学，关于书中剩下的部分，关于cmake的剩下的知识，还是得在实际的工程项目中不断的运用和总结！最后，再总结一个普通的CMakeLists.txt的写法作为结束吧！

cmake_minimum_required(VERSION 3.5)//声明要求的 cmake 最低版本

project(project_name)//声明一个 cmake 工程
 
set(CMAKE_CXX_STANDARD 11)//使用的C++标准（C++11需CMake 3.1或者更高版本）

set( CMAKE_BUILD_TYPE "Debug" )//设置编译模式
 
set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} "/usr/local/share/OpenCV")
find_package(OpenCV 3.2.0 REQUIRED)//添加需要的库

set(SRC 
    ${PROJECT_SOURCE_DIR}/src/main.cpp
    ${PROJECT_SOURCE_DIR}/src/demo.cpp
    ${PROJECT_SOURCE_DIR}/test.cpp
)//设置（添加）源代码
 
set(INC_DIR include)//设置动态链接库的目录
set(LINK_DIR lib)//设置头文件目录
 
include_directories(${INC_DIR})//加入头文件目录
link_directories(${LINK_DIR})//加入头库所在目录
link_libraries(library_name)//库名称
 
add_executable(project_name ${SOURCE_FILES})//添加一个可执行程序，语法：add_executable( 程序名 源代码文件 ）
target_link_libraries(project_name library_name)//将库文件链接到可执行程序上