“5分钟CMake使用指南,解决我的C++打包问题!”

C语言与CPP编程 2024-11-06 09:01

本文经授权转自公众号CSDN(ID:CSDNnews)

作者 | Shrijith Venkatramana
翻译 | 郑丽媛

在软件开发的世界里,构建系统扮演着至关重要的角色,它不仅决定了项目的构建效率,还直接影响到团队协作的流畅度。对于许多 C++ 开发者而言,CMake 因其强大的功能和广泛的兼容性成为了构建自动化流程的首选工具。

原文链接:https://journal.hexmos.com/cmake-survial-guide/


最近我一直在用 C++ 处理一些编程挑战,其中管理 C++ 项目的一个重要方面就是依赖管理。

如今,我们在很多编程生态系统中享受着即时包管理器的便利:

● 在 Node.js/JavaScript 中使用 npm

● 在 Rust 中使用 cargo

● 在 Python 中使用 pip

而在 C++ 中,尽管有像 Conan 这样的包管理器,但处理实际项目时,你通常会发现 CMake 是绕不开的选择。因此如果你想在 C++ 生态系统中工作,学习如何使用 CMake 就不是可选项,而是必修课。

1、CMake 到底是什么,为什么要学它?

CMake 是一个跨平台的构建系统生成器。跨平台这一点非常重要,因为 CMake 能够在一定程度上抽象出不同平台之间的差异。

例如在类 Unix 系统上,CMake 会生成 makefile 文件,然后用这些文件来构建项目。而在 Windows 系统中,CMake 会生成 Visual Studio 项目文件,随后用于构建项目。

需要注意的是,不同平台通常都有各自的编译和调试工具链:Unix 使用 gcc,macOS 使用clang 等等。

在 C++ 生态系统中,另一个重要方面是能同时处理可执行文件和库。

可执行文件可基于以下不同因素:

● 目标 CPU 架构

● 目标操作系统

● 其他因素

对于库来说,链接方式也有不同的选择(链接是指在代码中使用另一个代码库的功能,而无需了解其具体实现):

● 静态链接

● 动态链接

我曾在一些内部原型项目中,需要调用底层操作系统 API 来执行某些任务,唯一可行的高效方法就是基于一些 C++ 库来进行构建。


2、CMake 是如何工作的:三个阶段

1. 配置阶段

CMake 会读取所有的 CMakeLists.txt 文件,并创建一个中间结构来确定后续步骤(如列出源文件、收集要链接的库等)。

2. 生成阶段

基于配置阶段的中间输出,CMake 会生成特定平台的构建文件(如在 Unix 系统上生成 makefiles 等)。

3. 构建阶段

使用特定平台的工具(如 make 或 ninja)来构建可执行文件或库文件。


3、一个简单的 CMake 项目示例(Hello World!)

假设你有一个用于计算数字平方根的 C++ 源文件。

tutorial.cxx

