[apple/cf.git] / CFBag.h

/*
 * Copyright (c) 2011 Apple Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */

/*	CFBag.h
	Copyright (c) 1998-2011, Apple Inc. All rights reserved.
*/

#if !defined(__COREFOUNDATION_CFBAG__)
#define __COREFOUNDATION_CFBAG__ 1

#include <CoreFoundation/CFBase.h>

CF_EXTERN_C_BEGIN

typedef const void *	(*CFBagRetainCallBack)(CFAllocatorRef allocator, const void *value);
typedef void		(*CFBagReleaseCallBack)(CFAllocatorRef allocator, const void *value);
typedef CFStringRef	(*CFBagCopyDescriptionCallBack)(const void *value);
typedef Boolean		(*CFBagEqualCallBack)(const void *value1, const void *value2);
typedef CFHashCode	(*CFBagHashCallBack)(const void *value);
typedef struct {
    CFIndex				version;
    CFBagRetainCallBack			retain;
    CFBagReleaseCallBack		release;
    CFBagCopyDescriptionCallBack	copyDescription;
    CFBagEqualCallBack			equal;
    CFBagHashCallBack			hash;
} CFBagCallBacks;

CF_EXPORT
const CFBagCallBacks kCFTypeBagCallBacks;
CF_EXPORT
const CFBagCallBacks kCFCopyStringBagCallBacks;

typedef void (*CFBagApplierFunction)(const void *value, void *context);

typedef const struct __CFBag * CFBagRef;
typedef struct __CFBag * CFMutableBagRef;

CF_EXPORT
CFTypeID CFBagGetTypeID(void);

CF_EXPORT
CFBagRef CFBagCreate(CFAllocatorRef allocator, const void **values, CFIndex numValues, const CFBagCallBacks *callBacks);

CF_EXPORT
CFBagRef CFBagCreateCopy(CFAllocatorRef allocator, CFBagRef theBag);

CF_EXPORT
CFMutableBagRef CFBagCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFBagCallBacks *callBacks);

CF_EXPORT
CFMutableBagRef CFBagCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFBagRef theBag);

CF_EXPORT
CFIndex CFBagGetCount(CFBagRef theBag);

CF_EXPORT
CFIndex CFBagGetCountOfValue(CFBagRef theBag, const void *value);

CF_EXPORT
Boolean CFBagContainsValue(CFBagRef theBag, const void *value);

CF_EXPORT
const void *CFBagGetValue(CFBagRef theBag, const void *value);

CF_EXPORT
Boolean CFBagGetValueIfPresent(CFBagRef theBag, const void *candidate, const void **value);

CF_EXPORT
void CFBagGetValues(CFBagRef theBag, const void **values);

CF_EXPORT
void CFBagApplyFunction(CFBagRef theBag, CFBagApplierFunction applier, void *context);

CF_EXPORT
void CFBagAddValue(CFMutableBagRef theBag, const void *value);

CF_EXPORT
void CFBagReplaceValue(CFMutableBagRef theBag, const void *value);

CF_EXPORT
void CFBagSetValue(CFMutableBagRef theBag, const void *value);

CF_EXPORT
void CFBagRemoveValue(CFMutableBagRef theBag, const void *value);

CF_EXPORT
void CFBagRemoveAllValues(CFMutableBagRef theBag);

CF_EXTERN_C_END

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