Cmake 学习实践 总结教程 - 第二小节 更好的HELLO WORLD

Cmake 学习实践 总结教程 - 第二小节 更好的HELLO WORLD

本小节的任务是让前面的 Hello World 更像一个工程，我们需要作的是：

1，为工程添加一个子目录 src，用来放置工程源代码;

2，添加一个子目录 doc，用来放置这个工程的文档 hello.txt

3，在工程目录添加文本文件 COPYRIGHT, README；

4，在工程目录添加一个 runhello.sh 脚本，用来调用 hello 二进制

4，将构建后的目标文件放入构建目录的 bin 子目录；

5，最终安装这些文件：将 hello 二进制与 runhello.sh 安装至/usr/bin，将 doc 目录

的内容以及 COPYRIGHT/README 安装到/usr/share/doc/cmake/t2

ADD_SUBDIRECTORY 指令

ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

这个指令用于向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存

放的位置。EXCLUDE_FROM_ALL 参数的含义是将这个目录从编译过程中排除，比如，工程

的 example，可能就需要工程构建完成后，再进入 example 目录单独进行构建(当然，你

也可以通过定义依赖来解决此类问题)。

上面的例子定义了将 src 子目录加入工程，并指定编译输出(包含编译中间结果)路径为

bin 目录。如果不进行 bin 目录的指定，那么编译结果(包括中间结果)都将存放在

build/src 目录(这个目录跟原有的 src 目录对应)，指定 bin 目录后，相当于在编译时

将 src 重命名为 bin，所有的中间结果和目标二进制都将存放在 bin 目录。

这里需要提一下的是 SUBDIRS 指令，使用方法是：

SUBDIRS(dir1 dir2…)，但是这个指令已经不推荐使用。它可以一次添加多个子目录，

并且，即使外部编译，子目录体系仍然会被保存。

如果我们在上面的例子中将 ADD_SUBDIRECTORY (src bin)修改为 SUBDIRS(src)。

那么在 build 目录中将出现一个 src 目录，生成的目标代码 hello 将存放在 src 目录中。

3，换个地方保存目标二进制

不论是 SUBDIRS 还是 ADD_SUBDIRECTORY 指令(不论是否指定编译输出目录)，我们都可

以通过 SET 指令重新定义 EXECUTABLE_OUTPUT_PATH 和 LIBRARY_OUTPUT_PATH 变量

来指定最终的目标二进制的位置(指最终生成的 hello 或者最终的共享库，不包含编译生成

的中间文件)

SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin) 

SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib) 

在第一节我们提到了_BINARY_DIR 和 PROJECT_BINARY_DIR 变量，他

们指的编译发生的当前目录，如果是内部编译，就相当于 PROJECT_SOURCE_DIR 也就是

工程代码所在目录，如果是外部编译，指的是外部编译所在目录，也就是本例中的 build

目录。

在哪里 ADD_EXECUTABLE 或 ADD_LIBRARY， 如果需要改变目标存放路径，就在哪里加入上述的定义

如何安装。

安装的需要有两种，一种是从代码编译后直接 make install 安装，一种是打包时的指定目录安装。

所以，即使最简单的手工编写的 Makefile，看起来也是这个样子的：

DESTDIR= 

install: 

mkdir -p $(DESTDIR)/usr/bin 

install -m 755 hello $(DESTDIR)/usr/bin 

你可以通过:

make install 

将 hello 直接安装到/usr/bin 目录，也可以通过 make install DESTDIR=/tmp/test 将他安装在 /tmp/test/usr/bin 目录，打包时这个方式经常被使用。

稍微复杂一点的是还需要定义 PREFIX，一般 autotools 工程，会运行这样的指令: ./configure –prefix=/usr 或者./configure --prefix=/usr/local 来指定 PREFIX

比如上面的 Makefile 就可以改写成:

DESTDIR= 

PREFIX=/usr 

install: 

mkdir -p $(DESTDIR)/$(PREFIX)/bin 

install -m 755 hello $(DESTDIR)/$(PREFIX)/bin

那么我们的 HelloWorld 应该怎么进行安装呢？

这里需要引入一个新的 cmake 指令 INSTALL 和一个非常有用的变量 CMAKE_INSTALL_PREFIX。

CMAKE_INSTALL_PREFIX 变量类似于 configure 脚本的 –prefix，常见的使用方法看

起来是这个样子： cmake -DCMAKE_INSTALL_PREFIX=/usr .

INSTALL 指令用于定义安装规则，安装的内容可以包括目标二进制、动态库、静态库以及 文件、目录、脚本等。

INSTALL 指令包含了各种安装类型，我们需要一个个分开解释：

目标文件的安装：

 INSTALL(TARGETS targets...  [[ARCHIVE|LIBRARY|RUNTIME]  [DESTINATION <dir>]  [PERMISSIONS rmissions...]  [CONFIGURATIONS  [Debug|Release|...]]  [COMPONENT <component>]  [OPTIONAL]  ] [...]) 

参数中的 TARGETS 后面跟的就是我们通过 ADD_EXECUTABLE 或者 ADD_LIBRARY 定义的 目标文件，可能是可执行二进制、动态库、静态库。

目标类型也就相对应的有三种，ARCHIVE 特指静态库，LIBRARY 特指动态库，RUNTIME 特指可执行目标二进制。DESTINATION 定义了安装的路径，如果路径以/开头，那么指的是绝对路径，这时候 CMAKE_INSTALL_PREFIX 其实就无效了。如果你希望使用 CMAKE_INSTALL_PREFIX 来 定义安装路径，就要写成相对路径，即不要以/开头，那么安装后的路径就是 ${CMAKE_INSTALL_PREFIX}/<DESTINATION 定义的路径>

举个简单的例子：

INSTALL(TARGETS myrun mylib mystaticlib

RUNTIME DESTINATION bin

LIBRARY DESTINATION lib

ARCHIVE DESTINATION libstatic

)

普通文件的安装：

INSTALL(FILES files... DESTINATION <dir>
 [PERMISSIONS permissions...]
 [CONFIGURATIONS [Debug|Release|...]]
 [COMPONENT <component>]
 [RENAME <name>] [OPTIONAL])