1 //===- DeclObjC.cpp - ObjC Declaration AST Node Implementation ------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the Objective-C related Decl classes.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "clang/AST/DeclObjC.h"
14 #include "clang/AST/ASTContext.h"
15 #include "clang/AST/ASTMutationListener.h"
16 #include "clang/AST/Attr.h"
17 #include "clang/AST/Decl.h"
18 #include "clang/AST/DeclBase.h"
19 #include "clang/AST/Stmt.h"
20 #include "clang/AST/Type.h"
21 #include "clang/AST/TypeLoc.h"
22 #include "clang/Basic/IdentifierTable.h"
23 #include "clang/Basic/LLVM.h"
24 #include "clang/Basic/LangOptions.h"
25 #include "clang/Basic/SourceLocation.h"
26 #include "llvm/ADT/None.h"
27 #include "llvm/ADT/SmallString.h"
28 #include "llvm/ADT/SmallVector.h"
29 #include "llvm/Support/Casting.h"
30 #include "llvm/Support/ErrorHandling.h"
31 #include "llvm/Support/raw_ostream.h"
32 #include <algorithm>
33 #include <cassert>
34 #include <cstdint>
35 #include <cstring>
36 #include <utility>
37 
38 using namespace clang;
39 
40 //===----------------------------------------------------------------------===//
41 // ObjCListBase
42 //===----------------------------------------------------------------------===//
43 
44 void ObjCListBase::set(void *const* InList, unsigned Elts, ASTContext &Ctx) {
45   List = nullptr;
46   if (Elts == 0) return;  // Setting to an empty list is a noop.
47 
48   List = new (Ctx) void*[Elts];
49   NumElts = Elts;
50   memcpy(List, InList, sizeof(void*)*Elts);
51 }
52 
53 void ObjCProtocolList::set(ObjCProtocolDecl* const* InList, unsigned Elts,
54                            const SourceLocation *Locs, ASTContext &Ctx) {
55   if (Elts == 0)
56     return;
57 
58   Locations = new (Ctx) SourceLocation[Elts];
59   memcpy(Locations, Locs, sizeof(SourceLocation) * Elts);
60   set(InList, Elts, Ctx);
61 }
62 
63 //===----------------------------------------------------------------------===//
64 // ObjCInterfaceDecl
65 //===----------------------------------------------------------------------===//
66 
67 ObjCContainerDecl::ObjCContainerDecl(Kind DK, DeclContext *DC,
68                                      IdentifierInfo *Id, SourceLocation nameLoc,
69                                      SourceLocation atStartLoc)
70     : NamedDecl(DK, DC, nameLoc, Id), DeclContext(DK) {
71   setAtStartLoc(atStartLoc);
72 }
73 
74 void ObjCContainerDecl::anchor() {}
75 
76 /// getIvarDecl - This method looks up an ivar in this ContextDecl.
77 ///
78 ObjCIvarDecl *
79 ObjCContainerDecl::getIvarDecl(IdentifierInfo *Id) const {
80   lookup_result R = lookup(Id);
81   for (lookup_iterator Ivar = R.begin(), IvarEnd = R.end();
82        Ivar != IvarEnd; ++Ivar) {
83     if (auto *ivar = dyn_cast<ObjCIvarDecl>(*Ivar))
84       return ivar;
85   }
86   return nullptr;
87 }
88 
89 // Get the local instance/class method declared in this interface.
90 ObjCMethodDecl *
91 ObjCContainerDecl::getMethod(Selector Sel, bool isInstance,
92                              bool AllowHidden) const {
93   // If this context is a hidden protocol definition, don't find any
94   // methods there.
95   if (const auto *Proto = dyn_cast<ObjCProtocolDecl>(this)) {
96     if (const ObjCProtocolDecl *Def = Proto->getDefinition())
97       if (Def->isHidden() && !AllowHidden)
98         return nullptr;
99   }
100 
101   // Since instance & class methods can have the same name, the loop below
102   // ensures we get the correct method.
103   //
104   // @interface Whatever
105   // - (int) class_method;
106   // + (float) class_method;
107   // @end
108   lookup_result R = lookup(Sel);
109   for (lookup_iterator Meth = R.begin(), MethEnd = R.end();
110        Meth != MethEnd; ++Meth) {
111     auto *MD = dyn_cast<ObjCMethodDecl>(*Meth);
112     if (MD && MD->isInstanceMethod() == isInstance)
113       return MD;
114   }
115   return nullptr;
116 }
117 
118 /// This routine returns 'true' if a user declared setter method was
119 /// found in the class, its protocols, its super classes or categories.
120 /// It also returns 'true' if one of its categories has declared a 'readwrite'
121 /// property.  This is because, user must provide a setter method for the
122 /// category's 'readwrite' property.
123 bool ObjCContainerDecl::HasUserDeclaredSetterMethod(
124     const ObjCPropertyDecl *Property) const {
125   Selector Sel = Property->getSetterName();
126   lookup_result R = lookup(Sel);
127   for (lookup_iterator Meth = R.begin(), MethEnd = R.end();
128        Meth != MethEnd; ++Meth) {
129     auto *MD = dyn_cast<ObjCMethodDecl>(*Meth);
130     if (MD && MD->isInstanceMethod() && !MD->isImplicit())
131       return true;
132   }
133 
134   if (const auto *ID = dyn_cast<ObjCInterfaceDecl>(this)) {
135     // Also look into categories, including class extensions, looking
136     // for a user declared instance method.
137     for (const auto *Cat : ID->visible_categories()) {
138       if (ObjCMethodDecl *MD = Cat->getInstanceMethod(Sel))
139         if (!MD->isImplicit())
140           return true;
141       if (Cat->IsClassExtension())
142         continue;
143       // Also search through the categories looking for a 'readwrite'
144       // declaration of this property. If one found, presumably a setter will
145       // be provided (properties declared in categories will not get
146       // auto-synthesized).
147       for (const auto *P : Cat->properties())
148         if (P->getIdentifier() == Property->getIdentifier()) {
149           if (P->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_readwrite)
150             return true;
151           break;
152         }
153     }
154 
155     // Also look into protocols, for a user declared instance method.
156     for (const auto *Proto : ID->all_referenced_protocols())
157       if (Proto->HasUserDeclaredSetterMethod(Property))
158         return true;
159 
160     // And in its super class.
161     ObjCInterfaceDecl *OSC = ID->getSuperClass();
162     while (OSC) {
163       if (OSC->HasUserDeclaredSetterMethod(Property))
164         return true;
165       OSC = OSC->getSuperClass();
166     }
167   }
168   if (const auto *PD = dyn_cast<ObjCProtocolDecl>(this))
169     for (const auto *PI : PD->protocols())
170       if (PI->HasUserDeclaredSetterMethod(Property))
171         return true;
172   return false;
173 }
174 
175 ObjCPropertyDecl *
176 ObjCPropertyDecl::findPropertyDecl(const DeclContext *DC,
177                                    const IdentifierInfo *propertyID,
178                                    ObjCPropertyQueryKind queryKind) {
179   // If this context is a hidden protocol definition, don't find any
180   // property.
181   if (const auto *Proto = dyn_cast<ObjCProtocolDecl>(DC)) {
182     if (const ObjCProtocolDecl *Def = Proto->getDefinition())
183       if (Def->isHidden())
184         return nullptr;
185   }
186 
187   // If context is class, then lookup property in its visible extensions.
188   // This comes before property is looked up in primary class.
189   if (auto *IDecl = dyn_cast<ObjCInterfaceDecl>(DC)) {
190     for (const auto *Ext : IDecl->visible_extensions())
191       if (ObjCPropertyDecl *PD = ObjCPropertyDecl::findPropertyDecl(Ext,
192                                                        propertyID,
193                                                        queryKind))
194         return PD;
195   }
196 
197   DeclContext::lookup_result R = DC->lookup(propertyID);
198   ObjCPropertyDecl *classProp = nullptr;
199   for (DeclContext::lookup_iterator I = R.begin(), E = R.end(); I != E;
200        ++I)
201     if (auto *PD = dyn_cast<ObjCPropertyDecl>(*I)) {
202       // If queryKind is unknown, we return the instance property if one
203       // exists; otherwise we return the class property.
204       if ((queryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown &&
205            !PD->isClassProperty()) ||
206           (queryKind == ObjCPropertyQueryKind::OBJC_PR_query_class &&
207            PD->isClassProperty()) ||
208           (queryKind == ObjCPropertyQueryKind::OBJC_PR_query_instance &&
209            !PD->isClassProperty()))
210         return PD;
211 
212       if (PD->isClassProperty())
213         classProp = PD;
214     }
215 
216   if (queryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown)
217     // We can't find the instance property, return the class property.
218     return classProp;
219 
220   return nullptr;
221 }
222 
223 IdentifierInfo *
224 ObjCPropertyDecl::getDefaultSynthIvarName(ASTContext &Ctx) const {
225   SmallString<128> ivarName;
226   {
227     llvm::raw_svector_ostream os(ivarName);
228     os << '_' << getIdentifier()->getName();
229   }
230   return &Ctx.Idents.get(ivarName.str());
231 }
232 
233 /// FindPropertyDeclaration - Finds declaration of the property given its name
234 /// in 'PropertyId' and returns it. It returns 0, if not found.
235 ObjCPropertyDecl *ObjCContainerDecl::FindPropertyDeclaration(
236     const IdentifierInfo *PropertyId,
237     ObjCPropertyQueryKind QueryKind) const {
238   // Don't find properties within hidden protocol definitions.
239   if (const auto *Proto = dyn_cast<ObjCProtocolDecl>(this)) {
240     if (const ObjCProtocolDecl *Def = Proto->getDefinition())
241       if (Def->isHidden())
242         return nullptr;
243   }
244 
245   // Search the extensions of a class first; they override what's in
246   // the class itself.
247   if (const auto *ClassDecl = dyn_cast<ObjCInterfaceDecl>(this)) {
248     for (const auto *Ext : ClassDecl->visible_extensions()) {
249       if (auto *P = Ext->FindPropertyDeclaration(PropertyId, QueryKind))
250         return P;
251     }
252   }
253 
254   if (ObjCPropertyDecl *PD =
255         ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(this), PropertyId,
256                                            QueryKind))
257     return PD;
258 
259   switch (getKind()) {
260     default:
261       break;
262     case Decl::ObjCProtocol: {
263       const auto *PID = cast<ObjCProtocolDecl>(this);
264       for (const auto *I : PID->protocols())
265         if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
266                                                              QueryKind))
267           return P;
268       break;
269     }
270     case Decl::ObjCInterface: {
271       const auto *OID = cast<ObjCInterfaceDecl>(this);
272       // Look through categories (but not extensions; they were handled above).
273       for (const auto *Cat : OID->visible_categories()) {
274         if (!Cat->IsClassExtension())
275           if (ObjCPropertyDecl *P = Cat->FindPropertyDeclaration(
276                                              PropertyId, QueryKind))
277             return P;
278       }
279 
280       // Look through protocols.
281       for (const auto *I : OID->all_referenced_protocols())
282         if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
283                                                              QueryKind))
284           return P;
285 
286       // Finally, check the super class.
287       if (const ObjCInterfaceDecl *superClass = OID->getSuperClass())
288         return superClass->FindPropertyDeclaration(PropertyId, QueryKind);
289       break;
290     }
291     case Decl::ObjCCategory: {
292       const auto *OCD = cast<ObjCCategoryDecl>(this);
293       // Look through protocols.
294       if (!OCD->IsClassExtension())
295         for (const auto *I : OCD->protocols())
296           if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
297                                                                QueryKind))
298             return P;
299       break;
300     }
301   }
302   return nullptr;
303 }
304 
305 void ObjCInterfaceDecl::anchor() {}
306 
307 ObjCTypeParamList *ObjCInterfaceDecl::getTypeParamList() const {
308   // If this particular declaration has a type parameter list, return it.
309   if (ObjCTypeParamList *written = getTypeParamListAsWritten())
310     return written;
311 
312   // If there is a definition, return its type parameter list.
313   if (const ObjCInterfaceDecl *def = getDefinition())
314     return def->getTypeParamListAsWritten();
315 
316   // Otherwise, look at previous declarations to determine whether any
317   // of them has a type parameter list, skipping over those
318   // declarations that do not.
319   for (const ObjCInterfaceDecl *decl = getMostRecentDecl(); decl;
320        decl = decl->getPreviousDecl()) {
321     if (ObjCTypeParamList *written = decl->getTypeParamListAsWritten())
322       return written;
323   }
324 
325   return nullptr;
326 }
327 
328 void ObjCInterfaceDecl::setTypeParamList(ObjCTypeParamList *TPL) {
329   TypeParamList = TPL;
330   if (!TPL)
331     return;
332   // Set the declaration context of each of the type parameters.
333   for (auto *typeParam : *TypeParamList)
334     typeParam->setDeclContext(this);
335 }
336 
337 ObjCInterfaceDecl *ObjCInterfaceDecl::getSuperClass() const {
338   // FIXME: Should make sure no callers ever do this.
339   if (!hasDefinition())
340     return nullptr;
341 
342   if (data().ExternallyCompleted)
343     LoadExternalDefinition();
344 
345   if (const ObjCObjectType *superType = getSuperClassType()) {
346     if (ObjCInterfaceDecl *superDecl = superType->getInterface()) {
347       if (ObjCInterfaceDecl *superDef = superDecl->getDefinition())
348         return superDef;
349 
350       return superDecl;
351     }
352   }
353 
354   return nullptr;
355 }
356 
357 SourceLocation ObjCInterfaceDecl::getSuperClassLoc() const {
358   if (TypeSourceInfo *superTInfo = getSuperClassTInfo())
359     return superTInfo->getTypeLoc().getBeginLoc();
360 
361   return SourceLocation();
362 }
363 
364 /// FindPropertyVisibleInPrimaryClass - Finds declaration of the property
365 /// with name 'PropertyId' in the primary class; including those in protocols
366 /// (direct or indirect) used by the primary class.
367 ObjCPropertyDecl *
368 ObjCInterfaceDecl::FindPropertyVisibleInPrimaryClass(
369                        IdentifierInfo *PropertyId,
370                        ObjCPropertyQueryKind QueryKind) const {
371   // FIXME: Should make sure no callers ever do this.
372   if (!hasDefinition())
373     return nullptr;
374 
375   if (data().ExternallyCompleted)
376     LoadExternalDefinition();
377 
378   if (ObjCPropertyDecl *PD =
379       ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(this), PropertyId,
380                                          QueryKind))
381     return PD;
382 
383   // Look through protocols.
384   for (const auto *I : all_referenced_protocols())
385     if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
386                                                          QueryKind))
387       return P;
388 
389   return nullptr;
390 }
391 
392 void ObjCInterfaceDecl::collectPropertiesToImplement(PropertyMap &PM,
393                                                      PropertyDeclOrder &PO) const {
394   for (auto *Prop : properties()) {
395     PM[std::make_pair(Prop->getIdentifier(), Prop->isClassProperty())] = Prop;
396     PO.push_back(Prop);
397   }
398   for (const auto *Ext : known_extensions()) {
399     const ObjCCategoryDecl *ClassExt = Ext;
400     for (auto *Prop : ClassExt->properties()) {
401       PM[std::make_pair(Prop->getIdentifier(), Prop->isClassProperty())] = Prop;
402       PO.push_back(Prop);
403     }
404   }
405   for (const auto *PI : all_referenced_protocols())
406     PI->collectPropertiesToImplement(PM, PO);
407   // Note, the properties declared only in class extensions are still copied
408   // into the main @interface's property list, and therefore we don't
409   // explicitly, have to search class extension properties.
410 }
411 
412 bool ObjCInterfaceDecl::isArcWeakrefUnavailable() const {
413   const ObjCInterfaceDecl *Class = this;
414   while (Class) {
415     if (Class->hasAttr<ArcWeakrefUnavailableAttr>())
416       return true;
417     Class = Class->getSuperClass();
418   }
419   return false;
420 }
421 
422 const ObjCInterfaceDecl *ObjCInterfaceDecl::isObjCRequiresPropertyDefs() const {
423   const ObjCInterfaceDecl *Class = this;
424   while (Class) {
425     if (Class->hasAttr<ObjCRequiresPropertyDefsAttr>())
426       return Class;
427     Class = Class->getSuperClass();
428   }
429   return nullptr;
430 }
431 
432 void ObjCInterfaceDecl::mergeClassExtensionProtocolList(
433                               ObjCProtocolDecl *const* ExtList, unsigned ExtNum,
434                               ASTContext &C) {
435   if (data().ExternallyCompleted)
436     LoadExternalDefinition();
437 
438   if (data().AllReferencedProtocols.empty() &&
439       data().ReferencedProtocols.empty()) {
440     data().AllReferencedProtocols.set(ExtList, ExtNum, C);
441     return;
442   }
443 
444   // Check for duplicate protocol in class's protocol list.
445   // This is O(n*m). But it is extremely rare and number of protocols in
446   // class or its extension are very few.
447   SmallVector<ObjCProtocolDecl *, 8> ProtocolRefs;
448   for (unsigned i = 0; i < ExtNum; i++) {
449     bool protocolExists = false;
450     ObjCProtocolDecl *ProtoInExtension = ExtList[i];
451     for (auto *Proto : all_referenced_protocols()) {
452       if (C.ProtocolCompatibleWithProtocol(ProtoInExtension, Proto)) {
453         protocolExists = true;
454         break;
455       }
456     }
457     // Do we want to warn on a protocol in extension class which
458     // already exist in the class? Probably not.
459     if (!protocolExists)
460       ProtocolRefs.push_back(ProtoInExtension);
461   }
462 
463   if (ProtocolRefs.empty())
464     return;
465 
466   // Merge ProtocolRefs into class's protocol list;
467   ProtocolRefs.append(all_referenced_protocol_begin(),
468                       all_referenced_protocol_end());
469 
470   data().AllReferencedProtocols.set(ProtocolRefs.data(), ProtocolRefs.size(),C);
471 }
472 
473 const ObjCInterfaceDecl *
474 ObjCInterfaceDecl::findInterfaceWithDesignatedInitializers() const {
475   const ObjCInterfaceDecl *IFace = this;
476   while (IFace) {
477     if (IFace->hasDesignatedInitializers())
478       return IFace;
479     if (!IFace->inheritsDesignatedInitializers())
480       break;
481     IFace = IFace->getSuperClass();
482   }
483   return nullptr;
484 }
485 
486 static bool isIntroducingInitializers(const ObjCInterfaceDecl *D) {
487   for (const auto *MD : D->instance_methods()) {
488     if (MD->getMethodFamily() == OMF_init && !MD->isOverriding())
489       return true;
490   }
491   for (const auto *Ext : D->visible_extensions()) {
492     for (const auto *MD : Ext->instance_methods()) {
493       if (MD->getMethodFamily() == OMF_init && !MD->isOverriding())
494         return true;
495     }
496   }
497   if (const auto *ImplD = D->getImplementation()) {
498     for (const auto *MD : ImplD->instance_methods()) {
499       if (MD->getMethodFamily() == OMF_init && !MD->isOverriding())
500         return true;
501     }
502   }
503   return false;
504 }
505 
506 bool ObjCInterfaceDecl::inheritsDesignatedInitializers() const {
507   switch (data().InheritedDesignatedInitializers) {
508   case DefinitionData::IDI_Inherited:
509     return true;
510   case DefinitionData::IDI_NotInherited:
511     return false;
512   case DefinitionData::IDI_Unknown:
513     // If the class introduced initializers we conservatively assume that we
514     // don't know if any of them is a designated initializer to avoid possible
515     // misleading warnings.
516     if (isIntroducingInitializers(this)) {
517       data().InheritedDesignatedInitializers = DefinitionData::IDI_NotInherited;
518     } else {
519       if (auto SuperD = getSuperClass()) {
520         data().InheritedDesignatedInitializers =
521           SuperD->declaresOrInheritsDesignatedInitializers() ?
522             DefinitionData::IDI_Inherited :
523             DefinitionData::IDI_NotInherited;
524       } else {
525         data().InheritedDesignatedInitializers =
526           DefinitionData::IDI_NotInherited;
527       }
528     }
529     assert(data().InheritedDesignatedInitializers
530              != DefinitionData::IDI_Unknown);
531     return data().InheritedDesignatedInitializers ==
532         DefinitionData::IDI_Inherited;
533   }
534 
535   llvm_unreachable("unexpected InheritedDesignatedInitializers value");
536 }
537 
538 void ObjCInterfaceDecl::getDesignatedInitializers(
539     llvm::SmallVectorImpl<const ObjCMethodDecl *> &Methods) const {
540   // Check for a complete definition and recover if not so.
541   if (!isThisDeclarationADefinition())
542     return;
543   if (data().ExternallyCompleted)
544     LoadExternalDefinition();
545 
546   const ObjCInterfaceDecl *IFace= findInterfaceWithDesignatedInitializers();
547   if (!IFace)
548     return;
549 
550   for (const auto *MD : IFace->instance_methods())
551     if (MD->isThisDeclarationADesignatedInitializer())
552       Methods.push_back(MD);
553   for (const auto *Ext : IFace->visible_extensions()) {
554     for (const auto *MD : Ext->instance_methods())
555       if (MD->isThisDeclarationADesignatedInitializer())
556         Methods.push_back(MD);
557   }
558 }
559 
560 bool ObjCInterfaceDecl::isDesignatedInitializer(Selector Sel,
561                                       const ObjCMethodDecl **InitMethod) const {
562   bool HasCompleteDef = isThisDeclarationADefinition();
563   // During deserialization the data record for the ObjCInterfaceDecl could
564   // be made invariant by reusing the canonical decl. Take this into account
565   // when checking for the complete definition.
566   if (!HasCompleteDef && getCanonicalDecl()->hasDefinition() &&
567       getCanonicalDecl()->getDefinition() == getDefinition())
568     HasCompleteDef = true;
569 
570   // Check for a complete definition and recover if not so.
571   if (!HasCompleteDef)
572     return false;
573 
574   if (data().ExternallyCompleted)
575     LoadExternalDefinition();
576 
577   const ObjCInterfaceDecl *IFace= findInterfaceWithDesignatedInitializers();
578   if (!IFace)
579     return false;
580 
581   if (const ObjCMethodDecl *MD = IFace->getInstanceMethod(Sel)) {
582     if (MD->isThisDeclarationADesignatedInitializer()) {
583       if (InitMethod)
584         *InitMethod = MD;
585       return true;
586     }
587   }
588   for (const auto *Ext : IFace->visible_extensions()) {
589     if (const ObjCMethodDecl *MD = Ext->getInstanceMethod(Sel)) {
590       if (MD->isThisDeclarationADesignatedInitializer()) {
591         if (InitMethod)
592           *InitMethod = MD;
593         return true;
594       }
595     }
596   }
597   return false;
598 }
599 
600 void ObjCInterfaceDecl::allocateDefinitionData() {
601   assert(!hasDefinition() && "ObjC class already has a definition");
602   Data.setPointer(new (getASTContext()) DefinitionData());
603   Data.getPointer()->Definition = this;
604 
605   // Make the type point at the definition, now that we have one.
606   if (TypeForDecl)
607     cast<ObjCInterfaceType>(TypeForDecl)->Decl = this;
608 }
609 
610 void ObjCInterfaceDecl::startDefinition() {
611   allocateDefinitionData();
612 
613   // Update all of the declarations with a pointer to the definition.
614   for (auto *RD : redecls()) {
615     if (RD != this)
616       RD->Data = Data;
617   }
618 }
619 
620 ObjCIvarDecl *ObjCInterfaceDecl::lookupInstanceVariable(IdentifierInfo *ID,
621                                               ObjCInterfaceDecl *&clsDeclared) {
622   // FIXME: Should make sure no callers ever do this.
623   if (!hasDefinition())
624     return nullptr;
625 
626   if (data().ExternallyCompleted)
627     LoadExternalDefinition();
628 
629   ObjCInterfaceDecl* ClassDecl = this;
630   while (ClassDecl != nullptr) {
631     if (ObjCIvarDecl *I = ClassDecl->getIvarDecl(ID)) {
632       clsDeclared = ClassDecl;
633       return I;
634     }
635 
636     for (const auto *Ext : ClassDecl->visible_extensions()) {
637       if (ObjCIvarDecl *I = Ext->getIvarDecl(ID)) {
638         clsDeclared = ClassDecl;
639         return I;
640       }
641     }
642 
643     ClassDecl = ClassDecl->getSuperClass();
644   }
645   return nullptr;
646 }
647 
648 /// lookupInheritedClass - This method returns ObjCInterfaceDecl * of the super
649 /// class whose name is passed as argument. If it is not one of the super classes
650 /// the it returns NULL.
651 ObjCInterfaceDecl *ObjCInterfaceDecl::lookupInheritedClass(
652                                         const IdentifierInfo*ICName) {
653   // FIXME: Should make sure no callers ever do this.
654   if (!hasDefinition())
655     return nullptr;
656 
657   if (data().ExternallyCompleted)
658     LoadExternalDefinition();
659 
660   ObjCInterfaceDecl* ClassDecl = this;
661   while (ClassDecl != nullptr) {
662     if (ClassDecl->getIdentifier() == ICName)
663       return ClassDecl;
664     ClassDecl = ClassDecl->getSuperClass();
665   }
666   return nullptr;
667 }
668 
669 ObjCProtocolDecl *
670 ObjCInterfaceDecl::lookupNestedProtocol(IdentifierInfo *Name) {
671   for (auto *P : all_referenced_protocols())
672     if (P->lookupProtocolNamed(Name))
673       return P;
674   ObjCInterfaceDecl *SuperClass = getSuperClass();
675   return SuperClass ? SuperClass->lookupNestedProtocol(Name) : nullptr;
676 }
677 
678 /// lookupMethod - This method returns an instance/class method by looking in
679 /// the class, its categories, and its super classes (using a linear search).
680 /// When argument category "C" is specified, any implicit method found
681 /// in this category is ignored.
682 ObjCMethodDecl *ObjCInterfaceDecl::lookupMethod(Selector Sel,
683                                                 bool isInstance,
684                                                 bool shallowCategoryLookup,
685                                                 bool followSuper,
686                                                 const ObjCCategoryDecl *C) const
687 {
688   // FIXME: Should make sure no callers ever do this.
689   if (!hasDefinition())
690     return nullptr;
691 
692   const ObjCInterfaceDecl* ClassDecl = this;
693   ObjCMethodDecl *MethodDecl = nullptr;
694 
695   if (data().ExternallyCompleted)
696     LoadExternalDefinition();
697 
698   while (ClassDecl) {
699     // 1. Look through primary class.
700     if ((MethodDecl = ClassDecl->getMethod(Sel, isInstance)))
701       return MethodDecl;
702 
703     // 2. Didn't find one yet - now look through categories.
704     for (const auto *Cat : ClassDecl->visible_categories())
705       if ((MethodDecl = Cat->getMethod(Sel, isInstance)))
706         if (C != Cat || !MethodDecl->isImplicit())
707           return MethodDecl;
708 
709     // 3. Didn't find one yet - look through primary class's protocols.
710     for (const auto *I : ClassDecl->protocols())
711       if ((MethodDecl = I->lookupMethod(Sel, isInstance)))
712         return MethodDecl;
713 
714     // 4. Didn't find one yet - now look through categories' protocols
715     if (!shallowCategoryLookup)
716       for (const auto *Cat : ClassDecl->visible_categories()) {
717         // Didn't find one yet - look through protocols.
718         const ObjCList<ObjCProtocolDecl> &Protocols =
719           Cat->getReferencedProtocols();
720         for (auto *Protocol : Protocols)
721           if ((MethodDecl = Protocol->lookupMethod(Sel, isInstance)))
722             if (C != Cat || !MethodDecl->isImplicit())
723               return MethodDecl;
724       }
725 
726 
727     if (!followSuper)
728       return nullptr;
729 
730     // 5. Get to the super class (if any).
731     ClassDecl = ClassDecl->getSuperClass();
732   }
733   return nullptr;
734 }
735 
736 // Will search "local" class/category implementations for a method decl.
737 // If failed, then we search in class's root for an instance method.
738 // Returns 0 if no method is found.
739 ObjCMethodDecl *ObjCInterfaceDecl::lookupPrivateMethod(
740                                    const Selector &Sel,
741                                    bool Instance) const {
742   // FIXME: Should make sure no callers ever do this.
743   if (!hasDefinition())
744     return nullptr;
745 
746   if (data().ExternallyCompleted)
747     LoadExternalDefinition();
748 
749   ObjCMethodDecl *Method = nullptr;
750   if (ObjCImplementationDecl *ImpDecl = getImplementation())
751     Method = Instance ? ImpDecl->getInstanceMethod(Sel)
752                       : ImpDecl->getClassMethod(Sel);
753 
754   // Look through local category implementations associated with the class.
755   if (!Method)
756     Method = getCategoryMethod(Sel, Instance);
757 
758   // Before we give up, check if the selector is an instance method.
759   // But only in the root. This matches gcc's behavior and what the
760   // runtime expects.
761   if (!Instance && !Method && !getSuperClass()) {
762     Method = lookupInstanceMethod(Sel);
763     // Look through local category implementations associated
764     // with the root class.
765     if (!Method)
766       Method = lookupPrivateMethod(Sel, true);
767   }
768 
769   if (!Method && getSuperClass())
770     return getSuperClass()->lookupPrivateMethod(Sel, Instance);
771   return Method;
772 }
773 
774 //===----------------------------------------------------------------------===//
775 // ObjCMethodDecl
776 //===----------------------------------------------------------------------===//
777 
778 ObjCMethodDecl::ObjCMethodDecl(
779     SourceLocation beginLoc, SourceLocation endLoc, Selector SelInfo,
780     QualType T, TypeSourceInfo *ReturnTInfo, DeclContext *contextDecl,
781     bool isInstance, bool isVariadic, bool isPropertyAccessor,
782     bool isSynthesizedAccessorStub, bool isImplicitlyDeclared, bool isDefined,
783     ImplementationControl impControl, bool HasRelatedResultType)
784     : NamedDecl(ObjCMethod, contextDecl, beginLoc, SelInfo),
785       DeclContext(ObjCMethod), MethodDeclType(T), ReturnTInfo(ReturnTInfo),
786       DeclEndLoc(endLoc) {
787 
788   // Initialized the bits stored in DeclContext.
789   ObjCMethodDeclBits.Family =
790       static_cast<ObjCMethodFamily>(InvalidObjCMethodFamily);
791   setInstanceMethod(isInstance);
792   setVariadic(isVariadic);
793   setPropertyAccessor(isPropertyAccessor);
794   setSynthesizedAccessorStub(isSynthesizedAccessorStub);
795   setDefined(isDefined);
796   setIsRedeclaration(false);
797   setHasRedeclaration(false);
798   setDeclImplementation(impControl);
799   setObjCDeclQualifier(OBJC_TQ_None);
800   setRelatedResultType(HasRelatedResultType);
801   setSelLocsKind(SelLoc_StandardNoSpace);
802   setOverriding(false);
803   setHasSkippedBody(false);
804 
805   setImplicit(isImplicitlyDeclared);
806 }
807 
808 ObjCMethodDecl *ObjCMethodDecl::Create(
809     ASTContext &C, SourceLocation beginLoc, SourceLocation endLoc,
810     Selector SelInfo, QualType T, TypeSourceInfo *ReturnTInfo,
811     DeclContext *contextDecl, bool isInstance, bool isVariadic,
812     bool isPropertyAccessor, bool isSynthesizedAccessorStub,
813     bool isImplicitlyDeclared, bool isDefined, ImplementationControl impControl,
814     bool HasRelatedResultType) {
815   return new (C, contextDecl) ObjCMethodDecl(
816       beginLoc, endLoc, SelInfo, T, ReturnTInfo, contextDecl, isInstance,
817       isVariadic, isPropertyAccessor, isSynthesizedAccessorStub,
818       isImplicitlyDeclared, isDefined, impControl, HasRelatedResultType);
819 }
820 
821 ObjCMethodDecl *ObjCMethodDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
822   return new (C, ID) ObjCMethodDecl(SourceLocation(), SourceLocation(),
823                                     Selector(), QualType(), nullptr, nullptr);
824 }
825 
826 bool ObjCMethodDecl::isDirectMethod() const {
827   return hasAttr<ObjCDirectAttr>();
828 }
829 
830 bool ObjCMethodDecl::isThisDeclarationADesignatedInitializer() const {
831   return getMethodFamily() == OMF_init &&
832       hasAttr<ObjCDesignatedInitializerAttr>();
833 }
834 
835 bool ObjCMethodDecl::definedInNSObject(const ASTContext &Ctx) const {
836   if (const auto *PD = dyn_cast<const ObjCProtocolDecl>(getDeclContext()))
837     return PD->getIdentifier() == Ctx.getNSObjectName();
838   if (const auto *ID = dyn_cast<const ObjCInterfaceDecl>(getDeclContext()))
839     return ID->getIdentifier() == Ctx.getNSObjectName();
840   return false;
841 }
842 
843 bool ObjCMethodDecl::isDesignatedInitializerForTheInterface(
844     const ObjCMethodDecl **InitMethod) const {
845   if (getMethodFamily() != OMF_init)
846     return false;
847   const DeclContext *DC = getDeclContext();
848   if (isa<ObjCProtocolDecl>(DC))
849     return false;
850   if (const ObjCInterfaceDecl *ID = getClassInterface())
851     return ID->isDesignatedInitializer(getSelector(), InitMethod);
852   return false;
853 }
854 
855 Stmt *ObjCMethodDecl::getBody() const {
856   return Body.get(getASTContext().getExternalSource());
857 }
858 
859 void ObjCMethodDecl::setAsRedeclaration(const ObjCMethodDecl *PrevMethod) {
860   assert(PrevMethod);
861   getASTContext().setObjCMethodRedeclaration(PrevMethod, this);
862   setIsRedeclaration(true);
863   PrevMethod->setHasRedeclaration(true);
864 }
865 
866 void ObjCMethodDecl::setParamsAndSelLocs(ASTContext &C,
867                                          ArrayRef<ParmVarDecl*> Params,
868                                          ArrayRef<SourceLocation> SelLocs) {
869   ParamsAndSelLocs = nullptr;
870   NumParams = Params.size();
871   if (Params.empty() && SelLocs.empty())
872     return;
873 
874   static_assert(alignof(ParmVarDecl *) >= alignof(SourceLocation),
875                 "Alignment not sufficient for SourceLocation");
876 
877   unsigned Size = sizeof(ParmVarDecl *) * NumParams +
878                   sizeof(SourceLocation) * SelLocs.size();
879   ParamsAndSelLocs = C.Allocate(Size);
880   std::copy(Params.begin(), Params.end(), getParams());
881   std::copy(SelLocs.begin(), SelLocs.end(), getStoredSelLocs());
882 }
883 
884 void ObjCMethodDecl::getSelectorLocs(
885                                SmallVectorImpl<SourceLocation> &SelLocs) const {
886   for (unsigned i = 0, e = getNumSelectorLocs(); i != e; ++i)
887     SelLocs.push_back(getSelectorLoc(i));
888 }
889 
890 void ObjCMethodDecl::setMethodParams(ASTContext &C,
891                                      ArrayRef<ParmVarDecl*> Params,
892                                      ArrayRef<SourceLocation> SelLocs) {
893   assert((!SelLocs.empty() || isImplicit()) &&
894          "No selector locs for non-implicit method");
895   if (isImplicit())
896     return setParamsAndSelLocs(C, Params, llvm::None);
897 
898   setSelLocsKind(hasStandardSelectorLocs(getSelector(), SelLocs, Params,
899                                         DeclEndLoc));
900   if (getSelLocsKind() != SelLoc_NonStandard)
901     return setParamsAndSelLocs(C, Params, llvm::None);
902 
903   setParamsAndSelLocs(C, Params, SelLocs);
904 }
905 
906 /// A definition will return its interface declaration.
907 /// An interface declaration will return its definition.
908 /// Otherwise it will return itself.
909 ObjCMethodDecl *ObjCMethodDecl::getNextRedeclarationImpl() {
910   ASTContext &Ctx = getASTContext();
911   ObjCMethodDecl *Redecl = nullptr;
912   if (hasRedeclaration())
913     Redecl = const_cast<ObjCMethodDecl*>(Ctx.getObjCMethodRedeclaration(this));
914   if (Redecl)
915     return Redecl;
916 
917   auto *CtxD = cast<Decl>(getDeclContext());
918 
919   if (!CtxD->isInvalidDecl()) {
920     if (auto *IFD = dyn_cast<ObjCInterfaceDecl>(CtxD)) {
921       if (ObjCImplementationDecl *ImplD = Ctx.getObjCImplementation(IFD))
922         if (!ImplD->isInvalidDecl())
923           Redecl = ImplD->getMethod(getSelector(), isInstanceMethod());
924 
925     } else if (auto *CD = dyn_cast<ObjCCategoryDecl>(CtxD)) {
926       if (ObjCCategoryImplDecl *ImplD = Ctx.getObjCImplementation(CD))
927         if (!ImplD->isInvalidDecl())
928           Redecl = ImplD->getMethod(getSelector(), isInstanceMethod());
929 
930     } else if (auto *ImplD = dyn_cast<ObjCImplementationDecl>(CtxD)) {
931       if (ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
932         if (!IFD->isInvalidDecl())
933           Redecl = IFD->getMethod(getSelector(), isInstanceMethod());
934 
935     } else if (auto *CImplD = dyn_cast<ObjCCategoryImplDecl>(CtxD)) {
936       if (ObjCCategoryDecl *CatD = CImplD->getCategoryDecl())
937         if (!CatD->isInvalidDecl())
938           Redecl = CatD->getMethod(getSelector(), isInstanceMethod());
939     }
940   }
941 
942   // Ensure that the discovered method redeclaration has a valid declaration
943   // context. Used to prevent infinite loops when iterating redeclarations in
944   // a partially invalid AST.
945   if (Redecl && cast<Decl>(Redecl->getDeclContext())->isInvalidDecl())
946     Redecl = nullptr;
947 
948   if (!Redecl && isRedeclaration()) {
949     // This is the last redeclaration, go back to the first method.
950     return cast<ObjCContainerDecl>(CtxD)->getMethod(getSelector(),
951                                                     isInstanceMethod());
952   }
953 
954   return Redecl ? Redecl : this;
955 }
956 
957 ObjCMethodDecl *ObjCMethodDecl::getCanonicalDecl() {
958   auto *CtxD = cast<Decl>(getDeclContext());
959   const auto &Sel = getSelector();
960 
961   if (auto *ImplD = dyn_cast<ObjCImplementationDecl>(CtxD)) {
962     if (ObjCInterfaceDecl *IFD = ImplD->getClassInterface()) {
963       // When the container is the ObjCImplementationDecl (the primary
964       // @implementation), then the canonical Decl is either in
965       // the class Interface, or in any of its extension.
966       //
967       // So when we don't find it in the ObjCInterfaceDecl,
968       // sift through extensions too.
969       if (ObjCMethodDecl *MD = IFD->getMethod(Sel, isInstanceMethod()))
970         return MD;
971       for (auto *Ext : IFD->known_extensions())
972         if (ObjCMethodDecl *MD = Ext->getMethod(Sel, isInstanceMethod()))
973           return MD;
974     }
975   } else if (auto *CImplD = dyn_cast<ObjCCategoryImplDecl>(CtxD)) {
976     if (ObjCCategoryDecl *CatD = CImplD->getCategoryDecl())
977       if (ObjCMethodDecl *MD = CatD->getMethod(Sel, isInstanceMethod()))
978         return MD;
979   }
980 
981   if (isRedeclaration()) {
982     // It is possible that we have not done deserializing the ObjCMethod yet.
983     ObjCMethodDecl *MD =
984         cast<ObjCContainerDecl>(CtxD)->getMethod(Sel, isInstanceMethod());
985     return MD ? MD : this;
986   }
987 
988   return this;
989 }
990 
991 SourceLocation ObjCMethodDecl::getEndLoc() const {
992   if (Stmt *Body = getBody())
993     return Body->getEndLoc();
994   return DeclEndLoc;
995 }
996 
997 ObjCMethodFamily ObjCMethodDecl::getMethodFamily() const {
998   auto family = static_cast<ObjCMethodFamily>(ObjCMethodDeclBits.Family);
999   if (family != static_cast<unsigned>(InvalidObjCMethodFamily))
1000     return family;
1001 
1002   // Check for an explicit attribute.
1003   if (const ObjCMethodFamilyAttr *attr = getAttr<ObjCMethodFamilyAttr>()) {
1004     // The unfortunate necessity of mapping between enums here is due
1005     // to the attributes framework.
1006     switch (attr->getFamily()) {
1007     case ObjCMethodFamilyAttr::OMF_None: family = OMF_None; break;
1008     case ObjCMethodFamilyAttr::OMF_alloc: family = OMF_alloc; break;
1009     case ObjCMethodFamilyAttr::OMF_copy: family = OMF_copy; break;
1010     case ObjCMethodFamilyAttr::OMF_init: family = OMF_init; break;
1011     case ObjCMethodFamilyAttr::OMF_mutableCopy: family = OMF_mutableCopy; break;
1012     case ObjCMethodFamilyAttr::OMF_new: family = OMF_new; break;
1013     }
1014     ObjCMethodDeclBits.Family = family;
1015     return family;
1016   }
1017 
1018   family = getSelector().getMethodFamily();
1019   switch (family) {
1020   case OMF_None: break;
1021 
1022   // init only has a conventional meaning for an instance method, and
1023   // it has to return an object.
1024   case OMF_init:
1025     if (!isInstanceMethod() || !getReturnType()->isObjCObjectPointerType())
1026       family = OMF_None;
1027     break;
1028 
1029   // alloc/copy/new have a conventional meaning for both class and
1030   // instance methods, but they require an object return.
1031   case OMF_alloc:
1032   case OMF_copy:
1033   case OMF_mutableCopy:
1034   case OMF_new:
1035     if (!getReturnType()->isObjCObjectPointerType())
1036       family = OMF_None;
1037     break;
1038 
1039   // These selectors have a conventional meaning only for instance methods.
1040   case OMF_dealloc:
1041   case OMF_finalize:
1042   case OMF_retain:
1043   case OMF_release:
1044   case OMF_autorelease:
1045   case OMF_retainCount:
1046   case OMF_self:
1047     if (!isInstanceMethod())
1048       family = OMF_None;
1049     break;
1050 
1051   case OMF_initialize:
1052     if (isInstanceMethod() || !getReturnType()->isVoidType())
1053       family = OMF_None;
1054     break;
1055 
1056   case OMF_performSelector:
1057     if (!isInstanceMethod() || !getReturnType()->isObjCIdType())
1058       family = OMF_None;
1059     else {
1060       unsigned noParams = param_size();
1061       if (noParams < 1 || noParams > 3)
1062         family = OMF_None;
1063       else {
1064         ObjCMethodDecl::param_type_iterator it = param_type_begin();
1065         QualType ArgT = (*it);
1066         if (!ArgT->isObjCSelType()) {
1067           family = OMF_None;
1068           break;
1069         }
1070         while (--noParams) {
1071           it++;
1072           ArgT = (*it);
1073           if (!ArgT->isObjCIdType()) {
1074             family = OMF_None;
1075             break;
1076           }
1077         }
1078       }
1079     }
1080     break;
1081 
1082   }
1083 
1084   // Cache the result.
1085   ObjCMethodDeclBits.Family = family;
1086   return family;
1087 }
1088 
1089 QualType ObjCMethodDecl::getSelfType(ASTContext &Context,
1090                                      const ObjCInterfaceDecl *OID,
1091                                      bool &selfIsPseudoStrong,
1092                                      bool &selfIsConsumed) const {
1093   QualType selfTy;
1094   selfIsPseudoStrong = false;
1095   selfIsConsumed = false;
1096   if (isInstanceMethod()) {
1097     // There may be no interface context due to error in declaration
1098     // of the interface (which has been reported). Recover gracefully.
1099     if (OID) {
1100       selfTy = Context.getObjCInterfaceType(OID);
1101       selfTy = Context.getObjCObjectPointerType(selfTy);
1102     } else {
1103       selfTy = Context.getObjCIdType();
1104     }
1105   } else // we have a factory method.
1106     selfTy = Context.getObjCClassType();
1107 
1108   if (Context.getLangOpts().ObjCAutoRefCount) {
1109     if (isInstanceMethod()) {
1110       selfIsConsumed = hasAttr<NSConsumesSelfAttr>();
1111 
1112       // 'self' is always __strong.  It's actually pseudo-strong except
1113       // in init methods (or methods labeled ns_consumes_self), though.
1114       Qualifiers qs;
1115       qs.setObjCLifetime(Qualifiers::OCL_Strong);
1116       selfTy = Context.getQualifiedType(selfTy, qs);
1117 
1118       // In addition, 'self' is const unless this is an init method.
1119       if (getMethodFamily() != OMF_init && !selfIsConsumed) {
1120         selfTy = selfTy.withConst();
1121         selfIsPseudoStrong = true;
1122       }
1123     }
1124     else {
1125       assert(isClassMethod());
1126       // 'self' is always const in class methods.
1127       selfTy = selfTy.withConst();
1128       selfIsPseudoStrong = true;
1129     }
1130   }
1131   return selfTy;
1132 }
1133 
1134 void ObjCMethodDecl::createImplicitParams(ASTContext &Context,
1135                                           const ObjCInterfaceDecl *OID) {
1136   bool selfIsPseudoStrong, selfIsConsumed;
1137   QualType selfTy =
1138     getSelfType(Context, OID, selfIsPseudoStrong, selfIsConsumed);
1139   auto *Self = ImplicitParamDecl::Create(Context, this, SourceLocation(),
1140                                          &Context.Idents.get("self"), selfTy,
1141                                          ImplicitParamDecl::ObjCSelf);
1142   setSelfDecl(Self);
1143 
1144   if (selfIsConsumed)
1145     Self->addAttr(NSConsumedAttr::CreateImplicit(Context));
1146 
1147   if (selfIsPseudoStrong)
1148     Self->setARCPseudoStrong(true);
1149 
1150   setCmdDecl(ImplicitParamDecl::Create(
1151       Context, this, SourceLocation(), &Context.Idents.get("_cmd"),
1152       Context.getObjCSelType(), ImplicitParamDecl::ObjCCmd));
1153 }
1154 
1155 ObjCInterfaceDecl *ObjCMethodDecl::getClassInterface() {
1156   if (auto *ID = dyn_cast<ObjCInterfaceDecl>(getDeclContext()))
1157     return ID;
1158   if (auto *CD = dyn_cast<ObjCCategoryDecl>(getDeclContext()))
1159     return CD->getClassInterface();
1160   if (auto *IMD = dyn_cast<ObjCImplDecl>(getDeclContext()))
1161     return IMD->getClassInterface();
1162   if (isa<ObjCProtocolDecl>(getDeclContext()))
1163     return nullptr;
1164   llvm_unreachable("unknown method context");
1165 }
1166 
1167 SourceRange ObjCMethodDecl::getReturnTypeSourceRange() const {
1168   const auto *TSI = getReturnTypeSourceInfo();
1169   if (TSI)
1170     return TSI->getTypeLoc().getSourceRange();
1171   return SourceRange();
1172 }
1173 
1174 QualType ObjCMethodDecl::getSendResultType() const {
1175   ASTContext &Ctx = getASTContext();
1176   return getReturnType().getNonLValueExprType(Ctx)
1177            .substObjCTypeArgs(Ctx, {}, ObjCSubstitutionContext::Result);
1178 }
1179 
1180 QualType ObjCMethodDecl::getSendResultType(QualType receiverType) const {
1181   // FIXME: Handle related result types here.
1182 
1183   return getReturnType().getNonLValueExprType(getASTContext())
1184            .substObjCMemberType(receiverType, getDeclContext(),
1185                                 ObjCSubstitutionContext::Result);
1186 }
1187 
1188 static void CollectOverriddenMethodsRecurse(const ObjCContainerDecl *Container,
1189                                             const ObjCMethodDecl *Method,
1190                                SmallVectorImpl<const ObjCMethodDecl *> &Methods,
1191                                             bool MovedToSuper) {
1192   if (!Container)
1193     return;
1194 
1195   // In categories look for overridden methods from protocols. A method from
1196   // category is not "overridden" since it is considered as the "same" method
1197   // (same USR) as the one from the interface.
1198   if (const auto *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
1199     // Check whether we have a matching method at this category but only if we
1200     // are at the super class level.
1201     if (MovedToSuper)
1202       if (ObjCMethodDecl *
1203             Overridden = Container->getMethod(Method->getSelector(),
1204                                               Method->isInstanceMethod(),
1205                                               /*AllowHidden=*/true))
1206         if (Method != Overridden) {
1207           // We found an override at this category; there is no need to look
1208           // into its protocols.
1209           Methods.push_back(Overridden);
1210           return;
1211         }
1212 
1213     for (const auto *P : Category->protocols())
1214       CollectOverriddenMethodsRecurse(P, Method, Methods, MovedToSuper);
1215     return;
1216   }
1217 
1218   // Check whether we have a matching method at this level.
1219   if (const ObjCMethodDecl *
1220         Overridden = Container->getMethod(Method->getSelector(),
1221                                           Method->isInstanceMethod(),
1222                                           /*AllowHidden=*/true))
1223     if (Method != Overridden) {
1224       // We found an override at this level; there is no need to look
1225       // into other protocols or categories.
1226       Methods.push_back(Overridden);
1227       return;
1228     }
1229 
1230   if (const auto *Protocol = dyn_cast<ObjCProtocolDecl>(Container)){
1231     for (const auto *P : Protocol->protocols())
1232       CollectOverriddenMethodsRecurse(P, Method, Methods, MovedToSuper);
1233   }
1234 
1235   if (const auto *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
1236     for (const auto *P : Interface->protocols())
1237       CollectOverriddenMethodsRecurse(P, Method, Methods, MovedToSuper);
1238 
1239     for (const auto *Cat : Interface->known_categories())
1240       CollectOverriddenMethodsRecurse(Cat, Method, Methods, MovedToSuper);
1241 
1242     if (const ObjCInterfaceDecl *Super = Interface->getSuperClass())
1243       return CollectOverriddenMethodsRecurse(Super, Method, Methods,
1244                                              /*MovedToSuper=*/true);
1245   }
1246 }
1247 
1248 static inline void CollectOverriddenMethods(const ObjCContainerDecl *Container,
1249                                             const ObjCMethodDecl *Method,
1250                              SmallVectorImpl<const ObjCMethodDecl *> &Methods) {
1251   CollectOverriddenMethodsRecurse(Container, Method, Methods,
1252                                   /*MovedToSuper=*/false);
1253 }
1254 
1255 static void collectOverriddenMethodsSlow(const ObjCMethodDecl *Method,
1256                           SmallVectorImpl<const ObjCMethodDecl *> &overridden) {
1257   assert(Method->isOverriding());
1258 
1259   if (const auto *ProtD =
1260           dyn_cast<ObjCProtocolDecl>(Method->getDeclContext())) {
1261     CollectOverriddenMethods(ProtD, Method, overridden);
1262 
1263   } else if (const auto *IMD =
1264                  dyn_cast<ObjCImplDecl>(Method->getDeclContext())) {
1265     const ObjCInterfaceDecl *ID = IMD->getClassInterface();
1266     if (!ID)
1267       return;
1268     // Start searching for overridden methods using the method from the
1269     // interface as starting point.
1270     if (const ObjCMethodDecl *IFaceMeth = ID->getMethod(Method->getSelector(),
1271                                                     Method->isInstanceMethod(),
1272                                                     /*AllowHidden=*/true))
1273       Method = IFaceMeth;
1274     CollectOverriddenMethods(ID, Method, overridden);
1275 
1276   } else if (const auto *CatD =
1277                  dyn_cast<ObjCCategoryDecl>(Method->getDeclContext())) {
1278     const ObjCInterfaceDecl *ID = CatD->getClassInterface();
1279     if (!ID)
1280       return;
1281     // Start searching for overridden methods using the method from the
1282     // interface as starting point.
1283     if (const ObjCMethodDecl *IFaceMeth = ID->getMethod(Method->getSelector(),
1284                                                      Method->isInstanceMethod(),
1285                                                      /*AllowHidden=*/true))
1286       Method = IFaceMeth;
1287     CollectOverriddenMethods(ID, Method, overridden);
1288 
1289   } else {
1290     CollectOverriddenMethods(
1291                   dyn_cast_or_null<ObjCContainerDecl>(Method->getDeclContext()),
1292                   Method, overridden);
1293   }
1294 }
1295 
1296 void ObjCMethodDecl::getOverriddenMethods(
1297                     SmallVectorImpl<const ObjCMethodDecl *> &Overridden) const {
1298   const ObjCMethodDecl *Method = this;
1299 
1300   if (Method->isRedeclaration()) {
1301     Method = cast<ObjCContainerDecl>(Method->getDeclContext())->
1302                    getMethod(Method->getSelector(), Method->isInstanceMethod());
1303   }
1304 
1305   if (Method->isOverriding()) {
1306     collectOverriddenMethodsSlow(Method, Overridden);
1307     assert(!Overridden.empty() &&
1308            "ObjCMethodDecl's overriding bit is not as expected");
1309   }
1310 }
1311 
1312 const ObjCPropertyDecl *
1313 ObjCMethodDecl::findPropertyDecl(bool CheckOverrides) const {
1314   Selector Sel = getSelector();
1315   unsigned NumArgs = Sel.getNumArgs();
1316   if (NumArgs > 1)
1317     return nullptr;
1318 
1319   if (isPropertyAccessor()) {
1320     const auto *Container = cast<ObjCContainerDecl>(getParent());
1321     // For accessor stubs, go back to the interface.
1322     if (auto *ImplDecl = dyn_cast<ObjCImplDecl>(Container))
1323       if (isSynthesizedAccessorStub())
1324         Container = ImplDecl->getClassInterface();
1325 
1326     bool IsGetter = (NumArgs == 0);
1327     bool IsInstance = isInstanceMethod();
1328 
1329     /// Local function that attempts to find a matching property within the
1330     /// given Objective-C container.
1331     auto findMatchingProperty =
1332       [&](const ObjCContainerDecl *Container) -> const ObjCPropertyDecl * {
1333       if (IsInstance) {
1334         for (const auto *I : Container->instance_properties()) {
1335           Selector NextSel = IsGetter ? I->getGetterName()
1336                                       : I->getSetterName();
1337           if (NextSel == Sel)
1338             return I;
1339         }
1340       } else {
1341         for (const auto *I : Container->class_properties()) {
1342           Selector NextSel = IsGetter ? I->getGetterName()
1343                                       : I->getSetterName();
1344           if (NextSel == Sel)
1345             return I;
1346         }
1347       }
1348 
1349       return nullptr;
1350     };
1351 
1352     // Look in the container we were given.
1353     if (const auto *Found = findMatchingProperty(Container))
1354       return Found;
1355 
1356     // If we're in a category or extension, look in the main class.
1357     const ObjCInterfaceDecl *ClassDecl = nullptr;
1358     if (const auto *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
1359       ClassDecl = Category->getClassInterface();
1360       if (const auto *Found = findMatchingProperty(ClassDecl))
1361         return Found;
1362     } else {
1363       // Determine whether the container is a class.
1364       ClassDecl = cast<ObjCInterfaceDecl>(Container);
1365     }
1366     assert(ClassDecl && "Failed to find main class");
1367 
1368     // If we have a class, check its visible extensions.
1369     for (const auto *Ext : ClassDecl->visible_extensions()) {
1370       if (Ext == Container)
1371         continue;
1372       if (const auto *Found = findMatchingProperty(Ext))
1373         return Found;
1374     }
1375 
1376     assert(isSynthesizedAccessorStub() && "expected an accessor stub");
1377 
1378     for (const auto *Cat : ClassDecl->known_categories()) {
1379       if (Cat == Container)
1380         continue;
1381       if (const auto *Found = findMatchingProperty(Cat))
1382         return Found;
1383     }
1384 
1385     llvm_unreachable("Marked as a property accessor but no property found!");
1386   }
1387 
1388   if (!CheckOverrides)
1389     return nullptr;
1390 
1391   using OverridesTy = SmallVector<const ObjCMethodDecl *, 8>;
1392 
1393   OverridesTy Overrides;
1394   getOverriddenMethods(Overrides);
1395   for (const auto *Override : Overrides)
1396     if (const ObjCPropertyDecl *Prop = Override->findPropertyDecl(false))
1397       return Prop;
1398 
1399   return nullptr;
1400 }
1401 
1402 //===----------------------------------------------------------------------===//
1403 // ObjCTypeParamDecl
1404 //===----------------------------------------------------------------------===//
1405 
1406 void ObjCTypeParamDecl::anchor() {}
1407 
1408 ObjCTypeParamDecl *ObjCTypeParamDecl::Create(ASTContext &ctx, DeclContext *dc,
1409                                              ObjCTypeParamVariance variance,
1410                                              SourceLocation varianceLoc,
1411                                              unsigned index,
1412                                              SourceLocation nameLoc,
1413                                              IdentifierInfo *name,
1414                                              SourceLocation colonLoc,
1415                                              TypeSourceInfo *boundInfo) {
1416   auto *TPDecl =
1417     new (ctx, dc) ObjCTypeParamDecl(ctx, dc, variance, varianceLoc, index,
1418                                     nameLoc, name, colonLoc, boundInfo);
1419   QualType TPType = ctx.getObjCTypeParamType(TPDecl, {});
1420   TPDecl->setTypeForDecl(TPType.getTypePtr());
1421   return TPDecl;
1422 }
1423 
1424 ObjCTypeParamDecl *ObjCTypeParamDecl::CreateDeserialized(ASTContext &ctx,
1425                                                          unsigned ID) {
1426   return new (ctx, ID) ObjCTypeParamDecl(ctx, nullptr,
1427                                          ObjCTypeParamVariance::Invariant,
1428                                          SourceLocation(), 0, SourceLocation(),
1429                                          nullptr, SourceLocation(), nullptr);
1430 }
1431 
1432 SourceRange ObjCTypeParamDecl::getSourceRange() const {
1433   SourceLocation startLoc = VarianceLoc;
1434   if (startLoc.isInvalid())
1435     startLoc = getLocation();
1436 
1437   if (hasExplicitBound()) {
1438     return SourceRange(startLoc,
1439                        getTypeSourceInfo()->getTypeLoc().getEndLoc());
1440   }
1441 
1442   return SourceRange(startLoc);
1443 }
1444 
1445 //===----------------------------------------------------------------------===//
1446 // ObjCTypeParamList
1447 //===----------------------------------------------------------------------===//
1448 ObjCTypeParamList::ObjCTypeParamList(SourceLocation lAngleLoc,
1449                                      ArrayRef<ObjCTypeParamDecl *> typeParams,
1450                                      SourceLocation rAngleLoc)
1451     : NumParams(typeParams.size()) {
1452   Brackets.Begin = lAngleLoc.getRawEncoding();
1453   Brackets.End = rAngleLoc.getRawEncoding();
1454   std::copy(typeParams.begin(), typeParams.end(), begin());
1455 }
1456 
1457 ObjCTypeParamList *ObjCTypeParamList::create(
1458                      ASTContext &ctx,
1459                      SourceLocation lAngleLoc,
1460                      ArrayRef<ObjCTypeParamDecl *> typeParams,
1461                      SourceLocation rAngleLoc) {
1462   void *mem =
1463       ctx.Allocate(totalSizeToAlloc<ObjCTypeParamDecl *>(typeParams.size()),
1464                    alignof(ObjCTypeParamList));
1465   return new (mem) ObjCTypeParamList(lAngleLoc, typeParams, rAngleLoc);
1466 }
1467 
1468 void ObjCTypeParamList::gatherDefaultTypeArgs(
1469        SmallVectorImpl<QualType> &typeArgs) const {
1470   typeArgs.reserve(size());
1471   for (auto typeParam : *this)
1472     typeArgs.push_back(typeParam->getUnderlyingType());
1473 }
1474 
1475 //===----------------------------------------------------------------------===//
1476 // ObjCInterfaceDecl
1477 //===----------------------------------------------------------------------===//
1478 
1479 ObjCInterfaceDecl *ObjCInterfaceDecl::Create(const ASTContext &C,
1480                                              DeclContext *DC,
1481                                              SourceLocation atLoc,
1482                                              IdentifierInfo *Id,
1483                                              ObjCTypeParamList *typeParamList,
1484                                              ObjCInterfaceDecl *PrevDecl,
1485                                              SourceLocation ClassLoc,
1486                                              bool isInternal){
1487   auto *Result = new (C, DC)
1488       ObjCInterfaceDecl(C, DC, atLoc, Id, typeParamList, ClassLoc, PrevDecl,
1489                         isInternal);
1490   Result->Data.setInt(!C.getLangOpts().Modules);
1491   C.getObjCInterfaceType(Result, PrevDecl);
1492   return Result;
1493 }
1494 
1495 ObjCInterfaceDecl *ObjCInterfaceDecl::CreateDeserialized(const ASTContext &C,
1496                                                          unsigned ID) {
1497   auto *Result = new (C, ID)
1498       ObjCInterfaceDecl(C, nullptr, SourceLocation(), nullptr, nullptr,
1499                         SourceLocation(), nullptr, false);
1500   Result->Data.setInt(!C.getLangOpts().Modules);
1501   return Result;
1502 }
1503 
1504 ObjCInterfaceDecl::ObjCInterfaceDecl(const ASTContext &C, DeclContext *DC,
1505                                      SourceLocation AtLoc, IdentifierInfo *Id,
1506                                      ObjCTypeParamList *typeParamList,
1507                                      SourceLocation CLoc,
1508                                      ObjCInterfaceDecl *PrevDecl,
1509                                      bool IsInternal)
1510     : ObjCContainerDecl(ObjCInterface, DC, Id, CLoc, AtLoc),
1511       redeclarable_base(C) {
1512   setPreviousDecl(PrevDecl);
1513 
1514   // Copy the 'data' pointer over.
1515   if (PrevDecl)
1516     Data = PrevDecl->Data;
1517 
1518   setImplicit(IsInternal);
1519 
1520   setTypeParamList(typeParamList);
1521 }
1522 
1523 void ObjCInterfaceDecl::LoadExternalDefinition() const {
1524   assert(data().ExternallyCompleted && "Class is not externally completed");
1525   data().ExternallyCompleted = false;
1526   getASTContext().getExternalSource()->CompleteType(
1527                                         const_cast<ObjCInterfaceDecl *>(this));
1528 }
1529 
1530 void ObjCInterfaceDecl::setExternallyCompleted() {
1531   assert(getASTContext().getExternalSource() &&
1532          "Class can't be externally completed without an external source");
1533   assert(hasDefinition() &&
1534          "Forward declarations can't be externally completed");
1535   data().ExternallyCompleted = true;
1536 }
1537 
1538 void ObjCInterfaceDecl::setHasDesignatedInitializers() {
1539   // Check for a complete definition and recover if not so.
1540   if (!isThisDeclarationADefinition())
1541     return;
1542   data().HasDesignatedInitializers = true;
1543 }
1544 
1545 bool ObjCInterfaceDecl::hasDesignatedInitializers() const {
1546   // Check for a complete definition and recover if not so.
1547   if (!isThisDeclarationADefinition())
1548     return false;
1549   if (data().ExternallyCompleted)
1550     LoadExternalDefinition();
1551 
1552   return data().HasDesignatedInitializers;
1553 }
1554 
1555 StringRef
1556 ObjCInterfaceDecl::getObjCRuntimeNameAsString() const {
1557   if (const auto *ObjCRTName = getAttr<ObjCRuntimeNameAttr>())
1558     return ObjCRTName->getMetadataName();
1559 
1560   return getName();
1561 }
1562 
1563 StringRef
1564 ObjCImplementationDecl::getObjCRuntimeNameAsString() const {
1565   if (ObjCInterfaceDecl *ID =
1566       const_cast<ObjCImplementationDecl*>(this)->getClassInterface())
1567     return ID->getObjCRuntimeNameAsString();
1568 
1569   return getName();
1570 }
1571 
1572 ObjCImplementationDecl *ObjCInterfaceDecl::getImplementation() const {
1573   if (const ObjCInterfaceDecl *Def = getDefinition()) {
1574     if (data().ExternallyCompleted)
1575       LoadExternalDefinition();
1576 
1577     return getASTContext().getObjCImplementation(
1578              const_cast<ObjCInterfaceDecl*>(Def));
1579   }
1580 
1581   // FIXME: Should make sure no callers ever do this.
1582   return nullptr;
1583 }
1584 
1585 void ObjCInterfaceDecl::setImplementation(ObjCImplementationDecl *ImplD) {
1586   getASTContext().setObjCImplementation(getDefinition(), ImplD);
1587 }
1588 
1589 namespace {
1590 
1591 struct SynthesizeIvarChunk {
1592   uint64_t Size;
1593   ObjCIvarDecl *Ivar;
1594 
1595   SynthesizeIvarChunk(uint64_t size, ObjCIvarDecl *ivar)
1596       : Size(size), Ivar(ivar) {}
1597 };
1598 
1599 bool operator<(const SynthesizeIvarChunk & LHS,
1600                const SynthesizeIvarChunk &RHS) {
1601     return LHS.Size < RHS.Size;
1602 }
1603 
1604 } // namespace
1605 
1606 /// all_declared_ivar_begin - return first ivar declared in this class,
1607 /// its extensions and its implementation. Lazily build the list on first
1608 /// access.
1609 ///
1610 /// Caveat: The list returned by this method reflects the current
1611 /// state of the parser. The cache will be updated for every ivar
1612 /// added by an extension or the implementation when they are
1613 /// encountered.
1614 /// See also ObjCIvarDecl::Create().
1615 ObjCIvarDecl *ObjCInterfaceDecl::all_declared_ivar_begin() {
1616   // FIXME: Should make sure no callers ever do this.
1617   if (!hasDefinition())
1618     return nullptr;
1619 
1620   ObjCIvarDecl *curIvar = nullptr;
1621   if (!data().IvarList) {
1622     if (!ivar_empty()) {
1623       ObjCInterfaceDecl::ivar_iterator I = ivar_begin(), E = ivar_end();
1624       data().IvarList = *I; ++I;
1625       for (curIvar = data().IvarList; I != E; curIvar = *I, ++I)
1626         curIvar->setNextIvar(*I);
1627     }
1628 
1629     for (const auto *Ext : known_extensions()) {
1630       if (!Ext->ivar_empty()) {
1631         ObjCCategoryDecl::ivar_iterator
1632           I = Ext->ivar_begin(),
1633           E = Ext->ivar_end();
1634         if (!data().IvarList) {
1635           data().IvarList = *I; ++I;
1636           curIvar = data().IvarList;
1637         }
1638         for ( ;I != E; curIvar = *I, ++I)
1639           curIvar->setNextIvar(*I);
1640       }
1641     }
1642     data().IvarListMissingImplementation = true;
1643   }
1644 
1645   // cached and complete!
1646   if (!data().IvarListMissingImplementation)
1647       return data().IvarList;
1648 
1649   if (ObjCImplementationDecl *ImplDecl = getImplementation()) {
1650     data().IvarListMissingImplementation = false;
1651     if (!ImplDecl->ivar_empty()) {
1652       SmallVector<SynthesizeIvarChunk, 16> layout;
1653       for (auto *IV : ImplDecl->ivars()) {
1654         if (IV->getSynthesize() && !IV->isInvalidDecl()) {
1655           layout.push_back(SynthesizeIvarChunk(
1656                              IV->getASTContext().getTypeSize(IV->getType()), IV));
1657           continue;
1658         }
1659         if (!data().IvarList)
1660           data().IvarList = IV;
1661         else
1662           curIvar->setNextIvar(IV);
1663         curIvar = IV;
1664       }
1665 
1666       if (!layout.empty()) {
1667         // Order synthesized ivars by their size.
1668         llvm::stable_sort(layout);
1669         unsigned Ix = 0, EIx = layout.size();
1670         if (!data().IvarList) {
1671           data().IvarList = layout[0].Ivar; Ix++;
1672           curIvar = data().IvarList;
1673         }
1674         for ( ; Ix != EIx; curIvar = layout[Ix].Ivar, Ix++)
1675           curIvar->setNextIvar(layout[Ix].Ivar);
1676       }
1677     }
1678   }
1679   return data().IvarList;
1680 }
1681 
1682 /// FindCategoryDeclaration - Finds category declaration in the list of
1683 /// categories for this class and returns it. Name of the category is passed
1684 /// in 'CategoryId'. If category not found, return 0;
1685 ///
1686 ObjCCategoryDecl *
1687 ObjCInterfaceDecl::FindCategoryDeclaration(IdentifierInfo *CategoryId) const {
1688   // FIXME: Should make sure no callers ever do this.
1689   if (!hasDefinition())
1690     return nullptr;
1691 
1692   if (data().ExternallyCompleted)
1693     LoadExternalDefinition();
1694 
1695   for (auto *Cat : visible_categories())
1696     if (Cat->getIdentifier() == CategoryId)
1697       return Cat;
1698 
1699   return nullptr;
1700 }
1701 
1702 ObjCMethodDecl *
1703 ObjCInterfaceDecl::getCategoryInstanceMethod(Selector Sel) const {
1704   for (const auto *Cat : visible_categories()) {
1705     if (ObjCCategoryImplDecl *Impl = Cat->getImplementation())
1706       if (ObjCMethodDecl *MD = Impl->getInstanceMethod(Sel))
1707         return MD;
1708   }
1709 
1710   return nullptr;
1711 }
1712 
1713 ObjCMethodDecl *ObjCInterfaceDecl::getCategoryClassMethod(Selector Sel) const {
1714   for (const auto *Cat : visible_categories()) {
1715     if (ObjCCategoryImplDecl *Impl = Cat->getImplementation())
1716       if (ObjCMethodDecl *MD = Impl->getClassMethod(Sel))
1717         return MD;
1718   }
1719 
1720   return nullptr;
1721 }
1722 
1723 /// ClassImplementsProtocol - Checks that 'lProto' protocol
1724 /// has been implemented in IDecl class, its super class or categories (if
1725 /// lookupCategory is true).
1726 bool ObjCInterfaceDecl::ClassImplementsProtocol(ObjCProtocolDecl *lProto,
1727                                     bool lookupCategory,
1728                                     bool RHSIsQualifiedID) {
1729   if (!hasDefinition())
1730     return false;
1731 
1732   ObjCInterfaceDecl *IDecl = this;
1733   // 1st, look up the class.
1734   for (auto *PI : IDecl->protocols()){
1735     if (getASTContext().ProtocolCompatibleWithProtocol(lProto, PI))
1736       return true;
1737     // This is dubious and is added to be compatible with gcc.  In gcc, it is
1738     // also allowed assigning a protocol-qualified 'id' type to a LHS object
1739     // when protocol in qualified LHS is in list of protocols in the rhs 'id'
1740     // object. This IMO, should be a bug.
1741     // FIXME: Treat this as an extension, and flag this as an error when GCC
1742     // extensions are not enabled.
1743     if (RHSIsQualifiedID &&
1744         getASTContext().ProtocolCompatibleWithProtocol(PI, lProto))
1745       return true;
1746   }
1747 
1748   // 2nd, look up the category.
1749   if (lookupCategory)
1750     for (const auto *Cat : visible_categories()) {
1751       for (auto *PI : Cat->protocols())
1752         if (getASTContext().ProtocolCompatibleWithProtocol(lProto, PI))
1753           return true;
1754     }
1755 
1756   // 3rd, look up the super class(s)
1757   if (IDecl->getSuperClass())
1758     return
1759   IDecl->getSuperClass()->ClassImplementsProtocol(lProto, lookupCategory,
1760                                                   RHSIsQualifiedID);
1761 
1762   return false;
1763 }
1764 
1765 //===----------------------------------------------------------------------===//
1766 // ObjCIvarDecl
1767 //===----------------------------------------------------------------------===//
1768 
1769 void ObjCIvarDecl::anchor() {}
1770 
1771 ObjCIvarDecl *ObjCIvarDecl::Create(ASTContext &C, ObjCContainerDecl *DC,
1772                                    SourceLocation StartLoc,
1773                                    SourceLocation IdLoc, IdentifierInfo *Id,
1774                                    QualType T, TypeSourceInfo *TInfo,
1775                                    AccessControl ac, Expr *BW,
1776                                    bool synthesized) {
1777   if (DC) {
1778     // Ivar's can only appear in interfaces, implementations (via synthesized
1779     // properties), and class extensions (via direct declaration, or synthesized
1780     // properties).
1781     //
1782     // FIXME: This should really be asserting this:
1783     //   (isa<ObjCCategoryDecl>(DC) &&
1784     //    cast<ObjCCategoryDecl>(DC)->IsClassExtension()))
1785     // but unfortunately we sometimes place ivars into non-class extension
1786     // categories on error. This breaks an AST invariant, and should not be
1787     // fixed.
1788     assert((isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl>(DC) ||
1789             isa<ObjCCategoryDecl>(DC)) &&
1790            "Invalid ivar decl context!");
1791     // Once a new ivar is created in any of class/class-extension/implementation
1792     // decl contexts, the previously built IvarList must be rebuilt.
1793     auto *ID = dyn_cast<ObjCInterfaceDecl>(DC);
1794     if (!ID) {
1795       if (auto *IM = dyn_cast<ObjCImplementationDecl>(DC))
1796         ID = IM->getClassInterface();
1797       else
1798         ID = cast<ObjCCategoryDecl>(DC)->getClassInterface();
1799     }
1800     ID->setIvarList(nullptr);
1801   }
1802 
1803   return new (C, DC) ObjCIvarDecl(DC, StartLoc, IdLoc, Id, T, TInfo, ac, BW,
1804                                   synthesized);
1805 }
1806 
1807 ObjCIvarDecl *ObjCIvarDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
1808   return new (C, ID) ObjCIvarDecl(nullptr, SourceLocation(), SourceLocation(),
1809                                   nullptr, QualType(), nullptr,
1810                                   ObjCIvarDecl::None, nullptr, false);
1811 }
1812 
1813 const ObjCInterfaceDecl *ObjCIvarDecl::getContainingInterface() const {
1814   const auto *DC = cast<ObjCContainerDecl>(getDeclContext());
1815 
1816   switch (DC->getKind()) {
1817   default:
1818   case ObjCCategoryImpl:
1819   case ObjCProtocol:
1820     llvm_unreachable("invalid ivar container!");
1821 
1822     // Ivars can only appear in class extension categories.
1823   case ObjCCategory: {
1824     const auto *CD = cast<ObjCCategoryDecl>(DC);
1825     assert(CD->IsClassExtension() && "invalid container for ivar!");
1826     return CD->getClassInterface();
1827   }
1828 
1829   case ObjCImplementation:
1830     return cast<ObjCImplementationDecl>(DC)->getClassInterface();
1831 
1832   case ObjCInterface:
1833     return cast<ObjCInterfaceDecl>(DC);
1834   }
1835 }
1836 
1837 QualType ObjCIvarDecl::getUsageType(QualType objectType) const {
1838   return getType().substObjCMemberType(objectType, getDeclContext(),
1839                                        ObjCSubstitutionContext::Property);
1840 }
1841 
1842 //===----------------------------------------------------------------------===//
1843 // ObjCAtDefsFieldDecl
1844 //===----------------------------------------------------------------------===//
1845 
1846 void ObjCAtDefsFieldDecl::anchor() {}
1847 
1848 ObjCAtDefsFieldDecl
1849 *ObjCAtDefsFieldDecl::Create(ASTContext &C, DeclContext *DC,
1850                              SourceLocation StartLoc,  SourceLocation IdLoc,
1851                              IdentifierInfo *Id, QualType T, Expr *BW) {
1852   return new (C, DC) ObjCAtDefsFieldDecl(DC, StartLoc, IdLoc, Id, T, BW);
1853 }
1854 
1855 ObjCAtDefsFieldDecl *ObjCAtDefsFieldDecl::CreateDeserialized(ASTContext &C,
1856                                                              unsigned ID) {
1857   return new (C, ID) ObjCAtDefsFieldDecl(nullptr, SourceLocation(),
1858                                          SourceLocation(), nullptr, QualType(),
1859                                          nullptr);
1860 }
1861 
1862 //===----------------------------------------------------------------------===//
1863 // ObjCProtocolDecl
1864 //===----------------------------------------------------------------------===//
1865 
1866 void ObjCProtocolDecl::anchor() {}
1867 
1868 ObjCProtocolDecl::ObjCProtocolDecl(ASTContext &C, DeclContext *DC,
1869                                    IdentifierInfo *Id, SourceLocation nameLoc,
1870                                    SourceLocation atStartLoc,
1871                                    ObjCProtocolDecl *PrevDecl)
1872     : ObjCContainerDecl(ObjCProtocol, DC, Id, nameLoc, atStartLoc),
1873       redeclarable_base(C) {
1874   setPreviousDecl(PrevDecl);
1875   if (PrevDecl)
1876     Data = PrevDecl->Data;
1877 }
1878 
1879 ObjCProtocolDecl *ObjCProtocolDecl::Create(ASTContext &C, DeclContext *DC,
1880                                            IdentifierInfo *Id,
1881                                            SourceLocation nameLoc,
1882                                            SourceLocation atStartLoc,
1883                                            ObjCProtocolDecl *PrevDecl) {
1884   auto *Result =
1885       new (C, DC) ObjCProtocolDecl(C, DC, Id, nameLoc, atStartLoc, PrevDecl);
1886   Result->Data.setInt(!C.getLangOpts().Modules);
1887   return Result;
1888 }
1889 
1890 ObjCProtocolDecl *ObjCProtocolDecl::CreateDeserialized(ASTContext &C,
1891                                                        unsigned ID) {
1892   ObjCProtocolDecl *Result =
1893       new (C, ID) ObjCProtocolDecl(C, nullptr, nullptr, SourceLocation(),
1894                                    SourceLocation(), nullptr);
1895   Result->Data.setInt(!C.getLangOpts().Modules);
1896   return Result;
1897 }
1898 
1899 ObjCProtocolDecl *ObjCProtocolDecl::lookupProtocolNamed(IdentifierInfo *Name) {
1900   ObjCProtocolDecl *PDecl = this;
1901 
1902   if (Name == getIdentifier())
1903     return PDecl;
1904 
1905   for (auto *I : protocols())
1906     if ((PDecl = I->lookupProtocolNamed(Name)))
1907       return PDecl;
1908 
1909   return nullptr;
1910 }
1911 
1912 // lookupMethod - Lookup a instance/class method in the protocol and protocols
1913 // it inherited.
1914 ObjCMethodDecl *ObjCProtocolDecl::lookupMethod(Selector Sel,
1915                                                bool isInstance) const {
1916   ObjCMethodDecl *MethodDecl = nullptr;
1917 
1918   // If there is no definition or the definition is hidden, we don't find
1919   // anything.
1920   const ObjCProtocolDecl *Def = getDefinition();
1921   if (!Def || Def->isHidden())
1922     return nullptr;
1923 
1924   if ((MethodDecl = getMethod(Sel, isInstance)))
1925     return MethodDecl;
1926 
1927   for (const auto *I : protocols())
1928     if ((MethodDecl = I->lookupMethod(Sel, isInstance)))
1929       return MethodDecl;
1930   return nullptr;
1931 }
1932 
1933 void ObjCProtocolDecl::allocateDefinitionData() {
1934   assert(!Data.getPointer() && "Protocol already has a definition!");
1935   Data.setPointer(new (getASTContext()) DefinitionData);
1936   Data.getPointer()->Definition = this;
1937 }
1938 
1939 void ObjCProtocolDecl::startDefinition() {
1940   allocateDefinitionData();
1941 
1942   // Update all of the declarations with a pointer to the definition.
1943   for (auto *RD : redecls())
1944     RD->Data = this->Data;
1945 }
1946 
1947 void ObjCProtocolDecl::collectPropertiesToImplement(PropertyMap &PM,
1948                                                     PropertyDeclOrder &PO) const {
1949   if (const ObjCProtocolDecl *PDecl = getDefinition()) {
1950     for (auto *Prop : PDecl->properties()) {
1951       // Insert into PM if not there already.
1952       PM.insert(std::make_pair(
1953           std::make_pair(Prop->getIdentifier(), Prop->isClassProperty()),
1954           Prop));
1955       PO.push_back(Prop);
1956     }
1957     // Scan through protocol's protocols.
1958     for (const auto *PI : PDecl->protocols())
1959       PI->collectPropertiesToImplement(PM, PO);
1960   }
1961 }
1962 
1963 void ObjCProtocolDecl::collectInheritedProtocolProperties(
1964     const ObjCPropertyDecl *Property, ProtocolPropertySet &PS,
1965     PropertyDeclOrder &PO) const {
1966   if (const ObjCProtocolDecl *PDecl = getDefinition()) {
1967     if (!PS.insert(PDecl).second)
1968       return;
1969     for (auto *Prop : PDecl->properties()) {
1970       if (Prop == Property)
1971         continue;
1972       if (Prop->getIdentifier() == Property->getIdentifier()) {
1973         PO.push_back(Prop);
1974         return;
1975       }
1976     }
1977     // Scan through protocol's protocols which did not have a matching property.
1978     for (const auto *PI : PDecl->protocols())
1979       PI->collectInheritedProtocolProperties(Property, PS, PO);
1980   }
1981 }
1982 
1983 StringRef
1984 ObjCProtocolDecl::getObjCRuntimeNameAsString() const {
1985   if (const auto *ObjCRTName = getAttr<ObjCRuntimeNameAttr>())
1986     return ObjCRTName->getMetadataName();
1987 
1988   return getName();
1989 }
1990 
1991 //===----------------------------------------------------------------------===//
1992 // ObjCCategoryDecl
1993 //===----------------------------------------------------------------------===//
1994 
1995 void ObjCCategoryDecl::anchor() {}
1996 
1997 ObjCCategoryDecl::ObjCCategoryDecl(DeclContext *DC, SourceLocation AtLoc,
1998                                    SourceLocation ClassNameLoc,
1999                                    SourceLocation CategoryNameLoc,
2000                                    IdentifierInfo *Id, ObjCInterfaceDecl *IDecl,
2001                                    ObjCTypeParamList *typeParamList,
2002                                    SourceLocation IvarLBraceLoc,
2003                                    SourceLocation IvarRBraceLoc)
2004     : ObjCContainerDecl(ObjCCategory, DC, Id, ClassNameLoc, AtLoc),
2005       ClassInterface(IDecl), CategoryNameLoc(CategoryNameLoc),
2006       IvarLBraceLoc(IvarLBraceLoc), IvarRBraceLoc(IvarRBraceLoc) {
2007   setTypeParamList(typeParamList);
2008 }
2009 
2010 ObjCCategoryDecl *ObjCCategoryDecl::Create(ASTContext &C, DeclContext *DC,
2011                                            SourceLocation AtLoc,
2012                                            SourceLocation ClassNameLoc,
2013                                            SourceLocation CategoryNameLoc,
2014                                            IdentifierInfo *Id,
2015                                            ObjCInterfaceDecl *IDecl,
2016                                            ObjCTypeParamList *typeParamList,
2017                                            SourceLocation IvarLBraceLoc,
2018                                            SourceLocation IvarRBraceLoc) {
2019   auto *CatDecl =
2020       new (C, DC) ObjCCategoryDecl(DC, AtLoc, ClassNameLoc, CategoryNameLoc, Id,
2021                                    IDecl, typeParamList, IvarLBraceLoc,
2022                                    IvarRBraceLoc);
2023   if (IDecl) {
2024     // Link this category into its class's category list.
2025     CatDecl->NextClassCategory = IDecl->getCategoryListRaw();
2026     if (IDecl->hasDefinition()) {
2027       IDecl->setCategoryListRaw(CatDecl);
2028       if (ASTMutationListener *L = C.getASTMutationListener())
2029         L->AddedObjCCategoryToInterface(CatDecl, IDecl);
2030     }
2031   }
2032 
2033   return CatDecl;
2034 }
2035 
2036 ObjCCategoryDecl *ObjCCategoryDecl::CreateDeserialized(ASTContext &C,
2037                                                        unsigned ID) {
2038   return new (C, ID) ObjCCategoryDecl(nullptr, SourceLocation(),
2039                                       SourceLocation(), SourceLocation(),
2040                                       nullptr, nullptr, nullptr);
2041 }
2042 
2043 ObjCCategoryImplDecl *ObjCCategoryDecl::getImplementation() const {
2044   return getASTContext().getObjCImplementation(
2045                                            const_cast<ObjCCategoryDecl*>(this));
2046 }
2047 
2048 void ObjCCategoryDecl::setImplementation(ObjCCategoryImplDecl *ImplD) {
2049   getASTContext().setObjCImplementation(this, ImplD);
2050 }
2051 
2052 void ObjCCategoryDecl::setTypeParamList(ObjCTypeParamList *TPL) {
2053   TypeParamList = TPL;
2054   if (!TPL)
2055     return;
2056   // Set the declaration context of each of the type parameters.
2057   for (auto *typeParam : *TypeParamList)
2058     typeParam->setDeclContext(this);
2059 }
2060 
2061 //===----------------------------------------------------------------------===//
2062 // ObjCCategoryImplDecl
2063 //===----------------------------------------------------------------------===//
2064 
2065 void ObjCCategoryImplDecl::anchor() {}
2066 
2067 ObjCCategoryImplDecl *
2068 ObjCCategoryImplDecl::Create(ASTContext &C, DeclContext *DC,
2069                              IdentifierInfo *Id,
2070                              ObjCInterfaceDecl *ClassInterface,
2071                              SourceLocation nameLoc,
2072                              SourceLocation atStartLoc,
2073                              SourceLocation CategoryNameLoc) {
2074   if (ClassInterface && ClassInterface->hasDefinition())
2075     ClassInterface = ClassInterface->getDefinition();
2076   return new (C, DC) ObjCCategoryImplDecl(DC, Id, ClassInterface, nameLoc,
2077                                           atStartLoc, CategoryNameLoc);
2078 }
2079 
2080 ObjCCategoryImplDecl *ObjCCategoryImplDecl::CreateDeserialized(ASTContext &C,
2081                                                                unsigned ID) {
2082   return new (C, ID) ObjCCategoryImplDecl(nullptr, nullptr, nullptr,
2083                                           SourceLocation(), SourceLocation(),
2084                                           SourceLocation());
2085 }
2086 
2087 ObjCCategoryDecl *ObjCCategoryImplDecl::getCategoryDecl() const {
2088   // The class interface might be NULL if we are working with invalid code.
2089   if (const ObjCInterfaceDecl *ID = getClassInterface())
2090     return ID->FindCategoryDeclaration(getIdentifier());
2091   return nullptr;
2092 }
2093 
2094 void ObjCImplDecl::anchor() {}
2095 
2096 void ObjCImplDecl::addPropertyImplementation(ObjCPropertyImplDecl *property) {
2097   // FIXME: The context should be correct before we get here.
2098   property->setLexicalDeclContext(this);
2099   addDecl(property);
2100 }
2101 
2102 void ObjCImplDecl::setClassInterface(ObjCInterfaceDecl *IFace) {
2103   ASTContext &Ctx = getASTContext();
2104 
2105   if (auto *ImplD = dyn_cast_or_null<ObjCImplementationDecl>(this)) {
2106     if (IFace)
2107       Ctx.setObjCImplementation(IFace, ImplD);
2108 
2109   } else if (auto *ImplD = dyn_cast_or_null<ObjCCategoryImplDecl>(this)) {
2110     if (ObjCCategoryDecl *CD = IFace->FindCategoryDeclaration(getIdentifier()))
2111       Ctx.setObjCImplementation(CD, ImplD);
2112   }
2113 
2114   ClassInterface = IFace;
2115 }
2116 
2117 /// FindPropertyImplIvarDecl - This method lookup the ivar in the list of
2118 /// properties implemented in this \@implementation block and returns
2119 /// the implemented property that uses it.
2120 ObjCPropertyImplDecl *ObjCImplDecl::
2121 FindPropertyImplIvarDecl(IdentifierInfo *ivarId) const {
2122   for (auto *PID : property_impls())
2123     if (PID->getPropertyIvarDecl() &&
2124         PID->getPropertyIvarDecl()->getIdentifier() == ivarId)
2125       return PID;
2126   return nullptr;
2127 }
2128 
2129 /// FindPropertyImplDecl - This method looks up a previous ObjCPropertyImplDecl
2130 /// added to the list of those properties \@synthesized/\@dynamic in this
2131 /// category \@implementation block.
2132 ObjCPropertyImplDecl *ObjCImplDecl::
2133 FindPropertyImplDecl(IdentifierInfo *Id,
2134                      ObjCPropertyQueryKind QueryKind) const {
2135   ObjCPropertyImplDecl *ClassPropImpl = nullptr;
2136   for (auto *PID : property_impls())
2137     // If queryKind is unknown, we return the instance property if one
2138     // exists; otherwise we return the class property.
2139     if (PID->getPropertyDecl()->getIdentifier() == Id) {
2140       if ((QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown &&
2141            !PID->getPropertyDecl()->isClassProperty()) ||
2142           (QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_class &&
2143            PID->getPropertyDecl()->isClassProperty()) ||
2144           (QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_instance &&
2145            !PID->getPropertyDecl()->isClassProperty()))
2146         return PID;
2147 
2148       if (PID->getPropertyDecl()->isClassProperty())
2149         ClassPropImpl = PID;
2150     }
2151 
2152   if (QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown)
2153     // We can't find the instance property, return the class property.
2154     return ClassPropImpl;
2155 
2156   return nullptr;
2157 }
2158 
2159 raw_ostream &clang::operator<<(raw_ostream &OS,
2160                                const ObjCCategoryImplDecl &CID) {
2161   OS << CID.getName();
2162   return OS;
2163 }
2164 
2165 //===----------------------------------------------------------------------===//
2166 // ObjCImplementationDecl
2167 //===----------------------------------------------------------------------===//
2168 
2169 void ObjCImplementationDecl::anchor() {}
2170 
2171 ObjCImplementationDecl *
2172 ObjCImplementationDecl::Create(ASTContext &C, DeclContext *DC,
2173                                ObjCInterfaceDecl *ClassInterface,
2174                                ObjCInterfaceDecl *SuperDecl,
2175                                SourceLocation nameLoc,
2176                                SourceLocation atStartLoc,
2177                                SourceLocation superLoc,
2178                                SourceLocation IvarLBraceLoc,
2179                                SourceLocation IvarRBraceLoc) {
2180   if (ClassInterface && ClassInterface->hasDefinition())
2181     ClassInterface = ClassInterface->getDefinition();
2182   return new (C, DC) ObjCImplementationDecl(DC, ClassInterface, SuperDecl,
2183                                             nameLoc, atStartLoc, superLoc,
2184                                             IvarLBraceLoc, IvarRBraceLoc);
2185 }
2186 
2187 ObjCImplementationDecl *
2188 ObjCImplementationDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
2189   return new (C, ID) ObjCImplementationDecl(nullptr, nullptr, nullptr,
2190                                             SourceLocation(), SourceLocation());
2191 }
2192 
2193 void ObjCImplementationDecl::setIvarInitializers(ASTContext &C,
2194                                              CXXCtorInitializer ** initializers,
2195                                                  unsigned numInitializers) {
2196   if (numInitializers > 0) {
2197     NumIvarInitializers = numInitializers;
2198     auto **ivarInitializers = new (C) CXXCtorInitializer*[NumIvarInitializers];
2199     memcpy(ivarInitializers, initializers,
2200            numInitializers * sizeof(CXXCtorInitializer*));
2201     IvarInitializers = ivarInitializers;
2202   }
2203 }
2204 
2205 ObjCImplementationDecl::init_const_iterator
2206 ObjCImplementationDecl::init_begin() const {
2207   return IvarInitializers.get(getASTContext().getExternalSource());
2208 }
2209 
2210 raw_ostream &clang::operator<<(raw_ostream &OS,
2211                                const ObjCImplementationDecl &ID) {
2212   OS << ID.getName();
2213   return OS;
2214 }
2215 
2216 //===----------------------------------------------------------------------===//
2217 // ObjCCompatibleAliasDecl
2218 //===----------------------------------------------------------------------===//
2219 
2220 void ObjCCompatibleAliasDecl::anchor() {}
2221 
2222 ObjCCompatibleAliasDecl *
2223 ObjCCompatibleAliasDecl::Create(ASTContext &C, DeclContext *DC,
2224                                 SourceLocation L,
2225                                 IdentifierInfo *Id,
2226                                 ObjCInterfaceDecl* AliasedClass) {
2227   return new (C, DC) ObjCCompatibleAliasDecl(DC, L, Id, AliasedClass);
2228 }
2229 
2230 ObjCCompatibleAliasDecl *
2231 ObjCCompatibleAliasDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
2232   return new (C, ID) ObjCCompatibleAliasDecl(nullptr, SourceLocation(),
2233                                              nullptr, nullptr);
2234 }
2235 
2236 //===----------------------------------------------------------------------===//
2237 // ObjCPropertyDecl
2238 //===----------------------------------------------------------------------===//
2239 
2240 void ObjCPropertyDecl::anchor() {}
2241 
2242 ObjCPropertyDecl *ObjCPropertyDecl::Create(ASTContext &C, DeclContext *DC,
2243                                            SourceLocation L,
2244                                            IdentifierInfo *Id,
2245                                            SourceLocation AtLoc,
2246                                            SourceLocation LParenLoc,
2247                                            QualType T,
2248                                            TypeSourceInfo *TSI,
2249                                            PropertyControl propControl) {
2250   return new (C, DC) ObjCPropertyDecl(DC, L, Id, AtLoc, LParenLoc, T, TSI,
2251                                       propControl);
2252 }
2253 
2254 ObjCPropertyDecl *ObjCPropertyDecl::CreateDeserialized(ASTContext &C,
2255                                                        unsigned ID) {
2256   return new (C, ID) ObjCPropertyDecl(nullptr, SourceLocation(), nullptr,
2257                                       SourceLocation(), SourceLocation(),
2258                                       QualType(), nullptr, None);
2259 }
2260 
2261 QualType ObjCPropertyDecl::getUsageType(QualType objectType) const {
2262   return DeclType.substObjCMemberType(objectType, getDeclContext(),
2263                                       ObjCSubstitutionContext::Property);
2264 }
2265 
2266 //===----------------------------------------------------------------------===//
2267 // ObjCPropertyImplDecl
2268 //===----------------------------------------------------------------------===//
2269 
2270 ObjCPropertyImplDecl *ObjCPropertyImplDecl::Create(ASTContext &C,
2271                                                    DeclContext *DC,
2272                                                    SourceLocation atLoc,
2273                                                    SourceLocation L,
2274                                                    ObjCPropertyDecl *property,
2275                                                    Kind PK,
2276                                                    ObjCIvarDecl *ivar,
2277                                                    SourceLocation ivarLoc) {
2278   return new (C, DC) ObjCPropertyImplDecl(DC, atLoc, L, property, PK, ivar,
2279                                           ivarLoc);
2280 }
2281 
2282 ObjCPropertyImplDecl *ObjCPropertyImplDecl::CreateDeserialized(ASTContext &C,
2283                                                                unsigned ID) {
2284   return new (C, ID) ObjCPropertyImplDecl(nullptr, SourceLocation(),
2285                                           SourceLocation(), nullptr, Dynamic,
2286                                           nullptr, SourceLocation());
2287 }
2288 
2289 SourceRange ObjCPropertyImplDecl::getSourceRange() const {
2290   SourceLocation EndLoc = getLocation();
2291   if (IvarLoc.isValid())
2292     EndLoc = IvarLoc;
2293 
2294   return SourceRange(AtLoc, EndLoc);
2295 }
2296