以下内容为本人的著作,如需要转载,请声明原文链接微信公众号「englyf」https://www.cnblogs.com/englyf/p/16667896.html


1. cmake 是什么?

这些年大型 C/C++ 工程都纷纷转到了 cmake 环境下,那么这个工具到底有什么魅力吸引着大家呢?无它,软件工程崇尚实用主义,而 cmake 的功能强悍而灵活,趁手的工具用起来!为了从 makefile 下解放大伙的双手,cmake 在设计之初的目标就是奔着用于对程序构建过程进行管理,它会自动对工程生成相应的 makefile 和其它辅助构建信息。

注意:cmake 不是编译器,仅是构建管理工具,比如调度编译器/链接器等等

2. cmake 的配置文件 CMakeLists.txt

使用 cmake 来构建工程成功输出目标文件,这个过程需要依赖于配置的设定。而这个设定存放在文件 CMakeLists.txt 中,每个构建工程都至少有一个这样的文件(如果工程有子工程,那么每个子工程又会有对应的配置文件),该文件可按需定制。一般会在工程的根目录下创建这个文件 CMakeLists.txt。举个栗子,这里有个最简单的配置示例(假设本工程不包含子工程,只有一个源文件 main.cpp 而且存放于工程根目录下):

# 指定最低要求的 cmake 版本 3.10
cmake_minimum_required(VERSION 3.10) # 设置工程名 test
project(test) # 指定编译输出可执行结果文件 test, 指定编译源文件 main.cpp
add_executable(test main.cpp)

当然,除了把配置内容写在配置文件 CMakeLists.txt 中,还可以在执行 cmake 指令时传入多样化的参数,不过通过传参的方式用起来不灵活而且不利于持续输出的开发理念。同一套产品输出给不同的客户时,可以将不同客户的需求转化为不同的配置文件,分别调用于构建目标结果文件。

3. CMakeLists.txt 变量

CMakeLists.txt 文件内部同样支持变量,包括变量定义和引用等。

eg. 定义变量 USE_CUSTOM_SRC,并设置默认值 OFF (如果引用该变量前,没有赋值,那么当前值为默认值):

option (USE_CUSTOM_SRC "something you want to mark" OFF)

或者只是定义变量 USE_CUSTOM_SRC,并赋值 true

SET(USE_CUSTOM_SRC true)

或者通过调用其它程序并接收输出值,跳过定义,如在调用变量 CMAKE_CURRENT_SOURCE_DIR 代表的目录下执行程序 git 带上参数 "log --format='%h' -1" 以获取 SHA1 值并且保存到变量 GIT_SHA1 中。

exec_program(
        "git"
        ${CMAKE_CURRENT_SOURCE_DIR}
        ARGS "log --format='%h' -1"
        OUTPUT_VARIABLE GIT_SHA1
    )

在调用 cmake 时同样可以在传入的参数中指定变量 USE_CUSTOM_SRC 并赋值,变量前加 -D,如:

cmake -DUSE_CUSTOM_SRC=ON

CMakeLists.txt 中,已定义的变量可直接引用:

if(USE_CUSTOM_SRC)
    xxx
else()
    xxx
endif()

4. CMakeLists.txt 定义源码相关的宏定义

如果需要为源码编译器添加宏定义呢?

如下:

add_definitions(-DUSE_CUSTOM_SRC)

这段语句定义了适用于源代码中的预编译宏 USE_CUSTOM_SRC, 以 -D 为前缀。

注意:这里的 USE_CUSTOM_SRC (适用范围是被 cmake 管理的工程源代码) 与上面的 CMakeLists.txt 变量 USE_CUSTOM_SRC (适用范围是 cmake 读取的 CMakeLists.txt 文件内容内) 不一样

5. 执行方法

先说一下我的环境:

WIN10 + WSL Ubuntu 18.4

wsl 环境下要求安装有cmake、gcc、g++ 等基本工具。

首先进入 wsl 环境,看一下当前的工作目录内容:

