如何在CMake项目中将库头文件添加到公共搜索作用域

问题根源 #

你当前的配置存在两个核心问题导致库头文件无法被主程序直接识别：

1. 子目录中修改的INCLUDES、LIBRARIES变量默认仅在当前CMakeLists的作用域内有效，没有向上传递到父级目录，因此顶层和src目录的配置完全拿不到你追加的库头文件路径。
2. 给somelib设置头文件目录时用了PRIVATE参数，代表该路径仅对somelib自身编译生效，依赖somelib的目标不会自动继承该路径。

方案一：使用现代CMake目标属性（推荐） #

不需要手动维护全局变量列表，靠CMake目标的属性自动传递能力解决，后续新增库也不需要额外修改全局配置：

1. 修改Project/lib/somelib/CMakeLists.txt：

add_library(somelib)
# 将PRIVATE改为PUBLIC，头文件路径会自动传递给所有依赖somelib的目标
target_include_directories(somelib PUBLIC include)

# 下面两行全局变量追加的代码可以直接删除，不需要手动维护
# list(APPEND INCLUDES include)
# list(APPEND LIBRARIES somelib)

add_subdirectory(src)

2. 修改Project/src/CMakeLists.txt，直接链接somelib即可自动继承头文件路径：

add_executable(${CMAKE_PROJECT_NAME} main.c)
target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE ${INCLUDES})
# 直接链接somelib目标，自动继承其PUBLIC属性的头文件路径
target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE somelib)

add_subdirectory(somedir)

修改完成后，直接在main.c中写#include <somelibheader.h>即可正常引入，不需要写相对路径。

方案二：修复现有全局变量写法 #

如果你不想改动现有全局变量维护的架构，只需要补全变量作用域传递的逻辑即可：

1. 修改Project/lib/somelib/CMakeLists.txt，补全绝对路径和变量向上传递逻辑：

add_library(somelib)
target_include_directories(somelib PRIVATE include)

# 改用绝对路径避免不同作用域下相对路径解析错误
list(APPEND INCLUDES ${CMAKE_CURRENT_SOURCE_DIR}/include)
list(APPEND LIBRARIES somelib)
# 将修改后的变量向上传递到父目录作用域
set(INCLUDES ${INCLUDES} PARENT_SCOPE)
set(LIBRARIES ${LIBRARIES} PARENT_SCOPE)

add_subdirectory(src)

2. 修改Project/lib/CMakeLists.txt，补全变量向上传递到顶层目录的逻辑：

add_subdirectory(somelib)
set(INCLUDES ${INCLUDES} PARENT_SCOPE)
set(LIBRARIES ${LIBRARIES} PARENT_SCOPE)

修改完成后全局INCLUDES列表就会包含库的头文件路径，主程序即可直接引入头文件。

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