1 /* Copyright: � Copyright 2005 Apple Computer, Inc. All rights reserved. 2 3 Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Computer, Inc. 4 ("Apple") in consideration of your agreement to the following terms, and your 5 use, installation, modification or redistribution of this Apple software 6 constitutes acceptance of these terms. If you do not agree with these terms, 7 please do not use, install, modify or redistribute this Apple software. 8 9 In consideration of your agreement to abide by the following terms, and subject 10 to these terms, Apple grants you a personal, non-exclusive license, under Apple�s 11 copyrights in this original Apple software (the "Apple Software"), to use, 12 reproduce, modify and redistribute the Apple Software, with or without 13 modifications, in source and/or binary forms; provided that if you redistribute 14 the Apple Software in its entirety and without modifications, you must retain 15 this notice and the following text and disclaimers in all such redistributions of 16 the Apple Software. Neither the name, trademarks, service marks or logos of 17 Apple Computer, Inc. may be used to endorse or promote products derived from the 18 Apple Software without specific prior written permission from Apple. Except as 19 expressly stated in this notice, no other rights or licenses, express or implied, 20 are granted by Apple herein, including but not limited to any patent rights that 21 may be infringed by your derivative works or by other works in which the Apple 22 Software may be incorporated. 23 24 The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO 25 WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED 26 WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR 27 PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN 28 COMBINATION WITH YOUR PRODUCTS. 29 30 IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR 31 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 32 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION 34 OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT 35 (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN 36 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37 */ 38 /*============================================================================= 39 CACFString.h 40 41 =============================================================================*/ 42 #if !defined(__CACFString_h__) 43 #define __CACFString_h__ 44 45 //============================================================================= 46 // Includes 47 //============================================================================= 48 49 #if !defined(__COREAUDIO_USE_FLAT_INCLUDES__) 50 #include <CoreAudio/CoreAudioTypes.h> 51 #include <CoreFoundation/CFString.h> 52 #else 53 #include <CoreAudioTypes.h> 54 #include <CFString.h> 55 #endif 56 57 //============================================================================= 58 // CACFString 59 //============================================================================= 60 61 class CACFString 62 { 63 // Construction/Destruction 64 public: CACFString()65 CACFString() : mCFString(NULL), mWillRelease(true) {} mCFString(inCFString)66 CACFString(CFStringRef inCFString, bool inWillRelease = true) : mCFString(inCFString), mWillRelease(inWillRelease) {} mCFString(CFStringCreateWithCString (NULL,inCString,kCFStringEncodingASCII))67 CACFString(const char* inCString, bool inWillRelease = true) : mCFString(CFStringCreateWithCString(NULL, inCString, kCFStringEncodingASCII)), mWillRelease(inWillRelease) {} mCFString(CFStringCreateWithCString (NULL,inCString,inCStringEncoding))68 CACFString(const char* inCString, CFStringEncoding inCStringEncoding, bool inWillRelease = true) : mCFString(CFStringCreateWithCString(NULL, inCString, inCStringEncoding)), mWillRelease(inWillRelease) {} ~CACFString()69 ~CACFString() { Release(); } CACFString(const CACFString & inString)70 CACFString(const CACFString& inString) : mCFString(inString.mCFString), mWillRelease(inString.mWillRelease) { Retain(); } 71 CACFString& operator=(const CACFString& inString) { Release(); mCFString = inString.mCFString; mWillRelease = inString.mWillRelease; Retain(); return *this; } 72 CACFString& operator=(CFStringRef inCFString) { Release(); mCFString = inCFString; mWillRelease = true; return *this; } 73 74 private: Retain()75 void Retain() { if(mWillRelease && (mCFString != NULL)) { CFRetain(mCFString); } } Release()76 void Release() { if(mWillRelease && (mCFString != NULL)) { CFRelease(mCFString); } } 77 78 CFStringRef mCFString; 79 bool mWillRelease; 80 81 // Operations 82 public: AllowRelease()83 void AllowRelease() { mWillRelease = true; } DontAllowRelease()84 void DontAllowRelease() { mWillRelease = false; } IsValid()85 bool IsValid() const { return mCFString != NULL; } StartsWith(CFStringRef inString)86 bool StartsWith(CFStringRef inString) const { bool theAnswer = false; if(mCFString != NULL) { theAnswer = CFStringHasPrefix(mCFString, inString); } return theAnswer; } EndsWith(CFStringRef inString)87 bool EndsWith(CFStringRef inString) const { bool theAnswer = false; if(mCFString != NULL) { theAnswer = CFStringHasSuffix(mCFString, inString); } return theAnswer; } 88 89 // Value Access 90 public: GetCFString()91 CFStringRef GetCFString() const { return mCFString; } CopyCFString()92 CFStringRef CopyCFString() const { if(mCFString != NULL) { CFRetain(mCFString); } return mCFString; } GetLength()93 UInt32 GetLength() const { UInt32 theAnswer = 0; if(mCFString != NULL) { theAnswer = CFStringGetLength(mCFString); } return theAnswer; } 94 UInt32 GetByteLength(CFStringEncoding inEncoding = kCFStringEncodingUTF8) const { UInt32 theAnswer = 0; if(mCFString != NULL) { theAnswer = GetStringByteLength(mCFString, inEncoding); } return theAnswer; } 95 void GetCString(char* outString, UInt32& ioStringSize, CFStringEncoding inEncoding = kCFStringEncodingUTF8) const { GetCString(mCFString, outString, ioStringSize, inEncoding); } GetUnicodeString(UInt16 * outString,UInt32 & ioStringSize)96 void GetUnicodeString(UInt16* outString, UInt32& ioStringSize) const { GetUnicodeString(mCFString, outString, ioStringSize); } 97 98 static UInt32 GetStringByteLength(CFStringRef inCFString, CFStringEncoding inEncoding = kCFStringEncodingUTF8); 99 static void GetCString(CFStringRef inCFString, char* outString, UInt32& ioStringSize, CFStringEncoding inEncoding = kCFStringEncodingUTF8); 100 static void GetUnicodeString(CFStringRef inCFString, UInt16* outString, UInt32& ioStringSize); 101 102 }; 103 104 inline bool operator<(const CACFString& x, const CACFString& y) { return CFStringCompare(x.GetCFString(), y.GetCFString(), 0) == kCFCompareLessThan; } 105 inline bool operator==(const CACFString& x, const CACFString& y) { return CFStringCompare(x.GetCFString(), y.GetCFString(), 0) == kCFCompareEqualTo; } 106 inline bool operator!=(const CACFString& x, const CACFString& y) { return !(x == y); } 107 inline bool operator<=(const CACFString& x, const CACFString& y) { return (x < y) || (x == y); } 108 inline bool operator>=(const CACFString& x, const CACFString& y) { return !(x < y); } 109 inline bool operator>(const CACFString& x, const CACFString& y) { return !((x < y) || (x == y)); } 110 111 //============================================================================= 112 // CACFMutableString 113 //============================================================================= 114 115 class CACFMutableString 116 { 117 // Construction/Destruction 118 public: CACFMutableString()119 CACFMutableString() : mCFMutableString(NULL), mWillRelease(true) {} mCFMutableString(inCFMutableString)120 CACFMutableString(CFMutableStringRef inCFMutableString, bool inWillRelease = true) : mCFMutableString(inCFMutableString), mWillRelease(inWillRelease) {} 121 CACFMutableString(CFStringRef inStringToCopy, bool /*inMakeCopy*/, bool inWillRelease = true) : mCFMutableString(CFStringCreateMutableCopy(NULL, 0, inStringToCopy)), mWillRelease(inWillRelease) {} mCFMutableString(NULL)122 CACFMutableString(const char* inCString, bool inWillRelease = true) : mCFMutableString(NULL), mWillRelease(inWillRelease) { CACFString theString(inCString); mCFMutableString = CFStringCreateMutableCopy(NULL, 0, theString.GetCFString()); } mCFMutableString(NULL)123 CACFMutableString(const char* inCString, CFStringEncoding inCStringEncoding, bool inWillRelease = true) : mCFMutableString(NULL), mWillRelease(inWillRelease) { CACFString theString(inCString, inCStringEncoding); mCFMutableString = CFStringCreateMutableCopy(NULL, 0, theString.GetCFString()); } ~CACFMutableString()124 ~CACFMutableString() { Release(); } CACFMutableString(const CACFMutableString & inString)125 CACFMutableString(const CACFMutableString& inString) : mCFMutableString(inString.mCFMutableString), mWillRelease(inString.mWillRelease) { Retain(); } 126 CACFMutableString operator=(const CACFMutableString& inString) { Release(); mCFMutableString = inString.mCFMutableString; mWillRelease = inString.mWillRelease; Retain(); return *this; } 127 CACFMutableString operator=(CFMutableStringRef inCFMutableString) { Release(); mCFMutableString = inCFMutableString; mWillRelease = true; return *this; } 128 129 private: Retain()130 void Retain() { if(mWillRelease && (mCFMutableString != NULL)) { CFRetain(mCFMutableString); } } Release()131 void Release() { if(mWillRelease && (mCFMutableString != NULL)) { CFRelease(mCFMutableString); } } 132 133 CFMutableStringRef mCFMutableString; 134 bool mWillRelease; 135 136 // Operations 137 public: AllowRelease()138 void AllowRelease() { mWillRelease = true; } DontAllowRelease()139 void DontAllowRelease() { mWillRelease = false; } IsValid()140 bool IsValid() { return mCFMutableString != NULL; } StartsWith(CFStringRef inString)141 bool StartsWith(CFStringRef inString) const { bool theAnswer = false; if(mCFMutableString != NULL) { theAnswer = CFStringHasPrefix(mCFMutableString, inString); } return theAnswer; } EndsWith(CFStringRef inString)142 bool EndsWith(CFStringRef inString) const { bool theAnswer = false; if(mCFMutableString != NULL) { theAnswer = CFStringHasSuffix(mCFMutableString, inString); } return theAnswer; } Append(CFStringRef inString)143 void Append(CFStringRef inString) { if(mCFMutableString != NULL) { CFStringAppend(mCFMutableString, inString); } } 144 145 // Value Access 146 public: GetCFMutableString()147 CFMutableStringRef GetCFMutableString() const { return mCFMutableString; } CopyCFMutableString()148 CFMutableStringRef CopyCFMutableString() const { if(mCFMutableString != NULL) { CFRetain(mCFMutableString); } return mCFMutableString; } GetLength()149 UInt32 GetLength() const { UInt32 theAnswer = 0; if(mCFMutableString != NULL) { theAnswer = CFStringGetLength(mCFMutableString); } return theAnswer; } 150 UInt32 GetByteLength(CFStringEncoding inEncoding = kCFStringEncodingUTF8) const { UInt32 theAnswer = 0; if(mCFMutableString != NULL) { theAnswer = CACFString::GetStringByteLength(mCFMutableString, inEncoding); } return theAnswer; } 151 void GetCString(char* outString, UInt32& ioStringSize, CFStringEncoding inEncoding = kCFStringEncodingUTF8) const { CACFString::GetCString(mCFMutableString, outString, ioStringSize, inEncoding); } GetUnicodeString(UInt16 * outString,UInt32 & ioStringSize)152 void GetUnicodeString(UInt16* outString, UInt32& ioStringSize) const { CACFString::GetUnicodeString(mCFMutableString, outString, ioStringSize); } 153 154 }; 155 156 #endif 157