CocoaConventions.cpp revision 80cb6e69d9e85231588ae604e4bc2bc9a07389af 
1//===- CocoaConventions.h - Special handling of Cocoa conventions -*- 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 implements cocoa naming convention analysis.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Analysis/DomainSpecific/CocoaConventions.h"
15#include "clang/AST/Type.h"
16#include "clang/AST/Decl.h"
17#include "clang/AST/DeclObjC.h"
18#include "llvm/ADT/StringExtras.h"
19#include "llvm/Support/ErrorHandling.h"
20using namespace clang;
21using namespace ento;
22
23// The "fundamental rule" for naming conventions of methods:
24//  (url broken into two lines)
25//  http://developer.apple.com/documentation/Cocoa/Conceptual/
26//     MemoryMgmt/Tasks/MemoryManagementRules.html
27//
28// "You take ownership of an object if you create it using a method whose name
29//  begins with "alloc" or "new" or contains "copy" (for example, alloc,
30//  newObject, or mutableCopy), or if you send it a retain message. You are
31//  responsible for relinquishing ownership of objects you own using release
32//  or autorelease. Any other time you receive an object, you must
33//  not release it."
34//
35
36cocoa::NamingConvention cocoa::deriveNamingConvention(Selector S,
37                                                    const ObjCMethodDecl *MD) {
38  switch (MD && MD->hasAttr<ObjCMethodFamilyAttr>()? MD->getMethodFamily()
39                                                   : S.getMethodFamily()) {
40  case OMF_None:
41  case OMF_autorelease:
42  case OMF_dealloc:
43  case OMF_finalize:
44  case OMF_release:
45  case OMF_retain:
46  case OMF_retainCount:
47  case OMF_self:
48  case OMF_performSelector:
49    return NoConvention;
50
51  case OMF_init:
52    return InitRule;
53
54  case OMF_alloc:
55  case OMF_copy:
56  case OMF_mutableCopy:
57  case OMF_new:
58    return CreateRule;
59  }
60  llvm_unreachable("unexpected naming convention");
61  return NoConvention;
62}
63
64bool cocoa::isRefType(QualType RetTy, StringRef Prefix,
65                      StringRef Name) {
66  // Recursively walk the typedef stack, allowing typedefs of reference types.
67  while (const TypedefType *TD = dyn_cast<TypedefType>(RetTy.getTypePtr())) {
68    StringRef TDName = TD->getDecl()->getIdentifier()->getName();
69    if (TDName.startswith(Prefix) && TDName.endswith("Ref"))
70      return true;
71
72    RetTy = TD->getDecl()->getUnderlyingType();
73  }
74
75  if (Name.empty())
76    return false;
77
78  // Is the type void*?
79  const PointerType* PT = RetTy->getAs<PointerType>();
80  if (!(PT->getPointeeType().getUnqualifiedType()->isVoidType()))
81    return false;
82
83  // Does the name start with the prefix?
84  return Name.startswith(Prefix);
85}
86
87bool coreFoundation::isCFObjectRef(QualType T) {
88  return cocoa::isRefType(T, "CF") || // Core Foundation.
89         cocoa::isRefType(T, "CG") || // Core Graphics.
90         cocoa::isRefType(T, "DADisk") || // Disk Arbitration API.
91         cocoa::isRefType(T, "DADissenter") ||
92         cocoa::isRefType(T, "DASessionRef");
93}
94
95
96bool cocoa::isCocoaObjectRef(QualType Ty) {
97  if (!Ty->isObjCObjectPointerType())
98    return false;
99
100  const ObjCObjectPointerType *PT = Ty->getAs<ObjCObjectPointerType>();
101
102  // Can be true for objects with the 'NSObject' attribute.
103  if (!PT)
104    return true;
105
106  // We assume that id<..>, id, Class, and Class<..> all represent tracked
107  // objects.
108  if (PT->isObjCIdType() || PT->isObjCQualifiedIdType() ||
109      PT->isObjCClassType() || PT->isObjCQualifiedClassType())
110    return true;
111
112  // Does the interface subclass NSObject?
113  // FIXME: We can memoize here if this gets too expensive.
114  const ObjCInterfaceDecl *ID = PT->getInterfaceDecl();
115
116  // Assume that anything declared with a forward declaration and no
117  // @interface subclasses NSObject.
118  if (ID->isForwardDecl())
119    return true;
120
121  for ( ; ID ; ID = ID->getSuperClass())
122    if (ID->getIdentifier()->getName() == "NSObject")
123      return true;
124
125  return false;
126}
127
128bool coreFoundation::followsCreateRule(StringRef functionName) {
129  StringRef::iterator it = functionName.begin();
130  StringRef::iterator start = it;
131  StringRef::iterator endI = functionName.end();
132
133  while (true) {
134    // Scan for the start of 'create' or 'copy'.
135    for ( ; it != endI ; ++it) {
136      // Search for the first character.  It can either be 'C' or 'c'.
137      char ch = *it;
138      if (ch == 'C' || ch == 'c') {
139        ++it;
140        break;
141      }
142    }
143
144    // Did we hit the end of the string?  If so, we didn't find a match.
145    if (it == endI)
146      return false;
147
148    // Scan for *lowercase* 'reate' or 'opy', followed by no lowercase
149    // character.
150    StringRef suffix = functionName.substr(it - start);
151    if (suffix.startswith("reate")) {
152      it += 5;
153    }
154    else if (suffix.startswith("opy")) {
155      it += 3;
156    } else {
157      // Keep scanning.
158      continue;
159    }
160
161    if (it == endI || !islower(*it))
162      return true;
163
164    // If we matched a lowercase character, it isn't the end of the
165    // word.  Keep scanning.
166  }
167
168  return false;
169}
170