超详细的cmake入门教程

2023-08-01 12:53:04 79

什么是cmake

你或许听过好几种Make工具，例如GNUMake，QT的qmake，微软的MSnmake，BSDMake（pmake），Makepp，等等。这些Make工具遵循着不同的规范和标准，所执行的Makefile格式也千差万别。这样就带来了一个严峻的问题：如果软件想跨平台，必须要保证能够在不同平台编译。而如果使用上面的Make工具，就得为每一种标准写一次Makefile，这将是一件让人抓狂的工作。
CMakeCMake附图1CMake就是针对上面问题所设计的工具：它首先允许开发者编写一种平台无关的CMakeList.txt文件来定制整个编译流程，然后再根据目标用户的平台进一步生成所需的本地化Makefile和工程文件，如Unix的Makefile或Windows的VisualStudio工程。从而做到“Writeonce,runeverywhere”。显然，CMake是一个比上述几种make更高级的编译配置工具。一些使用CMake作为项目架构系统的知名开源项目有VTK、ITK、KDE、OpenCV、OSG等。

在linux平台下使用CMake生成Makefile并编译的流程如下：

编写CMake配置文件CMakeLists.txt。
执行命令cmakePATH或者ccmakePATH生成Makefile。其中，PATH是CMakeLists.txt所在的目录。（ccmake和cmake的区别在于前者提供了一个交互式的界面）
使用make命令进行编译。

入门案例：单个源文件

本节对应的源代码所在目录：Demo1。
对于简单的项目，只需要写几行代码就可以了。例如，假设现在我们的项目中只有一个源文件main.cc，该程序的用途是计算一个数的指数幂。

