CMKAE简单实用指南

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.

1. 简单文件结构和实现流程

我们使用的工程文件结构如下，工程文件夹名为 cmaketest 

~/cmaketest $ tree
.
├── build
├── CMakeLists.txt
├── data
├── libs
├── result
└── src
    └── main.cc

其中 main.cc 文件和 CMakeLists.txt 文件如下展示。 CMakeLists.txt 文件用于告诉 cmake 我们要对这个目录下的文件进行什么操作， CMakeLists.txt 文件的内容需要遵守 cmake 的语法。这里展示的一个最基本的用法，通过注释很容易理解。

// cmaketest/src/main.cc
#include <iostream>

using namespace std;

int main(int argc, char** argv) {

        cout << "Hello world!" << endl;
        return 0;
}

# cmaketest/CMakeLists.txt for the project

# 声明要求的 cmake 最低版本要求
cmake_minimum_required( VERSION 2.8 )

# 声明一个 cmake 工程
project( cmaketest )

# 添加一个可执行程序
# 基本语法：add_executable( 程序名 源代码文件 )
add_executable( cmaketest ./src/main.cc )

然后进入进行编译，注意由于我们的 CMakeLists.txt 文件在工程文件的一级目录下，而此时我们在二级目录 build 文件夹下，需要将路径设为 CMakeLists.txt 所在的路径，因此使用的 cmake .. 的命令。

cmake 会输出一些编译信息，然后在当前目录生成一些中间文件，其中最重要的是 Makefile。由于 Makefile 是自动生成的，我们不必修改它，直接 make 对工程进行编译即可。编译过程会输出一个编译进度，如果顺利通过，我们就可得到在 CMakeLists.txt 中声明的可执行文件 cmaketest ，在命令行输入可执行文件的文件名使其运行。

$ cd build
$ cmake ..
-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
-- Build files have been written to: /home/cv/cmaketest/build

$ make
Scanning dependencies of target cmaketest
[ 50%] Building CXX object CMakeFiles/cmaketest.dir/src/main.cc.o
[100%] Linking CXX executable cmaketest
[100%] Built target cmaketest

$ ./cmaketest
Hello world!

这里我们使用的cmake-make方式对工程进行编译，cmake过程处理了工程文件之间的关系，而make过程实际上调用了g++来编译程序，使得我们对项目的编译管理工作，从输入一串g++命令，变成了维护若干个比较直观的CMakeLists.txt文件，这明显降低了维护整个工程的难度。

而且当我们想要发布源代码时，一般都不希望把文件编译和运行的中间文件一并发布，因此我们这里建了一个名为build的目录，将编译和运行过程中产生的中间文件和缓冲文件与源代码很好地隔离开来，发布源码时，直接将改文件夹删掉即可，方便快捷。

2. 调用工程目录下子文件夹下的头文件

在libs文件夹下新建func.h和func.cc两个库文件，并在main.cc中调用其中定义的函数，三个文件的源代码内容如下。

~/cmaketest $ tree
.
├── build
├── CMakeLists.txt
├── data
├── libs
│   ├── func.cc
│   └── func.h
├── result
└── src
    └── main.cc

其中main.cc以及func.h和func.cc文件内容如下所示。

Reference

[1] cmake 添加头文件目录，链接动态、静态库