CFBag.h

   1 /*
   2  * Copyright (c) 2008 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 /*      CFBag.h
  24         Copyright (c) 1998-2007, Apple Inc. All rights reserved.
  25 */
  26
  27 #if !defined(__COREFOUNDATION_CFBAG__)
  28 #define __COREFOUNDATION_CFBAG__ 1
  29
  30 #include <CoreFoundation/CFBase.h>
  31
  32 CF_EXTERN_C_BEGIN
  33
  34 typedef const void *    (*CFBagRetainCallBack)(CFAllocatorRef allocator, const void *value);
  35 typedef void            (*CFBagReleaseCallBack)(CFAllocatorRef allocator, const void *value);
  36 typedef CFStringRef     (*CFBagCopyDescriptionCallBack)(const void *value);
  37 typedef Boolean         (*CFBagEqualCallBack)(const void *value1, const void *value2);
  38 typedef CFHashCode      (*CFBagHashCallBack)(const void *value);
  39 typedef struct {
  40     CFIndex                             version;
  41     CFBagRetainCallBack                 retain;
  42     CFBagReleaseCallBack                release;
  43     CFBagCopyDescriptionCallBack        copyDescription;
  44     CFBagEqualCallBack                  equal;
  45     CFBagHashCallBack                   hash;
  46 } CFBagCallBacks;
  47
  48 CF_EXPORT
  49 const CFBagCallBacks kCFTypeBagCallBacks;
  50 CF_EXPORT
  51 const CFBagCallBacks kCFCopyStringBagCallBacks;
  52
  53 typedef void (*CFBagApplierFunction)(const void *value, void *context);
  54
  55 typedef const struct __CFBag * CFBagRef;
  56 typedef struct __CFBag * CFMutableBagRef;
  57
  58 CF_EXPORT
  59 CFTypeID CFBagGetTypeID(void);
  60
  61 CF_EXPORT
  62 CFBagRef CFBagCreate(CFAllocatorRef allocator, const void **values, CFIndex numValues, const CFBagCallBacks *callBacks);
  63
  64 CF_EXPORT
  65 CFBagRef CFBagCreateCopy(CFAllocatorRef allocator, CFBagRef theBag);
  66
  67 CF_EXPORT
  68 CFMutableBagRef CFBagCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFBagCallBacks *callBacks);
  69
  70 CF_EXPORT
  71 CFMutableBagRef CFBagCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFBagRef theBag);
  72
  73 CF_EXPORT
  74 CFIndex CFBagGetCount(CFBagRef theBag);
  75
  76 CF_EXPORT
  77 CFIndex CFBagGetCountOfValue(CFBagRef theBag, const void *value);
  78
  79 CF_EXPORT
  80 Boolean CFBagContainsValue(CFBagRef theBag, const void *value);
  81
  82 CF_EXPORT
  83 const void *CFBagGetValue(CFBagRef theBag, const void *value);
  84
  85 CF_EXPORT
  86 Boolean CFBagGetValueIfPresent(CFBagRef theBag, const void *candidate, const void **value);
  87
  88 CF_EXPORT
  89 void CFBagGetValues(CFBagRef theBag, const void **values);
  90
  91 CF_EXPORT
  92 void CFBagApplyFunction(CFBagRef theBag, CFBagApplierFunction applier, void *context);
  93
  94 CF_EXPORT
  95 void CFBagAddValue(CFMutableBagRef theBag, const void *value);
  96
  97 CF_EXPORT
  98 void CFBagReplaceValue(CFMutableBagRef theBag, const void *value);
  99
 100 CF_EXPORT
 101 void CFBagSetValue(CFMutableBagRef theBag, const void *value);
 102
 103 CF_EXPORT
 104 void CFBagRemoveValue(CFMutableBagRef theBag, const void *value);
 105
 106 CF_EXPORT
 107 void CFBagRemoveAllValues(CFMutableBagRef theBag);
 108
 109 CF_EXTERN_C_END
 110
 111 #endif /* ! __COREFOUNDATION_CFBAG__ */
 112