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