使用cmake自动构建工程

      公司引擎是用cmake根据目标平台来构建工程的，刚接触的时候深深体会到cmake的方便：如果目标平台是windows，它可以帮你自动构建出vs工程；如果是安卓，自动构建出eclipse工程，如果是IOS，自动构建出xcode工程。想想以前用vs建工程的时候，如果要引入第三方库，必须要手动配置第三方库路径，如果引入的库少，那还没什么，如果多的话就悲剧了，配个环境都要半天。再想想以前在linux平台下手动写Makefile的时候，如果工程比较小，模块少还好办，如果工程大，模块多，各种写依赖关系都要让你抓狂。有了cmake这个工具，我们完全可以靠它来帮我们构建vs工程，写Makefile文件。既然cmake构建工程这么方便，当然需要拿来用，可是对于我这个小白来说，怎么学呢？果断谷歌，百度，不过并没有找到比较有价值的学习资料，很多人都是贴出了cmake的源文件CMakeLists.txt，然后对文件中的每行都讲了下作用。看完这些，我依然不知道为什么要这么写，为什么这行要这样写，那行要那样写？后来才反应过来，cmake官网肯定有讲啊，虽然是英文的，虽然自己英文比较挫，没办法，谁叫没有其它资料呢（其实官网讲的才说最权威的，不要因为是英文就畏惧，看多了其实英文也没那么难，很多人自认为英文不行或者看英文吃力就去网上找各种中文资料，结果可能花费了大量时间在找资料上，到最后啥都没学到）。本文主要通过讲解cmake中一些比较简单的命令来构建自己的工程，作为初学者的入门。

1、两行命令帮你构建输出hello world的vs工程

      为了自动构建工程，需要在源文件所在的最上层目录写一个CMakeLists.txt文件，它是cmake的源文件，也可以看作是cmake的脚本文件，这个文件描述了cmake怎样帮我们自动构建工程。现在我们有一个hello.cpp文件，需要用这个文件来构建一个vs工程，手动的方法就是打开vs，新建一个工程hello，然后把hello.cpp添加到hello工程里面。而有了cmake，只需要在CMakeLists.txt写两行命令，第一行给自己工程命个名hello，第二行hello工程需要的源文件hello.cpp。然后通过下面几个步骤，就可以生成一个vs工程了，生成其它工程的步骤相同，只是在选择目标工程的时候不同。

1.1 编写CMakeLists.txt文件和hello.cpp文件

CMakeLists.txt

project(hello)

add_executable(hello hello.cpp)

hello.cpp

#include <stdio.h>

int main (int argc, char *argv[])
{
    printf("hello world!");
    return 0;
}

1.2 设置路径

1.3 设置目标工程为vs工程

1.4  产生vs工程

1.5 打开vs工程，编译运行程序

2 添加子模块

      对于比较大的工程来说，包含多个子模块是很常见的事，因为通常每个人只是负责他自己的模块。那么怎样将各个模块加入到主工程中呢？首先我们需要使用cmake来创建各个子模块的工程，然后再将这些模块加入到整个工程中。假设现在我们有一个子模块myhello，它提供了一个函数PrintHelloWorld来打印hello world!，主模块hello调用这个函数来打印。首先我们在hello.cpp所在目录创建myhello文件夹，将myhello.cpp和myhello.h放到里面，然后在这个文件夹中创建CMakeLists.txt。这三个文件的具体内容如下：

myhello/myhello.h：

void PrintHelloWorld();

myhello/myhello.cpp

#include <stdio.h>

void PrintHelloWorld()
{
    printf("hello world!");
}

myhello/CMakeLists.txt

add_library(myhello myhello.cpp)

这个CMakeLists.txt主要是告诉cmake，为myhello创建一个库工程。

hello.cpp

#include "myhello/myhello.h"

int main (int argc, char *argv[])
{
    PrintHelloWorld();
    return 0;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.5)

project(hello)

add_subdirectory(myhello)
set (EXTRA_LIBS ${EXTRA_LIBS} myhello)

add_executable(hello hello.cpp)

target_link_libraries (hello ${EXTRA_LIBS})

       add_subdirectory将myhello子工程加入到主工程，target_link_libraries将子模myhello链接到hello中。然后重新cmake下，打开vs就可以编译运行啦。

3 添加可配置的头文件

      cmake可以通过可配置的头文件来产生实际的头文件，如下面的可配置头文件hello.h.in，里面@@引用的变量可以通过CMakeLists.txt来设置，最后通过cmake来替换hello.h.in文件中的变量并生成hello.h内容。

hello.h.in

#define VERSION_MAJOR @VERSION_MAJOR@
#define VERSION_MINOR @VERSION_MINOR@

CMakeLists.txt

cmake_minimum_required(VERSION 3.5)

project(hello)

include_directories("${PROJECT_BINARY_DIR}")
set(VERSION_MAJOR 1)
set(VERSION_MINOR 0)
configure_file(
    "${PROJECT_SOURCE_DIR}/hello.h.in"
    "${PROJECT_BINARY_DIR}/hello.h"
)

add_subdirectory(myhello)
set (EXTRA_LIBS ${EXTRA_LIBS} myhello)


add_executable(hello hello.cpp)

target_link_libraries (hello ${EXTRA_LIBS})

上面加红的命令主要用来设置hello.h.in中的两个变量，并且让cmake生成hello.h文件。生成的hello.h如下：

hello.h

#define VERSION_MAJOR 1
#define VERSION_MINOR 0

再修改下hello.cpp文件使用这两个变量，

