CMake用法示例

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

说明：本文介绍的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

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

yum install cmake.x86_64

2.2 示例项目

2.2.1 项目代码结构

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

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

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

• cmake_test为项目文件夹，该文件夹下保存所有的项目内容；
• build文件夹用于存放使用CMake构建项目时生成的文件，cmake命令也是在build目录中执行的。默认情况下，build文件夹不包含任何文件；
• cmake_dir1和cmake_dir2文件夹表示两个功能独立的代码模块，这两个文件夹中包括的源代码文件列表如下：
  
• cmake_dir1和cmake_dir2文件夹中的main.cpp是各个模块的功能实现文件；
• cmake_dir1和cmake_dir2文件夹中的CMakeLists.txt是分别针对各自的功能模块编写的CMake配置文件；
• CMakeLists.txt是此项目顶级的CMake配置文件，包括了构建项目时的一些总体设置；
• include文件夹用于存放构建项目时调用的头文件；
  
• lib文件夹用于存放构建项目时需要的共享库；
  
• 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++编译器介绍》的相关内容。

源文件 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目录中：

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

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

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

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

5. 分别运行构建生成的可执行文件cmake_test1和cmake_test2，结果如下：

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