如何配置ClangTool忽略PCH文件以解析项目AST？

可以通过在代码中过滤/修改编译命令的方式，让ClangTool忽略PCH相关内容，无需手动修改compile_commands.json。以下是具体实现方案：

方案1：清理编译命令中的PCH相关参数 #

遍历所有编译命令，移除与预编译头相关的参数（如-include-pch、-Xclang -include-pch组合、指向.pch文件的-include参数），再用清理后的命令创建新的编译数据库。

修改你的初始化代码如下：

auto options_parser =
    CommonOptionsParser::create(argc, argv, option_category);
if (!options_parser) {
  llvm::errs() << options_parser.takeError();
  return -1;
}

// 获取原始编译数据库和源文件列表
auto& original_compilations = options_parser->getCompilations();
std::vector<std::string> source_files = options_parser->getSourcePathList();
auto all_cmds = original_compilations.getAllCompileCommands();

// 过滤并清理编译命令
std::vector<clang::tooling::CompileCommand> cleaned_cmds;
for (const auto& cmd : all_cmds) {
  clang::tooling::CompileCommand cleaned_cmd = cmd;
  std::vector<std::string> new_args;
  bool skip_next_arg = false;

  for (const auto& arg : cmd.CommandLine) {
    if (skip_next_arg) {
      skip_next_arg = false;
      continue;
    }

    // 跳过PCH相关参数
    if (arg == "-include-pch" || arg == "-Xclang") {
      skip_next_arg = (arg == "-Xclang"); // 跳过-Xclang后的下一个参数（通常是-include-pch）
      continue;
    }
    // 跳过指向.pch文件的-include参数
    if (arg == "-include") {
      skip_next_arg = true;
      continue;
    }

    new_args.push_back(arg);
  }

  cleaned_cmd.CommandLine = new_args;
  cleaned_cmds.push_back(cleaned_cmd);
}

// 创建过滤后的固定编译数据库
auto fixed_compilations = clang::tooling::FixedCompilationDatabase::create(
    cleaned_cmds.front().Directory, cleaned_cmds);
ClangTool tool(*fixed_compilations, source_files);

方案2：强制禁用预编译头使用 #

如果清理参数太繁琐，可以直接给所有编译命令添加-fno-use-precompiled-header选项，强制Clang忽略预编译头，从根本上规避PCH格式问题：

auto options_parser =
    CommonOptionsParser::create(argc, argv, option_category);
if (!options_parser) {
  llvm::errs() << options_parser.takeError();
  return -1;
}

auto& original_compilations = options_parser->getCompilations();
std::vector<std::string> source_files = options_parser->getSourcePathList();
auto all_cmds = original_compilations.getAllCompileCommands();

// 给每个编译命令添加禁用PCH的选项
std::vector<clang::tooling::CompileCommand> modified_cmds;
for (auto cmd : all_cmds) {
  cmd.CommandLine.push_back("-fno-use-precompiled-header");
  modified_cmds.push_back(cmd);
}

auto fixed_compilations = clang::tooling::FixedCompilationDatabase::create(
    modified_cmds.front().Directory, modified_cmds);
ClangTool tool(*fixed_compilations, source_files);

方案对比 #

• 方案1更精准，仅移除PCH相关参数，保留其他编译选项的完整性；
• 方案2更简洁，适合大多数场景，无需精确匹配PCH参数。

这两种方案都无需手动修改compile_commands.json，能适配CMake重新生成编译数据库的情况，比临时修改文件更可靠。

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