- 前言:
-
1 安装
- sudo apt install cmake
- cmake -version查看cmake版本
2 举例
编写main.c
#include <stdio.h>
int main(void)
{
printf("Hello World\n");
return 0;
}
然后在main.c相同目录下编写CMakeLists.txt
cmake_minimum_required (VERSION 2.8)
project (demo)
add_executable(main main.c)
第一行意思是表示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文件
3 同一目录下多个源文件
在同一个目录下有多个源文件
在之前的目录下添加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);
}
testFunc.h内容如下
/*
** testFunc.h
*/
#ifndef _TEST_FUNC_H_
#define _TEST_FUNC_H_
void func(int data);
#endif
修改main.c，调用testFunc.h里声明的函数func()
#include <stdio.h>
#include "testFunc.h"
int main(void)
{
func(100);
return 0;
}
修改CMakeLists.txt，在add_executable的参数里把testFunc.c加进来
cmake_minimum_required (VERSION 2.8)
project (demo)
add_executable(main main.c testFunc.c)
然后重新执行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);
}
testFunc1.h如下
/*
** testFunc1.h
*/
#ifndef _TEST_FUNC1_H_
#define _TEST_FUNC1_H_
void func1(int data);
#endif
再修改main.c，调用testFunc1.h里声明的函数func1()
#include <stdio.h>
#include "testFunc.h"
#include "testFunc1.h"
int main(void)
{
func(100);
func1(200);
return 0;
}
修改CMakeLists.txt
cmake_minimum_required (VERSION 2.8)
project (demo)
aux_source_directory(. SRC_LIST)
add_executable(main ${
SRC_LIST})
使用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})
4 不同目录下多个源文件
一般来说，当程序文件比较多时，我们会进行分类管理，把代码根据功能放在不同的目录下，这样方便查找。那么这种情况下如何编写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})
这里出现了一个新的命令：include_directories。该命令是用来向工程添加多个指定头文件的搜索路径，路径之间用空格分隔。
因为main.c里include了testFunc.h和testFunc1.h，如果没有这个命令来指定头文件所在位置，就会无法编译。当然，也可以在main.c里使用include来指定路径，如下
#include "test_func/testFunc.h"
#include "test_func1/testFunc1.h"
只是这种写法不好看。
另外，我们使用了2次aux_source_directory，因为源文件分布在2个目录下，所以添加2次
5 正规一点的组织结构
正规一点来说，一般会把源文件放到src目录下，把头文件放入到include文件下，生成的对象文件放入到build目录下，最终输出的elf文件会放到bin目录下，这样整个结构更加清晰。让我们把前面的文件再次重新组织下
我们在最外层目录下新建一个CMakeLists.txt，内容如下
cmake_minimum_required (VERSION 2.8)
project (demo)
add_subdirectory (src)
这里出现一个新的命令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)
这里又出现一个新的命令set，是用于定义变量的，EXECUTABLE_OUT_PATH和PROJECT_SOURCE_DIR是CMake自带的预定义变量，其意义如下，
EXECUTABLE_OUTPUT_PATH ：目标二进制可执行文件的存放位置
PROJECT_SOURCE_DIR：工程的根目录
所以，这里set的意思是把存放elf文件的位置设置为工程根目录下的bin目录。（cmake有很多预定义变量，详细的可以网上搜索一下）
添加好以上这2个CMakeLists.txt后
下面来运行cmake，不过这次先让我们切到build目录下，然后输入以下命令，
cmake …
Makefile会在build目录下生成，然后在build目录下运行make
运行ok，我们再切到bin目录下，发现main已经生成，并运行测试
测试OK！
这里解释一下为什么在build目录下运行cmake？从前面几个case中可以看到，如果不这样做，cmake运行时生成的附带文件就会跟源码文件混在一起，这样会对程序的目录结构造成污染，而在build目录下运行cmake，生成的附带文件就只会待在build目录下，如果我们不想要这些文件了就可以直接清空build目录，非常方便。
另外一种写法：
前面的工程使用了2个CMakeLists.txt，最外层的CMakeLists.txt用于掌控全局，使用add_subdirectory来控制其它目录下的CMakeLists.txt的运行。
上面的例子也可以只使用一个CMakeLists.txt，把最外层的CMakeLists.txt内容改成如下
cmake_minimum_required (VERSION 2.8)
project (demo)
set (EXECUTABLE_OUTPUT_PATH ${
PROJECT_SOURCE_DIR}/bin)
aux_source_directory (src SRC_LIST)
include_directories (include)
add_executable (main ${
SRC_LIST})
同时，还要把src目录下的CMakeLists.txt删除