4.cmake-更好的hello-world

从本小节开始，后面所有的构建我们都将采用 out-of-source 外部构建，约定的构建目录是工程目录下的 build 自录
本小节的任务是让前面的 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.准备工作

在cmake目录下建立t2目录
将t1工程里的main.c和CMakeLists.txt拷贝到t2目录中
main.c :

#include 
int main()
{
    printf("Hello World from t1 Main!\n");
    
    return 0;
}
1
2
3
4
5
6
7

CMakeLists.txt:

cmake_minimum_required(VERSION 3.0.0)
project(hello)
 
set(SRC_LIST main.c)
 
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")

add_executable(hello ${SRC_LIST})
1
2
3
4
5
6
7
8
9

2.添加子目录src

添加子目录并且把main.c放到src目录中:

mkdir src
mv main.c src
1
2

现在的工程看起来是这个样子：
一个子目录 src，一个 CMakeLists.txt。
上一节我们提到，需要为任何子目录建立一个 CMakeLists.txt，
进入子目录 src，编写 CMakeLists.txt 如下：

cmake_minimum_required(VERSION 3.0.0)
add_executable(hello main.cpp)
1
2

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

cmake_minimum_required(VERSION 3.0.0)
project(hello)
add_subdirectory(src bin)
1
2
3

然后建立 build 目录
可以看到当前的目录结构:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2# tree
.
├── CMakeLists.txt
├── build
└── src
    ├── CMakeLists.txt
    └── main.c

2 directories, 3 files
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2#
1
2
3
4
5
6
7
8
9
10

进入 build 目录进行外部编译

cmake ..
make 
1
2

我们可以看到编译过程如下:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# cmake ..
-- The C compiler identification is GNU 9.4.0
-- The CXX compiler identification is GNU 9.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /mnt/d/study/lwstudy/cmake/t2/build
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# make
Scanning dependencies of target hello
[ 50%] Building C object bin/CMakeFiles/hello.dir/main.c.o
[100%] Linking C executable hello
[100%] Built target hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

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

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# cd bin/
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/bin# ls
CMakeFiles  Makefile  cmake_install.cmake  hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/bin#
1
2
3
4

语法解释:
ADD_SUBDIRECTORY 指令

ADD_SUBDIRECTORY(source_dir [binary_dir] 
                [EXCLUDE_FROM_ALL])
1
2

这个指令用于向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置。EXCLUDE_FROM_ALL 参数的含义是将这个目录从编译过程中排除，比如，工程的 example，可能就需要工程构建完成后，再进入 example 目录单独进行构建(当然，你也可以通过定义依赖来解决此类问题)。

上面的例子定义了将 src 子目录加入工程，并指定编译输出(包含编译中间结果)路径为bin 目录。如果不进行 bin 目录的指定，那么编译结果(包括中间结果)都将存放在build/src 目录(这个目录跟原有的 src 目录对应)，指定 bin 目录后，相当于在编译时将 src 重命名为 bin，所有的中间结果和目标二进制都将存放在 bin 目录。
修改src目录下的CMakeLists.txt文件里面的add_subdirectory(src bin)

add_subdirectory(src)
1

编译结果如下:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# make
Scanning dependencies of target hello
[ 50%] Building C object src/CMakeFiles/hello.dir/main.c.o
[100%] Linking C executable hello
[100%] Built target hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# ls
CMakeCache.txt  CMakeFiles  Makefile  cmake_install.cmake  src
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build# cd src/
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/src# ls
CMakeFiles  Makefile  cmake_install.cmake  hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t2/build/src#
1
2
3
4
5
6
7
8
9
10
11

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

SUBDIRS(dir1 dir2...)
1

它可以一次添加多个子目录，
并且，即使外部编译，子目录体系仍然会被保存。

如果我们在上面的例子中将 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)
1
2

在第一节我们提到了_BINARY_DIR 和 PROJECT_BINARY_DIR 变量，他们指的编译发生的当前目录，如果是内部编译，就相当于 PROJECT_SOURCE_DIR 也就是工程代码所在目录，如果是外部编译，指的是外部编译所在目录，也就是本例中的 build目录。

所以，上面两个指令分别定义了：
可执行二进制的输出路径为 build/bin 和库的输出路径为 build/lib

本节我们没有提到共享库和静态库的构建，所以，你可以不考虑第二条指令

问题是，我应该把这两条指令写在工程的 CMakeLists.txt 还是 src 目录下的CMakeLists.txt，把握一个简单的原则，在哪里 ADD_EXECUTABLE 或 ADD_LIBRARY，如果需要改变目标存放路径，就在哪里加入上述的定义

在这个例子里，当然就是指 src 下的 CMakeLists.txt 了。

4.如何安装

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

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

DESTDIR=
install:
mkdir -p $(DESTDIR)/usr/bin
install -m 755 hello $(DESTDIR)/usr/bin
1
2
3
4

