编译工具:CMake(三)| 最简单的实例升级
- 前言
- 过程
- 语法解释
- ADD_SUBDIRECTORY 指令
- 如何安装
- 目标文件的安装
- 普通文件的安装:
- 非目标文件的可执行程序安装(比如脚本之类)
- 目录的安装
- 修改 Helloworld 支持安装
- 测试
前言
本篇博客的任务是让前面的 Hello World 更像一个工程,我们需要作的是:
- 为工程添加一个子目录 src,用来放置工程源代码;
- 添加一个子目录 doc,用来放置这个工程的文档 hello.txt
- 在工程目录添加文本文件 COPYRIGHT, README;
- 在工程目录添加一个 runhello.sh 脚本,用来调用 hello 二进制
- 将构建后的目标文件放入构建目录的 bin 子目录;
- 最终安装这些文件:将 hello 二进制与 runhello.sh 安装至/usr/bin,将 doc 目录的内容以及 COPYRIGHT/README 安装到/usr/share/doc/cmake/test2
过程
在/Compilation_tool/cmake/目录下建立 test2 目录。
将 test1 工程的 main.c 和 CMakeLists.txt 拷贝到 test2 目录中。
添加子目录 src
将main.c文件移动到src文件夹
mkdir src
mv main.c src
现在的工程是这个样子:
一个子目录 src,一个 CMakeLists.txt。
CMake要求为任何子目录建立一个CMakeLists.txt
所以进入src子目录,编写CMakeLists.txt如下:
ADD_EXECUTABLE(hello main.c)
将test2工程的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 目录单独进行构建(当然,也可以通过定义依赖来解决此类问题)。
上面的例子定义了将 src 子目录加入工程,并指定编译输出(包含编译中间结果)路径为bin 目录。
如果不进行 bin 目录的指定,那么编译结果(包括中间结果)都将存放在build/src 目录(这个目录跟原有的 src 目录对应),
指定 bin 目录后,相当于在编译时将 src 重命名为 bin,所有的中间结果和目标二进制都将存放在 bin 目录。
换个地方保存目标二进制
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)
<projectname>_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 了。
如何安装
安装的需要有两种,一种是从代码编译后直接 make install 安装,一种是打包时的指定目录安装。
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 permissions...]
[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
)
上面的例子会将:
可执行二进制 myrun 安装到${CMAKE_INSTALL_PREFIX}/bin
目录
动态库 libmylib 安装到${CMAKE_INSTALL_PREFIX}/lib
目录
静态库 libmystaticlib 安装到${CMAKE_INSTALL_PREFIX}/libstatic
目录
特别注意的是不需要关心 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
、PATTERN
以及PERMISSIONS
参数。
DIRECTORY
后面连接的是所在 Source 目录的相对路径,但务必注意:
abc 和 abc/有很大的区别。如果目录名不以/结尾,那么这个目录将被安装为目标路径下的 abc,如果目录名以/结尾,
代表将这个目录中的内容安装到目标路径,但不包括这个目录本身。PATTERN
用于使用正则表达式进行过滤,PERMISSIONS
用于指定 PATTERN
过滤后的文件权限。
修改 Helloworld 支持安装
添加 doc 目录及文件:
cd /Compilation_tool/cmake/test2
mkdir doc
vi doc/hello.txt
随便填写一些内容并保存
在工程目录添加 runhello.sh 脚本,内容为:
hello
添加工程目录中的 COPYRIGHT 和 README
touch COPYRIGHT
touch README
下面改写各目录的 CMakeLists.txt 文件。
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
因为 hello.txt 要安装到//share/doc/cmake/t2,所以我们不能直接安装整个 doc 目录,这里采用的方式是安装 doc 目录中的内容,也就是使用 ” doc/” 在工程文件中添加
INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake/t2)
测试
现在进入 build 目录进行外部编译,注意使用 CMAKE_INSTALL_PREFIX 参数,这里我们将它安装到了/tmp/t2 目录:
cmake -DCMAKE_INSTALL_PREFIX=/tmp/t2/usr ..
然后运行
make
make install
这时候在计算机的 tmp路径下就多了 t2 文件夹
t2的目录为
如果你要直接安装到系统,可以使用如下指令:
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
如果没有定义CMAKE_INSTALL_PREFIX
会安装到什么地方?
CMAKE_INSTALL_PREFIX 的默认定义是/usr/local