CheckObjCInstMethSignature.cpp revision b8989f27f116ff2400e92a52c067a69846119eb5 
1//=- CheckObjCInstMethodRetTy.cpp - Check ObjC method signatures -*- C++ -*-==//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file defines a CheckObjCInstMethSignature, a flow-insenstive check
11//  that determines if an Objective-C class interface incorrectly redefines
12//  the method signature in a subclass.
13//
14//===----------------------------------------------------------------------===//
15
16#include "ClangSACheckers.h"
17#include "clang/StaticAnalyzer/Core/Checker.h"
18#include "clang/StaticAnalyzer/Core/BugReporter/PathDiagnostic.h"
19#include "clang/StaticAnalyzer/Core/BugReporter/BugReporter.h"
20#include "clang/AST/DeclObjC.h"
21#include "clang/AST/Type.h"
22#include "clang/AST/ASTContext.h"
23
24#include "llvm/ADT/DenseMap.h"
25#include "llvm/Support/raw_ostream.h"
26
27using namespace clang;
28using namespace ento;
29
30static bool AreTypesCompatible(QualType Derived, QualType Ancestor,
31                               ASTContext &C) {
32
33  // Right now don't compare the compatibility of pointers.  That involves
34  // looking at subtyping relationships.  FIXME: Future patch.
35  if (Derived->isAnyPointerType() &&  Ancestor->isAnyPointerType())
36    return true;
37
38  return C.typesAreCompatible(Derived, Ancestor);
39}
40
41static void CompareReturnTypes(const ObjCMethodDecl *MethDerived,
42                               const ObjCMethodDecl *MethAncestor,
43                               BugReporter &BR, ASTContext &Ctx,
44                               const ObjCImplementationDecl *ID) {
45
46  QualType ResDerived  = MethDerived->getResultType();
47  QualType ResAncestor = MethAncestor->getResultType();
48
49  if (!AreTypesCompatible(ResDerived, ResAncestor, Ctx)) {
50    std::string sbuf;
51    llvm::raw_string_ostream os(sbuf);
52
53    os << "The Objective-C class '"
54       << *MethDerived->getClassInterface()
55       << "', which is derived from class '"
56       << *MethAncestor->getClassInterface()
57       << "', defines the instance method '"
58       << MethDerived->getSelector().getAsString()
59       << "' whose return type is '"
60       << ResDerived.getAsString()
61       << "'.  A method with the same name (same selector) is also defined in "
62          "class '"
63       << *MethAncestor->getClassInterface()
64       << "' and has a return type of '"
65       << ResAncestor.getAsString()
66       << "'.  These two types are incompatible, and may result in undefined "
67          "behavior for clients of these classes.";
68
69    PathDiagnosticLocation MethDLoc =
70      PathDiagnosticLocation::createBegin(MethDerived,
71                                          BR.getSourceManager());
72
73    BR.EmitBasicReport("Incompatible instance method return type",
74                       os.str(), MethDLoc);
75  }
76}
77
78static void CheckObjCInstMethSignature(const ObjCImplementationDecl *ID,
79                                       BugReporter& BR) {
80
81  const ObjCInterfaceDecl *D = ID->getClassInterface();
82  const ObjCInterfaceDecl *C = D->getSuperClass();
83
84  if (!C)
85    return;
86
87  ASTContext &Ctx = BR.getContext();
88
89  // Build a DenseMap of the methods for quick querying.
90  typedef llvm::DenseMap<Selector,ObjCMethodDecl*> MapTy;
91  MapTy IMeths;
92  unsigned NumMethods = 0;
93
94  for (ObjCImplementationDecl::instmeth_iterator I=ID->instmeth_begin(),
95       E=ID->instmeth_end(); I!=E; ++I) {
96
97    ObjCMethodDecl *M = *I;
98    IMeths[M->getSelector()] = M;
99    ++NumMethods;
100  }
101
102  // Now recurse the class hierarchy chain looking for methods with the
103  // same signatures.
104  while (C && NumMethods) {
105    for (ObjCInterfaceDecl::instmeth_iterator I=C->instmeth_begin(),
106         E=C->instmeth_end(); I!=E; ++I) {
107
108      ObjCMethodDecl *M = *I;
109      Selector S = M->getSelector();
110
111      MapTy::iterator MI = IMeths.find(S);
112
113      if (MI == IMeths.end() || MI->second == 0)
114        continue;
115
116      --NumMethods;
117      ObjCMethodDecl *MethDerived = MI->second;
118      MI->second = 0;
119
120      CompareReturnTypes(MethDerived, M, BR, Ctx, ID);
121    }
122
123    C = C->getSuperClass();
124  }
125}
126
127//===----------------------------------------------------------------------===//
128// ObjCMethSigsChecker
129//===----------------------------------------------------------------------===//
130
131namespace {
132class ObjCMethSigsChecker : public Checker<
133                                      check::ASTDecl<ObjCImplementationDecl> > {
134public:
135  void checkASTDecl(const ObjCImplementationDecl *D, AnalysisManager& mgr,
136                    BugReporter &BR) const {
137    CheckObjCInstMethSignature(D, BR);
138  }
139};
140}
141
142void ento::registerObjCMethSigsChecker(CheckerManager &mgr) {
143  mgr.registerChecker<ObjCMethSigsChecker>();
144}
145