如何通过AST定位含特定VarDeclRef的成员函数并完成代码替换？

示例代码 #

#include <string>

class DBFetcher {
  public:
    void findByName(std::string name) {}
    void findByNameV2(std::string name) {}
}; // 原代码此处缺失分号，已修正

DBFetcher getFetcher() {
  return DBFetcher(); // 原代码此处为FBFetcher，应为笔误，已修正
}

void clientFetch() {
  std::string myName = "abc";
  auto res = getFetcher().findByName(std::move(myName));
  return res;
}

需求说明 #

已通过Matcher匹配到std::move(myName)中变量myName的引用位置，需完成两项修改：

• 将调用的findByName替换为findByNameV2
• 将变量名myName改为newName

当前Matcher代码 #

auto matcher = declRefExpr(
            isExpansionInMainFile(),
            to(varDecl(hasInitializer(
                           cxxConstructExpr(hasType(cxxRecordDecl(hasName(
                                                "DBFetcher"))))
                               .bind("constructor")))
                   .bind("var")))
            .bind("varRef"));

解决方案 #

1. 调整Matcher，同时关联函数调用与变量引用 #

原Matcher仅匹配变量引用，需向上关联到对应的findByName函数调用。通过hasAncestor添加函数调用匹配逻辑，同时绑定关键节点：

auto matcher = declRefExpr(
            isExpansionInMainFile(),
            to(varDecl(hasName("myName")).bind("var")), // 直接匹配目标变量名，提升精准度
            hasAncestor(callExpr(
                callee(cxxMethodDecl(hasName("findByName"),
                                     ofClass(hasName("DBFetcher"))))
                .bind("targetCall")))
            .bind("varRef"));

说明：

• 用hasName("myName")直接锁定目标变量，避免误匹配其他DBFetcher相关变量
• 通过hasAncestor找到包含该变量引用的findByName调用，绑定为targetCall节点

2. 在AST回调中完成修改 #

在匹配后的回调函数中，分两步执行修改：

替换函数名

从targetCall节点获取方法声明，修改调用的函数名称：

if (const auto* call = Result.Nodes.getNodeAs<CallExpr>("targetCall")) {
  if (const auto* method = dyn_cast<CXXMethodDecl>(call->getCalleeDecl())) {
    // 创建新函数名标识符
    auto newName = getASTContext().Identifiers.get("findByNameV2");
    // 克隆并修改调用的目标方法
    auto* newCallee = cast<DeclRefExpr>(call->getCallee()->Clone(getASTContext()));
    newCallee->setDecl(method->getDeclContext()->lookup(newName).front());
    call->setCallee(newCallee);
  }
}

修改变量名

需同时修改变量声明和所有引用：

if (const auto* var = Result.Nodes.getNodeAs<VarDecl>("var")) {
  // 修改变量声明的名称
  var->setName("newName");
  // 修正当前匹配到的引用指向
  if (const auto* ref = Result.Nodes.getNodeAs<DeclRefExpr>("varRef")) {
    ref->setDecl(var);
  }
}

如果需要修改所有myName的引用，建议额外编写一个Matcher，匹配所有指向myName的DeclRefExpr节点进行批量替换。

注意事项 #

• 原示例代码存在两处语法错误，需先修正再进行AST修改
• 修改AST时需严格使用Clang提供的API，避免破坏AST结构

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