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

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>();

快速引用

• 我正在使用此 blog 中的引用代码, 这里是 full code .
• clang::VarTemplateSpecializationDecl
• clang::TemplateArgumentListInfo
• clang::TemplateArgumentLoc
• clang::TemplateArgument
• clang::TemplateSpecializationType

麻烦的测试用例

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

这是一个简单的测试用例。变量 Decl在他的解决方案中找到但是Decl2不是。 Actor 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) 特化。

Represents a variable template specialization, which refers to a variable template with a given set of template arguments.

Variable template specializations represent both explicit specializations of variable templates, as in the example below, and implicit instantiations of variable templates.

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:小提示 - 不要让访问者功能虚拟化。 Clang的访客是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 愉快!