CMake入门教程【核心篇】定义C++宏定义(add_compile_definitions)

1.基本用法

add_compile_definitions 是 CMake 中用于向编译器添加预定义宏的命令。它可以用来定义编译时的宏，从而控制代码的编译行为。

add_compile_definitions的语法如下：

add_compile_definitions(<macro1> [<macro2> ...])

其中 <macro1>, <macro2>, … 是要定义的宏的名称。您可以指定一个或多个宏。

2.定义单个宏

您可以通过在 add_compile_definitions 命令中指定单个宏的名称来定义宏。

add_compile_definitions(ENABLE_FEATURE_X)

这将在编译过程中定义名为 ENABLE_FEATURE_X 的宏。

3.定义多个宏

您可以在 add_compile_definitions 命令中指定多个宏的名称，以逗号或空格分隔。

add_compile_definitions(ENABLE_FEATURE_X ENABLE_FEATURE_Y)

这将在编译过程中定义名为 ENABLE_FEATURE_X 和 ENABLE_FEATURE_Y 的宏。

4.条件定义宏

您可以根据条件来定义宏。例如，使用 if 语句可以根据 CMake 的变量或条件来决定是否定义宏。

if(ENABLE_FEATURE_X)
  add_compile_definitions(ENABLE_FEATURE_X)
endif()

在上述示例中，只有当 CMake 变量 ENABLE_FEATURE_X 为真时，才会定义宏 ENABLE_FEATURE_X。

5.使用预定义变量

CMake 提供了一些预定义的变量，您可以在 add_compile_definitions 命令中使用它们。

例如，$<CONFIG> 变量表示当前的构建配置（例如 Debug、Release 等）。您可以根据不同的构建配置定义不同的宏。

add_compile_definitions($<CONFIG>_DEBUG)

在上述示例中，如果当前构建配置为 Debug，将定义名为 DEBUG 的宏。

6.使用 generator 表达式

CMake 还提供了强大的 generator 表达式，您可以在 add_compile_definitions 命令中使用它们。

generator 表达式可以根据不同的生成器和平台提供不同的宏定义。

add_compile_definitions($<$<CXX_COMPILER_ID:MSVC>:WINDOWS>)

在上述示例中，如果使用的是 MSVC 编译器，将定义名为 WINDOWS 的宏。

7.使用选项控制宏

您可以使用 CMake 的选项来控制宏的定义。通过 option 命令定义一个选项，并在 add_compile_definitions 命令中使用该选项来定义宏。例如：

option(ENABLE_FEATURE_X "Enable feature X" ON)
if(ENABLE_FEATURE_X)
  add_compile_definitions(ENABLE_FEATURE_X)
endif()

在上述示例中，如果选项 ENABLE_FEATURE_X 被设置为 ON，将定义宏 ENABLE_FEATURE_X。