1 /*
2 File: CACFObject.h
3 Abstract: Part of CoreAudio Utility Classes
4 Version: 1.1
5
6 Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple
7 Inc. ("Apple") in consideration of your agreement to the following
8 terms, and your use, installation, modification or redistribution of
9 this Apple software constitutes acceptance of these terms. If you do
10 not agree with these terms, please do not use, install, modify or
11 redistribute this Apple software.
12
13 In consideration of your agreement to abide by the following terms, and
14 subject to these terms, Apple grants you a personal, non-exclusive
15 license, under Apple's copyrights in this original Apple software (the
16 "Apple Software"), to use, reproduce, modify and redistribute the Apple
17 Software, with or without modifications, in source and/or binary forms;
18 provided that if you redistribute the Apple Software in its entirety and
19 without modifications, you must retain this notice and the following
20 text and disclaimers in all such redistributions of the Apple Software.
21 Neither the name, trademarks, service marks or logos of Apple Inc. may
22 be used to endorse or promote products derived from the Apple Software
23 without specific prior written permission from Apple. Except as
24 expressly stated in this notice, no other rights or licenses, express or
25 implied, are granted by Apple herein, including but not limited to any
26 patent rights that may be infringed by your derivative works or by other
27 works in which the Apple Software may be incorporated.
28
29 The Apple Software is provided by Apple on an "AS IS" basis. APPLE
30 MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
31 THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
32 FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
33 OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
34
35 IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
36 OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
39 MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
40 AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
41 STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
42 POSSIBILITY OF SUCH DAMAGE.
43
44 Copyright (C) 2014 Apple Inc. All Rights Reserved.
45
46 */
47 #if !defined(__CACFObject_h__)
48 #define __CACFObject_h__
49
50 //=============================================================================
51 // Includes
52 //=============================================================================
53
54 #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__)
55 #include <CoreAudio/CoreAudioTypes.h>
56 #include <CoreFoundation/CoreFoundation.h>
57 #else
58 #include <CoreAudioTypes.h>
59 #include <CoreFoundation.h>
60 #endif
61
62 //=============================================================================
63 // Wrappers for CFRetain and CFRelease that check for NULL
64 //=============================================================================
65
66 template <typename CFObjectType>
CACFRetain(CFObjectType inObject)67 CFObjectType CACFRetain(CFObjectType inObject)
68 {
69 CFObjectType theAnswer = inObject;
70 if(inObject != NULL)
71 {
72 theAnswer = reinterpret_cast<CFObjectType>(CFRetain(inObject));
73 }
74 return theAnswer;
75 }
76
CACFRelease(CFTypeRef inObject)77 inline void CACFRelease(CFTypeRef inObject)
78 {
79 if(inObject != NULL)
80 {
81 CFRelease(inObject);
82 }
83 }
84
85 //=============================================================================
86 // CACFObject
87 //
88 // Notes
89 // - Using the AssignWithoutRetain() method will fool the static analyzer into thinking that the
90 // CFObject being assigned will be leaked. This is because the static analyzer is not smart
91 // enough to understand that the destructor will release the object.
92 //=============================================================================
93
94 template <class CFObjectType>
95 class CACFObject
96 {
97
98 // Construction/Destruction
99 public:
CACFObject()100 CACFObject() : mCFObject(NULL), mWillRelease(true) {}
CACFObject(CFObjectType inCFObject)101 explicit CACFObject(CFObjectType inCFObject) : mCFObject(inCFObject), mWillRelease(true) {}
CACFObject(CFObjectType inCFObject,bool inWillRelease)102 CACFObject(CFObjectType inCFObject, bool inWillRelease) : mCFObject(inCFObject), mWillRelease(inWillRelease) {}
~CACFObject()103 ~CACFObject() { Release(); }
CACFObject(const CACFObject & inObject)104 CACFObject(const CACFObject& inObject) : mCFObject(inObject.mCFObject), mWillRelease(inObject.mWillRelease) { Retain(); }
105 CACFObject& operator=(const CACFObject& inObject) { Release(); mCFObject = inObject.mCFObject; mWillRelease = inObject.mWillRelease; Retain(); return *this; }
106 CACFObject& operator=(CFObjectType inCFObject) { Release(); mCFObject = inCFObject; mWillRelease = true; Retain(); return *this; }
AssignWithoutRetain(CFObjectType inObject)107 void AssignWithoutRetain(CFObjectType inObject) { if (inObject != mCFObject) { Release(); mCFObject = inObject; } mWillRelease = true; }
108
109 private:
Retain()110 void Retain() { if(mWillRelease && (mCFObject != NULL)) { CFRetain(mCFObject); } }
Release()111 void Release() { if(mWillRelease && (mCFObject != NULL)) { CFRelease(mCFObject); mCFObject = NULL; } }
112
113 CFObjectType mCFObject;
114 bool mWillRelease;
115
116 // Operations
117 public:
AllowRelease()118 void AllowRelease() { mWillRelease = true; }
DontAllowRelease()119 void DontAllowRelease() { mWillRelease = false; }
IsValid()120 bool IsValid() const { return mCFObject != NULL; }
GetTypeID()121 CFTypeID GetTypeID() const { return CFGetTypeID(mCFObject); }
IsEqual(CFObjectType inCFObject)122 bool IsEqual(CFObjectType inCFObject) const { return CFEqual(inCFObject, mCFObject) != 0; }
123
124 // Value Access
125 public:
GetCFObject()126 CFObjectType GetCFObject() const { return mCFObject; }
CopyCFObject()127 CFObjectType CopyCFObject() const { if(mCFObject != NULL) { CFRetain(mCFObject); } return mCFObject; }
GetPointerToStorage()128 const CFObjectType* GetPointerToStorage() const { return &mCFObject; }
129
130 };
131
132 typedef CACFObject<CFBundleRef> CACFBundle;
133 typedef CACFObject<CFPropertyListRef> CACFPropertyList;
134 typedef CACFObject<CFTypeRef> CACFType;
135 typedef CACFObject<CFUUIDRef> CACFUUID;
136 typedef CACFObject<CFURLRef> CACFURL;
137
138 #endif
139