cmake终极奥秘

cmake集中开源，跨平台，能够管理大型项目，简化编译构建过程和编译过程，高效率，可扩展于一体，简单而强大的项目构建工具

一般不需要安装，cmake目前已经成为各大linux发行版提供的组件，所以，需要自己动手安装的可能性很小。如果你使用的操作系统(比如windows或者某些linux版本)没有提供cmake或者包含的版本较旧，建议你直接从cmake官方网站下载安装。 cmake官网：https://cmake.org/download/

hello world，世界 你好

一个最简单的例子helloworld来演练一下cmake的完整构建过程

1、准备工作：

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

新建一个 demo1 文件，目录结构如下

所有的cmake练习都会放在/root/cmake的子目录下

在demo1目录新建main.c和cmakelists.txt (注意文件名大小写)：

main.c

cmakelists.txt

cmakelists.txt 的语法比较简单，由命令、注释和空格组成，其中命令是不区分大小写的。符号 <code>#</code> 后面的内容被认为是注释。命令由命令名称、小括号和参数组成，参数之间使用空格进行间隔。

对于上面的 cmakelists.txt 文件，依次出现了几个命令：

<code>cmake_minimum_required</code>：指定运行此配置文件所需的 cmake 的最低版本；

<code>project</code>：参数值是 <code>demo1</code>，该命令表示项目的名称是 <code>demo1</code> 。

<code>add_executable</code>： 将名为 main.c 的源文件编译成一个名称为 demo 的可执行文件

2、开始构建

所有的文件创建完成后，demo1目录中应该存在main.c和cmakelists.txt两个文件,如下所示

编译项目

之后，在 demo1 目录执行 <code>cmake .</code> ，得到 makefile 后再使用 <code>make</code> 命令编译得到 demo1 可执行文件。

3、清理工程：

跟经典的autotools系列工具一样，运行:

make clean

即可对构建结果进行清理

上面的例子展示的是“内部构建”，相信看到生成的临时文件比你的代码文件还要多的时候，估计这辈子你都不希望再使用内部构建！

对于cmake，内部编译上面已经演示过了，它生成了一些无法自动删除的中间文件，所以，引出了我们对外部编译的探讨，外部编译的过程如下：

(1)、新建build目录

(2)、进入build目录，运行 <code>cmake ..</code> (注意,…代表父目录)查看一下build目录，就会发现了生成了编译需要的makefile以及其他的中间文件。

(3)、运行make构建工程，就会在当前目录(build目录)中获得目标文件demo。

上述过程就是所谓的out-of-source外部编译，一个最大的好处是，对于原有的工程没有任何影响，所有动作全部发生在编译目录。通过这一点，也足以说服我们全部采用外部编译方式构建工程。

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

先看下目录结构,代码是makefile里面的测试文件，简单的调用加减乘除函数

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

唯一的改动只是在 <code>add_executable</code> 命令中增加了一个 <code>dir_srcs</code> 变量。这样写的好处就是如果源文件很多，把所有源文件的名字都加进去将是一件烦人的工作。更省事的方法是使用 <code>aux_source_directory</code> 命令，该命令会查找指定目录下的所有源文件，然后将结果存进指定变量名。其语法如下：

这样，cmake 会将当前目录所有源文件的文件名赋值给变量 <code>dir_srcs</code> ，再指示变量 <code>dir_srcs</code> 中的源文件需要编译成一个名称为 demo 的可执行文件。

我们还是使用外部编译

运行profect完美,简单又强大。

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

目录构建如下

对于这种情况，需要分别在项目根目录 demo3 和 src 目录里各编写一个 cmakelists.txt 文件。

为了方便，我们可以先将 src 目录里的文件编译成静态库或者动态库再由 main 函数调用

根目录makefile

该文件添加了下面的内容:

第10行，定义变量 <code>use_mycalc</code>,默认为<code>on</code>

第18行，使用命令 <code>add_subdirectory</code> 指明本项目包含一个子目录 math，这样 math 目录下的 cmakelists.txt 文件和源代码也会被处理 。

第28行，使用命令 <code>target_link_libraries</code> 指明可执行文件 demo 需要连接一个名为 calc 的链接库 。

