cmake实践学习（1）

星期六, 07. 一月 2017 05:16下午

学习笔记，来源： cmake实践

准备工作

首先确定自己的编程目录，这里选用：

cd Documents/study/cmake/
mkdir t1 && cd t1

建立main.cpp和CMakeLists.txt

编写程序

main.cpp

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

CMakeLists.txt

PROJECT (HELLO)
SET (SRC_LIST main.cpp)
MESSAGE(STATUS"THISISBINARYdir"${HELLO_BINARY_DIR})
MESSAGE(STATUS"THISISSOURCEdir"${HELLO_SOURCE_DIR})
ADD_EXECUTABLE  (hello SRC_LIST)

编译过程

运行：

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

输出大概是这个样子:

-- Check for working C compiler: /usr/bin/gcc
-- Check for working C compiler: /usr/bin/gcc -- works
-- Check size of void*
-- Check size of void* - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- This is BINARY dir /backup/cmake/t1
-- This is SOURCE dir /backup/cmake/t1
-- Configuring done
-- Generating done
-- Build files have been written to: /backup/cmake/t1

运行（当前目录）：

make

大概会得到如下的彩色输出:

Scanning dependencies of target hello
[100%] Building C object CMakeFiles/hello.dir/main.o
Linking C executable hello
[100%] Built target hello

##简单的解释

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

PROJECT (HELLO)
SET(SRC_LIST main.c)
MESSAGE(STATUS"ThisisBINARYdir"${HELLO_BINARY_DIR})
MESSAGE(STATUS"ThisisSOURCEdir"${HELLO_SOURCE_DIR})
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 与 HELLO_SOURCE_DIR 一致。为了统一起见,建议以后直接使用 PROJECT_BINARY_DIR,PROJECT_SOURCE_DIR,即使修改了工程名称,也不会影响这两个变量。如果使用了<projectname>_SOURCE_DIR ,修改工程名称后,需要同时修改这些变量。

SET 指令

SET 指令的语法是:

SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])

现阶段,你只需要了解 SET 指令可以用来显式的定义变量即可。比如我们用到的是 SET(SRC_LISTmain.c),如果有多个源文件,也可以定义成:SET(SRC_LIST main.c t1.c t2.c)。

MESSAGE 指令

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

ADD_EXECUTABLE(hello${SRC_LIST})

定义了这个工程会生成一个文件名为hello的可执行文件,相关的源文件是SRC_LIST中定义的源文件列表,本例中你也可以直接写成ADD_EXECUTABLE(hellomain.c)。在本例我们使用了${}来引用变量,这是cmake的变量应用方式,但是,有一些例外,比如在IF控制语句,变量是直接使用变量名引用,而不需要${}。如果使用了${}去应用变量,其实IF会去判断名为${}所代表的值的变量,那当然是不存在的了。将本例改写成一个最简化的CMakeLists.txt:

PROJECT(HELLO)
ADD_EXECUTABLE(hello main.c)

基本语法规则

前面提到过,cmake 其实仍然要使用 ” cmake 语言和语法 ” 去构建,上面的内容就是所谓的”cmake 语言和语法 ” ,最简单的语法规则是: 1.变量使用${}方式取值,但是在IF控制语句中是直接使用变量名

指令(参数 1 参数 2…) 参数使用括弧括起,参数之间使用空格或分号分开。以上面的 ADD_EXECUTABLE 指令为例,如果存在另外一个 func.c 源文件,就要写成 ADD_EXECUTABLE(hello main.c func.c) 或者 ADD_EXECUTABLE(hello main.c;func.c)
指令是大小写无关的,参数和变量是大小写相关的。但,推荐你全部使用大写指令。上面的 MESSAGE 指令我们已经用到了这条规则:

MESSAGE(STATUS“ThisisBINARYdir”${HELLO_BINARY_DIR})

也可以写成:

MESSAGE(STATUS“ThisisBINARYdir${HELLO_BINARY_DIR}”)

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

关于语法的疑惑

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 时注意形成统一的风格即可。

清理工程:

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

make clean

即可对构建结果进行清理。

内部构建与外部构建

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

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

小结:

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