1 //===--- ASTCommon.cpp - 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 #include "ASTCommon.h" 15 #include "clang/AST/DeclCXX.h" 16 #include "clang/AST/DeclObjC.h" 17 #include "clang/Basic/IdentifierTable.h" 18 #include "clang/Serialization/ASTDeserializationListener.h" 19 #include "llvm/ADT/StringExtras.h" 20 21 using namespace clang; 22 23 // Give ASTDeserializationListener's VTable a home. 24 ASTDeserializationListener::~ASTDeserializationListener() { } 25 26 serialization::TypeIdx 27 serialization::TypeIdxFromBuiltin(const BuiltinType *BT) { 28 unsigned ID = 0; 29 switch (BT->getKind()) { 30 case BuiltinType::Void: 31 ID = PREDEF_TYPE_VOID_ID; 32 break; 33 case BuiltinType::Bool: 34 ID = PREDEF_TYPE_BOOL_ID; 35 break; 36 case BuiltinType::Char_U: 37 ID = PREDEF_TYPE_CHAR_U_ID; 38 break; 39 case BuiltinType::UChar: 40 ID = PREDEF_TYPE_UCHAR_ID; 41 break; 42 case BuiltinType::UShort: 43 ID = PREDEF_TYPE_USHORT_ID; 44 break; 45 case BuiltinType::UInt: 46 ID = PREDEF_TYPE_UINT_ID; 47 break; 48 case BuiltinType::ULong: 49 ID = PREDEF_TYPE_ULONG_ID; 50 break; 51 case BuiltinType::ULongLong: 52 ID = PREDEF_TYPE_ULONGLONG_ID; 53 break; 54 case BuiltinType::UInt128: 55 ID = PREDEF_TYPE_UINT128_ID; 56 break; 57 case BuiltinType::Char_S: 58 ID = PREDEF_TYPE_CHAR_S_ID; 59 break; 60 case BuiltinType::SChar: 61 ID = PREDEF_TYPE_SCHAR_ID; 62 break; 63 case BuiltinType::WChar_S: 64 case BuiltinType::WChar_U: 65 ID = PREDEF_TYPE_WCHAR_ID; 66 break; 67 case BuiltinType::Short: 68 ID = PREDEF_TYPE_SHORT_ID; 69 break; 70 case BuiltinType::Int: 71 ID = PREDEF_TYPE_INT_ID; 72 break; 73 case BuiltinType::Long: 74 ID = PREDEF_TYPE_LONG_ID; 75 break; 76 case BuiltinType::LongLong: 77 ID = PREDEF_TYPE_LONGLONG_ID; 78 break; 79 case BuiltinType::Int128: 80 ID = PREDEF_TYPE_INT128_ID; 81 break; 82 case BuiltinType::Half: 83 ID = PREDEF_TYPE_HALF_ID; 84 break; 85 case BuiltinType::Float: 86 ID = PREDEF_TYPE_FLOAT_ID; 87 break; 88 case BuiltinType::Double: 89 ID = PREDEF_TYPE_DOUBLE_ID; 90 break; 91 case BuiltinType::LongDouble: 92 ID = PREDEF_TYPE_LONGDOUBLE_ID; 93 break; 94 case BuiltinType::Float128: 95 ID = PREDEF_TYPE_FLOAT128_ID; 96 break; 97 case BuiltinType::NullPtr: 98 ID = PREDEF_TYPE_NULLPTR_ID; 99 break; 100 case BuiltinType::Char16: 101 ID = PREDEF_TYPE_CHAR16_ID; 102 break; 103 case BuiltinType::Char32: 104 ID = PREDEF_TYPE_CHAR32_ID; 105 break; 106 case BuiltinType::Overload: 107 ID = PREDEF_TYPE_OVERLOAD_ID; 108 break; 109 case BuiltinType::BoundMember: 110 ID = PREDEF_TYPE_BOUND_MEMBER; 111 break; 112 case BuiltinType::PseudoObject: 113 ID = PREDEF_TYPE_PSEUDO_OBJECT; 114 break; 115 case BuiltinType::Dependent: 116 ID = PREDEF_TYPE_DEPENDENT_ID; 117 break; 118 case BuiltinType::UnknownAny: 119 ID = PREDEF_TYPE_UNKNOWN_ANY; 120 break; 121 case BuiltinType::ARCUnbridgedCast: 122 ID = PREDEF_TYPE_ARC_UNBRIDGED_CAST; 123 break; 124 case BuiltinType::ObjCId: 125 ID = PREDEF_TYPE_OBJC_ID; 126 break; 127 case BuiltinType::ObjCClass: 128 ID = PREDEF_TYPE_OBJC_CLASS; 129 break; 130 case BuiltinType::ObjCSel: 131 ID = PREDEF_TYPE_OBJC_SEL; 132 break; 133 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \ 134 case BuiltinType::Id: \ 135 ID = PREDEF_TYPE_##Id##_ID; \ 136 break; 137 #include "clang/Basic/OpenCLImageTypes.def" 138 case BuiltinType::OCLSampler: 139 ID = PREDEF_TYPE_SAMPLER_ID; 140 break; 141 case BuiltinType::OCLEvent: 142 ID = PREDEF_TYPE_EVENT_ID; 143 break; 144 case BuiltinType::OCLClkEvent: 145 ID = PREDEF_TYPE_CLK_EVENT_ID; 146 break; 147 case BuiltinType::OCLQueue: 148 ID = PREDEF_TYPE_QUEUE_ID; 149 break; 150 case BuiltinType::OCLReserveID: 151 ID = PREDEF_TYPE_RESERVE_ID_ID; 152 break; 153 case BuiltinType::BuiltinFn: 154 ID = PREDEF_TYPE_BUILTIN_FN; 155 break; 156 case BuiltinType::OMPArraySection: 157 ID = PREDEF_TYPE_OMP_ARRAY_SECTION; 158 break; 159 } 160 161 return TypeIdx(ID); 162 } 163 164 unsigned serialization::ComputeHash(Selector Sel) { 165 unsigned N = Sel.getNumArgs(); 166 if (N == 0) 167 ++N; 168 unsigned R = 5381; 169 for (unsigned I = 0; I != N; ++I) 170 if (IdentifierInfo *II = Sel.getIdentifierInfoForSlot(I)) 171 R = llvm::HashString(II->getName(), R); 172 return R; 173 } 174 175 const DeclContext * 176 serialization::getDefinitiveDeclContext(const DeclContext *DC) { 177 switch (DC->getDeclKind()) { 178 // These entities may have multiple definitions. 179 case Decl::TranslationUnit: 180 case Decl::ExternCContext: 181 case Decl::Namespace: 182 case Decl::LinkageSpec: 183 case Decl::Export: 184 return nullptr; 185 186 // C/C++ tag types can only be defined in one place. 187 case Decl::Enum: 188 case Decl::Record: 189 if (const TagDecl *Def = cast<TagDecl>(DC)->getDefinition()) 190 return Def; 191 return nullptr; 192 193 // FIXME: These can be defined in one place... except special member 194 // functions and out-of-line definitions. 195 case Decl::CXXRecord: 196 case Decl::ClassTemplateSpecialization: 197 case Decl::ClassTemplatePartialSpecialization: 198 return nullptr; 199 200 // Each function, method, and block declaration is its own DeclContext. 201 case Decl::Function: 202 case Decl::CXXMethod: 203 case Decl::CXXConstructor: 204 case Decl::CXXDestructor: 205 case Decl::CXXConversion: 206 case Decl::ObjCMethod: 207 case Decl::Block: 208 case Decl::Captured: 209 // Objective C categories, category implementations, and class 210 // implementations can only be defined in one place. 211 case Decl::ObjCCategory: 212 case Decl::ObjCCategoryImpl: 213 case Decl::ObjCImplementation: 214 return DC; 215 216 case Decl::ObjCProtocol: 217 if (const ObjCProtocolDecl *Def 218 = cast<ObjCProtocolDecl>(DC)->getDefinition()) 219 return Def; 220 return nullptr; 221 222 // FIXME: These are defined in one place, but properties in class extensions 223 // end up being back-patched into the main interface. See 224 // Sema::HandlePropertyInClassExtension for the offending code. 225 case Decl::ObjCInterface: 226 return nullptr; 227 228 default: 229 llvm_unreachable("Unhandled DeclContext in AST reader"); 230 } 231 232 llvm_unreachable("Unhandled decl kind"); 233 } 234 235 bool serialization::isRedeclarableDeclKind(unsigned Kind) { 236 switch (static_cast<Decl::Kind>(Kind)) { 237 case Decl::TranslationUnit: 238 case Decl::ExternCContext: 239 // Special case of a "merged" declaration. 240 return true; 241 242 case Decl::Namespace: 243 case Decl::NamespaceAlias: 244 case Decl::Typedef: 245 case Decl::TypeAlias: 246 case Decl::Enum: 247 case Decl::Record: 248 case Decl::CXXRecord: 249 case Decl::ClassTemplateSpecialization: 250 case Decl::ClassTemplatePartialSpecialization: 251 case Decl::VarTemplateSpecialization: 252 case Decl::VarTemplatePartialSpecialization: 253 case Decl::Function: 254 case Decl::CXXDeductionGuide: 255 case Decl::CXXMethod: 256 case Decl::CXXConstructor: 257 case Decl::CXXDestructor: 258 case Decl::CXXConversion: 259 case Decl::UsingShadow: 260 case Decl::ConstructorUsingShadow: 261 case Decl::Var: 262 case Decl::FunctionTemplate: 263 case Decl::ClassTemplate: 264 case Decl::VarTemplate: 265 case Decl::TypeAliasTemplate: 266 case Decl::ObjCProtocol: 267 case Decl::ObjCInterface: 268 case Decl::Empty: 269 return true; 270 271 // Never redeclarable. 272 case Decl::UsingDirective: 273 case Decl::Label: 274 case Decl::UnresolvedUsingTypename: 275 case Decl::TemplateTypeParm: 276 case Decl::EnumConstant: 277 case Decl::UnresolvedUsingValue: 278 case Decl::IndirectField: 279 case Decl::Field: 280 case Decl::MSProperty: 281 case Decl::ObjCIvar: 282 case Decl::ObjCAtDefsField: 283 case Decl::NonTypeTemplateParm: 284 case Decl::TemplateTemplateParm: 285 case Decl::Using: 286 case Decl::UsingPack: 287 case Decl::ObjCMethod: 288 case Decl::ObjCCategory: 289 case Decl::ObjCCategoryImpl: 290 case Decl::ObjCImplementation: 291 case Decl::ObjCProperty: 292 case Decl::ObjCCompatibleAlias: 293 case Decl::LinkageSpec: 294 case Decl::Export: 295 case Decl::ObjCPropertyImpl: 296 case Decl::PragmaComment: 297 case Decl::PragmaDetectMismatch: 298 case Decl::FileScopeAsm: 299 case Decl::AccessSpec: 300 case Decl::Friend: 301 case Decl::FriendTemplate: 302 case Decl::StaticAssert: 303 case Decl::Block: 304 case Decl::Captured: 305 case Decl::ClassScopeFunctionSpecialization: 306 case Decl::Import: 307 case Decl::OMPThreadPrivate: 308 case Decl::OMPCapturedExpr: 309 case Decl::OMPDeclareReduction: 310 case Decl::BuiltinTemplate: 311 case Decl::Decomposition: 312 case Decl::Binding: 313 return false; 314 315 // These indirectly derive from Redeclarable<T> but are not actually 316 // redeclarable. 317 case Decl::ImplicitParam: 318 case Decl::ParmVar: 319 case Decl::ObjCTypeParam: 320 return false; 321 } 322 323 llvm_unreachable("Unhandled declaration kind"); 324 } 325 326 bool serialization::needsAnonymousDeclarationNumber(const NamedDecl *D) { 327 // Friend declarations in dependent contexts aren't anonymous in the usual 328 // sense, but they cannot be found by name lookup in their semantic context 329 // (or indeed in any context), so we treat them as anonymous. 330 // 331 // This doesn't apply to friend tag decls; Sema makes those available to name 332 // lookup in the surrounding context. 333 if (D->getFriendObjectKind() && 334 D->getLexicalDeclContext()->isDependentContext() && !isa<TagDecl>(D)) { 335 // For function templates and class templates, the template is numbered and 336 // not its pattern. 337 if (auto *FD = dyn_cast<FunctionDecl>(D)) 338 return !FD->getDescribedFunctionTemplate(); 339 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) 340 return !RD->getDescribedClassTemplate(); 341 return true; 342 } 343 344 // Otherwise, we only care about anonymous class members. 345 if (D->getDeclName() || !isa<CXXRecordDecl>(D->getLexicalDeclContext())) 346 return false; 347 return isa<TagDecl>(D) || isa<FieldDecl>(D); 348 } 349 350