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