如何基于CMake实现脚本驱动的代码生成与编译？

核心思路 #

利用CMake的add_custom_command配合编译器的标准输入支持（如GCC/Clang的-x c++ -参数），跳过生成中间.cpp文件，直接将bash脚本输出的代码传递给编译器编译。同时做好依赖跟踪，确保.hpp文件或脚本变化时自动重新编译对应生成代码。

具体实现步骤 #

1. 定位目标头文件 #

先获取目标目录下所有需要处理的.hpp文件：

# 替换为你的.hpp文件所在目录
set(HEADER_DIR "${CMAKE_SOURCE_DIR}/path/to/headers")
file(GLOB_RECURSE HEADER_FILES "${HEADER_DIR}/*.hpp")

2. 为每个头文件生成编译规则 #

遍历所有.hpp文件，用自定义命令将脚本输出直接传给编译器，生成目标文件：

# 存储所有生成的目标文件
set(GENERATED_OBJS "")
# 替换为你的bash脚本路径
set(GENERATOR_SCRIPT "${CMAKE_SOURCE_DIR}/path/to/generator.sh")

foreach(HEADER ${HEADER_FILES})
    # 生成唯一的目标文件名，避免冲突
    get_filename_component(HEADER_BASENAME ${HEADER} NAME_WE)
    set(OBJ_FILE "${CMAKE_CURRENT_BINARY_DIR}/${HEADER_BASENAME}_gen.o")

    add_custom_command(
        OUTPUT ${OBJ_FILE}
        # 脚本读取.hpp输出代码，管道传给编译器编译为目标文件
        COMMAND bash ${GENERATOR_SCRIPT} ${HEADER} | ${CMAKE_CXX_COMPILER} ${CMAKE_CXX_FLAGS} -x c++ -c -o ${OBJ_FILE} -
        # 依赖：头文件和生成脚本本身
        DEPENDS ${HEADER} ${GENERATOR_SCRIPT}
        COMMENT "Compiling generated code for ${HEADER_BASENAME}.hpp"
        VERBATIM
    )

    list(APPEND GENERATED_OBJS ${OBJ_FILE})
endforeach()

3. 将生成的目标文件加入最终构建目标 #

把所有生成的.o文件添加到你的可执行文件或库目标中：

add_executable(your_target main.cpp ${GENERATED_OBJS})
# 或者如果是库：add_library(your_lib STATIC ${GENERATED_OBJS})

4. 跨平台兼容处理 #

针对Windows系统，由于bash脚本无法运行，添加条件判断跳过相关逻辑：

if(UNIX)
    # 上述遍历和自定义命令逻辑放在这里
else()
    message(WARNING "Bash generator scripts are not supported on Windows; generated code compilation skipped.")
endif()

关键注意事项 #

• 依赖跟踪：DEPENDS参数必须包含.hpp文件和生成脚本，确保文件修改后触发重编译。
• 编译器兼容性：GCC、Clang均支持-x c++ -从标准输入读取代码编译；MSVC虽有类似能力，但因Windows不支持bash脚本，无需额外处理。
• 目标文件唯一性：用头文件的无后缀名拼接生成目标文件名，避免不同目录下同名头文件的冲突。
• VERBATIM参数：保证命令中的特殊字符被正确转义，提升跨平台可靠性。

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