CMake用法示例

╰+攻爆jí腚メ 2022-05-22 01:52 278阅读 0赞

本文主要介绍 CMake 的用法示例。

说明：本文的用法示例是面向 Linux 操作系统的。

# 1 概述 #

引用 CMake 官网的描述，内容如下：

> CMake is an open-source, cross-platform family of tools designed to **build**, **test** and **package** **software**. 
> 
> CMake is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice. 
> 
> The suite of CMake tools were created by Kitware in response to the need for a powerful, cross-platform build environment for open-source projects such as ITK and VTK.

# 2 用法示例 #

## 2.1 安装CMake ##

在 Linux 操作系统中使用 yum 命令安装 cmake 工具，命令如下：

yum install cmake.x86_64

## 2.2 示例项目 ##

### 2.2.1 项目代码结构 ###

在实际项目中，通常会将项目包含的各个功能模块的相关文件分类部署，以保证项目各个功能模块结构清晰、互不干扰。

本节介绍的示例项目的代码目录结构如下：

![70][]

对于上述代码目录结构，说明如下（相关的源码文件内容会在后面展示）：

*  cmake\_test 为项目文件夹，该文件夹下保存所有的项目内容；
 *  build 文件夹用于存放使用 CMake 构建项目时生成的文件，**cmake 命令也是在 build 目录中执行的**。默认情况下，build 文件夹中不包含任何文件；
 *  cmake\_dir1 和 cmake\_dir2 文件夹表示两个功能独立的代码模块，这两个文件夹中包括的源代码文件列表如下：  
    ![70 1][]
 *  cmake\_dir1 和 cmake\_dir2 文件夹中的 main.cpp 是对应模块的功能实现文件；
 *  cmake\_dir1 和 cmake\_dir2 文件夹中的 CMakeLists.txt 是分别针对各自的源码模块编写的 CMake 配置文件；
 *  CMakeLists.txt 是此项目顶级的 CMake 配置文件，包括了构建项目时的一些总体设置；
 *  include 文件夹用于存放构建项目时调用的头文件；  
    ![70 2][]
 *  lib 文件夹用于存放构建项目时需要的共享库；  
    ![70 3][]
 *  obj 文件夹用于存放生成的项目文件，如可执行的二进制文件或共享库等。默认情况下，obj 文件夹中不包含任何文件。

### 2.2.2 项目代码内容 ###

本示例项目所涉及到的代码内容如下（CMakeLists.txt 文件中各项配置的作用，参考文件中的注释）：

**【项目根目录（cmake\_test）下】**

配置文件 CMakeLists.txt 内容如下：

# CMake版本要求
    cmake_minimum_required(VERSION 2.8)
    
    # 生成的可执行文件及共享库的存放位置 
    # PROJECT_SOURCE_DIR表示项目的顶级目录
    SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/obj)
    SET(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/obj)
    
    # 头文件路径
    include_directories(${PROJECT_SOURCE_DIR}/include)
    
    # 共享库位置
    LINK_DIRECTORIES(${PROJECT_SOURCE_DIR}/lib)
    
    # 添加构建子目录
    ADD_SUBDIRECTORY(cmake_dir1)
    ADD_SUBDIRECTORY(cmake_dir2)

**【cmake\_dir1文件夹下】**

配置文件 CMakeLists.txt 内容如下：

# 遍历当前路径下的所有源文件，并将其添加到变量DIR_SRCS中
    aux_source_directory(. DIR_SRCS)
    
    # 添加名为cmake_test1的可执行文件，该文件会由变量DIR_SRCS中的源文件构建生成
    add_executable(cmake_test1 ${DIR_SRCS})
    
    # 设置依赖的共享库
    target_link_libraries(cmake_test1 fileA)

源文件 main.cpp 内容如下：

#include "fileA.h"
    
    int main()
    {
        // 调用函数funA
        funA();
    
        return 0;
    }

**【cmake\_dir2文件夹下】**

配置文件 CMakeLists.txt 内容如下：

