如何使用CMake构建c++项目

1. c++项目构建与CMake简介

在Windows系统上我们通常使用 Visual Studio(VS)来生成我们的c++项目。我们只需在VS相应的层次目录中添加相应的文件即可,而不需要手动指定各个文件的具体路径及依赖包含关系。

如何使用CMake构建c++项目

图1. 微软开源的Calculator源码

Linux系统上我们通常使用 CMake来构建c++项目。cmake是一个跨平台的编译工具,CMake 的组态档取名为 CMakeLists.txt。换一个通俗点的意思就是我只需要写一个CMakeLists.txt文件来指明与我的项目有关的文件、依赖等,便可将这个项目正常编译及生成可执行文件。

注:CMake 并不直接建构出最终的软件,而是产生标准的建构档(如 Unix 的 Makefile 或 Windows Visual C++ 的 projects/workspaces),然后再依一般的建构方式使用。即当我们使用 cmake命令后,我们还要使用 make命令生成可执行文件。

2.使用g++编译cpp文件

g++是GNU开发的C++编译器,是GCC(GNU Compiler Collection)GNU编译器套件的组成部分。对应一个简单的c++程序,我们一般可以使用g++命令进行直接编译。

/*文件名为main.cpp*/
#include
int main(){
        std::cout<

我们可以使用如下命令进行编译:

g++ -o hello main.cpp

我们可以看到程序正常编译与执行:

如何使用CMake构建c++项目

图2. Ubuntu下执行g++命令

当然g++以及gcc有较多的命令与功能,这里不再详细展开说明。

3. Cmake入门

3.1 一个简单的CMakeLists.txt:

cmake_minimum_required(VERSION 3.9) #最低版本

project(helloworld VERSION 1.0) #项目名称及自定义版本号
add_executable(hello_cmake main.cpp) #添加生成可执行文件

接下来我们使用 cmake . && make&& ./hello_cmake便可编译、生成与运行我们所编译的文件了。

  • cmake .:在当前目录下生成标准建构档(可以理解为中间文件),这里的 ” .” 指代的是当前目录。
  • make:编译中间文件,生成可执行文件。

如何使用CMake构建c++项目

图3. 执行make命令

  • ./hello_cmake:运行可执行文件。

这样,我们便使用CMake编译与生成了第一个c++文件。到目前为止它与上文中使用到的 g++的作用是一样的。而当一个c++项目越复杂时,使用CMake的优势也将越来越明显。

3.2 创建build文件夹,不同文件分离与有序化

如果你运行了 cmake . && make这两个命令,你就会发现在你的源文件所在的目录下多出了很多其他的文件。这些文件是项目编译中很重要的文件,但其实你可以完全不用去管他。我们只需要关注 CMakeLists.txt源文件

上述问题的解决方法是在项目文件夹中创建一个 build文件用于保存这些”无关紧要的编译文件”——mkdir build

如何使用CMake构建c++项目

图4. 创建build文件夹

这样你只需要进入 build目录使用 cmake .. && make便可以生成二进制文件了(可执行文件)。

注: cmake ..中 ” ..” 指代上一级目录。所以在build目录中使用 cmake ..指代的是:调用上一级目录中的CMakeLists.txt文件,并将生成的中间文件保存在当前目录。

附:对于较大型的c++项目,合理利用文件夹分类文件可以帮到我们很多。例如创建 src文件夹存放源文件(源代码),创建 bin(binary)存放可执行文件,创建 include存放头文件。

3.3 CMake使项目中包含头文件

我们创建一个include目录并在目录下编写一个较为简单的header:

#pragma once
#include
class Blah{
    public:
    inline void boo(){
        std::cout<

然后再在源文件中添加一个 #include "header.h"来引用头文件。这时如果不改变CMakeLists.txt文件,显然源文件并不知道这个header.h的具体位置。

所以,我们需要修改CMakeLists.txt文件(事实上只需要添加一行语句)

cmake_minimum_required(VERSION 3.9)

project(helloworld VERSION 1.0)
add_executable(hello_cmake main.cpp)
target_include_directories(hello_cmake PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

target_include_directories:指定编译给定目标时要使用的include目录。这里即在编译生成hello_make可执行文件时,使用CMakeLists.txt所在的目录下的include目录。 INTERFACE、PUBLIC和PRIVATE关键字用于指定target_include_directories的影响范围 。在引用库路径时使用这个命令更多,这里不在展开。

当然在CMake中 include_directories也可以指定头文件目录。其作用是:将给定的目录添加到编译器用来搜索头文件的目录中。它的范围相较于 target_include_directories更大。不需要针对于某一个给定的目标。所有生成的可执行文件都可以在 include_directories指定的目录下搜索查找头文件。

3.4 CMake处理多个源文件的编译

  1. 修改 add_executable,添加多个源文件,例如:
add_executable(hello_cmake main.cpp src/Blah.cpp)
  1. 通过修改CMakeLists.txt文件指定源文件的路径。

​ 在CMakeLists.txt中添加如下代码即可:

file(GOLB_RECURSE SRC_FILES src/*.cpp)
add_executable(hello ${SRC_FILES})

这里的 ${},相当于一个变量。在CMake中经常使用!

我们可以使用以下语句设置相应路径变量,则MYLIB_INCLUDE_DIRS为设置的路径。

set(MYLIB_INCLUDE_DIRS /tmp/customPATH/include)

3.5 CMake中引用相关文件(library\package)

我们首先需要了解以下概念。

linux下有两种库: 动态库(.so)静态库(.a)(共享库)。二者的不同点在于代码被载入的时刻不同。

  • 静态库的代码在编译过程中已经被载入可执行程序,因此体积比较大。
  • 动态库(共享库)的代码在可执行程序运行时才载入内存,在编译过程中仅简单的引用,因此代码体积比较小。

  • My own lib:

add_library(mylib STATIC lib/blah.cpp) #STATIC 静态 #添加lib
add_executable(hello_cmake main.cpp) #生成可执行文件
target_link_libraries(hello_cmake PUBLIC mylib) #链接库文件
  1. external lib with find_package:

这里以sfml作为外部依赖包为例,它需要首先从软件仓库下载,再在CMakeLists.txt文件中编写如下语句。

find_package(SFML 2 REQUIRED network audio graphics window system)
target_include_directories(hello_cmake PUBLIC ${SFML_INCLUDE_DIR})
target_link_libraries(hello_cmake PUBLIC ${SFML_LIBRARIES} ${SFML_DEPENDENCIES}) #链接库文件

这样我们就可以在源文件中加入相关include语句了。

#include
#include
  1. external lib manually (手动引用库文件)
find_library(MYLIB mylib)
find_library(MYLIB mylib PATHS /tmp/customPATH)

​ find_library可以加入 REQUIRED参数,它表示为如果未找到任何内容,则停止处理并显示错误消息。

3.6 CMake的嵌套使用

主要操作如下:

add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

作用: 添加一个子目录并构建该子目录。

例如在库文件中,我们可能还需要添加头文件的路径。而将其全部写在外部的CMakeLists.txt文件中又会略显臃肿。

这时我们可以在lib文件中,编写一个新的CMakeList.txt,然后仅仅将相关代码放上去。例如

add_library(mylib STATIC blah.cpp) #STATIC 静态 #添加lib
target_include_directories(hello_cmake PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include) #指定头文件

4. 案例代码

cmake_minimum_required(VERSION 3.9)
project(example_test1)
set (EXECUTABLE_OUTPUT_PATH /home/tom/文档/example_test1/bin)
aux_source_directory (/home/tom/文档/example_test1/src SRC_LIST)
include_directories (/home/tom/文档/example_test1/ltkcpp/include)

find_library(LIBLTKCPP libltkcpp_x86_64.a /home/tom/文档/example_test1/ltkcpp/lib)
find_library(LIBLTKCPP_IMPINJ libltkcppimpinj_x86_64.a /home/tom/文档/example_test1/ltkcpp/lib)
it is not recommended to statically link for ssl and crypto libraries
find_library(LIBSSL ssl REQUIRED)
find_library(LIBCRYPTO crypto REQUIRED)
The ETK does not contain a host static library for xml2.  Add the generic
name 'xml2' to link against the dynmaic library when compiling for host.

find_library(LIBXML2 NAMES libxml2.a xml2 REQUIRED)
set(LIBS
    ${LIBLTKCPP}
    ${LIBLTKCPP_IMPINJ}
    ${LIBCRYPTO}
    ${LIBSSL}
    ${LIBXML2}
)

add_executable(main ${SRC_LIST})
target_link_libraries(main PRIVATE ${LIBS})

aux_source_directory (< dir > < variable >) 搜集所有在指定路径下的源文件的文件名,将输出结果列表储存在指定的变量中。

Original: https://www.cnblogs.com/litecdows/p/cmake.html
Author: litecdows
Title: 如何使用CMake构建c++项目

原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/610662/

转载文章受原作者版权保护。转载请注明原作者出处!

(0)

大家都在看

  • Redis高可用架构Sentinel

    1 简介 哨兵是用来解决redis高可用性的,可以监控集群中主从的变化,然后进行故障转移。一套合理的监控机制是Sentinel节点判定节点不可达的重要保证,Redis Sentin…

    Linux 2023年6月13日
    089
  • 干货速看!同行盆友来稿:一文带你搭建K8S高可用集群,以及在上面搭建Prometheus和Grafana。

    写在开篇 kubeadm工具快速部署k8s集群实现故障自动发现、转移及修复,集群中部署prometheus+grafan可实现自动收集集群的各项新性能指标数据,可视化界面提升客户对…

    Linux 2023年6月7日
    083
  • mysql join语句的执行流程是怎么样的

    mysql join语句的执行流程是怎么样的 join语句是使用十分频繁的sql语句,同样结果的join语句,写法不同会有非常大的性能差距。 select * from t1 st…

    Linux 2023年6月8日
    087
  • 刨析一下C++构造析构函数能不能声明为虚函数的背后机理?

    先说结论: &#x6784;&#x9020;&#x51FD;&#x6570;&#x4E0D;&#x80FD;&#x58F0;…

    Linux 2023年6月6日
    086
  • Linux下 lsof 命令详解

    lsof 是 List Open File 的缩写, 它主要用来获取被进程打开文件的信息,我们都知道,在Linux中,一切皆文件,lsof命令可以查看所有已经打开了的文件,比如: …

    Linux 2023年6月13日
    088
  • SQL51 查找字符串中逗号出现的次数

    本题链接本题表结构如下所示。 +—-+————–+ | id | string | +—-+————–+ | 1 | 10,A,B | …

    Linux 2023年6月13日
    082
  • 常见题目

    这几天有朋友反映给小编说让多发点关于面试的文章,小编深知从事IT行业的难处,跳槽多,加班多,薪资不乐观,大多数朋友都想找新的工作,进入一个好的公司,今天小编就给大家带来了C语言面试…

    Linux 2023年6月13日
    087
  • 到底能不能用 join

    互联网上一直流传着各大公司的 MySQL 军规,其中关于 join 的描述,有些公司不推荐使用 join,而有些公司则规定有条件的使用 join, 它们都是教条式的规定,也没有详细…

    Linux 2023年6月13日
    069
  • 如何在shell脚本中传变量的值传给curl

    随着即时通讯的发展,大量的报警媒介已经从以往的邮件转为钉钉,企业微信等聊天工具。当我使用shell脚本来监控 Keepalived的时候,在给curl传递变量的时候无法生效,经过查…

    Linux 2023年6月8日
    084
  • NJU软件分析笔记(1)

    课程链接本次课程主要内容 Compilers and Static Analyzers AST vs. IR IR: Three-Address Code (3AC) 3AC in…

    Linux 2023年6月8日
    0105
  • Mysql数据库 ALTER 基本操作

    背景: ALTER作为DDL语言之一,工作中经常遇到,这里我们简单介绍一下常见的几种使用场景 新建两个测试表offices 和 employess CREATE TABLE off…

    Linux 2023年6月6日
    0101
  • 012 Linux 搞懂用户权限升级(sudo 和 su),包学会😁

    Linux 系统中 root 账号通常用于系统的管理和维护,对操作系统的所有资源具有访问控制权限,当一个普通用户希望执行一些系统维护相关的操作的时候,就需要使用 sudo 命令,临…

    Linux 2023年6月13日
    067
  • python动态网站爬虫实战(requests+xpath+demjson+redis)

    404. 抱歉,您访问的资源不存在。 可能是网址有误,或者对应的内容被删除,或者处于私有状态。 代码改变世界,联系邮箱 contact@cnblogs.com 园子的商业化努力-困…

    Linux 2023年6月7日
    0105
  • 源码安装Nginx以及用systemctl管理

    一、源码安装Nginx: 下载 nginx软件包 进入nginx-1.20.1目录 安装依赖 /configure软件检查( ./configure–prefix=/u…

    Linux 2023年6月13日
    081
  • 【小记】腾讯云 Linux 虚拟机如何正确修改 hosts 文件

    如果直接修改 /etc/hosts 文件,重启后设置会丢失还原,原因是腾讯云虚拟机默认使用了 Cloud-Init 进行初始化操作。 参见:https://cloud.tencen…

    Linux 2023年6月13日
    083
  • __pycache__

    最近在使用python写一个串口模块的时候,偶然发现运行脚本之后,在工程文件夹下面出现了这样一个文件夹__pycache__,所以就特意到网上查了一下这个文件夹是怎么回事。 &am…

    Linux 2023年6月14日
    0102
亲爱的 Coder【最近整理,可免费获取】👉 最新必读书单  | 👏 面试题下载  | 🌎 免费的AI知识星球