背景
不同的Make 工具遵循着不同的规范和标准,所执行的 Makefile 格式也千差万别。为了保证能够在不同平台编译,就得为每一种标准写一次 Makefile ,麻烦。
CMake诞生了。CMake 是比make 更高级的编译配置工具。它允许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程,再根据用户的平台生成所需的本地化 Makefile 和工程文件,从而做到“Write once, run everywhere”。
比如在 linux 平台:
- 先编写 CMake 配置文件 CMakeLists.txt 。
- 执行命令 cmake PATH 或者 ccmake PATH 生成 Makefile(ccmake 和 cmake 的区别在于前者提供了一个交互式的界面。PATH 是 CMakeLists.txt 所在的目录。)
- 用 make 命令进行编译。
具体案例:
1、同一目录,单个源文件
只有一个源文件 main.cc ,在同个目录下编写CMakeList.txt 文件内容如下:
add_executable: 将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件。
2、同一目录,多个源文件
简单方案一:
在 add_executable 命令中增加了一个 MathFunctions.cc 源文件就行
但是如果源文件很多的时候,一个个加很麻烦,于是有了方案二
方案二:
使用 aux_source_directory 命令,该命令会查找指定目录下的源文件,然后将结果存进指定变量名。其语法如下:
aux_source_directory(<dir> <variable>)
#上面案例中.对应这里的<dir>就是表示所有源文件名称都保存到该变量哈
3、多个目录,多个源文件,对应多个CMakeLists.txt 文件
需要分别在项目根目录 Demo3 和 math 目录里各编写一个 CMakeLists.txt 文件。
根目录中的 CMakeLists.txt :
命令 add_subdirectory 指明本项目包含一个子目录 math,这样 math 目录下的 CMakeLists.txt 文件和源代码也会被处理 。
命令 target_link_libraries 指明可执行文件 main 需要连接一个名为 MathFunctions 的链接库(先将 math 目录里的文件编译成静态库再由 main 函数调用。)
子目录中的 CMakeLists.txt:
命令 add_library 将 src 目录中的源文件编译为静态链接库。
4、自定义编译选项
CMake 允许为项目增加编译选项,从而根据用户的环境和需求选择最合适的编译方案。
例如,将 MathFunctions 库设为可选的库,如果该选项为 ON ,就使用该库定义的数学函数来进行运算。否则就调用标准库中的数学函数库。
1、第一步是在顶层的 CMakeLists.txt 文件中添加该选项:
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo4)
# 加入一个配置头文件,用于处理 CMake 对源码的设置
configure_file (
"${PROJECT_SOURCE_DIR}/config.h.in"
"${PROJECT_BINARY_DIR}/config.h"
)
# 是否使用自己的 MathFunctions 库
option (USE_MYMATH
"Use provided math implementation" ON)
# 是否加入 MathFunctions 库
if (USE_MYMATH)
include_directories ("${PROJECT_SOURCE_DIR}/math")
add_subdirectory (math)
set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif (USE_MYMATH)
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 指定生成目标
add_executable(Demo ${DIR_SRCS})
target_link_libraries (Demo ${EXTRA_LIBS})
configure_file 命令用于加入一个配置头文件 config.h ,这个文件由 CMake 从 config.h.in 生成,通过这样的机制,将可以通过预定义一些参数和变量来控制代码的生成。
option 命令添加了一个 USE_MYMATH 变量,并且默认值为 ON ,接下来的命令是根据 USE_MYMATH 变量的值来决定是否使用我们自己编写的 MathFunctions 库。
2、修改 main.cc 文件
修改 main.cc 文件,根据 USE_MYMATH 的预定义值来决定是调用标准库还是 MathFunctions 库:
#include <stdio.h>
#include <stdlib.h>
#include "config.h"
#ifdef USE_MYMATH
#include "math/MathFunctions.h"
#else
#include <math.h>
#endif
int main(int argc, char *argv[])
{
if (argc < 3){
printf("Usage: %s base exponent \n", argv[0]);
return 1;
}
double base = atof(argv[1]);
int exponent = atoi(argv[2]);
#ifdef USE_MYMATH
printf("Now we use our own Math library. \n");
double result = power(base, exponent);
#else
printf("Now we use the standard library. \n");
double result = pow(base, exponent);
#endif
printf("%g ^ %d is %g\n", base, exponent, result);
return 0;
}
这里的 config.h 文件预定义了 USE_MYMATH 的值。但并不直接编写这个文件,为了方便从 CMakeLists.txt 中导入配置,我们编写一个 config.h.in 文件,内容如下:#cmakedefine USE_MYMATH
然后CMake 会自动根据 CMakeLists 配置文件中的设置自动生成 config.h 文件。
5、补充细节————安装和测试
CMake 也可以用来指定安装规则,添加测试。这两个功能分别可以通过在产生 Makefile 后使用 make install 和 make test 来执行。在以前的 GNU Makefile 里,你可能需要为此编写 install 和 test 两个伪目标和相应的规则,但在 CMake 里,这样的工作同样只需要以下简单的调用几条命令。
5.1 定制安装规则
先在 math/CMakeLists.txt 文件里添加下面两行:
# 指定 MathFunctions 库的安装路径
install (TARGETS MathFunctions DESTINATION bin)
install (FILES MathFunctions.h DESTINATION include)
再修改根目录的 CMakeLists 文件,在末尾添加下面几行:
# 指定安装路径
install (TARGETS Demo DESTINATION bin)
install (FILES "${PROJECT_BINARY_DIR}/config.h"
DESTINATION include)
然后生成的 Demo 文件和 MathFunctions 函数库 libMathFunctions.o 文件将会自动被复制到 /usr/local/bin 中,而 MathFunctions.h 和生成的 config.h 文件则会被复制到 /usr/local/include 中(这里的 /usr/local/ 是默认安装到的根目录,可以修改 CMAKE_INSTALL_PREFIX 变量的值来指定这些文件应该拷贝到哪个根目录)
5.2 为工程添加测试
CMake 提供了一个称为 CTest 的测试工具。在项目根目录的 CMakeLists 文件中调用一系列的 add_test 命令即可
略