Cmake的Hello World

本文介绍如何使用CMake构建一个包含main.c文件的简单项目。通过创建目录、编写CMakeLists.txt文件并执行构建过程,实现了从源代码到可执行文件的自动化流程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.建立“cmake learn"目录,然后在该目录下建立”t1“目录

2.在”t1“目录中建立main.c文件,内容如下

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

3.在”t1“目录下建立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})
4.解释

CMakeLists.txt的文件名是大小写相关的,如果工程存在多个目录,需要确保每个要管理的目录都存在一个CMakeLists.txt。

PROJECT (HELLO)
PROJECT(projectname [CXX] [C] [Java])
你可以用这个指令定义工程名称,并可指定工程支持的语言,支持的语言列表是可以忽略的,默认情况表示支持所有语言。这个指令隐式的定义了两个
cmake变量:<projectname>_BINARY_DIR以及<projectname>_SOURCE_DIR,这里就是HELLO_BINARY_DIR 和 HELLO_SOURCE_DIR(所以CMakeLists.txt中两个MESSAGE指令可以直接使用了这两个变量),因为采用的是内部编译,两个变量目前指的都是工程所在路径,后面我们会讲到外部编译,两者所指代的内容会有所不同。
同时
cmake系统也帮助我们预定义了PROJECT_BINARY_DIRPROJECT_SOURCE_DIR变量,他们的值分别跟HELLO_BINARY_DIRHELLO_SOURCE_DIR一致。为了统一起见,建议以后直接使用PROJECT_BINARY_DIRPROJECT_SOURCE_DIR,即使修改了工程名称,也不会影响这两个变量。如果使用了<projectname>_SOURCE_DIR,修改工程名称后,需要同时修改这些变量。
SET(SRC_LIST main.c)
SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
现阶段,你只需要了解SET指令可以用来显式的定义变量即可。
比如我们用到的是
SET(SRC_LIST main.c),如果有多个源文件,也可以定义成:SET(SRC_LIST main.c t1.c t2.c)。
MESSAGE(STATUS "This is BINARY dir " ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir "${HELLO_SOURCE_DIR})
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)

5.基本语法规则

前面提到过,cmake其实仍然要使用”cmake语言和语法去构建,上面的内容就是所谓的”cmake 语言和语法,最简单的语法规则是:

a,变量使用${}方式取值,但是在IF控制语句中是直接使用变量名

b,指令(参数1参数 2...)
参数使用括弧括起,参数之间使用空格或分号分开。以上面的 ADD_EXECUTABLE 指令为例,如果存在另外一个 func.c 源文件,就要写成:ADD_EXECUTABLE(hello main.c func.c)或者ADD_EXECUTABLE(hello main.c;func.c)

c,指令是大小写无关的,参数和变量是大小写相关的。但,推荐你全部使用大写指令。

6.关于语法的疑惑

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

7.内部构建与外部构建

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

a,首先,请清除t1 目录中除 main.c CmakeLists.txt 之外的所有中间文件,最关键
的是 CMakeCache.txt

b,在t1 目录中建立 build 目录,当然你也可以在任何地方建立 build 目录,不一定必
须在工程目录中。

c,进入build 目录,运行 cmake ..(注意,..代表父目录,因为父目录存在我们需要的CMakeLists.txt,如果你在其他地方建立了build 目录,需要运行 cmake <工程的全
路径>),查看一下build 目录,就会发现了生成了编译需要的 Makefile 以及其他的中间
文件.

d,运行make 构建工程,就会在当前目录(build 目录)中获得目标文件hello
上述过程就是所谓的 out-of-source 外部编译,一个最大的好处是,对于原有的工程没有任何影响,所有动作全部发生在编译目录。通过这一点,也足以说服我们全部采用外部编译方式构建工程。
这里需要特别注意的是:
通过外部编译进行工程构建,HELLO_SOURCE_DIR 仍然指代工程路径,即/backup/cmake/t1,而 HELLO_BINARY_DIR则指代编译路径,即/backup/cmake/t1/build











评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值