Cmake Practice(一)

最近在编译安装OpenCV和OpenGL的时候,发现构建系统都换成了cmake自动生成Makefile,确实方便了不少,因此打算学习下cmake的语法规则.

参考书籍<< Cmake Practice>>,这个学习笔记也是参考这本书来练习的.
全部代码路径:https://github.com/xuewend/learn-cmake

一.背景知识：
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作为自己的构建系统。在迁移过程中，进展异常的顺利，并获得了cmake开发者的支持。所以，目前的KDE4开发版本已经完全使用cmake来进行构建。像kdesvn,rosegarden等项目也开始使用cmake，这也注定了cmake必然会成为一个主流的构建体系。

二.安装cmake
linux用户可以先查查本机是否安装了cmake

~$ cmake --versioncmake version 3.5.1CMake suite maintained and supported by Kitware (kitware.com/cmake).

也可以去cmake官网下载安装

三.初试cmake – cmake的helloworld
1.准备工作：
新建一个学习目录

mkdir leran-cmakecd leran-cmakemkdir practice1cd practice1

新建建立main.c

//main.c#include <stdio.h>int main(){    printf("Hello World!\n");    return 0;}

新建CMakeLists.txt

PROJECT(HELLO)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.开始构建

cmake .make./helloHello World!

3.简单的解释：
我们来重新看一下CMakeLists.txt，这个文件是cmake的构建定义文件，文件名是大小写相关的，如果工程存在多个目录，需要确保每个要管理的目录都存在一个CMakeLists.txt。(关于多目录构建，后面我们会提到，这里不作过多解释)。

PROJECT指令的语法是:
PROJECT(projectname [CXX] [C] [Java])
你可以用这个指令定义工程名称，并可指定工程支持的语言，支持的语言列表是可以忽略的，默认情况表示支持所有语言。

这个指令隐式的定义了两个cmake变量:
_BINARY_DIR以及_SOURCE_DIR，
这里就是 HELLO_BINARY_DIR和HELLO_SOURCE_DIR(所以CMakeLists.txt中两个MESSAGE指令可以直接使用了这两个变量)，因为采用的是内部编译，两个变量目前指的都是工程所在路径/leran-cmake/practice1/，后面我们会讲到外部编译，两者所指代的内容会有所不同。同时cmake系统也帮助我们预定义了PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR变量，他们的值分别跟HELLO_BINARY_DIR与HELLO_SOURCE_DIR一致。 为了统一起见，建议以后直接使用PROJECT_BINARY_DIR，PROJECT_SOURCE_DIR，即使修改了工程名称，也不会影响这两个变量。如果使用了 _SOURCE_DIR ，修改工程名称后，需要同时修改这些变量。

SET指令的语法是：
SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
现阶段，你只需要了解SET指令可以用来显式的定义变量即可。 比如我们用到的是SET(SRC_LIST main.c)，如果有多个源文件，也可以定义成：SET(SRC_LIST main.c t1.c t2.c).

MESSAGE指令的语法是：
MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] “message to display” …)
这个指令用于向终端输出用户定义的信息，包含了三种类型:SEND_ERROR，产生错误，生成过程被跳过。SATUS—，输出前缀为的信息。
FATAL_ERROR，立即终止所有cmake过程. 我们在这里使用的是STATUS信息输出，演示了由PROJECT指令定义的两个隐式变量HELLO_BINARY_DIR和HELLO_SOURCE_DIR。

ADD_EXECUTABLE(hello ${SRC_LIST})
定义了这个工程会生成一个文件名为hello的可执行文件，相关的源文件是SRC_LIST中 定义的源文件列表，本例中你也可以直接写成ADD_EXECUTABLE(hello main.c)。

在本例我们使用了${}来引用变量，这是cmake的变量应用方式，但是，有一些例外，比如在IF控制语句，变量是直接使用变量名引用，而不需要${}。如果使用了${}去应用变量，其实IF会去判断名为${}所代表的值的变量，那当然是不存在的了。

将本例改写成一个最简化的CMakeLists.txt：
PROJECT(HELLO)
ADD_EXECUTABLE(hello main.c)

4，基本语法规则
前面提到过，cmake”其实仍然要使用cmake”语言和语法去构建，上面的内容就是所谓的”cmake”语言和语法，最简单的语法规则是：
1，变量使用${}方式取值，但是在IF控制语句中是直接使用变量名
2，指令(参数1 参数2…) 参数使用括弧括起，参数之间使用空格或分号分开。 以上面的ADD_EXECUTABLE指令为例，如果存在另外一个func.c源文件，就要写成：ADD_EXECUTABLE(hello main.c func.c)或者ADD_EXECUTABLE(hello main.c;func.c)
3，指令是大小写无关的，参数和变量是大小写相关的。但，推荐你全部使用大写指令。

上面的MESSAGE指令我们已经用到了这条规则：
MESSAGE(STATUS “This is BINARY dir” ${HELLO_BINARY_DIR})

也可以写成：
MESSAGE(STATUS “This is BINARY dir ${HELLO_BINARY_DIR}”)

