CMake子目录变量在父目录不可见致头文件找不到编译错误

1. 子目录变量未传递到根作用域 #

CMake变量默认仅在当前作用域生效，子目录中定义的LIB_OUTPUT_NAME如果未显式传递到根目录，根目录的target_link_libraries实际链接的是空目标，自然无法获取头文件路径。

• 修复方式：在子目录的CMakeLists.txt中设置变量时添加PARENT_SCOPE：

set(LIB_OUTPUT_NAME icalendar PARENT_SCOPE)
add_library(${LIB_OUTPUT_NAME} SHARED src/icalendar.cpp)

2. PUBLIC包含路径配置错误 #

子目录中target_include_directories的路径需相对于自身CMakeLists.txt的位置，若使用根目录相对路径会导致依赖目标无法正确识别头文件位置。

• 正确配置示例（假设icalendar.h在icalendarlib/include下）：

target_include_directories(${LIB_OUTPUT_NAME}
    PUBLIC
        ${CMAKE_CURRENT_SOURCE_DIR}/include
)

CMAKE_CURRENT_SOURCE_DIR指向子目录的根目录，确保路径在任何构建环境下都正确。

3. 优先直接引用库Target而非变量 #

通过变量传递库名称容易出现作用域问题，直接引用子目录定义的库Target更可靠，CMake会自动处理依赖的头文件和链接路径：

• 根目录CMakeLists.txt修改示例：

add_subdirectory(icalendarlib)
# 直接使用子目录中定义的库Target名称，无需依赖变量
target_link_libraries(main PRIVATE icalendar)

4. 检查源码中的头文件引用 #

若已通过PUBLIC包含目录将头文件所在目录加入编译器搜索路径，源码中应使用<icalendar.h>而非相对路径引用：

// 正确写法
#include <icalendar.h>
// 错误写法（会导致路径不匹配）
#include "icalendarlib/include/icalendar.h"

完整配置示例 #

子目录icalendarlib/CMakeLists.txt

add_library(icalendar SHARED
    src/icalendar.cpp
)

target_include_directories(icalendar
    PUBLIC
        ${CMAKE_CURRENT_SOURCE_DIR}/include
)

根目录CMakeLists.txt

cmake_minimum_required(VERSION 3.10)
project(icalendar_demo)

add_executable(main main.cc)

add_subdirectory(icalendarlib)
target_link_libraries(main PRIVATE icalendar)

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