cmake学习我是参考了《CMake Practice.pdf》,说实话这本书写的真好,很详细,所以就按照这本书,自己再总结一遍。(其实是自己抄一遍,哈哈哈)
PDF路径
没有最好,只有更好。接下来继续优化hello world的工程。
但是现在看是都是使用外部构建了,上一节已经学会了外部构建,就不能再回到解放前了是吧。
本小节的任务是让前面的 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,
2.1 准备工作
把上一节的工程目录直接拷贝一份出来,我们在这一份里修改。
添加src子目录,把main.c移动到子目录中,并添加CMakeLists.txt。如下:
然后修改两个CMakeLists.txt
# main/CMakeLists.txt
ADD_EXECUTABLE(hello main.c)
# 顶级CMakeLists.txt
PROJECT (HELLO)
ADD_SUBDIRECTORY(src bin)
接下来就自行编译了,这里就不介绍了,无非就是创建一个build,然后cmake …;make;
2.2 语法解释
在上面好像新增加了一个指令,这里我们来解释一波:
# 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指令,这个指令已经不推荐使用
ADD_SUBDIRECTORY(src bin)
# 如果需要换个地方保存目标二进制
# 我们都可以通过SET指令重新定义EXECUTABLE_OUTPUT_PATH和LIBRARY_OUTPUT_DIR变量来指定最终的目标二进制的位置
# (指最终生成的hello或者最终的共享库,不包含编译生成的中间文件)
# SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
# SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
# 这两条指令需要写成什么位置,在哪里的ADD_EXECUTABLE或ADD_LIBRARY需要改变路径,就在哪里加入定义
2.3 如何安装
# 如何安装?我们用makefile的时候,make之后,也会经常执行make install,接下来看看cmake是怎么处理的
# 安装的需要有两种,一种是从代码编译后直接make install安装,一种是打包时指定目录安装
# 这里需要引入一个新的cmake指令:INSTALL和一个非常有用的变量CMAKE_INSTALL_PREFIX
# CMAKE_INSTALL_PREFIX变量类似于configure脚本的--prefix,常见的使用方法看起来是这个样子
# cmake -DCMAKE_INSTALL_PREFIX=/usr .
# INSTALL指令用于定义安装规则:下面来看看
# --目标文件的安装:
# INSTALL(TARGETS targets ...
# [ [ ARCHIVE | LIBRARY | RUNTIME]
# [ DESCTINATION <dir>]
# [ PERMISSIONS permissions ...]
# [ CONFIGURATIONS [Debug | Release | ..] ]
# [ COMPONENT <component>]
# [ OPTIONAL]
# ] [...] )
# targets 后面跟着我们ADD_EXECUTABLE或者ADD_LIBRARY定义的目标文件,可能是可执行二进制,动态库,静态库
# 目标类型对应这上面的三种:ARCHIVE特指静态库,LIBRARY特值动态库,RUNTIME特指可执行目标二进制
# DESCTINATION定义了安装的路径,如果路径以/开头,那是绝对路径,这时候我们传参的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>
# [ PREMISSIONS permissions... ]
# [ CONFIGURATIONS [Debug | Release | ...] ]
# [COMPONENT <component>]
# [RENAME <name>] [OPTIONAL])
# 可用于安装一般文件,并可以指定访问权限,文件名是此指令所在路径下的相对路径
# 如果默认不定义权限PERMISSIONS,安装后的权限为:
# OWNER_WRITE,OWNER_READ,GROUP_READ和WORLD_READ,即664权限
# --非目标文件的可执行程序安装(比如脚本之类):
# INSTALL(PROGRAMS files.. DESTINATION <dir>
# [RERMISSIONS permissions...]
# [CONFIGURATIONS [Debug | Release | ...] ]
# [COMPONENT <component>]
# [RENAME <name>] [OPTIONAL])
# 跟上面的FILES指令使用方法一样,唯一的不同时安装后的权限为:
# OWNER_EXECUTE,GROUP_EXECUTE和WORLD_EXECUTE,即755权限
# --目录安装:
# INSTAL(DIRECTORY dirs... DESTINATION <dir>
# [FILE_PERMISSIONS permissions...]
# [DIRECTORY_PERMISSOPNS 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 "script/*"
# PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ)
# 这条指令的执行结果是:
# 将icons目录安装到<prefix>/share/myproj,将scripts/中的内容安装到<prefix>/share/myproj
# 不包含目录名为CVS的目录,对于scripts/*文件指定权限为OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ
2.4 修改helloworld支持安装
按照作者的意思,添加一些工程中的描述信息,(感觉就是一些装逼的东西)
添加完成之后,我们接下来修改CMakeLists.txt
# main/CMakeLists.txt
ADD_EXECUTABLE(hello main.c)
INSTALL(TARGETS hello RUNTIME DESTINATION bin) # 现在添加的,就是把生成的hello文件安装到<prefix/>bin目录下
# 顶级CMakeLists.txt
# 添加对COPYRIGHT/README,runhello.sh doc等文件的安装
INSTALL(FILES COPYRIGHT README DESTINATION doc)
INSTALL(PROGRAMS runhello.sh DESTINATION bin)
INSTALL(DIRECTORY doc/ DESTINATION doc)
接下来可以尝试编译一下:
cmake -DCMAKE_INSTALL_PREFIX=…/run …;
make;make install;
[mmog@localhost build]$ make install
[100%] Built target hello
Install the project...
-- Install configuration: ""
-- Installing: /home/mmog/study/cmake/2.advance_hello_world/run/doc/COPYRIGHT
-- Installing: /home/mmog/study/cmake/2.advance_hello_world/run/doc/README
-- Installing: /home/mmog/study/cmake/2.advance_hello_world/run/bin/runhello.sh
-- Installing: /home/mmog/study/cmake/2.advance_hello_world/run/doc
-- Installing: /home/mmog/study/cmake/2.advance_hello_world/run/doc/hello.txt
-- Installing: /home/mmog/study/cmake/2.advance_hello_world/run/bin/hello
[mmog@localhost build]$
看到都把我们需要安装的文件安装到我们传参的文件夹中。
CMAKE_INSTALL_PREFIX可以指定任意目录,我不太喜欢指定到系统目录中,总感觉一个工程就都生成在一个工程中,这样最好了。
2.5 一个疑问
如果我没有定义CMAKE_INSTALL_PREFIX会安装到什么地方?
你可以尝试一下,直接cmake …;make;make install;
你就会发现CMAKE_INSTALL_PREFIX的默认定义是/usr/local