# 遍历当前路径下的所有源文件，并将其添加到变量DIR_SRCS中
    aux_source_directory(. DIR_SRCS)
    
    # 添加名为cmake_test2的可执行文件，该文件会由变量DIR_SRCS中的源文件构建生成
    add_executable(cmake_test2 ${DIR_SRCS})
    
    # 设置依赖的共享库
    target_link_libraries(cmake_test2 fileB)

源文件 main.cpp 内容如下：

#include "fileB.h"
    
    int main()
    {
        // 调用函数funB
        funB();
    
        return 0;
    }

**【include文件夹下】**

源文件 fileA.h 内容如下：

#include <iostream>
    
    using namespace std;
    
    int funA();

源文件 fileB.h 内容如下：

#include <iostream>
    
    using namespace std;
    
    int funB();

**【lib文件夹下】**

项目构建时所需的共享库，分别为 libfileA.so 和 libfileB.so ，这两个共享库是由下面的源文件 fileA.cpp 和 fileB.cpp 编译生成的。

**说明：**在实际的项目开发中，生成共享库的源文件可能不会提供，在此处提供源文件的目的，是方便大家编译生成项目构建时所需的共享库。共享库的编译生成具体方法，请参考文章[《gcc与g++编译器介绍》][gcc_g]的相关内容。

源文件 fileA.cpp 的内容如下：

#include "fileA.h"
    
    int funA()
    {
        cout << "This is funA in fileA print out!" << endl;
    
        return 0;
    }

源文件 fileB.cpp 的内容如下：

#include "fileB.h"
    
    int funB()
    {
        cout << "This is funB in fileB print out!" << endl;
    
        return 0;
    }

### 2.2.3 项目构建 ###

按照以下步骤，使用 CMake 进行项目构建：

1. 进入项目的 build 目录中：

![70 4][]

2. 执行 cmake 命令，生成项目的 makefile 文件（生成的项目 makefile 文件会存放在 build 目录中）：

![70 5][]

**说明：**由于项目顶级 CMake 配置文件 CMakeLists.txt 位于项目根目录 cmake\_test 下，所以在 build 文件夹中执行 cmake 命令时，需要后接“..”来指定该 CMakeLists.txt 的位置。

3. （由于上一步已生成了makefile文件，所以此处）执行 make 命令，进行项目构建：

![70 6][]

4. 因为在 CMakeLists.txt 中配置了生成的可执行文件的存放位置（即 cmake\_test/obj），所以此处进入 obj 文件夹中，查看是否生成了可执行文件：

![70 7][]

5. 分别运行构建生成的可执行文件 cmake\_test1 和 cmake\_test2 ，结果如下：

![70 8][]

上面的结果说明我们的项目构建成功、生成的可执行文件功能正常。

[70]: /images/20220522/bb3ae8a0e0064650a6e5d3f6e5050e55.png
[70 1]: /images/20220522/823665e7825f4f6e87924e3d219aca3c.png
[70 2]: /images/20220522/be16b9bb69a7483cbfa1612f560eeaee.png
[70 3]: /images/20220522/212b843e2ede4b9684d53d73d49dabb0.png
[gcc_g]: https://blog.csdn.net/liitdar/article/details/80025030?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522161957447016780261914067%2522%252C%2522scm%2522%253A%252220140713.130102334.pc%255Fblog.%2522%257D&request_id=161957447016780261914067&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~blog~first_rank_v2~rank_v29-7-80025030.nonecase&utm_term=%E5%85%B1%E4%BA%AB%E5%BA%93
[70 4]: /images/20220522/211496c1675c459092d9af343d3d3c87.png
[70 5]: /images/20220522/156c16e6f7ee4682a829e54a35d1f95f.png
[70 6]: /images/20220522/428aaa8fd838444c8970b285f581274c.png
[70 7]: /images/20220522/0dcfe2c92c1f4fbb932aba5c437a0840.png
[70 8]: /images/20220522/c4964dcdba2a494ca4fa9dee119c0311.png