hello.cpp

#include "myhello/myhello.h"
#include "hello.h"
#include <stdio.h>

int main (int argc, char *argv[])
{
    printf("version:%d.%d
", VERSION_MAJOR, VERSION_MINOR);
    PrintHelloWorld();
    return 0;
}

打开vs工程，编译运行输出者两个变量的值。这样就可以通过在CMakeLists.txt中设置变量的内容来动态修改.h文件，增加了代码的灵活性。

4 检测系统是否有支持工程需要的函数

      对于跨平台的工程来说，检查系统是否支持某些特性是很有必要的，这样程序中就可以通过系统的特性来选择具体执行哪些代码。其中检查是否支持某些函数是我们经常要做的事情，如epoll函数，可能有的linux系统就不支持，对于不支持的系统我们只能用poll来替代等。在cmake中检查系统是否支持某个函数也很简单，先包含一个CheckFunctionExists库，然后使用check_function_exists来判断就行了。

CMakeLists.txt

cmake_minimum_required(VERSION 3.5)

project(hello)

include (CheckFunctionExists)
check_function_exists (printf HAVE_PRINTF)

include_directories("${PROJECT_BINARY_DIR}")
set(VERSION_MAJOR 1)
set(VERSION_MINOR 0)
configure_file(
    "${PROJECT_SOURCE_DIR}/hello.h.in"
    "${PROJECT_BINARY_DIR}/hello.h"
)

add_subdirectory(myhello)
set (EXTRA_LIBS ${EXTRA_LIBS} myhello)


add_executable(hello hello.cpp)

target_link_libraries (hello ${EXTRA_LIBS})

在配置的头文件hello.h.in中加入#cmakedefine HAVE_PRINTF，这样如果系统中有printf函数，最终生成的hello.h中会定义HAVE_PRINTF这个宏，否则不会生成这个宏，在hello.cpp文件中可以根据这个宏来是否定义来判断是否应该使用printf函数。

hello.h.in

#define VERSION_MAJOR @VERSION_MAJOR@
#define VERSION_MINOR @VERSION_MINOR@

#cmakedefine HAVE_PRINTF

hello.cpp

#include "myhello/myhello.h"
#include "hello.h"
#include <stdio.h>

int main (int argc, char *argv[])
{
#ifdef HAVE_PRINTF
    printf("version:%d.%d
", VERSION_MAJOR, VERSION_MINOR);
#endif
    PrintHelloWorld();
    return 0;
}

运行结果：

5 配置可选项

有时候代码可能包含了所有平台的模块代码，但是对于特定的目标平台，只需要配置该平台需要模块的代码，而不需要配置其它平台模块的代码。这种需求可以通过cmake的配置可选项来完成，配置可选项就是cmake在生成工程的时候提示你一些选项，根据你的选项来具体选择需要添加到工程中的模块代码。例如我现在需要提高是否使用myhello模块的选项，可以在CMakeLists.txt中加option命令来实现，代码如下：

cmake_minimum_required(VERSION 3.5)

project(hello)

include (CheckFunctionExists)
check_function_exists (printf HAVE_PRINTF)

include_directories("${PROJECT_BINARY_DIR}")
set(VERSION_MAJOR 1)
set(VERSION_MINOR 0)

option (USE_MYHELLO 
        "Use myhello" ON) 
        
configure_file(
    "${PROJECT_SOURCE_DIR}/hello.h.in"
    "${PROJECT_BINARY_DIR}/hello.h"
)

add_subdirectory(myhello)
set (EXTRA_LIBS ${EXTRA_LIBS} myhello)


add_executable(hello hello.cpp)

target_link_libraries (hello ${EXTRA_LIBS})

并且在hello.h.in中添加由cmake根据选项来定义USE_MYHELLO宏。

#define VERSION_MAJOR @VERSION_MAJOR@
#define VERSION_MINOR @VERSION_MINOR@

#cmakedefine HAVE_PRINTF
#cmakedefine USE_MYHELLO

这样在运行cmake的时候，会提示我们一些选项来进行选择：

通过USE_MYHELLO是否被选择，cmake来确定是否要在hello.h中定义USE_MYHELLO宏，最终我们可以在hello.cpp中判断USE_MYHELLO宏是否定义来是否使用myhello模块中的PrintHelloWorld函数。

hello.cpp

#include "myhello/myhello.h"
#include "hello.h"
#include <stdio.h>

int main (int argc, char *argv[])
{
#ifdef HAVE_PRINTF
    printf("version:%d.%d
", VERSION_MAJOR, VERSION_MINOR);
#endif
#ifdef USE_MYHELLO
    PrintHelloWorld();
#else
    printf("xx hello world!");
#endif
    return 0;
}

最后通过选中或者不选中USE_MYHELLO选择，得到的结果会不同。

选中结果

没选中结果：

6 总结

      本文主要介绍了下cmake的比较常用的一些命令：project、include、include_directories、set、option、configure_file、add_subdirectory、add_executable、target_link_libraries、add_library，算是一个入门吧。需要用好cmake，熟悉cmake的命令和多写cmake脚本是必须的，具体每个命令的介绍看以参考官方文档：https://cmake.org/cmake/help/v3.5/manual/cmake-commands.7.html，脚步的编写语法可以参考官网文档：https://cmake.org/cmake/help/v3.5/manual/cmake-language.7.html。以后大点的工程创建完全可以交给cmake来完成，同时也是熟悉cmake的过程。

参考：https://cmake.org/cmake/help/v3.5/index.html