// A simple program that computes the square root of a number#include #include  // TODO 5: Remove this line#include #include 
// TODO 11: Include TutorialConfig.h
int main(int argc, char* argv[]){ if (argc < 2) { // TODO 12: Create a print statement using Tutorial_VERSION_MAJOR // and Tutorial_VERSION_MINOR std::cout << "Usage: " << argv[0] << " number" << std::endl; return 1; }
// convert input to double // TODO 4: Replace atof(argv[1]) with std::stod(argv[1]) const double inputValue = atof(argv[1]);
// calculate square root const double outputValue = sqrt(inputValue); std::cout << "The square root of " << inputValue << " is " << outputValue << std::endl; return 0;}

CMakeLists.txt

project(Tutorial)add_executable(tutorial tutorial.cxx)

上述两行是生成一个可执行文件所需的最少指令。理论上,我们还应该指定 CMake 的最低版本号,省略 CMake 会默认使用某个版本(暂时跳过这部分)。

严格来说,project 指令并非必需,但我们还是保留它。所以最重要的代码行是:

add_executable(tutorial tutorial.cxx)

这行代码指定了目标二进制文件 tutorial 以及源文件 tutorial.cxx。


4、如何构建

以下是一组用于构建项目和测试二进制文件的命令,稍后会详细解释:

mkdir buildcd build/cmake ..ls -l # inspect generated build filescmake --build ../tutorial 10 # test the binary

从上面的步骤可以看到,整个构建过程大约涉及 5-6 个步骤。

首先,在 CMake 中,我们应该将构建相关的内容与源代码分开,所以先创建一个构建目录:

mkdir build

然后我们可以在构建目录中进行所有与构建相关的操作:

cd build

从这一步开始,我们将执行多个构建相关的任务。

先是生成配置文件:

cmake ..

在这一步中,CMake 会生成平台特定的配置文件。在我的 Ubuntu 系统中,我看到了生成的makefile,这些文件相当冗长,但目前我不需要担心它们。

接下来,我根据新生成的文件触发构建:

cmake --build .

这一步使用生成的构建文件,生成目标二进制文件 tutorial。

最后,我可以通过以下命令验证二进制文件是否如预期运行:

./tutorial 16

我得到了预期的答案,这说明构建过程运行正常!


5、在 C++ 项目中注入变量

CMake 通过 Config.h.in 提供了一种机制,允许你在 CMakeLists.txt 中指定变量,这些变量可以在你的 .cpp 文件中使用。

下面是一个示例,我们在 CMakeLists.txt 中定义了项目的版本号,并在程序中使用。

Config.h.in

在这个文件中,来自 CMakeLists.txt 的变量将以 @VAR_NAME@ 的形式出现。

#pragma once
#define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR@#define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR@#define AUTHOR_NAME "@AUTHOR_NAME@"

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)project(Tutorial)
# Define configuration variablesset(PROJECT_VERSION_MAJOR 1)set(PROJECT_VERSION_MINOR 0)set(AUTHOR_NAME "Jith")
# Configure the header fileconfigure_file(Config.h.in Config.h)
# Add the executableadd_executable(tutorial tutorial.cxx)
# Include the directory where the generated header file is locatedtarget_include_directories(tutorial PRIVATE "${CMAKE_BINARY_DIR}")

请注意,我们添加了 cmake_minimum_required 来指定所需的最低 CMake 版本,这是编写 CMakeLists.txt 文件时的一个良好习惯。

然后,我们使用多个 set() 语句来定义所需的变量名。接着,指定配置文件 Config.h.in,通过该文件来使用上述设置的变量。

最后,CMake 会在变量占位被填充后生成头文件,这些动态生成的头文件需要被包含到项目中。

在我们的示例中,Config.h 文件将被放置在 ${CMAKE_BINARY_DIR} 目录中,所以我们只需指定该路径即可。

你可能会对以下这一行的 PRIVATE 标签感到好奇:

target_include_directories(tutorial PRIVATE "${CMAKE_BINARY_DIR}")


6、理解 CMake 的两个关键概念:可见性修饰符和目标

在 CMake 中,有三个可见性修饰符:PRIVATE、PUBLIC、INTERFACE。

这些修饰符可以在命令中使用,例如:target_include_directories 和 target_link_libraries 等。

这些修饰符是在目标(Targets)的上下文中指定的。目标是 CMake 中的一种抽象概念,表示某种类型的输出:

● 可执行目标(通过 add_executable)生成二进制文件

● 库目标(通过 add_library)生成库文件

● 自定义目标(通过 add_custom_target)通过脚本等生成任意文件

所有上述的目标都会产生具体的文件或工件作为输出。库目标的一个特殊情况是接口目标(Interface Target)。接口目标的定义如下:

add_library(my_interface_lib INTERFACE)target_include_directories(my_interface_lib INTERFACE include/)

在这里,my_interface_lib 并不会立即生成任何文件。但在后续阶段,一些具体的目标可能会依赖于 my_interface_lib。这意味着,接口目标中指定的 include 目录也会被依赖。因此,INTERFACE 库可以看作是构建依赖关系树的一种便利机制。

理解了目标和依赖的概念之后,我们就回到可见性修饰符的概念。

PRIVATE 可见性

1target_include_directories(tutorial PRIVATE "${CMAKE_BINARY_DIR}")

PRIVATE 表示目标 tutorial 将使用指定的包含目录。但如果在后续阶段其他目标链接到 tutorial,包含目录将不会传递给那些依赖项。

PUBLIC 可见性

1target_include_directories(tutorial PUBLIC "${CMAKE_BINARY_DIR}")

使用 PUBLIC 修饰符意味着目标 tutorial 需要使用该包含目录,并且任何依赖于 tutorial 的其他目标也会继承这个包含目录。

INTERFACE 可见性

1target_include_directories(tutorial INTERFACE "${CMAKE_BINARY_DIR}")

INTERFACE 修饰符表示 tutorial 本身不需要该包含目录,但任何依赖于 tutorial 的其他目标会继承这个包含目录。

简单总结,可见性修饰符的工作原理如下:

● PRIVATE:源文件和依赖关系只传递给当前目标;

● PUBLIC:源文件和依赖关系传递给当前目标及其依赖的目标;

INTERFACE:源文件和依赖关系不传递给当前目标,但会传递给依赖于它的目标。


7、将项目构建划分为库和目录

随着项目规模不断增长,通常需要模块化来组织项目并管理复杂性。

在 CMake 中,可以用子目录来指定独立的模块及其自定义的构建流程。我们可以拥有一个主 CMake 配置,它能触发多个库(子目录)的构建,最后将所有模块链接在一起。

这是一个经过简化后的示例。我们将创建一个名为 MathFunctions 的模块/库,它将构建为一个静态库(在 Unix 系统上生成 MathFunctions.a),最后再把它链接到我们的主程序中。

首先是源文件部分(代码较为简单):

MathFunctions.h

#pragma once
namespace mathfunctions {double sqrt(double x);}

MathFunctions.cxx

#include "MathFunctions.h"#include "mysqrt.h"
namespace mathfunctions {double sqrt(double x){ return detail::mysqrt(x);}}

mysqrt.h

#pragma once
namespace mathfunctions {namespace detail {double mysqrt(double x);}}

mysqrt.cxx

#include "mysqrt.h"
#include
namespace mathfunctions {namespace detail {// a hack square root calculation using simple operationsdouble mysqrt(double x){ if (x <= 0) { return 0; }
double result = x;
// do ten iterations for (int i = 0; i < 10; ++i) { if (result <= 0) { result = 0.1; } double delta = x - (result * result); result = result + 0.5 * delta / result; std::cout << "Computing sqrt of " << x << " to be " << result << std::endl; } return result;}}}

以上这些代码片段,引入了一个名为 mathfunctions 的命名空间,其中包含了一个自定义的 sqrt 函数实现。这样我们就可以在项目中定义自己的平方根函数,而不会与其他版本的 sqrt 冲突。

接下来,如何将该文件夹构建为 Unix 二进制文件?我们需要为该模块/库创建一个自定义的 CMake 子配置:

MathFunctions/CMakeLists.txt

add_library(MathFunctions MathFunctions.cxx mysqrt.cxx)

通过这条简单的 add_library 指令,我们指定了需要编译的 .cxx 文件来生成库文件。

但这还不够,解决方案的核心在于如何将这个子目录或库链接到我们的主项目中:

tutorial.cxx(使用库/模块版本)

#include "Config.h"#include "MathFunctions.h"#include #include  #include #include 
int main(int argc, char* argv[]){ std::cout << "Project Version: " << PROJECT_VERSION_MAJOR << "." << PROJECT_VERSION_MINOR << std::endl; std::cout << "Author: " << AUTHOR_NAME << std::endl;
if (argc < 2) { std::cout << "Usage: " << argv[0] << " number" << std::endl; return 1; }
const double inputValue = atof(argv[1]);
// use library function const double outputValue = mathfunctions::sqrt(inputValue); std::cout << "The square root of " << inputValue << " is " << outputValue << std::endl; return 0;}

在这个文件中,我们导入了 MathFunctions.h,并使用命名空间 mathfunctions 来调用自定义的 sqrt 函数。我们都知道 MathFunctions.h 位于子目录中,但可以直接引用它,就像它在根目录中似的,这是怎么做到的?答案在于修订后的主 CMake 配置文件中:

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)project(Tutorial)
# Define configuration variablesset(PROJECT_VERSION_MAJOR 1)set(PROJECT_VERSION_MINOR 0)set(AUTHOR_NAME "Jith")
# Configure the header fileconfigure_file(Config.h.in Config.h)
add_subdirectory(MathFunctions)
add_executable(tutorial tutorial.cxx)

target_include_directories(tutorial PUBLIC "${PROJECT_BINARY_DIR}" "${PROJECT_SOURCE_DIR}/MathFunctions")
target_link_libraries(tutorial PUBLIC MathFunctions)

这里有几条新命令:

● add_subdirectory 指定了一个子目录构建,CMake 将负责处理该子目录中的构建任务。

● target_include_directories 告诉 CMake MathFunctions 文件夹的路径,这样我们可以在 tutorial.cxx 中直接引用 MathFunctions.h。

● target_link_libraries 将 MathFunctions 库链接到主程序 tutorial 中。

当我在 Linux 上构建这个项目时,我看到 build/MathFunctions 目录下生成了 libMathFunctions.a 文件,这是一个静态链接的库文件,它已经成为主程序的一部分。

现在,我们还可以随意移动生成的 tutorial 可执行文件,它将继续正常运行,因为 libMathFunctions.a 已经被静态链接进主程序中。


8、下一步是什么?

学习 CMake 的基本工作原理和如何用它完成一些基本任务确实很有意思。

CMake 解决了我现在在 C++ 打包方面遇到的大部分问题。同时,探索 Conan 和 vcpkg 以简化 C++ 中的依赖管理也是一件有趣的事情。未来有机会的话,我应该会进一步了解和尝试这些工具。

本文转自公众号“CSDN”,ID:CSDNnews
EOF

你好,我是飞宇。日常分享C/C++、计算机学习经验、工作体会,欢迎点击此处查看我以前的学习笔记&经验&分享的资源。

我组建了一些社群一起交流,群里有大牛也有小白,如果你有意可以一起进群交流。

欢迎你添加我的微信,我拉你进技术交流群。此外,我也会经常在微信上分享一些计算机学习经验以及工作体验,还有一些内推机会

加个微信,打开另一扇窗

经常遇到有读者后台私信想要一些编程学习资源,这里分享 1T 的编程电子书、C/C++开发手册、Github上182K+的架构路线图、LeetCode算法刷题笔记等精品学习资料,点击下方公众号会回复"编程"即可免费领取~

感谢你的分享,点赞,在看三  

C语言与CPP编程 C语言/C++开发,C语言/C++基础知识,C语言/C++学习路线,C语言/C++进阶,数据结构;算法;python;计算机基础等
评论
  • 根据环洋市场咨询(Global Info Research)项目团队最新调研,预计2030年全球无人机锂电池产值达到2457百万美元,2024-2030年期间年复合增长率CAGR为9.6%。 无人机锂电池是无人机动力系统中存储并释放能量的部分。无人机使用的动力电池,大多数是锂聚合物电池,相较其他电池,锂聚合物电池具有较高的能量密度,较长寿命,同时也具有良好的放电特性和安全性。 全球无人机锂电池核心厂商有宁德新能源科技、欣旺达、鹏辉能源、深圳格瑞普和EaglePicher等,前五大厂商占有全球
    GIRtina 2025-01-07 11:02 51浏览
  • 每日可见的315MHz和433MHz遥控模块,你能分清楚吗?众所周知,一套遥控设备主要由发射部分和接收部分组成,发射器可以将控制者的控制按键经过编码,调制到射频信号上面,然后经天线发射出无线信号。而接收器是将天线接收到的无线信号进行解码,从而得到与控制按键相对应的信号,然后再去控制相应的设备工作。当前,常见的遥控设备主要分为红外遥控与无线电遥控两大类,其主要区别为所采用的载波频率及其应用场景不一致。红外遥控设备所采用的射频信号频率一般为38kHz,通常应用在电视、投影仪等设备中;而无线电遥控设备
    华普微HOPERF 2025-01-06 15:29 117浏览
  • 这篇内容主要讨论三个基本问题,硅电容是什么,为什么要使用硅电容,如何正确使用硅电容?1.  硅电容是什么首先我们需要了解电容是什么?物理学上电容的概念指的是给定电位差下自由电荷的储藏量,记为C,单位是F,指的是容纳电荷的能力,C=εS/d=ε0εrS/4πkd(真空)=Q/U。百度百科上电容器的概念指的是两个相互靠近的导体,中间夹一层不导电的绝缘介质。通过观察电容本身的定义公式中可以看到,在各个变量中比较能够改变的就是εr,S和d,也就是介质的介电常数,金属板有效相对面积以及距离。当前
    知白 2025-01-06 12:04 155浏览
  • By Toradex 秦海1). 简介嵌入式平台设备基于Yocto Linux 在开发后期量产前期,为了安全以及提高启动速度等考虑,希望将 ARM 处理器平台的 Debug Console 输出关闭,本文就基于 NXP i.MX8MP ARM 处理器平台来演示相关流程。 本文所示例的平台来自于 Toradex Verdin i.MX8MP 嵌入式平台。  2. 准备a). Verdin i.MX8MP ARM核心版配合Dahlia载板并
    hai.qin_651820742 2025-01-07 14:52 25浏览
  • 大模型的赋能是指利用大型机器学习模型(如深度学习模型)来增强或改进各种应用和服务。这种技术在许多领域都显示出了巨大的潜力,包括但不限于以下几个方面: 1. 企业服务:大模型可以用于构建智能客服系统、知识库问答系统等,提升企业的服务质量和运营效率。 2. 教育服务:在教育领域,大模型被应用于个性化学习、智能辅导、作业批改等,帮助教师减轻工作负担,提高教学质量。 3. 工业智能化:大模型有助于解决工业领域的复杂性和不确定性问题,尽管在认知能力方面尚未完全具备专家级的复杂决策能力。 4. 消费
    丙丁先生 2025-01-07 09:25 71浏览
  • 在智能家居领域中,Wi-Fi、蓝牙、Zigbee、Thread与Z-Wave等无线通信协议是构建短距物联局域网的关键手段,它们常在实际应用中交叉运用,以满足智能家居生态系统多样化的功能需求。然而,这些协议之间并未遵循统一的互通标准,缺乏直接的互操作性,在进行组网时需要引入额外的网关作为“翻译桥梁”,极大地增加了系统的复杂性。 同时,Apple HomeKit、SamSung SmartThings、Amazon Alexa、Google Home等主流智能家居平台为了提升市占率与消费者
    华普微HOPERF 2025-01-06 17:23 138浏览
  • 彼得·德鲁克被誉为“现代管理学之父”,他的管理思想影响了无数企业和管理者。然而,关于他的书籍分类,一种流行的说法令人感到困惑:德鲁克一生写了39本书,其中15本是关于管理的,而其中“专门写工商企业或为企业管理者写的”只有两本——《为成果而管理》和《创新与企业家精神》。这样的表述广为流传,但深入探讨后却发现并不完全准确。让我们一起重新审视这一说法,解析其中的矛盾与根源,进而重新认识德鲁克的管理思想及其著作的真正价值。从《创新与企业家精神》看德鲁克的视角《创新与企业家精神》通常被认为是一本专为企业管
    优思学院 2025-01-06 12:03 107浏览
  • 本文介绍Linux系统更换开机logo方法教程,通用RK3566、RK3568、RK3588、RK3576等开发板,触觉智能RK3562开发板演示,搭载4核A53处理器,主频高达2.0GHz;内置独立1Tops算力NPU,可应用于物联网网关、平板电脑、智能家居、教育电子、工业显示与控制等行业。制作图片开机logo图片制作注意事项(1)图片必须为bmp格式;(2)图片大小不能大于4MB;(3)BMP位深最大是32,建议设置为8;(4)图片名称为logo.bmp和logo_kernel.bmp;开机
    Industio_触觉智能 2025-01-06 10:43 87浏览
  • 村田是目前全球量产硅电容的领先企业,其在2016年收购了法国IPDiA头部硅电容器公司,并于2023年6月宣布投资约100亿日元将硅电容产能提升两倍。以下内容主要来自村田官网信息整理,村田高密度硅电容器采用半导体MOS工艺开发,并使用3D结构来大幅增加电极表面,因此在给定的占位面积内增加了静电容量。村田的硅技术以嵌入非结晶基板的单片结构为基础(单层MIM和多层MIM—MIM是指金属 / 绝缘体/ 金属) 村田硅电容采用先进3D拓扑结构在100um内,使开发的有效静电容量面积相当于80个
    知白 2025-01-07 15:02 40浏览
  • PLC组态方式主要有三种,每种都有其独特的特点和适用场景。下面来简单说说: 1. 硬件组态   定义:硬件组态指的是选择适合的PLC型号、I/O模块、通信模块等硬件组件,并按照实际需求进行连接和配置。    灵活性:这种方式允许用户根据项目需求自由搭配硬件组件,具有较高的灵活性。    成本:可能需要额外的硬件购买成本,适用于对系统性能和扩展性有较高要求的场合。 2. 软件组态   定义:软件组态主要是通过PLC
    丙丁先生 2025-01-06 09:23 82浏览
  • 根据Global Info Research项目团队最新调研,预计2030年全球封闭式电机产值达到1425百万美元,2024-2030年期间年复合增长率CAGR为3.4%。 封闭式电机是一种电动机,其外壳设计为密闭结构,通常用于要求较高的防护等级的应用场合。封闭式电机可以有效防止外部灰尘、水分和其他污染物进入内部,从而保护电机的内部组件,延长其使用寿命。 环洋市场咨询机构出版的调研分析报告【全球封闭式电机行业总体规模、主要厂商及IPO上市调研报告,2025-2031】研究全球封闭式电机总体规
    GIRtina 2025-01-06 11:10 102浏览
我要评论
0
点击右上角,分享到朋友圈 我知道啦
请使用浏览器分享功能 我知道啦