CMake实践（二）

让 HelloWorld 看起来更像一个工程

让前面的 Hello World 更像一个工程,我们需要做的是:

1. 添加一个子目录src，放置工程源代码
2. 添加一个子目录doc，放置这个工程的文档 hello.txt
3. 在工程目录添加一个COPYRIGHT，README
4. 工程目录添加一个runhello.sh脚本，用来调用 hello 二进制
5. 将构建后的目标文件放入构建目录的bin子目录
6. 安装这些文件: 将 hello 二进制与 runhello.sh 安装至/usr/bin，将 doc 目录的内容以及 COPYRIGHT/README 安装到/usr/share/doc/cmake/t2

1,准备工作:

在/backup/cmake/目录下建立 t2 目录

mkdir t2

将 t1 工程的 main.c 和 CMakeLists.txt 拷贝到 t2 目录中

cd t2
cp -r ~/backup/cmake/t1/CMakeLists.txt ~/backup/cmake/t1/main.c .

2,添加子目录 src:

mkdir src
mv main.c src

现在的工程看起来是这个样子:
一个子目录 src,一个 CMakeLists.txt。

要为任何子目录建立一个 CMakeLists.txt :
进入子目录 src,编写 CMakeLists.txt 如下:

ADD_EXECUTABLE(hello main.c)

将 t2 工程的 CMakeLists.txt 修改为:

PROJECT(HELLO)
ADD_SUBDIRECTORY(src bin)

然后建立 build 目录,进入 build 目录进行外部编译

mkdir build
cd build
cmake ..
make

构建完成后，生成的目标文件 hello 位于 build/bin 目录中

语法解释:

ADD_SUBDIRECTORY 指令

ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

用于向当前工程添加存放源文件的子目录，并指定中间二进制和目标二进制存放的位置。

EXCLUDE_FROM_ALL 参数的含义是将这个目录从编译过程中排除，比如工程中的example可能就需要工程构建完成后再进入example目录单独进行构建（也可以通过定义依赖来解决此类问题）

ADD_SUBDIRECTORY(src bin)定义了将src子目录加入工程，编译输出（包含编译中间结果）路径为bin目录。若不进行bin目录的指定，编译结果（包括中间结果）都会放在build/src（此目录跟原有的 src 目录对应），指定bin目录后，相当于在编译时将 src 重命名为 bin，所有的中间结果和目标二进制都将存放在 bin 目录。

SUBDIRS 指令,使用方法是:

SUBDIRS(dir1 dir2...)

但是这个指令已经不推荐使用。它可以一次添加多个子目录,并且,即使外部编译,子目录体系仍然会被保存。如果我们在上面的例子中将 ADD_SUBDIRECTORY (src bin)修改为 SUBDIRS(src,bin)，build目录中将出现一个src目录，生成的目标代码hello将存放在src目录中。

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

无论是SUBDIRS()还是ADD_SUBDIRECTORY()指令(不论是否指定编译输出目录)，都可以通过SET指令重新定义EXECUTABLE_OUTPUT_PATH 和LIBRARY_OUTPUT_PATH变量来指定最终的目标二进制的位置(指最终生成的 hello 或者最终的共享库,不包含编译生成的中间文件)

SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)//build/bin
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)//build/lib

在哪里ADD_EXECUTABLE 或 ADD_LIBRARY，如果需要改变目标存放路径，就在哪里加入上述的定义。本例中是src下的CMakeLists.txt

4 安装

安装的需要有两种，一种是从代码编译后直接make install安装，一种是打包时指定目录安装
可以通过make install直接将hello安装到/usr/bin目录，也可以通过make install DESTDIR=/tmp/test将hello安装在tmp/test/usr/bin（打包时这个方式经常被使用）。
安装我们的 HelloWorld ，需要引入一个新的cmake指令 INSTALL和一个变量CMAKE_INSTALL_PREFIX（CMAKE_INSTALL_PREFIX变量类似于configure脚本的 -prefix）。

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

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

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

ARCHIVE指静态库，LIBRATY指动态库，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
		)

将二进制myrun安装到{ CMAKE_INSTALL_PREFIX}/bin目录
动态库mylib安装到{CMAKE_INSTALL_PREFIX}/lib目录
静态库mystaticlib安装到${CMAKE_INSTALL_PREFIX}/linstatic目录

不需要关心 TARGETS 具体生成的路径,只需要写上 TARGETS 名称就可以。

普通文件的安装

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

