1 //===--- SemaDeclObjC.cpp - Semantic Analysis for ObjC Declarations -------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  This file implements semantic analysis for Objective C declarations.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Sema/SemaInternal.h"
15 #include "clang/AST/ASTConsumer.h"
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/ASTMutationListener.h"
18 #include "clang/AST/RecursiveASTVisitor.h"
19 #include "clang/AST/DeclObjC.h"
20 #include "clang/AST/Expr.h"
21 #include "clang/AST/ExprObjC.h"
22 #include "clang/Basic/SourceManager.h"
23 #include "clang/Sema/DeclSpec.h"
24 #include "clang/Sema/ExternalSemaSource.h"
25 #include "clang/Sema/Lookup.h"
26 #include "clang/Sema/Scope.h"
27 #include "clang/Sema/ScopeInfo.h"
28 #include "llvm/ADT/DenseMap.h"
29 #include "llvm/ADT/DenseSet.h"
30 #include "TypeLocBuilder.h"
31 
32 using namespace clang;
33 
34 /// Check whether the given method, which must be in the 'init'
35 /// family, is a valid member of that family.
36 ///
37 /// \param receiverTypeIfCall - if null, check this as if declaring it;
38 ///   if non-null, check this as if making a call to it with the given
39 ///   receiver type
40 ///
41 /// \return true to indicate that there was an error and appropriate
42 ///   actions were taken
43 bool Sema::checkInitMethod(ObjCMethodDecl *method,
44                            QualType receiverTypeIfCall) {
45   if (method->isInvalidDecl()) return true;
46 
47   // This castAs is safe: methods that don't return an object
48   // pointer won't be inferred as inits and will reject an explicit
49   // objc_method_family(init).
50 
51   // We ignore protocols here.  Should we?  What about Class?
52 
53   const ObjCObjectType *result =
54       method->getReturnType()->castAs<ObjCObjectPointerType>()->getObjectType();
55 
56   if (result->isObjCId()) {
57     return false;
58   } else if (result->isObjCClass()) {
59     // fall through: always an error
60   } else {
61     ObjCInterfaceDecl *resultClass = result->getInterface();
62     assert(resultClass && "unexpected object type!");
63 
64     // It's okay for the result type to still be a forward declaration
65     // if we're checking an interface declaration.
66     if (!resultClass->hasDefinition()) {
67       if (receiverTypeIfCall.isNull() &&
68           !isa<ObjCImplementationDecl>(method->getDeclContext()))
69         return false;
70 
71     // Otherwise, we try to compare class types.
72     } else {
73       // If this method was declared in a protocol, we can't check
74       // anything unless we have a receiver type that's an interface.
75       const ObjCInterfaceDecl *receiverClass = nullptr;
76       if (isa<ObjCProtocolDecl>(method->getDeclContext())) {
77         if (receiverTypeIfCall.isNull())
78           return false;
79 
80         receiverClass = receiverTypeIfCall->castAs<ObjCObjectPointerType>()
81           ->getInterfaceDecl();
82 
83         // This can be null for calls to e.g. id<Foo>.
84         if (!receiverClass) return false;
85       } else {
86         receiverClass = method->getClassInterface();
87         assert(receiverClass && "method not associated with a class!");
88       }
89 
90       // If either class is a subclass of the other, it's fine.
91       if (receiverClass->isSuperClassOf(resultClass) ||
92           resultClass->isSuperClassOf(receiverClass))
93         return false;
94     }
95   }
96 
97   SourceLocation loc = method->getLocation();
98 
99   // If we're in a system header, and this is not a call, just make
100   // the method unusable.
101   if (receiverTypeIfCall.isNull() && getSourceManager().isInSystemHeader(loc)) {
102     method->addAttr(UnavailableAttr::CreateImplicit(Context, "",
103                       UnavailableAttr::IR_ARCInitReturnsUnrelated, loc));
104     return true;
105   }
106 
107   // Otherwise, it's an error.
108   Diag(loc, diag::err_arc_init_method_unrelated_result_type);
109   method->setInvalidDecl();
110   return true;
111 }
112 
113 void Sema::CheckObjCMethodOverride(ObjCMethodDecl *NewMethod,
114                                    const ObjCMethodDecl *Overridden) {
115   if (Overridden->hasRelatedResultType() &&
116       !NewMethod->hasRelatedResultType()) {
117     // This can only happen when the method follows a naming convention that
118     // implies a related result type, and the original (overridden) method has
119     // a suitable return type, but the new (overriding) method does not have
120     // a suitable return type.
121     QualType ResultType = NewMethod->getReturnType();
122     SourceRange ResultTypeRange = NewMethod->getReturnTypeSourceRange();
123 
124     // Figure out which class this method is part of, if any.
125     ObjCInterfaceDecl *CurrentClass
126       = dyn_cast<ObjCInterfaceDecl>(NewMethod->getDeclContext());
127     if (!CurrentClass) {
128       DeclContext *DC = NewMethod->getDeclContext();
129       if (ObjCCategoryDecl *Cat = dyn_cast<ObjCCategoryDecl>(DC))
130         CurrentClass = Cat->getClassInterface();
131       else if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(DC))
132         CurrentClass = Impl->getClassInterface();
133       else if (ObjCCategoryImplDecl *CatImpl
134                = dyn_cast<ObjCCategoryImplDecl>(DC))
135         CurrentClass = CatImpl->getClassInterface();
136     }
137 
138     if (CurrentClass) {
139       Diag(NewMethod->getLocation(),
140            diag::warn_related_result_type_compatibility_class)
141         << Context.getObjCInterfaceType(CurrentClass)
142         << ResultType
143         << ResultTypeRange;
144     } else {
145       Diag(NewMethod->getLocation(),
146            diag::warn_related_result_type_compatibility_protocol)
147         << ResultType
148         << ResultTypeRange;
149     }
150 
151     if (ObjCMethodFamily Family = Overridden->getMethodFamily())
152       Diag(Overridden->getLocation(),
153            diag::note_related_result_type_family)
154         << /*overridden method*/ 0
155         << Family;
156     else
157       Diag(Overridden->getLocation(),
158            diag::note_related_result_type_overridden);
159   }
160   if (getLangOpts().ObjCAutoRefCount) {
161     if ((NewMethod->hasAttr<NSReturnsRetainedAttr>() !=
162          Overridden->hasAttr<NSReturnsRetainedAttr>())) {
163         Diag(NewMethod->getLocation(),
164              diag::err_nsreturns_retained_attribute_mismatch) << 1;
165         Diag(Overridden->getLocation(), diag::note_previous_decl)
166         << "method";
167     }
168     if ((NewMethod->hasAttr<NSReturnsNotRetainedAttr>() !=
169               Overridden->hasAttr<NSReturnsNotRetainedAttr>())) {
170         Diag(NewMethod->getLocation(),
171              diag::err_nsreturns_retained_attribute_mismatch) << 0;
172         Diag(Overridden->getLocation(), diag::note_previous_decl)
173         << "method";
174     }
175     ObjCMethodDecl::param_const_iterator oi = Overridden->param_begin(),
176                                          oe = Overridden->param_end();
177     for (ObjCMethodDecl::param_iterator
178            ni = NewMethod->param_begin(), ne = NewMethod->param_end();
179          ni != ne && oi != oe; ++ni, ++oi) {
180       const ParmVarDecl *oldDecl = (*oi);
181       ParmVarDecl *newDecl = (*ni);
182       if (newDecl->hasAttr<NSConsumedAttr>() !=
183           oldDecl->hasAttr<NSConsumedAttr>()) {
184         Diag(newDecl->getLocation(),
185              diag::err_nsconsumed_attribute_mismatch);
186         Diag(oldDecl->getLocation(), diag::note_previous_decl)
187           << "parameter";
188       }
189     }
190   }
191 }
192 
193 /// \brief Check a method declaration for compatibility with the Objective-C
194 /// ARC conventions.
195 bool Sema::CheckARCMethodDecl(ObjCMethodDecl *method) {
196   ObjCMethodFamily family = method->getMethodFamily();
197   switch (family) {
198   case OMF_None:
199   case OMF_finalize:
200   case OMF_retain:
201   case OMF_release:
202   case OMF_autorelease:
203   case OMF_retainCount:
204   case OMF_self:
205   case OMF_initialize:
206   case OMF_performSelector:
207     return false;
208 
209   case OMF_dealloc:
210     if (!Context.hasSameType(method->getReturnType(), Context.VoidTy)) {
211       SourceRange ResultTypeRange = method->getReturnTypeSourceRange();
212       if (ResultTypeRange.isInvalid())
213         Diag(method->getLocation(), diag::error_dealloc_bad_result_type)
214             << method->getReturnType()
215             << FixItHint::CreateInsertion(method->getSelectorLoc(0), "(void)");
216       else
217         Diag(method->getLocation(), diag::error_dealloc_bad_result_type)
218             << method->getReturnType()
219             << FixItHint::CreateReplacement(ResultTypeRange, "void");
220       return true;
221     }
222     return false;
223 
224   case OMF_init:
225     // If the method doesn't obey the init rules, don't bother annotating it.
226     if (checkInitMethod(method, QualType()))
227       return true;
228 
229     method->addAttr(NSConsumesSelfAttr::CreateImplicit(Context));
230 
231     // Don't add a second copy of this attribute, but otherwise don't
232     // let it be suppressed.
233     if (method->hasAttr<NSReturnsRetainedAttr>())
234       return false;
235     break;
236 
237   case OMF_alloc:
238   case OMF_copy:
239   case OMF_mutableCopy:
240   case OMF_new:
241     if (method->hasAttr<NSReturnsRetainedAttr>() ||
242         method->hasAttr<NSReturnsNotRetainedAttr>() ||
243         method->hasAttr<NSReturnsAutoreleasedAttr>())
244       return false;
245     break;
246   }
247 
248   method->addAttr(NSReturnsRetainedAttr::CreateImplicit(Context));
249   return false;
250 }
251 
252 static void DiagnoseObjCImplementedDeprecations(Sema &S,
253                                                 NamedDecl *ND,
254                                                 SourceLocation ImplLoc,
255                                                 int select) {
256   if (ND && ND->isDeprecated()) {
257     S.Diag(ImplLoc, diag::warn_deprecated_def) << select;
258     if (select == 0)
259       S.Diag(ND->getLocation(), diag::note_method_declared_at)
260         << ND->getDeclName();
261     else
262       S.Diag(ND->getLocation(), diag::note_previous_decl) << "class";
263   }
264 }
265 
266 /// AddAnyMethodToGlobalPool - Add any method, instance or factory to global
267 /// pool.
268 void Sema::AddAnyMethodToGlobalPool(Decl *D) {
269   ObjCMethodDecl *MDecl = dyn_cast_or_null<ObjCMethodDecl>(D);
270 
271   // If we don't have a valid method decl, simply return.
272   if (!MDecl)
273     return;
274   if (MDecl->isInstanceMethod())
275     AddInstanceMethodToGlobalPool(MDecl, true);
276   else
277     AddFactoryMethodToGlobalPool(MDecl, true);
278 }
279 
280 /// HasExplicitOwnershipAttr - returns true when pointer to ObjC pointer
281 /// has explicit ownership attribute; false otherwise.
282 static bool
283 HasExplicitOwnershipAttr(Sema &S, ParmVarDecl *Param) {
284   QualType T = Param->getType();
285 
286   if (const PointerType *PT = T->getAs<PointerType>()) {
287     T = PT->getPointeeType();
288   } else if (const ReferenceType *RT = T->getAs<ReferenceType>()) {
289     T = RT->getPointeeType();
290   } else {
291     return true;
292   }
293 
294   // If we have a lifetime qualifier, but it's local, we must have
295   // inferred it. So, it is implicit.
296   return !T.getLocalQualifiers().hasObjCLifetime();
297 }
298 
299 /// ActOnStartOfObjCMethodDef - This routine sets up parameters; invisible
300 /// and user declared, in the method definition's AST.
301 void Sema::ActOnStartOfObjCMethodDef(Scope *FnBodyScope, Decl *D) {
302   assert((getCurMethodDecl() == nullptr) && "Methodparsing confused");
303   ObjCMethodDecl *MDecl = dyn_cast_or_null<ObjCMethodDecl>(D);
304 
305   // If we don't have a valid method decl, simply return.
306   if (!MDecl)
307     return;
308 
309   // Allow all of Sema to see that we are entering a method definition.
310   PushDeclContext(FnBodyScope, MDecl);
311   PushFunctionScope();
312 
313   // Create Decl objects for each parameter, entrring them in the scope for
314   // binding to their use.
315 
316   // Insert the invisible arguments, self and _cmd!
317   MDecl->createImplicitParams(Context, MDecl->getClassInterface());
318 
319   PushOnScopeChains(MDecl->getSelfDecl(), FnBodyScope);
320   PushOnScopeChains(MDecl->getCmdDecl(), FnBodyScope);
321 
322   // The ObjC parser requires parameter names so there's no need to check.
323   CheckParmsForFunctionDef(MDecl->param_begin(), MDecl->param_end(),
324                            /*CheckParameterNames=*/false);
325 
326   // Introduce all of the other parameters into this scope.
327   for (auto *Param : MDecl->params()) {
328     if (!Param->isInvalidDecl() &&
329         getLangOpts().ObjCAutoRefCount &&
330         !HasExplicitOwnershipAttr(*this, Param))
331       Diag(Param->getLocation(), diag::warn_arc_strong_pointer_objc_pointer) <<
332             Param->getType();
333 
334     if (Param->getIdentifier())
335       PushOnScopeChains(Param, FnBodyScope);
336   }
337 
338   // In ARC, disallow definition of retain/release/autorelease/retainCount
339   if (getLangOpts().ObjCAutoRefCount) {
340     switch (MDecl->getMethodFamily()) {
341     case OMF_retain:
342     case OMF_retainCount:
343     case OMF_release:
344     case OMF_autorelease:
345       Diag(MDecl->getLocation(), diag::err_arc_illegal_method_def)
346         << 0 << MDecl->getSelector();
347       break;
348 
349     case OMF_None:
350     case OMF_dealloc:
351     case OMF_finalize:
352     case OMF_alloc:
353     case OMF_init:
354     case OMF_mutableCopy:
355     case OMF_copy:
356     case OMF_new:
357     case OMF_self:
358     case OMF_initialize:
359     case OMF_performSelector:
360       break;
361     }
362   }
363 
364   // Warn on deprecated methods under -Wdeprecated-implementations,
365   // and prepare for warning on missing super calls.
366   if (ObjCInterfaceDecl *IC = MDecl->getClassInterface()) {
367     ObjCMethodDecl *IMD =
368       IC->lookupMethod(MDecl->getSelector(), MDecl->isInstanceMethod());
369 
370     if (IMD) {
371       ObjCImplDecl *ImplDeclOfMethodDef =
372         dyn_cast<ObjCImplDecl>(MDecl->getDeclContext());
373       ObjCContainerDecl *ContDeclOfMethodDecl =
374         dyn_cast<ObjCContainerDecl>(IMD->getDeclContext());
375       ObjCImplDecl *ImplDeclOfMethodDecl = nullptr;
376       if (ObjCInterfaceDecl *OID = dyn_cast<ObjCInterfaceDecl>(ContDeclOfMethodDecl))
377         ImplDeclOfMethodDecl = OID->getImplementation();
378       else if (ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(ContDeclOfMethodDecl)) {
379         if (CD->IsClassExtension()) {
380           if (ObjCInterfaceDecl *OID = CD->getClassInterface())
381             ImplDeclOfMethodDecl = OID->getImplementation();
382         } else
383             ImplDeclOfMethodDecl = CD->getImplementation();
384       }
385       // No need to issue deprecated warning if deprecated mehod in class/category
386       // is being implemented in its own implementation (no overriding is involved).
387       if (!ImplDeclOfMethodDecl || ImplDeclOfMethodDecl != ImplDeclOfMethodDef)
388         DiagnoseObjCImplementedDeprecations(*this,
389                                           dyn_cast<NamedDecl>(IMD),
390                                           MDecl->getLocation(), 0);
391     }
392 
393     if (MDecl->getMethodFamily() == OMF_init) {
394       if (MDecl->isDesignatedInitializerForTheInterface()) {
395         getCurFunction()->ObjCIsDesignatedInit = true;
396         getCurFunction()->ObjCWarnForNoDesignatedInitChain =
397             IC->getSuperClass() != nullptr;
398       } else if (IC->hasDesignatedInitializers()) {
399         getCurFunction()->ObjCIsSecondaryInit = true;
400         getCurFunction()->ObjCWarnForNoInitDelegation = true;
401       }
402     }
403 
404     // If this is "dealloc" or "finalize", set some bit here.
405     // Then in ActOnSuperMessage() (SemaExprObjC), set it back to false.
406     // Finally, in ActOnFinishFunctionBody() (SemaDecl), warn if flag is set.
407     // Only do this if the current class actually has a superclass.
408     if (const ObjCInterfaceDecl *SuperClass = IC->getSuperClass()) {
409       ObjCMethodFamily Family = MDecl->getMethodFamily();
410       if (Family == OMF_dealloc) {
411         if (!(getLangOpts().ObjCAutoRefCount ||
412               getLangOpts().getGC() == LangOptions::GCOnly))
413           getCurFunction()->ObjCShouldCallSuper = true;
414 
415       } else if (Family == OMF_finalize) {
416         if (Context.getLangOpts().getGC() != LangOptions::NonGC)
417           getCurFunction()->ObjCShouldCallSuper = true;
418 
419       } else {
420         const ObjCMethodDecl *SuperMethod =
421           SuperClass->lookupMethod(MDecl->getSelector(),
422                                    MDecl->isInstanceMethod());
423         getCurFunction()->ObjCShouldCallSuper =
424           (SuperMethod && SuperMethod->hasAttr<ObjCRequiresSuperAttr>());
425       }
426     }
427   }
428 }
429 
430 namespace {
431 
432 // Callback to only accept typo corrections that are Objective-C classes.
433 // If an ObjCInterfaceDecl* is given to the constructor, then the validation
434 // function will reject corrections to that class.
435 class ObjCInterfaceValidatorCCC : public CorrectionCandidateCallback {
436  public:
437   ObjCInterfaceValidatorCCC() : CurrentIDecl(nullptr) {}
438   explicit ObjCInterfaceValidatorCCC(ObjCInterfaceDecl *IDecl)
439       : CurrentIDecl(IDecl) {}
440 
441   bool ValidateCandidate(const TypoCorrection &candidate) override {
442     ObjCInterfaceDecl *ID = candidate.getCorrectionDeclAs<ObjCInterfaceDecl>();
443     return ID && !declaresSameEntity(ID, CurrentIDecl);
444   }
445 
446  private:
447   ObjCInterfaceDecl *CurrentIDecl;
448 };
449 
450 } // end anonymous namespace
451 
452 static void diagnoseUseOfProtocols(Sema &TheSema,
453                                    ObjCContainerDecl *CD,
454                                    ObjCProtocolDecl *const *ProtoRefs,
455                                    unsigned NumProtoRefs,
456                                    const SourceLocation *ProtoLocs) {
457   assert(ProtoRefs);
458   // Diagnose availability in the context of the ObjC container.
459   Sema::ContextRAII SavedContext(TheSema, CD);
460   for (unsigned i = 0; i < NumProtoRefs; ++i) {
461     (void)TheSema.DiagnoseUseOfDecl(ProtoRefs[i], ProtoLocs[i]);
462   }
463 }
464 
465 void Sema::
466 ActOnSuperClassOfClassInterface(Scope *S,
467                                 SourceLocation AtInterfaceLoc,
468                                 ObjCInterfaceDecl *IDecl,
469                                 IdentifierInfo *ClassName,
470                                 SourceLocation ClassLoc,
471                                 IdentifierInfo *SuperName,
472                                 SourceLocation SuperLoc,
473                                 ArrayRef<ParsedType> SuperTypeArgs,
474                                 SourceRange SuperTypeArgsRange) {
475   // Check if a different kind of symbol declared in this scope.
476   NamedDecl *PrevDecl = LookupSingleName(TUScope, SuperName, SuperLoc,
477                                          LookupOrdinaryName);
478 
479   if (!PrevDecl) {
480     // Try to correct for a typo in the superclass name without correcting
481     // to the class we're defining.
482     if (TypoCorrection Corrected = CorrectTypo(
483             DeclarationNameInfo(SuperName, SuperLoc),
484             LookupOrdinaryName, TUScope,
485             nullptr, llvm::make_unique<ObjCInterfaceValidatorCCC>(IDecl),
486             CTK_ErrorRecovery)) {
487       diagnoseTypo(Corrected, PDiag(diag::err_undef_superclass_suggest)
488                    << SuperName << ClassName);
489       PrevDecl = Corrected.getCorrectionDeclAs<ObjCInterfaceDecl>();
490     }
491   }
492 
493   if (declaresSameEntity(PrevDecl, IDecl)) {
494     Diag(SuperLoc, diag::err_recursive_superclass)
495       << SuperName << ClassName << SourceRange(AtInterfaceLoc, ClassLoc);
496     IDecl->setEndOfDefinitionLoc(ClassLoc);
497   } else {
498     ObjCInterfaceDecl *SuperClassDecl =
499     dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
500     QualType SuperClassType;
501 
502     // Diagnose classes that inherit from deprecated classes.
503     if (SuperClassDecl) {
504       (void)DiagnoseUseOfDecl(SuperClassDecl, SuperLoc);
505       SuperClassType = Context.getObjCInterfaceType(SuperClassDecl);
506     }
507 
508     if (PrevDecl && !SuperClassDecl) {
509       // The previous declaration was not a class decl. Check if we have a
510       // typedef. If we do, get the underlying class type.
511       if (const TypedefNameDecl *TDecl =
512           dyn_cast_or_null<TypedefNameDecl>(PrevDecl)) {
513         QualType T = TDecl->getUnderlyingType();
514         if (T->isObjCObjectType()) {
515           if (NamedDecl *IDecl = T->getAs<ObjCObjectType>()->getInterface()) {
516             SuperClassDecl = dyn_cast<ObjCInterfaceDecl>(IDecl);
517             SuperClassType = Context.getTypeDeclType(TDecl);
518 
519             // This handles the following case:
520             // @interface NewI @end
521             // typedef NewI DeprI __attribute__((deprecated("blah")))
522             // @interface SI : DeprI /* warn here */ @end
523             (void)DiagnoseUseOfDecl(const_cast<TypedefNameDecl*>(TDecl), SuperLoc);
524           }
525         }
526       }
527 
528       // This handles the following case:
529       //
530       // typedef int SuperClass;
531       // @interface MyClass : SuperClass {} @end
532       //
533       if (!SuperClassDecl) {
534         Diag(SuperLoc, diag::err_redefinition_different_kind) << SuperName;
535         Diag(PrevDecl->getLocation(), diag::note_previous_definition);
536       }
537     }
538 
539     if (!dyn_cast_or_null<TypedefNameDecl>(PrevDecl)) {
540       if (!SuperClassDecl)
541         Diag(SuperLoc, diag::err_undef_superclass)
542           << SuperName << ClassName << SourceRange(AtInterfaceLoc, ClassLoc);
543       else if (RequireCompleteType(SuperLoc,
544                                    SuperClassType,
545                                    diag::err_forward_superclass,
546                                    SuperClassDecl->getDeclName(),
547                                    ClassName,
548                                    SourceRange(AtInterfaceLoc, ClassLoc))) {
549         SuperClassDecl = nullptr;
550         SuperClassType = QualType();
551       }
552     }
553 
554     if (SuperClassType.isNull()) {
555       assert(!SuperClassDecl && "Failed to set SuperClassType?");
556       return;
557     }
558 
559     // Handle type arguments on the superclass.
560     TypeSourceInfo *SuperClassTInfo = nullptr;
561     if (!SuperTypeArgs.empty()) {
562       TypeResult fullSuperClassType = actOnObjCTypeArgsAndProtocolQualifiers(
563                                         S,
564                                         SuperLoc,
565                                         CreateParsedType(SuperClassType,
566                                                          nullptr),
567                                         SuperTypeArgsRange.getBegin(),
568                                         SuperTypeArgs,
569                                         SuperTypeArgsRange.getEnd(),
570                                         SourceLocation(),
571                                         { },
572                                         { },
573                                         SourceLocation());
574       if (!fullSuperClassType.isUsable())
575         return;
576 
577       SuperClassType = GetTypeFromParser(fullSuperClassType.get(),
578                                          &SuperClassTInfo);
579     }
580 
581     if (!SuperClassTInfo) {
582       SuperClassTInfo = Context.getTrivialTypeSourceInfo(SuperClassType,
583                                                          SuperLoc);
584     }
585 
586     IDecl->setSuperClass(SuperClassTInfo);
587     IDecl->setEndOfDefinitionLoc(SuperClassTInfo->getTypeLoc().getLocEnd());
588   }
589 }
590 
591 DeclResult Sema::actOnObjCTypeParam(Scope *S,
592                                     ObjCTypeParamVariance variance,
593                                     SourceLocation varianceLoc,
594                                     unsigned index,
595                                     IdentifierInfo *paramName,
596                                     SourceLocation paramLoc,
597                                     SourceLocation colonLoc,
598                                     ParsedType parsedTypeBound) {
599   // If there was an explicitly-provided type bound, check it.
600   TypeSourceInfo *typeBoundInfo = nullptr;
601   if (parsedTypeBound) {
602     // The type bound can be any Objective-C pointer type.
603     QualType typeBound = GetTypeFromParser(parsedTypeBound, &typeBoundInfo);
604     if (typeBound->isObjCObjectPointerType()) {
605       // okay
606     } else if (typeBound->isObjCObjectType()) {
607       // The user forgot the * on an Objective-C pointer type, e.g.,
608       // "T : NSView".
609       SourceLocation starLoc = getLocForEndOfToken(
610                                  typeBoundInfo->getTypeLoc().getEndLoc());
611       Diag(typeBoundInfo->getTypeLoc().getBeginLoc(),
612            diag::err_objc_type_param_bound_missing_pointer)
613         << typeBound << paramName
614         << FixItHint::CreateInsertion(starLoc, " *");
615 
616       // Create a new type location builder so we can update the type
617       // location information we have.
618       TypeLocBuilder builder;
619       builder.pushFullCopy(typeBoundInfo->getTypeLoc());
620 
621       // Create the Objective-C pointer type.
622       typeBound = Context.getObjCObjectPointerType(typeBound);
623       ObjCObjectPointerTypeLoc newT
624         = builder.push<ObjCObjectPointerTypeLoc>(typeBound);
625       newT.setStarLoc(starLoc);
626 
627       // Form the new type source information.
628       typeBoundInfo = builder.getTypeSourceInfo(Context, typeBound);
629     } else {
630       // Not a valid type bound.
631       Diag(typeBoundInfo->getTypeLoc().getBeginLoc(),
632            diag::err_objc_type_param_bound_nonobject)
633         << typeBound << paramName;
634 
635       // Forget the bound; we'll default to id later.
636       typeBoundInfo = nullptr;
637     }
638 
639     // Type bounds cannot have qualifiers (even indirectly) or explicit
640     // nullability.
641     if (typeBoundInfo) {
642       QualType typeBound = typeBoundInfo->getType();
643       TypeLoc qual = typeBoundInfo->getTypeLoc().findExplicitQualifierLoc();
644       if (qual || typeBound.hasQualifiers()) {
645         bool diagnosed = false;
646         SourceRange rangeToRemove;
647         if (qual) {
648           if (auto attr = qual.getAs<AttributedTypeLoc>()) {
649             rangeToRemove = attr.getLocalSourceRange();
650             if (attr.getTypePtr()->getImmediateNullability()) {
651               Diag(attr.getLocStart(),
652                    diag::err_objc_type_param_bound_explicit_nullability)
653                 << paramName << typeBound
654                 << FixItHint::CreateRemoval(rangeToRemove);
655               diagnosed = true;
656             }
657           }
658         }
659 
660         if (!diagnosed) {
661           Diag(qual ? qual.getLocStart()
662                     : typeBoundInfo->getTypeLoc().getLocStart(),
663               diag::err_objc_type_param_bound_qualified)
664             << paramName << typeBound << typeBound.getQualifiers().getAsString()
665             << FixItHint::CreateRemoval(rangeToRemove);
666         }
667 
668         // If the type bound has qualifiers other than CVR, we need to strip
669         // them or we'll probably assert later when trying to apply new
670         // qualifiers.
671         Qualifiers quals = typeBound.getQualifiers();
672         quals.removeCVRQualifiers();
673         if (!quals.empty()) {
674           typeBoundInfo =
675              Context.getTrivialTypeSourceInfo(typeBound.getUnqualifiedType());
676         }
677       }
678     }
679   }
680 
681   // If there was no explicit type bound (or we removed it due to an error),
682   // use 'id' instead.
683   if (!typeBoundInfo) {
684     colonLoc = SourceLocation();
685     typeBoundInfo = Context.getTrivialTypeSourceInfo(Context.getObjCIdType());
686   }
687 
688   // Create the type parameter.
689   return ObjCTypeParamDecl::Create(Context, CurContext, variance, varianceLoc,
690                                    index, paramLoc, paramName, colonLoc,
691                                    typeBoundInfo);
692 }
693 
694 ObjCTypeParamList *Sema::actOnObjCTypeParamList(Scope *S,
695                                                 SourceLocation lAngleLoc,
696                                                 ArrayRef<Decl *> typeParamsIn,
697                                                 SourceLocation rAngleLoc) {
698   // We know that the array only contains Objective-C type parameters.
699   ArrayRef<ObjCTypeParamDecl *>
700     typeParams(
701       reinterpret_cast<ObjCTypeParamDecl * const *>(typeParamsIn.data()),
702       typeParamsIn.size());
703 
704   // Diagnose redeclarations of type parameters.
705   // We do this now because Objective-C type parameters aren't pushed into
706   // scope until later (after the instance variable block), but we want the
707   // diagnostics to occur right after we parse the type parameter list.
708   llvm::SmallDenseMap<IdentifierInfo *, ObjCTypeParamDecl *> knownParams;
709   for (auto typeParam : typeParams) {
710     auto known = knownParams.find(typeParam->getIdentifier());
711     if (known != knownParams.end()) {
712       Diag(typeParam->getLocation(), diag::err_objc_type_param_redecl)
713         << typeParam->getIdentifier()
714         << SourceRange(known->second->getLocation());
715 
716       typeParam->setInvalidDecl();
717     } else {
718       knownParams.insert(std::make_pair(typeParam->getIdentifier(), typeParam));
719 
720       // Push the type parameter into scope.
721       PushOnScopeChains(typeParam, S, /*AddToContext=*/false);
722     }
723   }
724 
725   // Create the parameter list.
726   return ObjCTypeParamList::create(Context, lAngleLoc, typeParams, rAngleLoc);
727 }
728 
729 void Sema::popObjCTypeParamList(Scope *S, ObjCTypeParamList *typeParamList) {
730   for (auto typeParam : *typeParamList) {
731     if (!typeParam->isInvalidDecl()) {
732       S->RemoveDecl(typeParam);
733       IdResolver.RemoveDecl(typeParam);
734     }
735   }
736 }
737 
738 namespace {
739   /// The context in which an Objective-C type parameter list occurs, for use
740   /// in diagnostics.
741   enum class TypeParamListContext {
742     ForwardDeclaration,
743     Definition,
744     Category,
745     Extension
746   };
747 } // end anonymous namespace
748 
749 /// Check consistency between two Objective-C type parameter lists, e.g.,
750 /// between a category/extension and an \@interface or between an \@class and an
751 /// \@interface.
752 static bool checkTypeParamListConsistency(Sema &S,
753                                           ObjCTypeParamList *prevTypeParams,
754                                           ObjCTypeParamList *newTypeParams,
755                                           TypeParamListContext newContext) {
756   // If the sizes don't match, complain about that.
757   if (prevTypeParams->size() != newTypeParams->size()) {
758     SourceLocation diagLoc;
759     if (newTypeParams->size() > prevTypeParams->size()) {
760       diagLoc = newTypeParams->begin()[prevTypeParams->size()]->getLocation();
761     } else {
762       diagLoc = S.getLocForEndOfToken(newTypeParams->back()->getLocEnd());
763     }
764 
765     S.Diag(diagLoc, diag::err_objc_type_param_arity_mismatch)
766       << static_cast<unsigned>(newContext)
767       << (newTypeParams->size() > prevTypeParams->size())
768       << prevTypeParams->size()
769       << newTypeParams->size();
770 
771     return true;
772   }
773 
774   // Match up the type parameters.
775   for (unsigned i = 0, n = prevTypeParams->size(); i != n; ++i) {
776     ObjCTypeParamDecl *prevTypeParam = prevTypeParams->begin()[i];
777     ObjCTypeParamDecl *newTypeParam = newTypeParams->begin()[i];
778 
779     // Check for consistency of the variance.
780     if (newTypeParam->getVariance() != prevTypeParam->getVariance()) {
781       if (newTypeParam->getVariance() == ObjCTypeParamVariance::Invariant &&
782           newContext != TypeParamListContext::Definition) {
783         // When the new type parameter is invariant and is not part
784         // of the definition, just propagate the variance.
785         newTypeParam->setVariance(prevTypeParam->getVariance());
786       } else if (prevTypeParam->getVariance()
787                    == ObjCTypeParamVariance::Invariant &&
788                  !(isa<ObjCInterfaceDecl>(prevTypeParam->getDeclContext()) &&
789                    cast<ObjCInterfaceDecl>(prevTypeParam->getDeclContext())
790                      ->getDefinition() == prevTypeParam->getDeclContext())) {
791         // When the old parameter is invariant and was not part of the
792         // definition, just ignore the difference because it doesn't
793         // matter.
794       } else {
795         {
796           // Diagnose the conflict and update the second declaration.
797           SourceLocation diagLoc = newTypeParam->getVarianceLoc();
798           if (diagLoc.isInvalid())
799             diagLoc = newTypeParam->getLocStart();
800 
801           auto diag = S.Diag(diagLoc,
802                              diag::err_objc_type_param_variance_conflict)
803                         << static_cast<unsigned>(newTypeParam->getVariance())
804                         << newTypeParam->getDeclName()
805                         << static_cast<unsigned>(prevTypeParam->getVariance())
806                         << prevTypeParam->getDeclName();
807           switch (prevTypeParam->getVariance()) {
808           case ObjCTypeParamVariance::Invariant:
809             diag << FixItHint::CreateRemoval(newTypeParam->getVarianceLoc());
810             break;
811 
812           case ObjCTypeParamVariance::Covariant:
813           case ObjCTypeParamVariance::Contravariant: {
814             StringRef newVarianceStr
815                = prevTypeParam->getVariance() == ObjCTypeParamVariance::Covariant
816                    ? "__covariant"
817                    : "__contravariant";
818             if (newTypeParam->getVariance()
819                   == ObjCTypeParamVariance::Invariant) {
820               diag << FixItHint::CreateInsertion(newTypeParam->getLocStart(),
821                                                  (newVarianceStr + " ").str());
822             } else {
823               diag << FixItHint::CreateReplacement(newTypeParam->getVarianceLoc(),
824                                                newVarianceStr);
825             }
826           }
827           }
828         }
829 
830         S.Diag(prevTypeParam->getLocation(), diag::note_objc_type_param_here)
831           << prevTypeParam->getDeclName();
832 
833         // Override the variance.
834         newTypeParam->setVariance(prevTypeParam->getVariance());
835       }
836     }
837 
838     // If the bound types match, there's nothing to do.
839     if (S.Context.hasSameType(prevTypeParam->getUnderlyingType(),
840                               newTypeParam->getUnderlyingType()))
841       continue;
842 
843     // If the new type parameter's bound was explicit, complain about it being
844     // different from the original.
845     if (newTypeParam->hasExplicitBound()) {
846       SourceRange newBoundRange = newTypeParam->getTypeSourceInfo()
847                                     ->getTypeLoc().getSourceRange();
848       S.Diag(newBoundRange.getBegin(), diag::err_objc_type_param_bound_conflict)
849         << newTypeParam->getUnderlyingType()
850         << newTypeParam->getDeclName()
851         << prevTypeParam->hasExplicitBound()
852         << prevTypeParam->getUnderlyingType()
853         << (newTypeParam->getDeclName() == prevTypeParam->getDeclName())
854         << prevTypeParam->getDeclName()
855         << FixItHint::CreateReplacement(
856              newBoundRange,
857              prevTypeParam->getUnderlyingType().getAsString(
858                S.Context.getPrintingPolicy()));
859 
860       S.Diag(prevTypeParam->getLocation(), diag::note_objc_type_param_here)
861         << prevTypeParam->getDeclName();
862 
863       // Override the new type parameter's bound type with the previous type,
864       // so that it's consistent.
865       newTypeParam->setTypeSourceInfo(
866         S.Context.getTrivialTypeSourceInfo(prevTypeParam->getUnderlyingType()));
867       continue;
868     }
869 
870     // The new type parameter got the implicit bound of 'id'. That's okay for
871     // categories and extensions (overwrite it later), but not for forward
872     // declarations and @interfaces, because those must be standalone.
873     if (newContext == TypeParamListContext::ForwardDeclaration ||
874         newContext == TypeParamListContext::Definition) {
875       // Diagnose this problem for forward declarations and definitions.
876       SourceLocation insertionLoc
877         = S.getLocForEndOfToken(newTypeParam->getLocation());
878       std::string newCode
879         = " : " + prevTypeParam->getUnderlyingType().getAsString(
880                     S.Context.getPrintingPolicy());
881       S.Diag(newTypeParam->getLocation(),
882              diag::err_objc_type_param_bound_missing)
883         << prevTypeParam->getUnderlyingType()
884         << newTypeParam->getDeclName()
885         << (newContext == TypeParamListContext::ForwardDeclaration)
886         << FixItHint::CreateInsertion(insertionLoc, newCode);
887 
888       S.Diag(prevTypeParam->getLocation(), diag::note_objc_type_param_here)
889         << prevTypeParam->getDeclName();
890     }
891 
892     // Update the new type parameter's bound to match the previous one.
893     newTypeParam->setTypeSourceInfo(
894       S.Context.getTrivialTypeSourceInfo(prevTypeParam->getUnderlyingType()));
895   }
896 
897   return false;
898 }
899 
900 Decl *Sema::
901 ActOnStartClassInterface(Scope *S, SourceLocation AtInterfaceLoc,
902                          IdentifierInfo *ClassName, SourceLocation ClassLoc,
903                          ObjCTypeParamList *typeParamList,
904                          IdentifierInfo *SuperName, SourceLocation SuperLoc,
905                          ArrayRef<ParsedType> SuperTypeArgs,
906                          SourceRange SuperTypeArgsRange,
907                          Decl * const *ProtoRefs, unsigned NumProtoRefs,
908                          const SourceLocation *ProtoLocs,
909                          SourceLocation EndProtoLoc, AttributeList *AttrList) {
910   assert(ClassName && "Missing class identifier");
911 
912   // Check for another declaration kind with the same name.
913   NamedDecl *PrevDecl = LookupSingleName(TUScope, ClassName, ClassLoc,
914                                          LookupOrdinaryName, ForRedeclaration);
915 
916   if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
917     Diag(ClassLoc, diag::err_redefinition_different_kind) << ClassName;
918     Diag(PrevDecl->getLocation(), diag::note_previous_definition);
919   }
920 
921   // Create a declaration to describe this @interface.
922   ObjCInterfaceDecl* PrevIDecl = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
923 
924   if (PrevIDecl && PrevIDecl->getIdentifier() != ClassName) {
925     // A previous decl with a different name is because of
926     // @compatibility_alias, for example:
927     // \code
928     //   @class NewImage;
929     //   @compatibility_alias OldImage NewImage;
930     // \endcode
931     // A lookup for 'OldImage' will return the 'NewImage' decl.
932     //
933     // In such a case use the real declaration name, instead of the alias one,
934     // otherwise we will break IdentifierResolver and redecls-chain invariants.
935     // FIXME: If necessary, add a bit to indicate that this ObjCInterfaceDecl
936     // has been aliased.
937     ClassName = PrevIDecl->getIdentifier();
938   }
939 
940   // If there was a forward declaration with type parameters, check
941   // for consistency.
942   if (PrevIDecl) {
943     if (ObjCTypeParamList *prevTypeParamList = PrevIDecl->getTypeParamList()) {
944       if (typeParamList) {
945         // Both have type parameter lists; check for consistency.
946         if (checkTypeParamListConsistency(*this, prevTypeParamList,
947                                           typeParamList,
948                                           TypeParamListContext::Definition)) {
949           typeParamList = nullptr;
950         }
951       } else {
952         Diag(ClassLoc, diag::err_objc_parameterized_forward_class_first)
953           << ClassName;
954         Diag(prevTypeParamList->getLAngleLoc(), diag::note_previous_decl)
955           << ClassName;
956 
957         // Clone the type parameter list.
958         SmallVector<ObjCTypeParamDecl *, 4> clonedTypeParams;
959         for (auto typeParam : *prevTypeParamList) {
960           clonedTypeParams.push_back(
961             ObjCTypeParamDecl::Create(
962               Context,
963               CurContext,
964               typeParam->getVariance(),
965               SourceLocation(),
966               typeParam->getIndex(),
967               SourceLocation(),
968               typeParam->getIdentifier(),
969               SourceLocation(),
970               Context.getTrivialTypeSourceInfo(typeParam->getUnderlyingType())));
971         }
972 
973         typeParamList = ObjCTypeParamList::create(Context,
974                                                   SourceLocation(),
975                                                   clonedTypeParams,
976                                                   SourceLocation());
977       }
978     }
979   }
980 
981   ObjCInterfaceDecl *IDecl
982     = ObjCInterfaceDecl::Create(Context, CurContext, AtInterfaceLoc, ClassName,
983                                 typeParamList, PrevIDecl, ClassLoc);
984   if (PrevIDecl) {
985     // Class already seen. Was it a definition?
986     if (ObjCInterfaceDecl *Def = PrevIDecl->getDefinition()) {
987       Diag(AtInterfaceLoc, diag::err_duplicate_class_def)
988         << PrevIDecl->getDeclName();
989       Diag(Def->getLocation(), diag::note_previous_definition);
990       IDecl->setInvalidDecl();
991     }
992   }
993 
994   if (AttrList)
995     ProcessDeclAttributeList(TUScope, IDecl, AttrList);
996   PushOnScopeChains(IDecl, TUScope);
997 
998   // Start the definition of this class. If we're in a redefinition case, there
999   // may already be a definition, so we'll end up adding to it.
1000   if (!IDecl->hasDefinition())
1001     IDecl->startDefinition();
1002 
1003   if (SuperName) {
1004     // Diagnose availability in the context of the @interface.
1005     ContextRAII SavedContext(*this, IDecl);
1006 
1007     ActOnSuperClassOfClassInterface(S, AtInterfaceLoc, IDecl,
1008                                     ClassName, ClassLoc,
1009                                     SuperName, SuperLoc, SuperTypeArgs,
1010                                     SuperTypeArgsRange);
1011   } else { // we have a root class.
1012     IDecl->setEndOfDefinitionLoc(ClassLoc);
1013   }
1014 
1015   // Check then save referenced protocols.
1016   if (NumProtoRefs) {
1017     diagnoseUseOfProtocols(*this, IDecl, (ObjCProtocolDecl*const*)ProtoRefs,
1018                            NumProtoRefs, ProtoLocs);
1019     IDecl->setProtocolList((ObjCProtocolDecl*const*)ProtoRefs, NumProtoRefs,
1020                            ProtoLocs, Context);
1021     IDecl->setEndOfDefinitionLoc(EndProtoLoc);
1022   }
1023 
1024   CheckObjCDeclScope(IDecl);
1025   return ActOnObjCContainerStartDefinition(IDecl);
1026 }
1027 
1028 /// ActOnTypedefedProtocols - this action finds protocol list as part of the
1029 /// typedef'ed use for a qualified super class and adds them to the list
1030 /// of the protocols.
1031 void Sema::ActOnTypedefedProtocols(SmallVectorImpl<Decl *> &ProtocolRefs,
1032                                    IdentifierInfo *SuperName,
1033                                    SourceLocation SuperLoc) {
1034   if (!SuperName)
1035     return;
1036   NamedDecl* IDecl = LookupSingleName(TUScope, SuperName, SuperLoc,
1037                                       LookupOrdinaryName);
1038   if (!IDecl)
1039     return;
1040 
1041   if (const TypedefNameDecl *TDecl = dyn_cast_or_null<TypedefNameDecl>(IDecl)) {
1042     QualType T = TDecl->getUnderlyingType();
1043     if (T->isObjCObjectType())
1044       if (const ObjCObjectType *OPT = T->getAs<ObjCObjectType>())
1045         ProtocolRefs.append(OPT->qual_begin(), OPT->qual_end());
1046   }
1047 }
1048 
1049 /// ActOnCompatibilityAlias - this action is called after complete parsing of
1050 /// a \@compatibility_alias declaration. It sets up the alias relationships.
1051 Decl *Sema::ActOnCompatibilityAlias(SourceLocation AtLoc,
1052                                     IdentifierInfo *AliasName,
1053                                     SourceLocation AliasLocation,
1054                                     IdentifierInfo *ClassName,
1055                                     SourceLocation ClassLocation) {
1056   // Look for previous declaration of alias name
1057   NamedDecl *ADecl = LookupSingleName(TUScope, AliasName, AliasLocation,
1058                                       LookupOrdinaryName, ForRedeclaration);
1059   if (ADecl) {
1060     Diag(AliasLocation, diag::err_conflicting_aliasing_type) << AliasName;
1061     Diag(ADecl->getLocation(), diag::note_previous_declaration);
1062     return nullptr;
1063   }
1064   // Check for class declaration
1065   NamedDecl *CDeclU = LookupSingleName(TUScope, ClassName, ClassLocation,
1066                                        LookupOrdinaryName, ForRedeclaration);
1067   if (const TypedefNameDecl *TDecl =
1068         dyn_cast_or_null<TypedefNameDecl>(CDeclU)) {
1069     QualType T = TDecl->getUnderlyingType();
1070     if (T->isObjCObjectType()) {
1071       if (NamedDecl *IDecl = T->getAs<ObjCObjectType>()->getInterface()) {
1072         ClassName = IDecl->getIdentifier();
1073         CDeclU = LookupSingleName(TUScope, ClassName, ClassLocation,
1074                                   LookupOrdinaryName, ForRedeclaration);
1075       }
1076     }
1077   }
1078   ObjCInterfaceDecl *CDecl = dyn_cast_or_null<ObjCInterfaceDecl>(CDeclU);
1079   if (!CDecl) {
1080     Diag(ClassLocation, diag::warn_undef_interface) << ClassName;
1081     if (CDeclU)
1082       Diag(CDeclU->getLocation(), diag::note_previous_declaration);
1083     return nullptr;
1084   }
1085 
1086   // Everything checked out, instantiate a new alias declaration AST.
1087   ObjCCompatibleAliasDecl *AliasDecl =
1088     ObjCCompatibleAliasDecl::Create(Context, CurContext, AtLoc, AliasName, CDecl);
1089 
1090   if (!CheckObjCDeclScope(AliasDecl))
1091     PushOnScopeChains(AliasDecl, TUScope);
1092 
1093   return AliasDecl;
1094 }
1095 
1096 bool Sema::CheckForwardProtocolDeclarationForCircularDependency(
1097   IdentifierInfo *PName,
1098   SourceLocation &Ploc, SourceLocation PrevLoc,
1099   const ObjCList<ObjCProtocolDecl> &PList) {
1100 
1101   bool res = false;
1102   for (ObjCList<ObjCProtocolDecl>::iterator I = PList.begin(),
1103        E = PList.end(); I != E; ++I) {
1104     if (ObjCProtocolDecl *PDecl = LookupProtocol((*I)->getIdentifier(),
1105                                                  Ploc)) {
1106       if (PDecl->getIdentifier() == PName) {
1107         Diag(Ploc, diag::err_protocol_has_circular_dependency);
1108         Diag(PrevLoc, diag::note_previous_definition);
1109         res = true;
1110       }
1111 
1112       if (!PDecl->hasDefinition())
1113         continue;
1114 
1115       if (CheckForwardProtocolDeclarationForCircularDependency(PName, Ploc,
1116             PDecl->getLocation(), PDecl->getReferencedProtocols()))
1117         res = true;
1118     }
1119   }
1120   return res;
1121 }
1122 
1123 Decl *
1124 Sema::ActOnStartProtocolInterface(SourceLocation AtProtoInterfaceLoc,
1125                                   IdentifierInfo *ProtocolName,
1126                                   SourceLocation ProtocolLoc,
1127                                   Decl * const *ProtoRefs,
1128                                   unsigned NumProtoRefs,
1129                                   const SourceLocation *ProtoLocs,
1130                                   SourceLocation EndProtoLoc,
1131                                   AttributeList *AttrList) {
1132   bool err = false;
1133   // FIXME: Deal with AttrList.
1134   assert(ProtocolName && "Missing protocol identifier");
1135   ObjCProtocolDecl *PrevDecl = LookupProtocol(ProtocolName, ProtocolLoc,
1136                                               ForRedeclaration);
1137   ObjCProtocolDecl *PDecl = nullptr;
1138   if (ObjCProtocolDecl *Def = PrevDecl? PrevDecl->getDefinition() : nullptr) {
1139     // If we already have a definition, complain.
1140     Diag(ProtocolLoc, diag::warn_duplicate_protocol_def) << ProtocolName;
1141     Diag(Def->getLocation(), diag::note_previous_definition);
1142 
1143     // Create a new protocol that is completely distinct from previous
1144     // declarations, and do not make this protocol available for name lookup.
1145     // That way, we'll end up completely ignoring the duplicate.
1146     // FIXME: Can we turn this into an error?
1147     PDecl = ObjCProtocolDecl::Create(Context, CurContext, ProtocolName,
1148                                      ProtocolLoc, AtProtoInterfaceLoc,
1149                                      /*PrevDecl=*/nullptr);
1150     PDecl->startDefinition();
1151   } else {
1152     if (PrevDecl) {
1153       // Check for circular dependencies among protocol declarations. This can
1154       // only happen if this protocol was forward-declared.
1155       ObjCList<ObjCProtocolDecl> PList;
1156       PList.set((ObjCProtocolDecl *const*)ProtoRefs, NumProtoRefs, Context);
1157       err = CheckForwardProtocolDeclarationForCircularDependency(
1158               ProtocolName, ProtocolLoc, PrevDecl->getLocation(), PList);
1159     }
1160 
1161     // Create the new declaration.
1162     PDecl = ObjCProtocolDecl::Create(Context, CurContext, ProtocolName,
1163                                      ProtocolLoc, AtProtoInterfaceLoc,
1164                                      /*PrevDecl=*/PrevDecl);
1165 
1166     PushOnScopeChains(PDecl, TUScope);
1167     PDecl->startDefinition();
1168   }
1169 
1170   if (AttrList)
1171     ProcessDeclAttributeList(TUScope, PDecl, AttrList);
1172 
1173   // Merge attributes from previous declarations.
1174   if (PrevDecl)
1175     mergeDeclAttributes(PDecl, PrevDecl);
1176 
1177   if (!err && NumProtoRefs ) {
1178     /// Check then save referenced protocols.
1179     diagnoseUseOfProtocols(*this, PDecl, (ObjCProtocolDecl*const*)ProtoRefs,
1180                            NumProtoRefs, ProtoLocs);
1181     PDecl->setProtocolList((ObjCProtocolDecl*const*)ProtoRefs, NumProtoRefs,
1182                            ProtoLocs, Context);
1183   }
1184 
1185   CheckObjCDeclScope(PDecl);
1186   return ActOnObjCContainerStartDefinition(PDecl);
1187 }
1188 
1189 static bool NestedProtocolHasNoDefinition(ObjCProtocolDecl *PDecl,
1190                                           ObjCProtocolDecl *&UndefinedProtocol) {
1191   if (!PDecl->hasDefinition() || PDecl->getDefinition()->isHidden()) {
1192     UndefinedProtocol = PDecl;
1193     return true;
1194   }
1195 
1196   for (auto *PI : PDecl->protocols())
1197     if (NestedProtocolHasNoDefinition(PI, UndefinedProtocol)) {
1198       UndefinedProtocol = PI;
1199       return true;
1200     }
1201   return false;
1202 }
1203 
1204 /// FindProtocolDeclaration - This routine looks up protocols and
1205 /// issues an error if they are not declared. It returns list of
1206 /// protocol declarations in its 'Protocols' argument.
1207 void
1208 Sema::FindProtocolDeclaration(bool WarnOnDeclarations, bool ForObjCContainer,
1209                               ArrayRef<IdentifierLocPair> ProtocolId,
1210                               SmallVectorImpl<Decl *> &Protocols) {
1211   for (const IdentifierLocPair &Pair : ProtocolId) {
1212     ObjCProtocolDecl *PDecl = LookupProtocol(Pair.first, Pair.second);
1213     if (!PDecl) {
1214       TypoCorrection Corrected = CorrectTypo(
1215           DeclarationNameInfo(Pair.first, Pair.second),
1216           LookupObjCProtocolName, TUScope, nullptr,
1217           llvm::make_unique<DeclFilterCCC<ObjCProtocolDecl>>(),
1218           CTK_ErrorRecovery);
1219       if ((PDecl = Corrected.getCorrectionDeclAs<ObjCProtocolDecl>()))
1220         diagnoseTypo(Corrected, PDiag(diag::err_undeclared_protocol_suggest)
1221                                     << Pair.first);
1222     }
1223 
1224     if (!PDecl) {
1225       Diag(Pair.second, diag::err_undeclared_protocol) << Pair.first;
1226       continue;
1227     }
1228     // If this is a forward protocol declaration, get its definition.
1229     if (!PDecl->isThisDeclarationADefinition() && PDecl->getDefinition())
1230       PDecl = PDecl->getDefinition();
1231 
1232     // For an objc container, delay protocol reference checking until after we
1233     // can set the objc decl as the availability context, otherwise check now.
1234     if (!ForObjCContainer) {
1235       (void)DiagnoseUseOfDecl(PDecl, Pair.second);
1236     }
1237 
1238     // If this is a forward declaration and we are supposed to warn in this
1239     // case, do it.
1240     // FIXME: Recover nicely in the hidden case.
1241     ObjCProtocolDecl *UndefinedProtocol;
1242 
1243     if (WarnOnDeclarations &&
1244         NestedProtocolHasNoDefinition(PDecl, UndefinedProtocol)) {
1245       Diag(Pair.second, diag::warn_undef_protocolref) << Pair.first;
1246       Diag(UndefinedProtocol->getLocation(), diag::note_protocol_decl_undefined)
1247         << UndefinedProtocol;
1248     }
1249     Protocols.push_back(PDecl);
1250   }
1251 }
1252 
1253 namespace {
1254 // Callback to only accept typo corrections that are either
1255 // Objective-C protocols or valid Objective-C type arguments.
1256 class ObjCTypeArgOrProtocolValidatorCCC : public CorrectionCandidateCallback {
1257   ASTContext &Context;
1258   Sema::LookupNameKind LookupKind;
1259  public:
1260   ObjCTypeArgOrProtocolValidatorCCC(ASTContext &context,
1261                                     Sema::LookupNameKind lookupKind)
1262     : Context(context), LookupKind(lookupKind) { }
1263 
1264   bool ValidateCandidate(const TypoCorrection &candidate) override {
1265     // If we're allowed to find protocols and we have a protocol, accept it.
1266     if (LookupKind != Sema::LookupOrdinaryName) {
1267       if (candidate.getCorrectionDeclAs<ObjCProtocolDecl>())
1268         return true;
1269     }
1270 
1271     // If we're allowed to find type names and we have one, accept it.
1272     if (LookupKind != Sema::LookupObjCProtocolName) {
1273       // If we have a type declaration, we might accept this result.
1274       if (auto typeDecl = candidate.getCorrectionDeclAs<TypeDecl>()) {
1275         // If we found a tag declaration outside of C++, skip it. This
1276         // can happy because we look for any name when there is no
1277         // bias to protocol or type names.
1278         if (isa<RecordDecl>(typeDecl) && !Context.getLangOpts().CPlusPlus)
1279           return false;
1280 
1281         // Make sure the type is something we would accept as a type
1282         // argument.
1283         auto type = Context.getTypeDeclType(typeDecl);
1284         if (type->isObjCObjectPointerType() ||
1285             type->isBlockPointerType() ||
1286             type->isDependentType() ||
1287             type->isObjCObjectType())
1288           return true;
1289 
1290         return false;
1291       }
1292 
1293       // If we have an Objective-C class type, accept it; there will
1294       // be another fix to add the '*'.
1295       if (candidate.getCorrectionDeclAs<ObjCInterfaceDecl>())
1296         return true;
1297 
1298       return false;
1299     }
1300 
1301     return false;
1302   }
1303 };
1304 } // end anonymous namespace
1305 
1306 void Sema::actOnObjCTypeArgsOrProtocolQualifiers(
1307        Scope *S,
1308        ParsedType baseType,
1309        SourceLocation lAngleLoc,
1310        ArrayRef<IdentifierInfo *> identifiers,
1311        ArrayRef<SourceLocation> identifierLocs,
1312        SourceLocation rAngleLoc,
1313        SourceLocation &typeArgsLAngleLoc,
1314        SmallVectorImpl<ParsedType> &typeArgs,
1315        SourceLocation &typeArgsRAngleLoc,
1316        SourceLocation &protocolLAngleLoc,
1317        SmallVectorImpl<Decl *> &protocols,
1318        SourceLocation &protocolRAngleLoc,
1319        bool warnOnIncompleteProtocols) {
1320   // Local function that updates the declaration specifiers with
1321   // protocol information.
1322   unsigned numProtocolsResolved = 0;
1323   auto resolvedAsProtocols = [&] {
1324     assert(numProtocolsResolved == identifiers.size() && "Unresolved protocols");
1325 
1326     // Determine whether the base type is a parameterized class, in
1327     // which case we want to warn about typos such as
1328     // "NSArray<NSObject>" (that should be NSArray<NSObject *>).
1329     ObjCInterfaceDecl *baseClass = nullptr;
1330     QualType base = GetTypeFromParser(baseType, nullptr);
1331     bool allAreTypeNames = false;
1332     SourceLocation firstClassNameLoc;
1333     if (!base.isNull()) {
1334       if (const auto *objcObjectType = base->getAs<ObjCObjectType>()) {
1335         baseClass = objcObjectType->getInterface();
1336         if (baseClass) {
1337           if (auto typeParams = baseClass->getTypeParamList()) {
1338             if (typeParams->size() == numProtocolsResolved) {
1339               // Note that we should be looking for type names, too.
1340               allAreTypeNames = true;
1341             }
1342           }
1343         }
1344       }
1345     }
1346 
1347     for (unsigned i = 0, n = protocols.size(); i != n; ++i) {
1348       ObjCProtocolDecl *&proto
1349         = reinterpret_cast<ObjCProtocolDecl *&>(protocols[i]);
1350       // For an objc container, delay protocol reference checking until after we
1351       // can set the objc decl as the availability context, otherwise check now.
1352       if (!warnOnIncompleteProtocols) {
1353         (void)DiagnoseUseOfDecl(proto, identifierLocs[i]);
1354       }
1355 
1356       // If this is a forward protocol declaration, get its definition.
1357       if (!proto->isThisDeclarationADefinition() && proto->getDefinition())
1358         proto = proto->getDefinition();
1359 
1360       // If this is a forward declaration and we are supposed to warn in this
1361       // case, do it.
1362       // FIXME: Recover nicely in the hidden case.
1363       ObjCProtocolDecl *forwardDecl = nullptr;
1364       if (warnOnIncompleteProtocols &&
1365           NestedProtocolHasNoDefinition(proto, forwardDecl)) {
1366         Diag(identifierLocs[i], diag::warn_undef_protocolref)
1367           << proto->getDeclName();
1368         Diag(forwardDecl->getLocation(), diag::note_protocol_decl_undefined)
1369           << forwardDecl;
1370       }
1371 
1372       // If everything this far has been a type name (and we care
1373       // about such things), check whether this name refers to a type
1374       // as well.
1375       if (allAreTypeNames) {
1376         if (auto *decl = LookupSingleName(S, identifiers[i], identifierLocs[i],
1377                                           LookupOrdinaryName)) {
1378           if (isa<ObjCInterfaceDecl>(decl)) {
1379             if (firstClassNameLoc.isInvalid())
1380               firstClassNameLoc = identifierLocs[i];
1381           } else if (!isa<TypeDecl>(decl)) {
1382             // Not a type.
1383             allAreTypeNames = false;
1384           }
1385         } else {
1386           allAreTypeNames = false;
1387         }
1388       }
1389     }
1390 
1391     // All of the protocols listed also have type names, and at least
1392     // one is an Objective-C class name. Check whether all of the
1393     // protocol conformances are declared by the base class itself, in
1394     // which case we warn.
1395     if (allAreTypeNames && firstClassNameLoc.isValid()) {
1396       llvm::SmallPtrSet<ObjCProtocolDecl*, 8> knownProtocols;
1397       Context.CollectInheritedProtocols(baseClass, knownProtocols);
1398       bool allProtocolsDeclared = true;
1399       for (auto proto : protocols) {
1400         if (knownProtocols.count(static_cast<ObjCProtocolDecl *>(proto)) == 0) {
1401           allProtocolsDeclared = false;
1402           break;
1403         }
1404       }
1405 
1406       if (allProtocolsDeclared) {
1407         Diag(firstClassNameLoc, diag::warn_objc_redundant_qualified_class_type)
1408           << baseClass->getDeclName() << SourceRange(lAngleLoc, rAngleLoc)
1409           << FixItHint::CreateInsertion(getLocForEndOfToken(firstClassNameLoc),
1410                                         " *");
1411       }
1412     }
1413 
1414     protocolLAngleLoc = lAngleLoc;
1415     protocolRAngleLoc = rAngleLoc;
1416     assert(protocols.size() == identifierLocs.size());
1417   };
1418 
1419   // Attempt to resolve all of the identifiers as protocols.
1420   for (unsigned i = 0, n = identifiers.size(); i != n; ++i) {
1421     ObjCProtocolDecl *proto = LookupProtocol(identifiers[i], identifierLocs[i]);
1422     protocols.push_back(proto);
1423     if (proto)
1424       ++numProtocolsResolved;
1425   }
1426 
1427   // If all of the names were protocols, these were protocol qualifiers.
1428   if (numProtocolsResolved == identifiers.size())
1429     return resolvedAsProtocols();
1430 
1431   // Attempt to resolve all of the identifiers as type names or
1432   // Objective-C class names. The latter is technically ill-formed,
1433   // but is probably something like \c NSArray<NSView *> missing the
1434   // \c*.
1435   typedef llvm::PointerUnion<TypeDecl *, ObjCInterfaceDecl *> TypeOrClassDecl;
1436   SmallVector<TypeOrClassDecl, 4> typeDecls;
1437   unsigned numTypeDeclsResolved = 0;
1438   for (unsigned i = 0, n = identifiers.size(); i != n; ++i) {
1439     NamedDecl *decl = LookupSingleName(S, identifiers[i], identifierLocs[i],
1440                                        LookupOrdinaryName);
1441     if (!decl) {
1442       typeDecls.push_back(TypeOrClassDecl());
1443       continue;
1444     }
1445 
1446     if (auto typeDecl = dyn_cast<TypeDecl>(decl)) {
1447       typeDecls.push_back(typeDecl);
1448       ++numTypeDeclsResolved;
1449       continue;
1450     }
1451 
1452     if (auto objcClass = dyn_cast<ObjCInterfaceDecl>(decl)) {
1453       typeDecls.push_back(objcClass);
1454       ++numTypeDeclsResolved;
1455       continue;
1456     }
1457 
1458     typeDecls.push_back(TypeOrClassDecl());
1459   }
1460 
1461   AttributeFactory attrFactory;
1462 
1463   // Local function that forms a reference to the given type or
1464   // Objective-C class declaration.
1465   auto resolveTypeReference = [&](TypeOrClassDecl typeDecl, SourceLocation loc)
1466                                 -> TypeResult {
1467     // Form declaration specifiers. They simply refer to the type.
1468     DeclSpec DS(attrFactory);
1469     const char* prevSpec; // unused
1470     unsigned diagID; // unused
1471     QualType type;
1472     if (auto *actualTypeDecl = typeDecl.dyn_cast<TypeDecl *>())
1473       type = Context.getTypeDeclType(actualTypeDecl);
1474     else
1475       type = Context.getObjCInterfaceType(typeDecl.get<ObjCInterfaceDecl *>());
1476     TypeSourceInfo *parsedTSInfo = Context.getTrivialTypeSourceInfo(type, loc);
1477     ParsedType parsedType = CreateParsedType(type, parsedTSInfo);
1478     DS.SetTypeSpecType(DeclSpec::TST_typename, loc, prevSpec, diagID,
1479                        parsedType, Context.getPrintingPolicy());
1480     // Use the identifier location for the type source range.
1481     DS.SetRangeStart(loc);
1482     DS.SetRangeEnd(loc);
1483 
1484     // Form the declarator.
1485     Declarator D(DS, Declarator::TypeNameContext);
1486 
1487     // If we have a typedef of an Objective-C class type that is missing a '*',
1488     // add the '*'.
1489     if (type->getAs<ObjCInterfaceType>()) {
1490       SourceLocation starLoc = getLocForEndOfToken(loc);
1491       ParsedAttributes parsedAttrs(attrFactory);
1492       D.AddTypeInfo(DeclaratorChunk::getPointer(/*typeQuals=*/0, starLoc,
1493                                                 SourceLocation(),
1494                                                 SourceLocation(),
1495                                                 SourceLocation(),
1496                                                 SourceLocation()),
1497                                                 parsedAttrs,
1498                                                 starLoc);
1499 
1500       // Diagnose the missing '*'.
1501       Diag(loc, diag::err_objc_type_arg_missing_star)
1502         << type
1503         << FixItHint::CreateInsertion(starLoc, " *");
1504     }
1505 
1506     // Convert this to a type.
1507     return ActOnTypeName(S, D);
1508   };
1509 
1510   // Local function that updates the declaration specifiers with
1511   // type argument information.
1512   auto resolvedAsTypeDecls = [&] {
1513     // We did not resolve these as protocols.
1514     protocols.clear();
1515 
1516     assert(numTypeDeclsResolved == identifiers.size() && "Unresolved type decl");
1517     // Map type declarations to type arguments.
1518     for (unsigned i = 0, n = identifiers.size(); i != n; ++i) {
1519       // Map type reference to a type.
1520       TypeResult type = resolveTypeReference(typeDecls[i], identifierLocs[i]);
1521       if (!type.isUsable()) {
1522         typeArgs.clear();
1523         return;
1524       }
1525 
1526       typeArgs.push_back(type.get());
1527     }
1528 
1529     typeArgsLAngleLoc = lAngleLoc;
1530     typeArgsRAngleLoc = rAngleLoc;
1531   };
1532 
1533   // If all of the identifiers can be resolved as type names or
1534   // Objective-C class names, we have type arguments.
1535   if (numTypeDeclsResolved == identifiers.size())
1536     return resolvedAsTypeDecls();
1537 
1538   // Error recovery: some names weren't found, or we have a mix of
1539   // type and protocol names. Go resolve all of the unresolved names
1540   // and complain if we can't find a consistent answer.
1541   LookupNameKind lookupKind = LookupAnyName;
1542   for (unsigned i = 0, n = identifiers.size(); i != n; ++i) {
1543     // If we already have a protocol or type. Check whether it is the
1544     // right thing.
1545     if (protocols[i] || typeDecls[i]) {
1546       // If we haven't figured out whether we want types or protocols
1547       // yet, try to figure it out from this name.
1548       if (lookupKind == LookupAnyName) {
1549         // If this name refers to both a protocol and a type (e.g., \c
1550         // NSObject), don't conclude anything yet.
1551         if (protocols[i] && typeDecls[i])
1552           continue;
1553 
1554         // Otherwise, let this name decide whether we'll be correcting
1555         // toward types or protocols.
1556         lookupKind = protocols[i] ? LookupObjCProtocolName
1557                                   : LookupOrdinaryName;
1558         continue;
1559       }
1560 
1561       // If we want protocols and we have a protocol, there's nothing
1562       // more to do.
1563       if (lookupKind == LookupObjCProtocolName && protocols[i])
1564         continue;
1565 
1566       // If we want types and we have a type declaration, there's
1567       // nothing more to do.
1568       if (lookupKind == LookupOrdinaryName && typeDecls[i])
1569         continue;
1570 
1571       // We have a conflict: some names refer to protocols and others
1572       // refer to types.
1573       Diag(identifierLocs[i], diag::err_objc_type_args_and_protocols)
1574         << (protocols[i] != nullptr)
1575         << identifiers[i]
1576         << identifiers[0]
1577         << SourceRange(identifierLocs[0]);
1578 
1579       protocols.clear();
1580       typeArgs.clear();
1581       return;
1582     }
1583 
1584     // Perform typo correction on the name.
1585     TypoCorrection corrected = CorrectTypo(
1586         DeclarationNameInfo(identifiers[i], identifierLocs[i]), lookupKind, S,
1587         nullptr,
1588         llvm::make_unique<ObjCTypeArgOrProtocolValidatorCCC>(Context,
1589                                                              lookupKind),
1590         CTK_ErrorRecovery);
1591     if (corrected) {
1592       // Did we find a protocol?
1593       if (auto proto = corrected.getCorrectionDeclAs<ObjCProtocolDecl>()) {
1594         diagnoseTypo(corrected,
1595                      PDiag(diag::err_undeclared_protocol_suggest)
1596                        << identifiers[i]);
1597         lookupKind = LookupObjCProtocolName;
1598         protocols[i] = proto;
1599         ++numProtocolsResolved;
1600         continue;
1601       }
1602 
1603       // Did we find a type?
1604       if (auto typeDecl = corrected.getCorrectionDeclAs<TypeDecl>()) {
1605         diagnoseTypo(corrected,
1606                      PDiag(diag::err_unknown_typename_suggest)
1607                        << identifiers[i]);
1608         lookupKind = LookupOrdinaryName;
1609         typeDecls[i] = typeDecl;
1610         ++numTypeDeclsResolved;
1611         continue;
1612       }
1613 
1614       // Did we find an Objective-C class?
1615       if (auto objcClass = corrected.getCorrectionDeclAs<ObjCInterfaceDecl>()) {
1616         diagnoseTypo(corrected,
1617                      PDiag(diag::err_unknown_type_or_class_name_suggest)
1618                        << identifiers[i] << true);
1619         lookupKind = LookupOrdinaryName;
1620         typeDecls[i] = objcClass;
1621         ++numTypeDeclsResolved;
1622         continue;
1623       }
1624     }
1625 
1626     // We couldn't find anything.
1627     Diag(identifierLocs[i],
1628          (lookupKind == LookupAnyName ? diag::err_objc_type_arg_missing
1629           : lookupKind == LookupObjCProtocolName ? diag::err_undeclared_protocol
1630           : diag::err_unknown_typename))
1631       << identifiers[i];
1632     protocols.clear();
1633     typeArgs.clear();
1634     return;
1635   }
1636 
1637   // If all of the names were (corrected to) protocols, these were
1638   // protocol qualifiers.
1639   if (numProtocolsResolved == identifiers.size())
1640     return resolvedAsProtocols();
1641 
1642   // Otherwise, all of the names were (corrected to) types.
1643   assert(numTypeDeclsResolved == identifiers.size() && "Not all types?");
1644   return resolvedAsTypeDecls();
1645 }
1646 
1647 /// DiagnoseClassExtensionDupMethods - Check for duplicate declaration of
1648 /// a class method in its extension.
1649 ///
1650 void Sema::DiagnoseClassExtensionDupMethods(ObjCCategoryDecl *CAT,
1651                                             ObjCInterfaceDecl *ID) {
1652   if (!ID)
1653     return;  // Possibly due to previous error
1654 
1655   llvm::DenseMap<Selector, const ObjCMethodDecl*> MethodMap;
1656   for (auto *MD : ID->methods())
1657     MethodMap[MD->getSelector()] = MD;
1658 
1659   if (MethodMap.empty())
1660     return;
1661   for (const auto *Method : CAT->methods()) {
1662     const ObjCMethodDecl *&PrevMethod = MethodMap[Method->getSelector()];
1663     if (PrevMethod &&
1664         (PrevMethod->isInstanceMethod() == Method->isInstanceMethod()) &&
1665         !MatchTwoMethodDeclarations(Method, PrevMethod)) {
1666       Diag(Method->getLocation(), diag::err_duplicate_method_decl)
1667             << Method->getDeclName();
1668       Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
1669     }
1670   }
1671 }
1672 
1673 /// ActOnForwardProtocolDeclaration - Handle \@protocol foo;
1674 Sema::DeclGroupPtrTy
1675 Sema::ActOnForwardProtocolDeclaration(SourceLocation AtProtocolLoc,
1676                                       ArrayRef<IdentifierLocPair> IdentList,
1677                                       AttributeList *attrList) {
1678   SmallVector<Decl *, 8> DeclsInGroup;
1679   for (const IdentifierLocPair &IdentPair : IdentList) {
1680     IdentifierInfo *Ident = IdentPair.first;
1681     ObjCProtocolDecl *PrevDecl = LookupProtocol(Ident, IdentPair.second,
1682                                                 ForRedeclaration);
1683     ObjCProtocolDecl *PDecl
1684       = ObjCProtocolDecl::Create(Context, CurContext, Ident,
1685                                  IdentPair.second, AtProtocolLoc,
1686                                  PrevDecl);
1687 
1688     PushOnScopeChains(PDecl, TUScope);
1689     CheckObjCDeclScope(PDecl);
1690 
1691     if (attrList)
1692       ProcessDeclAttributeList(TUScope, PDecl, attrList);
1693 
1694     if (PrevDecl)
1695       mergeDeclAttributes(PDecl, PrevDecl);
1696 
1697     DeclsInGroup.push_back(PDecl);
1698   }
1699 
1700   return BuildDeclaratorGroup(DeclsInGroup, false);
1701 }
1702 
1703 Decl *Sema::
1704 ActOnStartCategoryInterface(SourceLocation AtInterfaceLoc,
1705                             IdentifierInfo *ClassName, SourceLocation ClassLoc,
1706                             ObjCTypeParamList *typeParamList,
1707                             IdentifierInfo *CategoryName,
1708                             SourceLocation CategoryLoc,
1709                             Decl * const *ProtoRefs,
1710                             unsigned NumProtoRefs,
1711                             const SourceLocation *ProtoLocs,
1712                             SourceLocation EndProtoLoc) {
1713   ObjCCategoryDecl *CDecl;
1714   ObjCInterfaceDecl *IDecl = getObjCInterfaceDecl(ClassName, ClassLoc, true);
1715 
1716   /// Check that class of this category is already completely declared.
1717 
1718   if (!IDecl
1719       || RequireCompleteType(ClassLoc, Context.getObjCInterfaceType(IDecl),
1720                              diag::err_category_forward_interface,
1721                              CategoryName == nullptr)) {
1722     // Create an invalid ObjCCategoryDecl to serve as context for
1723     // the enclosing method declarations.  We mark the decl invalid
1724     // to make it clear that this isn't a valid AST.
1725     CDecl = ObjCCategoryDecl::Create(Context, CurContext, AtInterfaceLoc,
1726                                      ClassLoc, CategoryLoc, CategoryName,
1727                                      IDecl, typeParamList);
1728     CDecl->setInvalidDecl();
1729     CurContext->addDecl(CDecl);
1730 
1731     if (!IDecl)
1732       Diag(ClassLoc, diag::err_undef_interface) << ClassName;
1733     return ActOnObjCContainerStartDefinition(CDecl);
1734   }
1735 
1736   if (!CategoryName && IDecl->getImplementation()) {
1737     Diag(ClassLoc, diag::err_class_extension_after_impl) << ClassName;
1738     Diag(IDecl->getImplementation()->getLocation(),
1739           diag::note_implementation_declared);
1740   }
1741 
1742   if (CategoryName) {
1743     /// Check for duplicate interface declaration for this category
1744     if (ObjCCategoryDecl *Previous
1745           = IDecl->FindCategoryDeclaration(CategoryName)) {
1746       // Class extensions can be declared multiple times, categories cannot.
1747       Diag(CategoryLoc, diag::warn_dup_category_def)
1748         << ClassName << CategoryName;
1749       Diag(Previous->getLocation(), diag::note_previous_definition);
1750     }
1751   }
1752 
1753   // If we have a type parameter list, check it.
1754   if (typeParamList) {
1755     if (auto prevTypeParamList = IDecl->getTypeParamList()) {
1756       if (checkTypeParamListConsistency(*this, prevTypeParamList, typeParamList,
1757                                         CategoryName
1758                                           ? TypeParamListContext::Category
1759                                           : TypeParamListContext::Extension))
1760         typeParamList = nullptr;
1761     } else {
1762       Diag(typeParamList->getLAngleLoc(),
1763            diag::err_objc_parameterized_category_nonclass)
1764         << (CategoryName != nullptr)
1765         << ClassName
1766         << typeParamList->getSourceRange();
1767 
1768       typeParamList = nullptr;
1769     }
1770   }
1771 
1772   CDecl = ObjCCategoryDecl::Create(Context, CurContext, AtInterfaceLoc,
1773                                    ClassLoc, CategoryLoc, CategoryName, IDecl,
1774                                    typeParamList);
1775   // FIXME: PushOnScopeChains?
1776   CurContext->addDecl(CDecl);
1777 
1778   if (NumProtoRefs) {
1779     diagnoseUseOfProtocols(*this, CDecl, (ObjCProtocolDecl*const*)ProtoRefs,
1780                            NumProtoRefs, ProtoLocs);
1781     CDecl->setProtocolList((ObjCProtocolDecl*const*)ProtoRefs, NumProtoRefs,
1782                            ProtoLocs, Context);
1783     // Protocols in the class extension belong to the class.
1784     if (CDecl->IsClassExtension())
1785      IDecl->mergeClassExtensionProtocolList((ObjCProtocolDecl*const*)ProtoRefs,
1786                                             NumProtoRefs, Context);
1787   }
1788 
1789   CheckObjCDeclScope(CDecl);
1790   return ActOnObjCContainerStartDefinition(CDecl);
1791 }
1792 
1793 /// ActOnStartCategoryImplementation - Perform semantic checks on the
1794 /// category implementation declaration and build an ObjCCategoryImplDecl
1795 /// object.
1796 Decl *Sema::ActOnStartCategoryImplementation(
1797                       SourceLocation AtCatImplLoc,
1798                       IdentifierInfo *ClassName, SourceLocation ClassLoc,
1799                       IdentifierInfo *CatName, SourceLocation CatLoc) {
1800   ObjCInterfaceDecl *IDecl = getObjCInterfaceDecl(ClassName, ClassLoc, true);
1801   ObjCCategoryDecl *CatIDecl = nullptr;
1802   if (IDecl && IDecl->hasDefinition()) {
1803     CatIDecl = IDecl->FindCategoryDeclaration(CatName);
1804     if (!CatIDecl) {
1805       // Category @implementation with no corresponding @interface.
1806       // Create and install one.
1807       CatIDecl = ObjCCategoryDecl::Create(Context, CurContext, AtCatImplLoc,
1808                                           ClassLoc, CatLoc,
1809                                           CatName, IDecl,
1810                                           /*typeParamList=*/nullptr);
1811       CatIDecl->setImplicit();
1812     }
1813   }
1814 
1815   ObjCCategoryImplDecl *CDecl =
1816     ObjCCategoryImplDecl::Create(Context, CurContext, CatName, IDecl,
1817                                  ClassLoc, AtCatImplLoc, CatLoc);
1818   /// Check that class of this category is already completely declared.
1819   if (!IDecl) {
1820     Diag(ClassLoc, diag::err_undef_interface) << ClassName;
1821     CDecl->setInvalidDecl();
1822   } else if (RequireCompleteType(ClassLoc, Context.getObjCInterfaceType(IDecl),
1823                                  diag::err_undef_interface)) {
1824     CDecl->setInvalidDecl();
1825   }
1826 
1827   // FIXME: PushOnScopeChains?
1828   CurContext->addDecl(CDecl);
1829 
1830   // If the interface is deprecated/unavailable, warn/error about it.
1831   if (IDecl)
1832     DiagnoseUseOfDecl(IDecl, ClassLoc);
1833 
1834   /// Check that CatName, category name, is not used in another implementation.
1835   if (CatIDecl) {
1836     if (CatIDecl->getImplementation()) {
1837       Diag(ClassLoc, diag::err_dup_implementation_category) << ClassName
1838         << CatName;
1839       Diag(CatIDecl->getImplementation()->getLocation(),
1840            diag::note_previous_definition);
1841       CDecl->setInvalidDecl();
1842     } else {
1843       CatIDecl->setImplementation(CDecl);
1844       // Warn on implementating category of deprecated class under
1845       // -Wdeprecated-implementations flag.
1846       DiagnoseObjCImplementedDeprecations(*this,
1847                                           dyn_cast<NamedDecl>(IDecl),
1848                                           CDecl->getLocation(), 2);
1849     }
1850   }
1851 
1852   CheckObjCDeclScope(CDecl);
1853   return ActOnObjCContainerStartDefinition(CDecl);
1854 }
1855 
1856 Decl *Sema::ActOnStartClassImplementation(
1857                       SourceLocation AtClassImplLoc,
1858                       IdentifierInfo *ClassName, SourceLocation ClassLoc,
1859                       IdentifierInfo *SuperClassname,
1860                       SourceLocation SuperClassLoc) {
1861   ObjCInterfaceDecl *IDecl = nullptr;
1862   // Check for another declaration kind with the same name.
1863   NamedDecl *PrevDecl
1864     = LookupSingleName(TUScope, ClassName, ClassLoc, LookupOrdinaryName,
1865                        ForRedeclaration);
1866   if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
1867     Diag(ClassLoc, diag::err_redefinition_different_kind) << ClassName;
1868     Diag(PrevDecl->getLocation(), diag::note_previous_definition);
1869   } else if ((IDecl = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl))) {
1870     RequireCompleteType(ClassLoc, Context.getObjCInterfaceType(IDecl),
1871                         diag::warn_undef_interface);
1872   } else {
1873     // We did not find anything with the name ClassName; try to correct for
1874     // typos in the class name.
1875     TypoCorrection Corrected = CorrectTypo(
1876         DeclarationNameInfo(ClassName, ClassLoc), LookupOrdinaryName, TUScope,
1877         nullptr, llvm::make_unique<ObjCInterfaceValidatorCCC>(), CTK_NonError);
1878     if (Corrected.getCorrectionDeclAs<ObjCInterfaceDecl>()) {
1879       // Suggest the (potentially) correct interface name. Don't provide a
1880       // code-modification hint or use the typo name for recovery, because
1881       // this is just a warning. The program may actually be correct.
1882       diagnoseTypo(Corrected,
1883                    PDiag(diag::warn_undef_interface_suggest) << ClassName,
1884                    /*ErrorRecovery*/false);
1885     } else {
1886       Diag(ClassLoc, diag::warn_undef_interface) << ClassName;
1887     }
1888   }
1889 
1890   // Check that super class name is valid class name
1891   ObjCInterfaceDecl *SDecl = nullptr;
1892   if (SuperClassname) {
1893     // Check if a different kind of symbol declared in this scope.
1894     PrevDecl = LookupSingleName(TUScope, SuperClassname, SuperClassLoc,
1895                                 LookupOrdinaryName);
1896     if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
1897       Diag(SuperClassLoc, diag::err_redefinition_different_kind)
1898         << SuperClassname;
1899       Diag(PrevDecl->getLocation(), diag::note_previous_definition);
1900     } else {
1901       SDecl = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
1902       if (SDecl && !SDecl->hasDefinition())
1903         SDecl = nullptr;
1904       if (!SDecl)
1905         Diag(SuperClassLoc, diag::err_undef_superclass)
1906           << SuperClassname << ClassName;
1907       else if (IDecl && !declaresSameEntity(IDecl->getSuperClass(), SDecl)) {
1908         // This implementation and its interface do not have the same
1909         // super class.
1910         Diag(SuperClassLoc, diag::err_conflicting_super_class)
1911           << SDecl->getDeclName();
1912         Diag(SDecl->getLocation(), diag::note_previous_definition);
1913       }
1914     }
1915   }
1916 
1917   if (!IDecl) {
1918     // Legacy case of @implementation with no corresponding @interface.
1919     // Build, chain & install the interface decl into the identifier.
1920 
1921     // FIXME: Do we support attributes on the @implementation? If so we should
1922     // copy them over.
1923     IDecl = ObjCInterfaceDecl::Create(Context, CurContext, AtClassImplLoc,
1924                                       ClassName, /*typeParamList=*/nullptr,
1925                                       /*PrevDecl=*/nullptr, ClassLoc,
1926                                       true);
1927     IDecl->startDefinition();
1928     if (SDecl) {
1929       IDecl->setSuperClass(Context.getTrivialTypeSourceInfo(
1930                              Context.getObjCInterfaceType(SDecl),
1931                              SuperClassLoc));
1932       IDecl->setEndOfDefinitionLoc(SuperClassLoc);
1933     } else {
1934       IDecl->setEndOfDefinitionLoc(ClassLoc);
1935     }
1936 
1937     PushOnScopeChains(IDecl, TUScope);
1938   } else {
1939     // Mark the interface as being completed, even if it was just as
1940     //   @class ....;
1941     // declaration; the user cannot reopen it.
1942     if (!IDecl->hasDefinition())
1943       IDecl->startDefinition();
1944   }
1945 
1946   ObjCImplementationDecl* IMPDecl =
1947     ObjCImplementationDecl::Create(Context, CurContext, IDecl, SDecl,
1948                                    ClassLoc, AtClassImplLoc, SuperClassLoc);
1949 
1950   if (CheckObjCDeclScope(IMPDecl))
1951     return ActOnObjCContainerStartDefinition(IMPDecl);
1952 
1953   // Check that there is no duplicate implementation of this class.
1954   if (IDecl->getImplementation()) {
1955     // FIXME: Don't leak everything!
1956     Diag(ClassLoc, diag::err_dup_implementation_class) << ClassName;
1957     Diag(IDecl->getImplementation()->getLocation(),
1958          diag::note_previous_definition);
1959     IMPDecl->setInvalidDecl();
1960   } else { // add it to the list.
1961     IDecl->setImplementation(IMPDecl);
1962     PushOnScopeChains(IMPDecl, TUScope);
1963     // Warn on implementating deprecated class under
1964     // -Wdeprecated-implementations flag.
1965     DiagnoseObjCImplementedDeprecations(*this,
1966                                         dyn_cast<NamedDecl>(IDecl),
1967                                         IMPDecl->getLocation(), 1);
1968   }
1969   return ActOnObjCContainerStartDefinition(IMPDecl);
1970 }
1971 
1972 Sema::DeclGroupPtrTy
1973 Sema::ActOnFinishObjCImplementation(Decl *ObjCImpDecl, ArrayRef<Decl *> Decls) {
1974   SmallVector<Decl *, 64> DeclsInGroup;
1975   DeclsInGroup.reserve(Decls.size() + 1);
1976 
1977   for (unsigned i = 0, e = Decls.size(); i != e; ++i) {
1978     Decl *Dcl = Decls[i];
1979     if (!Dcl)
1980       continue;
1981     if (Dcl->getDeclContext()->isFileContext())
1982       Dcl->setTopLevelDeclInObjCContainer();
1983     DeclsInGroup.push_back(Dcl);
1984   }
1985 
1986   DeclsInGroup.push_back(ObjCImpDecl);
1987 
1988   return BuildDeclaratorGroup(DeclsInGroup, false);
1989 }
1990 
1991 void Sema::CheckImplementationIvars(ObjCImplementationDecl *ImpDecl,
1992                                     ObjCIvarDecl **ivars, unsigned numIvars,
1993                                     SourceLocation RBrace) {
1994   assert(ImpDecl && "missing implementation decl");
1995   ObjCInterfaceDecl* IDecl = ImpDecl->getClassInterface();
1996   if (!IDecl)
1997     return;
1998   /// Check case of non-existing \@interface decl.
1999   /// (legacy objective-c \@implementation decl without an \@interface decl).
2000   /// Add implementations's ivar to the synthesize class's ivar list.
2001   if (IDecl->isImplicitInterfaceDecl()) {
2002     IDecl->setEndOfDefinitionLoc(RBrace);
2003     // Add ivar's to class's DeclContext.
2004     for (unsigned i = 0, e = numIvars; i != e; ++i) {
2005       ivars[i]->setLexicalDeclContext(ImpDecl);
2006       IDecl->makeDeclVisibleInContext(ivars[i]);
2007       ImpDecl->addDecl(ivars[i]);
2008     }
2009 
2010     return;
2011   }
2012   // If implementation has empty ivar list, just return.
2013   if (numIvars == 0)
2014     return;
2015 
2016   assert(ivars && "missing @implementation ivars");
2017   if (LangOpts.ObjCRuntime.isNonFragile()) {
2018     if (ImpDecl->getSuperClass())
2019       Diag(ImpDecl->getLocation(), diag::warn_on_superclass_use);
2020     for (unsigned i = 0; i < numIvars; i++) {
2021       ObjCIvarDecl* ImplIvar = ivars[i];
2022       if (const ObjCIvarDecl *ClsIvar =
2023             IDecl->getIvarDecl(ImplIvar->getIdentifier())) {
2024         Diag(ImplIvar->getLocation(), diag::err_duplicate_ivar_declaration);
2025         Diag(ClsIvar->getLocation(), diag::note_previous_definition);
2026         continue;
2027       }
2028       // Check class extensions (unnamed categories) for duplicate ivars.
2029       for (const auto *CDecl : IDecl->visible_extensions()) {
2030         if (const ObjCIvarDecl *ClsExtIvar =
2031             CDecl->getIvarDecl(ImplIvar->getIdentifier())) {
2032           Diag(ImplIvar->getLocation(), diag::err_duplicate_ivar_declaration);
2033           Diag(ClsExtIvar->getLocation(), diag::note_previous_definition);
2034           continue;
2035         }
2036       }
2037       // Instance ivar to Implementation's DeclContext.
2038       ImplIvar->setLexicalDeclContext(ImpDecl);
2039       IDecl->makeDeclVisibleInContext(ImplIvar);
2040       ImpDecl->addDecl(ImplIvar);
2041     }
2042     return;
2043   }
2044   // Check interface's Ivar list against those in the implementation.
2045   // names and types must match.
2046   //
2047   unsigned j = 0;
2048   ObjCInterfaceDecl::ivar_iterator
2049     IVI = IDecl->ivar_begin(), IVE = IDecl->ivar_end();
2050   for (; numIvars > 0 && IVI != IVE; ++IVI) {
2051     ObjCIvarDecl* ImplIvar = ivars[j++];
2052     ObjCIvarDecl* ClsIvar = *IVI;
2053     assert (ImplIvar && "missing implementation ivar");
2054     assert (ClsIvar && "missing class ivar");
2055 
2056     // First, make sure the types match.
2057     if (!Context.hasSameType(ImplIvar->getType(), ClsIvar->getType())) {
2058       Diag(ImplIvar->getLocation(), diag::err_conflicting_ivar_type)
2059         << ImplIvar->getIdentifier()
2060         << ImplIvar->getType() << ClsIvar->getType();
2061       Diag(ClsIvar->getLocation(), diag::note_previous_definition);
2062     } else if (ImplIvar->isBitField() && ClsIvar->isBitField() &&
2063                ImplIvar->getBitWidthValue(Context) !=
2064                ClsIvar->getBitWidthValue(Context)) {
2065       Diag(ImplIvar->getBitWidth()->getLocStart(),
2066            diag::err_conflicting_ivar_bitwidth) << ImplIvar->getIdentifier();
2067       Diag(ClsIvar->getBitWidth()->getLocStart(),
2068            diag::note_previous_definition);
2069     }
2070     // Make sure the names are identical.
2071     if (ImplIvar->getIdentifier() != ClsIvar->getIdentifier()) {
2072       Diag(ImplIvar->getLocation(), diag::err_conflicting_ivar_name)
2073         << ImplIvar->getIdentifier() << ClsIvar->getIdentifier();
2074       Diag(ClsIvar->getLocation(), diag::note_previous_definition);
2075     }
2076     --numIvars;
2077   }
2078 
2079   if (numIvars > 0)
2080     Diag(ivars[j]->getLocation(), diag::err_inconsistent_ivar_count);
2081   else if (IVI != IVE)
2082     Diag(IVI->getLocation(), diag::err_inconsistent_ivar_count);
2083 }
2084 
2085 static void WarnUndefinedMethod(Sema &S, SourceLocation ImpLoc,
2086                                 ObjCMethodDecl *method,
2087                                 bool &IncompleteImpl,
2088                                 unsigned DiagID,
2089                                 NamedDecl *NeededFor = nullptr) {
2090   // No point warning no definition of method which is 'unavailable'.
2091   switch (method->getAvailability()) {
2092   case AR_Available:
2093   case AR_Deprecated:
2094     break;
2095 
2096       // Don't warn about unavailable or not-yet-introduced methods.
2097   case AR_NotYetIntroduced:
2098   case AR_Unavailable:
2099     return;
2100   }
2101 
2102   // FIXME: For now ignore 'IncompleteImpl'.
2103   // Previously we grouped all unimplemented methods under a single
2104   // warning, but some users strongly voiced that they would prefer
2105   // separate warnings.  We will give that approach a try, as that
2106   // matches what we do with protocols.
2107   {
2108     const Sema::SemaDiagnosticBuilder &B = S.Diag(ImpLoc, DiagID);
2109     B << method;
2110     if (NeededFor)
2111       B << NeededFor;
2112   }
2113 
2114   // Issue a note to the original declaration.
2115   SourceLocation MethodLoc = method->getLocStart();
2116   if (MethodLoc.isValid())
2117     S.Diag(MethodLoc, diag::note_method_declared_at) << method;
2118 }
2119 
2120 /// Determines if type B can be substituted for type A.  Returns true if we can
2121 /// guarantee that anything that the user will do to an object of type A can
2122 /// also be done to an object of type B.  This is trivially true if the two
2123 /// types are the same, or if B is a subclass of A.  It becomes more complex
2124 /// in cases where protocols are involved.
2125 ///
2126 /// Object types in Objective-C describe the minimum requirements for an
2127 /// object, rather than providing a complete description of a type.  For
2128 /// example, if A is a subclass of B, then B* may refer to an instance of A.
2129 /// The principle of substitutability means that we may use an instance of A
2130 /// anywhere that we may use an instance of B - it will implement all of the
2131 /// ivars of B and all of the methods of B.
2132 ///
2133 /// This substitutability is important when type checking methods, because
2134 /// the implementation may have stricter type definitions than the interface.
2135 /// The interface specifies minimum requirements, but the implementation may
2136 /// have more accurate ones.  For example, a method may privately accept
2137 /// instances of B, but only publish that it accepts instances of A.  Any
2138 /// object passed to it will be type checked against B, and so will implicitly
2139 /// by a valid A*.  Similarly, a method may return a subclass of the class that
2140 /// it is declared as returning.
2141 ///
2142 /// This is most important when considering subclassing.  A method in a
2143 /// subclass must accept any object as an argument that its superclass's
2144 /// implementation accepts.  It may, however, accept a more general type
2145 /// without breaking substitutability (i.e. you can still use the subclass
2146 /// anywhere that you can use the superclass, but not vice versa).  The
2147 /// converse requirement applies to return types: the return type for a
2148 /// subclass method must be a valid object of the kind that the superclass
2149 /// advertises, but it may be specified more accurately.  This avoids the need
2150 /// for explicit down-casting by callers.
2151 ///
2152 /// Note: This is a stricter requirement than for assignment.
2153 static bool isObjCTypeSubstitutable(ASTContext &Context,
2154                                     const ObjCObjectPointerType *A,
2155                                     const ObjCObjectPointerType *B,
2156                                     bool rejectId) {
2157   // Reject a protocol-unqualified id.
2158   if (rejectId && B->isObjCIdType()) return false;
2159 
2160   // If B is a qualified id, then A must also be a qualified id and it must
2161   // implement all of the protocols in B.  It may not be a qualified class.
2162   // For example, MyClass<A> can be assigned to id<A>, but MyClass<A> is a
2163   // stricter definition so it is not substitutable for id<A>.
2164   if (B->isObjCQualifiedIdType()) {
2165     return A->isObjCQualifiedIdType() &&
2166            Context.ObjCQualifiedIdTypesAreCompatible(QualType(A, 0),
2167                                                      QualType(B,0),
2168                                                      false);
2169   }
2170 
2171   /*
2172   // id is a special type that bypasses type checking completely.  We want a
2173   // warning when it is used in one place but not another.
2174   if (C.isObjCIdType(A) || C.isObjCIdType(B)) return false;
2175 
2176 
2177   // If B is a qualified id, then A must also be a qualified id (which it isn't
2178   // if we've got this far)
2179   if (B->isObjCQualifiedIdType()) return false;
2180   */
2181 
2182   // Now we know that A and B are (potentially-qualified) class types.  The
2183   // normal rules for assignment apply.
2184   return Context.canAssignObjCInterfaces(A, B);
2185 }
2186 
2187 static SourceRange getTypeRange(TypeSourceInfo *TSI) {
2188   return (TSI ? TSI->getTypeLoc().getSourceRange() : SourceRange());
2189 }
2190 
2191 /// Determine whether two set of Objective-C declaration qualifiers conflict.
2192 static bool objcModifiersConflict(Decl::ObjCDeclQualifier x,
2193                                   Decl::ObjCDeclQualifier y) {
2194   return (x & ~Decl::OBJC_TQ_CSNullability) !=
2195          (y & ~Decl::OBJC_TQ_CSNullability);
2196 }
2197 
2198 static bool CheckMethodOverrideReturn(Sema &S,
2199                                       ObjCMethodDecl *MethodImpl,
2200                                       ObjCMethodDecl *MethodDecl,
2201                                       bool IsProtocolMethodDecl,
2202                                       bool IsOverridingMode,
2203                                       bool Warn) {
2204   if (IsProtocolMethodDecl &&
2205       objcModifiersConflict(MethodDecl->getObjCDeclQualifier(),
2206                             MethodImpl->getObjCDeclQualifier())) {
2207     if (Warn) {
2208       S.Diag(MethodImpl->getLocation(),
2209              (IsOverridingMode
2210                   ? diag::warn_conflicting_overriding_ret_type_modifiers
2211                   : diag::warn_conflicting_ret_type_modifiers))
2212           << MethodImpl->getDeclName()
2213           << MethodImpl->getReturnTypeSourceRange();
2214       S.Diag(MethodDecl->getLocation(), diag::note_previous_declaration)
2215           << MethodDecl->getReturnTypeSourceRange();
2216     }
2217     else
2218       return false;
2219   }
2220   if (Warn && IsOverridingMode &&
2221       !isa<ObjCImplementationDecl>(MethodImpl->getDeclContext()) &&
2222       !S.Context.hasSameNullabilityTypeQualifier(MethodImpl->getReturnType(),
2223                                                  MethodDecl->getReturnType(),
2224                                                  false)) {
2225     auto nullabilityMethodImpl =
2226       *MethodImpl->getReturnType()->getNullability(S.Context);
2227     auto nullabilityMethodDecl =
2228       *MethodDecl->getReturnType()->getNullability(S.Context);
2229       S.Diag(MethodImpl->getLocation(),
2230              diag::warn_conflicting_nullability_attr_overriding_ret_types)
2231         << DiagNullabilityKind(
2232              nullabilityMethodImpl,
2233              ((MethodImpl->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability)
2234               != 0))
2235         << DiagNullabilityKind(
2236              nullabilityMethodDecl,
2237              ((MethodDecl->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability)
2238                 != 0));
2239       S.Diag(MethodDecl->getLocation(), diag::note_previous_declaration);
2240   }
2241 
2242   if (S.Context.hasSameUnqualifiedType(MethodImpl->getReturnType(),
2243                                        MethodDecl->getReturnType()))
2244     return true;
2245   if (!Warn)
2246     return false;
2247 
2248   unsigned DiagID =
2249     IsOverridingMode ? diag::warn_conflicting_overriding_ret_types
2250                      : diag::warn_conflicting_ret_types;
2251 
2252   // Mismatches between ObjC pointers go into a different warning
2253   // category, and sometimes they're even completely whitelisted.
2254   if (const ObjCObjectPointerType *ImplPtrTy =
2255           MethodImpl->getReturnType()->getAs<ObjCObjectPointerType>()) {
2256     if (const ObjCObjectPointerType *IfacePtrTy =
2257             MethodDecl->getReturnType()->getAs<ObjCObjectPointerType>()) {
2258       // Allow non-matching return types as long as they don't violate
2259       // the principle of substitutability.  Specifically, we permit
2260       // return types that are subclasses of the declared return type,
2261       // or that are more-qualified versions of the declared type.
2262       if (isObjCTypeSubstitutable(S.Context, IfacePtrTy, ImplPtrTy, false))
2263         return false;
2264 
2265       DiagID =
2266         IsOverridingMode ? diag::warn_non_covariant_overriding_ret_types
2267                          : diag::warn_non_covariant_ret_types;
2268     }
2269   }
2270 
2271   S.Diag(MethodImpl->getLocation(), DiagID)
2272       << MethodImpl->getDeclName() << MethodDecl->getReturnType()
2273       << MethodImpl->getReturnType()
2274       << MethodImpl->getReturnTypeSourceRange();
2275   S.Diag(MethodDecl->getLocation(), IsOverridingMode
2276                                         ? diag::note_previous_declaration
2277                                         : diag::note_previous_definition)
2278       << MethodDecl->getReturnTypeSourceRange();
2279   return false;
2280 }
2281 
2282 static bool CheckMethodOverrideParam(Sema &S,
2283                                      ObjCMethodDecl *MethodImpl,
2284                                      ObjCMethodDecl *MethodDecl,
2285                                      ParmVarDecl *ImplVar,
2286                                      ParmVarDecl *IfaceVar,
2287                                      bool IsProtocolMethodDecl,
2288                                      bool IsOverridingMode,
2289                                      bool Warn) {
2290   if (IsProtocolMethodDecl &&
2291       objcModifiersConflict(ImplVar->getObjCDeclQualifier(),
2292                             IfaceVar->getObjCDeclQualifier())) {
2293     if (Warn) {
2294       if (IsOverridingMode)
2295         S.Diag(ImplVar->getLocation(),
2296                diag::warn_conflicting_overriding_param_modifiers)
2297             << getTypeRange(ImplVar->getTypeSourceInfo())
2298             << MethodImpl->getDeclName();
2299       else S.Diag(ImplVar->getLocation(),
2300              diag::warn_conflicting_param_modifiers)
2301           << getTypeRange(ImplVar->getTypeSourceInfo())
2302           << MethodImpl->getDeclName();
2303       S.Diag(IfaceVar->getLocation(), diag::note_previous_declaration)
2304           << getTypeRange(IfaceVar->getTypeSourceInfo());
2305     }
2306     else
2307       return false;
2308   }
2309 
2310   QualType ImplTy = ImplVar->getType();
2311   QualType IfaceTy = IfaceVar->getType();
2312   if (Warn && IsOverridingMode &&
2313       !isa<ObjCImplementationDecl>(MethodImpl->getDeclContext()) &&
2314       !S.Context.hasSameNullabilityTypeQualifier(ImplTy, IfaceTy, true)) {
2315     S.Diag(ImplVar->getLocation(),
2316            diag::warn_conflicting_nullability_attr_overriding_param_types)
2317       << DiagNullabilityKind(
2318            *ImplTy->getNullability(S.Context),
2319            ((ImplVar->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability)
2320             != 0))
2321       << DiagNullabilityKind(
2322            *IfaceTy->getNullability(S.Context),
2323            ((IfaceVar->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability)
2324             != 0));
2325     S.Diag(IfaceVar->getLocation(), diag::note_previous_declaration);
2326   }
2327   if (S.Context.hasSameUnqualifiedType(ImplTy, IfaceTy))
2328     return true;
2329 
2330   if (!Warn)
2331     return false;
2332   unsigned DiagID =
2333     IsOverridingMode ? diag::warn_conflicting_overriding_param_types
2334                      : diag::warn_conflicting_param_types;
2335 
2336   // Mismatches between ObjC pointers go into a different warning
2337   // category, and sometimes they're even completely whitelisted.
2338   if (const ObjCObjectPointerType *ImplPtrTy =
2339         ImplTy->getAs<ObjCObjectPointerType>()) {
2340     if (const ObjCObjectPointerType *IfacePtrTy =
2341           IfaceTy->getAs<ObjCObjectPointerType>()) {
2342       // Allow non-matching argument types as long as they don't
2343       // violate the principle of substitutability.  Specifically, the
2344       // implementation must accept any objects that the superclass
2345       // accepts, however it may also accept others.
2346       if (isObjCTypeSubstitutable(S.Context, ImplPtrTy, IfacePtrTy, true))
2347         return false;
2348 
2349       DiagID =
2350       IsOverridingMode ? diag::warn_non_contravariant_overriding_param_types
2351                        : diag::warn_non_contravariant_param_types;
2352     }
2353   }
2354 
2355   S.Diag(ImplVar->getLocation(), DiagID)
2356     << getTypeRange(ImplVar->getTypeSourceInfo())
2357     << MethodImpl->getDeclName() << IfaceTy << ImplTy;
2358   S.Diag(IfaceVar->getLocation(),
2359          (IsOverridingMode ? diag::note_previous_declaration
2360                            : diag::note_previous_definition))
2361     << getTypeRange(IfaceVar->getTypeSourceInfo());
2362   return false;
2363 }
2364 
2365 /// In ARC, check whether the conventional meanings of the two methods
2366 /// match.  If they don't, it's a hard error.
2367 static bool checkMethodFamilyMismatch(Sema &S, ObjCMethodDecl *impl,
2368                                       ObjCMethodDecl *decl) {
2369   ObjCMethodFamily implFamily = impl->getMethodFamily();
2370   ObjCMethodFamily declFamily = decl->getMethodFamily();
2371   if (implFamily == declFamily) return false;
2372 
2373   // Since conventions are sorted by selector, the only possibility is
2374   // that the types differ enough to cause one selector or the other
2375   // to fall out of the family.
2376   assert(implFamily == OMF_None || declFamily == OMF_None);
2377 
2378   // No further diagnostics required on invalid declarations.
2379   if (impl->isInvalidDecl() || decl->isInvalidDecl()) return true;
2380 
2381   const ObjCMethodDecl *unmatched = impl;
2382   ObjCMethodFamily family = declFamily;
2383   unsigned errorID = diag::err_arc_lost_method_convention;
2384   unsigned noteID = diag::note_arc_lost_method_convention;
2385   if (declFamily == OMF_None) {
2386     unmatched = decl;
2387     family = implFamily;
2388     errorID = diag::err_arc_gained_method_convention;
2389     noteID = diag::note_arc_gained_method_convention;
2390   }
2391 
2392   // Indexes into a %select clause in the diagnostic.
2393   enum FamilySelector {
2394     F_alloc, F_copy, F_mutableCopy = F_copy, F_init, F_new
2395   };
2396   FamilySelector familySelector = FamilySelector();
2397 
2398   switch (family) {
2399   case OMF_None: llvm_unreachable("logic error, no method convention");
2400   case OMF_retain:
2401   case OMF_release:
2402   case OMF_autorelease:
2403   case OMF_dealloc:
2404   case OMF_finalize:
2405   case OMF_retainCount:
2406   case OMF_self:
2407   case OMF_initialize:
2408   case OMF_performSelector:
2409     // Mismatches for these methods don't change ownership
2410     // conventions, so we don't care.
2411     return false;
2412 
2413   case OMF_init: familySelector = F_init; break;
2414   case OMF_alloc: familySelector = F_alloc; break;
2415   case OMF_copy: familySelector = F_copy; break;
2416   case OMF_mutableCopy: familySelector = F_mutableCopy; break;
2417   case OMF_new: familySelector = F_new; break;
2418   }
2419 
2420   enum ReasonSelector { R_NonObjectReturn, R_UnrelatedReturn };
2421   ReasonSelector reasonSelector;
2422 
2423   // The only reason these methods don't fall within their families is
2424   // due to unusual result types.
2425   if (unmatched->getReturnType()->isObjCObjectPointerType()) {
2426     reasonSelector = R_UnrelatedReturn;
2427   } else {
2428     reasonSelector = R_NonObjectReturn;
2429   }
2430 
2431   S.Diag(impl->getLocation(), errorID) << int(familySelector) << int(reasonSelector);
2432   S.Diag(decl->getLocation(), noteID) << int(familySelector) << int(reasonSelector);
2433 
2434   return true;
2435 }
2436 
2437 void Sema::WarnConflictingTypedMethods(ObjCMethodDecl *ImpMethodDecl,
2438                                        ObjCMethodDecl *MethodDecl,
2439                                        bool IsProtocolMethodDecl) {
2440   if (getLangOpts().ObjCAutoRefCount &&
2441       checkMethodFamilyMismatch(*this, ImpMethodDecl, MethodDecl))
2442     return;
2443 
2444   CheckMethodOverrideReturn(*this, ImpMethodDecl, MethodDecl,
2445                             IsProtocolMethodDecl, false,
2446                             true);
2447 
2448   for (ObjCMethodDecl::param_iterator IM = ImpMethodDecl->param_begin(),
2449        IF = MethodDecl->param_begin(), EM = ImpMethodDecl->param_end(),
2450        EF = MethodDecl->param_end();
2451        IM != EM && IF != EF; ++IM, ++IF) {
2452     CheckMethodOverrideParam(*this, ImpMethodDecl, MethodDecl, *IM, *IF,
2453                              IsProtocolMethodDecl, false, true);
2454   }
2455 
2456   if (ImpMethodDecl->isVariadic() != MethodDecl->isVariadic()) {
2457     Diag(ImpMethodDecl->getLocation(),
2458          diag::warn_conflicting_variadic);
2459     Diag(MethodDecl->getLocation(), diag::note_previous_declaration);
2460   }
2461 }
2462 
2463 void Sema::CheckConflictingOverridingMethod(ObjCMethodDecl *Method,
2464                                        ObjCMethodDecl *Overridden,
2465                                        bool IsProtocolMethodDecl) {
2466 
2467   CheckMethodOverrideReturn(*this, Method, Overridden,
2468                             IsProtocolMethodDecl, true,
2469                             true);
2470 
2471   for (ObjCMethodDecl::param_iterator IM = Method->param_begin(),
2472        IF = Overridden->param_begin(), EM = Method->param_end(),
2473        EF = Overridden->param_end();
2474        IM != EM && IF != EF; ++IM, ++IF) {
2475     CheckMethodOverrideParam(*this, Method, Overridden, *IM, *IF,
2476                              IsProtocolMethodDecl, true, true);
2477   }
2478 
2479   if (Method->isVariadic() != Overridden->isVariadic()) {
2480     Diag(Method->getLocation(),
2481          diag::warn_conflicting_overriding_variadic);
2482     Diag(Overridden->getLocation(), diag::note_previous_declaration);
2483   }
2484 }
2485 
2486 /// WarnExactTypedMethods - This routine issues a warning if method
2487 /// implementation declaration matches exactly that of its declaration.
2488 void Sema::WarnExactTypedMethods(ObjCMethodDecl *ImpMethodDecl,
2489                                  ObjCMethodDecl *MethodDecl,
2490                                  bool IsProtocolMethodDecl) {
2491   // don't issue warning when protocol method is optional because primary
2492   // class is not required to implement it and it is safe for protocol
2493   // to implement it.
2494   if (MethodDecl->getImplementationControl() == ObjCMethodDecl::Optional)
2495     return;
2496   // don't issue warning when primary class's method is
2497   // depecated/unavailable.
2498   if (MethodDecl->hasAttr<UnavailableAttr>() ||
2499       MethodDecl->hasAttr<DeprecatedAttr>())
2500     return;
2501 
2502   bool match = CheckMethodOverrideReturn(*this, ImpMethodDecl, MethodDecl,
2503                                       IsProtocolMethodDecl, false, false);
2504   if (match)
2505     for (ObjCMethodDecl::param_iterator IM = ImpMethodDecl->param_begin(),
2506          IF = MethodDecl->param_begin(), EM = ImpMethodDecl->param_end(),
2507          EF = MethodDecl->param_end();
2508          IM != EM && IF != EF; ++IM, ++IF) {
2509       match = CheckMethodOverrideParam(*this, ImpMethodDecl, MethodDecl,
2510                                        *IM, *IF,
2511                                        IsProtocolMethodDecl, false, false);
2512       if (!match)
2513         break;
2514     }
2515   if (match)
2516     match = (ImpMethodDecl->isVariadic() == MethodDecl->isVariadic());
2517   if (match)
2518     match = !(MethodDecl->isClassMethod() &&
2519               MethodDecl->getSelector() == GetNullarySelector("load", Context));
2520 
2521   if (match) {
2522     Diag(ImpMethodDecl->getLocation(),
2523          diag::warn_category_method_impl_match);
2524     Diag(MethodDecl->getLocation(), diag::note_method_declared_at)
2525       << MethodDecl->getDeclName();
2526   }
2527 }
2528 
2529 /// FIXME: Type hierarchies in Objective-C can be deep. We could most likely
2530 /// improve the efficiency of selector lookups and type checking by associating
2531 /// with each protocol / interface / category the flattened instance tables. If
2532 /// we used an immutable set to keep the table then it wouldn't add significant
2533 /// memory cost and it would be handy for lookups.
2534 
2535 typedef llvm::DenseSet<IdentifierInfo*> ProtocolNameSet;
2536 typedef std::unique_ptr<ProtocolNameSet> LazyProtocolNameSet;
2537 
2538 static void findProtocolsWithExplicitImpls(const ObjCProtocolDecl *PDecl,
2539                                            ProtocolNameSet &PNS) {
2540   if (PDecl->hasAttr<ObjCExplicitProtocolImplAttr>())
2541     PNS.insert(PDecl->getIdentifier());
2542   for (const auto *PI : PDecl->protocols())
2543     findProtocolsWithExplicitImpls(PI, PNS);
2544 }
2545 
2546 /// Recursively populates a set with all conformed protocols in a class
2547 /// hierarchy that have the 'objc_protocol_requires_explicit_implementation'
2548 /// attribute.
2549 static void findProtocolsWithExplicitImpls(const ObjCInterfaceDecl *Super,
2550                                            ProtocolNameSet &PNS) {
2551   if (!Super)
2552     return;
2553 
2554   for (const auto *I : Super->all_referenced_protocols())
2555     findProtocolsWithExplicitImpls(I, PNS);
2556 
2557   findProtocolsWithExplicitImpls(Super->getSuperClass(), PNS);
2558 }
2559 
2560 /// CheckProtocolMethodDefs - This routine checks unimplemented methods
2561 /// Declared in protocol, and those referenced by it.
2562 static void CheckProtocolMethodDefs(Sema &S,
2563                                     SourceLocation ImpLoc,
2564                                     ObjCProtocolDecl *PDecl,
2565                                     bool& IncompleteImpl,
2566                                     const Sema::SelectorSet &InsMap,
2567                                     const Sema::SelectorSet &ClsMap,
2568                                     ObjCContainerDecl *CDecl,
2569                                     LazyProtocolNameSet &ProtocolsExplictImpl) {
2570   ObjCCategoryDecl *C = dyn_cast<ObjCCategoryDecl>(CDecl);
2571   ObjCInterfaceDecl *IDecl = C ? C->getClassInterface()
2572                                : dyn_cast<ObjCInterfaceDecl>(CDecl);
2573   assert (IDecl && "CheckProtocolMethodDefs - IDecl is null");
2574 
2575   ObjCInterfaceDecl *Super = IDecl->getSuperClass();
2576   ObjCInterfaceDecl *NSIDecl = nullptr;
2577 
2578   // If this protocol is marked 'objc_protocol_requires_explicit_implementation'
2579   // then we should check if any class in the super class hierarchy also
2580   // conforms to this protocol, either directly or via protocol inheritance.
2581   // If so, we can skip checking this protocol completely because we
2582   // know that a parent class already satisfies this protocol.
2583   //
2584   // Note: we could generalize this logic for all protocols, and merely
2585   // add the limit on looking at the super class chain for just
2586   // specially marked protocols.  This may be a good optimization.  This
2587   // change is restricted to 'objc_protocol_requires_explicit_implementation'
2588   // protocols for now for controlled evaluation.
2589   if (PDecl->hasAttr<ObjCExplicitProtocolImplAttr>()) {
2590     if (!ProtocolsExplictImpl) {
2591       ProtocolsExplictImpl.reset(new ProtocolNameSet);
2592       findProtocolsWithExplicitImpls(Super, *ProtocolsExplictImpl);
2593     }
2594     if (ProtocolsExplictImpl->find(PDecl->getIdentifier()) !=
2595         ProtocolsExplictImpl->end())
2596       return;
2597 
2598     // If no super class conforms to the protocol, we should not search
2599     // for methods in the super class to implicitly satisfy the protocol.
2600     Super = nullptr;
2601   }
2602 
2603   if (S.getLangOpts().ObjCRuntime.isNeXTFamily()) {
2604     // check to see if class implements forwardInvocation method and objects
2605     // of this class are derived from 'NSProxy' so that to forward requests
2606     // from one object to another.
2607     // Under such conditions, which means that every method possible is
2608     // implemented in the class, we should not issue "Method definition not
2609     // found" warnings.
2610     // FIXME: Use a general GetUnarySelector method for this.
2611     IdentifierInfo* II = &S.Context.Idents.get("forwardInvocation");
2612     Selector fISelector = S.Context.Selectors.getSelector(1, &II);
2613     if (InsMap.count(fISelector))
2614       // Is IDecl derived from 'NSProxy'? If so, no instance methods
2615       // need be implemented in the implementation.
2616       NSIDecl = IDecl->lookupInheritedClass(&S.Context.Idents.get("NSProxy"));
2617   }
2618 
2619   // If this is a forward protocol declaration, get its definition.
2620   if (!PDecl->isThisDeclarationADefinition() &&
2621       PDecl->getDefinition())
2622     PDecl = PDecl->getDefinition();
2623 
2624   // If a method lookup fails locally we still need to look and see if
2625   // the method was implemented by a base class or an inherited
2626   // protocol. This lookup is slow, but occurs rarely in correct code
2627   // and otherwise would terminate in a warning.
2628 
2629   // check unimplemented instance methods.
2630   if (!NSIDecl)
2631     for (auto *method : PDecl->instance_methods()) {
2632       if (method->getImplementationControl() != ObjCMethodDecl::Optional &&
2633           !method->isPropertyAccessor() &&
2634           !InsMap.count(method->getSelector()) &&
2635           (!Super || !Super->lookupMethod(method->getSelector(),
2636                                           true /* instance */,
2637                                           false /* shallowCategory */,
2638                                           true /* followsSuper */,
2639                                           nullptr /* category */))) {
2640             // If a method is not implemented in the category implementation but
2641             // has been declared in its primary class, superclass,
2642             // or in one of their protocols, no need to issue the warning.
2643             // This is because method will be implemented in the primary class
2644             // or one of its super class implementation.
2645 
2646             // Ugly, but necessary. Method declared in protcol might have
2647             // have been synthesized due to a property declared in the class which
2648             // uses the protocol.
2649             if (ObjCMethodDecl *MethodInClass =
2650                   IDecl->lookupMethod(method->getSelector(),
2651                                       true /* instance */,
2652                                       true /* shallowCategoryLookup */,
2653                                       false /* followSuper */))
2654               if (C || MethodInClass->isPropertyAccessor())
2655                 continue;
2656             unsigned DIAG = diag::warn_unimplemented_protocol_method;
2657             if (!S.Diags.isIgnored(DIAG, ImpLoc)) {
2658               WarnUndefinedMethod(S, ImpLoc, method, IncompleteImpl, DIAG,
2659                                   PDecl);
2660             }
2661           }
2662     }
2663   // check unimplemented class methods
2664   for (auto *method : PDecl->class_methods()) {
2665     if (method->getImplementationControl() != ObjCMethodDecl::Optional &&
2666         !ClsMap.count(method->getSelector()) &&
2667         (!Super || !Super->lookupMethod(method->getSelector(),
2668                                         false /* class method */,
2669                                         false /* shallowCategoryLookup */,
2670                                         true  /* followSuper */,
2671                                         nullptr /* category */))) {
2672       // See above comment for instance method lookups.
2673       if (C && IDecl->lookupMethod(method->getSelector(),
2674                                    false /* class */,
2675                                    true /* shallowCategoryLookup */,
2676                                    false /* followSuper */))
2677         continue;
2678 
2679       unsigned DIAG = diag::warn_unimplemented_protocol_method;
2680       if (!S.Diags.isIgnored(DIAG, ImpLoc)) {
2681         WarnUndefinedMethod(S, ImpLoc, method, IncompleteImpl, DIAG, PDecl);
2682       }
2683     }
2684   }
2685   // Check on this protocols's referenced protocols, recursively.
2686   for (auto *PI : PDecl->protocols())
2687     CheckProtocolMethodDefs(S, ImpLoc, PI, IncompleteImpl, InsMap, ClsMap,
2688                             CDecl, ProtocolsExplictImpl);
2689 }
2690 
2691 /// MatchAllMethodDeclarations - Check methods declared in interface
2692 /// or protocol against those declared in their implementations.
2693 ///
2694 void Sema::MatchAllMethodDeclarations(const SelectorSet &InsMap,
2695                                       const SelectorSet &ClsMap,
2696                                       SelectorSet &InsMapSeen,
2697                                       SelectorSet &ClsMapSeen,
2698                                       ObjCImplDecl* IMPDecl,
2699                                       ObjCContainerDecl* CDecl,
2700                                       bool &IncompleteImpl,
2701                                       bool ImmediateClass,
2702                                       bool WarnCategoryMethodImpl) {
2703   // Check and see if instance methods in class interface have been
2704   // implemented in the implementation class. If so, their types match.
2705   for (auto *I : CDecl->instance_methods()) {
2706     if (!InsMapSeen.insert(I->getSelector()).second)
2707       continue;
2708     if (!I->isPropertyAccessor() &&
2709         !InsMap.count(I->getSelector())) {
2710       if (ImmediateClass)
2711         WarnUndefinedMethod(*this, IMPDecl->getLocation(), I, IncompleteImpl,
2712                             diag::warn_undef_method_impl);
2713       continue;
2714     } else {
2715       ObjCMethodDecl *ImpMethodDecl =
2716         IMPDecl->getInstanceMethod(I->getSelector());
2717       assert(CDecl->getInstanceMethod(I->getSelector()) &&
2718              "Expected to find the method through lookup as well");
2719       // ImpMethodDecl may be null as in a @dynamic property.
2720       if (ImpMethodDecl) {
2721         if (!WarnCategoryMethodImpl)
2722           WarnConflictingTypedMethods(ImpMethodDecl, I,
2723                                       isa<ObjCProtocolDecl>(CDecl));
2724         else if (!I->isPropertyAccessor())
2725           WarnExactTypedMethods(ImpMethodDecl, I, isa<ObjCProtocolDecl>(CDecl));
2726       }
2727     }
2728   }
2729 
2730   // Check and see if class methods in class interface have been
2731   // implemented in the implementation class. If so, their types match.
2732   for (auto *I : CDecl->class_methods()) {
2733     if (!ClsMapSeen.insert(I->getSelector()).second)
2734       continue;
2735     if (!ClsMap.count(I->getSelector())) {
2736       if (ImmediateClass)
2737         WarnUndefinedMethod(*this, IMPDecl->getLocation(), I, IncompleteImpl,
2738                             diag::warn_undef_method_impl);
2739     } else {
2740       ObjCMethodDecl *ImpMethodDecl =
2741         IMPDecl->getClassMethod(I->getSelector());
2742       assert(CDecl->getClassMethod(I->getSelector()) &&
2743              "Expected to find the method through lookup as well");
2744       if (!WarnCategoryMethodImpl)
2745         WarnConflictingTypedMethods(ImpMethodDecl, I,
2746                                     isa<ObjCProtocolDecl>(CDecl));
2747       else
2748         WarnExactTypedMethods(ImpMethodDecl, I,
2749                               isa<ObjCProtocolDecl>(CDecl));
2750     }
2751   }
2752 
2753   if (ObjCProtocolDecl *PD = dyn_cast<ObjCProtocolDecl> (CDecl)) {
2754     // Also, check for methods declared in protocols inherited by
2755     // this protocol.
2756     for (auto *PI : PD->protocols())
2757       MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
2758                                  IMPDecl, PI, IncompleteImpl, false,
2759                                  WarnCategoryMethodImpl);
2760   }
2761 
2762   if (ObjCInterfaceDecl *I = dyn_cast<ObjCInterfaceDecl> (CDecl)) {
2763     // when checking that methods in implementation match their declaration,
2764     // i.e. when WarnCategoryMethodImpl is false, check declarations in class
2765     // extension; as well as those in categories.
2766     if (!WarnCategoryMethodImpl) {
2767       for (auto *Cat : I->visible_categories())
2768         MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
2769                                    IMPDecl, Cat, IncompleteImpl,
2770                                    ImmediateClass && Cat->IsClassExtension(),
2771                                    WarnCategoryMethodImpl);
2772     } else {
2773       // Also methods in class extensions need be looked at next.
2774       for (auto *Ext : I->visible_extensions())
2775         MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
2776                                    IMPDecl, Ext, IncompleteImpl, false,
2777                                    WarnCategoryMethodImpl);
2778     }
2779 
2780     // Check for any implementation of a methods declared in protocol.
2781     for (auto *PI : I->all_referenced_protocols())
2782       MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
2783                                  IMPDecl, PI, IncompleteImpl, false,
2784                                  WarnCategoryMethodImpl);
2785 
2786     // FIXME. For now, we are not checking for extact match of methods
2787     // in category implementation and its primary class's super class.
2788     if (!WarnCategoryMethodImpl && I->getSuperClass())
2789       MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
2790                                  IMPDecl,
2791                                  I->getSuperClass(), IncompleteImpl, false);
2792   }
2793 }
2794 
2795 /// CheckCategoryVsClassMethodMatches - Checks that methods implemented in
2796 /// category matches with those implemented in its primary class and
2797 /// warns each time an exact match is found.
2798 void Sema::CheckCategoryVsClassMethodMatches(
2799                                   ObjCCategoryImplDecl *CatIMPDecl) {
2800   // Get category's primary class.
2801   ObjCCategoryDecl *CatDecl = CatIMPDecl->getCategoryDecl();
2802   if (!CatDecl)
2803     return;
2804   ObjCInterfaceDecl *IDecl = CatDecl->getClassInterface();
2805   if (!IDecl)
2806     return;
2807   ObjCInterfaceDecl *SuperIDecl = IDecl->getSuperClass();
2808   SelectorSet InsMap, ClsMap;
2809 
2810   for (const auto *I : CatIMPDecl->instance_methods()) {
2811     Selector Sel = I->getSelector();
2812     // When checking for methods implemented in the category, skip over
2813     // those declared in category class's super class. This is because
2814     // the super class must implement the method.
2815     if (SuperIDecl && SuperIDecl->lookupMethod(Sel, true))
2816       continue;
2817     InsMap.insert(Sel);
2818   }
2819 
2820   for (const auto *I : CatIMPDecl->class_methods()) {
2821     Selector Sel = I->getSelector();
2822     if (SuperIDecl && SuperIDecl->lookupMethod(Sel, false))
2823       continue;
2824     ClsMap.insert(Sel);
2825   }
2826   if (InsMap.empty() && ClsMap.empty())
2827     return;
2828 
2829   SelectorSet InsMapSeen, ClsMapSeen;
2830   bool IncompleteImpl = false;
2831   MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
2832                              CatIMPDecl, IDecl,
2833                              IncompleteImpl, false,
2834                              true /*WarnCategoryMethodImpl*/);
2835 }
2836 
2837 void Sema::ImplMethodsVsClassMethods(Scope *S, ObjCImplDecl* IMPDecl,
2838                                      ObjCContainerDecl* CDecl,
2839                                      bool IncompleteImpl) {
2840   SelectorSet InsMap;
2841   // Check and see if instance methods in class interface have been
2842   // implemented in the implementation class.
2843   for (const auto *I : IMPDecl->instance_methods())
2844     InsMap.insert(I->getSelector());
2845 
2846   // Add the selectors for getters/setters of @dynamic properties.
2847   for (const auto *PImpl : IMPDecl->property_impls()) {
2848     // We only care about @dynamic implementations.
2849     if (PImpl->getPropertyImplementation() != ObjCPropertyImplDecl::Dynamic)
2850       continue;
2851 
2852     const auto *P = PImpl->getPropertyDecl();
2853     if (!P) continue;
2854 
2855     InsMap.insert(P->getGetterName());
2856     if (!P->getSetterName().isNull())
2857       InsMap.insert(P->getSetterName());
2858   }
2859 
2860   // Check and see if properties declared in the interface have either 1)
2861   // an implementation or 2) there is a @synthesize/@dynamic implementation
2862   // of the property in the @implementation.
2863   if (const ObjCInterfaceDecl *IDecl = dyn_cast<ObjCInterfaceDecl>(CDecl)) {
2864     bool SynthesizeProperties = LangOpts.ObjCDefaultSynthProperties &&
2865                                 LangOpts.ObjCRuntime.isNonFragile() &&
2866                                 !IDecl->isObjCRequiresPropertyDefs();
2867     DiagnoseUnimplementedProperties(S, IMPDecl, CDecl, SynthesizeProperties);
2868   }
2869 
2870   // Diagnose null-resettable synthesized setters.
2871   diagnoseNullResettableSynthesizedSetters(IMPDecl);
2872 
2873   SelectorSet ClsMap;
2874   for (const auto *I : IMPDecl->class_methods())
2875     ClsMap.insert(I->getSelector());
2876 
2877   // Check for type conflict of methods declared in a class/protocol and
2878   // its implementation; if any.
2879   SelectorSet InsMapSeen, ClsMapSeen;
2880   MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
2881                              IMPDecl, CDecl,
2882                              IncompleteImpl, true);
2883 
2884   // check all methods implemented in category against those declared
2885   // in its primary class.
2886   if (ObjCCategoryImplDecl *CatDecl =
2887         dyn_cast<ObjCCategoryImplDecl>(IMPDecl))
2888     CheckCategoryVsClassMethodMatches(CatDecl);
2889 
2890   // Check the protocol list for unimplemented methods in the @implementation
2891   // class.
2892   // Check and see if class methods in class interface have been
2893   // implemented in the implementation class.
2894 
2895   LazyProtocolNameSet ExplicitImplProtocols;
2896 
2897   if (ObjCInterfaceDecl *I = dyn_cast<ObjCInterfaceDecl> (CDecl)) {
2898     for (auto *PI : I->all_referenced_protocols())
2899       CheckProtocolMethodDefs(*this, IMPDecl->getLocation(), PI, IncompleteImpl,
2900                               InsMap, ClsMap, I, ExplicitImplProtocols);
2901   } else if (ObjCCategoryDecl *C = dyn_cast<ObjCCategoryDecl>(CDecl)) {
2902     // For extended class, unimplemented methods in its protocols will
2903     // be reported in the primary class.
2904     if (!C->IsClassExtension()) {
2905       for (auto *P : C->protocols())
2906         CheckProtocolMethodDefs(*this, IMPDecl->getLocation(), P,
2907                                 IncompleteImpl, InsMap, ClsMap, CDecl,
2908                                 ExplicitImplProtocols);
2909       DiagnoseUnimplementedProperties(S, IMPDecl, CDecl,
2910                                       /*SynthesizeProperties=*/false);
2911     }
2912   } else
2913     llvm_unreachable("invalid ObjCContainerDecl type.");
2914 }
2915 
2916 Sema::DeclGroupPtrTy
2917 Sema::ActOnForwardClassDeclaration(SourceLocation AtClassLoc,
2918                                    IdentifierInfo **IdentList,
2919                                    SourceLocation *IdentLocs,
2920                                    ArrayRef<ObjCTypeParamList *> TypeParamLists,
2921                                    unsigned NumElts) {
2922   SmallVector<Decl *, 8> DeclsInGroup;
2923   for (unsigned i = 0; i != NumElts; ++i) {
2924     // Check for another declaration kind with the same name.
2925     NamedDecl *PrevDecl
2926       = LookupSingleName(TUScope, IdentList[i], IdentLocs[i],
2927                          LookupOrdinaryName, ForRedeclaration);
2928     if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
2929       // GCC apparently allows the following idiom:
2930       //
2931       // typedef NSObject < XCElementTogglerP > XCElementToggler;
2932       // @class XCElementToggler;
2933       //
2934       // Here we have chosen to ignore the forward class declaration
2935       // with a warning. Since this is the implied behavior.
2936       TypedefNameDecl *TDD = dyn_cast<TypedefNameDecl>(PrevDecl);
2937       if (!TDD || !TDD->getUnderlyingType()->isObjCObjectType()) {
2938         Diag(AtClassLoc, diag::err_redefinition_different_kind) << IdentList[i];
2939         Diag(PrevDecl->getLocation(), diag::note_previous_definition);
2940       } else {
2941         // a forward class declaration matching a typedef name of a class refers
2942         // to the underlying class. Just ignore the forward class with a warning
2943         // as this will force the intended behavior which is to lookup the
2944         // typedef name.
2945         if (isa<ObjCObjectType>(TDD->getUnderlyingType())) {
2946           Diag(AtClassLoc, diag::warn_forward_class_redefinition)
2947               << IdentList[i];
2948           Diag(PrevDecl->getLocation(), diag::note_previous_definition);
2949           continue;
2950         }
2951       }
2952     }
2953 
2954     // Create a declaration to describe this forward declaration.
2955     ObjCInterfaceDecl *PrevIDecl
2956       = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
2957 
2958     IdentifierInfo *ClassName = IdentList[i];
2959     if (PrevIDecl && PrevIDecl->getIdentifier() != ClassName) {
2960       // A previous decl with a different name is because of
2961       // @compatibility_alias, for example:
2962       // \code
2963       //   @class NewImage;
2964       //   @compatibility_alias OldImage NewImage;
2965       // \endcode
2966       // A lookup for 'OldImage' will return the 'NewImage' decl.
2967       //
2968       // In such a case use the real declaration name, instead of the alias one,
2969       // otherwise we will break IdentifierResolver and redecls-chain invariants.
2970       // FIXME: If necessary, add a bit to indicate that this ObjCInterfaceDecl
2971       // has been aliased.
2972       ClassName = PrevIDecl->getIdentifier();
2973     }
2974 
2975     // If this forward declaration has type parameters, compare them with the
2976     // type parameters of the previous declaration.
2977     ObjCTypeParamList *TypeParams = TypeParamLists[i];
2978     if (PrevIDecl && TypeParams) {
2979       if (ObjCTypeParamList *PrevTypeParams = PrevIDecl->getTypeParamList()) {
2980         // Check for consistency with the previous declaration.
2981         if (checkTypeParamListConsistency(
2982               *this, PrevTypeParams, TypeParams,
2983               TypeParamListContext::ForwardDeclaration)) {
2984           TypeParams = nullptr;
2985         }
2986       } else if (ObjCInterfaceDecl *Def = PrevIDecl->getDefinition()) {
2987         // The @interface does not have type parameters. Complain.
2988         Diag(IdentLocs[i], diag::err_objc_parameterized_forward_class)
2989           << ClassName
2990           << TypeParams->getSourceRange();
2991         Diag(Def->getLocation(), diag::note_defined_here)
2992           << ClassName;
2993 
2994         TypeParams = nullptr;
2995       }
2996     }
2997 
2998     ObjCInterfaceDecl *IDecl
2999       = ObjCInterfaceDecl::Create(Context, CurContext, AtClassLoc,
3000                                   ClassName, TypeParams, PrevIDecl,
3001                                   IdentLocs[i]);
3002     IDecl->setAtEndRange(IdentLocs[i]);
3003 
3004     PushOnScopeChains(IDecl, TUScope);
3005     CheckObjCDeclScope(IDecl);
3006     DeclsInGroup.push_back(IDecl);
3007   }
3008 
3009   return BuildDeclaratorGroup(DeclsInGroup, false);
3010 }
3011 
3012 static bool tryMatchRecordTypes(ASTContext &Context,
3013                                 Sema::MethodMatchStrategy strategy,
3014                                 const Type *left, const Type *right);
3015 
3016 static bool matchTypes(ASTContext &Context, Sema::MethodMatchStrategy strategy,
3017                        QualType leftQT, QualType rightQT) {
3018   const Type *left =
3019     Context.getCanonicalType(leftQT).getUnqualifiedType().getTypePtr();
3020   const Type *right =
3021     Context.getCanonicalType(rightQT).getUnqualifiedType().getTypePtr();
3022 
3023   if (left == right) return true;
3024 
3025   // If we're doing a strict match, the types have to match exactly.
3026   if (strategy == Sema::MMS_strict) return false;
3027 
3028   if (left->isIncompleteType() || right->isIncompleteType()) return false;
3029 
3030   // Otherwise, use this absurdly complicated algorithm to try to
3031   // validate the basic, low-level compatibility of the two types.
3032 
3033   // As a minimum, require the sizes and alignments to match.
3034   TypeInfo LeftTI = Context.getTypeInfo(left);
3035   TypeInfo RightTI = Context.getTypeInfo(right);
3036   if (LeftTI.Width != RightTI.Width)
3037     return false;
3038 
3039   if (LeftTI.Align != RightTI.Align)
3040     return false;
3041 
3042   // Consider all the kinds of non-dependent canonical types:
3043   // - functions and arrays aren't possible as return and parameter types
3044 
3045   // - vector types of equal size can be arbitrarily mixed
3046   if (isa<VectorType>(left)) return isa<VectorType>(right);
3047   if (isa<VectorType>(right)) return false;
3048 
3049   // - references should only match references of identical type
3050   // - structs, unions, and Objective-C objects must match more-or-less
3051   //   exactly
3052   // - everything else should be a scalar
3053   if (!left->isScalarType() || !right->isScalarType())
3054     return tryMatchRecordTypes(Context, strategy, left, right);
3055 
3056   // Make scalars agree in kind, except count bools as chars, and group
3057   // all non-member pointers together.
3058   Type::ScalarTypeKind leftSK = left->getScalarTypeKind();
3059   Type::ScalarTypeKind rightSK = right->getScalarTypeKind();
3060   if (leftSK == Type::STK_Bool) leftSK = Type::STK_Integral;
3061   if (rightSK == Type::STK_Bool) rightSK = Type::STK_Integral;
3062   if (leftSK == Type::STK_CPointer || leftSK == Type::STK_BlockPointer)
3063     leftSK = Type::STK_ObjCObjectPointer;
3064   if (rightSK == Type::STK_CPointer || rightSK == Type::STK_BlockPointer)
3065     rightSK = Type::STK_ObjCObjectPointer;
3066 
3067   // Note that data member pointers and function member pointers don't
3068   // intermix because of the size differences.
3069 
3070   return (leftSK == rightSK);
3071 }
3072 
3073 static bool tryMatchRecordTypes(ASTContext &Context,
3074                                 Sema::MethodMatchStrategy strategy,
3075                                 const Type *lt, const Type *rt) {
3076   assert(lt && rt && lt != rt);
3077 
3078   if (!isa<RecordType>(lt) || !isa<RecordType>(rt)) return false;
3079   RecordDecl *left = cast<RecordType>(lt)->getDecl();
3080   RecordDecl *right = cast<RecordType>(rt)->getDecl();
3081 
3082   // Require union-hood to match.
3083   if (left->isUnion() != right->isUnion()) return false;
3084 
3085   // Require an exact match if either is non-POD.
3086   if ((isa<CXXRecordDecl>(left) && !cast<CXXRecordDecl>(left)->isPOD()) ||
3087       (isa<CXXRecordDecl>(right) && !cast<CXXRecordDecl>(right)->isPOD()))
3088     return false;
3089 
3090   // Require size and alignment to match.
3091   TypeInfo LeftTI = Context.getTypeInfo(lt);
3092   TypeInfo RightTI = Context.getTypeInfo(rt);
3093   if (LeftTI.Width != RightTI.Width)
3094     return false;
3095 
3096   if (LeftTI.Align != RightTI.Align)
3097     return false;
3098 
3099   // Require fields to match.
3100   RecordDecl::field_iterator li = left->field_begin(), le = left->field_end();
3101   RecordDecl::field_iterator ri = right->field_begin(), re = right->field_end();
3102   for (; li != le && ri != re; ++li, ++ri) {
3103     if (!matchTypes(Context, strategy, li->getType(), ri->getType()))
3104       return false;
3105   }
3106   return (li == le && ri == re);
3107 }
3108 
3109 /// MatchTwoMethodDeclarations - Checks that two methods have matching type and
3110 /// returns true, or false, accordingly.
3111 /// TODO: Handle protocol list; such as id<p1,p2> in type comparisons
3112 bool Sema::MatchTwoMethodDeclarations(const ObjCMethodDecl *left,
3113                                       const ObjCMethodDecl *right,
3114                                       MethodMatchStrategy strategy) {
3115   if (!matchTypes(Context, strategy, left->getReturnType(),
3116                   right->getReturnType()))
3117     return false;
3118 
3119   // If either is hidden, it is not considered to match.
3120   if (left->isHidden() || right->isHidden())
3121     return false;
3122 
3123   if (getLangOpts().ObjCAutoRefCount &&
3124       (left->hasAttr<NSReturnsRetainedAttr>()
3125          != right->hasAttr<NSReturnsRetainedAttr>() ||
3126        left->hasAttr<NSConsumesSelfAttr>()
3127          != right->hasAttr<NSConsumesSelfAttr>()))
3128     return false;
3129 
3130   ObjCMethodDecl::param_const_iterator
3131     li = left->param_begin(), le = left->param_end(), ri = right->param_begin(),
3132     re = right->param_end();
3133 
3134   for (; li != le && ri != re; ++li, ++ri) {
3135     assert(ri != right->param_end() && "Param mismatch");
3136     const ParmVarDecl *lparm = *li, *rparm = *ri;
3137 
3138     if (!matchTypes(Context, strategy, lparm->getType(), rparm->getType()))
3139       return false;
3140 
3141     if (getLangOpts().ObjCAutoRefCount &&
3142         lparm->hasAttr<NSConsumedAttr>() != rparm->hasAttr<NSConsumedAttr>())
3143       return false;
3144   }
3145   return true;
3146 }
3147 
3148 void Sema::addMethodToGlobalList(ObjCMethodList *List,
3149                                  ObjCMethodDecl *Method) {
3150   // Record at the head of the list whether there were 0, 1, or >= 2 methods
3151   // inside categories.
3152   if (ObjCCategoryDecl *CD =
3153           dyn_cast<ObjCCategoryDecl>(Method->getDeclContext()))
3154     if (!CD->IsClassExtension() && List->getBits() < 2)
3155       List->setBits(List->getBits() + 1);
3156 
3157   // If the list is empty, make it a singleton list.
3158   if (List->getMethod() == nullptr) {
3159     List->setMethod(Method);
3160     List->setNext(nullptr);
3161     return;
3162   }
3163 
3164   // We've seen a method with this name, see if we have already seen this type
3165   // signature.
3166   ObjCMethodList *Previous = List;
3167   for (; List; Previous = List, List = List->getNext()) {
3168     // If we are building a module, keep all of the methods.
3169     if (getLangOpts().Modules && !getLangOpts().CurrentModule.empty())
3170       continue;
3171 
3172     if (!MatchTwoMethodDeclarations(Method, List->getMethod())) {
3173       // Even if two method types do not match, we would like to say
3174       // there is more than one declaration so unavailability/deprecated
3175       // warning is not too noisy.
3176       if (!Method->isDefined())
3177         List->setHasMoreThanOneDecl(true);
3178       continue;
3179     }
3180 
3181     ObjCMethodDecl *PrevObjCMethod = List->getMethod();
3182 
3183     // Propagate the 'defined' bit.
3184     if (Method->isDefined())
3185       PrevObjCMethod->setDefined(true);
3186     else {
3187       // Objective-C doesn't allow an @interface for a class after its
3188       // @implementation. So if Method is not defined and there already is
3189       // an entry for this type signature, Method has to be for a different
3190       // class than PrevObjCMethod.
3191       List->setHasMoreThanOneDecl(true);
3192     }
3193 
3194     // If a method is deprecated, push it in the global pool.
3195     // This is used for better diagnostics.
3196     if (Method->isDeprecated()) {
3197       if (!PrevObjCMethod->isDeprecated())
3198         List->setMethod(Method);
3199     }
3200     // If the new method is unavailable, push it into global pool
3201     // unless previous one is deprecated.
3202     if (Method->isUnavailable()) {
3203       if (PrevObjCMethod->getAvailability() < AR_Deprecated)
3204         List->setMethod(Method);
3205     }
3206 
3207     return;
3208   }
3209 
3210   // We have a new signature for an existing method - add it.
3211   // This is extremely rare. Only 1% of Cocoa selectors are "overloaded".
3212   ObjCMethodList *Mem = BumpAlloc.Allocate<ObjCMethodList>();
3213   Previous->setNext(new (Mem) ObjCMethodList(Method));
3214 }
3215 
3216 /// \brief Read the contents of the method pool for a given selector from
3217 /// external storage.
3218 void Sema::ReadMethodPool(Selector Sel) {
3219   assert(ExternalSource && "We need an external AST source");
3220   ExternalSource->ReadMethodPool(Sel);
3221 }
3222 
3223 void Sema::AddMethodToGlobalPool(ObjCMethodDecl *Method, bool impl,
3224                                  bool instance) {
3225   // Ignore methods of invalid containers.
3226   if (cast<Decl>(Method->getDeclContext())->isInvalidDecl())
3227     return;
3228 
3229   if (ExternalSource)
3230     ReadMethodPool(Method->getSelector());
3231 
3232   GlobalMethodPool::iterator Pos = MethodPool.find(Method->getSelector());
3233   if (Pos == MethodPool.end())
3234     Pos = MethodPool.insert(std::make_pair(Method->getSelector(),
3235                                            GlobalMethods())).first;
3236 
3237   Method->setDefined(impl);
3238 
3239   ObjCMethodList &Entry = instance ? Pos->second.first : Pos->second.second;
3240   addMethodToGlobalList(&Entry, Method);
3241 }
3242 
3243 /// Determines if this is an "acceptable" loose mismatch in the global
3244 /// method pool.  This exists mostly as a hack to get around certain
3245 /// global mismatches which we can't afford to make warnings / errors.
3246 /// Really, what we want is a way to take a method out of the global
3247 /// method pool.
3248 static bool isAcceptableMethodMismatch(ObjCMethodDecl *chosen,
3249                                        ObjCMethodDecl *other) {
3250   if (!chosen->isInstanceMethod())
3251     return false;
3252 
3253   Selector sel = chosen->getSelector();
3254   if (!sel.isUnarySelector() || sel.getNameForSlot(0) != "length")
3255     return false;
3256 
3257   // Don't complain about mismatches for -length if the method we
3258   // chose has an integral result type.
3259   return (chosen->getReturnType()->isIntegerType());
3260 }
3261 
3262 bool Sema::CollectMultipleMethodsInGlobalPool(
3263     Selector Sel, SmallVectorImpl<ObjCMethodDecl *> &Methods, bool instance) {
3264   if (ExternalSource)
3265     ReadMethodPool(Sel);
3266 
3267   GlobalMethodPool::iterator Pos = MethodPool.find(Sel);
3268   if (Pos == MethodPool.end())
3269     return false;
3270   // Gather the non-hidden methods.
3271   ObjCMethodList &MethList = instance ? Pos->second.first : Pos->second.second;
3272   for (ObjCMethodList *M = &MethList; M; M = M->getNext())
3273     if (M->getMethod() && !M->getMethod()->isHidden())
3274       Methods.push_back(M->getMethod());
3275   return Methods.size() > 1;
3276 }
3277 
3278 bool Sema::AreMultipleMethodsInGlobalPool(Selector Sel, ObjCMethodDecl *BestMethod,
3279                                           SourceRange R,
3280                                           bool receiverIdOrClass) {
3281   GlobalMethodPool::iterator Pos = MethodPool.find(Sel);
3282   // Test for no method in the pool which should not trigger any warning by
3283   // caller.
3284   if (Pos == MethodPool.end())
3285     return true;
3286   ObjCMethodList &MethList =
3287     BestMethod->isInstanceMethod() ? Pos->second.first : Pos->second.second;
3288 
3289   // Diagnose finding more than one method in global pool
3290   SmallVector<ObjCMethodDecl *, 4> Methods;
3291   Methods.push_back(BestMethod);
3292   for (ObjCMethodList *ML = &MethList; ML; ML = ML->getNext())
3293     if (ObjCMethodDecl *M = ML->getMethod())
3294       if (!M->isHidden() && M != BestMethod && !M->hasAttr<UnavailableAttr>())
3295         Methods.push_back(M);
3296   if (Methods.size() > 1)
3297     DiagnoseMultipleMethodInGlobalPool(Methods, Sel, R, receiverIdOrClass);
3298 
3299   return MethList.hasMoreThanOneDecl();
3300 }
3301 
3302 ObjCMethodDecl *Sema::LookupMethodInGlobalPool(Selector Sel, SourceRange R,
3303                                                bool receiverIdOrClass,
3304                                                bool instance) {
3305   if (ExternalSource)
3306     ReadMethodPool(Sel);
3307 
3308   GlobalMethodPool::iterator Pos = MethodPool.find(Sel);
3309   if (Pos == MethodPool.end())
3310     return nullptr;
3311 
3312   // Gather the non-hidden methods.
3313   ObjCMethodList &MethList = instance ? Pos->second.first : Pos->second.second;
3314   SmallVector<ObjCMethodDecl *, 4> Methods;
3315   for (ObjCMethodList *M = &MethList; M; M = M->getNext()) {
3316     if (M->getMethod() && !M->getMethod()->isHidden())
3317       return M->getMethod();
3318   }
3319   return nullptr;
3320 }
3321 
3322 void Sema::DiagnoseMultipleMethodInGlobalPool(SmallVectorImpl<ObjCMethodDecl*> &Methods,
3323                                               Selector Sel, SourceRange R,
3324                                               bool receiverIdOrClass) {
3325   // We found multiple methods, so we may have to complain.
3326   bool issueDiagnostic = false, issueError = false;
3327 
3328   // We support a warning which complains about *any* difference in
3329   // method signature.
3330   bool strictSelectorMatch =
3331   receiverIdOrClass &&
3332   !Diags.isIgnored(diag::warn_strict_multiple_method_decl, R.getBegin());
3333   if (strictSelectorMatch) {
3334     for (unsigned I = 1, N = Methods.size(); I != N; ++I) {
3335       if (!MatchTwoMethodDeclarations(Methods[0], Methods[I], MMS_strict)) {
3336         issueDiagnostic = true;
3337         break;
3338       }
3339     }
3340   }
3341 
3342   // If we didn't see any strict differences, we won't see any loose
3343   // differences.  In ARC, however, we also need to check for loose
3344   // mismatches, because most of them are errors.
3345   if (!strictSelectorMatch ||
3346       (issueDiagnostic && getLangOpts().ObjCAutoRefCount))
3347     for (unsigned I = 1, N = Methods.size(); I != N; ++I) {
3348       // This checks if the methods differ in type mismatch.
3349       if (!MatchTwoMethodDeclarations(Methods[0], Methods[I], MMS_loose) &&
3350           !isAcceptableMethodMismatch(Methods[0], Methods[I])) {
3351         issueDiagnostic = true;
3352         if (getLangOpts().ObjCAutoRefCount)
3353           issueError = true;
3354         break;
3355       }
3356     }
3357 
3358   if (issueDiagnostic) {
3359     if (issueError)
3360       Diag(R.getBegin(), diag::err_arc_multiple_method_decl) << Sel << R;
3361     else if (strictSelectorMatch)
3362       Diag(R.getBegin(), diag::warn_strict_multiple_method_decl) << Sel << R;
3363     else
3364       Diag(R.getBegin(), diag::warn_multiple_method_decl) << Sel << R;
3365 
3366     Diag(Methods[0]->getLocStart(),
3367          issueError ? diag::note_possibility : diag::note_using)
3368     << Methods[0]->getSourceRange();
3369     for (unsigned I = 1, N = Methods.size(); I != N; ++I) {
3370       Diag(Methods[I]->getLocStart(), diag::note_also_found)
3371       << Methods[I]->getSourceRange();
3372     }
3373   }
3374 }
3375 
3376 ObjCMethodDecl *Sema::LookupImplementedMethodInGlobalPool(Selector Sel) {
3377   GlobalMethodPool::iterator Pos = MethodPool.find(Sel);
3378   if (Pos == MethodPool.end())
3379     return nullptr;
3380 
3381   GlobalMethods &Methods = Pos->second;
3382   for (const ObjCMethodList *Method = &Methods.first; Method;
3383        Method = Method->getNext())
3384     if (Method->getMethod() &&
3385         (Method->getMethod()->isDefined() ||
3386          Method->getMethod()->isPropertyAccessor()))
3387       return Method->getMethod();
3388 
3389   for (const ObjCMethodList *Method = &Methods.second; Method;
3390        Method = Method->getNext())
3391     if (Method->getMethod() &&
3392         (Method->getMethod()->isDefined() ||
3393          Method->getMethod()->isPropertyAccessor()))
3394       return Method->getMethod();
3395   return nullptr;
3396 }
3397 
3398 static void
3399 HelperSelectorsForTypoCorrection(
3400                       SmallVectorImpl<const ObjCMethodDecl *> &BestMethod,
3401                       StringRef Typo, const ObjCMethodDecl * Method) {
3402   const unsigned MaxEditDistance = 1;
3403   unsigned BestEditDistance = MaxEditDistance + 1;
3404   std::string MethodName = Method->getSelector().getAsString();
3405 
3406   unsigned MinPossibleEditDistance = abs((int)MethodName.size() - (int)Typo.size());
3407   if (MinPossibleEditDistance > 0 &&
3408       Typo.size() / MinPossibleEditDistance < 1)
3409     return;
3410   unsigned EditDistance = Typo.edit_distance(MethodName, true, MaxEditDistance);
3411   if (EditDistance > MaxEditDistance)
3412     return;
3413   if (EditDistance == BestEditDistance)
3414     BestMethod.push_back(Method);
3415   else if (EditDistance < BestEditDistance) {
3416     BestMethod.clear();
3417     BestMethod.push_back(Method);
3418   }
3419 }
3420 
3421 static bool HelperIsMethodInObjCType(Sema &S, Selector Sel,
3422                                      QualType ObjectType) {
3423   if (ObjectType.isNull())
3424     return true;
3425   if (S.LookupMethodInObjectType(Sel, ObjectType, true/*Instance method*/))
3426     return true;
3427   return S.LookupMethodInObjectType(Sel, ObjectType, false/*Class method*/) !=
3428          nullptr;
3429 }
3430 
3431 const ObjCMethodDecl *
3432 Sema::SelectorsForTypoCorrection(Selector Sel,
3433                                  QualType ObjectType) {
3434   unsigned NumArgs = Sel.getNumArgs();
3435   SmallVector<const ObjCMethodDecl *, 8> Methods;
3436   bool ObjectIsId = true, ObjectIsClass = true;
3437   if (ObjectType.isNull())
3438     ObjectIsId = ObjectIsClass = false;
3439   else if (!ObjectType->isObjCObjectPointerType())
3440     return nullptr;
3441   else if (const ObjCObjectPointerType *ObjCPtr =
3442            ObjectType->getAsObjCInterfacePointerType()) {
3443     ObjectType = QualType(ObjCPtr->getInterfaceType(), 0);
3444     ObjectIsId = ObjectIsClass = false;
3445   }
3446   else if (ObjectType->isObjCIdType() || ObjectType->isObjCQualifiedIdType())
3447     ObjectIsClass = false;
3448   else if (ObjectType->isObjCClassType() || ObjectType->isObjCQualifiedClassType())
3449     ObjectIsId = false;
3450   else
3451     return nullptr;
3452 
3453   for (GlobalMethodPool::iterator b = MethodPool.begin(),
3454        e = MethodPool.end(); b != e; b++) {
3455     // instance methods
3456     for (ObjCMethodList *M = &b->second.first; M; M=M->getNext())
3457       if (M->getMethod() &&
3458           (M->getMethod()->getSelector().getNumArgs() == NumArgs) &&
3459           (M->getMethod()->getSelector() != Sel)) {
3460         if (ObjectIsId)
3461           Methods.push_back(M->getMethod());
3462         else if (!ObjectIsClass &&
3463                  HelperIsMethodInObjCType(*this, M->getMethod()->getSelector(),
3464                                           ObjectType))
3465           Methods.push_back(M->getMethod());
3466       }
3467     // class methods
3468     for (ObjCMethodList *M = &b->second.second; M; M=M->getNext())
3469       if (M->getMethod() &&
3470           (M->getMethod()->getSelector().getNumArgs() == NumArgs) &&
3471           (M->getMethod()->getSelector() != Sel)) {
3472         if (ObjectIsClass)
3473           Methods.push_back(M->getMethod());
3474         else if (!ObjectIsId &&
3475                  HelperIsMethodInObjCType(*this, M->getMethod()->getSelector(),
3476                                           ObjectType))
3477           Methods.push_back(M->getMethod());
3478       }
3479   }
3480 
3481   SmallVector<const ObjCMethodDecl *, 8> SelectedMethods;
3482   for (unsigned i = 0, e = Methods.size(); i < e; i++) {
3483     HelperSelectorsForTypoCorrection(SelectedMethods,
3484                                      Sel.getAsString(), Methods[i]);
3485   }
3486   return (SelectedMethods.size() == 1) ? SelectedMethods[0] : nullptr;
3487 }
3488 
3489 /// DiagnoseDuplicateIvars -
3490 /// Check for duplicate ivars in the entire class at the start of
3491 /// \@implementation. This becomes necesssary because class extension can
3492 /// add ivars to a class in random order which will not be known until
3493 /// class's \@implementation is seen.
3494 void Sema::DiagnoseDuplicateIvars(ObjCInterfaceDecl *ID,
3495                                   ObjCInterfaceDecl *SID) {
3496   for (auto *Ivar : ID->ivars()) {
3497     if (Ivar->isInvalidDecl())
3498       continue;
3499     if (IdentifierInfo *II = Ivar->getIdentifier()) {
3500       ObjCIvarDecl* prevIvar = SID->lookupInstanceVariable(II);
3501       if (prevIvar) {
3502         Diag(Ivar->getLocation(), diag::err_duplicate_member) << II;
3503         Diag(prevIvar->getLocation(), diag::note_previous_declaration);
3504         Ivar->setInvalidDecl();
3505       }
3506     }
3507   }
3508 }
3509 
3510 /// Diagnose attempts to define ARC-__weak ivars when __weak is disabled.
3511 static void DiagnoseWeakIvars(Sema &S, ObjCImplementationDecl *ID) {
3512   if (S.getLangOpts().ObjCWeak) return;
3513 
3514   for (auto ivar = ID->getClassInterface()->all_declared_ivar_begin();
3515          ivar; ivar = ivar->getNextIvar()) {
3516     if (ivar->isInvalidDecl()) continue;
3517     if (ivar->getType().getObjCLifetime() == Qualifiers::OCL_Weak) {
3518       if (S.getLangOpts().ObjCWeakRuntime) {
3519         S.Diag(ivar->getLocation(), diag::err_arc_weak_disabled);
3520       } else {
3521         S.Diag(ivar->getLocation(), diag::err_arc_weak_no_runtime);
3522       }
3523     }
3524   }
3525 }
3526 
3527 Sema::ObjCContainerKind Sema::getObjCContainerKind() const {
3528   switch (CurContext->getDeclKind()) {
3529     case Decl::ObjCInterface:
3530       return Sema::OCK_Interface;
3531     case Decl::ObjCProtocol:
3532       return Sema::OCK_Protocol;
3533     case Decl::ObjCCategory:
3534       if (cast<ObjCCategoryDecl>(CurContext)->IsClassExtension())
3535         return Sema::OCK_ClassExtension;
3536       return Sema::OCK_Category;
3537     case Decl::ObjCImplementation:
3538       return Sema::OCK_Implementation;
3539     case Decl::ObjCCategoryImpl:
3540       return Sema::OCK_CategoryImplementation;
3541 
3542     default:
3543       return Sema::OCK_None;
3544   }
3545 }
3546 
3547 // Note: For class/category implementations, allMethods is always null.
3548 Decl *Sema::ActOnAtEnd(Scope *S, SourceRange AtEnd, ArrayRef<Decl *> allMethods,
3549                        ArrayRef<DeclGroupPtrTy> allTUVars) {
3550   if (getObjCContainerKind() == Sema::OCK_None)
3551     return nullptr;
3552 
3553   assert(AtEnd.isValid() && "Invalid location for '@end'");
3554 
3555   ObjCContainerDecl *OCD = dyn_cast<ObjCContainerDecl>(CurContext);
3556   Decl *ClassDecl = cast<Decl>(OCD);
3557 
3558   bool isInterfaceDeclKind =
3559         isa<ObjCInterfaceDecl>(ClassDecl) || isa<ObjCCategoryDecl>(ClassDecl)
3560          || isa<ObjCProtocolDecl>(ClassDecl);
3561   bool checkIdenticalMethods = isa<ObjCImplementationDecl>(ClassDecl);
3562 
3563   // FIXME: Remove these and use the ObjCContainerDecl/DeclContext.
3564   llvm::DenseMap<Selector, const ObjCMethodDecl*> InsMap;
3565   llvm::DenseMap<Selector, const ObjCMethodDecl*> ClsMap;
3566 
3567   for (unsigned i = 0, e = allMethods.size(); i != e; i++ ) {
3568     ObjCMethodDecl *Method =
3569       cast_or_null<ObjCMethodDecl>(allMethods[i]);
3570 
3571     if (!Method) continue;  // Already issued a diagnostic.
3572     if (Method->isInstanceMethod()) {
3573       /// Check for instance method of the same name with incompatible types
3574       const ObjCMethodDecl *&PrevMethod = InsMap[Method->getSelector()];
3575       bool match = PrevMethod ? MatchTwoMethodDeclarations(Method, PrevMethod)
3576                               : false;
3577       if ((isInterfaceDeclKind && PrevMethod && !match)
3578           || (checkIdenticalMethods && match)) {
3579           Diag(Method->getLocation(), diag::err_duplicate_method_decl)
3580             << Method->getDeclName();
3581           Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
3582         Method->setInvalidDecl();
3583       } else {
3584         if (PrevMethod) {
3585           Method->setAsRedeclaration(PrevMethod);
3586           if (!Context.getSourceManager().isInSystemHeader(
3587                  Method->getLocation()))
3588             Diag(Method->getLocation(), diag::warn_duplicate_method_decl)
3589               << Method->getDeclName();
3590           Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
3591         }
3592         InsMap[Method->getSelector()] = Method;
3593         /// The following allows us to typecheck messages to "id".
3594         AddInstanceMethodToGlobalPool(Method);
3595       }
3596     } else {
3597       /// Check for class method of the same name with incompatible types
3598       const ObjCMethodDecl *&PrevMethod = ClsMap[Method->getSelector()];
3599       bool match = PrevMethod ? MatchTwoMethodDeclarations(Method, PrevMethod)
3600                               : false;
3601       if ((isInterfaceDeclKind && PrevMethod && !match)
3602           || (checkIdenticalMethods && match)) {
3603         Diag(Method->getLocation(), diag::err_duplicate_method_decl)
3604           << Method->getDeclName();
3605         Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
3606         Method->setInvalidDecl();
3607       } else {
3608         if (PrevMethod) {
3609           Method->setAsRedeclaration(PrevMethod);
3610           if (!Context.getSourceManager().isInSystemHeader(
3611                  Method->getLocation()))
3612             Diag(Method->getLocation(), diag::warn_duplicate_method_decl)
3613               << Method->getDeclName();
3614           Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
3615         }
3616         ClsMap[Method->getSelector()] = Method;
3617         AddFactoryMethodToGlobalPool(Method);
3618       }
3619     }
3620   }
3621   if (isa<ObjCInterfaceDecl>(ClassDecl)) {
3622     // Nothing to do here.
3623   } else if (ObjCCategoryDecl *C = dyn_cast<ObjCCategoryDecl>(ClassDecl)) {
3624     // Categories are used to extend the class by declaring new methods.
3625     // By the same token, they are also used to add new properties. No
3626     // need to compare the added property to those in the class.
3627 
3628     if (C->IsClassExtension()) {
3629       ObjCInterfaceDecl *CCPrimary = C->getClassInterface();
3630       DiagnoseClassExtensionDupMethods(C, CCPrimary);
3631     }
3632   }
3633   if (ObjCContainerDecl *CDecl = dyn_cast<ObjCContainerDecl>(ClassDecl)) {
3634     if (CDecl->getIdentifier())
3635       // ProcessPropertyDecl is responsible for diagnosing conflicts with any
3636       // user-defined setter/getter. It also synthesizes setter/getter methods
3637       // and adds them to the DeclContext and global method pools.
3638       for (auto *I : CDecl->properties())
3639         ProcessPropertyDecl(I);
3640     CDecl->setAtEndRange(AtEnd);
3641   }
3642   if (ObjCImplementationDecl *IC=dyn_cast<ObjCImplementationDecl>(ClassDecl)) {
3643     IC->setAtEndRange(AtEnd);
3644     if (ObjCInterfaceDecl* IDecl = IC->getClassInterface()) {
3645       // Any property declared in a class extension might have user
3646       // declared setter or getter in current class extension or one
3647       // of the other class extensions. Mark them as synthesized as
3648       // property will be synthesized when property with same name is
3649       // seen in the @implementation.
3650       for (const auto *Ext : IDecl->visible_extensions()) {
3651         for (const auto *Property : Ext->properties()) {
3652           // Skip over properties declared @dynamic
3653           if (const ObjCPropertyImplDecl *PIDecl
3654               = IC->FindPropertyImplDecl(Property->getIdentifier()))
3655             if (PIDecl->getPropertyImplementation()
3656                   == ObjCPropertyImplDecl::Dynamic)
3657               continue;
3658 
3659           for (const auto *Ext : IDecl->visible_extensions()) {
3660             if (ObjCMethodDecl *GetterMethod
3661                   = Ext->getInstanceMethod(Property->getGetterName()))
3662               GetterMethod->setPropertyAccessor(true);
3663             if (!Property->isReadOnly())
3664               if (ObjCMethodDecl *SetterMethod
3665                     = Ext->getInstanceMethod(Property->getSetterName()))
3666                 SetterMethod->setPropertyAccessor(true);
3667           }
3668         }
3669       }
3670       ImplMethodsVsClassMethods(S, IC, IDecl);
3671       AtomicPropertySetterGetterRules(IC, IDecl);
3672       DiagnoseOwningPropertyGetterSynthesis(IC);
3673       DiagnoseUnusedBackingIvarInAccessor(S, IC);
3674       if (IDecl->hasDesignatedInitializers())
3675         DiagnoseMissingDesignatedInitOverrides(IC, IDecl);
3676       DiagnoseWeakIvars(*this, IC);
3677 
3678       bool HasRootClassAttr = IDecl->hasAttr<ObjCRootClassAttr>();
3679       if (IDecl->getSuperClass() == nullptr) {
3680         // This class has no superclass, so check that it has been marked with
3681         // __attribute((objc_root_class)).
3682         if (!HasRootClassAttr) {
3683           SourceLocation DeclLoc(IDecl->getLocation());
3684           SourceLocation SuperClassLoc(getLocForEndOfToken(DeclLoc));
3685           Diag(DeclLoc, diag::warn_objc_root_class_missing)
3686             << IDecl->getIdentifier();
3687           // See if NSObject is in the current scope, and if it is, suggest
3688           // adding " : NSObject " to the class declaration.
3689           NamedDecl *IF = LookupSingleName(TUScope,
3690                                            NSAPIObj->getNSClassId(NSAPI::ClassId_NSObject),
3691                                            DeclLoc, LookupOrdinaryName);
3692           ObjCInterfaceDecl *NSObjectDecl = dyn_cast_or_null<ObjCInterfaceDecl>(IF);
3693           if (NSObjectDecl && NSObjectDecl->getDefinition()) {
3694             Diag(SuperClassLoc, diag::note_objc_needs_superclass)
3695               << FixItHint::CreateInsertion(SuperClassLoc, " : NSObject ");
3696           } else {
3697             Diag(SuperClassLoc, diag::note_objc_needs_superclass);
3698           }
3699         }
3700       } else if (HasRootClassAttr) {
3701         // Complain that only root classes may have this attribute.
3702         Diag(IDecl->getLocation(), diag::err_objc_root_class_subclass);
3703       }
3704 
3705       if (LangOpts.ObjCRuntime.isNonFragile()) {
3706         while (IDecl->getSuperClass()) {
3707           DiagnoseDuplicateIvars(IDecl, IDecl->getSuperClass());
3708           IDecl = IDecl->getSuperClass();
3709         }
3710       }
3711     }
3712     SetIvarInitializers(IC);
3713   } else if (ObjCCategoryImplDecl* CatImplClass =
3714                                    dyn_cast<ObjCCategoryImplDecl>(ClassDecl)) {
3715     CatImplClass->setAtEndRange(AtEnd);
3716 
3717     // Find category interface decl and then check that all methods declared
3718     // in this interface are implemented in the category @implementation.
3719     if (ObjCInterfaceDecl* IDecl = CatImplClass->getClassInterface()) {
3720       if (ObjCCategoryDecl *Cat
3721             = IDecl->FindCategoryDeclaration(CatImplClass->getIdentifier())) {
3722         ImplMethodsVsClassMethods(S, CatImplClass, Cat);
3723       }
3724     }
3725   }
3726   if (isInterfaceDeclKind) {
3727     // Reject invalid vardecls.
3728     for (unsigned i = 0, e = allTUVars.size(); i != e; i++) {
3729       DeclGroupRef DG = allTUVars[i].get();
3730       for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I)
3731         if (VarDecl *VDecl = dyn_cast<VarDecl>(*I)) {
3732           if (!VDecl->hasExternalStorage())
3733             Diag(VDecl->getLocation(), diag::err_objc_var_decl_inclass);
3734         }
3735     }
3736   }
3737   ActOnObjCContainerFinishDefinition();
3738 
3739   for (unsigned i = 0, e = allTUVars.size(); i != e; i++) {
3740     DeclGroupRef DG = allTUVars[i].get();
3741     for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I)
3742       (*I)->setTopLevelDeclInObjCContainer();
3743     Consumer.HandleTopLevelDeclInObjCContainer(DG);
3744   }
3745 
3746   ActOnDocumentableDecl(ClassDecl);
3747   return ClassDecl;
3748 }
3749 
3750 /// CvtQTToAstBitMask - utility routine to produce an AST bitmask for
3751 /// objective-c's type qualifier from the parser version of the same info.
3752 static Decl::ObjCDeclQualifier
3753 CvtQTToAstBitMask(ObjCDeclSpec::ObjCDeclQualifier PQTVal) {
3754   return (Decl::ObjCDeclQualifier) (unsigned) PQTVal;
3755 }
3756 
3757 /// \brief Check whether the declared result type of the given Objective-C
3758 /// method declaration is compatible with the method's class.
3759 ///
3760 static Sema::ResultTypeCompatibilityKind
3761 CheckRelatedResultTypeCompatibility(Sema &S, ObjCMethodDecl *Method,
3762                                     ObjCInterfaceDecl *CurrentClass) {
3763   QualType ResultType = Method->getReturnType();
3764 
3765   // If an Objective-C method inherits its related result type, then its
3766   // declared result type must be compatible with its own class type. The
3767   // declared result type is compatible if:
3768   if (const ObjCObjectPointerType *ResultObjectType
3769                                 = ResultType->getAs<ObjCObjectPointerType>()) {
3770     //   - it is id or qualified id, or
3771     if (ResultObjectType->isObjCIdType() ||
3772         ResultObjectType->isObjCQualifiedIdType())
3773       return Sema::RTC_Compatible;
3774 
3775     if (CurrentClass) {
3776       if (ObjCInterfaceDecl *ResultClass
3777                                       = ResultObjectType->getInterfaceDecl()) {
3778         //   - it is the same as the method's class type, or
3779         if (declaresSameEntity(CurrentClass, ResultClass))
3780           return Sema::RTC_Compatible;
3781 
3782         //   - it is a superclass of the method's class type
3783         if (ResultClass->isSuperClassOf(CurrentClass))
3784           return Sema::RTC_Compatible;
3785       }
3786     } else {
3787       // Any Objective-C pointer type might be acceptable for a protocol
3788       // method; we just don't know.
3789       return Sema::RTC_Unknown;
3790     }
3791   }
3792 
3793   return Sema::RTC_Incompatible;
3794 }
3795 
3796 namespace {
3797 /// A helper class for searching for methods which a particular method
3798 /// overrides.
3799 class OverrideSearch {
3800 public:
3801   Sema &S;
3802   ObjCMethodDecl *Method;
3803   llvm::SmallPtrSet<ObjCMethodDecl*, 4> Overridden;
3804   bool Recursive;
3805 
3806 public:
3807   OverrideSearch(Sema &S, ObjCMethodDecl *method) : S(S), Method(method) {
3808     Selector selector = method->getSelector();
3809 
3810     // Bypass this search if we've never seen an instance/class method
3811     // with this selector before.
3812     Sema::GlobalMethodPool::iterator it = S.MethodPool.find(selector);
3813     if (it == S.MethodPool.end()) {
3814       if (!S.getExternalSource()) return;
3815       S.ReadMethodPool(selector);
3816 
3817       it = S.MethodPool.find(selector);
3818       if (it == S.MethodPool.end())
3819         return;
3820     }
3821     ObjCMethodList &list =
3822       method->isInstanceMethod() ? it->second.first : it->second.second;
3823     if (!list.getMethod()) return;
3824 
3825     ObjCContainerDecl *container
3826       = cast<ObjCContainerDecl>(method->getDeclContext());
3827 
3828     // Prevent the search from reaching this container again.  This is
3829     // important with categories, which override methods from the
3830     // interface and each other.
3831     if (ObjCCategoryDecl *Category = dyn_cast<ObjCCategoryDecl>(container)) {
3832       searchFromContainer(container);
3833       if (ObjCInterfaceDecl *Interface = Category->getClassInterface())
3834         searchFromContainer(Interface);
3835     } else {
3836       searchFromContainer(container);
3837     }
3838   }
3839 
3840   typedef llvm::SmallPtrSet<ObjCMethodDecl*, 128>::iterator iterator;
3841   iterator begin() const { return Overridden.begin(); }
3842   iterator end() const { return Overridden.end(); }
3843 
3844 private:
3845   void searchFromContainer(ObjCContainerDecl *container) {
3846     if (container->isInvalidDecl()) return;
3847 
3848     switch (container->getDeclKind()) {
3849 #define OBJCCONTAINER(type, base) \
3850     case Decl::type: \
3851       searchFrom(cast<type##Decl>(container)); \
3852       break;
3853 #define ABSTRACT_DECL(expansion)
3854 #define DECL(type, base) \
3855     case Decl::type:
3856 #include "clang/AST/DeclNodes.inc"
3857       llvm_unreachable("not an ObjC container!");
3858     }
3859   }
3860 
3861   void searchFrom(ObjCProtocolDecl *protocol) {
3862     if (!protocol->hasDefinition())
3863       return;
3864 
3865     // A method in a protocol declaration overrides declarations from
3866     // referenced ("parent") protocols.
3867     search(protocol->getReferencedProtocols());
3868   }
3869 
3870   void searchFrom(ObjCCategoryDecl *category) {
3871     // A method in a category declaration overrides declarations from
3872     // the main class and from protocols the category references.
3873     // The main class is handled in the constructor.
3874     search(category->getReferencedProtocols());
3875   }
3876 
3877   void searchFrom(ObjCCategoryImplDecl *impl) {
3878     // A method in a category definition that has a category
3879     // declaration overrides declarations from the category
3880     // declaration.
3881     if (ObjCCategoryDecl *category = impl->getCategoryDecl()) {
3882       search(category);
3883       if (ObjCInterfaceDecl *Interface = category->getClassInterface())
3884         search(Interface);
3885 
3886     // Otherwise it overrides declarations from the class.
3887     } else if (ObjCInterfaceDecl *Interface = impl->getClassInterface()) {
3888       search(Interface);
3889     }
3890   }
3891 
3892   void searchFrom(ObjCInterfaceDecl *iface) {
3893     // A method in a class declaration overrides declarations from
3894     if (!iface->hasDefinition())
3895       return;
3896 
3897     //   - categories,
3898     for (auto *Cat : iface->known_categories())
3899       search(Cat);
3900 
3901     //   - the super class, and
3902     if (ObjCInterfaceDecl *super = iface->getSuperClass())
3903       search(super);
3904 
3905     //   - any referenced protocols.
3906     search(iface->getReferencedProtocols());
3907   }
3908 
3909   void searchFrom(ObjCImplementationDecl *impl) {
3910     // A method in a class implementation overrides declarations from
3911     // the class interface.
3912     if (ObjCInterfaceDecl *Interface = impl->getClassInterface())
3913       search(Interface);
3914   }
3915 
3916   void search(const ObjCProtocolList &protocols) {
3917     for (ObjCProtocolList::iterator i = protocols.begin(), e = protocols.end();
3918          i != e; ++i)
3919       search(*i);
3920   }
3921 
3922   void search(ObjCContainerDecl *container) {
3923     // Check for a method in this container which matches this selector.
3924     ObjCMethodDecl *meth = container->getMethod(Method->getSelector(),
3925                                                 Method->isInstanceMethod(),
3926                                                 /*AllowHidden=*/true);
3927 
3928     // If we find one, record it and bail out.
3929     if (meth) {
3930       Overridden.insert(meth);
3931       return;
3932     }
3933 
3934     // Otherwise, search for methods that a hypothetical method here
3935     // would have overridden.
3936 
3937     // Note that we're now in a recursive case.
3938     Recursive = true;
3939 
3940     searchFromContainer(container);
3941   }
3942 };
3943 } // end anonymous namespace
3944 
3945 void Sema::CheckObjCMethodOverrides(ObjCMethodDecl *ObjCMethod,
3946                                     ObjCInterfaceDecl *CurrentClass,
3947                                     ResultTypeCompatibilityKind RTC) {
3948   // Search for overridden methods and merge information down from them.
3949   OverrideSearch overrides(*this, ObjCMethod);
3950   // Keep track if the method overrides any method in the class's base classes,
3951   // its protocols, or its categories' protocols; we will keep that info
3952   // in the ObjCMethodDecl.
3953   // For this info, a method in an implementation is not considered as
3954   // overriding the same method in the interface or its categories.
3955   bool hasOverriddenMethodsInBaseOrProtocol = false;
3956   for (OverrideSearch::iterator
3957          i = overrides.begin(), e = overrides.end(); i != e; ++i) {
3958     ObjCMethodDecl *overridden = *i;
3959 
3960     if (!hasOverriddenMethodsInBaseOrProtocol) {
3961       if (isa<ObjCProtocolDecl>(overridden->getDeclContext()) ||
3962           CurrentClass != overridden->getClassInterface() ||
3963           overridden->isOverriding()) {
3964         hasOverriddenMethodsInBaseOrProtocol = true;
3965 
3966       } else if (isa<ObjCImplDecl>(ObjCMethod->getDeclContext())) {
3967         // OverrideSearch will return as "overridden" the same method in the
3968         // interface. For hasOverriddenMethodsInBaseOrProtocol, we need to
3969         // check whether a category of a base class introduced a method with the
3970         // same selector, after the interface method declaration.
3971         // To avoid unnecessary lookups in the majority of cases, we use the
3972         // extra info bits in GlobalMethodPool to check whether there were any
3973         // category methods with this selector.
3974         GlobalMethodPool::iterator It =
3975             MethodPool.find(ObjCMethod->getSelector());
3976         if (It != MethodPool.end()) {
3977           ObjCMethodList &List =
3978             ObjCMethod->isInstanceMethod()? It->second.first: It->second.second;
3979           unsigned CategCount = List.getBits();
3980           if (CategCount > 0) {
3981             // If the method is in a category we'll do lookup if there were at
3982             // least 2 category methods recorded, otherwise only one will do.
3983             if (CategCount > 1 ||
3984                 !isa<ObjCCategoryImplDecl>(overridden->getDeclContext())) {
3985               OverrideSearch overrides(*this, overridden);
3986               for (OverrideSearch::iterator
3987                      OI= overrides.begin(), OE= overrides.end(); OI!=OE; ++OI) {
3988                 ObjCMethodDecl *SuperOverridden = *OI;
3989                 if (isa<ObjCProtocolDecl>(SuperOverridden->getDeclContext()) ||
3990                     CurrentClass != SuperOverridden->getClassInterface()) {
3991                   hasOverriddenMethodsInBaseOrProtocol = true;
3992                   overridden->setOverriding(true);
3993                   break;
3994                 }
3995               }
3996             }
3997           }
3998         }
3999       }
4000     }
4001 
4002     // Propagate down the 'related result type' bit from overridden methods.
4003     if (RTC != Sema::RTC_Incompatible && overridden->hasRelatedResultType())
4004       ObjCMethod->SetRelatedResultType();
4005 
4006     // Then merge the declarations.
4007     mergeObjCMethodDecls(ObjCMethod, overridden);
4008 
4009     if (ObjCMethod->isImplicit() && overridden->isImplicit())
4010       continue; // Conflicting properties are detected elsewhere.
4011 
4012     // Check for overriding methods
4013     if (isa<ObjCInterfaceDecl>(ObjCMethod->getDeclContext()) ||
4014         isa<ObjCImplementationDecl>(ObjCMethod->getDeclContext()))
4015       CheckConflictingOverridingMethod(ObjCMethod, overridden,
4016               isa<ObjCProtocolDecl>(overridden->getDeclContext()));
4017 
4018     if (CurrentClass && overridden->getDeclContext() != CurrentClass &&
4019         isa<ObjCInterfaceDecl>(overridden->getDeclContext()) &&
4020         !overridden->isImplicit() /* not meant for properties */) {
4021       ObjCMethodDecl::param_iterator ParamI = ObjCMethod->param_begin(),
4022                                           E = ObjCMethod->param_end();
4023       ObjCMethodDecl::param_iterator PrevI = overridden->param_begin(),
4024                                      PrevE = overridden->param_end();
4025       for (; ParamI != E && PrevI != PrevE; ++ParamI, ++PrevI) {
4026         assert(PrevI != overridden->param_end() && "Param mismatch");
4027         QualType T1 = Context.getCanonicalType((*ParamI)->getType());
4028         QualType T2 = Context.getCanonicalType((*PrevI)->getType());
4029         // If type of argument of method in this class does not match its
4030         // respective argument type in the super class method, issue warning;
4031         if (!Context.typesAreCompatible(T1, T2)) {
4032           Diag((*ParamI)->getLocation(), diag::ext_typecheck_base_super)
4033             << T1 << T2;
4034           Diag(overridden->getLocation(), diag::note_previous_declaration);
4035           break;
4036         }
4037       }
4038     }
4039   }
4040 
4041   ObjCMethod->setOverriding(hasOverriddenMethodsInBaseOrProtocol);
4042 }
4043 
4044 /// Merge type nullability from for a redeclaration of the same entity,
4045 /// producing the updated type of the redeclared entity.
4046 static QualType mergeTypeNullabilityForRedecl(Sema &S, SourceLocation loc,
4047                                               QualType type,
4048                                               bool usesCSKeyword,
4049                                               SourceLocation prevLoc,
4050                                               QualType prevType,
4051                                               bool prevUsesCSKeyword) {
4052   // Determine the nullability of both types.
4053   auto nullability = type->getNullability(S.Context);
4054   auto prevNullability = prevType->getNullability(S.Context);
4055 
4056   // Easy case: both have nullability.
4057   if (nullability.hasValue() == prevNullability.hasValue()) {
4058     // Neither has nullability; continue.
4059     if (!nullability)
4060       return type;
4061 
4062     // The nullabilities are equivalent; do nothing.
4063     if (*nullability == *prevNullability)
4064       return type;
4065 
4066     // Complain about mismatched nullability.
4067     S.Diag(loc, diag::err_nullability_conflicting)
4068       << DiagNullabilityKind(*nullability, usesCSKeyword)
4069       << DiagNullabilityKind(*prevNullability, prevUsesCSKeyword);
4070     return type;
4071   }
4072 
4073   // If it's the redeclaration that has nullability, don't change anything.
4074   if (nullability)
4075     return type;
4076 
4077   // Otherwise, provide the result with the same nullability.
4078   return S.Context.getAttributedType(
4079            AttributedType::getNullabilityAttrKind(*prevNullability),
4080            type, type);
4081 }
4082 
4083 /// Merge information from the declaration of a method in the \@interface
4084 /// (or a category/extension) into the corresponding method in the
4085 /// @implementation (for a class or category).
4086 static void mergeInterfaceMethodToImpl(Sema &S,
4087                                        ObjCMethodDecl *method,
4088                                        ObjCMethodDecl *prevMethod) {
4089   // Merge the objc_requires_super attribute.
4090   if (prevMethod->hasAttr<ObjCRequiresSuperAttr>() &&
4091       !method->hasAttr<ObjCRequiresSuperAttr>()) {
4092     // merge the attribute into implementation.
4093     method->addAttr(
4094       ObjCRequiresSuperAttr::CreateImplicit(S.Context,
4095                                             method->getLocation()));
4096   }
4097 
4098   // Merge nullability of the result type.
4099   QualType newReturnType
4100     = mergeTypeNullabilityForRedecl(
4101         S, method->getReturnTypeSourceRange().getBegin(),
4102         method->getReturnType(),
4103         method->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability,
4104         prevMethod->getReturnTypeSourceRange().getBegin(),
4105         prevMethod->getReturnType(),
4106         prevMethod->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability);
4107   method->setReturnType(newReturnType);
4108 
4109   // Handle each of the parameters.
4110   unsigned numParams = method->param_size();
4111   unsigned numPrevParams = prevMethod->param_size();
4112   for (unsigned i = 0, n = std::min(numParams, numPrevParams); i != n; ++i) {
4113     ParmVarDecl *param = method->param_begin()[i];
4114     ParmVarDecl *prevParam = prevMethod->param_begin()[i];
4115 
4116     // Merge nullability.
4117     QualType newParamType
4118       = mergeTypeNullabilityForRedecl(
4119           S, param->getLocation(), param->getType(),
4120           param->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability,
4121           prevParam->getLocation(), prevParam->getType(),
4122           prevParam->getObjCDeclQualifier() & Decl::OBJC_TQ_CSNullability);
4123     param->setType(newParamType);
4124   }
4125 }
4126 
4127 Decl *Sema::ActOnMethodDeclaration(
4128     Scope *S,
4129     SourceLocation MethodLoc, SourceLocation EndLoc,
4130     tok::TokenKind MethodType,
4131     ObjCDeclSpec &ReturnQT, ParsedType ReturnType,
4132     ArrayRef<SourceLocation> SelectorLocs,
4133     Selector Sel,
4134     // optional arguments. The number of types/arguments is obtained
4135     // from the Sel.getNumArgs().
4136     ObjCArgInfo *ArgInfo,
4137     DeclaratorChunk::ParamInfo *CParamInfo, unsigned CNumArgs, // c-style args
4138     AttributeList *AttrList, tok::ObjCKeywordKind MethodDeclKind,
4139     bool isVariadic, bool MethodDefinition) {
4140   // Make sure we can establish a context for the method.
4141   if (!CurContext->isObjCContainer()) {
4142     Diag(MethodLoc, diag::error_missing_method_context);
4143     return nullptr;
4144   }
4145   ObjCContainerDecl *OCD = dyn_cast<ObjCContainerDecl>(CurContext);
4146   Decl *ClassDecl = cast<Decl>(OCD);
4147   QualType resultDeclType;
4148 
4149   bool HasRelatedResultType = false;
4150   TypeSourceInfo *ReturnTInfo = nullptr;
4151   if (ReturnType) {
4152     resultDeclType = GetTypeFromParser(ReturnType, &ReturnTInfo);
4153 
4154     if (CheckFunctionReturnType(resultDeclType, MethodLoc))
4155       return nullptr;
4156 
4157     QualType bareResultType = resultDeclType;
4158     (void)AttributedType::stripOuterNullability(bareResultType);
4159     HasRelatedResultType = (bareResultType == Context.getObjCInstanceType());
4160   } else { // get the type for "id".
4161     resultDeclType = Context.getObjCIdType();
4162     Diag(MethodLoc, diag::warn_missing_method_return_type)
4163       << FixItHint::CreateInsertion(SelectorLocs.front(), "(id)");
4164   }
4165 
4166   ObjCMethodDecl *ObjCMethod = ObjCMethodDecl::Create(
4167       Context, MethodLoc, EndLoc, Sel, resultDeclType, ReturnTInfo, CurContext,
4168       MethodType == tok::minus, isVariadic,
4169       /*isPropertyAccessor=*/false,
4170       /*isImplicitlyDeclared=*/false, /*isDefined=*/false,
4171       MethodDeclKind == tok::objc_optional ? ObjCMethodDecl::Optional
4172                                            : ObjCMethodDecl::Required,
4173       HasRelatedResultType);
4174 
4175   SmallVector<ParmVarDecl*, 16> Params;
4176 
4177   for (unsigned i = 0, e = Sel.getNumArgs(); i != e; ++i) {
4178     QualType ArgType;
4179     TypeSourceInfo *DI;
4180 
4181     if (!ArgInfo[i].Type) {
4182       ArgType = Context.getObjCIdType();
4183       DI = nullptr;
4184     } else {
4185       ArgType = GetTypeFromParser(ArgInfo[i].Type, &DI);
4186     }
4187 
4188     LookupResult R(*this, ArgInfo[i].Name, ArgInfo[i].NameLoc,
4189                    LookupOrdinaryName, ForRedeclaration);
4190     LookupName(R, S);
4191     if (R.isSingleResult()) {
4192       NamedDecl *PrevDecl = R.getFoundDecl();
4193       if (S->isDeclScope(PrevDecl)) {
4194         Diag(ArgInfo[i].NameLoc,
4195              (MethodDefinition ? diag::warn_method_param_redefinition
4196                                : diag::warn_method_param_declaration))
4197           << ArgInfo[i].Name;
4198         Diag(PrevDecl->getLocation(),
4199              diag::note_previous_declaration);
4200       }
4201     }
4202 
4203     SourceLocation StartLoc = DI
4204       ? DI->getTypeLoc().getBeginLoc()
4205       : ArgInfo[i].NameLoc;
4206 
4207     ParmVarDecl* Param = CheckParameter(ObjCMethod, StartLoc,
4208                                         ArgInfo[i].NameLoc, ArgInfo[i].Name,
4209                                         ArgType, DI, SC_None);
4210 
4211     Param->setObjCMethodScopeInfo(i);
4212 
4213     Param->setObjCDeclQualifier(
4214       CvtQTToAstBitMask(ArgInfo[i].DeclSpec.getObjCDeclQualifier()));
4215 
4216     // Apply the attributes to the parameter.
4217     ProcessDeclAttributeList(TUScope, Param, ArgInfo[i].ArgAttrs);
4218 
4219     if (Param->hasAttr<BlocksAttr>()) {
4220       Diag(Param->getLocation(), diag::err_block_on_nonlocal);
4221       Param->setInvalidDecl();
4222     }
4223     S->AddDecl(Param);
4224     IdResolver.AddDecl(Param);
4225 
4226     Params.push_back(Param);
4227   }
4228 
4229   for (unsigned i = 0, e = CNumArgs; i != e; ++i) {
4230     ParmVarDecl *Param = cast<ParmVarDecl>(CParamInfo[i].Param);
4231     QualType ArgType = Param->getType();
4232     if (ArgType.isNull())
4233       ArgType = Context.getObjCIdType();
4234     else
4235       // Perform the default array/function conversions (C99 6.7.5.3p[7,8]).
4236       ArgType = Context.getAdjustedParameterType(ArgType);
4237 
4238     Param->setDeclContext(ObjCMethod);
4239     Params.push_back(Param);
4240   }
4241 
4242   ObjCMethod->setMethodParams(Context, Params, SelectorLocs);
4243   ObjCMethod->setObjCDeclQualifier(
4244     CvtQTToAstBitMask(ReturnQT.getObjCDeclQualifier()));
4245 
4246   if (AttrList)
4247     ProcessDeclAttributeList(TUScope, ObjCMethod, AttrList);
4248 
4249   // Add the method now.
4250   const ObjCMethodDecl *PrevMethod = nullptr;
4251   if (ObjCImplDecl *ImpDecl = dyn_cast<ObjCImplDecl>(ClassDecl)) {
4252     if (MethodType == tok::minus) {
4253       PrevMethod = ImpDecl->getInstanceMethod(Sel);
4254       ImpDecl->addInstanceMethod(ObjCMethod);
4255     } else {
4256       PrevMethod = ImpDecl->getClassMethod(Sel);
4257       ImpDecl->addClassMethod(ObjCMethod);
4258     }
4259 
4260     // Merge information from the @interface declaration into the
4261     // @implementation.
4262     if (ObjCInterfaceDecl *IDecl = ImpDecl->getClassInterface()) {
4263       if (auto *IMD = IDecl->lookupMethod(ObjCMethod->getSelector(),
4264                                           ObjCMethod->isInstanceMethod())) {
4265         mergeInterfaceMethodToImpl(*this, ObjCMethod, IMD);
4266 
4267         // Warn about defining -dealloc in a category.
4268         if (isa<ObjCCategoryImplDecl>(ImpDecl) && IMD->isOverriding() &&
4269             ObjCMethod->getSelector().getMethodFamily() == OMF_dealloc) {
4270           Diag(ObjCMethod->getLocation(), diag::warn_dealloc_in_category)
4271             << ObjCMethod->getDeclName();
4272         }
4273       }
4274     }
4275   } else {
4276     cast<DeclContext>(ClassDecl)->addDecl(ObjCMethod);
4277   }
4278 
4279   if (PrevMethod) {
4280     // You can never have two method definitions with the same name.
4281     Diag(ObjCMethod->getLocation(), diag::err_duplicate_method_decl)
4282       << ObjCMethod->getDeclName();
4283     Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
4284     ObjCMethod->setInvalidDecl();
4285     return ObjCMethod;
4286   }
4287 
4288   // If this Objective-C method does not have a related result type, but we
4289   // are allowed to infer related result types, try to do so based on the
4290   // method family.
4291   ObjCInterfaceDecl *CurrentClass = dyn_cast<ObjCInterfaceDecl>(ClassDecl);
4292   if (!CurrentClass) {
4293     if (ObjCCategoryDecl *Cat = dyn_cast<ObjCCategoryDecl>(ClassDecl))
4294       CurrentClass = Cat->getClassInterface();
4295     else if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(ClassDecl))
4296       CurrentClass = Impl->getClassInterface();
4297     else if (ObjCCategoryImplDecl *CatImpl
4298                                    = dyn_cast<ObjCCategoryImplDecl>(ClassDecl))
4299       CurrentClass = CatImpl->getClassInterface();
4300   }
4301 
4302   ResultTypeCompatibilityKind RTC
4303     = CheckRelatedResultTypeCompatibility(*this, ObjCMethod, CurrentClass);
4304 
4305   CheckObjCMethodOverrides(ObjCMethod, CurrentClass, RTC);
4306 
4307   bool ARCError = false;
4308   if (getLangOpts().ObjCAutoRefCount)
4309     ARCError = CheckARCMethodDecl(ObjCMethod);
4310 
4311   // Infer the related result type when possible.
4312   if (!ARCError && RTC == Sema::RTC_Compatible &&
4313       !ObjCMethod->hasRelatedResultType() &&
4314       LangOpts.ObjCInferRelatedResultType) {
4315     bool InferRelatedResultType = false;
4316     switch (ObjCMethod->getMethodFamily()) {
4317     case OMF_None:
4318     case OMF_copy:
4319     case OMF_dealloc:
4320     case OMF_finalize:
4321     case OMF_mutableCopy:
4322     case OMF_release:
4323     case OMF_retainCount:
4324     case OMF_initialize:
4325     case OMF_performSelector:
4326       break;
4327 
4328     case OMF_alloc:
4329     case OMF_new:
4330         InferRelatedResultType = ObjCMethod->isClassMethod();
4331       break;
4332 
4333     case OMF_init:
4334     case OMF_autorelease:
4335     case OMF_retain:
4336     case OMF_self:
4337       InferRelatedResultType = ObjCMethod->isInstanceMethod();
4338       break;
4339     }
4340 
4341     if (InferRelatedResultType &&
4342         !ObjCMethod->getReturnType()->isObjCIndependentClassType())
4343       ObjCMethod->SetRelatedResultType();
4344   }
4345 
4346   ActOnDocumentableDecl(ObjCMethod);
4347 
4348   return ObjCMethod;
4349 }
4350 
4351 bool Sema::CheckObjCDeclScope(Decl *D) {
4352   // Following is also an error. But it is caused by a missing @end
4353   // and diagnostic is issued elsewhere.
4354   if (isa<ObjCContainerDecl>(CurContext->getRedeclContext()))
4355     return false;
4356 
4357   // If we switched context to translation unit while we are still lexically in
4358   // an objc container, it means the parser missed emitting an error.
4359   if (isa<TranslationUnitDecl>(getCurLexicalContext()->getRedeclContext()))
4360     return false;
4361 
4362   Diag(D->getLocation(), diag::err_objc_decls_may_only_appear_in_global_scope);
4363   D->setInvalidDecl();
4364 
4365   return true;
4366 }
4367 
4368 /// Called whenever \@defs(ClassName) is encountered in the source.  Inserts the
4369 /// instance variables of ClassName into Decls.
4370 void Sema::ActOnDefs(Scope *S, Decl *TagD, SourceLocation DeclStart,
4371                      IdentifierInfo *ClassName,
4372                      SmallVectorImpl<Decl*> &Decls) {
4373   // Check that ClassName is a valid class
4374   ObjCInterfaceDecl *Class = getObjCInterfaceDecl(ClassName, DeclStart);
4375   if (!Class) {
4376     Diag(DeclStart, diag::err_undef_interface) << ClassName;
4377     return;
4378   }
4379   if (LangOpts.ObjCRuntime.isNonFragile()) {
4380     Diag(DeclStart, diag::err_atdef_nonfragile_interface);
4381     return;
4382   }
4383 
4384   // Collect the instance variables
4385   SmallVector<const ObjCIvarDecl*, 32> Ivars;
4386   Context.DeepCollectObjCIvars(Class, true, Ivars);
4387   // For each ivar, create a fresh ObjCAtDefsFieldDecl.
4388   for (unsigned i = 0; i < Ivars.size(); i++) {
4389     const FieldDecl* ID = cast<FieldDecl>(Ivars[i]);
4390     RecordDecl *Record = dyn_cast<RecordDecl>(TagD);
4391     Decl *FD = ObjCAtDefsFieldDecl::Create(Context, Record,
4392                                            /*FIXME: StartL=*/ID->getLocation(),
4393                                            ID->getLocation(),
4394                                            ID->getIdentifier(), ID->getType(),
4395                                            ID->getBitWidth());
4396     Decls.push_back(FD);
4397   }
4398 
4399   // Introduce all of these fields into the appropriate scope.
4400   for (SmallVectorImpl<Decl*>::iterator D = Decls.begin();
4401        D != Decls.end(); ++D) {
4402     FieldDecl *FD = cast<FieldDecl>(*D);
4403     if (getLangOpts().CPlusPlus)
4404       PushOnScopeChains(cast<FieldDecl>(FD), S);
4405     else if (RecordDecl *Record = dyn_cast<RecordDecl>(TagD))
4406       Record->addDecl(FD);
4407   }
4408 }
4409 
4410 /// \brief Build a type-check a new Objective-C exception variable declaration.
4411 VarDecl *Sema::BuildObjCExceptionDecl(TypeSourceInfo *TInfo, QualType T,
4412                                       SourceLocation StartLoc,
4413                                       SourceLocation IdLoc,
4414                                       IdentifierInfo *Id,
4415                                       bool Invalid) {
4416   // ISO/IEC TR 18037 S6.7.3: "The type of an object with automatic storage
4417   // duration shall not be qualified by an address-space qualifier."
4418   // Since all parameters have automatic store duration, they can not have
4419   // an address space.
4420   if (T.getAddressSpace() != 0) {
4421     Diag(IdLoc, diag::err_arg_with_address_space);
4422     Invalid = true;
4423   }
4424 
4425   // An @catch parameter must be an unqualified object pointer type;
4426   // FIXME: Recover from "NSObject foo" by inserting the * in "NSObject *foo"?
4427   if (Invalid) {
4428     // Don't do any further checking.
4429   } else if (T->isDependentType()) {
4430     // Okay: we don't know what this type will instantiate to.
4431   } else if (!T->isObjCObjectPointerType()) {
4432     Invalid = true;
4433     Diag(IdLoc ,diag::err_catch_param_not_objc_type);
4434   } else if (T->isObjCQualifiedIdType()) {
4435     Invalid = true;
4436     Diag(IdLoc, diag::err_illegal_qualifiers_on_catch_parm);
4437   }
4438 
4439   VarDecl *New = VarDecl::Create(Context, CurContext, StartLoc, IdLoc, Id,
4440                                  T, TInfo, SC_None);
4441   New->setExceptionVariable(true);
4442 
4443   // In ARC, infer 'retaining' for variables of retainable type.
4444   if (getLangOpts().ObjCAutoRefCount && inferObjCARCLifetime(New))
4445     Invalid = true;
4446 
4447   if (Invalid)
4448     New->setInvalidDecl();
4449   return New;
4450 }
4451 
4452 Decl *Sema::ActOnObjCExceptionDecl(Scope *S, Declarator &D) {
4453   const DeclSpec &DS = D.getDeclSpec();
4454 
4455   // We allow the "register" storage class on exception variables because
4456   // GCC did, but we drop it completely. Any other storage class is an error.
4457   if (DS.getStorageClassSpec() == DeclSpec::SCS_register) {
4458     Diag(DS.getStorageClassSpecLoc(), diag::warn_register_objc_catch_parm)
4459       << FixItHint::CreateRemoval(SourceRange(DS.getStorageClassSpecLoc()));
4460   } else if (DeclSpec::SCS SCS = DS.getStorageClassSpec()) {
4461     Diag(DS.getStorageClassSpecLoc(), diag::err_storage_spec_on_catch_parm)
4462       << DeclSpec::getSpecifierName(SCS);
4463   }
4464   if (DeclSpec::TSCS TSCS = D.getDeclSpec().getThreadStorageClassSpec())
4465     Diag(D.getDeclSpec().getThreadStorageClassSpecLoc(),
4466          diag::err_invalid_thread)
4467      << DeclSpec::getSpecifierName(TSCS);
4468   D.getMutableDeclSpec().ClearStorageClassSpecs();
4469 
4470   DiagnoseFunctionSpecifiers(D.getDeclSpec());
4471 
4472   // Check that there are no default arguments inside the type of this
4473   // exception object (C++ only).
4474   if (getLangOpts().CPlusPlus)
4475     CheckExtraCXXDefaultArguments(D);
4476 
4477   TypeSourceInfo *TInfo = GetTypeForDeclarator(D, S);
4478   QualType ExceptionType = TInfo->getType();
4479 
4480   VarDecl *New = BuildObjCExceptionDecl(TInfo, ExceptionType,
4481                                         D.getSourceRange().getBegin(),
4482                                         D.getIdentifierLoc(),
4483                                         D.getIdentifier(),
4484                                         D.isInvalidType());
4485 
4486   // Parameter declarators cannot be qualified (C++ [dcl.meaning]p1).
4487   if (D.getCXXScopeSpec().isSet()) {
4488     Diag(D.getIdentifierLoc(), diag::err_qualified_objc_catch_parm)
4489       << D.getCXXScopeSpec().getRange();
4490     New->setInvalidDecl();
4491   }
4492 
4493   // Add the parameter declaration into this scope.
4494   S->AddDecl(New);
4495   if (D.getIdentifier())
4496     IdResolver.AddDecl(New);
4497 
4498   ProcessDeclAttributes(S, New, D);
4499 
4500   if (New->hasAttr<BlocksAttr>())
4501     Diag(New->getLocation(), diag::err_block_on_nonlocal);
4502   return New;
4503 }
4504 
4505 /// CollectIvarsToConstructOrDestruct - Collect those ivars which require
4506 /// initialization.
4507 void Sema::CollectIvarsToConstructOrDestruct(ObjCInterfaceDecl *OI,
4508                                 SmallVectorImpl<ObjCIvarDecl*> &Ivars) {
4509   for (ObjCIvarDecl *Iv = OI->all_declared_ivar_begin(); Iv;
4510        Iv= Iv->getNextIvar()) {
4511     QualType QT = Context.getBaseElementType(Iv->getType());
4512     if (QT->isRecordType())
4513       Ivars.push_back(Iv);
4514   }
4515 }
4516 
4517 void Sema::DiagnoseUseOfUnimplementedSelectors() {
4518   // Load referenced selectors from the external source.
4519   if (ExternalSource) {
4520     SmallVector<std::pair<Selector, SourceLocation>, 4> Sels;
4521     ExternalSource->ReadReferencedSelectors(Sels);
4522     for (unsigned I = 0, N = Sels.size(); I != N; ++I)
4523       ReferencedSelectors[Sels[I].first] = Sels[I].second;
4524   }
4525 
4526   // Warning will be issued only when selector table is
4527   // generated (which means there is at lease one implementation
4528   // in the TU). This is to match gcc's behavior.
4529   if (ReferencedSelectors.empty() ||
4530       !Context.AnyObjCImplementation())
4531     return;
4532   for (auto &SelectorAndLocation : ReferencedSelectors) {
4533     Selector Sel = SelectorAndLocation.first;
4534     SourceLocation Loc = SelectorAndLocation.second;
4535     if (!LookupImplementedMethodInGlobalPool(Sel))
4536       Diag(Loc, diag::warn_unimplemented_selector) << Sel;
4537   }
4538 }
4539 
4540 ObjCIvarDecl *
4541 Sema::GetIvarBackingPropertyAccessor(const ObjCMethodDecl *Method,
4542                                      const ObjCPropertyDecl *&PDecl) const {
4543   if (Method->isClassMethod())
4544     return nullptr;
4545   const ObjCInterfaceDecl *IDecl = Method->getClassInterface();
4546   if (!IDecl)
4547     return nullptr;
4548   Method = IDecl->lookupMethod(Method->getSelector(), /*isInstance=*/true,
4549                                /*shallowCategoryLookup=*/false,
4550                                /*followSuper=*/false);
4551   if (!Method || !Method->isPropertyAccessor())
4552     return nullptr;
4553   if ((PDecl = Method->findPropertyDecl()))
4554     if (ObjCIvarDecl *IV = PDecl->getPropertyIvarDecl()) {
4555       // property backing ivar must belong to property's class
4556       // or be a private ivar in class's implementation.
4557       // FIXME. fix the const-ness issue.
4558       IV = const_cast<ObjCInterfaceDecl *>(IDecl)->lookupInstanceVariable(
4559                                                         IV->getIdentifier());
4560       return IV;
4561     }
4562   return nullptr;
4563 }
4564 
4565 namespace {
4566   /// Used by Sema::DiagnoseUnusedBackingIvarInAccessor to check if a property
4567   /// accessor references the backing ivar.
4568   class UnusedBackingIvarChecker :
4569       public RecursiveASTVisitor<UnusedBackingIvarChecker> {
4570   public:
4571     Sema &S;
4572     const ObjCMethodDecl *Method;
4573     const ObjCIvarDecl *IvarD;
4574     bool AccessedIvar;
4575     bool InvokedSelfMethod;
4576 
4577     UnusedBackingIvarChecker(Sema &S, const ObjCMethodDecl *Method,
4578                              const ObjCIvarDecl *IvarD)
4579       : S(S), Method(Method), IvarD(IvarD),
4580         AccessedIvar(false), InvokedSelfMethod(false) {
4581       assert(IvarD);
4582     }
4583 
4584     bool VisitObjCIvarRefExpr(ObjCIvarRefExpr *E) {
4585       if (E->getDecl() == IvarD) {
4586         AccessedIvar = true;
4587         return false;
4588       }
4589       return true;
4590     }
4591 
4592     bool VisitObjCMessageExpr(ObjCMessageExpr *E) {
4593       if (E->getReceiverKind() == ObjCMessageExpr::Instance &&
4594           S.isSelfExpr(E->getInstanceReceiver(), Method)) {
4595         InvokedSelfMethod = true;
4596       }
4597       return true;
4598     }
4599   };
4600 } // end anonymous namespace
4601 
4602 void Sema::DiagnoseUnusedBackingIvarInAccessor(Scope *S,
4603                                           const ObjCImplementationDecl *ImplD) {
4604   if (S->hasUnrecoverableErrorOccurred())
4605     return;
4606 
4607   for (const auto *CurMethod : ImplD->instance_methods()) {
4608     unsigned DIAG = diag::warn_unused_property_backing_ivar;
4609     SourceLocation Loc = CurMethod->getLocation();
4610     if (Diags.isIgnored(DIAG, Loc))
4611       continue;
4612 
4613     const ObjCPropertyDecl *PDecl;
4614     const ObjCIvarDecl *IV = GetIvarBackingPropertyAccessor(CurMethod, PDecl);
4615     if (!IV)
4616       continue;
4617 
4618     UnusedBackingIvarChecker Checker(*this, CurMethod, IV);
4619     Checker.TraverseStmt(CurMethod->getBody());
4620     if (Checker.AccessedIvar)
4621       continue;
4622 
4623     // Do not issue this warning if backing ivar is used somewhere and accessor
4624     // implementation makes a self call. This is to prevent false positive in
4625     // cases where the ivar is accessed by another method that the accessor
4626     // delegates to.
4627     if (!IV->isReferenced() || !Checker.InvokedSelfMethod) {
4628       Diag(Loc, DIAG) << IV;
4629       Diag(PDecl->getLocation(), diag::note_property_declare);
4630     }
4631   }
4632 }
4633