code shell c c++

Linux下CMake简明教程 爱就是恒久忍耐 2018-08-26 23:14:45 72815 已收藏 1037 分类专栏： C/C++ 编译 版权 CMake是开源、跨平台的构建工具，可以让我们通过编写简单的配置文件去生成本地的Makefile，这个配置文件是独立于运行平台和编译器的，这样就不用亲自去编写Makefile了，而且配置文件可以直接拿到其它平台上使用，无需修改，非常方便。 本文主要讲述在Linux下如何使用CMake来编译我们的程序。 一 安装CMake 本文使用ubuntu18.04，安装cmake使用如下命令， sudo apt install cmake 安装完成后，在终端下输入cmake -version查看cmake版本， 这样cmake就安装好了。 二 简单样例 首先让我们从最简单的代码入手，先来体验下cmake是如何操作的。编写main.c，如下， #include <stdio.h> int main(void) { printf("Hello World\n"); return 0; } 1 2 3 4 5 6 7 8 然后在main.c相同目录下编写CMakeLists.txt，内容如下， cmake_minimum_required (VERSION 2.8) project (demo) add_executable(main main.c) 1 2 3 4 5 第一行意思是表示cmake的最低版本要求是2.8，我们安装的是3.10.2；第二行是表示本工程信息，也就是工程名叫demo；第三行比较关键，表示最终要生成的elf文件的名字叫main，使用的源文件是main.c 在终端下切到main.c所在的目录下，然后输入以下命令运行cmake， cmake . 会输出如下信息， 再来看看目录下的文件， 可以看到成功生成了Makefile，还有一些cmake运行时自动生成的文件。 然后在终端下输入make并回车， 可以看到执行cmake生成的Makefile可以显示进度，并带颜色。再看下目录下的文件， 可以看到我们需要的elf文件main也成功生成了，然后运行main， 运行成功！ PS: 如果想重新生成main，输入make clean就可以删除main这个elf文件。 三 同一目录下多个源文件 接下来进入稍微复杂的例子：在同一个目录下有多个源文件。 在之前的目录下添加2个文件，testFunc.c和testFunc.h。添加完后整体文件结构如下， testFunc.c内容如下， /* ** testFunc.c */ #include <stdio.h> #include "testFunc.h" void func(int data) { printf("data is %d\n", data); } 1 2 3 4 5 6 7 8 9 10 11 testFunc.h内容如下， /* ** testFunc.h */ #ifndef _TEST_FUNC_H_ #define _TEST_FUNC_H_ void func(int data); #endif 1 2 3 4 5 6 7 8 9 10 修改main.c，调用testFunc.h里声明的函数func()， #include <stdio.h> #include "testFunc.h" int main(void) { func(100); return 0; } 1 2 3 4 5 6 7 8 9 10 修改CMakeLists.txt，在add_executable的参数里把testFunc.c加进来 cmake_minimum_required (VERSION 2.8) project (demo) add_executable(main main.c testFunc.c) 1 2 3 4 5 然后重新执行cmake生成Makefile并运行make， 然后运行重新生成的elf文件main， 运行成功！ 可以类推，如果在同一目录下有多个源文件，那么只要在add_executable里把所有源文件都添加进去就可以了。但是如果有一百个源文件，再这样做就有点坑了，无法体现cmake的优越性，cmake提供了一个命令可以把指定目录下所有的源文件存储在一个变量中，这个命令就是 aux_source_directory(dir var)。 第一个参数dir是指定目录，第二个参数var是用于存放源文件列表的变量。 我们在main.c所在目录下再添加2个文件，testFunc1.c和testFunc1.h。添加完后整体文件结构如下， testFunc1.c如下， /* ** testFunc1.c */ #include <stdio.h> #include "testFunc1.h" void func1(int data) { printf("data is %d\n", data); } 1 2 3 4 5 6 7 8 9 10 11 testFunc1.h如下， /* ** testFunc1.h */ #ifndef _TEST_FUNC1_H_ #define _TEST_FUNC1_H_ void func1(int data); #endif 1 2 3 4 5 6 7 8 9 10 再修改main.c，调用testFunc1.h里声明的函数func1()， #include <stdio.h> #include "testFunc.h" #include "testFunc1.h" int main(void) { func(100); func1(200); return 0; } 1 2 3 4 5 6 7 8 9 10 11 12 修改CMakeLists.txt， cmake_minimum_required (VERSION 2.8) project (demo) aux_source_directory(. SRC_LIST) add_executable(main ${SRC_LIST}) 1 2 3 4 5 6 7 使用aux_source_directory把当前目录下的源文件存列表存放到变量SRC_LIST里，然后在add_executable里调用SRC_LIST（注意调用变量时的写法）。 再次执行cmake和make，并运行main， 可以看到运行成功了。 aux_source_directory()也存在弊端，它会把指定目录下的所有源文件都加进来，可能会加入一些我们不需要的文件，此时我们可以使用set命令去新建变量来存放需要的源文件，如下， cmake_minimum_required (VERSION 2.8) project (demo) set( SRC_LIST ./main.c ./testFunc1.c ./testFunc.c) add_executable(main ${SRC_LIST}) 1 2 3 4 5 6 7 8 9 10 四 不同目录下多个源文件 一般来说，当程序文件比较多时，我们会进行分类管理，把代码根据功能放在不同的目录下，这样方便查找。那么这种情况下如何编写CMakeLists.txt呢？ 我们把之前的源文件整理一下（新建2个目录test_func和test_func1），整理好后整体文件结构如下， 把之前的testFunc.c和testFunc.h放到test_func目录下，testFunc1.c和testFunc1.h则放到test_func1目录下。 其中，CMakeLists.txt和main.c在同一目录下，内容修改成如下所示， cmake_minimum_required (VERSION 2.8) project (demo) include_directories (test_func test_func1) aux_source_directory (test_func SRC_LIST) aux_source_directory (test_func1 SRC_LIST1) add_executable (main main.c ${SRC_LIST} ${SRC_LIST1}) 1 2 3 4 5 6 7 8 9 10 这里出现了一个新的命令：include_directories。该命令是用来向工程添加多个指定头文件的搜索路径，路径之间用空格分隔。 因为main.c里include了testFunc.h和testFunc1.h，如果没有这个命令来指定头文件所在位置，就会无法编译。当然，也可以在main.c里使用include来指定路径，如下 #include "test_func/testFunc.h" #include "test_func1/testFunc1.h" 1 2 只是这种写法不好看。 另外，我们使用了2次aux_source_directory，因为源文件分布在2个目录下，所以添加2次。 五 正规一点的组织结构 正规一点来说，一般会把源文件放到src目录下，把头文件放入到include文件下，生成的对象文件放入到build目录下，最终输出的elf文件会放到bin目录下，这样整个结构更加清晰。让我们把前面的文件再次重新组织下， 我们在最外层目录下新建一个CMakeLists.txt，内容如下， cmake_minimum_required (VERSION 2.8) project (demo) add_subdirectory (src) 1 2 3 4 5 这里出现一个新的命令add_subdirectory()，这个命令可以向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制的存放位置，具体用法可以百度。 这里指定src目录下存放了源文件，当执行cmake时，就会进入src目录下去找src目录下的CMakeLists.txt，所以在src目录下也建立一个CMakeLists.txt，内容如下， aux_source_directory (. SRC_LIST) include_directories (../include) add_executable (main ${SRC_LIST}) set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin) 1 2 3 4 5 6 7 这里又出现一个新的命令set，是用于定义变量的，EXECUTABLE_OUT_PATH和PROJECT_SOURCE_DIR是CMake自带的预定义变量，其意义如下， EXECUTABLE_OUTPUT_PATH ：目标二进制可执行文件的存放位置 PROJECT_SOURCE_DIR：工程的根目录 所以，这里set的意思是把存放elf文