cmake自动添加宏定义

前言

一个大型的工程往往包含很多模块，构建时候可以自主选择需要使用的模块，这里模拟一个任务，实现一个求指数的模块，用户可以在CMakeLists.txt文件中自由配制是否使用该模块，如果使用该模块，则需要在config.h配置文件中增加相应的宏定义

准备工作

创建sample8工程，新增Math目录，Math.h和Math.cpp文件，实现求指数功能，新增main.cpp文件，当未引入Math模块时使用系统求指数函数，否则使用Math模块中的求指数函数
目录如下：

./sample8
    |
    +--- CMakeLists.txt
    |
    +--- build/
    +--- src/
            +--- CMakeLists.txt
            +--- main.cpp
    +--- Math/
          +--- Math.h
          +--- Math.cpp

main.cpp中内如下：

#include <stdio.h>
#include <stdlib.h>
#include "config.h"

#ifdef USE_MYMATH
#include "Math.h"
#else
#include <math.h>
#endif

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]);

#ifdef USE_MYMATH
    printf("Now we use our own Math library. \n");
    double result = power(base, exponent);
#else
    printf("Now we use the standard library. \n");
    double result = pow(base, exponent);
#endif
    printf("%g ^ %d is %g\n", base, exponent, result);
    return 0;
}

工程根目录下CMakeLists.txt文件内容为：

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

if(POLICY CMP0042)
  cmake_policy(SET CMP0042 NEW)  # CMake 3.0+ (2.8.12): MacOS "@rpath" in target's install name
endif()

# 项目工程名
project (sample8)
message(STATUS "root This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "root This is SOURCE dir " ${PROJECT_SOURCE_DIR})

# 添加子目录
ADD_SUBDIRECTORY(src)

src下CMakeLists.txt文件内容为：

# 打印信息
message(STATUS "src This is BINARY dir " ${PROJECT_BINARY_DIR})
message(STATUS "src This is SOURCE dir " ${PROJECT_SOURCE_DIR})


# 定义工程根目录; CMAKE_SOURCE_DIR为内建变量，表示工程根目录的CMakeLists.txt文件路径
SET(ROOT_DIR ${CMAKE_SOURCE_DIR})

# 是否使用自己的 Math库
option (USE_MYMATH "Use provided math implementation" ON)
# 用于测试替换用的变量
set(TEST_ON 1)
set(TEST_OF 0)
set(VAR "VAR_NEW")

# 加入一个配置头文件，用于处理 CMake 对源码的设置
configure_file (
  "${CMAKE_CURRENT_SOURCE_DIR}/config.h.in"
  "${CMAKE_CURRENT_BINARY_DIR}/config.h"
)

set(SRC_LIST main.cpp)

# 是否编译Math函数
if (USE_MYMATH)
  set(SRC_LIST main.cpp Math.cpp)
endif (USE_MYMATH)

# 指定可执行文件存放目录
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
# 这样可以找到config.h头文件
include_directories("${CMAKE_CURRENT_BINARY_DIR}")

# 构建可执行程序
ADD_EXECUTABLE(sample8 ${SRC_LIST})

src新增 config.h.in文件，内容如下：

#cmakedefine USE_MYMATH

// == 下面试测试用的
#cmakedefine01 TEST_ON
#cmakedefine01 TEST_OF

#ifndef __${VAR}___@VAR@

#endif

进入build 开始构建，然后执行bin目录下的./sample8 2 8 输出：
Now we use our own Math library.
2 ^ 8 is 256

打开 build/src下的config.h文件，内容为：

#define USE_MYMATH

// == 下面试测试用的
#define TEST_ON 1
#define TEST_OF 0

#ifndef __VAR_NEW___VAR_NEW

#endif

改写前面src中的CMakeLists.txt，将option (USE_MYMATH "Use provided math implementation" ON)改成option (USE_MYMATH "Use provided math implementation" OFF),删除build文件夹中内容，然后重新构建后，再执行 ./sample8 2 8 输出：
Now we use the standard library.
2 ^ 8 is 256

打开 build/src下的config.h文件，内容为：

/* #undef USE_MYMATH */

// == 下面试测试用的
#define TEST_ON 1
#define TEST_OF 0

#ifndef __VAR_NEW___VAR_NEW

#endif

cmake新增语法解释：

• option (USE_MYMATH "Use provided math implementation" ON)指令
  给变量赋值 ON，代表真;OFF关键字则代表 假
• configure_file(<input> <output> [COPYONLY] [ESCAPE_QUOTES] [@ONLY])
  对指定的输入文件中的内容按照指定的规则进行替换，替换完成后输出到output指定的输出路径
  替换规则为：
  1、在输入文件中，凡是以${VAR}格式或@VAR@格式出现的地方都将用CMake中对应变量的值进行替换，如上例中VAR变量的值为VAR_NEW，config.h中全部替换成了这个值
  2、在输入文件中，类似于#cmakedefine VAR的定义语句将会被替换为#define VAR或者/* #undef VAR /，如上例中USE_MYMATH当设定为ON的时候，config.h变成了#define USE_MYMATH，设定为OFF时，变成了/ #undef USE_MYMATH */；同理，类似于#cmakedefine01 VAR的定义语句将会被替换为#define VAR 1或#define VAR 0。

tips: 如果将CMakeLists.txt中的
@# 是否使用自己的 Math库
option (USE_MYMATH "Use provided math implementation" ON)
@# 用于测试替换用的变量
set(TEST_ON 1)
set(TEST_OF 0)
set(VAR "VAR_NEW")
这一段写到config_file指令的后面，会发生什么？
只有放到前面，config_file指令执行时这些变量才是有效的，切莫注意

from:https://www.jianshu.com/p/f0f71d36411a