admin@DESKTOP:/mnt/g/test$ ls -l
total 0
-rwxrwxrwx 1 root root 89 Jun 26 16:12 CMakeLists.txt
-rwxrwxrwx 1 root root 354 Jun 26 17:13 main.cpp

源文件 main.cpp 实现了执行指令 ls -l . 的功能,下面是文件内容

#include <unistd.h>
#include <stdio.h> int main()
{
pid_t pid = fork();
if (pid == -1) {
perror("fork error");
} if (pid == 0) {
execl("/bin/ls", "ls", "-l", ".", (char *)NULL);
} return 0;
}

创建构建输出目录 build,然后导航到输出目录

mkdir build
cd build

执行 cmake,输入参数是存放 CMakeLists.txt 文件的相对目录,目的是配置构建工程和生成用于原生构建的必需信息并保存到当前目录文件中,也就是所谓的配置构建系统

admin@DESKTOP:/mnt/g/test/build$ cmake ../
-- The C compiler identification is GNU 7.5.0
-- The CXX compiler identification is GNU 7.5.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
-- Configuring done
-- Generating done
-- Build files have been written to: /mnt/g/test/build

再次执行 cmake,调用当前目录的构建系统实现项目构建,包括编译/链接和输出二进制目标文件。

admin@DESKTOP:/mnt/g/test/build$ cmake --build .
Scanning dependencies of target test
[ 50%] Building CXX object CMakeFiles/test.dir/main.cpp.o
[100%] Linking CXX executable test
[100%] Built target test

这一步的操作其实也可以直接调用make实现,比如需要用到加速的选项-j等就比较推荐这样子调用

make -jn

看一下输出的二进制目标文件是否存在

admin@DESKTOP:/mnt/g/test/build$ ls -l
total 40
-rwxrwxrwx 1 root root 12704 Jul 12 21:34 CMakeCache.txt
drwxrwxrwx 1 root root 512 Jul 12 21:39 CMakeFiles
-rwxrwxrwx 1 root root 4847 Jul 12 21:34 Makefile
-rwxrwxrwx 1 root root 1552 Jul 12 21:34 cmake_install.cmake
-rwxrwxrwx 1 root root 8392 Jul 12 21:39 test

最后执行一下目标文件,看看实际执行结果和代码的意图是否一致

admin@DESKTOP:/mnt/g/test/build$ ./test
total 40
-rwxrwxrwx 1 root root 12704 Jul 12 21:34 CMakeCache.txt
drwxrwxrwx 1 root root 512 Jul 12 21:39 CMakeFiles
-rwxrwxrwx 1 root root 4847 Jul 12 21:34 Makefile
-rwxrwxrwx 1 root root 1552 Jul 12 21:34 cmake_install.cmake
-rwxrwxrwx 1 root root 8392 Jul 12 21:39 test

好了,简简单单介绍到这里,欢迎留言交流_

