CFData.h

   1 /*
   2  * Copyright (c) 2010 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*      CFData.h
  25         Copyright (c) 1998-2009, Apple Inc. All rights reserved.
  26 */
  27
  28 #if !defined(__COREFOUNDATION_CFDATA__)
  29 #define __COREFOUNDATION_CFDATA__ 1
  30
  31 #include <CoreFoundation/CFBase.h>
  32
  33 CF_EXTERN_C_BEGIN
  34
  35 typedef const struct __CFData * CFDataRef;
  36 typedef struct __CFData * CFMutableDataRef;
  37
  38 CF_EXPORT
  39 CFTypeID CFDataGetTypeID(void);
  40
  41 CF_EXPORT
  42 CFDataRef CFDataCreate(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length);
  43
  44 CF_EXPORT
  45 CFDataRef CFDataCreateWithBytesNoCopy(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length, CFAllocatorRef bytesDeallocator);
  46     /* Pass kCFAllocatorNull as bytesDeallocator to assure the bytes aren't freed */
  47
  48 CF_EXPORT
  49 CFDataRef CFDataCreateCopy(CFAllocatorRef allocator, CFDataRef theData);
  50
  51 CF_EXPORT
  52 CFMutableDataRef CFDataCreateMutable(CFAllocatorRef allocator, CFIndex capacity);
  53
  54 CF_EXPORT
  55 CFMutableDataRef CFDataCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFDataRef theData);
  56
  57 CF_EXPORT
  58 CFIndex CFDataGetLength(CFDataRef theData);
  59
  60 CF_EXPORT
  61 const UInt8 *CFDataGetBytePtr(CFDataRef theData);
  62
  63 CF_EXPORT
  64 UInt8 *CFDataGetMutableBytePtr(CFMutableDataRef theData);
  65
  66 CF_EXPORT
  67 void CFDataGetBytes(CFDataRef theData, CFRange range, UInt8 *buffer);
  68
  69 CF_EXPORT
  70 void CFDataSetLength(CFMutableDataRef theData, CFIndex length);
  71
  72 CF_EXPORT
  73 void CFDataIncreaseLength(CFMutableDataRef theData, CFIndex extraLength);
  74
  75 CF_EXPORT
  76 void CFDataAppendBytes(CFMutableDataRef theData, const UInt8 *bytes, CFIndex length);
  77
  78 CF_EXPORT
  79 void CFDataReplaceBytes(CFMutableDataRef theData, CFRange range, const UInt8 *newBytes, CFIndex newLength);
  80
  81 CF_EXPORT
  82 void CFDataDeleteBytes(CFMutableDataRef theData, CFRange range);
  83
  84 #if MAC_OS_X_VERSION_10_6 <= MAC_OS_X_VERSION_MAX_ALLOWED
  85 enum {
  86     kCFDataSearchBackwards = 1UL << 0,
  87     kCFDataSearchAnchored = 1UL << 1
  88 };
  89 #endif
  90 typedef CFOptionFlags CFDataSearchFlags;
  91
  92 CF_EXPORT
  93 CFRange CFDataFind(CFDataRef theData, CFDataRef dataToFind, CFRange searchRange, CFDataSearchFlags compareOptions) AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER;
  94
  95 CF_EXTERN_C_END
  96
  97 #endif /* ! __COREFOUNDATION_CFDATA__ */
  98