cmake_文档

前言

cmake 已经开发了 5,6 年的时间，如果没有 KDE4，也许不会有人或者 Linux 发行版本重视

cmake，因为除了 Kitware 似乎没有人使用它。通过 KDE4 的选型和开发，cmake 逐渐进入了人们的视

线，在实际的使用过程中，cmake 的优势也逐渐的被大家所认识，至少 KDE 的开发者们给予了 cmake

极高的评价，同时庞大的 KDE 项目使用 cmake 来作为构建工具也证明了 cmake 的可用性和大项目管理

能力。所以，cmake 应该感谢 KDE，也正因为如此，cmake 的开发者投入了 KDE 从 autotools 到

cmake 的迁移过程中，并相当快速和顺利的完成了迁移，现在整个 KDE4 开发版本全部使用 cmake 构

建。这也是促使我们学习 cmake 的原因，首先 cmake 被接受并成功应用，其次，cmake 的优势在实际

Foo_FIND_QUIETLY 的定义，这显然是错误的，这样的定义永远不可能有效，正确的定义是

FOO_FIND_QUIETLY。种种原因，促使我开始写一份“面向使用和实用”的 cmake 文档，也就是本

教程《cmake 实践》(Cmake Practice)

本文档是边学习边编写的成果，更像是一个学习笔记和 Tutorial，因此难免有失误或者理解不够透彻的地

方，比如，我仍然不能理解为什么绝大部分使用变量的情况要通过${}引用，而在 IF 语句中却必须直接

使用变量名。也希望能够有 cmake 的高手来指点迷津。

补：从 cmake 的 maillist,我找到了一些答案，原文是：The `IF(var)' or `IF(NOT var)' command

expects `var' to be the name of a variable. This is stated in CMake's manual. So, for your

situation `IF(${libX})' is the same as `IF(/usr/lib/xorg)' and then CMake will check the value of the

variable named `/usr/lib/xorg'.也就是说 IF 需要的是变量名而不是变量值这个文档是开放的，开放的目

cmake 是 kitware 公司以及一些开源开发者在开发几个工具套件(VTK)的过程中衍生品，最终形成体系，

成为一个独立的开放源代码项目。项目的诞生时间是 2001 年。其官方网站是 www.cmake.org，可以通

过访问官方网站获得更多关于 cmake 的信息。cmake 的流行其实要归功于 KDE4 的开发(似乎跟当年的

svn 一样，KDE 将代码仓库从 CVS 迁移到 SVN，同时证明了 SVN 管理大型项目的可用性)，在 KDE

开发者使用了近 10 年 autotools 之后，他们终于决定为 KDE4 选择一个新的工程构建工具，其根本原因

用 KDE 开发者的话来说就是：只有少数几个“编译专家”能够掌握 KDE 现在的构建体系

(admin/Makefile.common)，在经历了 unsermake, scons 以及 cmake 的选型和尝试之后，KDE4 决定

CMake有三步：

1、根据编译器产生相应编译器的源码编译环境

cmake 的特点主要有：

1，开放源代码，使用类 BSD 许可发布。http://cmake.org/HTML/Copyright.html

2，跨平台，并可生成 native 编译配置文件，在 Linux/Unix 平台，生成 makefile，在苹果平台，可

以生成 xcode，在 Windows 平台，可以生成 MSVC 的工程文件。

3，能够管理大型项目，KDE4 就是最好的证明。

4，简化编译构建过程和编译过程。Cmake 的工具链非常简单：cmake+make。

5，高效虑，按照 KDE 官方说法，CMake 构建 KDE4 的 kdelibs 要比使用 autotools 来构建

KDE3.5.6 的 kdelibs 快 40%，主要是因为 Cmake 在工具链中没有 libtool。

6，可扩展，可以为 cmake 编写特定功能的模块，扩充 cmake 功能。

3，问题，难道就没有问题？

1，如果你没有实际的项目需求，那么看到这里就可以停下来了，因为 cmake 的学习过程就是实践

2，如果你的工程只有几个文件，直接编写 Makefile 是最好的选择。

3，如果使用的是 C/C++/Java 之外的语言，请不要使用 cmake(至少目前是这样)

4，如果你使用的语言有非常完备的构建体系，比如 java 的 ant，也不需要学习 cmake，虽然有成功

的例子，比如 QT4.3 的 csharp 绑定 qyoto。

5，如果项目已经采用了非常完备的工程管理工具，并且不存在维护问题，没有必要迁移到 cmake

4，如果仅仅使用 qt 编程，没有必要使用 cmake，因为 qmake 管理 Qt 工程的专业性和自动化程度比

cmake 要高很多。

首先，在/backup 目录建立一个 cmake 目录，用来放置我们学习过程中的所有练习。mkdir -p /backup/

cmake 以后我们所有的 cmake 练习都会放在/backup/cmake 的子目录下(你也可以自行安排目录，这个

并不是限制，仅仅是为了叙述的方便) 然后在 cmake 建立第一个练习目录 t1

cd /backup/cmake

mkdir t1

cd t1

在 t1 目录建立 main.c 和 CMakeLists.txt(注意文件名大小写)：

main.c 文件内容：

//main.c

#include <stdio.h>

int main()

SET(SRC_LIST main.c)

MESSAGE(STATUS "This is BINARY dir " ${HELLO_BINARY_DIR})

MESSAGE(STATUS "This is SOURCE dir "${HELLO_SOURCE_DIR})

ADD_EXECUTABLE(hello SRC_LIST)

2，开始构建

所有的文件创建完成后，t1 目录中应该存在 main.c 和 CMakeLists.txt 两个文件

cmake . (注意命令后面的点号，代表本目录)。

-- Check for working C compiler: /usr/bin/gcc

-- This is SOURCE dir /backup/cmake/t1

-- Configuring done

-- Generating done

-- Build files have been written to: /backup/cmake/t1

CMakeFiles, CMakeCache.txt, cmake_install.cmake 等文件，并且生成了

Makefile.

Makefile.

如果你需要看到 make 构建的详细过程，可以使用 make VERBOSE=1 或者 VERBOSE=1

make 命令来进行构建。

这时候，我们需要的目标文件 hello 已经构建完成，位于当前目录，尝试运行一下：

./hello

Hello World from Main

恭喜您，到这里为止您已经完全掌握了 cmake 的使用方法。

3，简单的解释：

我们来重新看一下 CMakeLists.txt，这个文件是 cmake 的构建定义文件，文件名是大小写相关的，

如果工程存在多个目录，需要确保每个要管理的目录都存在一个 CMakeLists.txt。(关于多目录构建，后

ADD_EXECUTABLE(hello ${SRC_LIST})

PROJECT 指令的语法是：

PROJECT(projectname [CXX] [C] [Java])

情况表示支持所有语言。这个指令隐式的定义了两个 cmake 变量:<projectname>_BINARY_DIR 以及

<projectname>_SOURCE_DIR，这里就是 HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR(所

以 CMakeLists.txt 中两个 MESSAGE 指令可以直接使用了这两个变量)，因为采用的是内部编译，两个

变量目前指的都是工程所在路径/backup/cmake/t1，后面我们会讲到外部编译，两者所指代的内容会有

所不同。同时 cmake 系统也帮助我们预定义了 PROJECT_BINARY_DIR 和

PROJECT_SOURCE_DIR 变量，他们的值分别跟 HELLO_BINARY_DIR 与