CMake学习（七）

整理自《CMake实践》

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

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

1，准备工作:
请在/backup/cmake目录建立t4目录，本节所有资源将存储在t4目录。
2，重复以前的步骤，建立src目录，编写源文件main.c，内容如下：

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

编写工程主文件CMakeLists.txt

PROJECT(NEWHELLO)ADD_SUBDIRECTORY(src)

编写src/CMakeLists.txt

ADD_EXECUTABLE(main main.c)

上述工作已经严格按照我们前面季节提到的内容完成了。

３，外部构建
按照习惯，仍然建立build目录，使用cmake ..方式构建。
过程：

cmake ..make

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

错误输出为是：

/backup/cmake/t4/src/main.c:1:19: 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 ...)

这条指令可以用来向工程添加多个特定的头文件搜索路径，路径之间用空格分割，如果路径
中包含了空格，可以使用双引号将它括起来，默认的行为是追加到当前的头文件搜索路径的
后面，你可以通过两种方式来进行控制搜索路径添加的方式：
１，CMAKE_INCLUDE_DIRECTORIES_BEFORE，通过SET这个cmake变量为on，可以
将添加的头文件搜索路径放在已有路径的前面。
２，通过AFTER或者BEFORE参数，也可以控制是追加还是置前。

现在我们在src/CMakeLists.txt中添加一个头文件搜索路径，方式很简单，加入：

INCLUDE_DIRECTORIES(/usr/include/hello)

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

main.c:(.text+0x12): undefined reference to `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目录，运
行main的结果是输出：

Hello World

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

ldd src/mainlinux-gate.so.1 => (0xb7ee7000)libhello.so.1 => /usr/lib/libhello.so.1 (0xb7ece000)libc.so.6 => /lib/libc.so.6 (0xb7d77000)/lib/ld-linux.so.2 (0xb7ee8000)

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

那如何链接到静态库呢？
方法很简单：
将TARGET_LINK_LIBRRARIES指令修改为:

TARGET_LINK_LIBRARIES(main libhello.a)

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

ldd src/mainlinux-gate.so.1 => (0xb7fa8000)libc.so.6 => /lib/libc.so.6 (0xb7e3a000)/lib/ld-linux.so.2 (0xb7fa9000)

说明，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

然后在CMakeLists.txt中将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语言”，自然涉及到变量、语法等.
下一节，我们将抛开程序的话题，看看常用的CMAKE变量以及一些基本的控制语法规则。