3.初试cmake-cmake的helloworld

cmake快速入门教程代码
本节选择了一个最简单的例子 Helloworld 来演练一下 cmake 的完整构建过程,本节并不会深入的探讨 cmake,仅仅展示一个简单的例子,并加以粗略的解释。

1.准备工作

首先,建立cmake文件夹

mkdir cmake

以后我们所有的cmake练习都会放在这个目录下
然后,在cmake建立第一个练习目录t1

mdkir t1
cd t1

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

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

CMakeLists.txt文件内容

cmake_minimum_required(VERSION 3.0.0)
project(hello)
 
set(SRC_LIST main.c)
 
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")

add_executable(hello ${SRC_LIST})

2.开始构建

所有的文件创建完成后,t1 目录中应该存在 main.c 和 CMakeLists.txt
我们可以使用tree命令进行查看当前目录的结构和文件:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# tree
.
├── CMakeLists.txt
└── main.c

0 directories, 2 files

两个文件接下来我们来构建这个工程,在这个目录运行:

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

输出大概是这个样子:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# cmake .
-- The C compiler identification is GNU 9.4.0
-- The CXX compiler identification is GNU 9.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- 1.PROJECT_BINARY_DIR=/mnt/d/study/lwstudy/cmake/t1
-- 1.PROJECT_BINARY_DIR=/mnt/d/study/lwstudy/cmake/t1
-- Configuring done
-- Generating done
-- Build files have been written to: /mnt/d/study/lwstudy/cmake/t1
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1#

再让我们看一下目录中的内容
你会发现,系统自动生成了:
CMakeFiles, CMakeCache.txt, cmake_install.cmake 等文件,并且生成了Makefile:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# tree -L 1
.
├── CMakeCache.txt
├── CMakeFiles
├── CMakeLists.txt
├── Makefile
├── cmake_install.cmake
├── hello
└── main.c

1 directory, 6 files

现在不需要理会这些文件的作用,以后你也可以不去理会。最关键的是,它自动生成了Makefile
然后进行工程的实际构建,在这个目录输入 make 命令,大概会得到如下的彩色输出:

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# make
Scanning dependencies of target hello
[ 50%] Building C object CMakeFiles/hello.dir/main.c.o
[100%] Linking C executable hello
[100%] Built target hello
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1#

如果你需要看到 make 构建的详细过程,可以使用 make VERBOSE=1 或者 VERBOSE=1 make 命令来进行构建。

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# make VERBOSE=1
/usr/bin/cmake -S/mnt/d/study/lwstudy/cmake/t1 -B/mnt/d/study/lwstudy/cmake/t1 --check-build-system CMakeFiles/Makefile.cmake 0
/usr/bin/cmake -E cmake_progress_start /mnt/d/study/lwstudy/cmake/t1/CMakeFiles /mnt/d/study/lwstudy/cmake/t1/CMakeFiles/progress.marks
make -f CMakeFiles/Makefile2 all
make[1]: Entering directory '/mnt/d/study/lwstudy/cmake/t1'
make -f CMakeFiles/hello.dir/build.make CMakeFiles/hello.dir/depend
make[2]: Entering directory '/mnt/d/study/lwstudy/cmake/t1'
cd /mnt/d/study/lwstudy/cmake/t1 && /usr/bin/cmake -E cmake_depends "Unix Makefiles" /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1/CMakeFiles/hello.dir/DependInfo.cmake --color=
make[2]: Leaving directory '/mnt/d/study/lwstudy/cmake/t1'
make -f CMakeFiles/hello.dir/build.make CMakeFiles/hello.dir/build
make[2]: Entering directory '/mnt/d/study/lwstudy/cmake/t1'
make[2]: Nothing to be done for 'CMakeFiles/hello.dir/build'.
make[2]: Leaving directory '/mnt/d/study/lwstudy/cmake/t1'
[100%] Built target hello
make[1]: Leaving directory '/mnt/d/study/lwstudy/cmake/t1'
/usr/bin/cmake -E cmake_progress_start /mnt/d/study/lwstudy/cmake/t1/CMakeFiles 0
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# VERBOSE=1 make
/usr/bin/cmake -S/mnt/d/study/lwstudy/cmake/t1 -B/mnt/d/study/lwstudy/cmake/t1 --check-build-system CMakeFiles/Makefile.cmake 0
/usr/bin/cmake -E cmake_progress_start /mnt/d/study/lwstudy/cmake/t1/CMakeFiles /mnt/d/study/lwstudy/cmake/t1/CMakeFiles/progress.marks
make -f CMakeFiles/Makefile2 all
make[1]: Entering directory '/mnt/d/study/lwstudy/cmake/t1'
make -f CMakeFiles/hello.dir/build.make CMakeFiles/hello.dir/depend
make[2]: Entering directory '/mnt/d/study/lwstudy/cmake/t1'
cd /mnt/d/study/lwstudy/cmake/t1 && /usr/bin/cmake -E cmake_depends "Unix Makefiles" /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1 /mnt/d/study/lwstudy/cmake/t1/CMakeFiles/hello.dir/DependInfo.cmake --color=
make[2]: Leaving directory '/mnt/d/study/lwstudy/cmake/t1'
make -f CMakeFiles/hello.dir/build.make CMakeFiles/hello.dir/build
make[2]: Entering directory '/mnt/d/study/lwstudy/cmake/t1'
make[2]: Nothing to be done for 'CMakeFiles/hello.dir/build'.
make[2]: Leaving directory '/mnt/d/study/lwstudy/cmake/t1'
[100%] Built target hello
make[1]: Leaving directory '/mnt/d/study/lwstudy/cmake/t1'
/usr/bin/cmake -E cmake_progress_start /mnt/d/study/lwstudy/cmake/t1/CMakeFiles 0
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1#

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

