clang  5.0.0
ASTCommon.h
Go to the documentation of this file.
1 //===- ASTCommon.h - Common stuff for ASTReader/ASTWriter -*- 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 // This file defines common functions that both ASTReader and ASTWriter use.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LIB_SERIALIZATION_ASTCOMMON_H
15 #define LLVM_CLANG_LIB_SERIALIZATION_ASTCOMMON_H
16 
17 #include "clang/AST/ASTContext.h"
18 #include "clang/AST/DeclFriend.h"
20 
21 namespace clang {
22 
23 namespace serialization {
24 
44 };
45 
46 TypeIdx TypeIdxFromBuiltin(const BuiltinType *BT);
47 
48 template <typename IdxForTypeTy>
49 TypeID MakeTypeID(ASTContext &Context, QualType T, IdxForTypeTy IdxForType) {
50  if (T.isNull())
51  return PREDEF_TYPE_NULL_ID;
52 
53  unsigned FastQuals = T.getLocalFastQualifiers();
55 
57  return IdxForType(T).asTypeID(FastQuals);
58 
59  assert(!T.hasLocalQualifiers());
60 
61  if (const BuiltinType *BT = dyn_cast<BuiltinType>(T.getTypePtr()))
62  return TypeIdxFromBuiltin(BT).asTypeID(FastQuals);
63 
64  if (T == Context.AutoDeductTy)
65  return TypeIdx(PREDEF_TYPE_AUTO_DEDUCT).asTypeID(FastQuals);
66  if (T == Context.AutoRRefDeductTy)
68 
69  return IdxForType(T).asTypeID(FastQuals);
70 }
71 
72 unsigned ComputeHash(Selector Sel);
73 
74 /// \brief Retrieve the "definitive" declaration that provides all of the
75 /// visible entries for the given declaration context, if there is one.
76 ///
77 /// The "definitive" declaration is the only place where we need to look to
78 /// find information about the declarations within the given declaration
79 /// context. For example, C++ and Objective-C classes, C structs/unions, and
80 /// Objective-C protocols, categories, and extensions are all defined in a
81 /// single place in the source code, so they have definitive declarations
82 /// associated with them. C++ namespaces, on the other hand, can have
83 /// multiple definitions.
85 
86 /// \brief Determine whether the given declaration kind is redeclarable.
87 bool isRedeclarableDeclKind(unsigned Kind);
88 
89 /// \brief Determine whether the given declaration needs an anonymous
90 /// declaration number.
92 
93 /// \brief Visit each declaration within \c DC that needs an anonymous
94 /// declaration number and call \p Visit with the declaration and its number.
95 template<typename Fn> void numberAnonymousDeclsWithin(const DeclContext *DC,
96  Fn Visit) {
97  unsigned Index = 0;
98  for (Decl *LexicalD : DC->decls()) {
99  // For a friend decl, we care about the declaration within it, if any.
100  if (auto *FD = dyn_cast<FriendDecl>(LexicalD))
101  LexicalD = FD->getFriendDecl();
102 
103  auto *ND = dyn_cast_or_null<NamedDecl>(LexicalD);
104  if (!ND || !needsAnonymousDeclarationNumber(ND))
105  continue;
106 
107  Visit(ND, Index++);
108  }
109 }
110 
111 } // namespace serialization
112 
113 } // namespace clang
114 
115 #endif
Defines the clang::ASTContext interface.
Smart pointer class that efficiently represents Objective-C method names.
bool isRedeclarableDeclKind(unsigned Kind)
Determine whether the given declaration kind is redeclarable.
Definition: ASTCommon.cpp:235
A (possibly-)qualified type.
Definition: Type.h:616
decl_range decls() const
decls_begin/decls_end - Iterate over the declarations stored in this context.
Definition: DeclBase.h:1537
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:81
const DeclContext * getDefinitiveDeclContext(const DeclContext *DC)
Retrieve the "definitive" declaration that provides all of the visible entries for the given declarat...
Definition: ASTCommon.cpp:176
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:128
TypeID MakeTypeID(ASTContext &Context, QualType T, IdxForTypeTy IdxForType)
Definition: ASTCommon.h:49
ASTContext * Context
bool hasLocalQualifiers() const
Determine whether this particular QualType instance has any qualifiers, without looking through any t...
Definition: Type.h:720
unsigned getLocalFastQualifiers() const
Definition: Type.h:646
Kind
const Type * getTypePtr() const
Retrieves a pointer to the underlying (unqualified) type.
Definition: Type.h:5489
TypeIdx TypeIdxFromBuiltin(const BuiltinType *BT)
Definition: ASTCommon.cpp:27
QualType AutoDeductTy
Definition: ASTContext.h:992
unsigned ComputeHash(Selector Sel)
Definition: ASTCommon.cpp:164
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1215
void removeLocalFastQualifiers()
Definition: Type.h:817
bool hasLocalNonFastQualifiers() const
Determine whether this particular QualType instance has any "non-fast" qualifiers, e.g., those that are stored in an ExtQualType instance.
Definition: Type.h:730
QualType AutoRRefDeductTy
Definition: ASTContext.h:993
TypeID asTypeID(unsigned FastQuals) const
Definition: ASTBitCodes.h:90
bool needsAnonymousDeclarationNumber(const NamedDecl *D)
Determine whether the given declaration needs an anonymous declaration number.
Definition: ASTCommon.cpp:326
This class is used for builtin types like 'int'.
Definition: Type.h:2084
uint32_t TypeID
An ID number that refers to a type in an AST file.
Definition: ASTBitCodes.h:80
NamedDecl - This represents a decl with a name.
Definition: Decl.h:213
void numberAnonymousDeclsWithin(const DeclContext *DC, Fn Visit)
Visit each declaration within DC that needs an anonymous declaration number and call Visit with the d...
Definition: ASTCommon.h:95
bool isNull() const
Return true if this QualType doesn't point to a type yet.
Definition: Type.h:683
A type index; the type ID with the qualifier bits removed.
Definition: ASTBitCodes.h:83