如何通过CMake统一SDL头文件引用路径为SDL2/SDL.h？

核心思路 #

Windows平台下，SDL头文件直接存放在SDL2_INCLUDE_DIRS目录中（即直接引用SDL.h）；其他平台的SDL头文件则位于SDL2_INCLUDE_DIRS/SDL2/路径下（需引用SDL2/SDL.h）。我们可以通过CMake在Windows上构建虚拟的SDL2目录结构，让所有平台的代码统一使用#include <SDL2/SDL.h>即可完成引用。

实现步骤 #

1. 查找SDL2依赖 #

在项目的CMakeLists.txt中加入SDL2的查找逻辑：

find_package(SDL2 REQUIRED)

2. 配置目标的包含路径 #

针对不同平台设置包含目录，Windows平台通过符号链接构建虚拟目录结构：

add_executable(your_project_target src/main.cpp) # 替换为你的实际项目目标名

if(WIN32)
    # 在构建目录下创建include目录，再将SDL的实际头文件目录链接为include/SDL2
    file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/include)
    if(NOT EXISTS ${CMAKE_BINARY_DIR}/include/SDL2)
        file(CREATE_LINK ${SDL2_INCLUDE_DIRS} ${CMAKE_BINARY_DIR}/include/SDL2 SYMBOLIC)
    endif()
    # 将虚拟目录添加到项目的包含路径
    target_include_directories(your_project_target PRIVATE ${CMAKE_BINARY_DIR}/include)
else()
    # 非Windows平台直接使用SDL提供的标准包含路径
    target_include_directories(your_project_target PRIVATE ${SDL2_INCLUDE_DIRS})
endif()

# 链接SDL2库到项目目标
target_link_libraries(your_project_target PRIVATE SDL2::SDL2)

3. 代码中统一引用 #

完成配置后，所有平台的代码都可以统一使用以下方式引用SDL头文件，无需添加任何平台相关的条件编译：

#include <SDL2/SDL.h>

备选方案（无需符号链接） #

如果符号链接在你的环境中无法使用，可以用转发头文件替代：

1. 在项目源码目录下创建SDL2_SDL.h.in文件，内容如下：

#include <SDL.h>

2. 修改CMakeLists.txt中Windows平台的配置部分：

if(WIN32)
    file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/include/SDL2)
    # 生成转发头文件到虚拟SDL2目录
    configure_file(${CMAKE_CURRENT_SOURCE_DIR}/SDL2_SDL.h.in ${CMAKE_BINARY_DIR}/include/SDL2/SDL.h COPYONLY)
    target_include_directories(your_project_target PRIVATE ${CMAKE_BINARY_DIR}/include ${SDL2_INCLUDE_DIRS})
else()
    target_include_directories(your_project_target PRIVATE ${SDL2_INCLUDE_DIRS})
endif()

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