./hello

得到输出:
Hello World from Main

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# ./hello
Hello World from t1 Main!
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1#

恭喜您,到这里为止您已经完全掌握了 cmake 的使用方法

3.简单的解释

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

cmake_minimum_required(VERSION 3.0.0)
project(hello)
 
set(SRC_LIST main.c)
 
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")
message(STATUS "1.PROJECT_BINARY_DIR=${PROJECT_BINARY_DIR}")

add_executable(hello ${SRC_LIST})

cmake_minimum_required 语法是:
cmake_minimum_required(VERSION <min>[…<policy_max>] [FATAL_ERROR])
该命令指明了对cmake的最低(高)版本的要求,…为低版本和高版本之间的连接符号,没有其他含义
可通过cmake --version命令查看当前版本

root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# cmake --version
cmake version 3.16.3

CMake suite maintained and supported by Kitware (kitware.com/cmake).
root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1#

PROJECT的语法是:
PROJECT(projectname [CXX] [C] [Java])
你可以用这个指令定义工程名称,并可指定工程支持的语言,支持的语言列表是可以忽略的,默认情况表示支持所有语言。这个指令隐式的定义了两个 cmake 变量: <projectname>_BINARY_DIR 以及<projectname>_SOURCE_DIR,这里就是hello_BINARY_DIR 和 hello_SOURCE_DIR,因为采用的是内部编译,两个变量目前指的都是工程所在路径/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(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 过程

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 语言和语法",最简单的语法规则是:

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

  • 指令(参数 1 参数 2…)
    参数使用括弧括起,参数之间使用空格或分号分开。

    以上面的 ADD_EXECUTABLE 指令为例,如果存在另外一个 func.c 源文件,就要写成:
    ADD_EXECUTABLE(hello main.c func.c)或者
    ADD_EXECUTABLE(hello main.c;func.c)

  • 指令是大小写无关的,参数和变量是大小写相关的

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.清理工程

运行:
make clean
即可对构建结果进行清理

7.内部构建与外部构建

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

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

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

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

    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# tree
    .
    ├── CMakeLists.txt
    ├── build
    └── main.c
    
    1 directory, 2 files
    
  • 进入 build 目录,运行 cmake …(注意,…代表父目录,因为父目录存在我们需要的CMakeLists.txt,如果你在其他地方建立了 build 目录,需要运行 cmake <工程的全路径>),查看一下 build 目录,就会发现了生成了编译需要的 Makefile 以及其他的中间文件

    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1# cd build/
    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1/build# ls
    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1/build# cmake ..
    -- The C compiler identification is GNU 9.4.0
    -- The CXX compiler identification is GNU 9.4.0
    -- Check for working C compiler: /usr/bin/cc
    -- Check for working C compiler: /usr/bin/cc -- works
    -- Detecting C compiler ABI info
    -- Detecting C compiler ABI info - done
    -- Detecting C compile features
    -- Detecting C compile features - done
    -- Check for working CXX compiler: /usr/bin/c++
    -- Check for working CXX compiler: /usr/bin/c++ -- works
    -- Detecting CXX compiler ABI info
    -- Detecting CXX compiler ABI info - done
    -- Detecting CXX compile features
    -- Detecting CXX compile features - done
    -- 1.PROJECT_BINARY_DIR=/mnt/d/study/lwstudy/cmake/t1/build
    -- 1.PROJECT_BINARY_DIR=/mnt/d/study/lwstudy/cmake/t1/build
    -- Configuring done
    -- Generating done
    -- Build files have been written to: /mnt/d/study/lwstudy/cmake/t1/build
    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1/build#
    
  • 运行 make 构建工程,就会在当前目录(build 目录)中获得目标文件 hello

    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1/build# make
    Scanning dependencies of target hello
    [ 50%] Building C object CMakeFiles/hello.dir/main.c.o
    [100%] Linking C executable hello
    [100%] Built target hello
    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1/build# ls
    CMakeCache.txt  CMakeFiles  Makefile  cmake_install.cmake  hello
    root@BIH-L-55661:/mnt/d/study/lwstudy/cmake/t1/build#
    

上述过程就是所谓的 out-of-source 外部编译,一个最大的好处是,对于原有的工程没有任何影响,所有动作全部发生在编译目录。通过这一点,也足以说服我们全部采用外部编译方式构建工程

小节

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

下一节,我们的任务是让 HelloWorld 看起来更像一个工程

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

刘大望

谢谢你请的咖啡

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值