#include
#include
/**
*power-Calculatethepowerofnumber.
*@parambase:Basevalue.
*@paramexponent:Exponentvalue.
*
*@returnbaseraisedtothepowerexponent.
*/
doublepower(doublebase,intexponent)
{
intresult=base;
inti;

if(exponent==0){
return1;
}

for(i=1;i
编写CMakeLists.txt
首先编写CMakeLists.txt文件，并保存在与main.cc源文件同个目录下：

#CMake最低版本号要求

cmake_minimum_required(VERSION2.8)

#项目信息

project(Demo1)

#指定生成目标

add_executable(Demomain.cc)

CMakeLists.txt的语法比较简单，由命令、注释和空格组成，其中命令是不区分大小写的。符号#后面的内容被认为是注释。命令由命令名称、小括号和参数组成，参数之间使用空格进行间隔。
对于上面的CMakeLists.txt文件，依次出现了几个命令：

cmake_minimum_required：指定运行此配置文件所需的CMake的最低版本；
project：参数值是Demo1，该命令表示项目的名称是Demo1。
add_executable：将名为 main.cc 的源文件编译成一个名称为Demo的可执行文件。

编译项目
之后，在当前目录执行cmake.，得到Makefile后再使用make命令编译得到Demo1可执行文件。
[ehome@xmanDemo1]$cmake.
--TheCcompileridentificationisGNU4.8.2
--TheCXXcompileridentificationisGNU4.8.2
--CheckforworkingCcompiler:/usr/sbin/cc
--CheckforworkingCcompiler:/usr/sbin/cc--works
--DetectingCcompilerABIinfo
--DetectingCcompilerABIinfo-done
--CheckforworkingCXXcompiler:/usr/sbin/c++
--CheckforworkingCXXcompiler:/usr/sbin/c++--works
--DetectingCXXcompilerABIinfo
--DetectingCXXcompilerABIinfo-done
--Configuringdone
--Generatingdone
--Buildfileshavebeenwrittento:/home/ehome/Documents/programming/C/power/Demo1
[ehome@xmanDemo1]$make
ScanningdependenciesoftargetDemo
[100%]BuildingCobjectCMakeFiles/Demo.dir/main.cc.o
LinkingCexecutableDemo
[100%]BuilttargetDemo
[ehome@xmanDemo1]$./Demo54
5^4is625
[ehome@xmanDemo1]$./Demo73
7^3is343
[ehome@xmanDemo1]$./Demo210
2^10is1024

多个源文件
同一目录，多个源文件
本小节对应的源代码所在目录：Demo2。

上面的例子只有单个源文件。现在假如把power函数单独写进一个名为MathFunctions.c的源文件里，使得这个工程变成如下的形式：

./Demo2

   |

   +---main.cc

   |

   +---MathFunctions.cc

   |

   +---MathFunctions.h

这个时候，CMakeLists.txt可以改成如下的形式：

#CMake最低版本号要求

cmake_minimum_required(VERSION2.8)

#项目信息

project(Demo2)

#指定生成目标

add_executable(Demomain.ccMathFunctions.cc)

唯一的改动只是在add_executable命令中增加了一个MathFunctions.cc源文件。这样写当然没什么问题，但是如果源文件很多，把所有源文件的名字都加进去将是一件烦人的工作。更省事的方法是使用aux_source_directory命令，该命令会查找指定目录下的所有源文件，然后将结果存进指定变量名。其语法如下：

aux_source_directory(
)



因此，可以修改CMakeLists.txt如下：

#CMake最低版本号要求

cmake_minimum_required(VERSION2.8)

#项目信息

project(Demo2)

#查找当前目录下的所有源文件

#并将名称保存到DIR_SRCS变量

aux_source_directory(.DIR_SRCS)

#指定生成目标

add_executable(Demo${DIR_SRCS})

这样，CMake会将当前目录所有源文件的文件名赋值给变量DIR_SRCS，再指示变量DIR_SRCS中的源文件需要编译成一个名称为Demo的可执行文件。
多个目录，多个源文件


本小节对应的源代码所在目录：Demo3。

现在进一步将MathFunctions.h和MathFunctions.cc文件移动到math目录下。

./Demo3

   |

   +---main.cc

   |

   +---math/

         |

         +---MathFunctions.cc

         |

         +---MathFunctions.h

对于这种情况，需要分别在项目根目录Demo3和math目录里各编写一个CMakeLists.txt文件。为了方便，我们可以先将math目录里的文件编译成静态库再由main函数调用。
根目录中的CMakeLists.txt：

#CMake最低版本号要求

cmake_minimum_required(VERSION2.8)

#项目信息

project(Demo3)

#查找当前目录下的所有源文件

#并将名称保存到DIR_SRCS变量

aux_source_directory(.DIR_SRCS)

#添加math子目录

add_subdirectory(math)

#指定生成目标

add_executable(Demomain.cc)

#添加链接库

target_link_libraries(DemoMathFunctions)

该文件添加了下面的内容:第3行，使用命令add_subdirectory指明本项目包含一个子目录math，这样math目录下的CMakeLists.txt文件和源代码也会被处理。第6行，使用命令target_link_libraries指明可执行文件main需要连接一个名为MathFunctions的链接库。
子目录中的CMakeLists.txt：

#查找当前目录下的所有源文件

#并将名称保存到DIR_LIB_SRCS变量

aux_source_directory(.DIR_LIB_SRCS)

#生成链接库

add_library(MathFunctions${DIR_LIB_SRCS})

 在该文件中使用命令add_library将src目录中的源文件编译为静态链接库。
自定义编译选项
本节对应的源代码所在目录：Demo4。

CMake允许为项目增加编译选项，从而可以根据用户的环境和需求选择最合适的编译方案。
例如，可以将MathFunctions库设为一个可选的库，如果该选项为ON，就使用该库定义的数学函数来进行运算。否则就调用标准库中的数学函数库。

修改CMakeLists文件
我们要做的第一步是在顶层的CMakeLists.txt文件中添加该选项： 

#CMake最低版本号要求

cmake_minimum_required(VERSION2.8)

#项目信息

project(Demo4)

#加入一个配置头文件，用于处理CMake对源码的设置

configure_file(

"${PROJECT_SOURCE_DIR}/config.h.in"

"${PROJECT_BINARY_DIR}/config.h"

)

#是否使用自己的MathFunctions库

option(USE_MYMATH

"Useprovidedmathimplementation"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库。
修改main.cc文件
之后修改main.cc文件，让其根据USE_MYMATH的预定义值来决定是否调用标准库还是MathFunctions库：
#include
#include
#include"config.h"
#ifdefUSE_MYMATH
#include"math/MathFunctions.h"
#else
#include
#endif
intmain(intargc,char*argv[])
{
if(argc<3){
printf("Usage:%sbaseexponent\n",argv[0]);
return1;
}
doublebase=atof(argv[1]);
intexponent=atoi(argv[2]);

#ifdefUSE_MYMATH
printf("NowweuseourownMathlibrary.\n");
doubleresult=power(base,exponent);
#else
printf("Nowweusethestandardlibrary.\n");
doubleresult=pow(base,exponent);
#endif
printf("%g^%dis%g\n",base,exponent,result);
return0;
}
编写config.h.in文件
上面的程序值得注意的是第2行，这里引用了一个config.h文件，这个文件预定义了USE_MYMATH的值。但我们并不直接编写这个文件，为了方便从CMakeLists.txt中导入配置，我们编写一个config.h.in文件，内容如下：

#cmakedefineUSE_MYMATH



这样CMake会自动根据CMakeLists配置文件中的设置自动生成config.h文件。

编译项目

现在编译一下这个项目，为了便于交互式的选择该变量的值，可以使用ccmake命令(也可以使用cmake-i命令，该命令会提供一个会话式的交互式配置界面。)

从中可以找到刚刚定义的USE_MYMATH选项，按键盘的方向键可以在不同的选项窗口间跳转，按下enter键可以修改该选项。修改完成后可以按下c选项完成配置，之后再按g键确认生成Makefile。ccmake的其他操作可以参考窗口下方给出的指令提示。
我们可以试试分别将USE_MYMATH设为ON和OFF得到的结果：

USE_MYMATH为ON

运行结果：

[ehome@xmanDemo4]$./Demo

NowweuseourownMathFunctionslibrary.

7^3=343.000000

10^5=100000.000000

2^10=1024.000000



此时config.h的内容为：
#defineUSE_MYMATH



USE_MYMATH为OFF

运行结果：

[ehome@xmanDemo4]$./Demo

Nowweusethestandardlibrary.

7^3=343.000000

10^5=100000.000000

2^10=1024.000000



此时config.h的内容为：

/*#undefUSE_MYMATH*/

 下面是其他网友的补充
使用cmake编译,组织C++项目
前言

这篇博客是我对cmake用法的一些经验总结,还很浅显,如果有错误或者更好的方案,欢迎指正~
使用方法统一为在build目录中执行:

$:cmake..

$:make

我觉得养成外部编译是一个好习惯
例一
目录结构为:

lzj@lzj:~/C-Plus-Plus/makefile_cmake/cmake_1$tree

.

├──build

├──CMakeLists.txt

└──src

   ├──hello

   │  ├──hello.cc

   │  └──hello.h

   ├──main.cpp

   └──world

       ├──world.cc

       └──world.h

src目录中不同属性类维护在不同目录中
main.cpp中使用hello.h和world.h
CMakeLists.txt为:

cmake_minimum_required(VERSION3.0)

project(test_1)
aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src/helloSOURCE_HELLO)

aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src/worldSOURCE_WORLD)
add_definitions("-g-Wall-std=c++11")
add_executable(main

              ${CMAKE_CURRENT_LIST_DIR}/src/main.cpp

              ${SOURCE_HELLO}

              ${SOURCE_WORLD})

例二
目录结构为:

lzj@lzj:~/C-Plus-Plus/makefile_cmake/cmake_2$tree

.

├──build

├──CMakeLists.txt

├──include

│  └──person.h

└──src

   ├──main.cpp

   └──person.cc



include目录下统一包含头文件和宏定义之类,源文件放在src目录下维护
person类是一个简单的空类,拥有一个私有成员变量val,一个公有成员函数来打印该变量,在main.cpp中调用
CMakeLists.txt为:

cmake_minimum_required(VERSION3.0)

project(test_2)
include_directories(${PROJECT_SOURCE_DIR}/include)
add_definitions("-g-Wall-std=c++11")
add_executable(main

              ${PROJECT_SOURCE_DIR}/src/main.cpp#这个路径看这个main.cpp位于哪里了              

              ${PROJECT_SOURCE_DIR}/src/person.cc)

例三
目录结构为:

lzj@lzj:~/C-Plus-Plus/makefile_cmake/cmake_3$tree

.

├──build

├──CMakeLists.txt

├──main.cpp

└──src

   ├──CMakeLists.txt

   ├──hello.cc

   ├──hello.h

   ├──world.cc

   └──world.h

将编写的代码编译为库,在main.cpp中使用,编译main.cpp时链接该库
顶层目录中CMakeLists.txt为:

cmake_minimum_required(VERSION3.0)

project(test_3)
add_subdirectory(src)
add_definitions("-g-Wall-std=c++11")
add_executable(mainmain.cpp)

target_link_libraries(mainTEST3)#自己的库名为TEST3

子目录src中的CMakeLists.txt为:

aux_source_directory(.DIR_LIB_SRCS)
add_library(TEST3${DIR_LIB_SRCS})

当然如果src目录下为多文件时,每个目录下都要添加该语句的CMakeLists.txt
源代码
 这篇文章就介绍到这了，希望大家以后多多支持毛票票。

超详细的cmake入门教程

热门推荐

随机推荐