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"
19 #include "clang/Serialization/ASTBitCodes.h"
20 
21 namespace clang {
22 
23 namespace serialization {
24 
25 enum DeclUpdateKind {
26   UPD_CXX_ADDED_IMPLICIT_MEMBER,
27   UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
28   UPD_CXX_ADDED_ANONYMOUS_NAMESPACE,
29   UPD_CXX_ADDED_FUNCTION_DEFINITION,
30   UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
31   UPD_CXX_INSTANTIATED_CLASS_DEFINITION,
32   UPD_CXX_RESOLVED_DTOR_DELETE,
33   UPD_CXX_RESOLVED_EXCEPTION_SPEC,
34   UPD_CXX_DEDUCED_RETURN_TYPE,
35   UPD_DECL_MARKED_USED,
36   UPD_MANGLING_NUMBER,
37   UPD_STATIC_LOCAL_NUMBER,
38   UPD_DECL_MARKED_OPENMP_THREADPRIVATE,
39   UPD_DECL_EXPORTED
40 };
41 
42 TypeIdx TypeIdxFromBuiltin(const BuiltinType *BT);
43 
44 template <typename IdxForTypeTy>
MakeTypeID(ASTContext & Context,QualType T,IdxForTypeTy IdxForType)45 TypeID MakeTypeID(ASTContext &Context, QualType T, IdxForTypeTy IdxForType) {
46   if (T.isNull())
47     return PREDEF_TYPE_NULL_ID;
48 
49   unsigned FastQuals = T.getLocalFastQualifiers();
50   T.removeLocalFastQualifiers();
51 
52   if (T.hasLocalNonFastQualifiers())
53     return IdxForType(T).asTypeID(FastQuals);
54 
55   assert(!T.hasLocalQualifiers());
56 
57   if (const BuiltinType *BT = dyn_cast<BuiltinType>(T.getTypePtr()))
58     return TypeIdxFromBuiltin(BT).asTypeID(FastQuals);
59 
60   if (T == Context.AutoDeductTy)
61     return TypeIdx(PREDEF_TYPE_AUTO_DEDUCT).asTypeID(FastQuals);
62   if (T == Context.AutoRRefDeductTy)
63     return TypeIdx(PREDEF_TYPE_AUTO_RREF_DEDUCT).asTypeID(FastQuals);
64   if (T == Context.VaListTagTy)
65     return TypeIdx(PREDEF_TYPE_VA_LIST_TAG).asTypeID(FastQuals);
66 
67   return IdxForType(T).asTypeID(FastQuals);
68 }
69 
70 unsigned ComputeHash(Selector Sel);
71 
72 /// \brief Retrieve the "definitive" declaration that provides all of the
73 /// visible entries for the given declaration context, if there is one.
74 ///
75 /// The "definitive" declaration is the only place where we need to look to
76 /// find information about the declarations within the given declaration
77 /// context. For example, C++ and Objective-C classes, C structs/unions, and
78 /// Objective-C protocols, categories, and extensions are all defined in a
79 /// single place in the source code, so they have definitive declarations
80 /// associated with them. C++ namespaces, on the other hand, can have
81 /// multiple definitions.
82 const DeclContext *getDefinitiveDeclContext(const DeclContext *DC);
83 
84 /// \brief Determine whether the given declaration kind is redeclarable.
85 bool isRedeclarableDeclKind(unsigned Kind);
86 
87 /// \brief Determine whether the given declaration needs an anonymous
88 /// declaration number.
89 bool needsAnonymousDeclarationNumber(const NamedDecl *D);
90 
91 /// \brief Visit each declaration within \c DC that needs an anonymous
92 /// declaration number and call \p Visit with the declaration and its number.
numberAnonymousDeclsWithin(const DeclContext * DC,Fn Visit)93 template<typename Fn> void numberAnonymousDeclsWithin(const DeclContext *DC,
94                                                       Fn Visit) {
95   unsigned Index = 0;
96   for (Decl *LexicalD : DC->decls()) {
97     // For a friend decl, we care about the declaration within it, if any.
98     if (auto *FD = dyn_cast<FriendDecl>(LexicalD))
99       LexicalD = FD->getFriendDecl();
100 
101     auto *ND = dyn_cast_or_null<NamedDecl>(LexicalD);
102     if (!ND || !needsAnonymousDeclarationNumber(ND))
103       continue;
104 
105     Visit(ND, Index++);
106   }
107 }
108 
109 } // namespace serialization
110 
111 } // namespace clang
112 
113 #endif
114