CPM.cmake项目中本地依赖源配置问题的解决方案

问题背景

在使用CPM.cmake管理项目依赖时，开发者经常会遇到需要同时开发库和应用程序的情况。这时，使用本地代码而非远程仓库作为依赖源就显得尤为重要。CPM.cmake提供了CPM_dep_SOURCE参数和SOURCE_DIR选项来支持这种开发场景。

现象描述

当开发者尝试通过以下两种方式配置本地依赖源时：

1. 设置CPM_<package>_SOURCE变量：

set(CPM_common_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}/../../Libraries/common")

2. 直接在CPMAddPackage中指定SOURCE_DIR：

CPMAddPackage(
    NAME common
    SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../../Libraries/common
)

虽然构建系统能够识别本地源，但编译器却无法找到相应的头文件。同时，在_deps目录下，通常生成的<package>-src目录也会缺失。

技术原理

这个问题实际上源于CMake的FetchContent模块的行为特性。当使用SOURCE_DIR参数时，FetchContent不会像常规情况那样将源代码复制到<package>-src目录中，而是直接使用指定路径下的源代码。这种差异导致了包含路径的处理方式发生变化。

解决方案

临时解决方案

对于需要快速解决问题的开发者，可以直接在目标中包含本地路径：

target_include_directories(your_target PRIVATE
    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../../Libraries/common/include>
)

或者更优雅地使用变量：

target_include_directories(your_target PRIVATE
    $<BUILD_INTERFACE:${common_SOURCE_DIR}/include>
)

根本解决方案

1. 清理构建目录：完全删除构建目录（不仅仅是CMake缓存），然后重新配置项目。

2. 验证包含路径：使用make VERBOSE=1或相应构建系统的verbose选项，检查编译器实际接收到的包含路径。

3. 检查库的CMake配置：确保被引用的库正确导出了它的包含目录，通常通过target_include_directories配合PUBLIC或INTERFACE关键字。

最佳实践建议

1. 对于本地开发依赖，优先使用CPM_<package>_SOURCE变量，保持CMakeLists.txt的整洁性。

2. 在库项目中，确保正确设置导出目标：

target_include_directories(common PUBLIC include)

3. 考虑在项目中使用相对路径时，先将其转换为绝对路径：

get_filename_component(COMMON_ABS_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../../Libraries/common" ABSOLUTE)
set(CPM_common_SOURCE ${COMMON_ABS_PATH})

4. 对于复杂的项目结构，考虑在根CMakeLists.txt中定义基础路径变量，供子项目共享使用。

通过理解这些底层机制和采用正确的配置方法，开发者可以高效地使用CPM.cmake进行本地库和应用程序的并行开发。