CMakeLists 工程配置 (二)
引言
从本节开始,后面所有的构建我们都将采用 out-of-source 外部构建,约定的构建目 录是工程目录下的 build 自录。
本小节的任务是让前面的Hello World更像一个工程,我们需要作的是:
1,为工程添加一个子目录 src,用来放置工程源代码;
2,添加一个子目录 doc,用来放置这个工程的文档 hello.txt
3,在工程目录添加文本文件COPYRIGHT, README;
4,在工程目录添加一个 runhello.sh 脚本,用来调用 hello 二进制
4,将构建后的目标文件放入构建目录的 bin 子目录;
5,最终安装这些文件:将 hello 二进制与 runhello.sh 安装至/usr/bin,将 doc 目录 的内容以及 COPYRIGHT/README 安装到~/cmake/t2,将
准备工作
在~/cmake/目录下建立 t2 目录。
将 t1 工程的 main.c 和 CMakeLists.txt 拷贝到 t2 目录中。
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 目录进行外部编译。
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目录。
这里需要提一下的是 SUBDIRS指令,使用方法是:
SUBDIRS(dir1 dir2…),但是这个指令已经不推荐使用。它可以一次添加多个子目录,
并且,即使外部编译,子目录体系仍然会被保存。 如果我们在上面的例子中将ADD_SUBDIRECTORY (src bin)修改为SUBDIRS(src)。 那么在 build 目录中将出现一个 src 目录,生成的目标代码 hello 将存放在 src 目录中。
更换目标二进制保存位置
不论是 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)
在第一节我们提到了PROJECT_BINARY_DIR 变量,他们指的编译发生的当前目录,如果是内部编译,就相当于 PROJECT_SOURCE_DIR 也就是 工程代码所在目录,如果是外部编译,指的是外部编译所在目录,也就是本例中的 build 目录。
所以,上面两个指令分别定义了:
可执行二进制的输出路径为 build/bin 和库的输出路径为 build/lib.
本节我们没有提到共享库和静态库的构建,所以,你可以不考虑第二条指令。
问题是,我应该把这两条指令写在工程的 CMakeLists.txt 还是 src 目录下的 CMakeLists.txt,把握一个简单的原则,在哪里 ADD_EXECUTABLE 或 ADD_LIBRARY, 如果需要改变目标存放路径,就在哪里加入上述的定义。
在这个例子