这里需要特别解释的是作为工程名的HELLO和生成的可执行文件hello是没有任何关系的。
hello定义了可执行文件的文件名，你完全可以写成：ADD_EXECUTABLE(t1 main.c)
编译后会生成一个t1可执行文件。

5，关于语法的疑惑
cmake的语法还是比较灵活而且考虑到各种情况，比如 SET(SRC_LIST main.c)也可以写成SET(SRC_LIST “main.c”) 是没有区别的，但是假设一个源文件的文件名是fu nc.c(文件名中间包含了空格)。这时候就必须使用双引号，如果写成了SET(SRC_LIST fu nc.c)，就会出现错误，提示你找不到fu文件和nc.c文件。这种情况，就必须写成:SET(SRC_LIST “fu nc.c”)

此外，你可以可以忽略掉source列表中的源文件后缀，比如可以写成 ADD_EXECUTABLE(t1 main)，cmake会自动的在本目录查找main.c或者main.cpp等，当然，最好不要偷这个懒，以免这个目录确实存在一个main.c一个main.

同时参数也可以使用分号来进行分割。下面的例子也是合法的： ADD_EXECUTABLE(t1 main.c t1.c)可以写成ADD_EXECUTABLE(t1 main.c; t1.c). 我们只需要在编写CMakeLists.txt时注意形成统一的风格即可。

6，清理工程:

跟经典的autotools系列工具一样，运行:make clean 即可对构建结果进行清理。

7，问题?问题!
“我尝试运行了make distclean，这个指令一般用来清理构建过程中产生的中间文件的，如果要发布代码，必然要清理掉所有的中间文件，但是为什么在cmake工程中这个命令是” 无效的？是的，cmake并不支持make distclean，关于这一点，官方是有明确解释的: 因为CMakeLists.txt可以执行脚本并通过脚本生成一些临时文件，但是却没有办法来跟踪这些临时文件到底是哪些。因此，没有办法提供一个可靠的make distclean方案。

Some build trees created with GNU autotools have a “make distclean” target that cleans the build and also removes Makefiles and other parts of the generated build system. CMake does not generate a “make distclean” target because CMakeLists.txt files can run scripts and arbitrary commands; CMake has no way of tracking exactly which files are generated as part of running
CMake. Providing a distclean target would give users the false impression that it would work as expected. (CMake does generate a “make clean” target to remove files generated by the compiler and linker.) A “make distclean” target is only necessary if the user performs an in-source build. CMake supports in-source builds, but we strongly encourage users to adopt the notion of an out-of-source build. Using a build tree that is separate from the source tree will prevent CMake from generating any files in the source tree. Because CMake does not change the source tree, there is no need for a distclean target. One can start a fresh build by deleting the build tree or creating a separate build tree.

同时，还有另外一个非常重要的提示，就是：我们刚才进行的是内部构建(in-source build)，而cmake强烈推荐的是外部构建(out-of-source build)。

8，内部构建与外部构建:
对于cmake，内部编译上面已经演示过了，它生成了一些无法自动删除的中间文件，所以，引出了我们对外部编译的探讨，外部编译的过程如下： 1，首先，请清除t1目录中除main.c CmakeLists.txt之外的所有中间文件，最关键的是CMakeCache.txt。 2，在t1目录中建立build 目录，当然你也可以在任何地方建立build目录，不一定必须在工程目录中。 3，进入build目录，运行cmake ..(注意,..代表父目录，因为父目录存在我们需要的CMakeLists.txt，如果你在其他地方建立了build目录，需要运行cmake <工程的全路径>)，查看一下build目录，就会发现了生成了编译需要的Makefile以及其他的中间文件. 4，运行make构建工程，就会在当前目录(build目录)中获得目标文件hello。上述过程就是所谓的out-of-source外部编译，一个最大的好处是，对于原有的工程没有任何影响，所有动作全部发生在编译目录。通过这一点，也足以说服我们全部采用外部编译方式构建工程。
这里需要特别注意的是： 通过外部编译进行工程构建，HELLO_SOURCE_DIR仍然指代工程路径，即/leran-cmake/practice1 而HELLO_BINARY_DIR则指代编译路径，即/leran-cmake/practice1/build

9，小结：
本小节描述了使用cmake构建Hello World程序的全部过程，并介绍了三个简单的指令：PROJECT/MESSAGE/ADD_EXECUTABLE以及变量调用的方法，同时提及了两个隐式变量<projectname>_SOURCE_DIR及<projectname>_BINARY_DIR，演示了变量调用的方法，从这个过程来看，有些开发者可能会想，这实在比我直接写Makefile要复杂多了，甚至我都可以不编写Makefile，直接使用gcc main.c即可生成需要的目标文件。是的，正如第一节提到的，如果工程只有几个文件，还是直接编写Makefile最简单。但是，kdelibs压缩包达到了50多M，您认为使用什么方案会更容易一点呢？
下一节，我们的任务是让HelloWorld看起来更像一个工程。