CMake 简介与使用
2017.07.05
本文希望用短平快的方式,解决Cmake软件的安装配置使用问题,更进一步的参数配置与工程测试、报错问题解决,可以参考他人文档,众人拾柴火焰高,整理好的相关资源链接也一并列出。
简介
CMake是众多Make工具中的一种,就是对代码进行编译,测试以及打包操作。
Make工具里面,比较出名的有GNU Make,QT 的qmake,微软的MS nmake,BSD Make(pmake),Makepp,等等。这些 Make 工具遵循着不同的规范和标准,所执行的 Makefile 格式也千差万别。这样就带来了一个严峻的问题:如果软件想跨平台,必须要保证能够在不同平台编译。而如果使用上面的 Make 工具,就得为每一种标准写一次 Makefile ,这将是一件让人抓狂的工作。
而每次对出现的问题进行解决,即是一次对效率化的贡献。因此CMake应运而生。
它可以让程序员通过一个与开发平台无关的CMakeList.txt文件来定制整个编译流程,然后再根据目标用户的平台进一步生成所需的Makefile和工程文件,如*nix平台的Makefile或者win平台下面的VS工程。也是一种“Write once, run everywhere”。
一些比较出名的开源项目以及商业项目,也都是采用CMake作为项目架构系统,比如KDE以及OpenCV,奈飞(Netflix),第二人生(Second Life),还有LLVM 和Clang,MySQL等等。
安装
官网是https://cmake.org
https://cmake.org/download/ 这里可以下载到对应不同平台的安装包,这里分为源码包以及二进制可执行文件两类。然后根据需要进行下载安装就好了,对于*nix下面的安装,可以看另一篇帖子。
使用
CMake可以支持win和*nix,通过在平台环境上进行搜索用于build的文件,windows+VS环境下,可以帮你生成.sln,vcxproj文件,而在*nix则是makefile,同理MAC OS则是xcode的项目文件。
程序员就可以使用CMakeLists.txt配置文件在本地编译,链接文件,生成这些项目。
例如先创建一个小程序:
然后在相同目录下创建一个CMakeLists.txt文件
其中第一行是 最低的版本号要求,一般默认写2.6,方便兼容
第二行是项目信息,也就是项目名称
第三行是指定生成目标,也就是生成可以被开发环境使用的工程项目文件
然后运行控制台,切换到当前项目路径里面,用 cmake . 运行程序
这里用VS11.0 完成了编译,也是CMake自动搜索配置路径得到的。
这里你可以看到,就自动从cpp源文件生成了一个完整的VS项目工程。
如果有多个源文件存在,则修改CMakeLists.txt,在制定目标那一行的文件后面进行添加操作
如果源文件众多,还可以使用aux_source_directory命令,它可以查找指定目录下的所有源文件,将结果存进指定变量名,语法格式如下:
aux_source_directory(<dir><variable>)
这样,CMake 会将当前目录所有源文件的文件名赋值给变量DIR_SRCS,再指示变量DIR_SRCS中的源文件需要编译成一个名称为 Demo 的可执行文件。
如果是多个目录,多个源文件,例如路径有一个show文件夹,里面包括show.c和show.h
那么需要分别在项目根目录 test 和 show 目录里各编写一个 CMakeLists.txt 文件。为了方便,我们可以先将 show 目录里的文件编译成静态库再由 main 函数调用。
这种情况下,根目录test里面的CMakeLists.txt需要改为:
使用命令add_subdirectory指明本项目包含一个子目录 test,这样 test 目录下的 CMakeLists.txt 文件和源代码也会被处理 。第6行,使用命令target_link_libraries指明可执行文件 nihao 需要连接一个名为 test 的链接库 。
下面是修改子目录中的CMakeLists.txt如下:
也是类似,使用命令add_library将 src 目录中的源文件编译为静态链接库。
如果目录在其他路径,则可以在test项目目录一层CMakeLists里面添加
include_directories ("${PROJECT_SOURCE_DIR}/show")
进阶
我们可以让这个库是可选,因为如果使用更大的库或者依赖于第三方的库时,会有这个需求。
也是在顶层的CMakeLists添加
option(USE_SHOW"Use test provided display function"ON)
这个设置会显示在CMake的GUI中,并且其默认值为ON。当用户选择了之后,这个值会被保存在CACHE中,这样就不需要每次CMAKE都进行更改了。
下面就继续构建和链接Show库。为了达到这个目的,我们可以改变顶层的CMakeLists文件:
配置文件configure_file命令用于加入一个配置头文件 config.h ,这个文件由 CMake 从config.h.in生成,通过这样的机制,可以预定义一些参数和变量来控制代码的生成。
在添加函数库这里使用了USE_SHOW来决定我们自己的库show是否会被编译和使用。注意这里变量EXTRA_LIBS的使用方法。这是保持一个大的项目看起来比较简洁的一个方法。源代码中相应的变化就比较简单了:
#ifdef USE_SHOW
#include"show.h"
#endif
最后当然是编写config.h.in文件
因为在前面的配置文件里面,用到了config.h,里面预定义了USE_SHOW的值,但是我们不需要直接去编写它,更方便的办法是写一个config.h.in文件,从CMakeLists.txt中导入配置。
config.h.in文件里面写下面一句:
#cmakedefine USE_SHOW
Linux下的使用
同理,如果做好了Linux的配置,也是一样的。
在项目目录下面使用 cmake .,软件会去确认当前默认的编译工具,比如GNU 4.8.1
然后其他流程类似,不过在Linux下面可以使用ccmake 或者 cmake -i 来打开交互式配置界面方便选择。
方向键选择不同选项,enter键进行修改,c键完成配置,g键确认生成makefile,其他的操作可以参考界面上的提示。
正文就介绍到这里,如果需要进一步学习了解的,参考资料整理如下:
安装和测试及报错分析
windows下(测试可用):CMake简要教程
Linux下(没有Kali环境进行测试):CMake入门实战
报错分析合集:CMake error合集