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