aboutsummaryrefslogtreecommitdiff
path: root/Foundation/GTMGarbageCollection.h
blob: 58c814037f7f57ef678f1c3048294c52f2d0b838 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
//
//  GTMGarbageCollection.h
//
//  Copyright 2007-2008 Google Inc.
//
//  Licensed under the Apache License, Version 2.0 (the "License"); you may not
//  use this file except in compliance with the License.  You may obtain a copy
//  of the License at
// 
//  http://www.apache.org/licenses/LICENSE-2.0
// 
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
//  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
//  License for the specific language governing permissions and limitations under
//  the License.
//

#import <Foundation/Foundation.h>

#import "GTMDefines.h"

// This allows us to easily move our code from GC to non GC.
// They are no-ops unless we are require Leopard or above.
// See 
// http://developer.apple.com/documentation/Cocoa/Conceptual/GarbageCollection/index.html
// and
// http://developer.apple.com/documentation/Cocoa/Conceptual/GarbageCollection/Articles/gcCoreFoundation.html#//apple_ref/doc/uid/TP40006687-SW1
// for details.

#if (MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5) && !GTM_IPHONE_SDK
// General use would be to call this through GTMCFAutorelease
// but there may be a reason the you want to make something collectable
// but not autoreleased, especially in pure GC code where you don't
// want to bother with the nop autorelease.
GTM_INLINE id GTMNSMakeCollectable(CFTypeRef cf) { 
  return NSMakeCollectable(cf); 
}

// GTMNSMakeUncollectable is for global maps, etc. that we don't
// want released ever. You should still retain these in non-gc code.
GTM_INLINE void GTMNSMakeUncollectable(id object) {
  [[NSGarbageCollector defaultCollector] disableCollectorForPointer:object];
}

// Hopefully no code really needs this, but GTMIsGarbageCollectionEnabled is
// a common way to check at runtime if GC is on.
// There are some places where GC doesn't work w/ things w/in Apple's
// frameworks, so this is here so GTM unittests and detect it, and not run
// individual tests to work around bugs in Apple's frameworks.
GTM_INLINE BOOL GTMIsGarbageCollectionEnabled(void) {
  return ([NSGarbageCollector defaultCollector] != nil);
}

#else

GTM_INLINE id GTMNSMakeCollectable(CFTypeRef cf) { 
  // NSMakeCollectable handles NULLs just fine and returns nil as expected.
  return (id)cf;
}

GTM_INLINE void GTMNSMakeUncollectable(id object) {
}

GTM_INLINE BOOL GTMIsGarbageCollectionEnabled(void) {
  return NO;
}

#endif

// GTMCFAutorelease makes a CF object collectable in GC mode, or adds it 
// to the autorelease pool in non-GC mode. Either way it is taken care
// of.
GTM_INLINE id GTMCFAutorelease(CFTypeRef cf) {
  return [GTMNSMakeCollectable(cf) autorelease];
}