Ubuntu 下 CMake 的使用
一、安装 CMake1. 下载 CMake2. 查看版本信息3. 编译出错
二、简单样例三、同一目录下多个源文件四、不同目录下多个源文件五、正规一点的组织结构六、动态库和静态库的编译控制七、对库进行链接八、添加编译选项
最近项目需要用到 cmake 来编译程序，原本我以为 Makefile 都是自己写的，但后来发现下载一些源码库编译的时候，很多 Makefile 都是用 CMake 来自动生成的。
一、安装 CMake
1. 下载 CMake
sudo apt-get install cmake
2. 查看版本信息
cmake -version //查看版本信息，再编译的时候会用到；写 cmake 文件的时候，指定版本不能超过当前的版本号
3. 编译出错
在 Ubuntu 上第一次使用 cmake 编译的时候，可能会出现以下错误
个错误是由于 没有安装 gcc 或者 g++ ，这两个都有安装，要不然 cmake 会编译失败。
cmake 后面跟着的是 CMakeLists.txt 文件存放的路径
执行 make clean 清除可执行文件，绿色标志的文件。
二、简单样例
首先让我们从最简单的代码入手，先来体验一下 cmake 的如何操作的。编写 main.c ，如下：
#include
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 . // 这里的 . 表示当前目录
make
./main
三、同一目录下多个源文件
接下来进入稍微复杂的例子：在同一个目录下有多个源文件。
在之前的目录下添加2个文件， test_func.c 和 test_func.h 。添加完后整体文件结构如下：
test_func.c 内容如下：
#include
#include "testFunc.h"
void func(int data)
{
printf("I am in func.c\n");
printf("data is %d\n", data);
}
test_func.h 的内容如下：
#ifndef _TEST_FUNC_H_
#define _TEST_FUNC_H_
void func(int data);
#endif
修改 main.c ，调用 test_func.h 里面声明的函数 func() ：
#include
#include "testFunc.h"
int main(void)
{
func(100);
return 0;
}
修改 CMakeLists.txt ，在 add_excutable 的参数里把 test_func.c 加进来：
cmake_minimum_required (VERSION 2.8)
project (demo)
add_executable(main main.c testFunc.c)
可以类推，如果在同一个目录下有多个源文件，那么只要在 add_excutable 里把所有的源文件都添加将进入就可以了，。但是如果有一百个源文件，再这样就有点冗余了，无法体现 cmake 的优越性， cmake 提供了一个命令可以把指定目录下所有的源文件存储再一个变量中，这个目录就是 aux_source_directory (dir var)
第一参数 dir 是指定的目录，第二个参数 var 是用于存放源文件列表的变量。
我们在 main.c 所在目录下再添加 2 个文件，test_func1.c 和 test_func1.h 。添加完后整体文件结构如下：
//testFunc1.c 如下：
#include
#include "testFunc1.h"
void func1(int data)
{
printf("data is %d\n", data);
}
//testFunc1.h 如下：
#ifndef _TEST_FUNC1_H_
#define _TEST_FUNC1_H_
void func1(int data);
#endif
再修改 main.c ，调用 test_func1.h 里面声明的函数 func ：
#include
#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_excutable 里调用 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})
四、不同目录下多个源文件
一般来说，当程序比较多时，我们会进行分类管理，把代码根据功能放在不同目录下，这样方便查找。那么这种情况下如何编写 CMakeLists.txt 呢？
我们把之前的源文件整理一下，新建 2 个目录 test_fnc 和 test_func1 ，整理好后完整文件结构如下：
把之前的 test_func.c 和 test_func.h 放到 test_func 目录下，test_func1.c 和 test_func1.h 则放到 test_func 目录下。
其中， CMakeList.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 了 test_func.h 和 test__func1.h ，如果没有这个命令来指定头文件所在位置，就会无法编译。当然，也可以在 main.c 里使用 include 来指定路径，如下：
#include "test_func/testFunc.h"
#include "test_func1/testFunc1.h"
只是这种写法不好看。
另外，我们使用了 2 次 aux_source_directory ，因为源文件分布在 2 个目录，所以添加 2 次。
五、正规一点的组织结构
正规一点来说，一般会把源文件放到 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_OUT_PATH ：目标二进制可执行文件的存放位置PROJECT_SOURCE_DIR ：工程的根目录
所以，这里 set 的意思是把存放 elf 文件的位置设置为工程根目录下的 bin 目录。（ cmake 有很多预定义变量）
测试 OK !
这里解释一下为什么在 build 目录下运行 cmake ？从求按摩几个 case 中可以看到，如果不这样做，cmake 运行时生成的附带文件就会跟源文件混在一起，这样就会对程序目录结构造成污染，而在 build 目录下运行 cmake ，生成的附带文件就只会待在 build 目录下，输出的附带文件就指挥待在 build 目录下，如果我们不想要这些文件就可以直接清空 build 目录，非常方便。
另外一种写法：
前面的工程使用了 2 个 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 删除。
六、动态库和静态库的编译控制
有时只需要编译出动态库和静态库，然后和等着让其他程序去使用。让我们看一下这种情况下该如何使用 cmake 。首先按照如下重新组织文件，只留下 test_func.h 和 test_func.c
我们会在 build 目录下运行 cmake ，并把生成的库文件存放到 lib 目录下。 CMakeLists.txt 内容如下：
cmake_minimum_required (VERSION 3.5)
project (demo)
set (SRC_LIST ${PROJECT_SOURCE_DIR}/testFunc/testFunc.c)
add_library (testFunc_shared SHARED ${SRC_LIST})
add_library (testFunc_static STATIC ${SRC_LIST})
set_target_properties (testFunc_shared PROPERTIES OUTPUT_NAME "testFunc")
set_target_properties (testFunc_static PROPERTIES OUTPUT_NAME "testFunc")
set (LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
这里又出现了新的命令和预定义变量：
add_library ：生成动态库或静态库（第 1 个参数指定库的名字；第 2 个参数决定是动态库还是静态库，如果没有就默认是静态库；第 3 个参数指定生成的源文件）；set_target_properties ：设置最终生成的库的名称，还要其他功能，如设置库的版本号等等；LIBRARY_OUTPUT_PATH ：库文件的默认输出路径，这里设置为工程目录下的 lib 目录
注意 ：前面使用 set_target_properties 重新定义了库的输出名称，如果不使用 set_target_properties 也可以，按摩库的名称就是 add_library 里定义的名称，只是连续 2 次 使用 add_library 指定库名称时（第 1 个参数），这个名称不能相同，而 set_target_properties 可以把名称设置为相同，只是最终生成库文件后缀不同（一个是 .so ，一个是 .a ），这样相对来说会好看一点。
七、对库进行链接
既然我们已经生成了库，那么就进行链接测试下。重新新建一个工程目录，然后把上节生成的库拷贝过来，然后在工程目录下新建 src 目录和 bin 目录，在 src 目录下添加一个 main.c ，整体结构如下：
main.c 内容如下：
#include
#include "testFunc.h"
int main(void)
{
func(100);
return 0;
}
工程目录下的 CMakeLists.txt 内容如下：
cmake_minimum_required (VERSION 3.5)
project (demo)
#设置最后可执行文件存放的位置
set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
#找源文件
set (SRC_LIST ${PROJECT_SOURCE_DIR}/src/main.c)
#找头文件
include_directories (${PROJECT_SOURCE_DIR}/test_func)
#找库
find_library (TEST_FUNC_LIB libtest_func.so test_func HINTS ${PROJECT_SOURCE_DIR}/lib)
add_executable (main ${SRC_LIST})
#链接库
target_link_libraries (main ${TEST_FUNC_LIB})
这里出现 2 个新的命令：
find_library ：在指定目录下查找指定库，并把库的绝对路径存放到变量里，其第 1 个参数是变量名称，第 2 个参数是库名称，第 3 个参数是 HINTS ，第 4 个参数是路径；target_link_libraries ：把目标文件库与文件进行链接
使用 find_library 的好处是在执行 cmake … 时就会去查找是否存在，这样可以提前发现错误，不用等到链接时。
ps : 在 lib 目录下有 test_func 的静态库和动态库， find_library(TEST_FUNC_LIB test_func …) 默认是查找动态库，如果想直接指定使用动态库还是静态库，可以写成 find_library(TEST_FUNC_LIB libtest_func.so …) 或者 find_library(TEST_FUNC_LIB libtest_func.a …) ； Linux 下动态库生成的是后缀名为 .so ，静态库生成的后缀名是 .a （Windows 下动态库的后缀名为 .dll ，静态库为 .lib）
ps : 查看 elf 文件使用了哪些库，可以使用的 readelf -d ./xx 来查看 ：
八、添加编译选项
有时编译程序时想添加一些编译选项，如 -Wall 、-g 等，就可以用 add_compile_options 来进行操作
cmake_minimum_required (VERSION 2.8)
project (demo)
set (EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
add_compile_options(-Wall)
add_executable(main main.c)
参考文章
发表评论