NSString.m revision d7d5f0223bd30dfd618762349c6209dd1d5ea3e6 
1// RUN: clang-cc -analyze -checker-cfref -analyzer-store=basic -analyzer-constraints=basic -verify %s &&
2// RUN: clang-cc -analyze -checker-cfref -analyzer-store=basic -analyzer-constraints=range -verify %s &&
3// RUN: clang-cc -analyze -checker-cfref -analyzer-store=region -analyzer-constraints=basic -verify %s &&
4// RUN: clang-cc -analyze -checker-cfref -analyzer-store=region -analyzer-constraints=range -verify %s
5
6//===----------------------------------------------------------------------===//
7// The following code is reduced using delta-debugging from
8// Foundation.h (Mac OS X).
9//
10// It includes the basic definitions for the test cases below.
11// Not directly including Foundation.h directly makes this test case 
12// both svelte and portable to non-Mac platforms.
13//===----------------------------------------------------------------------===//
14
15typedef const void * CFTypeRef;
16typedef const struct __CFString * CFStringRef;
17typedef const struct __CFAllocator * CFAllocatorRef;
18extern const CFAllocatorRef kCFAllocatorDefault;
19extern CFTypeRef CFRetain(CFTypeRef cf);
20typedef const struct __CFDictionary * CFDictionaryRef;
21const void *CFDictionaryGetValue(CFDictionaryRef theDict, const void *key);
22extern CFStringRef CFStringCreateWithFormat(CFAllocatorRef alloc, CFDictionaryRef formatOptions, CFStringRef format, ...);
23typedef signed char BOOL;
24typedef int NSInteger;
25typedef unsigned int NSUInteger;
26@class NSString, Protocol;
27extern void NSLog(NSString *format, ...) __attribute__((format(__NSString__, 1, 2)));
28typedef NSInteger NSComparisonResult;
29typedef struct _NSZone NSZone;
30@class NSInvocation, NSMethodSignature, NSCoder, NSString, NSEnumerator;
31@protocol NSObject
32- (BOOL)isEqual:(id)object;
33- (oneway void)release;
34- (id)retain;
35@end
36@protocol NSCopying
37- (id)copyWithZone:(NSZone *)zone;
38@end
39@protocol NSMutableCopying
40- (id)mutableCopyWithZone:(NSZone *)zone;
41@end
42@protocol NSCoding
43- (void)encodeWithCoder:(NSCoder *)aCoder;
44@end
45@interface NSObject <NSObject> {}
46- (id)init;
47+ (id)alloc;
48@end
49extern id NSAllocateObject(Class aClass, NSUInteger extraBytes, NSZone *zone);
50typedef struct {} NSFastEnumerationState;
51@protocol NSFastEnumeration
52- (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)stackbuf count:(NSUInteger)len;
53@end
54@class NSString;
55typedef struct _NSRange {} NSRange;
56@interface NSArray : NSObject <NSCopying, NSMutableCopying, NSCoding, NSFastEnumeration>
57- (NSUInteger)count;
58@end
59@interface NSMutableArray : NSArray
60- (void)addObject:(id)anObject;
61- (id)initWithCapacity:(NSUInteger)numItems;
62@end
63typedef unsigned short unichar;
64@class NSData, NSArray, NSDictionary, NSCharacterSet, NSData, NSURL, NSError, NSLocale;
65typedef NSUInteger NSStringCompareOptions;
66@interface NSString : NSObject <NSCopying, NSMutableCopying, NSCoding>    - (NSUInteger)length;
67- (NSComparisonResult)compare:(NSString *)string;
68- (NSComparisonResult)compare:(NSString *)string options:(NSStringCompareOptions)mask;
69- (NSComparisonResult)compare:(NSString *)string options:(NSStringCompareOptions)mask range:(NSRange)compareRange;
70- (NSComparisonResult)compare:(NSString *)string options:(NSStringCompareOptions)mask range:(NSRange)compareRange locale:(id)locale;
71- (NSComparisonResult)caseInsensitiveCompare:(NSString *)string;
72- (NSArray *)componentsSeparatedByCharactersInSet:(NSCharacterSet *)separator;
73@end
74@interface NSSimpleCString : NSString {} @end
75@interface NSConstantString : NSSimpleCString @end
76extern void *_NSConstantStringClassReference;
77
78//===----------------------------------------------------------------------===//
79// Test cases.
80//===----------------------------------------------------------------------===//
81
82NSComparisonResult f1(NSString* s) {
83  NSString *aString = 0;
84  return [s compare:aString]; // expected-warning {{Argument to 'NSString' method 'compare:' cannot be nil.}}
85}
86
87NSComparisonResult f2(NSString* s) {
88  NSString *aString = 0;
89  return [s caseInsensitiveCompare:aString]; // expected-warning {{Argument to 'NSString' method 'caseInsensitiveCompare:' cannot be nil.}}
90}
91
92NSComparisonResult f3(NSString* s, NSStringCompareOptions op) {
93  NSString *aString = 0;
94  return [s compare:aString options:op]; // expected-warning {{Argument to 'NSString' method 'compare:options:' cannot be nil.}}
95}
96
97NSComparisonResult f4(NSString* s, NSStringCompareOptions op, NSRange R) {
98  NSString *aString = 0;
99  return [s compare:aString options:op range:R]; // expected-warning {{Argument to 'NSString' method 'compare:options:range:' cannot be nil.}}
100}
101
102NSComparisonResult f5(NSString* s, NSStringCompareOptions op, NSRange R) {
103  NSString *aString = 0;
104  return [s compare:aString options:op range:R locale:0]; // expected-warning {{Argument to 'NSString' method 'compare:options:range:locale:' cannot be nil.}}
105}
106
107NSArray *f6(NSString* s) {
108  return [s componentsSeparatedByCharactersInSet:0]; // expected-warning {{Argument to 'NSString' method 'componentsSeparatedByCharactersInSet:' cannot be nil.}}
109}
110
111NSString* f7(NSString* s1, NSString* s2, NSString* s3) {
112
113  NSString* s4 = (NSString*)
114    CFStringCreateWithFormat(kCFAllocatorDefault, 0,  // expected-warning{{leak}}
115                             (CFStringRef) __builtin___CFStringMakeConstantString("%@ %@ (%@)"), 
116                             s1, s2, s3);
117
118  CFRetain(s4);
119  return s4;
120}
121
122NSMutableArray* f8() {
123  
124  NSString* s = [[NSString alloc] init];
125  NSMutableArray* a = [[NSMutableArray alloc] initWithCapacity:2];
126  [a addObject:s];
127  [s release]; // no-warning
128  return a;
129}
130
131void f9() {
132  
133  NSString* s = [[NSString alloc] init];
134  NSString* q = s;
135  [s release];
136  [q release]; // expected-warning {{used after it is released}}
137}
138
139NSString* f10() {
140  static NSString* s = 0;
141  if (!s) s = [[NSString alloc] init];
142  return s; // no-warning
143}
144
145// Test case for regression reported in <rdar://problem/6452745>.
146// Essentially 's' should not be considered allocated on the false branch.
147// This exercises the 'EvalAssume' logic in GRTransferFuncs (CFRefCount.cpp).
148NSString* f11(CFDictionaryRef dict, const char* key) {
149  NSString* s = (NSString*) CFDictionaryGetValue(dict, key);
150  [s retain];
151  if (s) {
152    [s release];
153  }
154}
155
156// Test case for passing a tracked object by-reference to a function we
157// don't undersand.
158void unknown_function_f12(NSString** s);
159void f12() {
160  NSString *string = [[NSString alloc] init];
161  unknown_function_f12(&string); // no-warning
162}
163
164
165@interface C1 : NSObject {}
166- (NSString*) getShared;
167+ (C1*) sharedInstance;
168@end
169@implementation C1 : NSObject {}
170- (NSString*) getShared {
171  static NSString* s = 0;
172  if (!s) s = [[NSString alloc] init];    
173  return s; // no-warning  
174}
175+ (C1 *)sharedInstance {
176  static C1 *sharedInstance = 0;
177  if (!sharedInstance) {
178    sharedInstance = [[C1 alloc] init];
179  }
180  return sharedInstance; // no-warning
181}
182@end
183
184@interface SharedClass : NSObject
185+ (id)sharedInstance;
186- (id)notShared;
187@end
188
189@implementation SharedClass
190
191- (id)_init {
192    if ((self = [super init])) {
193        NSLog(@"Bar");
194    }
195    return self;
196}
197
198- (id)notShared {
199  return [[SharedClass alloc] _init]; // expected-warning{{leak}}
200}
201
202+ (id)sharedInstance {
203    static SharedClass *_sharedInstance = 0;
204    if (!_sharedInstance) {
205        _sharedInstance = [[SharedClass alloc] _init];
206    }
207    return _sharedInstance; // no-warning
208}
209@end
210
211id testSharedClassFromFunction() {
212  return [[SharedClass alloc] _init]; // no-warning
213}
214
215