(转载+整理)超详细的cmake教程
cmake教程
参考
(推荐)
注:本⽂主要内容来源于第⼀篇博客,所以转载的原地址仍然是第⼀篇的地址。在此基础上,有从其他博客⽂章学习进⾏总结,将基础性的语法知识进⾏合并,供⽇后复习参考。
什么是cmake
cmake允许开发者编写⼀种平台⽆关的 ⽂件来定制整个编译流程,然后再根据⽬标⽤户的平台进⼀步⽣成所需的本地化Makefile 和⼯程⽂件,如 Unix 的 Makefile 或 Windows 的 Visual Studio ⼯程。从⽽做到“Write once, run everywhere”。显
然,CMake 是⼀个⽐上述⼏种 make 更⾼级的编译配置⼯具。⼀些使⽤ CMake 作为项⽬架构系统的知名开源项⽬有 VTK、ITK、KDE、OpenCV、OSG 等。
在 linux 平台下使⽤ CMake ⽣成 Makefile 并编译的流程如下:
编写 CMake 配置⽂件 。
执⾏命令 cmake PATH 或者 ccmake PATH ⽣成 Makefile (ccmake 和 cmake 的区别在于前者提供了⼀个交互式的界⾯)。其中, PATH 是 所在的⽬录。
使⽤ make 命令进⾏编译。
你或许听过好⼏种 Make ⼯具,例如 ,QT 的 ,微软的 ,,,等等。这些 Make ⼯具遵循着不同的规范和标准,所执⾏的 Makefile 格式也千差万别。这样就带来了⼀个严峻的问题:如果软件想跨平台,必须要保证能够在不同平台编译。⽽如果使⽤上⾯的 Make ⼯具,就得为每⼀种标准写⼀次 Makefile ,这将是⼀件让⼈抓狂的⼯作。
CMake就是针对上⾯问题所设计的⼯具.
本⽂将从实例⼊⼿,⼀步步讲解 CMake 的常见⽤法,⽂中所有的可以在这⾥到。
cmake 常见语法罗列
< 的语法⽐较简单,由命令、注释和空格组成,其中命令是不区分⼤⼩写的,符号"#"后⾯的内容被认为是注释。命令由命令名称、⼩括号和参数组成,参数之间使⽤空格进⾏间隔。
PROJECT(hello_cmake):该命令表⽰项⽬的名称是 hello_cmake。
CMake构建包含⼀个项⽬名称,上⾯的命令会⾃动⽣成⼀些变量,在使⽤多个项⽬时引⽤某些变量会更加容易。⽐如⽣成了:PROJECT_NAME 这个变量。
PROJECT_NAME是变量名,${PROJECT_NAME}是变量值,值为hello_cmake
CMAKE_MINIMUM_REQUIRED(VERSION 2.6) :限定了 CMake 的版本。
AUX_SOURCE_DIRECTORY(< dir > < variable >): AUX_SOURCE_DIRECTORY ( . DIR_SRCS):将当前⽬录中的源⽂件名称赋值给变量 DIR_SRCS
ADD_SUBDIRECTORY(src): 指明本项⽬包含⼀个⼦⽬录 src
SET(SOURCES src/Hello.cpp src/main.cpp):创建⼀个变量,名字叫SOURCE。它包含了这些cpp⽂件。
ADD_EXECUTABLE(main ${SOURCES }):指⽰变量 SOURCES 中的源⽂件需要编译 成⼀个名称为 main 的可执⾏⽂件。
ADD_EXECUTABLE() 函数的第⼀个参数是可执⾏⽂件名,第⼆个参数是要编译的源⽂件列表。因为这⾥定义了SOURCE变量,所以就不需要罗列cpp⽂件了。等价于命令:ADD_EXECUTABLE(main src/Hello.cpp src/main.cpp)
ADD_LIBRARY(hello_library STATIC src/Hello.cpp):⽤于从某些源⽂件创建⼀个库,默认⽣成在构建⽂件夹。在add_library调⽤中包含了源⽂件,⽤于创建名称为libhello_library.a的静态库。
TARGET_LINK_LIBRARIES( main Test ):指明可执⾏⽂件 main 需要连接⼀个名为Test的链接库。添加链接库。
TARGET_INCLUDE_DIRECTORIES(hello_library PUBLIC ${PROJECT_SOURCE_DIR}/include):添加了⼀个⽬录,这个⽬录是库所包含的头⽂件的⽬录,并设置库属性为。
MESSAGE(STATUS “Using ake…”):命令 MESSAGE 会将参数的内容输出到终端。
FIND_PATH () :指明头⽂件查的路径,原型如下:find_path(< VAR > name1 [path1 path2 ...]) 该命令在参数 path* 指⽰的⽬录中查⽂件 name1 并将查到的路径保存在变量 VAR 中。
FIND_LIBRARY(): 同 FIND_PATH 类似,⽤于查链接库并将结果保存在变量中。
CMake可⽤变量
CMake语法指定了许多变量,可⽤于帮助您在项⽬或源代码树中到有⽤的⽬录。 其中⼀些包括:
Variable Info
CMAKE_SOURCE_DIR根源代码⽬录,⼯程顶层⽬录。暂认为就是PROJECT_SOURCE_DIR CMAKE_CURRENT_SOURCE_DIR当前处理的 所在的路径
PROJECT_SOURCE_DIR⼯程顶层⽬录
CMAKE_BINARY_DIR运⾏cmake的⽬录。外部构建时就是build⽬录CMAKE_CURRENT_BINARY_DIR The build directory you are currently in.当前所在build⽬录PROJECT_BINARY_DIR暂认为就是CMAKE_BINARY_DIR
想仔细体会⼀下,可以在CMakeLists中,利⽤message()命令输出⼀下这些变量。
另外,这些变量不仅可以在CMakeLists中使⽤,同样可以在源代码.cpp中使⽤。
⼊门案例
单个源⽂件
本节对应的源代码所在⽬录:。
对于简单的项⽬,只需要写⼏⾏代码就可以了。例如,假设现在我们的项⽬中只有⼀个源⽂件 ,该程序的⽤途是计算⼀个数的指数幂。
#include <stdio.h>
#include <stdlib.h>
double power(double base,int exponent)
{
int result = base;
int i;
if(exponent ==0){
return1;
}
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]);
return1;
}
double base =atof(argv[1]);
int exponent =atoi(argv[2]);
double result =power(base, exponent);
printf("%g ^ %d is %g\n", base, exponent, result);
return0;
}
编写
⾸先编写 ⽂件,并保存在与 源⽂件同个⽬录下:
# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项⽬信息
project (Demo1)
# 指定⽣成⽬标
add_executable()
< 的语法⽐较简单,由命令、注释和空格组成,其中命令是不区分⼤⼩写的。符号 # 后⾯的内容被认为是注释。命令由命令名称、⼩括号和参数组成,参数之间使⽤空格进⾏间隔。
对于上⾯的 ⽂件,依次出现了⼏个命令:
cmake_minimum_required:指定运⾏此配置⽂件所需的 CMake 的最低版本;
project:参数值是 Demo1,该命令表⽰项⽬的名称是 Demo1 。
add_executable: 将名为 的源⽂件编译成⼀个名称为 Demo 的可执⾏⽂件。
编译项⽬
之后,在当前⽬录执⾏ cmake . ,得到 Makefile 后再使⽤ make 命令编译得到 Demo1 可执⾏⽂件。
多个源⽂件
同⼀⽬录,多个源⽂件
本⼩节对应的源代码所在⽬录:。
上⾯的例⼦只有单个源⽂件。现在假如把 power 函数单独写进⼀个名为 MathFunctions.c 的源⽂件⾥,使得这个⼯程变成如下的形式:
./Demo2
|
为什么现在都用cmake+---
|
+---
|
+--- 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 的可执⾏⽂件。
多个⽬录,多个源⽂件
本⼩节对应的源代码所在⽬录:。
现在进⼀步将 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 ⽬录中的源⽂件编译为静态链接库。
进阶案例
⾃定义编译选项
本节对应的源代码所在⽬录:。
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 库:

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