如何配置CMake将PCH文件扩展名从hxx改为h适配clangd？

• 在VS Code中配合CMake使用clangd扩展时，编译流程正常，但clangd无法识别CMake自动生成的预编译头文件cmake_pch_arm64.hxx
• 手动将该文件扩展名改为.h，并同步更新compile_commands.json中对应的引用路径后，clangd识别恢复正常；原.hxx文件会触发clangd警告：#pragma system_header ignored in main file clang(-Wpragma-system-header-outside-header)
• 需求：
  1. 是否可通过CMake配置直接修改生成的预编译头文件扩展名？
  2. 若CMake不支持该配置，如何在每次构建时自动修改文件扩展名及compile_commands.json中的对应路径？

一、通过CMake配置修改预编译头扩展名 #

CMake 3.20及以上版本支持通过全局变量或目标属性指定预编译头的扩展名，具体配置方式如下：

全局配置（所有目标生效） #

在CMakeLists.txt的开头添加：

# 将所有目标的预编译头扩展名设置为.h
set(CMAKE_PCH_EXTENSION ".h")

单个目标配置 #

如果仅需对特定目标生效，可针对目标设置属性：

add_executable(YourTargetName src/main.cpp ...)
# 为当前目标指定预编译头扩展名
set_target_properties(YourTargetName PROPERTIES PCH_EXTENSION ".h")

注意：该配置仅对使用target_precompile_headers或CMAKE_PRECOMPILE_HEADERS启用预编译头的目标有效，且必须使用CMake 3.20及以上版本。

二、自动修改扩展名与compile_commands.json（适配低版本CMake） #

如果你的CMake版本低于3.20，或上述配置未生效，可以通过自定义命令实现自动修改：

1. 自动重命名预编译头文件 #

在CMakeLists.txt中添加自定义命令，监听预编译头生成事件后自动重命名：

# 定义预编译头的源路径和目标路径
set(PCH_SOURCE_FILE "${CMAKE_CURRENT_BINARY_DIR}/cmake_pch_arm64.hxx")
set(PCH_TARGET_FILE "${CMAKE_CURRENT_BINARY_DIR}/cmake_pch_arm64.h")

# 添加重命名命令
add_custom_command(
  OUTPUT ${PCH_TARGET_FILE}
  COMMAND ${CMAKE_COMMAND} -E copy ${PCH_SOURCE_FILE} ${PCH_TARGET_FILE}
  DEPENDS ${PCH_SOURCE_FILE}
  COMMENT "Renaming precompiled header to .h for clangd compatibility"
)

# 创建自定义目标，确保重命名在目标构建前完成
add_custom_target(RenamePCH ALL DEPENDS ${PCH_TARGET_FILE})
add_dependencies(YourTargetName RenamePCH)

2. 自动更新compile_commands.json #

编写Python脚本fix_compile_commands.py，用于替换配置文件中的预编译头路径：

import json
import os

def update_compile_commands():
    cc_path = os.path.join(os.getcwd(), "compile_commands.json")
    if not os.path.isfile(cc_path):
        return
    
    with open(cc_path, "r", encoding="utf-8") as f:
        data = json.load(f)
    
    # 遍历所有编译条目，替换.hxx为.h
    for entry in data:
        entry["command"] = entry["command"].replace("cmake_pch_arm64.hxx", "cmake_pch_arm64.h")
        if "arguments" in entry:
            entry["arguments"] = [arg.replace("cmake_pch_arm64.hxx", "cmake_pch_arm64.h") for arg in entry["arguments"]]
    
    with open(cc_path, "w", encoding="utf-8") as f:
        json.dump(data, f, indent=2)

if __name__ == "__main__":
    update_compile_commands()

然后在CMakeLists.txt中添加命令，在目标构建完成后执行脚本：

add_custom_command(
  TARGET YourTargetName POST_BUILD
  COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/fix_compile_commands.py
  COMMENT "Updating compile_commands.json for clangd"
)

确保环境中已安装Python3，且脚本路径与实际存放位置一致。

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