Cmake Practice 总结 Basics

安装 cmake

参考链接: https://www.cnblogs.com/6b7b5fc3/p/12715954.html

安装命令

sudo apt install cmake

初试 cmake

准备工作

建立一个 cmake_practice 目录

mkdir -p ~/cmake_practice

然后在 cmake_practice 建立第一个练习目录 t1

cd ~/cmake_practice
mkdir t1
cd t1

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

main.c 文件内容：

//main.c
#include <stdio.h>
int main()
{
printf(“Hello World from t1 Main!\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)

开始构建

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

接下来我们来构建这个工程，在这个目录运行

cmake .

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

再让我们看一下目录中的内容：
你会发现，系统自动生成了：CMakeFiles, CMakeCache.txt, cmake_install.cmake 等文件，并且生成了Makefile. 现在不需要理会这些文件的作用，以后你也可以不去理会。最关键的是，它自动生成了Makefile.

然后进行工程的实际构建，在这个目录输入 make 命令. 如果你需要看到 make 构建的详细过程，可以使用 make VERBOSE=1 命令来进行构建。

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

./hello

得到输出：

Hello World from Main

简单的解释

我们来重新看一下 CMakeLists.txt，这个文件是 cmake 的构建定义文件，文件名是大小写相关的，如果工程存在多个目录，需要确保每个要管理的目录都存在一个CMakeLists.txt.

project 指令的语法是：

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

你可以用这个指令定义工程名称，并可指定工程支持的语言，支持的语言列表是可以忽略的，默认情况表示支持所有语言。这个指令隐式的定义了两个cmake变量:projectname_BINARY_DIR 以及projectname_SOURCE_DIR，这里就是HELLO_BINARY_DIR和HELLO_SOURCE_DIR(所以CMakeLists.txt中两个message指令可以直接使用了这两个变量)，因为采用的是内部编译，两个变量目前指的都是工程所在路径/home/xiao/cmake_practice/t1/，后面我们会讲到外部编译，两者所指代的内容会有所不同。
同时 cmake 系统也帮助我们预定义了 PROJECT_BINARY_DIR 和 PROJECT_SOURCE_DIR 变量，他们的值分别跟 HELLO_BINARY_DIR 与 HELLO_SOURCE_DIR 一致。为了统一起见，建议以后直接使用 PROJECT_BINARY_DIR，PROJECT_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，产生错误，生成过程被跳过。
STATUS，输出前缀为 -- 的信息。
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)

基本语法规则

前面提到过，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. 指令是大小写无关的，参数和变量是大小写相关的。

这里需要特别解释的是作为工程名的 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”)

同时参数也可以使用分号来进行分割。
下面的例子也是合法的：

ADD_EXECUTABLE(t1 main.c t1.c)

可以写成

ADD_EXECUTABLE(t1 main.c;t1.c)

我们只需要在编写 CMakeLists.txt 时注意形成统一的风格即可。

内部构建与外部构建

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

外部构建:

1. 在 t1 目录中建立 build 目录
2. 进入 build 目录，运行 cmake ..
3. 运行 make 构建工程

这里需要特别注意的是：
通过外部编译进行工程构建，PROJECT_SOURCE_DIR 仍然指代工程路径，即 /home/xiao/cmake_practice/t1
而 PROJECT_BINARY_DIR 则指代编译路径，即 /home/xiao/cmake_practice/t1/build