用于安装一般文件，并可以指定访问权限，文件名是此指令所在路径下的相对路径。如果
默认不定义权限 PERMISSIONS,安装后的权限为:OWNER_WRITE, OWNER_READ,GROUP_READ,和 WORLD_READ,即 644 权限。

非目标文件的可执行程序安装(比如脚本之类):

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

和上面的 FILES 指令使用方法一样,唯一的不同是安装后权限为:OWNER_EXECUTE, GROUP_EXECUTE, 和 WORLD_EXECUTE,即 755 权限。

目录的安装:

INSTALL(DIRECTORY dirs... DESTINATION <dir>
[FILE_PERMISSIONS permissions...]
[DIRECTORY_PERMISSIONS permissions...]
[USE_SOURCE_PERMISSIONS]
[CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>]
[[PATTERN <pattern> | REGEX <regex>]
[EXCLUDE] [PERMISSIONS permissions...]] [...])

DIRECTORY后面连接的是所在source目录的相对路径（注意abc和abc/区别很大）：
若目录名不以/结尾，那么此目录将会被安装为目标路径下的abc，如果目录名以/结尾，代表这个目录中的内容安装到目标路径，但不包括这个目录本身。

PATTERN 用于使用正则表达式进行过滤，PERMISSIONS用于指定PATTERN过滤后的文件权限。

例：

INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj
		PATTERN "CVS" EXCLUDE 
		PATTERN"scripts/*"
		PERMISSIONS OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ
		)

执行结果是：
将icons目录安装到/share/myproj，将sctipts/中的内容安装到/share/myproj
不包含CVS的目录，对于scripts/*指定的权限为OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ。

安装时 CMAKE 脚本的执行:

INSTALL([[SCRIPT <file>] [CODE <code>]] [...])
//SCRIPT参数用于在安装时调用cmake脚本文件（也就是<abc>.cmake文件）
//CODE参数用于执行CMAKE指令，必须以双引号括起来。比如:
//INSTAL(CODE "MESSAGE(\"Sample install message.\")")）

5 修改 Helloworld 支持安装

1,为工程添加一个子目录 src,用来存储源代码;
2,添加一个子目录 doc,用来存储这个工程的文档 hello.txt
3,在工程目录添加文本文件 COPYRIGHT, README;
4,在工程目录添加一个 runhello.sh 脚本,用来调用 hello 二进制
4,将构建后的目标文件放入构建目录的 bin 子目录;
5,最终安装这些文件:将 hello 二进制与 runhello.sh 安装至//bin,将doc 目录中的 hello.txt 以及 COPYRIGHT/README 安装到//share/doc/cmake/t2

mkdir doc
cd doc
vim doc/hello.txt	#随便填写一些内容并保存
cd ..
touch runhello.sh
gedit runhello.sh	#内容为:hello
touch COPYRIGHT	#添加工程目录中的 COPYRIGHT 和 README
touch README

1.安装 COPYRIGHT/README:

修改主工程文件CMakelists.txt

INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/t2)

2.安装runhello.sh

修改主工程文件CMakelists.txt

INSTALL(PROGRAMS runhello.sh DESTINATION bin)

3.安装 doc 中的 hello.txt
两种方式：一是通过在doc目录建立CNakeLists.txt 并将doc目录通过ADD_SUBDIRECTORY 加入工程来完成。一种是直接爱工程目录中通过INSTALL(DIRECTORY)完成。
第二种方式：
hello.txt要安装到/.share/doc/cmake/t2，所以不能直接安装整个doc目录，安装 doc 目录中的内容，使用doc/

INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake/t2)

6 尝试修改的结果:

现在进入 build 目录进行外部编译,使用 CMAKE_INSTALL_PREFIX 参数(将它安装到了/tmp/t2 目录)

cd build
cmake -DCMAKE_INSTALL_PREFIX=/tmp/t2/usr ..
make
make install

进入/tmp/t2 目录看一下安装结果:
./usr
./usr/share
./usr/share/doc./usr/share/doc/cmake
./usr/share/doc/cmake/t2
./usr/share/doc/cmake/t2/hello.txt
./usr/share/doc/cmake/t2/README
./usr/share/doc/cmake/t2/COPYRIGHT
./usr/bin
./usr/bin/hello
./usr/bin/runhello.sh

直接安装到系统：

cd build
cmake -DCMAKE_INSTALL_PREFIX=/usr ..

如果没有定义CMAKE_INSTALL_PREFIX，即

cd build
cmake ..
make
make install

会发现CMAKE_INSTALL_PREFIX默认定义为/usr/local

参考：Cmake Practice --Cjacker