CMake实践教程

Cmake实践CmakePractice--Cjacker前言：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的优势在实际使用中不断的体现出来。我们为什么不来认识一下这款优秀的工程构建工具呢？在2006年KDE大会，听cmake开发者当面介绍了cmake之后，我就开始关注cmake，并将cmake纳入了Everest发行版，作为系统默认组件。最近QT-4.3也正式进入了Everest系统，为KDE4构建完成了准备工作。但是，在学习cmake的过程中，发现官方的文档非常的少，而且错误也较多，比如:在介绍FindName模块编写的文档中，模块名称为FOO，但是后面却出现了Foo_FIND_QUIETLY的定义，这显然是错误的，这样的定义永远不可能有效，正确的定义是FOO_FIND_QUIETLY“”。种种原因，促使我开始写一份面向使用和实用的cmake文档，也就是本教程《cmake实践》(CmakePractice)本文档是边学习边编写的成果，更像是一个学习笔记和Tutorial，因此难免有失误或者理解不够透彻的地方，比如，我仍然不能理解为什么绝大部分使用变量的情况要通过${}引用，而在IF语句中却必须直接使用变量名。也希望能够有cmake的高手来指点迷津。补：从cmake的maillist,我找到了一些答案，原文是：The`IF(var)'or`IF(NOTvar)'commandexpects`var'tobethenameofavariable.ThisisstatedinCMake'smanual.So,foryoursituation`IF(${libX})'isthesameas`IF(/usr/lib/xorg)'andthenCMakewillcheckthevalueofthevariablenamed`/usr/lib/xorg'.也就是说IF需要的是变量名而不是变量值这个文档是开放的，开放的目的是为了让更多的人能够读到并且能够修改，任何人都可以对它作出修改和补充，但是，为了大家都能够获得你关于cmake的经验和积累，如果你现错误或者添加了新内容后，请务必CC给我一份，让我们共同把cmake掌握的更好。一，初识cmakeCmake不再使你在构建项目时郁闷地想自杀了.--一位KDE开发者1，背景知识：cmake是kitware公司以及一些开源开发者在开发几个工具套件(VTK)的过程中衍生品，最终形成体系，成为一个独立的开放源代码项目。项目的诞生时间是2001年。其官方网站是，可以通过访问官方网站获得更多关于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必然会成为一个主流的构建体系。2，特点：cmake的特点主要有：1，开放源代码，使用类BSD许可发布。，跨平台，并可生成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，cmake编写的过程实际上是编程的过程，跟以前使用autotools一样，不过你需要编写的是CMakeLists.txt(每个目录一个)”，使用的是cmake”语言和语法。3，cmake跟已有体系的配合并不是特别理想，比如pkgconfig，您在实际使用中会有所体会，虽然有一些扩展可以使用，但并不理想。4，个人的建议：1，如果你没有实际的项目需求，那么看到这里就可以停下来了，因为cmake的学习过程就是实践过程，没有实践，读的再多几天后也会忘记。2，如果你的工程只有几个文件，直接编写Makefile是最好的选择。3，如果使用的是C/C++/Java之外的语言，请不要使用cmake(至少目前是这样)4，如果你使用的语言有非常完备的构建体系，比如java的ant，也不需要学习cmake，虽然有成功的例子，比如QT4.3的csharp绑定qyoto。5，如果项目已经采用了非常完备的工程管理工具，并且不存在维护问题，没有必要迁移到cmake4，如果仅仅使用qt编程，没有必要使用cmake，因为qmake管理Qt工程的专业性和自动化程度比cmake要高很多。二，安装cmake还需要安装吗？cmake目前已经成为各大Linux发行版提供的组件，比如Everest直接在系统中包含，Fedora在extra仓库中提供，所以，需要自己动手安装的可能性很小。如果你使用的操作系统(比如Windows或者某些Linux版本)没有提供cmake或者包含的版本较旧，建议你直接从cmake官方网站下载安装。在这个页面，提供了源代码的下载以及针对各种不同操作系统的二进制下载，可以选择适合自己操作系统的版本下载安装。因为各个系统的安装方式和包管理格式有所不同，在此就不再赘述了，相信一定能够顺利安装cmake。三，初试cmake–cmake的helloworldHelloworld，世界你好本节选择了一个最简单的例子Helloworld来演练一下cmake的完整构建过程，本节并不会深入的探讨cmake，仅仅展示一个简单的例子，并加以粗略的解释。我们选择了EverestLinux作为基本开发平台，因为这个只有一张CD的发行版本，包含了gcc-4.2/gtk/qt3/qt4等完整的开发环境，同时，系统默认集成了cmake最新版本2.4.6。1，准备工作：首先，在/backup目录建立一个cmake目录，用来放置我们学习过程中的所有练习。mkdir-p/backup/cmake以后我们所有的cmake练习都会放在/backup/cmake的子目录下(你也可以自行安排目录，这个并不是限制，仅仅是为了叙述的方便)然后在cmake建立第一个练习目录t1cd/backup/cmakemkdirt1cdt1在t1目录建立main.c和CMakeLists.txt(注意文件名大小写)：main.c文件内容：//main.c#includestdio.hintmain(){printf(“HelloWorldfromt1Main!\n”);return0;}CmakeLists.txt文件内容：PROJECT(HELLO)SET(SRC_LISTmain.c)MESSAGE(STATUSThisisBINARYdir${HELLO_BINARY_DIR})MESSAGE(STATUSThisisSOURCEdir${HELLO_SOURCE_DIR})ADD_EXECUTABLE(helloSRC_LIST)2，开始构建所有的文件创建完成后，t1目录中应该存在main.c和CMakeLists.txt两个文件接下来我们来构建这个工程，在这个目录运行：cmake.(注意命令后面的点号，代表本目录)。输出大概是这个样子：--CheckforworkingCcompiler:/usr/bin/gcc--CheckforworkingCcompiler:/usr/bin/gcc--works--Checksizeofvoid*--Checksizeofvoid*-done--CheckforworkingCXXcompiler:/usr/bin/c++--CheckforworkingCXXcompiler:/usr/bin/c++--works--ThisisBINARYdir/backup/cmake/t1--ThisisSOURCEdir/backup/cmake/t1--Configuringdone--Generatingdone--Buildfileshavebeenwrittento:/backup/cmake/t1再让我们看一下目录中的内容：你会发现，系统自动生成了：CMakeFiles,CMakeCache.txt,cmake_install.cmake等文件，并且生成了Makefile.现在不需要理会这些文件的作用，以后你也可以不去理会。最关键的是，它自动生成了Makefile.然后进行工程的实际构建，在这个目录输入make命令，大概会得到如下的彩色输出：Scanningdependenciesoftargethello[100%]BuildingCobjectCMakeFiles/hello.dir/main.oLinkingCexecutablehello[100%]Builttargethello如果你需要看到make构建的详细过程，可以使用makeVERBOSE=1或者VERBOSE=1make命令来进行构建。这时候，我们需要的目标文件hello已经构建完成，位于当前目录，尝试运行一下：./hello得到输出：HelloWorldfromMain恭喜您，到这里为止您已经完全掌握了cmake的使用方法。3，简单的解释：我们来重新看一下CMakeLists.txt，这个文件是cmake的构建定义文件，文件名是大小写相关的，如果工程存在多个目录，需要确保每个要管理的目录都存在一个CMakeLists.txt。(关于多目录构建，后面我们会提到，这里不作过多解释)。上面例子中的CMakeLists.txt文件内容如下：PROJECT(HELLO)SET(SRC_LISTmain.c)MESSAGE(STATUSThisisBINARYdir${HELLO_BINARY_DIR})MESSAGE(STATUSThisisSOURCEdir${HELLO_SOURCE_DIR})ADD_EXECUTABLE(hello${SRC_LIST})PROJECT指令的语法是：PROJECT(projectname[CXX][C][Java])你可以用这个指令定义工程名称，并可指定工程支持