CMake如何设置全局预处理器定义 解决子项目定义主项目不生效问题

1. add_definitions为目录级作用域，仅对定义所在CMakeLists.txt对应目录及子目录下的编译目标生效，上层主项目的编译目标无法继承子项目中定义的WITH_ADDS宏。
2. library子项目未公开自身头文件包含路径，主项目默认无法找到adds.h头文件，属于潜在编译问题。

通过目标的PUBLIC编译属性自动传递宏定义和头文件路径，所有链接library的目标会自动继承配置，无需手动重复设置。

第一步：修改library子项目的CMakeLists.txt #

project(library)
file(GLOB SRC . src/*.cpp)
file(GLOB INC . include/*.h)
add_library(${PROJECT_NAME} SHARED ${SRC} ${INC})

# 公开自身头文件路径，依赖本库的目标会自动添加该包含路径
target_include_directories(${PROJECT_NAME} PUBLIC 
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
    $<INSTALL_INTERFACE:include>
)

option(ADDS, "Some additional classes", OFF)
if(ADDS)
    message(STATUS "Configure with some extra classes")
    # PUBLIC作用域：编译本库时添加该宏，所有链接本库的目标也会自动添加该宏
    target_compile_definitions(${PROJECT_NAME} PUBLIC WITH_ADDS)
endif()

第二步：修复主项目CMakeLists.txt的语法问题 #

你原主项目的target_include_directories缺少闭合右括号，修正后即可无需其他额外配置：

project(main)
file(GLOB SRC . src/*.cpp)
file(GLOB INC . include/*.h)

add_executable(${PROJECT_NAME} ${SRC} ${INC})

target_include_directories(${PROJECT_NAME} PUBLIC
  ${CMAKE_CURRENT_SOURCE_DIR}/include
) # 补充缺失的右括号

option(ADDS, "", ON)
add_subdirectory(library)
target_link_libraries(${PROJECT_NAME} PRIVATE library)

第三步：主项目代码添加条件编译防护 #

为了避免关闭ADDS选项时主项目编译出错，建议对使用Adds类的代码包裹条件判断：

#ifdef WITH_ADDS
#include "adds.h"
#endif

int main() {
#ifdef WITH_ADDS
    Adds adds;
    adds.doSomething();
#endif
    // 其他业务逻辑
    return 0;
}

方案1：顶层统一配置选项 #

将ADDS选项定义在最顶层主项目的CMakeLists.txt中，子项目不再重复定义option，两个项目各自根据选项值添加宏定义：

# 主项目CMakeLists.txt开头添加
option(ADDS, "Enable additional classes", ON)
if(ADDS)
    target_compile_definitions(${PROJECT_NAME} PRIVATE WITH_ADDS)
endif()

该方案适合需要灵活控制宏生效范围的场景。

方案2：设置全局编译标志（不推荐） #

如果确实需要全局生效的预处理器宏，可以在任意层级的CMakeLists.txt中设置全局编译选项：

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DWITH_ADDS" CACHE INTERNAL "Global compile flags")

该方案会强制所有编译目标添加该宏，破坏CMake目标的封装性，后期维护成本高，非必要不建议使用

内容的提问来源于stack exchange，提问作者folibis