你可以通过:

make install
1

将 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
1
2
3
4
5

那么我们的 HelloWorld 应该怎么进行安装呢？
这里需要引入一个新的 cmake 指令 INSTALL 和一个非常有用的变量CMAKE_INSTALL_PREFIX。
CMAKE_INSTALL_PREFIX 变量类似于 configure 脚本的 –prefix，常见的使用方法看起来是这个样子：

cmake -DCMAKE_INSTALL_PREFIX=/usr ..
1

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

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

目标文件的安装

INSTALL(TARGETS targets... [[ARCHIVE|LIBRARY|RUNTIME] 
        [DESTINATION ] 
        [PERMISSIONS permissions...] 
        [CONFIGURATIONS [Debug|Release|...]] 
        [COMPONENT ] [OPTIONAL]] [...])
1
2
3
4
5

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

目标类型也就相对应的有三种，ARCHIVE 特指静态库，LIBRARY 特指动态库，RUNTIME特指可执行目标二进制。

DESTINATION 定义了安装的路径，如果路径以/开头，那么指的是绝对路径，这时候CMAKE_INSTALL_PREFIX 其实就无效了。如果你希望使用 CMAKE_INSTALL_PREFIX 来定义安装路径，就要写成相对路径，即不要以/开头，那么安装后的路径就是

举个简单的例子:

INSTALL(TARGETS myrun mylib mystaticlib
        RUNTIME DESTINATION bin
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION libstatic
        )
1
2
3
4
5

上面的例子会将：
可执行二进制 myrun 安装到${CMAKE_INSTALL_PREFIX}/bin 目录 动态库 libmylib 安装到${CMAKE_INSTALL_PREFIX}/lib 目录
静态库 libmystaticlib 安装到${CMAKE_INSTALL_PREFIX}/libstatic 目录

特别注意的是你不需要关心 TARGETS 具体生成的路径，只需要写上 TARGETS 名称就可以
了。

普通文件的安装

INSTALL(FILES files... DESTINATION  
        [PERMISSIONS permissions...] 
        [CONFIGURATIONS [Debug|Release|...]] 
        [COMPONENT ] [RENAME ] [OPTIONAL])
1
2
3
4

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

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

INSTALL(PROGRAMS files... DESTINATION  
        [PERMISSIONS permissions...] 
        [CONFIGURATIONS [Debug|Release|...]] 
        [COMPONENT ] 
        [RENAME ] [OPTIONAL])
1
2
3
4
5

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

目录的安装:

INSTALL(DIRECTORY dirs... DESTINATION 
        [FILE_PERMISSIONS permissions...]
        [DIRECTORY_PERMISSIONS permissions...]
        [USE_SOURCE_PERMISSIONS]
        [CONFIGURATIONS [Debug|Release|...]]
        [COMPONENT ]
        [[PATTERN  | REGEX ]
        [EXCLUDE] [PERMISSIONS permissions...]] [...])
1
2
3
4
5
6
7
8

这里主要介绍其中的 DIRECTORY、PATTERN 以及 PERMISSIONS 参数
DIRECTORY 后面连接的是所在 Source 目录的相对路径，但务必注意:
abc 和 abc/有很大的区别。
如果目录名不以/结尾，那么这个目录将被安装为目标路径下的 abc，如果目录名以/结尾，代表将这个目录中的内容安装到目标路径，但不包括这个目录本身。

PATTERN 用于使用正则表达式进行过滤，PERMISSIONS 用于指定 PATTERN 过滤后的文件权限。
我们来看一个例子:

INSTALL(DIRECTORY icons scripts/ DESTINATION share/myprojPATTERN "CVS" EXCLUDE
        PATTERN "scripts/*"
        PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ
        GROUP_EXECUTE GROUP_READ)
1
2
3
4

这条指令的执行结果是:
将 icons 目录安装到 /share/myproj，将 scripts/中的内容安装到 /share/myproj

不包含目录名为 CVS 的目录，对于 scripts/*文件指定权限为 OWNER_EXECUTE
OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ。

安装时CMAKE脚本的执行

todo liuwang 这个地方不是很明白

INSTALL([[SCRIPT ] [CODE ]] [...])
SCRIPT 参数用于在安装时调用 cmake 脚本文件（也就是.cmake 文件）
CODE 参数用于执行CMAKE指令, 必须以双引号括起来。比如:
INSTALL(CODE "MESSAGE(\"Sample install message.\")")
1
2
3
4

cd /cmake/t2
mkdir doc
vi doc/hello.txt
1
2
3

./hello
1

touch COPYRIGHT
touch README
1
2

```
INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/t2)
```
1
2
3

```
INSTALL(PROGRAMS runhello.sh DESTINATION bin)
```
1
2
3

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

cmake -DCMAKE_INSTALL_PREFIX=/tmp/t2/usr ..
1

make
make install
1
2

./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
1
2
3
4
5
6
7
8
9
10