13#include "clang/AST/ASTTypeTraits.h"
14#include "clang/AST/Expr.h"
15#include "clang/AST/ExprCXX.h"
16#include "clang/AST/NestedNameSpecifier.h"
17#include "clang/AST/PrettyPrinter.h"
18#include "clang/AST/RecursiveASTVisitor.h"
19#include "clang/AST/TextNodeDumper.h"
20#include "clang/AST/Type.h"
21#include "clang/AST/TypeLoc.h"
22#include "clang/Basic/Specifiers.h"
23#include "clang/Tooling/Syntax/Tokens.h"
24#include "llvm/ADT/StringRef.h"
25#include "llvm/Support/raw_ostream.h"
32using llvm::raw_ostream;
33template <
typename Pr
int> std::string
toString(
const Print &C) {
35 llvm::raw_string_ostream OS(Result);
37 return std::move(OS.str());
40bool isInjectedClassName(Decl *D) {
41 if (
const auto *CRD = llvm::dyn_cast<CXXRecordDecl>(D))
42 return CRD->isInjectedClassName();
46class DumpVisitor :
public RecursiveASTVisitor<DumpVisitor> {
47 using Base = RecursiveASTVisitor<DumpVisitor>;
49 const syntax::TokenBuffer &Tokens;
50 const ASTContext &Ctx;
55 std::vector<ASTNode *> Stack;
60 bool traverseNodePre(llvm::StringRef Role,
const T &Node) {
62 assert(Root.role.empty());
63 Stack.push_back(&Root);
65 Stack.back()->children.emplace_back();
66 Stack.push_back(&Stack.back()->children.back());
68 auto &N = *Stack.back();
70 N.kind = getKind(Node);
71 N.detail = getDetail(Node);
72 N.range = getRange(Node);
73 N.arcana = getArcana(Node);
76 bool traverseNodePost() {
77 assert(!Stack.empty());
81 template <
typename T,
typename Callable>
82 bool traverseNode(llvm::StringRef Role,
const T &Node,
const Callable &Body) {
83 traverseNodePre(Role, Node);
85 return traverseNodePost();
91 template <
typename T> std::optional<Range> getRange(
const T &Node) {
92 SourceRange SR = getSourceRange(Node);
93 auto Spelled = Tokens.spelledForExpanded(Tokens.expandedTokens(SR));
97 Tokens.sourceManager(),
98 CharSourceRange::getCharRange(
Spelled->front().location(),
99 Spelled->back().endLocation()));
101 template <typename T, typename = decltype(std::declval<T>().getSourceRange())>
102 SourceRange getSourceRange(
const T &Node) {
103 return Node.getSourceRange();
105 template <
typename T,
106 typename =
decltype(std::declval<T *>()->getSourceRange())>
107 SourceRange getSourceRange(
const T *Node) {
108 return Node->getSourceRange();
111 SourceRange getSourceRange(
const TemplateName &Node) {
return SourceRange(); }
113 SourceRange getSourceRange(
const Attr *Node) {
return Node->getRange(); }
118 std::string getKind(
const Decl *D) {
return D->getDeclKindName(); }
119 std::string getKind(
const Stmt *S) {
120 std::string Result = S->getStmtClassName();
121 if (llvm::StringRef(Result).ends_with(
"Stmt") ||
122 llvm::StringRef(Result).ends_with(
"Expr"))
123 Result.resize(Result.size() - 4);
126 std::string getKind(
const TypeLoc &TL) {
127 if (TL.getTypeLocClass() == TypeLoc::Qualified)
129 return TL.getType()->getTypeClassName();
131 std::string getKind(
const TemplateArgumentLoc &TAL) {
132 switch (TAL.getArgument().getKind()) {
133#define TEMPLATE_ARGUMENT_KIND(X) \
134 case TemplateArgument::X: \
146#undef TEMPLATE_ARGUMENT_KIND
148 llvm_unreachable(
"Unhandled ArgKind enum");
150 std::string getKind(NestedNameSpecifierLoc NNSL) {
151 switch (NNSL.getNestedNameSpecifier().getKind()) {
152 case NestedNameSpecifier::Kind::Null:
153 llvm_unreachable(
"unexpected null nested name specifier");
155 case NestedNameSpecifier::Kind::X: \
163 llvm_unreachable(
"Unhandled SpecifierKind enum");
165 std::string getKind(
const CXXCtorInitializer *CCI) {
166 if (CCI->isBaseInitializer())
167 return "BaseInitializer";
168 if (CCI->isDelegatingInitializer())
169 return "DelegatingInitializer";
170 if (CCI->isAnyMemberInitializer())
171 return "MemberInitializer";
172 llvm_unreachable(
"Unhandled CXXCtorInitializer type");
174 std::string getKind(
const TemplateName &TN) {
175 switch (TN.getKind()) {
176#define TEMPLATE_KIND(X) \
177 case TemplateName::X: \
190 llvm_unreachable(
"Unhandled NameKind enum");
192 std::string getKind(
const Attr *A) {
193 switch (
A->getKind()) {
197#include "clang/Basic/AttrList.inc"
200 llvm_unreachable(
"Unhandled attr::Kind enum");
202 std::string getKind(
const CXXBaseSpecifier &CBS) {
205 return getAccessSpelling(CBS.getAccessSpecifier()).str();
207 std::string getKind(
const ConceptReference *CR) {
217 std::string getDetail(
const Decl *D) {
218 const auto *ND = dyn_cast<NamedDecl>(D);
219 if (!ND || llvm::isa_and_nonnull<CXXConstructorDecl>(ND->getAsFunction()) ||
220 isa<CXXDestructorDecl>(ND))
222 std::string Name =
toString([&](raw_ostream &OS) { ND->printName(OS); });
224 return "(anonymous)";
227 std::string getDetail(
const Stmt *S) {
228 if (
const auto *DRE = dyn_cast<DeclRefExpr>(S))
229 return DRE->getNameInfo().getAsString();
230 if (
const auto *DSDRE = dyn_cast<DependentScopeDeclRefExpr>(S))
231 return DSDRE->getNameInfo().getAsString();
232 if (
const auto *ME = dyn_cast<MemberExpr>(S))
233 return ME->getMemberNameInfo().getAsString();
234 if (
const auto *CE = dyn_cast<CastExpr>(S))
235 return CE->getCastKindName();
236 if (
const auto *BO = dyn_cast<BinaryOperator>(S))
237 return BO->getOpcodeStr().str();
238 if (
const auto *UO = dyn_cast<UnaryOperator>(S))
239 return UnaryOperator::getOpcodeStr(UO->getOpcode()).str();
240 if (
const auto *CCO = dyn_cast<CXXConstructExpr>(S))
241 return CCO->getConstructor()->getNameAsString();
242 if (
const auto *CTE = dyn_cast<CXXThisExpr>(S)) {
243 bool Const = CTE->getType()->getPointeeType().isLocalConstQualified();
244 if (CTE->isImplicit())
245 return Const ?
"const, implicit" :
"implicit";
250 if (isa<IntegerLiteral, FloatingLiteral, FixedPointLiteral,
251 CharacterLiteral, ImaginaryLiteral, CXXBoolLiteralExpr>(S))
252 return toString([&](raw_ostream &OS) {
253 S->printPretty(OS,
nullptr, Ctx.getPrintingPolicy());
255 if (
const auto *MTE = dyn_cast<MaterializeTemporaryExpr>(S))
256 return MTE->isBoundToLvalueReference() ?
"lvalue" :
"rvalue";
259 std::string getDetail(
const TypeLoc &TL) {
260 if (TL.getType().hasLocalQualifiers())
261 return TL.getType().getLocalQualifiers().getAsString(
262 Ctx.getPrintingPolicy());
263 if (
const auto *TT = dyn_cast<TagType>(TL.getTypePtr()))
264 return getDetail(TT->getOriginalDecl());
265 if (
const auto *DT = dyn_cast<DeducedType>(TL.getTypePtr()))
267 return DT->getDeducedType().getAsString(Ctx.getPrintingPolicy());
268 if (
const auto *BT = dyn_cast<BuiltinType>(TL.getTypePtr()))
269 return BT->getName(Ctx.getPrintingPolicy()).str();
270 if (
const auto *TTPT = dyn_cast<TemplateTypeParmType>(TL.getTypePtr()))
271 return getDetail(TTPT->getDecl());
272 if (
const auto *TT = dyn_cast<TypedefType>(TL.getTypePtr()))
273 return getDetail(TT->getDecl());
276 std::string getDetail(NestedNameSpecifierLoc NNSL) {
277 NestedNameSpecifier NNS = NNSL.getNestedNameSpecifier();
278 if (NNS.getKind() != NestedNameSpecifier::Kind::Namespace)
280 return NNS.getAsNamespaceAndPrefix().Namespace->getNameAsString() +
"::";
282 std::string getDetail(
const CXXCtorInitializer *CCI) {
283 if (FieldDecl *FD = CCI->getAnyMember())
284 return getDetail(FD);
285 if (TypeLoc TL = CCI->getBaseClassLoc())
286 return getDetail(TL);
289 std::string getDetail(
const TemplateArgumentLoc &TAL) {
290 if (TAL.getArgument().getKind() == TemplateArgument::Integral)
291 return toString(TAL.getArgument().getAsIntegral(), 10);
294 std::string getDetail(
const TemplateName &TN) {
295 return toString([&](raw_ostream &OS) {
296 TN.print(OS, Ctx.getPrintingPolicy(), TemplateName::Qualified::None);
299 std::string getDetail(
const Attr *A) {
300 return A->getAttrName() ?
A->getNormalizedFullName() :
A->getSpelling();
302 std::string getDetail(
const CXXBaseSpecifier &CBS) {
303 return CBS.isVirtual() ?
"virtual" :
"";
305 std::string getDetail(
const ConceptReference *CR) {
306 return CR->getNamedConcept()->getNameAsString();
311 template <
typename Dump> std::string dump(
const Dump &D) {
312 return toString([&](raw_ostream &OS) {
313 TextNodeDumper Dumper(OS, Ctx,
false);
317 template <
typename T> std::string getArcana(
const T &N) {
318 return dump([&](TextNodeDumper &D) {
D.Visit(N); });
320 std::string getArcana(
const NestedNameSpecifierLoc &NNS) {
return ""; }
321 std::string getArcana(
const TemplateName &NNS) {
return ""; }
322 std::string getArcana(
const CXXBaseSpecifier &CBS) {
return ""; }
323 std::string getArcana(
const TemplateArgumentLoc &TAL) {
324 return dump([&](TextNodeDumper &D) {
325 D.Visit(TAL.getArgument(), TAL.getSourceRange());
328 std::string getArcana(
const TypeLoc &TL) {
329 return dump([&](TextNodeDumper &D) {
D.Visit(TL.getType()); });
334 DumpVisitor(
const syntax::TokenBuffer &Tokens,
const ASTContext &Ctx)
335 : Tokens(Tokens), Ctx(Ctx) {}
340 bool TraverseDecl(Decl *D) {
341 return !
D || isInjectedClassName(D) ||
342 traverseNode(
"declaration", D, [&] { Base::TraverseDecl(D); });
344 bool TraverseTypeLoc(TypeLoc TL,
bool TraverseQualifier =
true) {
345 return !TL || traverseNode(
"type", TL, [&] {
346 Base::TraverseTypeLoc(TL, TraverseQualifier);
349 bool TraverseTemplateName(
const TemplateName &TN) {
350 return traverseNode(
"template name", TN,
351 [&] { Base::TraverseTemplateName(TN); });
353 bool TraverseTemplateArgumentLoc(
const TemplateArgumentLoc &TAL) {
354 return traverseNode(
"template argument", TAL,
355 [&] { Base::TraverseTemplateArgumentLoc(TAL); });
357 bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNSL) {
358 return !NNSL || traverseNode(
"specifier", NNSL, [&] {
359 Base::TraverseNestedNameSpecifierLoc(NNSL);
362 bool TraverseConstructorInitializer(CXXCtorInitializer *CCI) {
363 return !CCI || traverseNode(
"constructor initializer", CCI, [&] {
364 Base::TraverseConstructorInitializer(CCI);
367 bool TraverseAttr(Attr *A) {
368 return !
A || traverseNode(
"attribute", A, [&] { Base::TraverseAttr(A); });
370 bool TraverseConceptReference(ConceptReference *C) {
371 return !
C || traverseNode(
"reference", C,
372 [&] { Base::TraverseConceptReference(C); });
374 bool TraverseCXXBaseSpecifier(
const CXXBaseSpecifier &CBS) {
375 return traverseNode(
"base", CBS,
376 [&] { Base::TraverseCXXBaseSpecifier(CBS); });
379 bool dataTraverseStmtPre(Stmt *S) {
380 return S && traverseNodePre(isa<Expr>(S) ?
"expression" :
"statement", S);
382 bool dataTraverseStmtPost(Stmt *
X) {
return traverseNodePost(); }
389 bool TraverseQualifiedTypeLoc(QualifiedTypeLoc QTL,
bool TraverseQualifier) {
390 return TraverseTypeLoc(QTL.getUnqualifiedLoc());
393 bool TraverseNestedNameSpecifier(NestedNameSpecifier) {
return true; }
394 bool TraverseType(QualType) {
return true; }
397 bool TraverseOpaqueValueExpr(OpaqueValueExpr *E) {
398 return TraverseStmt(E->getSourceExpr());
401 bool TraversePseudoObjectExpr(PseudoObjectExpr *E) {
402 return TraverseStmt(E->getSyntacticForm());
409 const ASTContext &Ctx) {
410 DumpVisitor V(Tokens, Ctx);
412 if (
const auto *D = N.get<Decl>())
413 V.TraverseDecl(
const_cast<Decl *
>(D));
414 else if (
const auto *S = N.get<Stmt>())
415 V.TraverseStmt(
const_cast<Stmt *
>(S));
416 else if (
const auto *NNSL = N.get<NestedNameSpecifierLoc>())
417 V.TraverseNestedNameSpecifierLoc(
418 *
const_cast<NestedNameSpecifierLoc *
>(NNSL));
419 else if (
const auto *NNS = N.get<NestedNameSpecifier>())
420 V.TraverseNestedNameSpecifier(*NNS);
421 else if (
const auto *TL = N.get<TypeLoc>())
422 V.TraverseTypeLoc(*
const_cast<TypeLoc *
>(TL));
423 else if (
const auto *QT = N.get<QualType>())
424 V.TraverseType(*
const_cast<QualType *
>(QT));
425 else if (
const auto *CCI = N.get<CXXCtorInitializer>())
426 V.TraverseConstructorInitializer(
const_cast<CXXCtorInitializer *
>(CCI));
427 else if (
const auto *TAL = N.get<TemplateArgumentLoc>())
428 V.TraverseTemplateArgumentLoc(*
const_cast<TemplateArgumentLoc *
>(TAL));
429 else if (
const auto *CBS = N.get<CXXBaseSpecifier>())
430 V.TraverseCXXBaseSpecifier(*
const_cast<CXXBaseSpecifier *
>(CBS));
431 else if (
const auto *CR = N.get<ConceptReference>())
432 V.TraverseConceptReference(
const_cast<ConceptReference *
>(CR));
434 elog(
"dumpAST: unhandled DynTypedNode kind {0}",
435 N.getNodeKind().asStringRef());
436 return std::move(V.Root);
#define TEMPLATE_ARGUMENT_KIND(X)
FIXME: Skip testing on windows temporarily due to the different escaping code mode.
Range halfOpenToRange(const SourceManager &SM, CharSourceRange R)
ASTNode dumpAST(const DynTypedNode &N, const syntax::TokenBuffer &Tokens, const ASTContext &Ctx)
static const char * toString(OffsetEncoding OE)
static URISchemeRegistry::Add< TestScheme > X(TestScheme::Scheme, "Test schema")
@ Type
An inlay hint that for a type annotation.
void elog(const char *Fmt, Ts &&... Vals)
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Simplified description of a clang AST node.