超详细的cmake⼊门教程
什么是cmake
你或许听过好⼏种 Make ⼯具，例如 GNU Make ，QT 的 qmake ，微软的 MSnmake，BSD Make（pmake），Makepp，等等。这些 Make ⼯具遵循着不同的规范和标准，所执⾏的 Makefile 格式也千差万别。这样就带来了⼀个严峻的问题：如果软件想跨平台，必须要保证能够在不同平台编译。⽽如果使⽤上⾯的 Make ⼯具，就得为每⼀种标准写⼀次 Makefile ，这将是⼀件让⼈抓狂的⼯作。
CMake CMake附图 1 CMake就是针对上⾯问题所设计的⼯具：它⾸先允许开发者编写⼀种平台⽆关的 ⽂件来定制整个编译流程，然后再根据⽬标⽤户的平台进⼀步⽣成所需的本地化 Makefile 和⼯程⽂件，如 Unix 的 Makefile 或Windows 的 Visual Studio ⼯程。从⽽做到“Write once, run everywhere”。显然，CMake 是⼀个⽐上述⼏种 make 更⾼级的编译配置⼯具。⼀些使⽤ CMake 作为项⽬架构系统的知名开源项⽬有 VTK、ITK、KDE、OpenCV、OSG 等。
在 linux 平台下使⽤ CMake ⽣成 Makefile 并编译的流程如下：
1. 编写 CMake 配置⽂件 。
2. 执⾏命令 cmake PATH 或者 ccmake PATH ⽣成 Makefile。其中， PATH 是 所在的⽬录。
（ccmake 和
cmake 的区别在于前者提供了⼀个交互式的界⾯）
3. 使⽤ make 命令进⾏编译。
⼊门案例：单个源⽂件
本节对应的源代码所在⽬录：Demo1。
对于简单的项⽬，只需要写⼏⾏代码就可以了。例如，假设现在我们的项⽬中只有⼀个源⽂件 ，该程序的⽤途是计算⼀个数的指数幂。
#include <stdio.h>
#include <stdlib.h>
/**
* power - Calculate the power of number.
* @param base: Base value.
* @param exponent: Exponent value.
*
* @return base raised to the power exponent.
*/
double power(double base, int exponent)
{
int result = base;
int i;
if (exponent == 0) {
return 1;
}
for(i = 1; i < exponent; ++i){
result = result * base;
}
return result;
}
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]);
double result = power(base, exponent);
printf("%g ^ %d is %g\n", base, exponent, result);
return 0;
}
编写
⾸先编写 ⽂件，并保存在与 源⽂件同个⽬录下：
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项⽬信息
project (Demo1)
# 指定⽣成⽬标
add_executable()
< 的语法⽐较简单，由命令、注释和空格组成，其中命令是不区分⼤⼩写的。符号 # 后⾯的内容被认为是注释。命令由命令名称、⼩括号和参数组成，参数之间使⽤空格进⾏间隔。
对于上⾯的 ⽂件，依次出现了⼏个命令：
1. cmake_minimum_required：指定运⾏此配置⽂件所需的 CMake 的最低版本；
2. project：参数值是 Demo1，该命令表⽰项⽬的名称是 Demo1 。
3. add_executable：将名为 的源⽂件编译成⼀个名称为 Demo 的可执⾏⽂件。
编译项⽬
之后，在当前⽬录执⾏ cmake . ，得到 Makefile 后再使⽤ make 命令编译得到 Demo1 可执⾏⽂件。
[ehome@xman Demo1]$ cmake .
-- The C compiler identification is GNU 4.8.2
-- The CXX compiler identification is GNU 4.8.2
cmake如何使用
-- Check for working C compiler: /usr/sbin/cc
-- Check for working C compiler: /usr/sbin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: /usr/sbin/c++
-- Check for working CXX compiler: /usr/sbin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Configuring done
-
- Generating done
-- Build files have been written to: /home/ehome/Documents/programming/C/power/Demo1
[ehome@xman Demo1]$ make
Scanning dependencies of target Demo
[100%] Building C object CMakeFiles/Demo.
Linking C executable Demo
[100%] Built target Demo
[ehome@xman Demo1]$ ./Demo 5 4
5 ^ 4 is 625
[ehome@xman Demo1]$ ./Demo 7 3
7 ^ 3 is 343
[ehome@xman Demo1]$ ./Demo 2 10
2 ^ 10 is 1024
多个源⽂件
同⼀⽬录，多个源⽂件
本⼩节对应的源代码所在⽬录：Demo2。
上⾯的例⼦只有单个源⽂件。现在假如把 power 函数单独写进⼀个名为MathFunctions.c 的源⽂件⾥，使得这个⼯程变成如下的形式：
./Demo2
|
+---
|
+---
|
+--- MathFunctions.h
这个时候， 可以改成如下的形式：
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项⽬信息
project (Demo2)
# 指定⽣成⽬标
add_executable( )
唯⼀的改动只是在 add_executable 命令中增加了⼀个 源⽂件。这样写当然没什么问题，但是如果源⽂件很多，把所有源⽂件的名字都加进去将是⼀件烦⼈的⼯作。更省事的⽅法是使⽤ aux_source_directory 命令，该命令会查指定⽬录下的所有源⽂件，然后将结果存进指定变量名。其
语法如下：
aux_source_directory(<dir> <variable>)
因此，可以修改 如下：
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项⽬信息
project (Demo2)
# 查当前⽬录下的所有源⽂件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 指定⽣成⽬标
add_executable(Demo ${DIR_SRCS})
这样，CMake 会将当前⽬录所有源⽂件的⽂件名赋值给变量 DIR_SRCS ，再指⽰变量 DIR_SRCS 中的源⽂件需要编译成⼀个名称为 Demo 的可执⾏⽂件。
多个⽬录，多个源⽂件
本⼩节对应的源代码所在⽬录：Demo3。
现在进⼀步将 MathFunctions.h 和 ⽂件移动到 math ⽬录下。
./Demo3
|
+---
|
+--- math/
|
+---
|
+--- MathFunctions.h
对于这种情况，需要分别在项⽬根⽬录 Demo3 和 math ⽬录⾥各编写⼀个 ⽂件。为了⽅便，我们可以先将math ⽬录⾥的⽂件编译成静态库再由 main 函数调⽤。
根⽬录中的 ：
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项⽬信息
project (Demo3)
# 查当前⽬录下的所有源⽂件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 添加 math ⼦⽬录
add_subdirectory(math)
# 指定⽣成⽬标
add_executable()
# 添加链接库
target_link_libraries(Demo MathFunctions)
该⽂件添加了下⾯的内容: 第3⾏，使⽤命令 add_subdirectory 指明本项⽬包含⼀个⼦⽬录 math，这样 math ⽬录下的 ⽂件和源代码也会被处理。第6⾏，使⽤命令 target_link_libraries 指明可执⾏⽂件 main 需要连接⼀个名为MathFunctions 的链接库。
⼦⽬录中的 ：
# 查当前⽬录下的所有源⽂件
# 并将名称保存到 DIR_LIB_SRCS 变量
aux_source_directory(. DIR_LIB_SRCS)
# ⽣成链接库
add_library (MathFunctions ${DIR_LIB_SRCS})
在该⽂件中使⽤命令 add_library 将 src ⽬录中的源⽂件编译为静态链接库。
⾃定义编译选项
本节对应的源代码所在⽬录：Demo4。
CMake 允许为项⽬增加编译选项，从⽽可以根据⽤户的环境和需求选择最合适的编译⽅案。
例如，可以将 MathFunctions 库设为⼀个可选的库，如果该选项为 ON ，就使⽤该库定义的数学函数来进⾏运算。否则就调⽤标准库中的数学函数库。
修改 CMakeLists ⽂件
我们要做的第⼀步是在顶层的 ⽂件中添加该选项：
# 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})
其中：
第7⾏的 configure_file 命令⽤于加⼊⼀个配置头⽂件 config.h ，这个⽂件由 CMake 从 config.h.in ⽣成，通过这样的机制，将可以通过预定义⼀些参数和变量来控制代码的⽣成。
第13⾏的 option 命令添加了⼀个 USE_MYMATH 选项，并且默认值为 ON 。
第17⾏根据 USE_MYMATH 变量的值来决定是否使⽤我们⾃⼰编写的 MathFunctions 库。
修改 ⽂件
之后修改 ⽂件，让其根据 USE_MYMATH 的预定义值来决定是否调⽤标准库还是 MathFunctions 库：
#include
#include
#include "config.h"
#ifdef USE_MYMATH
#include "math/MathFunctions.h"
#else
#include
#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.in ⽂件
上⾯的程序值得注意的是第2⾏，这⾥引⽤了⼀个 config.h ⽂件，这个⽂件预定义了 USE_MYMATH 的值。但我们并不直接编写这个⽂件，为了⽅便从 中导⼊配置，我们编写⼀个 config.h.in ⽂件，内容如下：
#cmakedefine USE_MYMATH
这样 CMake 会⾃动根据 CMakeLists 配置⽂件中的设置⾃动⽣成 config.h ⽂件。
编译项⽬
现在编译⼀下这个项⽬，为了便于交互式的选择该变量的值，可以使⽤ ccmake 命令(也可以使⽤ cmake -i 命令，该命令会提供⼀个会话式的交互式配置界⾯。 )
从中可以到刚刚定义的 USE_MYMATH 选项，按键盘的⽅向键可以在不同的选项窗⼝间跳转，按下 enter 键可以修改该选项。修改完成后可以按下 c 选项完成配置，之后再按 g 键确认⽣成 Makefile 。ccmake 的其他操作可以参考窗⼝下⽅给出的指令提⽰。
我们可以试试分别将 USE_MYMATH 设为 ON 和 OFF 得到的结果：
USE_MYMATH 为 ON
运⾏结果：
[ehome@xman Demo4]$ ./Demo
Now we use our own MathFunctions library.
7 ^ 3 = 343.000000
10 ^ 5 = 100000.000000
2 ^ 10 = 1024.000000
此时 config.h 的内容为：
#define USE_MYMATH
USE_MYMATH 为 OFF
运⾏结果：

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。