Question

我正在使用RecursiveASTVisitor来捕获变量声明。对于下面的模板，如何使用clang工具在源代码中获取每个参数的位置？

TMyTemplate<t1, t2> foo;

尝试1：创建一个VisitVarDecl访问者

使用这种方法，我可以识别变量是否为模板并将类型设为clang::TemplateSpecializationType。它允许我使用getArg遍历参数，但是返回类型（TemplateArgument）并未实现getLocation。

virtual bool VisitVarDecl(VarDecl *var) {
        const TemplateSpecializationType *ts = var->getType()->getAs<TemplateSpecializationType>();
        if( ts != nullptr ) {
            for(uint32_t i=0; i< ts->getNumArgs(); i++) {
                TemplateArgument arg = ts->getArg(i);
                // I want to get arg.getLocation() - but no getLocation in TemplateArgument.
            }
        }

}

我尝试将类型TemplateArgument转换为TemplateArgumentLoc，但是任何方法都会导致我出现一个虚拟位置（即：始终返回第1行和第1列，甚至出现段错误）。

尝试2：使用VisitVarTemplateSpecializationDecl访问者

在Clang中，类型VarTemplateSpecializationDecl使我可以将模板参数获取为clang::TemplateArgumentListInfo。这种类型似乎更方便，因为我们可以使用函数TemplateArgumentLoc获得getArgumentArray。

问题在于模板声明不会触发此访问者。我不太明白原因。

尝试3：以VarDecl的身份获得TemplateSpecializationTypeLoc

我还尝试将VarDecl设为TemplateSpecializationTypeLoc，但失败了。

TemplateSpecializationTypeLoc loc = var->getTypeSourceInfo()->getTypeLoc().getAs<TemplateSpecializationTypeLoc>();

快速参考

麻烦的测试用例

Valeriy提供的解决方案几乎完美。他的解决方案可以捕获变量声明TemplateType<ABC, XYZ> Decl;的位置，但是如果我显式命名空间：FOO::TemplateType<ABC, XYZ> Decl;，它将失败。

这是一个简单的测试用例。在解决方案中找到了变量Decl，但没有找到Decl2。强制转换auto Specialization = DeclarationTypeLoc.getAs<clang::TemplateSpecializationTypeLoc>()由于某种原因而失败（返回nullptr）。

namespace FOO {

class ABC {};
class XYZ {};

template <class T, class U> class TemplateType {};

}

using namespace FOO;



int main() {
    TemplateType<ABC, XYZ> Decl;
    FOO::TemplateType<ABC, XYZ> Decl2;
    return 0;
}

Answer 1

第一次尝试是最接近您需要的尝试。您要查找的节点是VarDecl，它是类型位置。 VarTemplateSpecializationDecl是变量模板（C++14 feature）的专业化。

代表变量模板的特殊化，指的是   具有给定模板参数集的可变模板。

变量模板专业化代表了两个显式   变量模板的专业化，如以下示例所示，以及   变量模板的隐式实例化。

Clang区分类型和类型位置。 Type 更像是一个抽象实体，而 TypeLoc 表示源代码中类型的实际入口。当您在代码中多次键入类型A时，它们都是不同的 TypeLoc ，但是相同的 Type 。

以下是如何获取声明的 TypeLoc 的示例：

bool VisitVarDecl(clang::VarDecl *Decl) {
  auto DeclarationTypeLoc = Decl->getTypeSourceInfo()->getTypeLoc();

  if (auto Specialization =
          DeclarationTypeLoc.getAs<clang::TemplateSpecializationTypeLoc>()) {

    for (auto i : llvm::seq<unsigned>(0, Specialization.getNumArgs())) {
      auto ArgumentLoc = Specialization.getArgLoc(i);
      auto &SM = Context.getSourceManager();
      llvm::errs() << ArgumentLoc.getLocation().printToString(SM) << "\n";
    }
  }
  return true;
}

在以下代码段上运行此代码

// main.cpp

template <class T, class U> class TemplateType {};

class ABC {};
class XYZ {};

int main() {
  TemplateType<ABC, XYZ> Decl;
  return 0;
}

产生以下结果：

.../main.cpp:9:16
.../main.cpp:9:21

注意1 ：根据Clang的版本，您可能使用的不是Decl->getTypeSourceInfo()->getTypeLoc()，而是Decl->getTypeLoc()。

注意2 ：小技巧-不要将访问者功能虚拟化。 lang的访客是CRTP。

更新1

对于更新的测试代码段，声明的 TypeLoc 并非完全是 TemplateSpecializationTypeLoc ，而是围绕它的包装器。手动获取它可能很麻烦且容易出错，因此最好使用Clang遍历器来实现它。

这是更新后的代码（请注意， SpecificationArgumentVisitor 是主要访问者的嵌套类内）：

class SpecificationArgumentVisitor
    : public clang::RecursiveASTVisitor<SpecificationArgumentVisitor> {
public:
  SpecificationArgumentVisitor(clang::ASTContext &Context)
      : SM(Context.getSourceManager()) {}

  bool VisitTemplateSpecializationTypeLoc(
      clang::TemplateSpecializationTypeLoc Specialization) {
    for (auto i : llvm::seq<unsigned>(0, Specialization.getNumArgs())) {
      auto ArgumentLoc = Specialization.getArgLoc(i);
      llvm::errs() << ArgumentLoc.getLocation().printToString(SM) << "\n";
    }
    return true;
  }

private:
  SourceManager &SM;
};

bool VisitVarDecl(clang::VarDecl *Decl) {
  SpecificationArgumentVisitor ArgumentVisitor(Context);
  ArgumentVisitor.TraverseDecl(Decl);
  return true;
}

对于新的测试代码段：

// main.cpp

namespace FOO {
class ABC {};
class XYZ {};

template <class T, class U> class TemplateType {};
} // namespace FOO

using namespace FOO;

int main() {
  TemplateType<ABC, XYZ> Decl;
  FOO::TemplateType<ABC, XYZ> Decl2;
  return 0;
}

它产生以下输出：

.../main.cpp:13:16
.../main.cpp:13:21
.../main.cpp:14:21
.../main.cpp:14:26

注意3 ：它是嵌套的 RecursiveASTVisitor ，因为在最初的问题中，您只想遍历变量声明中的类型的模板专门化。如果您希望它适用于每种情况，则只需使用此访问功能，并且只有一个访问者即可。

我希望这些信息有用。使用Clang进行快乐的黑客入侵！

ClangTool如何在变量声明中获取模板参数的位置？

1 个答案:

更新1