clang  9.0.0svn
ASTTypeTraits.cpp
Go to the documentation of this file.
1 //===--- ASTTypeTraits.cpp --------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // Provides a dynamic type identifier and a dynamically typed node container
10 // that can be used to store an AST base node at runtime in the same storage in
11 // a type safe way.
12 //
13 //===----------------------------------------------------------------------===//
14 
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/DeclCXX.h"
18 
19 namespace clang {
20 namespace ast_type_traits {
21 
22 const ASTNodeKind::KindInfo ASTNodeKind::AllKindInfo[] = {
23  { NKI_None, "<None>" },
24  { NKI_None, "TemplateArgument" },
25  { NKI_None, "TemplateName" },
26  { NKI_None, "NestedNameSpecifierLoc" },
27  { NKI_None, "QualType" },
28  { NKI_None, "TypeLoc" },
29  { NKI_None, "CXXCtorInitializer" },
30  { NKI_None, "NestedNameSpecifier" },
31  { NKI_None, "Decl" },
32 #define DECL(DERIVED, BASE) { NKI_##BASE, #DERIVED "Decl" },
33 #include "clang/AST/DeclNodes.inc"
34  { NKI_None, "Stmt" },
35 #define STMT(DERIVED, BASE) { NKI_##BASE, #DERIVED },
36 #include "clang/AST/StmtNodes.inc"
37  { NKI_None, "Type" },
38 #define TYPE(DERIVED, BASE) { NKI_##BASE, #DERIVED "Type" },
39 #include "clang/AST/TypeNodes.def"
40  { NKI_None, "OMPClause" },
41 #define OPENMP_CLAUSE(TextualSpelling, Class) {NKI_OMPClause, #Class},
42 #include "clang/Basic/OpenMPKinds.def"
43 };
44 
45 bool ASTNodeKind::isBaseOf(ASTNodeKind Other, unsigned *Distance) const {
46  return isBaseOf(KindId, Other.KindId, Distance);
47 }
48 
49 bool ASTNodeKind::isBaseOf(NodeKindId Base, NodeKindId Derived,
50  unsigned *Distance) {
51  if (Base == NKI_None || Derived == NKI_None) return false;
52  unsigned Dist = 0;
53  while (Derived != Base && Derived != NKI_None) {
54  Derived = AllKindInfo[Derived].ParentId;
55  ++Dist;
56  }
57  if (Distance)
58  *Distance = Dist;
59  return Derived == Base;
60 }
61 
62 StringRef ASTNodeKind::asStringRef() const { return AllKindInfo[KindId].Name; }
63 
65  ASTNodeKind Kind2) {
66  if (Kind1.isBaseOf(Kind2)) return Kind2;
67  if (Kind2.isBaseOf(Kind1)) return Kind1;
68  return ASTNodeKind();
69 }
70 
72  ASTNodeKind Kind2) {
73  NodeKindId Parent = Kind1.KindId;
74  while (!isBaseOf(Parent, Kind2.KindId, nullptr) && Parent != NKI_None) {
75  Parent = AllKindInfo[Parent].ParentId;
76  }
77  return ASTNodeKind(Parent);
78 }
79 
81  switch (D.getKind()) {
82 #define DECL(DERIVED, BASE) \
83  case Decl::DERIVED: return ASTNodeKind(NKI_##DERIVED##Decl);
84 #define ABSTRACT_DECL(D)
85 #include "clang/AST/DeclNodes.inc"
86  };
87  llvm_unreachable("invalid decl kind");
88 }
89 
91  switch (S.getStmtClass()) {
92  case Stmt::NoStmtClass: return NKI_None;
93 #define STMT(CLASS, PARENT) \
94  case Stmt::CLASS##Class: return ASTNodeKind(NKI_##CLASS);
95 #define ABSTRACT_STMT(S)
96 #include "clang/AST/StmtNodes.inc"
97  }
98  llvm_unreachable("invalid stmt kind");
99 }
100 
102  switch (T.getTypeClass()) {
103 #define TYPE(Class, Base) \
104  case Type::Class: return ASTNodeKind(NKI_##Class##Type);
105 #define ABSTRACT_TYPE(Class, Base)
106 #include "clang/AST/TypeNodes.def"
107  }
108  llvm_unreachable("invalid type kind");
109  }
110 
112  switch (C.getClauseKind()) {
113 #define OPENMP_CLAUSE(Name, Class) \
114  case OMPC_##Name: return ASTNodeKind(NKI_##Class);
115 #include "clang/Basic/OpenMPKinds.def"
116  case OMPC_threadprivate:
117  case OMPC_uniform:
118  case OMPC_unknown:
119  llvm_unreachable("unexpected OpenMP clause kind");
120  }
121  llvm_unreachable("invalid stmt kind");
122 }
123 
124 void DynTypedNode::print(llvm::raw_ostream &OS,
125  const PrintingPolicy &PP) const {
126  if (const TemplateArgument *TA = get<TemplateArgument>())
127  TA->print(PP, OS);
128  else if (const TemplateName *TN = get<TemplateName>())
129  TN->print(OS, PP);
130  else if (const NestedNameSpecifier *NNS = get<NestedNameSpecifier>())
131  NNS->print(OS, PP);
132  else if (const NestedNameSpecifierLoc *NNSL = get<NestedNameSpecifierLoc>())
133  NNSL->getNestedNameSpecifier()->print(OS, PP);
134  else if (const QualType *QT = get<QualType>())
135  QT->print(OS, PP);
136  else if (const TypeLoc *TL = get<TypeLoc>())
137  TL->getType().print(OS, PP);
138  else if (const Decl *D = get<Decl>())
139  D->print(OS, PP);
140  else if (const Stmt *S = get<Stmt>())
141  S->printPretty(OS, nullptr, PP);
142  else if (const Type *T = get<Type>())
143  QualType(T, 0).print(OS, PP);
144  else
145  OS << "Unable to print values of type " << NodeKind.asStringRef() << "\n";
146 }
147 
148 void DynTypedNode::dump(llvm::raw_ostream &OS, SourceManager &SM) const {
149  if (const Decl *D = get<Decl>())
150  D->dump(OS);
151  else if (const Stmt *S = get<Stmt>())
152  S->dump(OS, SM);
153  else if (const Type *T = get<Type>())
154  T->dump(OS);
155  else
156  OS << "Unable to dump values of type " << NodeKind.asStringRef() << "\n";
157 }
158 
160  if (const CXXCtorInitializer *CCI = get<CXXCtorInitializer>())
161  return CCI->getSourceRange();
162  if (const NestedNameSpecifierLoc *NNSL = get<NestedNameSpecifierLoc>())
163  return NNSL->getSourceRange();
164  if (const TypeLoc *TL = get<TypeLoc>())
165  return TL->getSourceRange();
166  if (const Decl *D = get<Decl>())
167  return D->getSourceRange();
168  if (const Stmt *S = get<Stmt>())
169  return S->getSourceRange();
170  if (const auto *C = get<OMPClause>())
171  return SourceRange(C->getBeginLoc(), C->getEndLoc());
172  return SourceRange();
173 }
174 
175 } // end namespace ast_type_traits
176 } // end namespace clang
Defines the clang::ASTContext interface.
A (possibly-)qualified type.
Definition: Type.h:643
static ASTNodeKind getFromNode(const Decl &D)
Stmt - This represents one statement.
Definition: Stmt.h:66
StringRef asStringRef() const
String representation of the kind.
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:88
The base class of the type hierarchy.
Definition: Type.h:1418
Describes how types, statements, expressions, and declarations should be printed. ...
Definition: PrettyPrinter.h:37
Base wrapper for a particular "section" of type source info.
Definition: TypeLoc.h:56
A C++ nested-name-specifier augmented with source location information.
ASTNodeKind()
Empty identifier. It matches nothing.
Definition: ASTTypeTraits.h:60
void print(raw_ostream &OS, const PrintingPolicy &Policy, const Twine &PlaceHolder=Twine(), unsigned Indentation=0) const
void dump(llvm::raw_ostream &OS, SourceManager &SM) const
Dumps the node to the given output stream.
NodeId Parent
Definition: ASTDiff.cpp:191
OpenMPClauseKind getClauseKind() const
Returns kind of OpenMP clause (private, shared, reduction, etc.).
Definition: OpenMPClause.h:78
Represents a C++ template name within the type system.
Definition: TemplateName.h:187
static ASTNodeKind getMostDerivedType(ASTNodeKind Kind1, ASTNodeKind Kind2)
Return the most derived type between Kind1 and Kind2.
SourceRange getSourceRange() const
For nodes which represent textual entities in the source code, return their SourceRange.
const SourceManager & SM
Definition: Format.cpp:1570
Represents a C++ nested name specifier, such as "\::std::vector<int>::".
This is a basic class for representing single OpenMP clause.
Definition: OpenMPClause.h:50
TypeClass getTypeClass() const
Definition: Type.h:1824
bool isBaseOf(ASTNodeKind Other, unsigned *Distance=nullptr) const
Returns true if this is a base kind of (or same as) Other.
Represents a template argument.
Definition: TemplateBase.h:50
static ASTNodeKind getMostDerivedCommonAncestor(ASTNodeKind Kind1, ASTNodeKind Kind2)
Return the most derived common ancestor between Kind1 and Kind2.
Dataflow Directional Tag Classes.
StmtClass getStmtClass() const
Definition: Stmt.h:1080
Kind getKind() const
Definition: DeclBase.h:432
Represents a C++ base or member initializer.
Definition: DeclCXX.h:2333
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
A trivial tuple used to represent a source range.
This class handles loading and caching of source files into memory.
void print(llvm::raw_ostream &OS, const PrintingPolicy &PP) const
Prints the node to the given output stream.