子目录中的 cmakelists.txt

同样，我们还是使用外部编译

使用ldd查看链接库的位置，发现<code>libcalc.so</code>在我们指定的<code>lib</code>目录。

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

cmake 允许为项目增加编译选项，从而可以根据用户的环境和需求选择最合适的编译方案。

例如，可以将 calc 库设为一个可选的库，如果该选项为 <code>on</code> ，就使用该库定义的函数来进行运算。否则就调用标准库中的运算符进行操作。

还是之前的代码，在此基础上进行增删。

修改 cmakelists 文件

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

其中：

第10行的 <code>configure_file</code> 命令用于加入一个配置头文件 config.h ，这个文件由 cmake 从 config.h.in 生成，通过这样的机制，将可以通过预定义一些参数和变量来控制代码的生成。

第16行的 <code>option</code> 命令添加了一个 <code>use_mycalc</code>选项，并且默认值为 <code>on</code> 。

第20行根据 <code>use_mycalc</code>变量的值来决定是否使用我们自己编写的 calc库。

修改 [main.c]文件，让其根据 <code>use_mycalc</code> 值来决定是否调用标准库还是 calc 库：

编写 [config.h.in]文件

上面的程序值得注意的是第2行，这里引用了一个 config.h 文件，这个文件预定义了 <code>use_mycalc</code> 的值。但我们并不直接编写这个文件，为了方便从 cmakelists.txt 中导入配置，我们编写一个 config.h.in 文件，内容如下：

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

同样使用外部编译，为了便于交互式的选择该变量的值，可以使用<code>cmake -i</code> 命令（也可以使用 <code>ccmake</code> 命令，该命令会提供一个会话式的交互式配置界面）：

上面是交互命令，有提示让你输入选项，回车默认不修改，可设置<code>off</code>和<code>on</code>，

从中可以找到刚刚定义的 <code>use_mycalc</code> 选项，在选项中设置<code>off</code>，make一下运行如下

可以将定义的 <code>use_mycalc</code> 选项，在选项中设置<code>on</code>，重新，make一下运行如下

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

首先先在 子目录下的cmakelists.txt 文件里添加下面两行：

指明 calc 库的安装路径。之后同样修改根目录的 cmakelists 文件，在末尾添加下面几行：

通过上面的定制，生成的 demo 文件和 calc 函数库 libcalc.so 文件将会被复制到 <code>/usr/local/bin</code> 中，而 head.h 和生成的 config.h 文件则会被复制到 <code>/usr/local/include</code> 中。

让 cmake 支持 gdb 的设置也很容易，只需要指定 <code>debug</code> 模式下开启 <code>-g</code> 选项：

之后可以直接对生成的程序使用 gdb 来调试。

另外提一下，<code>cflags</code> 是预先设置的变量。

命令

意义

<code>cflags</code>

c语言编译器参数。

<code>cxxflags</code>

c++语言编译器参数。

<code>cppflags</code>

c预处理器参数

<code>ldflags</code>

链接器参数。（如：<code>ld</code> ）

​ -dcmake_install_prefix 指定编译库安装路径

​ -dcmake_system_name 指定系统为linux

​ -dcmake_c_compiler 指定c语言编译器如交叉编译器未加入到环境变量，需要使用绝对路径

​ -dcmake_cxx_compiler 指定c++编译器

​ -dzlib_include_dir 指定zlib头文件目录

​ -dzlib_library 指定zlib动态库路径

​ -dlws_openssl_include_dirs 指定openssl头文件目录

​ -dlws_openssl_libraries 指定openssl动态库路径

<code>add_custom_target</code> 的用处：增加一个没有输出的目标，使得它总是被构建。

该命令的其他一些参数的含义：

all：表明该目标会被添加到默认的构建目标，使得它每次都被运行；

command：指定要在构建时执行的命令行；

depends：指定命令所依赖的文件；

comment：在构建时执行命令之前显示给定消息；

working_directory：使用给定的当前工作目录执行命令。如果它是相对路径，它将相对于对应于当前源目录的构建树目录；

byproducts：指定命令预期产生的文件。

#必须设置然后再使用