SemaDeclObjC.cpp revision 5f9e272e632e951b1efe824cd16acb4d96077930
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/Sema/Lookup.h"
16#include "clang/Sema/ExternalSemaSource.h"
17#include "clang/Sema/Scope.h"
18#include "clang/Sema/ScopeInfo.h"
19#include "clang/AST/ASTConsumer.h"
20#include "clang/AST/Expr.h"
21#include "clang/AST/ExprObjC.h"
22#include "clang/AST/ASTContext.h"
23#include "clang/AST/DeclObjC.h"
24#include "clang/Basic/SourceManager.h"
25#include "clang/Sema/DeclSpec.h"
26#include "llvm/ADT/DenseSet.h"
27
28using namespace clang;
29
30/// Check whether the given method, which must be in the 'init'
31/// family, is a valid member of that family.
32///
33/// \param receiverTypeIfCall - if null, check this as if declaring it;
34///   if non-null, check this as if making a call to it with the given
35///   receiver type
36///
37/// \return true to indicate that there was an error and appropriate
38///   actions were taken
39bool Sema::checkInitMethod(ObjCMethodDecl *method,
40                           QualType receiverTypeIfCall) {
41  if (method->isInvalidDecl()) return true;
42
43  // This castAs is safe: methods that don't return an object
44  // pointer won't be inferred as inits and will reject an explicit
45  // objc_method_family(init).
46
47  // We ignore protocols here.  Should we?  What about Class?
48
49  const ObjCObjectType *result = method->getResultType()
50    ->castAs<ObjCObjectPointerType>()->getObjectType();
51
52  if (result->isObjCId()) {
53    return false;
54  } else if (result->isObjCClass()) {
55    // fall through: always an error
56  } else {
57    ObjCInterfaceDecl *resultClass = result->getInterface();
58    assert(resultClass && "unexpected object type!");
59
60    // It's okay for the result type to still be a forward declaration
61    // if we're checking an interface declaration.
62    if (resultClass->isForwardDecl()) {
63      if (receiverTypeIfCall.isNull() &&
64          !isa<ObjCImplementationDecl>(method->getDeclContext()))
65        return false;
66
67    // Otherwise, we try to compare class types.
68    } else {
69      // If this method was declared in a protocol, we can't check
70      // anything unless we have a receiver type that's an interface.
71      const ObjCInterfaceDecl *receiverClass = 0;
72      if (isa<ObjCProtocolDecl>(method->getDeclContext())) {
73        if (receiverTypeIfCall.isNull())
74          return false;
75
76        receiverClass = receiverTypeIfCall->castAs<ObjCObjectPointerType>()
77          ->getInterfaceDecl();
78
79        // This can be null for calls to e.g. id<Foo>.
80        if (!receiverClass) return false;
81      } else {
82        receiverClass = method->getClassInterface();
83        assert(receiverClass && "method not associated with a class!");
84      }
85
86      // If either class is a subclass of the other, it's fine.
87      if (receiverClass->isSuperClassOf(resultClass) ||
88          resultClass->isSuperClassOf(receiverClass))
89        return false;
90    }
91  }
92
93  SourceLocation loc = method->getLocation();
94
95  // If we're in a system header, and this is not a call, just make
96  // the method unusable.
97  if (receiverTypeIfCall.isNull() && getSourceManager().isInSystemHeader(loc)) {
98    method->addAttr(new (Context) UnavailableAttr(loc, Context,
99                "init method returns a type unrelated to its receiver type"));
100    return true;
101  }
102
103  // Otherwise, it's an error.
104  Diag(loc, diag::err_arc_init_method_unrelated_result_type);
105  method->setInvalidDecl();
106  return true;
107}
108
109bool Sema::CheckObjCMethodOverride(ObjCMethodDecl *NewMethod,
110                                   const ObjCMethodDecl *Overridden,
111                                   bool IsImplementation) {
112  if (Overridden->hasRelatedResultType() &&
113      !NewMethod->hasRelatedResultType()) {
114    // This can only happen when the method follows a naming convention that
115    // implies a related result type, and the original (overridden) method has
116    // a suitable return type, but the new (overriding) method does not have
117    // a suitable return type.
118    QualType ResultType = NewMethod->getResultType();
119    SourceRange ResultTypeRange;
120    if (const TypeSourceInfo *ResultTypeInfo
121                                        = NewMethod->getResultTypeSourceInfo())
122      ResultTypeRange = ResultTypeInfo->getTypeLoc().getSourceRange();
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    Diag(Overridden->getLocation(), diag::note_related_result_type_overridden)
152      << Overridden->getMethodFamily();
153  }
154
155  return false;
156}
157
158/// \brief Check a method declaration for compatibility with the Objective-C
159/// ARC conventions.
160static bool CheckARCMethodDecl(Sema &S, ObjCMethodDecl *method) {
161  ObjCMethodFamily family = method->getMethodFamily();
162  switch (family) {
163  case OMF_None:
164  case OMF_dealloc:
165  case OMF_retain:
166  case OMF_release:
167  case OMF_autorelease:
168  case OMF_retainCount:
169  case OMF_self:
170  case OMF_performSelector:
171    return false;
172
173  case OMF_init:
174    // If the method doesn't obey the init rules, don't bother annotating it.
175    if (S.checkInitMethod(method, QualType()))
176      return true;
177
178    method->addAttr(new (S.Context) NSConsumesSelfAttr(SourceLocation(),
179                                                       S.Context));
180
181    // Don't add a second copy of this attribute, but otherwise don't
182    // let it be suppressed.
183    if (method->hasAttr<NSReturnsRetainedAttr>())
184      return false;
185    break;
186
187  case OMF_alloc:
188  case OMF_copy:
189  case OMF_mutableCopy:
190  case OMF_new:
191    if (method->hasAttr<NSReturnsRetainedAttr>() ||
192        method->hasAttr<NSReturnsNotRetainedAttr>() ||
193        method->hasAttr<NSReturnsAutoreleasedAttr>())
194      return false;
195    break;
196  }
197
198  method->addAttr(new (S.Context) NSReturnsRetainedAttr(SourceLocation(),
199                                                        S.Context));
200  return false;
201}
202
203static void DiagnoseObjCImplementedDeprecations(Sema &S,
204                                                NamedDecl *ND,
205                                                SourceLocation ImplLoc,
206                                                int select) {
207  if (ND && ND->isDeprecated()) {
208    S.Diag(ImplLoc, diag::warn_deprecated_def) << select;
209    if (select == 0)
210      S.Diag(ND->getLocation(), diag::note_method_declared_at);
211    else
212      S.Diag(ND->getLocation(), diag::note_previous_decl) << "class";
213  }
214}
215
216/// ActOnStartOfObjCMethodDef - This routine sets up parameters; invisible
217/// and user declared, in the method definition's AST.
218void Sema::ActOnStartOfObjCMethodDef(Scope *FnBodyScope, Decl *D) {
219  assert(getCurMethodDecl() == 0 && "Method parsing confused");
220  ObjCMethodDecl *MDecl = dyn_cast_or_null<ObjCMethodDecl>(D);
221
222  // If we don't have a valid method decl, simply return.
223  if (!MDecl)
224    return;
225
226  // Allow the rest of sema to find private method decl implementations.
227  if (MDecl->isInstanceMethod())
228    AddInstanceMethodToGlobalPool(MDecl, true);
229  else
230    AddFactoryMethodToGlobalPool(MDecl, true);
231
232  // Allow all of Sema to see that we are entering a method definition.
233  PushDeclContext(FnBodyScope, MDecl);
234  PushFunctionScope();
235
236  // Create Decl objects for each parameter, entrring them in the scope for
237  // binding to their use.
238
239  // Insert the invisible arguments, self and _cmd!
240  MDecl->createImplicitParams(Context, MDecl->getClassInterface());
241
242  PushOnScopeChains(MDecl->getSelfDecl(), FnBodyScope);
243  PushOnScopeChains(MDecl->getCmdDecl(), FnBodyScope);
244
245  // Introduce all of the other parameters into this scope.
246  for (ObjCMethodDecl::param_iterator PI = MDecl->param_begin(),
247       E = MDecl->param_end(); PI != E; ++PI) {
248    ParmVarDecl *Param = (*PI);
249    if (!Param->isInvalidDecl() &&
250        RequireCompleteType(Param->getLocation(), Param->getType(),
251                            diag::err_typecheck_decl_incomplete_type))
252          Param->setInvalidDecl();
253    if ((*PI)->getIdentifier())
254      PushOnScopeChains(*PI, FnBodyScope);
255  }
256
257  // In ARC, disallow definition of retain/release/autorelease/retainCount
258  if (getLangOptions().ObjCAutoRefCount) {
259    switch (MDecl->getMethodFamily()) {
260    case OMF_retain:
261    case OMF_retainCount:
262    case OMF_release:
263    case OMF_autorelease:
264      Diag(MDecl->getLocation(), diag::err_arc_illegal_method_def)
265        << MDecl->getSelector();
266      break;
267
268    case OMF_None:
269    case OMF_dealloc:
270    case OMF_alloc:
271    case OMF_init:
272    case OMF_mutableCopy:
273    case OMF_copy:
274    case OMF_new:
275    case OMF_self:
276    case OMF_performSelector:
277      break;
278    }
279  }
280
281  // Warn on implementating deprecated methods under
282  // -Wdeprecated-implementations flag.
283  if (ObjCInterfaceDecl *IC = MDecl->getClassInterface())
284    if (ObjCMethodDecl *IMD =
285          IC->lookupMethod(MDecl->getSelector(), MDecl->isInstanceMethod()))
286      DiagnoseObjCImplementedDeprecations(*this,
287                                          dyn_cast<NamedDecl>(IMD),
288                                          MDecl->getLocation(), 0);
289}
290
291Decl *Sema::
292ActOnStartClassInterface(SourceLocation AtInterfaceLoc,
293                         IdentifierInfo *ClassName, SourceLocation ClassLoc,
294                         IdentifierInfo *SuperName, SourceLocation SuperLoc,
295                         Decl * const *ProtoRefs, unsigned NumProtoRefs,
296                         const SourceLocation *ProtoLocs,
297                         SourceLocation EndProtoLoc, AttributeList *AttrList) {
298  assert(ClassName && "Missing class identifier");
299
300  // Check for another declaration kind with the same name.
301  NamedDecl *PrevDecl = LookupSingleName(TUScope, ClassName, ClassLoc,
302                                         LookupOrdinaryName, ForRedeclaration);
303
304  if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
305    Diag(ClassLoc, diag::err_redefinition_different_kind) << ClassName;
306    Diag(PrevDecl->getLocation(), diag::note_previous_definition);
307  }
308
309  ObjCInterfaceDecl* IDecl = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
310  if (IDecl) {
311    // Class already seen. Is it a forward declaration?
312    if (!IDecl->isForwardDecl()) {
313      IDecl->setInvalidDecl();
314      Diag(AtInterfaceLoc, diag::err_duplicate_class_def)<<IDecl->getDeclName();
315      Diag(IDecl->getLocation(), diag::note_previous_definition);
316
317      // Return the previous class interface.
318      // FIXME: don't leak the objects passed in!
319      return IDecl;
320    } else {
321      IDecl->setLocation(AtInterfaceLoc);
322      IDecl->setForwardDecl(false);
323      IDecl->setClassLoc(ClassLoc);
324      // If the forward decl was in a PCH, we need to write it again in a
325      // dependent AST file.
326      IDecl->setChangedSinceDeserialization(true);
327
328      // Since this ObjCInterfaceDecl was created by a forward declaration,
329      // we now add it to the DeclContext since it wasn't added before
330      // (see ActOnForwardClassDeclaration).
331      IDecl->setLexicalDeclContext(CurContext);
332      CurContext->addDecl(IDecl);
333
334      if (AttrList)
335        ProcessDeclAttributeList(TUScope, IDecl, AttrList);
336    }
337  } else {
338    IDecl = ObjCInterfaceDecl::Create(Context, CurContext, AtInterfaceLoc,
339                                      ClassName, ClassLoc);
340    if (AttrList)
341      ProcessDeclAttributeList(TUScope, IDecl, AttrList);
342
343    PushOnScopeChains(IDecl, TUScope);
344  }
345
346  if (SuperName) {
347    // Check if a different kind of symbol declared in this scope.
348    PrevDecl = LookupSingleName(TUScope, SuperName, SuperLoc,
349                                LookupOrdinaryName);
350
351    if (!PrevDecl) {
352      // Try to correct for a typo in the superclass name.
353      TypoCorrection Corrected = CorrectTypo(
354          DeclarationNameInfo(SuperName, SuperLoc), LookupOrdinaryName, TUScope,
355          NULL, NULL, false, CTC_NoKeywords);
356      if ((PrevDecl = Corrected.getCorrectionDeclAs<ObjCInterfaceDecl>())) {
357        Diag(SuperLoc, diag::err_undef_superclass_suggest)
358          << SuperName << ClassName << PrevDecl->getDeclName();
359        Diag(PrevDecl->getLocation(), diag::note_previous_decl)
360          << PrevDecl->getDeclName();
361      }
362    }
363
364    if (PrevDecl == IDecl) {
365      Diag(SuperLoc, diag::err_recursive_superclass)
366        << SuperName << ClassName << SourceRange(AtInterfaceLoc, ClassLoc);
367      IDecl->setLocEnd(ClassLoc);
368    } else {
369      ObjCInterfaceDecl *SuperClassDecl =
370                                dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
371
372      // Diagnose classes that inherit from deprecated classes.
373      if (SuperClassDecl)
374        (void)DiagnoseUseOfDecl(SuperClassDecl, SuperLoc);
375
376      if (PrevDecl && SuperClassDecl == 0) {
377        // The previous declaration was not a class decl. Check if we have a
378        // typedef. If we do, get the underlying class type.
379        if (const TypedefNameDecl *TDecl =
380              dyn_cast_or_null<TypedefNameDecl>(PrevDecl)) {
381          QualType T = TDecl->getUnderlyingType();
382          if (T->isObjCObjectType()) {
383            if (NamedDecl *IDecl = T->getAs<ObjCObjectType>()->getInterface())
384              SuperClassDecl = dyn_cast<ObjCInterfaceDecl>(IDecl);
385          }
386        }
387
388        // This handles the following case:
389        //
390        // typedef int SuperClass;
391        // @interface MyClass : SuperClass {} @end
392        //
393        if (!SuperClassDecl) {
394          Diag(SuperLoc, diag::err_redefinition_different_kind) << SuperName;
395          Diag(PrevDecl->getLocation(), diag::note_previous_definition);
396        }
397      }
398
399      if (!dyn_cast_or_null<TypedefNameDecl>(PrevDecl)) {
400        if (!SuperClassDecl)
401          Diag(SuperLoc, diag::err_undef_superclass)
402            << SuperName << ClassName << SourceRange(AtInterfaceLoc, ClassLoc);
403        else if (SuperClassDecl->isForwardDecl()) {
404          Diag(SuperLoc, diag::err_forward_superclass)
405            << SuperClassDecl->getDeclName() << ClassName
406            << SourceRange(AtInterfaceLoc, ClassLoc);
407          Diag(SuperClassDecl->getLocation(), diag::note_forward_class);
408          SuperClassDecl = 0;
409        }
410      }
411      IDecl->setSuperClass(SuperClassDecl);
412      IDecl->setSuperClassLoc(SuperLoc);
413      IDecl->setLocEnd(SuperLoc);
414    }
415  } else { // we have a root class.
416    IDecl->setLocEnd(ClassLoc);
417  }
418
419  // Check then save referenced protocols.
420  if (NumProtoRefs) {
421    IDecl->setProtocolList((ObjCProtocolDecl**)ProtoRefs, NumProtoRefs,
422                           ProtoLocs, Context);
423    IDecl->setLocEnd(EndProtoLoc);
424  }
425
426  CheckObjCDeclScope(IDecl);
427  return IDecl;
428}
429
430/// ActOnCompatiblityAlias - this action is called after complete parsing of
431/// @compatibility_alias declaration. It sets up the alias relationships.
432Decl *Sema::ActOnCompatiblityAlias(SourceLocation AtLoc,
433                                        IdentifierInfo *AliasName,
434                                        SourceLocation AliasLocation,
435                                        IdentifierInfo *ClassName,
436                                        SourceLocation ClassLocation) {
437  // Look for previous declaration of alias name
438  NamedDecl *ADecl = LookupSingleName(TUScope, AliasName, AliasLocation,
439                                      LookupOrdinaryName, ForRedeclaration);
440  if (ADecl) {
441    if (isa<ObjCCompatibleAliasDecl>(ADecl))
442      Diag(AliasLocation, diag::warn_previous_alias_decl);
443    else
444      Diag(AliasLocation, diag::err_conflicting_aliasing_type) << AliasName;
445    Diag(ADecl->getLocation(), diag::note_previous_declaration);
446    return 0;
447  }
448  // Check for class declaration
449  NamedDecl *CDeclU = LookupSingleName(TUScope, ClassName, ClassLocation,
450                                       LookupOrdinaryName, ForRedeclaration);
451  if (const TypedefNameDecl *TDecl =
452        dyn_cast_or_null<TypedefNameDecl>(CDeclU)) {
453    QualType T = TDecl->getUnderlyingType();
454    if (T->isObjCObjectType()) {
455      if (NamedDecl *IDecl = T->getAs<ObjCObjectType>()->getInterface()) {
456        ClassName = IDecl->getIdentifier();
457        CDeclU = LookupSingleName(TUScope, ClassName, ClassLocation,
458                                  LookupOrdinaryName, ForRedeclaration);
459      }
460    }
461  }
462  ObjCInterfaceDecl *CDecl = dyn_cast_or_null<ObjCInterfaceDecl>(CDeclU);
463  if (CDecl == 0) {
464    Diag(ClassLocation, diag::warn_undef_interface) << ClassName;
465    if (CDeclU)
466      Diag(CDeclU->getLocation(), diag::note_previous_declaration);
467    return 0;
468  }
469
470  // Everything checked out, instantiate a new alias declaration AST.
471  ObjCCompatibleAliasDecl *AliasDecl =
472    ObjCCompatibleAliasDecl::Create(Context, CurContext, AtLoc, AliasName, CDecl);
473
474  if (!CheckObjCDeclScope(AliasDecl))
475    PushOnScopeChains(AliasDecl, TUScope);
476
477  return AliasDecl;
478}
479
480bool Sema::CheckForwardProtocolDeclarationForCircularDependency(
481  IdentifierInfo *PName,
482  SourceLocation &Ploc, SourceLocation PrevLoc,
483  const ObjCList<ObjCProtocolDecl> &PList) {
484
485  bool res = false;
486  for (ObjCList<ObjCProtocolDecl>::iterator I = PList.begin(),
487       E = PList.end(); I != E; ++I) {
488    if (ObjCProtocolDecl *PDecl = LookupProtocol((*I)->getIdentifier(),
489                                                 Ploc)) {
490      if (PDecl->getIdentifier() == PName) {
491        Diag(Ploc, diag::err_protocol_has_circular_dependency);
492        Diag(PrevLoc, diag::note_previous_definition);
493        res = true;
494      }
495      if (CheckForwardProtocolDeclarationForCircularDependency(PName, Ploc,
496            PDecl->getLocation(), PDecl->getReferencedProtocols()))
497        res = true;
498    }
499  }
500  return res;
501}
502
503Decl *
504Sema::ActOnStartProtocolInterface(SourceLocation AtProtoInterfaceLoc,
505                                  IdentifierInfo *ProtocolName,
506                                  SourceLocation ProtocolLoc,
507                                  Decl * const *ProtoRefs,
508                                  unsigned NumProtoRefs,
509                                  const SourceLocation *ProtoLocs,
510                                  SourceLocation EndProtoLoc,
511                                  AttributeList *AttrList) {
512  bool err = false;
513  // FIXME: Deal with AttrList.
514  assert(ProtocolName && "Missing protocol identifier");
515  ObjCProtocolDecl *PDecl = LookupProtocol(ProtocolName, ProtocolLoc);
516  if (PDecl) {
517    // Protocol already seen. Better be a forward protocol declaration
518    if (!PDecl->isForwardDecl()) {
519      Diag(ProtocolLoc, diag::warn_duplicate_protocol_def) << ProtocolName;
520      Diag(PDecl->getLocation(), diag::note_previous_definition);
521      // Just return the protocol we already had.
522      // FIXME: don't leak the objects passed in!
523      return PDecl;
524    }
525    ObjCList<ObjCProtocolDecl> PList;
526    PList.set((ObjCProtocolDecl *const*)ProtoRefs, NumProtoRefs, Context);
527    err = CheckForwardProtocolDeclarationForCircularDependency(
528            ProtocolName, ProtocolLoc, PDecl->getLocation(), PList);
529
530    // Make sure the cached decl gets a valid start location.
531    PDecl->setLocation(AtProtoInterfaceLoc);
532    PDecl->setForwardDecl(false);
533    CurContext->addDecl(PDecl);
534    // Repeat in dependent AST files.
535    PDecl->setChangedSinceDeserialization(true);
536  } else {
537    PDecl = ObjCProtocolDecl::Create(Context, CurContext,
538                                     AtProtoInterfaceLoc,ProtocolName);
539    PushOnScopeChains(PDecl, TUScope);
540    PDecl->setForwardDecl(false);
541  }
542  if (AttrList)
543    ProcessDeclAttributeList(TUScope, PDecl, AttrList);
544  if (!err && NumProtoRefs ) {
545    /// Check then save referenced protocols.
546    PDecl->setProtocolList((ObjCProtocolDecl**)ProtoRefs, NumProtoRefs,
547                           ProtoLocs, Context);
548    PDecl->setLocEnd(EndProtoLoc);
549  }
550
551  CheckObjCDeclScope(PDecl);
552  return PDecl;
553}
554
555/// FindProtocolDeclaration - This routine looks up protocols and
556/// issues an error if they are not declared. It returns list of
557/// protocol declarations in its 'Protocols' argument.
558void
559Sema::FindProtocolDeclaration(bool WarnOnDeclarations,
560                              const IdentifierLocPair *ProtocolId,
561                              unsigned NumProtocols,
562                              SmallVectorImpl<Decl *> &Protocols) {
563  for (unsigned i = 0; i != NumProtocols; ++i) {
564    ObjCProtocolDecl *PDecl = LookupProtocol(ProtocolId[i].first,
565                                             ProtocolId[i].second);
566    if (!PDecl) {
567      TypoCorrection Corrected = CorrectTypo(
568          DeclarationNameInfo(ProtocolId[i].first, ProtocolId[i].second),
569          LookupObjCProtocolName, TUScope, NULL, NULL, false, CTC_NoKeywords);
570      if ((PDecl = Corrected.getCorrectionDeclAs<ObjCProtocolDecl>())) {
571        Diag(ProtocolId[i].second, diag::err_undeclared_protocol_suggest)
572          << ProtocolId[i].first << Corrected.getCorrection();
573        Diag(PDecl->getLocation(), diag::note_previous_decl)
574          << PDecl->getDeclName();
575      }
576    }
577
578    if (!PDecl) {
579      Diag(ProtocolId[i].second, diag::err_undeclared_protocol)
580        << ProtocolId[i].first;
581      continue;
582    }
583
584    (void)DiagnoseUseOfDecl(PDecl, ProtocolId[i].second);
585
586    // If this is a forward declaration and we are supposed to warn in this
587    // case, do it.
588    if (WarnOnDeclarations && PDecl->isForwardDecl())
589      Diag(ProtocolId[i].second, diag::warn_undef_protocolref)
590        << ProtocolId[i].first;
591    Protocols.push_back(PDecl);
592  }
593}
594
595/// DiagnoseClassExtensionDupMethods - Check for duplicate declaration of
596/// a class method in its extension.
597///
598void Sema::DiagnoseClassExtensionDupMethods(ObjCCategoryDecl *CAT,
599                                            ObjCInterfaceDecl *ID) {
600  if (!ID)
601    return;  // Possibly due to previous error
602
603  llvm::DenseMap<Selector, const ObjCMethodDecl*> MethodMap;
604  for (ObjCInterfaceDecl::method_iterator i = ID->meth_begin(),
605       e =  ID->meth_end(); i != e; ++i) {
606    ObjCMethodDecl *MD = *i;
607    MethodMap[MD->getSelector()] = MD;
608  }
609
610  if (MethodMap.empty())
611    return;
612  for (ObjCCategoryDecl::method_iterator i = CAT->meth_begin(),
613       e =  CAT->meth_end(); i != e; ++i) {
614    ObjCMethodDecl *Method = *i;
615    const ObjCMethodDecl *&PrevMethod = MethodMap[Method->getSelector()];
616    if (PrevMethod && !MatchTwoMethodDeclarations(Method, PrevMethod)) {
617      Diag(Method->getLocation(), diag::err_duplicate_method_decl)
618            << Method->getDeclName();
619      Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
620    }
621  }
622}
623
624/// ActOnForwardProtocolDeclaration - Handle @protocol foo;
625Decl *
626Sema::ActOnForwardProtocolDeclaration(SourceLocation AtProtocolLoc,
627                                      const IdentifierLocPair *IdentList,
628                                      unsigned NumElts,
629                                      AttributeList *attrList) {
630  SmallVector<ObjCProtocolDecl*, 32> Protocols;
631  SmallVector<SourceLocation, 8> ProtoLocs;
632
633  for (unsigned i = 0; i != NumElts; ++i) {
634    IdentifierInfo *Ident = IdentList[i].first;
635    ObjCProtocolDecl *PDecl = LookupProtocol(Ident, IdentList[i].second);
636    bool isNew = false;
637    if (PDecl == 0) { // Not already seen?
638      PDecl = ObjCProtocolDecl::Create(Context, CurContext,
639                                       IdentList[i].second, Ident);
640      PushOnScopeChains(PDecl, TUScope, false);
641      isNew = true;
642    }
643    if (attrList) {
644      ProcessDeclAttributeList(TUScope, PDecl, attrList);
645      if (!isNew)
646        PDecl->setChangedSinceDeserialization(true);
647    }
648    Protocols.push_back(PDecl);
649    ProtoLocs.push_back(IdentList[i].second);
650  }
651
652  ObjCForwardProtocolDecl *PDecl =
653    ObjCForwardProtocolDecl::Create(Context, CurContext, AtProtocolLoc,
654                                    Protocols.data(), Protocols.size(),
655                                    ProtoLocs.data());
656  CurContext->addDecl(PDecl);
657  CheckObjCDeclScope(PDecl);
658  return PDecl;
659}
660
661Decl *Sema::
662ActOnStartCategoryInterface(SourceLocation AtInterfaceLoc,
663                            IdentifierInfo *ClassName, SourceLocation ClassLoc,
664                            IdentifierInfo *CategoryName,
665                            SourceLocation CategoryLoc,
666                            Decl * const *ProtoRefs,
667                            unsigned NumProtoRefs,
668                            const SourceLocation *ProtoLocs,
669                            SourceLocation EndProtoLoc) {
670  ObjCCategoryDecl *CDecl;
671  ObjCInterfaceDecl *IDecl = getObjCInterfaceDecl(ClassName, ClassLoc, true);
672
673  /// Check that class of this category is already completely declared.
674  if (!IDecl || IDecl->isForwardDecl()) {
675    // Create an invalid ObjCCategoryDecl to serve as context for
676    // the enclosing method declarations.  We mark the decl invalid
677    // to make it clear that this isn't a valid AST.
678    CDecl = ObjCCategoryDecl::Create(Context, CurContext, AtInterfaceLoc,
679                                     ClassLoc, CategoryLoc, CategoryName);
680    CDecl->setInvalidDecl();
681    Diag(ClassLoc, diag::err_undef_interface) << ClassName;
682    return CDecl;
683  }
684
685  if (!CategoryName && IDecl->getImplementation()) {
686    Diag(ClassLoc, diag::err_class_extension_after_impl) << ClassName;
687    Diag(IDecl->getImplementation()->getLocation(),
688          diag::note_implementation_declared);
689  }
690
691  CDecl = ObjCCategoryDecl::Create(Context, CurContext, AtInterfaceLoc,
692                                   ClassLoc, CategoryLoc, CategoryName);
693  // FIXME: PushOnScopeChains?
694  CurContext->addDecl(CDecl);
695
696  CDecl->setClassInterface(IDecl);
697  // Insert class extension to the list of class's categories.
698  if (!CategoryName)
699    CDecl->insertNextClassCategory();
700
701  // If the interface is deprecated, warn about it.
702  (void)DiagnoseUseOfDecl(IDecl, ClassLoc);
703
704  if (CategoryName) {
705    /// Check for duplicate interface declaration for this category
706    ObjCCategoryDecl *CDeclChain;
707    for (CDeclChain = IDecl->getCategoryList(); CDeclChain;
708         CDeclChain = CDeclChain->getNextClassCategory()) {
709      if (CDeclChain->getIdentifier() == CategoryName) {
710        // Class extensions can be declared multiple times.
711        Diag(CategoryLoc, diag::warn_dup_category_def)
712          << ClassName << CategoryName;
713        Diag(CDeclChain->getLocation(), diag::note_previous_definition);
714        break;
715      }
716    }
717    if (!CDeclChain)
718      CDecl->insertNextClassCategory();
719  }
720
721  if (NumProtoRefs) {
722    CDecl->setProtocolList((ObjCProtocolDecl**)ProtoRefs, NumProtoRefs,
723                           ProtoLocs, Context);
724    // Protocols in the class extension belong to the class.
725    if (CDecl->IsClassExtension())
726     IDecl->mergeClassExtensionProtocolList((ObjCProtocolDecl**)ProtoRefs,
727                                            NumProtoRefs, Context);
728  }
729
730  CheckObjCDeclScope(CDecl);
731  return CDecl;
732}
733
734/// ActOnStartCategoryImplementation - Perform semantic checks on the
735/// category implementation declaration and build an ObjCCategoryImplDecl
736/// object.
737Decl *Sema::ActOnStartCategoryImplementation(
738                      SourceLocation AtCatImplLoc,
739                      IdentifierInfo *ClassName, SourceLocation ClassLoc,
740                      IdentifierInfo *CatName, SourceLocation CatLoc) {
741  ObjCInterfaceDecl *IDecl = getObjCInterfaceDecl(ClassName, ClassLoc, true);
742  ObjCCategoryDecl *CatIDecl = 0;
743  if (IDecl) {
744    CatIDecl = IDecl->FindCategoryDeclaration(CatName);
745    if (!CatIDecl) {
746      // Category @implementation with no corresponding @interface.
747      // Create and install one.
748      CatIDecl = ObjCCategoryDecl::Create(Context, CurContext, SourceLocation(),
749                                          SourceLocation(), SourceLocation(),
750                                          CatName);
751      CatIDecl->setClassInterface(IDecl);
752      CatIDecl->insertNextClassCategory();
753    }
754  }
755
756  ObjCCategoryImplDecl *CDecl =
757    ObjCCategoryImplDecl::Create(Context, CurContext, AtCatImplLoc, CatName,
758                                 IDecl);
759  /// Check that class of this category is already completely declared.
760  if (!IDecl || IDecl->isForwardDecl()) {
761    Diag(ClassLoc, diag::err_undef_interface) << ClassName;
762    CDecl->setInvalidDecl();
763  }
764
765  // FIXME: PushOnScopeChains?
766  CurContext->addDecl(CDecl);
767
768  /// Check that CatName, category name, is not used in another implementation.
769  if (CatIDecl) {
770    if (CatIDecl->getImplementation()) {
771      Diag(ClassLoc, diag::err_dup_implementation_category) << ClassName
772        << CatName;
773      Diag(CatIDecl->getImplementation()->getLocation(),
774           diag::note_previous_definition);
775    } else {
776      CatIDecl->setImplementation(CDecl);
777      // Warn on implementating category of deprecated class under
778      // -Wdeprecated-implementations flag.
779      DiagnoseObjCImplementedDeprecations(*this,
780                                          dyn_cast<NamedDecl>(IDecl),
781                                          CDecl->getLocation(), 2);
782    }
783  }
784
785  CheckObjCDeclScope(CDecl);
786  return CDecl;
787}
788
789Decl *Sema::ActOnStartClassImplementation(
790                      SourceLocation AtClassImplLoc,
791                      IdentifierInfo *ClassName, SourceLocation ClassLoc,
792                      IdentifierInfo *SuperClassname,
793                      SourceLocation SuperClassLoc) {
794  ObjCInterfaceDecl* IDecl = 0;
795  // Check for another declaration kind with the same name.
796  NamedDecl *PrevDecl
797    = LookupSingleName(TUScope, ClassName, ClassLoc, LookupOrdinaryName,
798                       ForRedeclaration);
799  if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
800    Diag(ClassLoc, diag::err_redefinition_different_kind) << ClassName;
801    Diag(PrevDecl->getLocation(), diag::note_previous_definition);
802  } else if ((IDecl = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl))) {
803    // If this is a forward declaration of an interface, warn.
804    if (IDecl->isForwardDecl()) {
805      Diag(ClassLoc, diag::warn_undef_interface) << ClassName;
806      IDecl = 0;
807    }
808  } else {
809    // We did not find anything with the name ClassName; try to correct for
810    // typos in the class name.
811    TypoCorrection Corrected = CorrectTypo(
812        DeclarationNameInfo(ClassName, ClassLoc), LookupOrdinaryName, TUScope,
813        NULL, NULL, false, CTC_NoKeywords);
814    if ((IDecl = Corrected.getCorrectionDeclAs<ObjCInterfaceDecl>())) {
815      // Suggest the (potentially) correct interface name. However, put the
816      // fix-it hint itself in a separate note, since changing the name in
817      // the warning would make the fix-it change semantics.However, don't
818      // provide a code-modification hint or use the typo name for recovery,
819      // because this is just a warning. The program may actually be correct.
820      DeclarationName CorrectedName = Corrected.getCorrection();
821      Diag(ClassLoc, diag::warn_undef_interface_suggest)
822        << ClassName << CorrectedName;
823      Diag(IDecl->getLocation(), diag::note_previous_decl) << CorrectedName
824        << FixItHint::CreateReplacement(ClassLoc, CorrectedName.getAsString());
825      IDecl = 0;
826    } else {
827      Diag(ClassLoc, diag::warn_undef_interface) << ClassName;
828    }
829  }
830
831  // Check that super class name is valid class name
832  ObjCInterfaceDecl* SDecl = 0;
833  if (SuperClassname) {
834    // Check if a different kind of symbol declared in this scope.
835    PrevDecl = LookupSingleName(TUScope, SuperClassname, SuperClassLoc,
836                                LookupOrdinaryName);
837    if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
838      Diag(SuperClassLoc, diag::err_redefinition_different_kind)
839        << SuperClassname;
840      Diag(PrevDecl->getLocation(), diag::note_previous_definition);
841    } else {
842      SDecl = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
843      if (!SDecl)
844        Diag(SuperClassLoc, diag::err_undef_superclass)
845          << SuperClassname << ClassName;
846      else if (IDecl && IDecl->getSuperClass() != SDecl) {
847        // This implementation and its interface do not have the same
848        // super class.
849        Diag(SuperClassLoc, diag::err_conflicting_super_class)
850          << SDecl->getDeclName();
851        Diag(SDecl->getLocation(), diag::note_previous_definition);
852      }
853    }
854  }
855
856  if (!IDecl) {
857    // Legacy case of @implementation with no corresponding @interface.
858    // Build, chain & install the interface decl into the identifier.
859
860    // FIXME: Do we support attributes on the @implementation? If so we should
861    // copy them over.
862    IDecl = ObjCInterfaceDecl::Create(Context, CurContext, AtClassImplLoc,
863                                      ClassName, ClassLoc, false, true);
864    IDecl->setSuperClass(SDecl);
865    IDecl->setLocEnd(ClassLoc);
866
867    PushOnScopeChains(IDecl, TUScope);
868  } else {
869    // Mark the interface as being completed, even if it was just as
870    //   @class ....;
871    // declaration; the user cannot reopen it.
872    IDecl->setForwardDecl(false);
873  }
874
875  ObjCImplementationDecl* IMPDecl =
876    ObjCImplementationDecl::Create(Context, CurContext, AtClassImplLoc,
877                                   IDecl, SDecl);
878
879  if (CheckObjCDeclScope(IMPDecl))
880    return IMPDecl;
881
882  // Check that there is no duplicate implementation of this class.
883  if (IDecl->getImplementation()) {
884    // FIXME: Don't leak everything!
885    Diag(ClassLoc, diag::err_dup_implementation_class) << ClassName;
886    Diag(IDecl->getImplementation()->getLocation(),
887         diag::note_previous_definition);
888  } else { // add it to the list.
889    IDecl->setImplementation(IMPDecl);
890    PushOnScopeChains(IMPDecl, TUScope);
891    // Warn on implementating deprecated class under
892    // -Wdeprecated-implementations flag.
893    DiagnoseObjCImplementedDeprecations(*this,
894                                        dyn_cast<NamedDecl>(IDecl),
895                                        IMPDecl->getLocation(), 1);
896  }
897  return IMPDecl;
898}
899
900void Sema::CheckImplementationIvars(ObjCImplementationDecl *ImpDecl,
901                                    ObjCIvarDecl **ivars, unsigned numIvars,
902                                    SourceLocation RBrace) {
903  assert(ImpDecl && "missing implementation decl");
904  ObjCInterfaceDecl* IDecl = ImpDecl->getClassInterface();
905  if (!IDecl)
906    return;
907  /// Check case of non-existing @interface decl.
908  /// (legacy objective-c @implementation decl without an @interface decl).
909  /// Add implementations's ivar to the synthesize class's ivar list.
910  if (IDecl->isImplicitInterfaceDecl()) {
911    IDecl->setLocEnd(RBrace);
912    // Add ivar's to class's DeclContext.
913    for (unsigned i = 0, e = numIvars; i != e; ++i) {
914      ivars[i]->setLexicalDeclContext(ImpDecl);
915      IDecl->makeDeclVisibleInContext(ivars[i], false);
916      ImpDecl->addDecl(ivars[i]);
917    }
918
919    return;
920  }
921  // If implementation has empty ivar list, just return.
922  if (numIvars == 0)
923    return;
924
925  assert(ivars && "missing @implementation ivars");
926  if (LangOpts.ObjCNonFragileABI2) {
927    if (ImpDecl->getSuperClass())
928      Diag(ImpDecl->getLocation(), diag::warn_on_superclass_use);
929    for (unsigned i = 0; i < numIvars; i++) {
930      ObjCIvarDecl* ImplIvar = ivars[i];
931      if (const ObjCIvarDecl *ClsIvar =
932            IDecl->getIvarDecl(ImplIvar->getIdentifier())) {
933        Diag(ImplIvar->getLocation(), diag::err_duplicate_ivar_declaration);
934        Diag(ClsIvar->getLocation(), diag::note_previous_definition);
935        continue;
936      }
937      // Instance ivar to Implementation's DeclContext.
938      ImplIvar->setLexicalDeclContext(ImpDecl);
939      IDecl->makeDeclVisibleInContext(ImplIvar, false);
940      ImpDecl->addDecl(ImplIvar);
941    }
942    return;
943  }
944  // Check interface's Ivar list against those in the implementation.
945  // names and types must match.
946  //
947  unsigned j = 0;
948  ObjCInterfaceDecl::ivar_iterator
949    IVI = IDecl->ivar_begin(), IVE = IDecl->ivar_end();
950  for (; numIvars > 0 && IVI != IVE; ++IVI) {
951    ObjCIvarDecl* ImplIvar = ivars[j++];
952    ObjCIvarDecl* ClsIvar = *IVI;
953    assert (ImplIvar && "missing implementation ivar");
954    assert (ClsIvar && "missing class ivar");
955
956    // First, make sure the types match.
957    if (Context.getCanonicalType(ImplIvar->getType()) !=
958        Context.getCanonicalType(ClsIvar->getType())) {
959      Diag(ImplIvar->getLocation(), diag::err_conflicting_ivar_type)
960        << ImplIvar->getIdentifier()
961        << ImplIvar->getType() << ClsIvar->getType();
962      Diag(ClsIvar->getLocation(), diag::note_previous_definition);
963    } else if (ImplIvar->isBitField() && ClsIvar->isBitField()) {
964      Expr *ImplBitWidth = ImplIvar->getBitWidth();
965      Expr *ClsBitWidth = ClsIvar->getBitWidth();
966      if (ImplBitWidth->EvaluateAsInt(Context).getZExtValue() !=
967          ClsBitWidth->EvaluateAsInt(Context).getZExtValue()) {
968        Diag(ImplBitWidth->getLocStart(), diag::err_conflicting_ivar_bitwidth)
969          << ImplIvar->getIdentifier();
970        Diag(ClsBitWidth->getLocStart(), diag::note_previous_definition);
971      }
972    }
973    // Make sure the names are identical.
974    if (ImplIvar->getIdentifier() != ClsIvar->getIdentifier()) {
975      Diag(ImplIvar->getLocation(), diag::err_conflicting_ivar_name)
976        << ImplIvar->getIdentifier() << ClsIvar->getIdentifier();
977      Diag(ClsIvar->getLocation(), diag::note_previous_definition);
978    }
979    --numIvars;
980  }
981
982  if (numIvars > 0)
983    Diag(ivars[j]->getLocation(), diag::err_inconsistant_ivar_count);
984  else if (IVI != IVE)
985    Diag((*IVI)->getLocation(), diag::err_inconsistant_ivar_count);
986}
987
988void Sema::WarnUndefinedMethod(SourceLocation ImpLoc, ObjCMethodDecl *method,
989                               bool &IncompleteImpl, unsigned DiagID) {
990  // No point warning no definition of method which is 'unavailable'.
991  if (method->hasAttr<UnavailableAttr>())
992    return;
993  if (!IncompleteImpl) {
994    Diag(ImpLoc, diag::warn_incomplete_impl);
995    IncompleteImpl = true;
996  }
997  if (DiagID == diag::warn_unimplemented_protocol_method)
998    Diag(ImpLoc, DiagID) << method->getDeclName();
999  else
1000    Diag(method->getLocation(), DiagID) << method->getDeclName();
1001}
1002
1003/// Determines if type B can be substituted for type A.  Returns true if we can
1004/// guarantee that anything that the user will do to an object of type A can
1005/// also be done to an object of type B.  This is trivially true if the two
1006/// types are the same, or if B is a subclass of A.  It becomes more complex
1007/// in cases where protocols are involved.
1008///
1009/// Object types in Objective-C describe the minimum requirements for an
1010/// object, rather than providing a complete description of a type.  For
1011/// example, if A is a subclass of B, then B* may refer to an instance of A.
1012/// The principle of substitutability means that we may use an instance of A
1013/// anywhere that we may use an instance of B - it will implement all of the
1014/// ivars of B and all of the methods of B.
1015///
1016/// This substitutability is important when type checking methods, because
1017/// the implementation may have stricter type definitions than the interface.
1018/// The interface specifies minimum requirements, but the implementation may
1019/// have more accurate ones.  For example, a method may privately accept
1020/// instances of B, but only publish that it accepts instances of A.  Any
1021/// object passed to it will be type checked against B, and so will implicitly
1022/// by a valid A*.  Similarly, a method may return a subclass of the class that
1023/// it is declared as returning.
1024///
1025/// This is most important when considering subclassing.  A method in a
1026/// subclass must accept any object as an argument that its superclass's
1027/// implementation accepts.  It may, however, accept a more general type
1028/// without breaking substitutability (i.e. you can still use the subclass
1029/// anywhere that you can use the superclass, but not vice versa).  The
1030/// converse requirement applies to return types: the return type for a
1031/// subclass method must be a valid object of the kind that the superclass
1032/// advertises, but it may be specified more accurately.  This avoids the need
1033/// for explicit down-casting by callers.
1034///
1035/// Note: This is a stricter requirement than for assignment.
1036static bool isObjCTypeSubstitutable(ASTContext &Context,
1037                                    const ObjCObjectPointerType *A,
1038                                    const ObjCObjectPointerType *B,
1039                                    bool rejectId) {
1040  // Reject a protocol-unqualified id.
1041  if (rejectId && B->isObjCIdType()) return false;
1042
1043  // If B is a qualified id, then A must also be a qualified id and it must
1044  // implement all of the protocols in B.  It may not be a qualified class.
1045  // For example, MyClass<A> can be assigned to id<A>, but MyClass<A> is a
1046  // stricter definition so it is not substitutable for id<A>.
1047  if (B->isObjCQualifiedIdType()) {
1048    return A->isObjCQualifiedIdType() &&
1049           Context.ObjCQualifiedIdTypesAreCompatible(QualType(A, 0),
1050                                                     QualType(B,0),
1051                                                     false);
1052  }
1053
1054  /*
1055  // id is a special type that bypasses type checking completely.  We want a
1056  // warning when it is used in one place but not another.
1057  if (C.isObjCIdType(A) || C.isObjCIdType(B)) return false;
1058
1059
1060  // If B is a qualified id, then A must also be a qualified id (which it isn't
1061  // if we've got this far)
1062  if (B->isObjCQualifiedIdType()) return false;
1063  */
1064
1065  // Now we know that A and B are (potentially-qualified) class types.  The
1066  // normal rules for assignment apply.
1067  return Context.canAssignObjCInterfaces(A, B);
1068}
1069
1070static SourceRange getTypeRange(TypeSourceInfo *TSI) {
1071  return (TSI ? TSI->getTypeLoc().getSourceRange() : SourceRange());
1072}
1073
1074static void CheckMethodOverrideReturn(Sema &S,
1075                                      ObjCMethodDecl *MethodImpl,
1076                                      ObjCMethodDecl *MethodDecl,
1077                                      bool IsProtocolMethodDecl) {
1078  if (IsProtocolMethodDecl &&
1079      (MethodDecl->getObjCDeclQualifier() !=
1080       MethodImpl->getObjCDeclQualifier())) {
1081    S.Diag(MethodImpl->getLocation(),
1082           diag::warn_conflicting_ret_type_modifiers)
1083        << MethodImpl->getDeclName()
1084        << getTypeRange(MethodImpl->getResultTypeSourceInfo());
1085    S.Diag(MethodDecl->getLocation(), diag::note_previous_declaration)
1086        << getTypeRange(MethodDecl->getResultTypeSourceInfo());
1087  }
1088
1089  if (S.Context.hasSameUnqualifiedType(MethodImpl->getResultType(),
1090                                       MethodDecl->getResultType()))
1091    return;
1092
1093  unsigned DiagID = diag::warn_conflicting_ret_types;
1094
1095  // Mismatches between ObjC pointers go into a different warning
1096  // category, and sometimes they're even completely whitelisted.
1097  if (const ObjCObjectPointerType *ImplPtrTy =
1098        MethodImpl->getResultType()->getAs<ObjCObjectPointerType>()) {
1099    if (const ObjCObjectPointerType *IfacePtrTy =
1100          MethodDecl->getResultType()->getAs<ObjCObjectPointerType>()) {
1101      // Allow non-matching return types as long as they don't violate
1102      // the principle of substitutability.  Specifically, we permit
1103      // return types that are subclasses of the declared return type,
1104      // or that are more-qualified versions of the declared type.
1105      if (isObjCTypeSubstitutable(S.Context, IfacePtrTy, ImplPtrTy, false))
1106        return;
1107
1108      DiagID = diag::warn_non_covariant_ret_types;
1109    }
1110  }
1111
1112  S.Diag(MethodImpl->getLocation(), DiagID)
1113    << MethodImpl->getDeclName()
1114    << MethodDecl->getResultType()
1115    << MethodImpl->getResultType()
1116    << getTypeRange(MethodImpl->getResultTypeSourceInfo());
1117  S.Diag(MethodDecl->getLocation(), diag::note_previous_definition)
1118    << getTypeRange(MethodDecl->getResultTypeSourceInfo());
1119}
1120
1121static void CheckMethodOverrideParam(Sema &S,
1122                                     ObjCMethodDecl *MethodImpl,
1123                                     ObjCMethodDecl *MethodDecl,
1124                                     ParmVarDecl *ImplVar,
1125                                     ParmVarDecl *IfaceVar,
1126                                     bool IsProtocolMethodDecl) {
1127  if (IsProtocolMethodDecl &&
1128      (ImplVar->getObjCDeclQualifier() !=
1129       IfaceVar->getObjCDeclQualifier())) {
1130    S.Diag(ImplVar->getLocation(),
1131           diag::warn_conflicting_param_modifiers)
1132        << getTypeRange(ImplVar->getTypeSourceInfo())
1133        << MethodImpl->getDeclName();
1134    S.Diag(IfaceVar->getLocation(), diag::note_previous_declaration)
1135        << getTypeRange(IfaceVar->getTypeSourceInfo());
1136  }
1137
1138  QualType ImplTy = ImplVar->getType();
1139  QualType IfaceTy = IfaceVar->getType();
1140
1141  if (S.Context.hasSameUnqualifiedType(ImplTy, IfaceTy))
1142    return;
1143
1144  unsigned DiagID = diag::warn_conflicting_param_types;
1145
1146  // Mismatches between ObjC pointers go into a different warning
1147  // category, and sometimes they're even completely whitelisted.
1148  if (const ObjCObjectPointerType *ImplPtrTy =
1149        ImplTy->getAs<ObjCObjectPointerType>()) {
1150    if (const ObjCObjectPointerType *IfacePtrTy =
1151          IfaceTy->getAs<ObjCObjectPointerType>()) {
1152      // Allow non-matching argument types as long as they don't
1153      // violate the principle of substitutability.  Specifically, the
1154      // implementation must accept any objects that the superclass
1155      // accepts, however it may also accept others.
1156      if (isObjCTypeSubstitutable(S.Context, ImplPtrTy, IfacePtrTy, true))
1157        return;
1158
1159      DiagID = diag::warn_non_contravariant_param_types;
1160    }
1161  }
1162
1163  S.Diag(ImplVar->getLocation(), DiagID)
1164    << getTypeRange(ImplVar->getTypeSourceInfo())
1165    << MethodImpl->getDeclName() << IfaceTy << ImplTy;
1166  S.Diag(IfaceVar->getLocation(), diag::note_previous_definition)
1167    << getTypeRange(IfaceVar->getTypeSourceInfo());
1168}
1169
1170/// In ARC, check whether the conventional meanings of the two methods
1171/// match.  If they don't, it's a hard error.
1172static bool checkMethodFamilyMismatch(Sema &S, ObjCMethodDecl *impl,
1173                                      ObjCMethodDecl *decl) {
1174  ObjCMethodFamily implFamily = impl->getMethodFamily();
1175  ObjCMethodFamily declFamily = decl->getMethodFamily();
1176  if (implFamily == declFamily) return false;
1177
1178  // Since conventions are sorted by selector, the only possibility is
1179  // that the types differ enough to cause one selector or the other
1180  // to fall out of the family.
1181  assert(implFamily == OMF_None || declFamily == OMF_None);
1182
1183  // No further diagnostics required on invalid declarations.
1184  if (impl->isInvalidDecl() || decl->isInvalidDecl()) return true;
1185
1186  const ObjCMethodDecl *unmatched = impl;
1187  ObjCMethodFamily family = declFamily;
1188  unsigned errorID = diag::err_arc_lost_method_convention;
1189  unsigned noteID = diag::note_arc_lost_method_convention;
1190  if (declFamily == OMF_None) {
1191    unmatched = decl;
1192    family = implFamily;
1193    errorID = diag::err_arc_gained_method_convention;
1194    noteID = diag::note_arc_gained_method_convention;
1195  }
1196
1197  // Indexes into a %select clause in the diagnostic.
1198  enum FamilySelector {
1199    F_alloc, F_copy, F_mutableCopy = F_copy, F_init, F_new
1200  };
1201  FamilySelector familySelector = FamilySelector();
1202
1203  switch (family) {
1204  case OMF_None: llvm_unreachable("logic error, no method convention");
1205  case OMF_retain:
1206  case OMF_release:
1207  case OMF_autorelease:
1208  case OMF_dealloc:
1209  case OMF_retainCount:
1210  case OMF_self:
1211  case OMF_performSelector:
1212    // Mismatches for these methods don't change ownership
1213    // conventions, so we don't care.
1214    return false;
1215
1216  case OMF_init: familySelector = F_init; break;
1217  case OMF_alloc: familySelector = F_alloc; break;
1218  case OMF_copy: familySelector = F_copy; break;
1219  case OMF_mutableCopy: familySelector = F_mutableCopy; break;
1220  case OMF_new: familySelector = F_new; break;
1221  }
1222
1223  enum ReasonSelector { R_NonObjectReturn, R_UnrelatedReturn };
1224  ReasonSelector reasonSelector;
1225
1226  // The only reason these methods don't fall within their families is
1227  // due to unusual result types.
1228  if (unmatched->getResultType()->isObjCObjectPointerType()) {
1229    reasonSelector = R_UnrelatedReturn;
1230  } else {
1231    reasonSelector = R_NonObjectReturn;
1232  }
1233
1234  S.Diag(impl->getLocation(), errorID) << familySelector << reasonSelector;
1235  S.Diag(decl->getLocation(), noteID) << familySelector << reasonSelector;
1236
1237  return true;
1238}
1239
1240void Sema::WarnConflictingTypedMethods(ObjCMethodDecl *ImpMethodDecl,
1241                                       ObjCMethodDecl *MethodDecl,
1242                                       bool IsProtocolMethodDecl) {
1243  if (getLangOptions().ObjCAutoRefCount &&
1244      checkMethodFamilyMismatch(*this, ImpMethodDecl, MethodDecl))
1245    return;
1246
1247  CheckMethodOverrideReturn(*this, ImpMethodDecl, MethodDecl,
1248                            IsProtocolMethodDecl);
1249
1250  for (ObjCMethodDecl::param_iterator IM = ImpMethodDecl->param_begin(),
1251       IF = MethodDecl->param_begin(), EM = ImpMethodDecl->param_end();
1252       IM != EM; ++IM, ++IF)
1253    CheckMethodOverrideParam(*this, ImpMethodDecl, MethodDecl, *IM, *IF,
1254                             IsProtocolMethodDecl);
1255
1256  if (ImpMethodDecl->isVariadic() != MethodDecl->isVariadic()) {
1257    Diag(ImpMethodDecl->getLocation(), diag::warn_conflicting_variadic);
1258    Diag(MethodDecl->getLocation(), diag::note_previous_declaration);
1259  }
1260}
1261
1262/// FIXME: Type hierarchies in Objective-C can be deep. We could most likely
1263/// improve the efficiency of selector lookups and type checking by associating
1264/// with each protocol / interface / category the flattened instance tables. If
1265/// we used an immutable set to keep the table then it wouldn't add significant
1266/// memory cost and it would be handy for lookups.
1267
1268/// CheckProtocolMethodDefs - This routine checks unimplemented methods
1269/// Declared in protocol, and those referenced by it.
1270void Sema::CheckProtocolMethodDefs(SourceLocation ImpLoc,
1271                                   ObjCProtocolDecl *PDecl,
1272                                   bool& IncompleteImpl,
1273                                   const llvm::DenseSet<Selector> &InsMap,
1274                                   const llvm::DenseSet<Selector> &ClsMap,
1275                                   ObjCContainerDecl *CDecl) {
1276  ObjCInterfaceDecl *IDecl;
1277  if (ObjCCategoryDecl *C = dyn_cast<ObjCCategoryDecl>(CDecl))
1278    IDecl = C->getClassInterface();
1279  else
1280    IDecl = dyn_cast<ObjCInterfaceDecl>(CDecl);
1281  assert (IDecl && "CheckProtocolMethodDefs - IDecl is null");
1282
1283  ObjCInterfaceDecl *Super = IDecl->getSuperClass();
1284  ObjCInterfaceDecl *NSIDecl = 0;
1285  if (getLangOptions().NeXTRuntime) {
1286    // check to see if class implements forwardInvocation method and objects
1287    // of this class are derived from 'NSProxy' so that to forward requests
1288    // from one object to another.
1289    // Under such conditions, which means that every method possible is
1290    // implemented in the class, we should not issue "Method definition not
1291    // found" warnings.
1292    // FIXME: Use a general GetUnarySelector method for this.
1293    IdentifierInfo* II = &Context.Idents.get("forwardInvocation");
1294    Selector fISelector = Context.Selectors.getSelector(1, &II);
1295    if (InsMap.count(fISelector))
1296      // Is IDecl derived from 'NSProxy'? If so, no instance methods
1297      // need be implemented in the implementation.
1298      NSIDecl = IDecl->lookupInheritedClass(&Context.Idents.get("NSProxy"));
1299  }
1300
1301  // If a method lookup fails locally we still need to look and see if
1302  // the method was implemented by a base class or an inherited
1303  // protocol. This lookup is slow, but occurs rarely in correct code
1304  // and otherwise would terminate in a warning.
1305
1306  // check unimplemented instance methods.
1307  if (!NSIDecl)
1308    for (ObjCProtocolDecl::instmeth_iterator I = PDecl->instmeth_begin(),
1309         E = PDecl->instmeth_end(); I != E; ++I) {
1310      ObjCMethodDecl *method = *I;
1311      if (method->getImplementationControl() != ObjCMethodDecl::Optional &&
1312          !method->isSynthesized() && !InsMap.count(method->getSelector()) &&
1313          (!Super ||
1314           !Super->lookupInstanceMethod(method->getSelector()))) {
1315            // Ugly, but necessary. Method declared in protcol might have
1316            // have been synthesized due to a property declared in the class which
1317            // uses the protocol.
1318            ObjCMethodDecl *MethodInClass =
1319            IDecl->lookupInstanceMethod(method->getSelector());
1320            if (!MethodInClass || !MethodInClass->isSynthesized()) {
1321              unsigned DIAG = diag::warn_unimplemented_protocol_method;
1322              if (Diags.getDiagnosticLevel(DIAG, ImpLoc)
1323                      != Diagnostic::Ignored) {
1324                WarnUndefinedMethod(ImpLoc, method, IncompleteImpl, DIAG);
1325                Diag(method->getLocation(), diag::note_method_declared_at);
1326                Diag(CDecl->getLocation(), diag::note_required_for_protocol_at)
1327                  << PDecl->getDeclName();
1328              }
1329            }
1330          }
1331    }
1332  // check unimplemented class methods
1333  for (ObjCProtocolDecl::classmeth_iterator
1334         I = PDecl->classmeth_begin(), E = PDecl->classmeth_end();
1335       I != E; ++I) {
1336    ObjCMethodDecl *method = *I;
1337    if (method->getImplementationControl() != ObjCMethodDecl::Optional &&
1338        !ClsMap.count(method->getSelector()) &&
1339        (!Super || !Super->lookupClassMethod(method->getSelector()))) {
1340      unsigned DIAG = diag::warn_unimplemented_protocol_method;
1341      if (Diags.getDiagnosticLevel(DIAG, ImpLoc) != Diagnostic::Ignored) {
1342        WarnUndefinedMethod(ImpLoc, method, IncompleteImpl, DIAG);
1343        Diag(method->getLocation(), diag::note_method_declared_at);
1344        Diag(IDecl->getLocation(), diag::note_required_for_protocol_at) <<
1345          PDecl->getDeclName();
1346      }
1347    }
1348  }
1349  // Check on this protocols's referenced protocols, recursively.
1350  for (ObjCProtocolDecl::protocol_iterator PI = PDecl->protocol_begin(),
1351       E = PDecl->protocol_end(); PI != E; ++PI)
1352    CheckProtocolMethodDefs(ImpLoc, *PI, IncompleteImpl, InsMap, ClsMap, IDecl);
1353}
1354
1355/// MatchAllMethodDeclarations - Check methods declared in interface
1356/// or protocol against those declared in their implementations.
1357///
1358void Sema::MatchAllMethodDeclarations(const llvm::DenseSet<Selector> &InsMap,
1359                                      const llvm::DenseSet<Selector> &ClsMap,
1360                                      llvm::DenseSet<Selector> &InsMapSeen,
1361                                      llvm::DenseSet<Selector> &ClsMapSeen,
1362                                      ObjCImplDecl* IMPDecl,
1363                                      ObjCContainerDecl* CDecl,
1364                                      bool &IncompleteImpl,
1365                                      bool ImmediateClass) {
1366  // Check and see if instance methods in class interface have been
1367  // implemented in the implementation class. If so, their types match.
1368  for (ObjCInterfaceDecl::instmeth_iterator I = CDecl->instmeth_begin(),
1369       E = CDecl->instmeth_end(); I != E; ++I) {
1370    if (InsMapSeen.count((*I)->getSelector()))
1371        continue;
1372    InsMapSeen.insert((*I)->getSelector());
1373    if (!(*I)->isSynthesized() &&
1374        !InsMap.count((*I)->getSelector())) {
1375      if (ImmediateClass)
1376        WarnUndefinedMethod(IMPDecl->getLocation(), *I, IncompleteImpl,
1377                            diag::note_undef_method_impl);
1378      continue;
1379    } else {
1380      ObjCMethodDecl *ImpMethodDecl =
1381      IMPDecl->getInstanceMethod((*I)->getSelector());
1382      ObjCMethodDecl *MethodDecl =
1383      CDecl->getInstanceMethod((*I)->getSelector());
1384      assert(MethodDecl &&
1385             "MethodDecl is null in ImplMethodsVsClassMethods");
1386      // ImpMethodDecl may be null as in a @dynamic property.
1387      if (ImpMethodDecl)
1388        WarnConflictingTypedMethods(ImpMethodDecl, MethodDecl,
1389                                    isa<ObjCProtocolDecl>(CDecl));
1390    }
1391  }
1392
1393  // Check and see if class methods in class interface have been
1394  // implemented in the implementation class. If so, their types match.
1395   for (ObjCInterfaceDecl::classmeth_iterator
1396       I = CDecl->classmeth_begin(), E = CDecl->classmeth_end(); I != E; ++I) {
1397     if (ClsMapSeen.count((*I)->getSelector()))
1398       continue;
1399     ClsMapSeen.insert((*I)->getSelector());
1400    if (!ClsMap.count((*I)->getSelector())) {
1401      if (ImmediateClass)
1402        WarnUndefinedMethod(IMPDecl->getLocation(), *I, IncompleteImpl,
1403                            diag::note_undef_method_impl);
1404    } else {
1405      ObjCMethodDecl *ImpMethodDecl =
1406        IMPDecl->getClassMethod((*I)->getSelector());
1407      ObjCMethodDecl *MethodDecl =
1408        CDecl->getClassMethod((*I)->getSelector());
1409      WarnConflictingTypedMethods(ImpMethodDecl, MethodDecl,
1410                                  isa<ObjCProtocolDecl>(CDecl));
1411    }
1412  }
1413
1414  if (ObjCInterfaceDecl *I = dyn_cast<ObjCInterfaceDecl> (CDecl)) {
1415    // Also methods in class extensions need be looked at next.
1416    for (const ObjCCategoryDecl *ClsExtDecl = I->getFirstClassExtension();
1417         ClsExtDecl; ClsExtDecl = ClsExtDecl->getNextClassExtension())
1418      MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
1419                                 IMPDecl,
1420                                 const_cast<ObjCCategoryDecl *>(ClsExtDecl),
1421                                 IncompleteImpl, false);
1422
1423    // Check for any implementation of a methods declared in protocol.
1424    for (ObjCInterfaceDecl::all_protocol_iterator
1425          PI = I->all_referenced_protocol_begin(),
1426          E = I->all_referenced_protocol_end(); PI != E; ++PI)
1427      MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
1428                                 IMPDecl,
1429                                 (*PI), IncompleteImpl, false);
1430    if (I->getSuperClass())
1431      MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
1432                                 IMPDecl,
1433                                 I->getSuperClass(), IncompleteImpl, false);
1434  }
1435}
1436
1437void Sema::ImplMethodsVsClassMethods(Scope *S, ObjCImplDecl* IMPDecl,
1438                                     ObjCContainerDecl* CDecl,
1439                                     bool IncompleteImpl) {
1440  llvm::DenseSet<Selector> InsMap;
1441  // Check and see if instance methods in class interface have been
1442  // implemented in the implementation class.
1443  for (ObjCImplementationDecl::instmeth_iterator
1444         I = IMPDecl->instmeth_begin(), E = IMPDecl->instmeth_end(); I!=E; ++I)
1445    InsMap.insert((*I)->getSelector());
1446
1447  // Check and see if properties declared in the interface have either 1)
1448  // an implementation or 2) there is a @synthesize/@dynamic implementation
1449  // of the property in the @implementation.
1450  if (isa<ObjCInterfaceDecl>(CDecl) &&
1451        !(LangOpts.ObjCDefaultSynthProperties && LangOpts.ObjCNonFragileABI2))
1452    DiagnoseUnimplementedProperties(S, IMPDecl, CDecl, InsMap);
1453
1454  llvm::DenseSet<Selector> ClsMap;
1455  for (ObjCImplementationDecl::classmeth_iterator
1456       I = IMPDecl->classmeth_begin(),
1457       E = IMPDecl->classmeth_end(); I != E; ++I)
1458    ClsMap.insert((*I)->getSelector());
1459
1460  // Check for type conflict of methods declared in a class/protocol and
1461  // its implementation; if any.
1462  llvm::DenseSet<Selector> InsMapSeen, ClsMapSeen;
1463  MatchAllMethodDeclarations(InsMap, ClsMap, InsMapSeen, ClsMapSeen,
1464                             IMPDecl, CDecl,
1465                             IncompleteImpl, true);
1466
1467  // Check the protocol list for unimplemented methods in the @implementation
1468  // class.
1469  // Check and see if class methods in class interface have been
1470  // implemented in the implementation class.
1471
1472  if (ObjCInterfaceDecl *I = dyn_cast<ObjCInterfaceDecl> (CDecl)) {
1473    for (ObjCInterfaceDecl::all_protocol_iterator
1474          PI = I->all_referenced_protocol_begin(),
1475          E = I->all_referenced_protocol_end(); PI != E; ++PI)
1476      CheckProtocolMethodDefs(IMPDecl->getLocation(), *PI, IncompleteImpl,
1477                              InsMap, ClsMap, I);
1478    // Check class extensions (unnamed categories)
1479    for (const ObjCCategoryDecl *Categories = I->getFirstClassExtension();
1480         Categories; Categories = Categories->getNextClassExtension())
1481      ImplMethodsVsClassMethods(S, IMPDecl,
1482                                const_cast<ObjCCategoryDecl*>(Categories),
1483                                IncompleteImpl);
1484  } else if (ObjCCategoryDecl *C = dyn_cast<ObjCCategoryDecl>(CDecl)) {
1485    // For extended class, unimplemented methods in its protocols will
1486    // be reported in the primary class.
1487    if (!C->IsClassExtension()) {
1488      for (ObjCCategoryDecl::protocol_iterator PI = C->protocol_begin(),
1489           E = C->protocol_end(); PI != E; ++PI)
1490        CheckProtocolMethodDefs(IMPDecl->getLocation(), *PI, IncompleteImpl,
1491                                InsMap, ClsMap, CDecl);
1492      // Report unimplemented properties in the category as well.
1493      // When reporting on missing setter/getters, do not report when
1494      // setter/getter is implemented in category's primary class
1495      // implementation.
1496      if (ObjCInterfaceDecl *ID = C->getClassInterface())
1497        if (ObjCImplDecl *IMP = ID->getImplementation()) {
1498          for (ObjCImplementationDecl::instmeth_iterator
1499               I = IMP->instmeth_begin(), E = IMP->instmeth_end(); I!=E; ++I)
1500            InsMap.insert((*I)->getSelector());
1501        }
1502      DiagnoseUnimplementedProperties(S, IMPDecl, CDecl, InsMap);
1503    }
1504  } else
1505    assert(false && "invalid ObjCContainerDecl type.");
1506}
1507
1508/// ActOnForwardClassDeclaration -
1509Decl *
1510Sema::ActOnForwardClassDeclaration(SourceLocation AtClassLoc,
1511                                   IdentifierInfo **IdentList,
1512                                   SourceLocation *IdentLocs,
1513                                   unsigned NumElts) {
1514  SmallVector<ObjCInterfaceDecl*, 32> Interfaces;
1515
1516  for (unsigned i = 0; i != NumElts; ++i) {
1517    // Check for another declaration kind with the same name.
1518    NamedDecl *PrevDecl
1519      = LookupSingleName(TUScope, IdentList[i], IdentLocs[i],
1520                         LookupOrdinaryName, ForRedeclaration);
1521    if (PrevDecl && PrevDecl->isTemplateParameter()) {
1522      // Maybe we will complain about the shadowed template parameter.
1523      DiagnoseTemplateParameterShadow(AtClassLoc, PrevDecl);
1524      // Just pretend that we didn't see the previous declaration.
1525      PrevDecl = 0;
1526    }
1527
1528    if (PrevDecl && !isa<ObjCInterfaceDecl>(PrevDecl)) {
1529      // GCC apparently allows the following idiom:
1530      //
1531      // typedef NSObject < XCElementTogglerP > XCElementToggler;
1532      // @class XCElementToggler;
1533      //
1534      // FIXME: Make an extension?
1535      TypedefNameDecl *TDD = dyn_cast<TypedefNameDecl>(PrevDecl);
1536      if (!TDD || !TDD->getUnderlyingType()->isObjCObjectType()) {
1537        Diag(AtClassLoc, diag::err_redefinition_different_kind) << IdentList[i];
1538        Diag(PrevDecl->getLocation(), diag::note_previous_definition);
1539      } else {
1540        // a forward class declaration matching a typedef name of a class refers
1541        // to the underlying class.
1542        if (const ObjCObjectType *OI =
1543              TDD->getUnderlyingType()->getAs<ObjCObjectType>())
1544          PrevDecl = OI->getInterface();
1545      }
1546    }
1547    ObjCInterfaceDecl *IDecl = dyn_cast_or_null<ObjCInterfaceDecl>(PrevDecl);
1548    if (!IDecl) {  // Not already seen?  Make a forward decl.
1549      IDecl = ObjCInterfaceDecl::Create(Context, CurContext, AtClassLoc,
1550                                        IdentList[i], IdentLocs[i], true);
1551
1552      // Push the ObjCInterfaceDecl on the scope chain but do *not* add it to
1553      // the current DeclContext.  This prevents clients that walk DeclContext
1554      // from seeing the imaginary ObjCInterfaceDecl until it is actually
1555      // declared later (if at all).  We also take care to explicitly make
1556      // sure this declaration is visible for name lookup.
1557      PushOnScopeChains(IDecl, TUScope, false);
1558      CurContext->makeDeclVisibleInContext(IDecl, true);
1559    }
1560
1561    Interfaces.push_back(IDecl);
1562  }
1563
1564  assert(Interfaces.size() == NumElts);
1565  ObjCClassDecl *CDecl = ObjCClassDecl::Create(Context, CurContext, AtClassLoc,
1566                                               Interfaces.data(), IdentLocs,
1567                                               Interfaces.size());
1568  CurContext->addDecl(CDecl);
1569  CheckObjCDeclScope(CDecl);
1570  return CDecl;
1571}
1572
1573static bool tryMatchRecordTypes(ASTContext &Context,
1574                                Sema::MethodMatchStrategy strategy,
1575                                const Type *left, const Type *right);
1576
1577static bool matchTypes(ASTContext &Context, Sema::MethodMatchStrategy strategy,
1578                       QualType leftQT, QualType rightQT) {
1579  const Type *left =
1580    Context.getCanonicalType(leftQT).getUnqualifiedType().getTypePtr();
1581  const Type *right =
1582    Context.getCanonicalType(rightQT).getUnqualifiedType().getTypePtr();
1583
1584  if (left == right) return true;
1585
1586  // If we're doing a strict match, the types have to match exactly.
1587  if (strategy == Sema::MMS_strict) return false;
1588
1589  if (left->isIncompleteType() || right->isIncompleteType()) return false;
1590
1591  // Otherwise, use this absurdly complicated algorithm to try to
1592  // validate the basic, low-level compatibility of the two types.
1593
1594  // As a minimum, require the sizes and alignments to match.
1595  if (Context.getTypeInfo(left) != Context.getTypeInfo(right))
1596    return false;
1597
1598  // Consider all the kinds of non-dependent canonical types:
1599  // - functions and arrays aren't possible as return and parameter types
1600
1601  // - vector types of equal size can be arbitrarily mixed
1602  if (isa<VectorType>(left)) return isa<VectorType>(right);
1603  if (isa<VectorType>(right)) return false;
1604
1605  // - references should only match references of identical type
1606  // - structs, unions, and Objective-C objects must match more-or-less
1607  //   exactly
1608  // - everything else should be a scalar
1609  if (!left->isScalarType() || !right->isScalarType())
1610    return tryMatchRecordTypes(Context, strategy, left, right);
1611
1612  // Make scalars agree in kind, except count bools as chars.
1613  Type::ScalarTypeKind leftSK = left->getScalarTypeKind();
1614  Type::ScalarTypeKind rightSK = right->getScalarTypeKind();
1615  if (leftSK == Type::STK_Bool) leftSK = Type::STK_Integral;
1616  if (rightSK == Type::STK_Bool) rightSK = Type::STK_Integral;
1617
1618  // Note that data member pointers and function member pointers don't
1619  // intermix because of the size differences.
1620
1621  return (leftSK == rightSK);
1622}
1623
1624static bool tryMatchRecordTypes(ASTContext &Context,
1625                                Sema::MethodMatchStrategy strategy,
1626                                const Type *lt, const Type *rt) {
1627  assert(lt && rt && lt != rt);
1628
1629  if (!isa<RecordType>(lt) || !isa<RecordType>(rt)) return false;
1630  RecordDecl *left = cast<RecordType>(lt)->getDecl();
1631  RecordDecl *right = cast<RecordType>(rt)->getDecl();
1632
1633  // Require union-hood to match.
1634  if (left->isUnion() != right->isUnion()) return false;
1635
1636  // Require an exact match if either is non-POD.
1637  if ((isa<CXXRecordDecl>(left) && !cast<CXXRecordDecl>(left)->isPOD()) ||
1638      (isa<CXXRecordDecl>(right) && !cast<CXXRecordDecl>(right)->isPOD()))
1639    return false;
1640
1641  // Require size and alignment to match.
1642  if (Context.getTypeInfo(lt) != Context.getTypeInfo(rt)) return false;
1643
1644  // Require fields to match.
1645  RecordDecl::field_iterator li = left->field_begin(), le = left->field_end();
1646  RecordDecl::field_iterator ri = right->field_begin(), re = right->field_end();
1647  for (; li != le && ri != re; ++li, ++ri) {
1648    if (!matchTypes(Context, strategy, li->getType(), ri->getType()))
1649      return false;
1650  }
1651  return (li == le && ri == re);
1652}
1653
1654/// MatchTwoMethodDeclarations - Checks that two methods have matching type and
1655/// returns true, or false, accordingly.
1656/// TODO: Handle protocol list; such as id<p1,p2> in type comparisons
1657bool Sema::MatchTwoMethodDeclarations(const ObjCMethodDecl *left,
1658                                      const ObjCMethodDecl *right,
1659                                      MethodMatchStrategy strategy) {
1660  if (!matchTypes(Context, strategy,
1661                  left->getResultType(), right->getResultType()))
1662    return false;
1663
1664  if (getLangOptions().ObjCAutoRefCount &&
1665      (left->hasAttr<NSReturnsRetainedAttr>()
1666         != right->hasAttr<NSReturnsRetainedAttr>() ||
1667       left->hasAttr<NSConsumesSelfAttr>()
1668         != right->hasAttr<NSConsumesSelfAttr>()))
1669    return false;
1670
1671  ObjCMethodDecl::param_iterator
1672    li = left->param_begin(), le = left->param_end(), ri = right->param_begin();
1673
1674  for (; li != le; ++li, ++ri) {
1675    assert(ri != right->param_end() && "Param mismatch");
1676    ParmVarDecl *lparm = *li, *rparm = *ri;
1677
1678    if (!matchTypes(Context, strategy, lparm->getType(), rparm->getType()))
1679      return false;
1680
1681    if (getLangOptions().ObjCAutoRefCount &&
1682        lparm->hasAttr<NSConsumedAttr>() != rparm->hasAttr<NSConsumedAttr>())
1683      return false;
1684  }
1685  return true;
1686}
1687
1688/// \brief Read the contents of the method pool for a given selector from
1689/// external storage.
1690///
1691/// This routine should only be called once, when the method pool has no entry
1692/// for this selector.
1693Sema::GlobalMethodPool::iterator Sema::ReadMethodPool(Selector Sel) {
1694  assert(ExternalSource && "We need an external AST source");
1695  assert(MethodPool.find(Sel) == MethodPool.end() &&
1696         "Selector data already loaded into the method pool");
1697
1698  // Read the method list from the external source.
1699  GlobalMethods Methods = ExternalSource->ReadMethodPool(Sel);
1700
1701  return MethodPool.insert(std::make_pair(Sel, Methods)).first;
1702}
1703
1704void Sema::AddMethodToGlobalPool(ObjCMethodDecl *Method, bool impl,
1705                                 bool instance) {
1706  GlobalMethodPool::iterator Pos = MethodPool.find(Method->getSelector());
1707  if (Pos == MethodPool.end()) {
1708    if (ExternalSource)
1709      Pos = ReadMethodPool(Method->getSelector());
1710    else
1711      Pos = MethodPool.insert(std::make_pair(Method->getSelector(),
1712                                             GlobalMethods())).first;
1713  }
1714  Method->setDefined(impl);
1715  ObjCMethodList &Entry = instance ? Pos->second.first : Pos->second.second;
1716  if (Entry.Method == 0) {
1717    // Haven't seen a method with this selector name yet - add it.
1718    Entry.Method = Method;
1719    Entry.Next = 0;
1720    return;
1721  }
1722
1723  // We've seen a method with this name, see if we have already seen this type
1724  // signature.
1725  for (ObjCMethodList *List = &Entry; List; List = List->Next) {
1726    bool match = MatchTwoMethodDeclarations(Method, List->Method);
1727
1728    if (match) {
1729      ObjCMethodDecl *PrevObjCMethod = List->Method;
1730      PrevObjCMethod->setDefined(impl);
1731      // If a method is deprecated, push it in the global pool.
1732      // This is used for better diagnostics.
1733      if (Method->isDeprecated()) {
1734        if (!PrevObjCMethod->isDeprecated())
1735          List->Method = Method;
1736      }
1737      // If new method is unavailable, push it into global pool
1738      // unless previous one is deprecated.
1739      if (Method->isUnavailable()) {
1740        if (PrevObjCMethod->getAvailability() < AR_Deprecated)
1741          List->Method = Method;
1742      }
1743      return;
1744    }
1745  }
1746
1747  // We have a new signature for an existing method - add it.
1748  // This is extremely rare. Only 1% of Cocoa selectors are "overloaded".
1749  ObjCMethodList *Mem = BumpAlloc.Allocate<ObjCMethodList>();
1750  Entry.Next = new (Mem) ObjCMethodList(Method, Entry.Next);
1751}
1752
1753/// Determines if this is an "acceptable" loose mismatch in the global
1754/// method pool.  This exists mostly as a hack to get around certain
1755/// global mismatches which we can't afford to make warnings / errors.
1756/// Really, what we want is a way to take a method out of the global
1757/// method pool.
1758static bool isAcceptableMethodMismatch(ObjCMethodDecl *chosen,
1759                                       ObjCMethodDecl *other) {
1760  if (!chosen->isInstanceMethod())
1761    return false;
1762
1763  Selector sel = chosen->getSelector();
1764  if (!sel.isUnarySelector() || sel.getNameForSlot(0) != "length")
1765    return false;
1766
1767  // Don't complain about mismatches for -length if the method we
1768  // chose has an integral result type.
1769  return (chosen->getResultType()->isIntegerType());
1770}
1771
1772ObjCMethodDecl *Sema::LookupMethodInGlobalPool(Selector Sel, SourceRange R,
1773                                               bool receiverIdOrClass,
1774                                               bool warn, bool instance) {
1775  GlobalMethodPool::iterator Pos = MethodPool.find(Sel);
1776  if (Pos == MethodPool.end()) {
1777    if (ExternalSource)
1778      Pos = ReadMethodPool(Sel);
1779    else
1780      return 0;
1781  }
1782
1783  ObjCMethodList &MethList = instance ? Pos->second.first : Pos->second.second;
1784
1785  if (warn && MethList.Method && MethList.Next) {
1786    bool issueDiagnostic = false, issueError = false;
1787
1788    // We support a warning which complains about *any* difference in
1789    // method signature.
1790    bool strictSelectorMatch =
1791      (receiverIdOrClass && warn &&
1792       (Diags.getDiagnosticLevel(diag::warn_strict_multiple_method_decl,
1793                                 R.getBegin()) !=
1794      Diagnostic::Ignored));
1795    if (strictSelectorMatch)
1796      for (ObjCMethodList *Next = MethList.Next; Next; Next = Next->Next) {
1797        if (!MatchTwoMethodDeclarations(MethList.Method, Next->Method,
1798                                        MMS_strict)) {
1799          issueDiagnostic = true;
1800          break;
1801        }
1802      }
1803
1804    // If we didn't see any strict differences, we won't see any loose
1805    // differences.  In ARC, however, we also need to check for loose
1806    // mismatches, because most of them are errors.
1807    if (!strictSelectorMatch ||
1808        (issueDiagnostic && getLangOptions().ObjCAutoRefCount))
1809      for (ObjCMethodList *Next = MethList.Next; Next; Next = Next->Next) {
1810        // This checks if the methods differ in type mismatch.
1811        if (!MatchTwoMethodDeclarations(MethList.Method, Next->Method,
1812                                        MMS_loose) &&
1813            !isAcceptableMethodMismatch(MethList.Method, Next->Method)) {
1814          issueDiagnostic = true;
1815          if (getLangOptions().ObjCAutoRefCount)
1816            issueError = true;
1817          break;
1818        }
1819      }
1820
1821    if (issueDiagnostic) {
1822      if (issueError)
1823        Diag(R.getBegin(), diag::err_arc_multiple_method_decl) << Sel << R;
1824      else if (strictSelectorMatch)
1825        Diag(R.getBegin(), diag::warn_strict_multiple_method_decl) << Sel << R;
1826      else
1827        Diag(R.getBegin(), diag::warn_multiple_method_decl) << Sel << R;
1828
1829      Diag(MethList.Method->getLocStart(),
1830           issueError ? diag::note_possibility : diag::note_using)
1831        << MethList.Method->getSourceRange();
1832      for (ObjCMethodList *Next = MethList.Next; Next; Next = Next->Next)
1833        Diag(Next->Method->getLocStart(), diag::note_also_found)
1834          << Next->Method->getSourceRange();
1835    }
1836  }
1837  return MethList.Method;
1838}
1839
1840ObjCMethodDecl *Sema::LookupImplementedMethodInGlobalPool(Selector Sel) {
1841  GlobalMethodPool::iterator Pos = MethodPool.find(Sel);
1842  if (Pos == MethodPool.end())
1843    return 0;
1844
1845  GlobalMethods &Methods = Pos->second;
1846
1847  if (Methods.first.Method && Methods.first.Method->isDefined())
1848    return Methods.first.Method;
1849  if (Methods.second.Method && Methods.second.Method->isDefined())
1850    return Methods.second.Method;
1851  return 0;
1852}
1853
1854/// CompareMethodParamsInBaseAndSuper - This routine compares methods with
1855/// identical selector names in current and its super classes and issues
1856/// a warning if any of their argument types are incompatible.
1857void Sema::CompareMethodParamsInBaseAndSuper(Decl *ClassDecl,
1858                                             ObjCMethodDecl *Method,
1859                                             bool IsInstance)  {
1860  ObjCInterfaceDecl *ID = dyn_cast<ObjCInterfaceDecl>(ClassDecl);
1861  if (ID == 0) return;
1862
1863  while (ObjCInterfaceDecl *SD = ID->getSuperClass()) {
1864    ObjCMethodDecl *SuperMethodDecl =
1865        SD->lookupMethod(Method->getSelector(), IsInstance);
1866    if (SuperMethodDecl == 0) {
1867      ID = SD;
1868      continue;
1869    }
1870    ObjCMethodDecl::param_iterator ParamI = Method->param_begin(),
1871      E = Method->param_end();
1872    ObjCMethodDecl::param_iterator PrevI = SuperMethodDecl->param_begin();
1873    for (; ParamI != E; ++ParamI, ++PrevI) {
1874      // Number of parameters are the same and is guaranteed by selector match.
1875      assert(PrevI != SuperMethodDecl->param_end() && "Param mismatch");
1876      QualType T1 = Context.getCanonicalType((*ParamI)->getType());
1877      QualType T2 = Context.getCanonicalType((*PrevI)->getType());
1878      // If type of argument of method in this class does not match its
1879      // respective argument type in the super class method, issue warning;
1880      if (!Context.typesAreCompatible(T1, T2)) {
1881        Diag((*ParamI)->getLocation(), diag::ext_typecheck_base_super)
1882          << T1 << T2;
1883        Diag(SuperMethodDecl->getLocation(), diag::note_previous_declaration);
1884        return;
1885      }
1886    }
1887    ID = SD;
1888  }
1889}
1890
1891/// DiagnoseDuplicateIvars -
1892/// Check for duplicate ivars in the entire class at the start of
1893/// @implementation. This becomes necesssary because class extension can
1894/// add ivars to a class in random order which will not be known until
1895/// class's @implementation is seen.
1896void Sema::DiagnoseDuplicateIvars(ObjCInterfaceDecl *ID,
1897                                  ObjCInterfaceDecl *SID) {
1898  for (ObjCInterfaceDecl::ivar_iterator IVI = ID->ivar_begin(),
1899       IVE = ID->ivar_end(); IVI != IVE; ++IVI) {
1900    ObjCIvarDecl* Ivar = (*IVI);
1901    if (Ivar->isInvalidDecl())
1902      continue;
1903    if (IdentifierInfo *II = Ivar->getIdentifier()) {
1904      ObjCIvarDecl* prevIvar = SID->lookupInstanceVariable(II);
1905      if (prevIvar) {
1906        Diag(Ivar->getLocation(), diag::err_duplicate_member) << II;
1907        Diag(prevIvar->getLocation(), diag::note_previous_declaration);
1908        Ivar->setInvalidDecl();
1909      }
1910    }
1911  }
1912}
1913
1914// Note: For class/category implemenations, allMethods/allProperties is
1915// always null.
1916void Sema::ActOnAtEnd(Scope *S, SourceRange AtEnd,
1917                      Decl *ClassDecl,
1918                      Decl **allMethods, unsigned allNum,
1919                      Decl **allProperties, unsigned pNum,
1920                      DeclGroupPtrTy *allTUVars, unsigned tuvNum) {
1921  // FIXME: If we don't have a ClassDecl, we have an error. We should consider
1922  // always passing in a decl. If the decl has an error, isInvalidDecl()
1923  // should be true.
1924  if (!ClassDecl)
1925    return;
1926
1927  bool isInterfaceDeclKind =
1928        isa<ObjCInterfaceDecl>(ClassDecl) || isa<ObjCCategoryDecl>(ClassDecl)
1929         || isa<ObjCProtocolDecl>(ClassDecl);
1930  bool checkIdenticalMethods = isa<ObjCImplementationDecl>(ClassDecl);
1931
1932  if (!isInterfaceDeclKind && AtEnd.isInvalid()) {
1933    // FIXME: This is wrong.  We shouldn't be pretending that there is
1934    //  an '@end' in the declaration.
1935    SourceLocation L = ClassDecl->getLocation();
1936    AtEnd.setBegin(L);
1937    AtEnd.setEnd(L);
1938    Diag(L, diag::err_missing_atend);
1939  }
1940
1941  // FIXME: Remove these and use the ObjCContainerDecl/DeclContext.
1942  llvm::DenseMap<Selector, const ObjCMethodDecl*> InsMap;
1943  llvm::DenseMap<Selector, const ObjCMethodDecl*> ClsMap;
1944
1945  for (unsigned i = 0; i < allNum; i++ ) {
1946    ObjCMethodDecl *Method =
1947      cast_or_null<ObjCMethodDecl>(allMethods[i]);
1948
1949    if (!Method) continue;  // Already issued a diagnostic.
1950    if (Method->isInstanceMethod()) {
1951      /// Check for instance method of the same name with incompatible types
1952      const ObjCMethodDecl *&PrevMethod = InsMap[Method->getSelector()];
1953      bool match = PrevMethod ? MatchTwoMethodDeclarations(Method, PrevMethod)
1954                              : false;
1955      if ((isInterfaceDeclKind && PrevMethod && !match)
1956          || (checkIdenticalMethods && match)) {
1957          Diag(Method->getLocation(), diag::err_duplicate_method_decl)
1958            << Method->getDeclName();
1959          Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
1960        Method->setInvalidDecl();
1961      } else {
1962        InsMap[Method->getSelector()] = Method;
1963        /// The following allows us to typecheck messages to "id".
1964        AddInstanceMethodToGlobalPool(Method);
1965        // verify that the instance method conforms to the same definition of
1966        // parent methods if it shadows one.
1967        CompareMethodParamsInBaseAndSuper(ClassDecl, Method, true);
1968      }
1969    } else {
1970      /// Check for class method of the same name with incompatible types
1971      const ObjCMethodDecl *&PrevMethod = ClsMap[Method->getSelector()];
1972      bool match = PrevMethod ? MatchTwoMethodDeclarations(Method, PrevMethod)
1973                              : false;
1974      if ((isInterfaceDeclKind && PrevMethod && !match)
1975          || (checkIdenticalMethods && match)) {
1976        Diag(Method->getLocation(), diag::err_duplicate_method_decl)
1977          << Method->getDeclName();
1978        Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
1979        Method->setInvalidDecl();
1980      } else {
1981        ClsMap[Method->getSelector()] = Method;
1982        /// The following allows us to typecheck messages to "Class".
1983        AddFactoryMethodToGlobalPool(Method);
1984        // verify that the class method conforms to the same definition of
1985        // parent methods if it shadows one.
1986        CompareMethodParamsInBaseAndSuper(ClassDecl, Method, false);
1987      }
1988    }
1989  }
1990  if (ObjCInterfaceDecl *I = dyn_cast<ObjCInterfaceDecl>(ClassDecl)) {
1991    // Compares properties declared in this class to those of its
1992    // super class.
1993    ComparePropertiesInBaseAndSuper(I);
1994    CompareProperties(I, I);
1995  } else if (ObjCCategoryDecl *C = dyn_cast<ObjCCategoryDecl>(ClassDecl)) {
1996    // Categories are used to extend the class by declaring new methods.
1997    // By the same token, they are also used to add new properties. No
1998    // need to compare the added property to those in the class.
1999
2000    // Compare protocol properties with those in category
2001    CompareProperties(C, C);
2002    if (C->IsClassExtension()) {
2003      ObjCInterfaceDecl *CCPrimary = C->getClassInterface();
2004      DiagnoseClassExtensionDupMethods(C, CCPrimary);
2005    }
2006  }
2007  if (ObjCContainerDecl *CDecl = dyn_cast<ObjCContainerDecl>(ClassDecl)) {
2008    if (CDecl->getIdentifier())
2009      // ProcessPropertyDecl is responsible for diagnosing conflicts with any
2010      // user-defined setter/getter. It also synthesizes setter/getter methods
2011      // and adds them to the DeclContext and global method pools.
2012      for (ObjCContainerDecl::prop_iterator I = CDecl->prop_begin(),
2013                                            E = CDecl->prop_end();
2014           I != E; ++I)
2015        ProcessPropertyDecl(*I, CDecl);
2016    CDecl->setAtEndRange(AtEnd);
2017  }
2018  if (ObjCImplementationDecl *IC=dyn_cast<ObjCImplementationDecl>(ClassDecl)) {
2019    IC->setAtEndRange(AtEnd);
2020    if (ObjCInterfaceDecl* IDecl = IC->getClassInterface()) {
2021      // Any property declared in a class extension might have user
2022      // declared setter or getter in current class extension or one
2023      // of the other class extensions. Mark them as synthesized as
2024      // property will be synthesized when property with same name is
2025      // seen in the @implementation.
2026      for (const ObjCCategoryDecl *ClsExtDecl =
2027           IDecl->getFirstClassExtension();
2028           ClsExtDecl; ClsExtDecl = ClsExtDecl->getNextClassExtension()) {
2029        for (ObjCContainerDecl::prop_iterator I = ClsExtDecl->prop_begin(),
2030             E = ClsExtDecl->prop_end(); I != E; ++I) {
2031          ObjCPropertyDecl *Property = (*I);
2032          // Skip over properties declared @dynamic
2033          if (const ObjCPropertyImplDecl *PIDecl
2034              = IC->FindPropertyImplDecl(Property->getIdentifier()))
2035            if (PIDecl->getPropertyImplementation()
2036                  == ObjCPropertyImplDecl::Dynamic)
2037              continue;
2038
2039          for (const ObjCCategoryDecl *CExtDecl =
2040               IDecl->getFirstClassExtension();
2041               CExtDecl; CExtDecl = CExtDecl->getNextClassExtension()) {
2042            if (ObjCMethodDecl *GetterMethod =
2043                CExtDecl->getInstanceMethod(Property->getGetterName()))
2044              GetterMethod->setSynthesized(true);
2045            if (!Property->isReadOnly())
2046              if (ObjCMethodDecl *SetterMethod =
2047                  CExtDecl->getInstanceMethod(Property->getSetterName()))
2048                SetterMethod->setSynthesized(true);
2049          }
2050        }
2051      }
2052
2053      if (LangOpts.ObjCDefaultSynthProperties &&
2054          LangOpts.ObjCNonFragileABI2)
2055        DefaultSynthesizeProperties(S, IC, IDecl);
2056      ImplMethodsVsClassMethods(S, IC, IDecl);
2057      AtomicPropertySetterGetterRules(IC, IDecl);
2058      DiagnoseOwningPropertyGetterSynthesis(IC);
2059
2060      if (LangOpts.ObjCNonFragileABI2)
2061        while (IDecl->getSuperClass()) {
2062          DiagnoseDuplicateIvars(IDecl, IDecl->getSuperClass());
2063          IDecl = IDecl->getSuperClass();
2064        }
2065    }
2066    SetIvarInitializers(IC);
2067  } else if (ObjCCategoryImplDecl* CatImplClass =
2068                                   dyn_cast<ObjCCategoryImplDecl>(ClassDecl)) {
2069    CatImplClass->setAtEndRange(AtEnd);
2070
2071    // Find category interface decl and then check that all methods declared
2072    // in this interface are implemented in the category @implementation.
2073    if (ObjCInterfaceDecl* IDecl = CatImplClass->getClassInterface()) {
2074      for (ObjCCategoryDecl *Categories = IDecl->getCategoryList();
2075           Categories; Categories = Categories->getNextClassCategory()) {
2076        if (Categories->getIdentifier() == CatImplClass->getIdentifier()) {
2077          ImplMethodsVsClassMethods(S, CatImplClass, Categories);
2078          break;
2079        }
2080      }
2081    }
2082  }
2083  if (isInterfaceDeclKind) {
2084    // Reject invalid vardecls.
2085    for (unsigned i = 0; i != tuvNum; i++) {
2086      DeclGroupRef DG = allTUVars[i].getAsVal<DeclGroupRef>();
2087      for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I)
2088        if (VarDecl *VDecl = dyn_cast<VarDecl>(*I)) {
2089          if (!VDecl->hasExternalStorage())
2090            Diag(VDecl->getLocation(), diag::err_objc_var_decl_inclass);
2091        }
2092    }
2093  }
2094}
2095
2096
2097/// CvtQTToAstBitMask - utility routine to produce an AST bitmask for
2098/// objective-c's type qualifier from the parser version of the same info.
2099static Decl::ObjCDeclQualifier
2100CvtQTToAstBitMask(ObjCDeclSpec::ObjCDeclQualifier PQTVal) {
2101  return (Decl::ObjCDeclQualifier) (unsigned) PQTVal;
2102}
2103
2104static inline
2105bool containsInvalidMethodImplAttribute(const AttrVec &A) {
2106  // The 'ibaction' attribute is allowed on method definitions because of
2107  // how the IBAction macro is used on both method declarations and definitions.
2108  // If the method definitions contains any other attributes, return true.
2109  for (AttrVec::const_iterator i = A.begin(), e = A.end(); i != e; ++i)
2110    if ((*i)->getKind() != attr::IBAction)
2111      return true;
2112  return false;
2113}
2114
2115/// \brief Check whether the declared result type of the given Objective-C
2116/// method declaration is compatible with the method's class.
2117///
2118static bool
2119CheckRelatedResultTypeCompatibility(Sema &S, ObjCMethodDecl *Method,
2120                                    ObjCInterfaceDecl *CurrentClass) {
2121  QualType ResultType = Method->getResultType();
2122  SourceRange ResultTypeRange;
2123  if (const TypeSourceInfo *ResultTypeInfo = Method->getResultTypeSourceInfo())
2124    ResultTypeRange = ResultTypeInfo->getTypeLoc().getSourceRange();
2125
2126  // If an Objective-C method inherits its related result type, then its
2127  // declared result type must be compatible with its own class type. The
2128  // declared result type is compatible if:
2129  if (const ObjCObjectPointerType *ResultObjectType
2130                                = ResultType->getAs<ObjCObjectPointerType>()) {
2131    //   - it is id or qualified id, or
2132    if (ResultObjectType->isObjCIdType() ||
2133        ResultObjectType->isObjCQualifiedIdType())
2134      return false;
2135
2136    if (CurrentClass) {
2137      if (ObjCInterfaceDecl *ResultClass
2138                                      = ResultObjectType->getInterfaceDecl()) {
2139        //   - it is the same as the method's class type, or
2140        if (CurrentClass == ResultClass)
2141          return false;
2142
2143        //   - it is a superclass of the method's class type
2144        if (ResultClass->isSuperClassOf(CurrentClass))
2145          return false;
2146      }
2147    }
2148  }
2149
2150  return true;
2151}
2152
2153namespace {
2154/// A helper class for searching for methods which a particular method
2155/// overrides.
2156class OverrideSearch {
2157  Sema &S;
2158  ObjCMethodDecl *Method;
2159  llvm::SmallPtrSet<ObjCContainerDecl*, 8> Searched;
2160  llvm::SmallPtrSet<ObjCMethodDecl*, 8> Overridden;
2161  bool Recursive;
2162
2163public:
2164  OverrideSearch(Sema &S, ObjCMethodDecl *method) : S(S), Method(method) {
2165    Selector selector = method->getSelector();
2166
2167    // Bypass this search if we've never seen an instance/class method
2168    // with this selector before.
2169    Sema::GlobalMethodPool::iterator it = S.MethodPool.find(selector);
2170    if (it == S.MethodPool.end()) {
2171      if (!S.ExternalSource) return;
2172      it = S.ReadMethodPool(selector);
2173    }
2174    ObjCMethodList &list =
2175      method->isInstanceMethod() ? it->second.first : it->second.second;
2176    if (!list.Method) return;
2177
2178    ObjCContainerDecl *container
2179      = cast<ObjCContainerDecl>(method->getDeclContext());
2180
2181    // Prevent the search from reaching this container again.  This is
2182    // important with categories, which override methods from the
2183    // interface and each other.
2184    Searched.insert(container);
2185    searchFromContainer(container);
2186  }
2187
2188  typedef llvm::SmallPtrSet<ObjCMethodDecl*,8>::iterator iterator;
2189  iterator begin() const { return Overridden.begin(); }
2190  iterator end() const { return Overridden.end(); }
2191
2192private:
2193  void searchFromContainer(ObjCContainerDecl *container) {
2194    if (container->isInvalidDecl()) return;
2195
2196    switch (container->getDeclKind()) {
2197#define OBJCCONTAINER(type, base) \
2198    case Decl::type: \
2199      searchFrom(cast<type##Decl>(container)); \
2200      break;
2201#define ABSTRACT_DECL(expansion)
2202#define DECL(type, base) \
2203    case Decl::type:
2204#include "clang/AST/DeclNodes.inc"
2205      llvm_unreachable("not an ObjC container!");
2206    }
2207  }
2208
2209  void searchFrom(ObjCProtocolDecl *protocol) {
2210    // A method in a protocol declaration overrides declarations from
2211    // referenced ("parent") protocols.
2212    search(protocol->getReferencedProtocols());
2213  }
2214
2215  void searchFrom(ObjCCategoryDecl *category) {
2216    // A method in a category declaration overrides declarations from
2217    // the main class and from protocols the category references.
2218    search(category->getClassInterface());
2219    search(category->getReferencedProtocols());
2220  }
2221
2222  void searchFrom(ObjCCategoryImplDecl *impl) {
2223    // A method in a category definition that has a category
2224    // declaration overrides declarations from the category
2225    // declaration.
2226    if (ObjCCategoryDecl *category = impl->getCategoryDecl()) {
2227      search(category);
2228
2229    // Otherwise it overrides declarations from the class.
2230    } else {
2231      search(impl->getClassInterface());
2232    }
2233  }
2234
2235  void searchFrom(ObjCInterfaceDecl *iface) {
2236    // A method in a class declaration overrides declarations from
2237
2238    //   - categories,
2239    for (ObjCCategoryDecl *category = iface->getCategoryList();
2240           category; category = category->getNextClassCategory())
2241      search(category);
2242
2243    //   - the super class, and
2244    if (ObjCInterfaceDecl *super = iface->getSuperClass())
2245      search(super);
2246
2247    //   - any referenced protocols.
2248    search(iface->getReferencedProtocols());
2249  }
2250
2251  void searchFrom(ObjCImplementationDecl *impl) {
2252    // A method in a class implementation overrides declarations from
2253    // the class interface.
2254    search(impl->getClassInterface());
2255  }
2256
2257
2258  void search(const ObjCProtocolList &protocols) {
2259    for (ObjCProtocolList::iterator i = protocols.begin(), e = protocols.end();
2260         i != e; ++i)
2261      search(*i);
2262  }
2263
2264  void search(ObjCContainerDecl *container) {
2265    // Abort if we've already searched this container.
2266    if (!Searched.insert(container)) return;
2267
2268    // Check for a method in this container which matches this selector.
2269    ObjCMethodDecl *meth = container->getMethod(Method->getSelector(),
2270                                                Method->isInstanceMethod());
2271
2272    // If we find one, record it and bail out.
2273    if (meth) {
2274      Overridden.insert(meth);
2275      return;
2276    }
2277
2278    // Otherwise, search for methods that a hypothetical method here
2279    // would have overridden.
2280
2281    // Note that we're now in a recursive case.
2282    Recursive = true;
2283
2284    searchFromContainer(container);
2285  }
2286};
2287}
2288
2289Decl *Sema::ActOnMethodDeclaration(
2290    Scope *S,
2291    SourceLocation MethodLoc, SourceLocation EndLoc,
2292    tok::TokenKind MethodType, Decl *ClassDecl,
2293    ObjCDeclSpec &ReturnQT, ParsedType ReturnType,
2294    SourceLocation SelectorStartLoc,
2295    Selector Sel,
2296    // optional arguments. The number of types/arguments is obtained
2297    // from the Sel.getNumArgs().
2298    ObjCArgInfo *ArgInfo,
2299    DeclaratorChunk::ParamInfo *CParamInfo, unsigned CNumArgs, // c-style args
2300    AttributeList *AttrList, tok::ObjCKeywordKind MethodDeclKind,
2301    bool isVariadic, bool MethodDefinition) {
2302  // Make sure we can establish a context for the method.
2303  if (!ClassDecl) {
2304    Diag(MethodLoc, diag::error_missing_method_context);
2305    return 0;
2306  }
2307  QualType resultDeclType;
2308
2309  TypeSourceInfo *ResultTInfo = 0;
2310  if (ReturnType) {
2311    resultDeclType = GetTypeFromParser(ReturnType, &ResultTInfo);
2312
2313    // Methods cannot return interface types. All ObjC objects are
2314    // passed by reference.
2315    if (resultDeclType->isObjCObjectType()) {
2316      Diag(MethodLoc, diag::err_object_cannot_be_passed_returned_by_value)
2317        << 0 << resultDeclType;
2318      return 0;
2319    }
2320  } else { // get the type for "id".
2321    resultDeclType = Context.getObjCIdType();
2322    Diag(MethodLoc, diag::warn_missing_method_return_type)
2323      << FixItHint::CreateInsertion(SelectorStartLoc, "(id)");
2324  }
2325
2326  ObjCMethodDecl* ObjCMethod =
2327    ObjCMethodDecl::Create(Context, MethodLoc, EndLoc, Sel, resultDeclType,
2328                           ResultTInfo,
2329                           cast<DeclContext>(ClassDecl),
2330                           MethodType == tok::minus, isVariadic,
2331                           false, false,
2332                           MethodDeclKind == tok::objc_optional
2333                             ? ObjCMethodDecl::Optional
2334                             : ObjCMethodDecl::Required,
2335                           false);
2336
2337  SmallVector<ParmVarDecl*, 16> Params;
2338
2339  for (unsigned i = 0, e = Sel.getNumArgs(); i != e; ++i) {
2340    QualType ArgType;
2341    TypeSourceInfo *DI;
2342
2343    if (ArgInfo[i].Type == 0) {
2344      ArgType = Context.getObjCIdType();
2345      DI = 0;
2346    } else {
2347      ArgType = GetTypeFromParser(ArgInfo[i].Type, &DI);
2348      // Perform the default array/function conversions (C99 6.7.5.3p[7,8]).
2349      ArgType = Context.getAdjustedParameterType(ArgType);
2350    }
2351
2352    LookupResult R(*this, ArgInfo[i].Name, ArgInfo[i].NameLoc,
2353                   LookupOrdinaryName, ForRedeclaration);
2354    LookupName(R, S);
2355    if (R.isSingleResult()) {
2356      NamedDecl *PrevDecl = R.getFoundDecl();
2357      if (S->isDeclScope(PrevDecl)) {
2358        Diag(ArgInfo[i].NameLoc,
2359             (MethodDefinition ? diag::warn_method_param_redefinition
2360                               : diag::warn_method_param_declaration))
2361          << ArgInfo[i].Name;
2362        Diag(PrevDecl->getLocation(),
2363             diag::note_previous_declaration);
2364      }
2365    }
2366
2367    SourceLocation StartLoc = DI
2368      ? DI->getTypeLoc().getBeginLoc()
2369      : ArgInfo[i].NameLoc;
2370
2371    ParmVarDecl* Param = CheckParameter(ObjCMethod, StartLoc,
2372                                        ArgInfo[i].NameLoc, ArgInfo[i].Name,
2373                                        ArgType, DI, SC_None, SC_None);
2374
2375    Param->setObjCMethodScopeInfo(i);
2376
2377    Param->setObjCDeclQualifier(
2378      CvtQTToAstBitMask(ArgInfo[i].DeclSpec.getObjCDeclQualifier()));
2379
2380    // Apply the attributes to the parameter.
2381    ProcessDeclAttributeList(TUScope, Param, ArgInfo[i].ArgAttrs);
2382
2383    S->AddDecl(Param);
2384    IdResolver.AddDecl(Param);
2385
2386    Params.push_back(Param);
2387  }
2388
2389  for (unsigned i = 0, e = CNumArgs; i != e; ++i) {
2390    ParmVarDecl *Param = cast<ParmVarDecl>(CParamInfo[i].Param);
2391    QualType ArgType = Param->getType();
2392    if (ArgType.isNull())
2393      ArgType = Context.getObjCIdType();
2394    else
2395      // Perform the default array/function conversions (C99 6.7.5.3p[7,8]).
2396      ArgType = Context.getAdjustedParameterType(ArgType);
2397    if (ArgType->isObjCObjectType()) {
2398      Diag(Param->getLocation(),
2399           diag::err_object_cannot_be_passed_returned_by_value)
2400      << 1 << ArgType;
2401      Param->setInvalidDecl();
2402    }
2403    Param->setDeclContext(ObjCMethod);
2404
2405    Params.push_back(Param);
2406  }
2407
2408  ObjCMethod->setMethodParams(Context, Params.data(), Params.size(),
2409                              Sel.getNumArgs());
2410  ObjCMethod->setObjCDeclQualifier(
2411    CvtQTToAstBitMask(ReturnQT.getObjCDeclQualifier()));
2412
2413  if (AttrList)
2414    ProcessDeclAttributeList(TUScope, ObjCMethod, AttrList);
2415
2416  // Add the method now.
2417  const ObjCMethodDecl *PrevMethod = 0;
2418  if (ObjCImplDecl *ImpDecl = dyn_cast<ObjCImplDecl>(ClassDecl)) {
2419    if (MethodType == tok::minus) {
2420      PrevMethod = ImpDecl->getInstanceMethod(Sel);
2421      ImpDecl->addInstanceMethod(ObjCMethod);
2422    } else {
2423      PrevMethod = ImpDecl->getClassMethod(Sel);
2424      ImpDecl->addClassMethod(ObjCMethod);
2425    }
2426
2427    if (ObjCMethod->hasAttrs() &&
2428        containsInvalidMethodImplAttribute(ObjCMethod->getAttrs()))
2429      Diag(EndLoc, diag::warn_attribute_method_def);
2430  } else {
2431    cast<DeclContext>(ClassDecl)->addDecl(ObjCMethod);
2432  }
2433
2434  if (PrevMethod) {
2435    // You can never have two method definitions with the same name.
2436    Diag(ObjCMethod->getLocation(), diag::err_duplicate_method_decl)
2437      << ObjCMethod->getDeclName();
2438    Diag(PrevMethod->getLocation(), diag::note_previous_declaration);
2439  }
2440
2441  // If this Objective-C method does not have a related result type, but we
2442  // are allowed to infer related result types, try to do so based on the
2443  // method family.
2444  ObjCInterfaceDecl *CurrentClass = dyn_cast<ObjCInterfaceDecl>(ClassDecl);
2445  if (!CurrentClass) {
2446    if (ObjCCategoryDecl *Cat = dyn_cast<ObjCCategoryDecl>(ClassDecl))
2447      CurrentClass = Cat->getClassInterface();
2448    else if (ObjCImplDecl *Impl = dyn_cast<ObjCImplDecl>(ClassDecl))
2449      CurrentClass = Impl->getClassInterface();
2450    else if (ObjCCategoryImplDecl *CatImpl
2451                                   = dyn_cast<ObjCCategoryImplDecl>(ClassDecl))
2452      CurrentClass = CatImpl->getClassInterface();
2453  }
2454
2455  bool isRelatedResultTypeCompatible =
2456    (getLangOptions().ObjCInferRelatedResultType &&
2457     !CheckRelatedResultTypeCompatibility(*this, ObjCMethod, CurrentClass));
2458
2459  // Search for overridden methods and merge information down from them.
2460  OverrideSearch overrides(*this, ObjCMethod);
2461  for (OverrideSearch::iterator
2462         i = overrides.begin(), e = overrides.end(); i != e; ++i) {
2463    ObjCMethodDecl *overridden = *i;
2464
2465    // Propagate down the 'related result type' bit from overridden methods.
2466    if (isRelatedResultTypeCompatible && overridden->hasRelatedResultType())
2467      ObjCMethod->SetRelatedResultType();
2468
2469    // Then merge the declarations.
2470    mergeObjCMethodDecls(ObjCMethod, overridden);
2471  }
2472
2473  bool ARCError = false;
2474  if (getLangOptions().ObjCAutoRefCount)
2475    ARCError = CheckARCMethodDecl(*this, ObjCMethod);
2476
2477  if (!ARCError && isRelatedResultTypeCompatible &&
2478      !ObjCMethod->hasRelatedResultType()) {
2479    bool InferRelatedResultType = false;
2480    switch (ObjCMethod->getMethodFamily()) {
2481    case OMF_None:
2482    case OMF_copy:
2483    case OMF_dealloc:
2484    case OMF_mutableCopy:
2485    case OMF_release:
2486    case OMF_retainCount:
2487    case OMF_performSelector:
2488      break;
2489
2490    case OMF_alloc:
2491    case OMF_new:
2492      InferRelatedResultType = ObjCMethod->isClassMethod();
2493      break;
2494
2495    case OMF_init:
2496    case OMF_autorelease:
2497    case OMF_retain:
2498    case OMF_self:
2499      InferRelatedResultType = ObjCMethod->isInstanceMethod();
2500      break;
2501    }
2502
2503    if (InferRelatedResultType)
2504      ObjCMethod->SetRelatedResultType();
2505  }
2506
2507  return ObjCMethod;
2508}
2509
2510bool Sema::CheckObjCDeclScope(Decl *D) {
2511  if (isa<TranslationUnitDecl>(CurContext->getRedeclContext()))
2512    return false;
2513
2514  Diag(D->getLocation(), diag::err_objc_decls_may_only_appear_in_global_scope);
2515  D->setInvalidDecl();
2516
2517  return true;
2518}
2519
2520/// Called whenever @defs(ClassName) is encountered in the source.  Inserts the
2521/// instance variables of ClassName into Decls.
2522void Sema::ActOnDefs(Scope *S, Decl *TagD, SourceLocation DeclStart,
2523                     IdentifierInfo *ClassName,
2524                     SmallVectorImpl<Decl*> &Decls) {
2525  // Check that ClassName is a valid class
2526  ObjCInterfaceDecl *Class = getObjCInterfaceDecl(ClassName, DeclStart);
2527  if (!Class) {
2528    Diag(DeclStart, diag::err_undef_interface) << ClassName;
2529    return;
2530  }
2531  if (LangOpts.ObjCNonFragileABI) {
2532    Diag(DeclStart, diag::err_atdef_nonfragile_interface);
2533    return;
2534  }
2535
2536  // Collect the instance variables
2537  SmallVector<const ObjCIvarDecl*, 32> Ivars;
2538  Context.DeepCollectObjCIvars(Class, true, Ivars);
2539  // For each ivar, create a fresh ObjCAtDefsFieldDecl.
2540  for (unsigned i = 0; i < Ivars.size(); i++) {
2541    const FieldDecl* ID = cast<FieldDecl>(Ivars[i]);
2542    RecordDecl *Record = dyn_cast<RecordDecl>(TagD);
2543    Decl *FD = ObjCAtDefsFieldDecl::Create(Context, Record,
2544                                           /*FIXME: StartL=*/ID->getLocation(),
2545                                           ID->getLocation(),
2546                                           ID->getIdentifier(), ID->getType(),
2547                                           ID->getBitWidth());
2548    Decls.push_back(FD);
2549  }
2550
2551  // Introduce all of these fields into the appropriate scope.
2552  for (SmallVectorImpl<Decl*>::iterator D = Decls.begin();
2553       D != Decls.end(); ++D) {
2554    FieldDecl *FD = cast<FieldDecl>(*D);
2555    if (getLangOptions().CPlusPlus)
2556      PushOnScopeChains(cast<FieldDecl>(FD), S);
2557    else if (RecordDecl *Record = dyn_cast<RecordDecl>(TagD))
2558      Record->addDecl(FD);
2559  }
2560}
2561
2562/// \brief Build a type-check a new Objective-C exception variable declaration.
2563VarDecl *Sema::BuildObjCExceptionDecl(TypeSourceInfo *TInfo, QualType T,
2564                                      SourceLocation StartLoc,
2565                                      SourceLocation IdLoc,
2566                                      IdentifierInfo *Id,
2567                                      bool Invalid) {
2568  // ISO/IEC TR 18037 S6.7.3: "The type of an object with automatic storage
2569  // duration shall not be qualified by an address-space qualifier."
2570  // Since all parameters have automatic store duration, they can not have
2571  // an address space.
2572  if (T.getAddressSpace() != 0) {
2573    Diag(IdLoc, diag::err_arg_with_address_space);
2574    Invalid = true;
2575  }
2576
2577  // An @catch parameter must be an unqualified object pointer type;
2578  // FIXME: Recover from "NSObject foo" by inserting the * in "NSObject *foo"?
2579  if (Invalid) {
2580    // Don't do any further checking.
2581  } else if (T->isDependentType()) {
2582    // Okay: we don't know what this type will instantiate to.
2583  } else if (!T->isObjCObjectPointerType()) {
2584    Invalid = true;
2585    Diag(IdLoc ,diag::err_catch_param_not_objc_type);
2586  } else if (T->isObjCQualifiedIdType()) {
2587    Invalid = true;
2588    Diag(IdLoc, diag::err_illegal_qualifiers_on_catch_parm);
2589  }
2590
2591  VarDecl *New = VarDecl::Create(Context, CurContext, StartLoc, IdLoc, Id,
2592                                 T, TInfo, SC_None, SC_None);
2593  New->setExceptionVariable(true);
2594
2595  if (Invalid)
2596    New->setInvalidDecl();
2597  return New;
2598}
2599
2600Decl *Sema::ActOnObjCExceptionDecl(Scope *S, Declarator &D) {
2601  const DeclSpec &DS = D.getDeclSpec();
2602
2603  // We allow the "register" storage class on exception variables because
2604  // GCC did, but we drop it completely. Any other storage class is an error.
2605  if (DS.getStorageClassSpec() == DeclSpec::SCS_register) {
2606    Diag(DS.getStorageClassSpecLoc(), diag::warn_register_objc_catch_parm)
2607      << FixItHint::CreateRemoval(SourceRange(DS.getStorageClassSpecLoc()));
2608  } else if (DS.getStorageClassSpec() != DeclSpec::SCS_unspecified) {
2609    Diag(DS.getStorageClassSpecLoc(), diag::err_storage_spec_on_catch_parm)
2610      << DS.getStorageClassSpec();
2611  }
2612  if (D.getDeclSpec().isThreadSpecified())
2613    Diag(D.getDeclSpec().getThreadSpecLoc(), diag::err_invalid_thread);
2614  D.getMutableDeclSpec().ClearStorageClassSpecs();
2615
2616  DiagnoseFunctionSpecifiers(D);
2617
2618  // Check that there are no default arguments inside the type of this
2619  // exception object (C++ only).
2620  if (getLangOptions().CPlusPlus)
2621    CheckExtraCXXDefaultArguments(D);
2622
2623  TypeSourceInfo *TInfo = GetTypeForDeclarator(D, S);
2624  QualType ExceptionType = TInfo->getType();
2625
2626  VarDecl *New = BuildObjCExceptionDecl(TInfo, ExceptionType,
2627                                        D.getSourceRange().getBegin(),
2628                                        D.getIdentifierLoc(),
2629                                        D.getIdentifier(),
2630                                        D.isInvalidType());
2631
2632  // Parameter declarators cannot be qualified (C++ [dcl.meaning]p1).
2633  if (D.getCXXScopeSpec().isSet()) {
2634    Diag(D.getIdentifierLoc(), diag::err_qualified_objc_catch_parm)
2635      << D.getCXXScopeSpec().getRange();
2636    New->setInvalidDecl();
2637  }
2638
2639  // Add the parameter declaration into this scope.
2640  S->AddDecl(New);
2641  if (D.getIdentifier())
2642    IdResolver.AddDecl(New);
2643
2644  ProcessDeclAttributes(S, New, D);
2645
2646  if (New->hasAttr<BlocksAttr>())
2647    Diag(New->getLocation(), diag::err_block_on_nonlocal);
2648  return New;
2649}
2650
2651/// CollectIvarsToConstructOrDestruct - Collect those ivars which require
2652/// initialization.
2653void Sema::CollectIvarsToConstructOrDestruct(ObjCInterfaceDecl *OI,
2654                                SmallVectorImpl<ObjCIvarDecl*> &Ivars) {
2655  for (ObjCIvarDecl *Iv = OI->all_declared_ivar_begin(); Iv;
2656       Iv= Iv->getNextIvar()) {
2657    QualType QT = Context.getBaseElementType(Iv->getType());
2658    if (QT->isRecordType())
2659      Ivars.push_back(Iv);
2660  }
2661}
2662
2663void Sema::DiagnoseUseOfUnimplementedSelectors() {
2664  // Warning will be issued only when selector table is
2665  // generated (which means there is at lease one implementation
2666  // in the TU). This is to match gcc's behavior.
2667  if (ReferencedSelectors.empty() ||
2668      !Context.AnyObjCImplementation())
2669    return;
2670  for (llvm::DenseMap<Selector, SourceLocation>::iterator S =
2671        ReferencedSelectors.begin(),
2672       E = ReferencedSelectors.end(); S != E; ++S) {
2673    Selector Sel = (*S).first;
2674    if (!LookupImplementedMethodInGlobalPool(Sel))
2675      Diag((*S).second, diag::warn_unimplemented_selector) << Sel;
2676  }
2677  return;
2678}
2679