cmake 入门笔记的更多相关文章

  1. MySQL入门笔记

    MySQL入门笔记 版本选择: 5.x.20 以上版本比较稳定 一.MySQL的三种安装方式: 安装MySQL的方式常见的有三种: ·          rpm包形式 ·          通用二进制 ...

  2. CMake学习笔记四:usb_cam的CMakeLists解析

    最近在学习cmake,在完整看了<cmake实践>一书后,跟着书上例程敲了跑了一遍,也写了几篇相关读书笔记,算是勉强基本入门了.所以找了usb_cam软件包的CMakeLists.txt来 ...

  3. Android NDK JNI 入门笔记-day04-NDK实现Hash算法

    * Android NDK JNI 入门笔记目录 * 开头 前面的学习,我们已经掌握了 NDK 开发的必备知识. 下一步就要多实践,通过创造问题并解决问题,来增加熟练度,提升经验. 日常开发中,经常会 ...

  4. 每天成长一点---WEB前端学习入门笔记

    WEB前端学习入门笔记 从今天开始,本人就要学习WEB前端了. 经过老师的建议,说到他每天都会记录下来新的知识点,每天都是在围绕着这些问题来度过,很有必要每天抽出半个小时来写一个知识总结,及时对一天工 ...

  5. ES6入门笔记

    ES6入门笔记 02 Let&Const.md 增加了块级作用域. 常量 避免了变量提升 03 变量的解构赋值.md var [a, b, c] = [1, 2, 3]; var [[a,d] ...

  6. [Java入门笔记] 面向对象编程基础(二):方法详解

    什么是方法? 简介 在上一篇的blog中,我们知道了方法是类中的一个组成部分,是类或对象的行为特征的抽象. 无论是从语法和功能上来看,方法都有点类似与函数.但是,方法与传统的函数还是有着不同之处: 在 ...

  7. React.js入门笔记

    # React.js入门笔记 核心提示 这是本人学习react.js的第一篇入门笔记,估计也会是该系列涵盖内容最多的笔记,主要内容来自英文官方文档的快速上手部分和阮一峰博客教程.当然,还有我自己尝试的 ...

  8. redis入门笔记(2)

    redis入门笔记(2) 上篇文章介绍了redis的基本情况和支持的数据类型,本篇文章将介绍redis持久化.主从复制.简单的事务支持及发布订阅功能. 持久化 •redis是一个支持持久化的内存数据库 ...

  9. redis入门笔记(1)

    redis入门笔记(1) 1. Redis 简介 •Redis是一款开源的.高性能的键-值存储(key-value store).它常被称作是一款数据结构服务器(data structure serv ...

随机推荐

  1. Web思维导图实现的技术点分析(附完整源码)

    简介 思维导图是一种常见的表达发散性思维的有效工具,市面上有非常多的工具可以用来画思维导图,有免费的也有收费的,此外也有一些可以用来帮助快速实现的JavaScript类库,如:jsMind.KityM ...

  2. 一条update语句到底加了多少锁?带你深入理解底层原理

    迎面走来了你的面试官,身穿格子衫,挺着啤酒肚,发际线严重后移的中年男子. 手拿泡着枸杞的保温杯,胳膊夹着MacBook,MacBook上还贴着公司标语:"我爱加班". 面试开始,直 ...

  3. 记一次排查线上MySQL死锁过程,不能只会curd,还要知道加锁原理

    昨晚我正在床上睡得着着的,突然来了一条短信. 啥,线上MySQL死锁了,我赶紧登录线上系统,查看业务日志. 能清楚看到是这条insert语句发生了死锁. MySQL如果检测到两个事务发生了死锁,会回滚 ...

  4. Google Colab初次使用

    网页无法加载,出现HTTP ERROR 407 开启chrome时不要在最下面的固定栏打开,否则会出错.

  5. NC16561 [NOIP2012]国王的游戏

    NC16561 [NOIP2012]国王的游戏 题目 题目描述 恰逢 H 国国庆,国王邀请 \(n\) 位大臣来玩一个有奖游戏.首先,他让每个大臣在左.右手上面分别写下一个整数,国王自己也在左.右手上 ...

  6. ClickHouse(03)ClickHouse怎么安装和部署

    本文会介绍如何安装和部署ClickHouse,官方推荐的几种安装模式,以及安装之后如何启动,ClickHouse集群如何配置等. 简单来说,ClickHouse的搭建流程如下: 环境检查,环境依赖安装 ...

  7. 关于 用fscanf读文件,把文件中用##分割的内容分开

    今天呀,被学弟问了一个问题 文件里存的是"123##456##0##1644444.....##" 为什么用fscanf(fp, "%s##%s......", ...

  8. DENIED Redis is running in protected mode because protected mode is enabled

    DENIED Redis is running in protected mode because protected mode is enabled redisson连接错误 Unable to i ...

  9. Operating System_via牛客网

    题目 链接:https://ac.nowcoder.com/acm/contest/28537/F 来源:牛客网 时间限制:C/C++ 1秒,其他语言2秒 空间限制:C/C++ 131072K,其他语 ...

  10. 1.9. 触摸按钮(touch pad)测试

    1.9.1. 基础 Esp32部分GPIO内置了touch按钮功能(电容式),具体有touch功能的引脚在配置为touchpad后,单片机读入的电容值随是否被触碰发生变化,系统根据电容值的变化判断判断 ...