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