CMake教程

Cmake简介

Cmake允许开发者编写一种平台无关的CMakeList.txt文件来定制整个编译流程，然后再根据目标用户的平台进一步生成所需的本地化Makefile和工程文件，如Unix的MakeFile或Windows的Visual Studio工程。从而做到"Write once, run everywhere"。

在linux平台下使用CMake生成的Makefile并编译的流程如下：

1. 在同一个目录下编写CMake配置文件CMakeLists.txt和源文件
2. mkdir build && cd build，然后执行命令cmake ..生成Makefile，再执行命令make。(建立build文件夹的目的是将编译文件和源文件分开)
3. make之后还可以再执行个sudo make install命令，这个命令可选，作用是将需要的头文件和库文件拷贝到/usr目录下，有时是/usr/local目录下。

make, make install的作用

CMake语法支持的数据类型是 字符串 和 字符串列表。

• 单个源文件

源文件main.cpp如下：

#include <stdio.h>
#include <stdlib.h>
/**
 * power - Calculate the power of number.
 * @param base: Base value.
 * @param exponent: Exponent value.
 *
 * @return base raised to the power exponent.
 */
double power(double base, int exponent)
{
    int result = base;
    int i;
    
    if (exponent == 0) {
        return 1;
    }
    
    for(i = 1; i < exponent; ++i){
        result = result * base;
    }
    return result;
}
int main(int argc, char *argv[])
{
    if (argc < 3){
        printf("Usage: %s base exponent \n", argv[0]);
        return 1;
    }
    double base = atof(argv[1]);
    int exponent = atoi(argv[2]);
    double result = power(base, exponent);
    printf("%g ^ %d is %g\n", base, exponent, result);
    return 0;
}

编写CMakeLists.txt

   # CMake 最低版本号要求
   cmake_minimum_required (VERSION 2.8)
   
   # 项目信息
   project (Demo1)
   
   # 指定生成目标
   add_executable(Demo main.cpp)

CMakeLists.txt 的语法比较简单，由命令、注释和空格组成，其中命令是不区分大小写的。符号#后面的内容是注释。命令由命令名称、小括号和参数组成。参数之间使用空格进行间隔。

对于上面的CMakeLists.txt文件，依次出现了几个命令：

1. cmake_minimum_required：指定运行此配置文件所需的CMake的最低版本;
2. project：参数值是Demo1，该命令表示项目的名称是Demo1。
3. add_executable：将名为main.cpp的源文件编译成一个名为Demo的可执行文件。

• 多个源文件

  • 同一目录，多个源文件

上面的例子只有单个源文件。现在假如把power函数单独写进一个名为MathFunctions.cpp的源文件里，使得这个工程变成如下的形式：

./Demo2
    |
    +--- main.cpp
    |
    +--- MathFunctions.cpp
    |
    +--- MathFunctions.h

CMakeLists.txt改成如下的形式：

# CMake 最低版本号要求
cmake_minimum_required(VERSION 2.8)

# 项目信息
project(Demo2)

# 指定生成目标
add_executable(Demo main.cpp MathFunctions.cpp)

唯一的改动只是在 add_executable 命令中增加了一个 MathFunctions.cpp 源文件。这样写当然没什么问题，但是如果源文件很多，把所有源文件的名字都加进去将是一件烦人的工作。更省事的方法是使用 aux_source_directory 命令，该命令会查找指定目录下的所有源文件，然后将结果存进指定变量名。其语法如下：

aux_source_directory(<dir> <variable>)

因此，可以修改CMakeLists.txt如下：

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo2)
# 查找当前目录下的所有源文件，并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 指定生成目标
add_executable(Demo ${DIR_SRCS})

这样，CMake 会将当前目录所有源文件的文件名赋值给变量 DIR_SRCS ，再指示变量 DIR_SRCS 中的源文件需要编译成一个名称为 Demo 的可执行文件。

• 多个目录，多个源文件

现在进一步将MathFunctions.h和MathFunctions.cpp文件移动到math目录下。

./Demo3
    |
    +--- main.cc
    |
    +--- math/
          |
          +--- MathFunctions.cc
          |
          +--- MathFunctions.h

对于这种情况，需要分别在项目根目录Demo3和math目录里各编写一个CMakeLists.txt文件。为了方便，我们可以将math目录里的文件编译成静态库再由main函数调用。

根目录中的 CMakeLists.txt ：

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)
# 项目信息
project (Demo3)
# 查找当前目录下的所有源文件，并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)
# 添加 math 子目录
add_subdirectory(math)
# 指定生成目标 
add_executable(Demo main.cc)
# 添加链接库
target_link_libraries(Demo MathFunctions)

该文件添加了下面的内容: 第3行，使用命令 add_subdirectory 指明本项目包含一个子目录 math，这样 math 目录下的 CMakeLists.txt 文件和源代码也会被处理 。第6行，使用命令 target_link_libraries 指明可执行文件 main 需要连接一个名为 MathFunctions 的链接库 。

子目录中的 CMakeLists.txt：

# 查找当前目录下的所有源文件，并将名称保存到 DIR_LIB_SRCS 变量
aux_source_directory(. DIR_LIB_SRCS)
# 生成链接库
add_library (MathFunctions ${DIR_LIB_SRCS})

在该文件中使用命令 add_library 将 src 目录中的源文件编译为静态链接库。

各种命令详解

1. cmake_minimum_required

规定cmake程序的最低版本。这行命令是可选的。但在有些情况下，如果CMakeLists.txt文件中使用了一些高版本cmake特有的一些命令的时候，就需要加上这一行，提醒用户升级到该版本之后再执行cmake

2. project

指定项目的名称。在cmake中有两个预定义的变量：<project name>_BINARY_DIR以及<project name>_SOURCE_DIR。
同时cmake还预定义了PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR变量。PROJECT_BINARY_DIR等同于<project name>_BINARY_DIR，PROJECT_SOURCE_DIR等同于<project name>_SOURCE_DIR。在实际的应用用，我强烈推荐使用PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR变量，这样即使项目名称发生变化也不会影响CMakeLists.txt文件