前言
上一篇文章从如何构建只有一个源文件扩展到多个源文件,多个目录的构建语法,以及如何进行外部构建(out-of-source)。这里回忆一下,每次构建都会生成一个CMakeFiles文件夹,当执行make指令后,编译的中间文件会在DemoProject.dir(DemoProject目录为可执行程序名)文件夹中,Makefile文件会在构建根目录下(外部构建时再build目录下,内部构建时则再源码根目录下),生成的可执行程序也在与Makefile同目录下,这些都是默认行为。
通常一个大型项目组建项目目录时通常如下(参考opencv目录):
+--- CMakeLists.txt (根目录构建文件,必须要有)
+--- CONTRIBUTING.md
+--- README.md
..... (readme,copyright其他许可证说明等辅助性文件)
+--- samples/ (示例代码,不需被构建,也会有CMakeLists.txt)
+--- doc/ (工程说明等等,此目录不需要被构建)
|
+--- src/ (源码,此目录及子目录下都会有一个CMakeLists.txt)
CMakeLists.txt
|
+---src1/
......
+---srcn/
|
+--- source1.cpp
+---source1.h
.......
+--- sourcen.cpp
+---sourcen.h
+--- 3rdparty/ (要引入的三方库,需要被构建)
....... (其它目录和文件)
1、工程根目录包含一个CMakeLists.txt,作为构建的开始
2、需要被构建的目录及其子目录下都会有CMakeLists.txt
本文目的:
1、如何添加子构建目录
2、如何指定最终生成的可执行文件的路径
3、如何安装生成的可执行文件(相当于执行make install命令)
添加子构建目录
首先创建sample5,
1、创建COPYRIGHT README.txt等文件(随便写点内容)
2、创建doc目录,build目录
3、创建src目录,将sample1中main.cpp拷贝到src目录下
分别在根目录和src目录下创建CMakeLists.txt文件,最后工程sample5目录如下:
./sample5
|
+--- CMakeLists.txt
+--- COPYRIGHT
+--- README.txt
|
+--- doc/
|
+--- build/
|
+--- src/
+--- CMakeLists.txt
+--- main.cpp
工程根目录下的CMakeLists.txt内容如下:
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目工程名
project (sample5)
message(STATUS "root This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "root This is SOURCE dir " ${PROJECT_SOURCE_DIR})
# 添加子目录
ADD_SUBDIRECTORY(src)
src目录下的CMakeLists.txt内容如下:
message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})
# 定义源文件列表
set(SRC_LIST main.cpp)
# 指定生成目标 目标名字随便写;${SRC_LIST}代表前面定义的源文件列表变量
ADD_EXECUTABLE(sample5 ${SRC_LIST})
ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])
这个指令用于向当前工程添加存放源文件的子目录,并可以指定中间二进制和目标二进制存放的位置。EXCLUDE_FROM_ALL 参数的含义是将这个目录从编译过程中排除,比如,工程的示例代码samples ,可能就需要工程构建完成后,再进入example 目录单独进行构建。
在build目录下执行 cmake .. 会发现 buil目录下前面的例子中多了src目录,这是因为cmake会为每个子构建目录也创建一份单独的文件夹
tips:
1、如果将ADD_SUBDIRECTORY(src)替换成ADD_SUBDIRECTORY(src bin),那么编译中间文件以及生成的可执行程序将在build/bin/目录下,有兴趣的可以试试;
2、子构建目录下必须包含CMakeLists.txt文件,否则会报错"does not contain a CMakeLists.txt file.",可以将ADD_SUBDIRECTORY(doc)加入到根目录下的CMakeLists.txt文件中试试
指定最终生成的可执行文件的路径
上一步可以通过ADD_SUBDIRECTORY()指令第二个参数改变最终生成的二进制所在路径,不过一般都不会这么做,而是采用改变EXECUTABLE_OUTPUT_PATH值的方式实现这一目标
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
PROJECT_BINARY_DIR为默认情况下的二进制程序路径,这里为build/;此语句将指定程序最终生成可执行程序的路径为build/bin,
tips:
由于EXECUTABLE_OUTPUT_PATH是cmake的全局内建变量,所以在工程根目录下或者src下的CMakeLists.txt文件中添加此语句都是有效的,不过一般的做法是在哪里ADD_EXECUTABLE ,如果需要改变目标存放路径,就在哪里加入上述的定义。
所以这里在src下的CMakeLists.txt文件添加SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)指令
message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})
# 定义源文件列表
set(SRC_LIST main.cpp)
# 指定最终生成的可执行文件的路径
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
# 指定生成目标 目标名字随便写;${SRC_LIST}代表前面定义的源文件列表变量
ADD_EXECUTABLE(sample5 ${SRC_LIST})
删除build目录下的所有文件,重新执行cmake.. 和make,最后发现build目录下会多出一个bin文件夹,里面只有一个可执行文件sample5
如何安装生成的可执行文件
一般执行make命令后会生成一个可执行文件,该可执行文件就可以直接使用了。那如何将其安装到系统目录中呢?在用make构建时,如果需要安装会执行make install命令,最终
参考文章
https://www.hahack.com/codes/cmake/
https://www.kancloud.cn/itfanr/cmake-practice/82983