如何使用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)

大家都在看

  • [非原创]2048游戏自动化算法

    function AI(grid) { this.grid = grid; } // static evaluation function AI.prototype.eval = …

    Linux 2023年6月13日
    098
  • 一篇文章扒掉“桥梁Handler”的底裤

    Android跨进程要掌握的是Binder, 而同一进程中最重要的应该就是Handler 消息通信机制了。我这么说,大家不知道是否认同,如果认同,还希望能给一个关注哈。 什么是Ha…

    Linux 2023年6月13日
    0100
  • VirtualBox 和宿主机挂载共享文件夹 步骤记录

    问题记录 这个功能不常用(感觉这个步骤很繁琐,用finalshell连ssh就能很溜),但是有时候在公司网络受限的时候安装不了ssh,只能用这个挂载的方式。 防止后期遗忘步骤,我把…

    Linux 2023年6月6日
    0166
  • PHP 获取数组长度

    count()函数,默认是获取一维数组,参数为:COUNT_NORMAL,添加第二个参数:COUNT_RECURSIVE,则可以获取多维关联数组的长度(意思为递归获取),例如:co…

    Linux 2023年6月7日
    0123
  • 整理常用的 vim 命令

    vim 是一款功能强大的文本编辑器,它是Linux下常用的编辑器之一,对于熟练掌握了 vim 的人来说,用它编辑文件,方便又快捷,能极大的提高工作效率 vim 功能强大,对应的命令…

    Linux 2023年6月13日
    0111
  • CentOS 7上安装和配置Ghost

    Ghost是一个轻量级的开源博客平台,易于使用。Ghost是完全可定制的,有许多主题可用。 在本教程中,您将在CentOS 7上设置Ghost。您还将配置Nginx以代理对Ghos…

    Linux 2023年6月13日
    071
  • 修改内核中的只读区内容

    研究到 apparmor 内核源码,其中涉及到只读变量 __lsm_ro_after_init,研究怎么修改只读区实现部分功能,这里记录一下。 思路上很简单,修改的时候禁用写保护,…

    Linux 2023年6月13日
    080
  • GIT使用说明

    1、Git入门教程 1.1:Git入门与使用 (一) Git介绍与安装 1.2:Git入门与使用 (二) Git相关命令的介绍与使用 1.3:Git入门与使用 (三) 使用GitH…

    Linux 2023年6月13日
    0110
  • 在docker中使用主机串口通讯

    在进行软件docker化的过程时,很大的一个阻碍就是软件与各种外围硬件设备的交互,网口通信的设备能够很容易地接入容器,但是串口设备则要复杂一些。本文讨论在windows和linux…

    Linux 2023年6月6日
    0107
  • 聊聊支付流程的设计与实现逻辑

    新手打怵老手头疼的业务; 一、业务背景 通常在业务体系中,都会或多或少的涉及到支付相关的功能;对于一些经验欠缺同学来说,最紧张的就是面对这类支付结算的逻辑,因为流程中的任何细节问题…

    Linux 2023年6月14日
    084
  • 订阅消息组件由 redis 改为 rabbitmq

    刚开始测试 dapr 时为了图省事,使用了 pubsub.redis,现在准备上生产环境,改用支持消息持久化的 pubsub.rabbitmq。 之前使用的 pubsub.redi…

    Linux 2023年5月28日
    086
  • 2021年3月-第02阶段-前端基础-Flex 伸缩布局-移动WEB开发_流式布局

    移动web开发流式布局 1.0 移动端基础 1.1 浏览器现状 PC端常见浏览器:360浏览器、谷歌浏览器、火狐浏览器、QQ浏览器、百度浏览器、搜狗浏览器、IE浏览器。 移动端常见…

    Linux 2023年6月8日
    0129
  • PyTorch 介绍 | LEARN THE BASICS

    大多数机器学习流程都包括数据、创建模型、优化模型参数,以及保存训练模型工作。该教程向你介绍一个在PyTorch上实现的完整的机器学习工作流,并提供了了解这些概念详细信息的链接。 我…

    Linux 2023年6月16日
    0143
  • 防止shell script多次运行

    防止shell script多次运行 一个思路是在script初期检测系统中是否存在同名进程。 if [ ps -ef | grep "test.sh" | g…

    Linux 2023年5月28日
    084
  • APACHE快速安装流程梳理

    快速安装开始: 【环境配置1】 yum -y install gcc gcc-c++ wget 保留操作(可跳过): yum -y removeapr-util-devel apr…

    Linux 2023年6月6日
    098
  • 【计算题】考研数据结构计算题型整理

    题型1:递归程序,一般使用公式进行递推 int fact(int n){ if(n 本题是求阶乘的递归代码,即n * (n-1) * …. * 1。每次递归调用 fac…

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