自定义Clang Tool无法检测C++标准库，手动加路径触发报错

问题背景 #

我正在开发一款C++重构工具，核心代码如下：

using namespace clang;

int main(int argc, const char **argv) {

    static llvm::cl::OptionCategory KsaiToolOptions("my_tool optoins");
    static llvm::cl::extrahelp CommonHelp(clang::tooling::CommonOptionsParser::HelpMessage);
    static llvm::cl::extrahelp MoreHelp("\nMore Help Text .. \n");

    std::string Error;
    auto CompilationDatabase = clang::tooling::JSONCompilationDatabase::loadFromFile(
         "compile_commands.json", Error, tooling::JSONCommandLineSyntax::AutoDetect);
    if (not Error.empty() and not CompilationDatabase) {
        llvm::outs() << "CompilationDatabase Error:" << Error << "\n";
    }

    auto Parser = clang::tooling::CommonOptionsParser::create(argc, argv, KsaiToolOptions);
    if (not Parser) {
        llvm::errs() << Parser.takeError();
        return 1;
    }
    auto Tool = clang::tooling::ClangTool(*CompilationDatabase, Parser->getSourcePathList());

    std::vector<std::unique_ptr<Refactor>> Refactors;
    Refactors.emplace_back(std::move(std::make_unique<KsaiRefactor::MoveDeclarationsToCppFile>()));
    for (auto &Refactor : Refactors) {
        if (Tool.run(tooling::newFrontendActionFactory(&Refactor->mFinder).get()) != 0) {
            llvm::outs() << "Failure Tooling\n";
        }
    }
    return 0;
}

初始报错 #

运行时出现无法找到C++标准库头文件的错误：

C:/Users/sansk/OneDrive/Desktop/ksai_shree/include\include.hxx:2:10: fatal error: 
      'cstdio' file not found
    2 | #include <cstdio>
      |          ^~~~~~~~

尝试的解决方案及新问题 #

手动添加Windows平台C++标准库路径后，触发__pragma(pack(pop))中pop未定义的错误，添加路径的代码如下：

"-IC:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.40.33807\include";

std::string CStandardLibraryPath = "-IC:\Program Files (x86)\Windows Kits\10\Include\10.0.22621.0\ucrt";

std::string CStandardLibraryPathShared = "-IC:\Program Files (x86)\Windows Kits\10\Include\10.0.22621.0\shared";

std::string CStandardLibraryPathUm = "-IC:\Program Files (x86)\Windows Kits\10\Include\10.0.22621.0\um";

std::string CStandardLibraryPathWinRT = "-IC:\Program Files (x86)\Windows Kits\10\Include\10.0.22621.0\winrt";

std::string DeclareWin32 = "-D_WIN32";

Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CXXStandardLibraryPath.c_str()));

Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPath.c_str()));

Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPathShared.c_str()));

Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPathUm.c_str()));

Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPathWinRT.c_str()));

Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(DeclareWin32.c_str()));

解决方案 #

1. 优先保证compile_commands.json的完整性 #

如果是用CMake生成编译数据库，在CMakeLists.txt中添加以下配置，让CMake自动生成包含完整MSVC编译参数（标准库路径、预定义宏）的compile_commands.json：

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

这样生成的编译数据库会自动注入MSVC环境的标准库路径和必要宏定义，无需手动添加。

2. 修正手动添加路径的代码（若无法依赖编译数据库） #

如果必须手动添加路径，需解决三个核心问题：

• 转义路径中的反斜杠，避免被解析为C++转义字符
• 添加MSVC必要的预定义宏和打包选项，匹配编译器默认行为
• 调整参数插入顺序，确保头文件路径优先被识别

修正后的代码示例：

// 转义路径中的反斜杠
std::string CXXStandardLibraryPath = "-IC:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\VC\\Tools\\MSVC\\14.40.33807\\include";
std::string CStandardLibraryPath = "-IC:\\Program Files (x86)\\Windows Kits\\10\\Include\\10.0.22621.0\\ucrt";
std::string CStandardLibraryPathShared = "-IC:\\Program Files (x86)\\Windows Kits\\10\\Include\\10.0.22621.0\\shared";
std::string CStandardLibraryPathUm = "-IC:\\Program Files (x86)\\Windows Kits\\10\\Include\\10.0.22621.0\\um";
std::string CStandardLibraryPathWinRT = "-IC:\\Program Files (x86)\\Windows Kits\\10\\Include\\10.0.22621.0\\winrt";

// 添加MSVC必要的预定义宏和打包选项
std::string DeclareWin32 = "-D_WIN32";
std::string DeclareMSCVer = "-D_MSC_VER=1940"; // 对应MSVC 14.40版本
std::string PackOption = "-Zp8"; // 匹配MSVC默认8字节打包规则
std::string MSVCCCompat = "-fms-compatibility"; // 开启MSVC兼容模式
std::string MSVCExtensions = "-fms-extensions"; // 支持MSVC扩展语法

// 在参数列表开头插入，确保路径和宏优先生效
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CXXStandardLibraryPath.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPath.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPathShared.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPathUm.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(CStandardLibraryPathWinRT.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(DeclareWin32.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(DeclareMSCVer.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(PackOption.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(MSVCCCompat.c_str(), tooling::ArgumentInsertPosition::BEGIN));
Tool.appendArgumentsAdjuster(tooling::getInsertArgumentAdjuster(MSVCExtensions.c_str(), tooling::ArgumentInsertPosition::BEGIN));

3. 验证环境一致性 #

确保你的Clang版本与MSVC版本兼容，避免因版本差异导致的语法解析问题。推荐使用与MSVC版本匹配的LLVM/Clang发行版。

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