clang  3.9.0
ASTTypeTraits.cpp
Go to the documentation of this file.
1 //===--- ASTTypeTraits.cpp --------------------------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Provides a dynamic type identifier and a dynamically typed node container
11 // that can be used to store an AST base node at runtime in the same storage in
12 // a type safe way.
13 //
14 //===----------------------------------------------------------------------===//
15 
17 #include "clang/AST/ASTContext.h"
18 #include "clang/AST/DeclCXX.h"
19 
20 namespace clang {
21 namespace ast_type_traits {
22 
23 const ASTNodeKind::KindInfo ASTNodeKind::AllKindInfo[] = {
24  { NKI_None, "<None>" },
25  { NKI_None, "TemplateArgument" },
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 };
41 
42 bool ASTNodeKind::isBaseOf(ASTNodeKind Other, unsigned *Distance) const {
43  return isBaseOf(KindId, Other.KindId, Distance);
44 }
45 
46 bool ASTNodeKind::isBaseOf(NodeKindId Base, NodeKindId Derived,
47  unsigned *Distance) {
48  if (Base == NKI_None || Derived == NKI_None) return false;
49  unsigned Dist = 0;
50  while (Derived != Base && Derived != NKI_None) {
51  Derived = AllKindInfo[Derived].ParentId;
52  ++Dist;
53  }
54  if (Distance)
55  *Distance = Dist;
56  return Derived == Base;
57 }
58 
59 StringRef ASTNodeKind::asStringRef() const { return AllKindInfo[KindId].Name; }
60 
62  ASTNodeKind Kind2) {
63  if (Kind1.isBaseOf(Kind2)) return Kind2;
64  if (Kind2.isBaseOf(Kind1)) return Kind1;
65  return ASTNodeKind();
66 }
67 
69  ASTNodeKind Kind2) {
70  NodeKindId Parent = Kind1.KindId;
71  while (!isBaseOf(Parent, Kind2.KindId, nullptr) && Parent != NKI_None) {
72  Parent = AllKindInfo[Parent].ParentId;
73  }
74  return ASTNodeKind(Parent);
75 }
76 
78  switch (D.getKind()) {
79 #define DECL(DERIVED, BASE) \
80  case Decl::DERIVED: return ASTNodeKind(NKI_##DERIVED##Decl);
81 #define ABSTRACT_DECL(D)
82 #include "clang/AST/DeclNodes.inc"
83  };
84  llvm_unreachable("invalid decl kind");
85 }
86 
88  switch (S.getStmtClass()) {
89  case Stmt::NoStmtClass: return NKI_None;
90 #define STMT(CLASS, PARENT) \
91  case Stmt::CLASS##Class: return ASTNodeKind(NKI_##CLASS);
92 #define ABSTRACT_STMT(S)
93 #include "clang/AST/StmtNodes.inc"
94  }
95  llvm_unreachable("invalid stmt kind");
96 }
97 
99  switch (T.getTypeClass()) {
100 #define TYPE(Class, Base) \
101  case Type::Class: return ASTNodeKind(NKI_##Class##Type);
102 #define ABSTRACT_TYPE(Class, Base)
103 #include "clang/AST/TypeNodes.def"
104  }
105  llvm_unreachable("invalid type kind");
106 }
107 
108 void DynTypedNode::print(llvm::raw_ostream &OS,
109  const PrintingPolicy &PP) const {
110  if (const TemplateArgument *TA = get<TemplateArgument>())
111  TA->print(PP, OS);
112  else if (const NestedNameSpecifier *NNS = get<NestedNameSpecifier>())
113  NNS->print(OS, PP);
114  else if (const NestedNameSpecifierLoc *NNSL = get<NestedNameSpecifierLoc>())
115  NNSL->getNestedNameSpecifier()->print(OS, PP);
116  else if (const QualType *QT = get<QualType>())
117  QT->print(OS, PP);
118  else if (const TypeLoc *TL = get<TypeLoc>())
119  TL->getType().print(OS, PP);
120  else if (const Decl *D = get<Decl>())
121  D->print(OS, PP);
122  else if (const Stmt *S = get<Stmt>())
123  S->printPretty(OS, nullptr, PP);
124  else if (const Type *T = get<Type>())
125  QualType(T, 0).print(OS, PP);
126  else
127  OS << "Unable to print values of type " << NodeKind.asStringRef() << "\n";
128 }
129 
130 void DynTypedNode::dump(llvm::raw_ostream &OS, SourceManager &SM) const {
131  if (const Decl *D = get<Decl>())
132  D->dump(OS);
133  else if (const Stmt *S = get<Stmt>())
134  S->dump(OS, SM);
135  else
136  OS << "Unable to dump values of type " << NodeKind.asStringRef() << "\n";
137 }
138 
140  if (const CXXCtorInitializer *CCI = get<CXXCtorInitializer>())
141  return CCI->getSourceRange();
142  if (const NestedNameSpecifierLoc *NNSL = get<NestedNameSpecifierLoc>())
143  return NNSL->getSourceRange();
144  if (const TypeLoc *TL = get<TypeLoc>())
145  return TL->getSourceRange();
146  if (const Decl *D = get<Decl>())
147  return D->getSourceRange();
148  if (const Stmt *S = get<Stmt>())
149  return S->getSourceRange();
150  return SourceRange();
151 }
152 
153 } // end namespace ast_type_traits
154 } // end namespace clang
Defines the clang::ASTContext interface.
A (possibly-)qualified type.
Definition: Type.h:598
static ASTNodeKind getFromNode(const Decl &D)
Construct an identifier for the dynamic type of the node.
The base class of the type hierarchy.
Definition: Type.h:1281
Describes how types, statements, expressions, and declarations should be printed. ...
Definition: PrettyPrinter.h:38
Base wrapper for a particular "section" of type source info.
Definition: TypeLoc.h:40
A C++ nested-name-specifier augmented with source location information.
bool isBaseOf(ASTNodeKind Other, unsigned *Distance=nullptr) const
Returns true if this is a base kind of (or same as) Other.
ASTNodeKind()
Empty identifier. It matches nothing.
Definition: ASTTypeTraits.h:49
void print(raw_ostream &OS, const PrintingPolicy &Policy, const Twine &PlaceHolder=Twine(), unsigned Indentation=0) const
Definition: Type.h:934
TypeClass getTypeClass() const
Definition: Type.h:1533
void dump(llvm::raw_ostream &OS, SourceManager &SM) const
Dumps the node to the given output stream.
static ASTNodeKind getMostDerivedType(ASTNodeKind Kind1, ASTNodeKind Kind2)
Return the most derived type between Kind1 and Kind2.
const SourceManager & SM
Definition: Format.cpp:1184
Represents a C++ nested name specifier, such as "\::std::vector<int>::".
StringRef asStringRef() const
String representation of the kind.
Represents a template argument.
Definition: TemplateBase.h:40
static ASTNodeKind getMostDerivedCommonAncestor(ASTNodeKind Kind1, ASTNodeKind Kind2)
Return the most derived common ancestor between Kind1 and Kind2.
Represents a C++ base or member initializer.
Definition: DeclCXX.h:1922
SourceRange getSourceRange() const
For nodes which represent textual entities in the source code, return their SourceRange.
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.
void print(llvm::raw_ostream &OS, const PrintingPolicy &PP) const
Prints the node to the given output stream.
This class handles loading and caching of source files into memory.