[apple/cf.git] / CFTree.c

/*
 * Copyright (c) 2008 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@
 */
/*	CFTree.c
	Copyright 1998-2002, Apple, Inc. All rights reserved.
	Responsibility: Christopher Kane
*/

#include <CoreFoundation/CFTree.h>
#include "CFInternal.h"
#include "CFPriv.h"

struct __CFTreeCallBacks {
    CFTreeRetainCallBack		retain;
    CFTreeReleaseCallBack		release;	
    CFTreeCopyDescriptionCallBack	copyDescription;
};

struct __CFTree {
    CFRuntimeBase _base;
    CFTreeRef _parent;	/* Not retained */
    CFTreeRef _sibling;	/* Not retained */
    CFTreeRef _child;	/* All children get a retain from the parent */
    CFTreeRef _rightmostChild;	/* Not retained */
    /* This is the context, exploded.
     * Currently the only valid version is 0, so we do not store that.
     * _callbacks initialized if not a special form. */
    void *_info;
    struct __CFTreeCallBacks *_callbacks;
};

static const struct __CFTreeCallBacks __kCFTypeTreeCallBacks = {CFRetain, CFRelease, CFCopyDescription};
static const struct __CFTreeCallBacks __kCFNullTreeCallBacks = {NULL, NULL, NULL};

enum {          /* Bits 0-1 */
    __kCFTreeHasNullCallBacks = 0,
    __kCFTreeHasCFTypeCallBacks = 1,
    __kCFTreeHasCustomCallBacks = 3    /* callbacks pointed to by _callbacks */
};

CF_INLINE uint32_t __CFTreeGetCallBacksType(CFTreeRef tree) {
    return (__CFBitfieldGetValue(tree->_base._cfinfo[CF_INFO_BITS], 1, 0));
}

CF_INLINE const struct __CFTreeCallBacks *__CFTreeGetCallBacks(CFTreeRef tree) {
    switch (__CFTreeGetCallBacksType(tree)) {
    case __kCFTreeHasNullCallBacks:
	return &__kCFNullTreeCallBacks;
    case __kCFTreeHasCFTypeCallBacks:
	return &__kCFTypeTreeCallBacks;
    case __kCFTreeHasCustomCallBacks:
	break;
    }
    return tree->_callbacks;
}

CF_INLINE bool __CFTreeCallBacksMatchNull(const CFTreeContext *c) {
    return (NULL == c || (c->retain == NULL && c->release == NULL && c->copyDescription == NULL));
}   

CF_INLINE bool __CFTreeCallBacksMatchCFType(const CFTreeContext *c) {
    return (NULL != c && (c->retain == CFRetain && c->release == CFRelease && c->copyDescription == CFCopyDescription));
}   

static CFStringRef __CFTreeCopyDescription(CFTypeRef cf) {
    CFTreeRef tree = (CFTreeRef)cf;
    CFMutableStringRef result;
    CFStringRef contextDesc = NULL;
    Boolean safeToReleaseContextDesc = true;
    const struct __CFTreeCallBacks *cb;
    CFAllocatorRef allocator;
    allocator = CFGetAllocator(tree);
    result = CFStringCreateMutable(allocator, 0);
    cb = __CFTreeGetCallBacks(tree);
    if (NULL != cb->copyDescription) {
	contextDesc = (CFStringRef)INVOKE_CALLBACK1(cb->copyDescription, tree->_info);
	safeToReleaseContextDesc = _CFExecutableLinkedOnOrAfter(CFSystemVersionTiger);    // Because it came from elsewhere, only free it compatibly (3593254)
    }
    if (NULL == contextDesc) {
	contextDesc = CFStringCreateWithFormat(allocator, NULL, CFSTR("<CFTree context %p>"), tree->_info);
    }
    CFStringAppendFormat(result, NULL, CFSTR("<CFTree %p [%p]>{children = %u, context = %@}"), cf, allocator, CFTreeGetChildCount(tree), contextDesc);
    if (contextDesc && safeToReleaseContextDesc) CFRelease(contextDesc);
    return result;
}

static void __CFTreeDeallocate(CFTypeRef cf) {
    CFTreeRef tree = (CFTreeRef)cf;
    const struct __CFTreeCallBacks *cb;
    CFAllocatorRef allocator = __CFGetAllocator(tree);
    if (!CF_IS_COLLECTABLE_ALLOCATOR(allocator)) {
        // GC:  keep the tree intact during finalization.
        CFTreeRemoveAllChildren(tree);
    }
    cb = __CFTreeGetCallBacks(tree);
    if (NULL != cb->release) {
        INVOKE_CALLBACK1(cb->release, tree->_info);
    }
    if (__kCFTreeHasCustomCallBacks == __CFTreeGetCallBacksType(tree)) {
        _CFAllocatorDeallocateGC(CFGetAllocator(tree), tree->_callbacks);
    }
}


static CFTypeID __kCFTreeTypeID = _kCFRuntimeNotATypeID;

static const CFRuntimeClass __CFTreeClass = {
    _kCFRuntimeScannedObject,
    "CFTree",
    NULL,	// init
    NULL,	// copy
    __CFTreeDeallocate,
    NULL,	// equal
    NULL,	// hash
    NULL,	// 
    __CFTreeCopyDescription
};

__private_extern__ void __CFTreeInitialize(void) {
    __kCFTreeTypeID = _CFRuntimeRegisterClass(&__CFTreeClass);
}

CFTypeID CFTreeGetTypeID(void) {
    return __kCFTreeTypeID;
}

CFTreeRef CFTreeCreate(CFAllocatorRef allocator, const CFTreeContext *context) {
    CFTreeRef memory;
    uint32_t size;

    CFAssert1(NULL != context, __kCFLogAssertion, "%s(): pointer to context may not be NULL", __PRETTY_FUNCTION__);
    CFAssert1(0 == context->version, __kCFLogAssertion, "%s(): context version not initialized to 0", __PRETTY_FUNCTION__);
    size = sizeof(struct __CFTree) - sizeof(CFRuntimeBase);
    memory = (CFTreeRef)_CFRuntimeCreateInstance(allocator, __kCFTreeTypeID, size, NULL);
    if (NULL == memory) {
	return NULL;
    }
    memory->_parent = NULL;
    memory->_sibling = NULL;
    memory->_child = NULL;
    memory->_rightmostChild = NULL;

    /* Start the context off in a recognizable state */
    __CFBitfieldSetValue(memory->_base._cfinfo[CF_INFO_BITS], 1, 0, __kCFTreeHasNullCallBacks);
    CFTreeSetContext(memory, context);
    return memory;
}

CFIndex CFTreeGetChildCount(CFTreeRef tree) {
    SInt32 cnt = 0;
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    tree = tree->_child;
    while (NULL != tree) {
	cnt++;
	tree = tree->_sibling;
    }
    return cnt;
}

CFTreeRef CFTreeGetParent(CFTreeRef tree) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    return tree->_parent;
}

CFTreeRef CFTreeGetNextSibling(CFTreeRef tree) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    return tree->_sibling;
}

CFTreeRef CFTreeGetFirstChild(CFTreeRef tree) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    return tree->_child;
}

CFTreeRef CFTreeFindRoot(CFTreeRef tree) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    while (NULL != tree->_parent) {
	tree = tree->_parent;
    }
    return tree;
}

void CFTreeGetContext(CFTreeRef tree, CFTreeContext *context) {
    const struct __CFTreeCallBacks *cb;
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    CFAssert1(0 == context->version, __kCFLogAssertion, "%s(): context version not initialized to 0", __PRETTY_FUNCTION__);
    cb = __CFTreeGetCallBacks(tree);
    context->version = 0;
    context->info = tree->_info;
    context->retain = cb->retain;
    context->release = cb->release;
    context->copyDescription = cb->copyDescription;
    UNFAULT_CALLBACK(context->retain);
    UNFAULT_CALLBACK(context->release);
    UNFAULT_CALLBACK(context->copyDescription);
}

void CFTreeSetContext(CFTreeRef tree, const CFTreeContext *context) {
    uint32_t newtype, oldtype = __CFTreeGetCallBacksType(tree);
    struct __CFTreeCallBacks *oldcb = (struct __CFTreeCallBacks *)__CFTreeGetCallBacks(tree);
    struct __CFTreeCallBacks *newcb;
    void *oldinfo = tree->_info;
    CFAllocatorRef allocator = CFGetAllocator(tree);
    
    if (__CFTreeCallBacksMatchNull(context)) {
        newtype = __kCFTreeHasNullCallBacks;
    } else if (__CFTreeCallBacksMatchCFType(context)) {
        newtype = __kCFTreeHasCFTypeCallBacks;
    } else {
        newtype = __kCFTreeHasCustomCallBacks;
        CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_callbacks, _CFAllocatorAllocateGC(allocator, sizeof(struct __CFTreeCallBacks), 0));
        if (__CFOASafe) __CFSetLastAllocationEventName(tree->_callbacks, "CFTree (callbacks)");
        tree->_callbacks->retain = context->retain;
        tree->_callbacks->release = context->release;
        tree->_callbacks->copyDescription = context->copyDescription;
        FAULT_CALLBACK((void **)&(tree->_callbacks->retain));
        FAULT_CALLBACK((void **)&(tree->_callbacks->release));
        FAULT_CALLBACK((void **)&(tree->_callbacks->copyDescription));
    }
    __CFBitfieldSetValue(tree->_base._cfinfo[CF_INFO_BITS], 1, 0, newtype);
    newcb = (struct __CFTreeCallBacks *)__CFTreeGetCallBacks(tree);
    if (NULL != newcb->retain) {
        tree->_info = (void *)INVOKE_CALLBACK1(newcb->retain, context->info);
    } else {
        CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_info, context->info);
    }
    if (NULL != oldcb->release) {
        INVOKE_CALLBACK1(oldcb->release, oldinfo);
    }
    if (oldtype == __kCFTreeHasCustomCallBacks) {
        _CFAllocatorDeallocateGC(allocator, oldcb);
    }
}

#if 0
CFTreeRef CFTreeFindNextSibling(CFTreeRef tree, const void *info) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    tree = tree->_sibling;
    while (NULL != tree) {
	if (info == tree->_context.info || (tree->_context.equal && tree->_context.equal(info, tree->_context.info))) {
	    return tree;
	}
	tree = tree->_sibling;
    }
    return NULL;
}

CFTreeRef CFTreeFindFirstChild(CFTreeRef tree, const void *info) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    tree = tree->_child;
    while (NULL != tree) {
	if (info == tree->_context.info || (tree->_context.equal && tree->_context.equal(info, tree->_context.info))) {
	    return tree;
	}
	tree = tree->_sibling;
    }
    return NULL;
}

CFTreeRef CFTreeFind(CFTreeRef tree, const void *info) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    if (info == tree->_context.info || (tree->_context.equal && tree->_context.equal(info, tree->info))) {
	return tree;
    }
    tree = tree->_child;
    while (NULL != tree) {
	CFTreeRef found = CFTreeFind(tree, info);
	if (NULL != found) {
	    return found;
	}
	tree = tree->_sibling;
    }
    return NULL;
}
#endif

CFTreeRef CFTreeGetChildAtIndex(CFTreeRef tree, CFIndex idx) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    tree = tree->_child;
    while (NULL != tree) {
	if (0 == idx) return tree;
	idx--;
	tree = tree->_sibling;
    }
    return NULL;
}

void CFTreeGetChildren(CFTreeRef tree, CFTreeRef *children) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    tree = tree->_child;
    while (NULL != tree) {
	*children++ = tree;
	tree = tree->_sibling;
    }
}

void CFTreeApplyFunctionToChildren(CFTreeRef tree, CFTreeApplierFunction applier, void *context) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    CFAssert1(NULL != applier, __kCFLogAssertion, "%s(): pointer to applier function may not be NULL", __PRETTY_FUNCTION__);
    tree = tree->_child;
    while (NULL != tree) {
	applier(tree, context);
	tree = tree->_sibling;
    }
}

void CFTreePrependChild(CFTreeRef tree, CFTreeRef newChild) {
    CFAllocatorRef allocator = CFGetAllocator(tree);
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    __CFGenericValidateType(newChild, __kCFTreeTypeID);
    CFAssert1(NULL == newChild->_parent, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
    CFAssert1(NULL == newChild->_sibling, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
    _CFRetainGC(newChild);
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newChild, newChild->_parent, tree);
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newChild, newChild->_sibling, tree->_child);
    if (!tree->_child) {
        CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_rightmostChild, newChild);
    }
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_child, newChild);
}

void CFTreeAppendChild(CFTreeRef tree, CFTreeRef newChild) {
    CFAllocatorRef allocator;
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    __CFGenericValidateType(newChild, __kCFTreeTypeID);
    CFAssert1(NULL == newChild->_parent, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
    CFAssert1(NULL == newChild->_sibling, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
    if (newChild->_parent) {
        HALT;
    }
    _CFRetainGC(newChild);
    allocator = CFGetAllocator(tree);
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newChild, newChild->_parent, tree);
    newChild->_sibling = NULL;
    if (!tree->_child) {
        CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_child, newChild);
    } else {
        CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_rightmostChild, tree->_rightmostChild->_sibling, newChild);
    }
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_rightmostChild, newChild);
}

void CFTreeInsertSibling(CFTreeRef tree, CFTreeRef newSibling) {
    CFAllocatorRef allocator;
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    __CFGenericValidateType(newSibling, __kCFTreeTypeID);
    CFAssert1(NULL != tree->_parent, __kCFLogAssertion, "%s(): tree must have a parent", __PRETTY_FUNCTION__);
    CFAssert1(NULL == newSibling->_parent, __kCFLogAssertion, "%s(): must remove newSibling from previous parent first", __PRETTY_FUNCTION__);
    CFAssert1(NULL == newSibling->_sibling, __kCFLogAssertion, "%s(): must remove newSibling from previous parent first", __PRETTY_FUNCTION__);
    _CFRetainGC(newSibling);
    allocator = CFGetAllocator(tree);
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newSibling, newSibling->_parent, tree->_parent);
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newSibling, newSibling->_sibling, tree->_sibling);
    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_sibling, newSibling);
    if (tree->_parent) {
        if (tree->_parent->_rightmostChild == tree) {
            CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_parent, tree->_parent->_rightmostChild, newSibling);
        }
    }
}

void CFTreeRemove(CFTreeRef tree) {
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    if (NULL != tree->_parent) {
        CFAllocatorRef allocator = CFGetAllocator(tree);
	if (tree == tree->_parent->_child) {
            CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_parent, tree->_parent->_child, tree->_sibling);
            if (tree->_sibling == NULL) {
                tree->_parent->_rightmostChild = NULL;
            }
	} else {
	    CFTreeRef prevSibling = NULL;
	    for (prevSibling = tree->_parent->_child; prevSibling; prevSibling = prevSibling->_sibling) {
		if (prevSibling->_sibling == tree) {
                    CF_WRITE_BARRIER_BASE_ASSIGN(allocator, prevSibling, prevSibling->_sibling, tree->_sibling);
                    if (tree->_parent->_rightmostChild == tree) {
                        CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_parent, tree->_parent->_rightmostChild, prevSibling);
                    }
		    break;
		}
	    }
	}
	tree->_parent = NULL;
	tree->_sibling = NULL;
        _CFReleaseGC(tree);
    }
}

void CFTreeRemoveAllChildren(CFTreeRef tree) {
    CFTreeRef nextChild;
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    nextChild = tree->_child;
    tree->_child = NULL;
    tree->_rightmostChild = NULL;
    while (NULL != nextChild) {
	CFTreeRef nextSibling = nextChild->_sibling;
	nextChild->_parent = NULL;
	nextChild->_sibling = NULL;
	_CFReleaseGC(nextChild);
	nextChild = nextSibling;
    }
}

struct _tcompareContext {
    CFComparatorFunction func;
    void *context;
};

static CFComparisonResult __CFTreeCompareValues(const void *v1, const void *v2, struct _tcompareContext *context) {
    const void **val1 = (const void **)v1;
    const void **val2 = (const void **)v2;
    return (CFComparisonResult)(INVOKE_CALLBACK3(context->func, *val1, *val2, context->context));
}

void CFTreeSortChildren(CFTreeRef tree, CFComparatorFunction comparator, void *context) {
    CFIndex children;
    __CFGenericValidateType(tree, __kCFTreeTypeID);
    CFAssert1(NULL != comparator, __kCFLogAssertion, "%s(): pointer to comparator function may not be NULL", __PRETTY_FUNCTION__);
    children = CFTreeGetChildCount(tree);
    if (1 < children) {
        CFIndex idx;
        CFTreeRef nextChild;
        struct _tcompareContext ctx;
        CFTreeRef *list, buffer[128];
        CFAllocatorRef allocator = __CFGetAllocator(tree);

        list = (children < 128) ? buffer : (CFTreeRef *)CFAllocatorAllocate(kCFAllocatorSystemDefault, children * sizeof(CFTreeRef), 0); // XXX_PCB GC OK
	if (__CFOASafe && list != buffer) __CFSetLastAllocationEventName(tree->_callbacks, "CFTree (temp)");
        nextChild = tree->_child;
        for (idx = 0; NULL != nextChild; idx++) {
            list[idx] = nextChild;
            nextChild = nextChild->_sibling;
        }

        ctx.func = comparator;
        ctx.context = context;
        CFQSortArray(list, children, sizeof(CFTreeRef), (CFComparatorFunction)__CFTreeCompareValues, &ctx);

        CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_child, list[0]);
        for (idx = 1; idx < children; idx++) {
            CF_WRITE_BARRIER_BASE_ASSIGN(allocator, list[idx - 1], list[idx - 1]->_sibling, list[idx]);
        }
        list[idx - 1]->_sibling = NULL;
        tree->_rightmostChild = list[children - 1];
        if (list != buffer) CFAllocatorDeallocate(kCFAllocatorSystemDefault, list); // XXX_PCB GC OK
    }
}
Commit	Line	Data
9ce05555	1	/*
bd5b749c	2	* Copyright (c) 2008 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	*/
	23	/* CFTree.c
	24	Copyright 1998-2002, Apple, Inc. All rights reserved.
	25	Responsibility: Christopher Kane
	26	*/
	27
	28	#include <CoreFoundation/CFTree.h>
	29	#include "CFInternal.h"
bd5b749c	30	#include "CFPriv.h"
9ce05555 A	31
	32	struct __CFTreeCallBacks {
	33	CFTreeRetainCallBack retain;
	34	CFTreeReleaseCallBack release;
	35	CFTreeCopyDescriptionCallBack copyDescription;
	36	};
	37
	38	struct __CFTree {
	39	CFRuntimeBase _base;
	40	CFTreeRef _parent; /* Not retained */
	41	CFTreeRef _sibling; /* Not retained */
	42	CFTreeRef _child; /* All children get a retain from the parent */
d8925383	43	CFTreeRef _rightmostChild; /* Not retained */
9ce05555 A	44	/* This is the context, exploded.
	45	* Currently the only valid version is 0, so we do not store that.
	46	* _callbacks initialized if not a special form. */
	47	void *_info;
	48	struct __CFTreeCallBacks *_callbacks;
	49	};
	50
	51	static const struct __CFTreeCallBacks __kCFTypeTreeCallBacks = {CFRetain, CFRelease, CFCopyDescription};
	52	static const struct __CFTreeCallBacks __kCFNullTreeCallBacks = {NULL, NULL, NULL};
	53
	54	enum { /* Bits 0-1 */
	55	__kCFTreeHasNullCallBacks = 0,
	56	__kCFTreeHasCFTypeCallBacks = 1,
	57	__kCFTreeHasCustomCallBacks = 3 /* callbacks pointed to by _callbacks */
	58	};
	59
	60	CF_INLINE uint32_t __CFTreeGetCallBacksType(CFTreeRef tree) {
bd5b749c	61	return (__CFBitfieldGetValue(tree->_base._cfinfo[CF_INFO_BITS], 1, 0));
9ce05555 A	62	}
	63
	64	CF_INLINE const struct __CFTreeCallBacks *__CFTreeGetCallBacks(CFTreeRef tree) {
	65	switch (__CFTreeGetCallBacksType(tree)) {
	66	case __kCFTreeHasNullCallBacks:
	67	return &__kCFNullTreeCallBacks;
	68	case __kCFTreeHasCFTypeCallBacks:
	69	return &__kCFTypeTreeCallBacks;
	70	case __kCFTreeHasCustomCallBacks:
	71	break;
	72	}
	73	return tree->_callbacks;
	74	}
	75
	76	CF_INLINE bool __CFTreeCallBacksMatchNull(const CFTreeContext *c) {
	77	return (NULL == c \|\| (c->retain == NULL && c->release == NULL && c->copyDescription == NULL));
	78	}
	79
	80	CF_INLINE bool __CFTreeCallBacksMatchCFType(const CFTreeContext *c) {
	81	return (NULL != c && (c->retain == CFRetain && c->release == CFRelease && c->copyDescription == CFCopyDescription));
	82	}
	83
	84	static CFStringRef __CFTreeCopyDescription(CFTypeRef cf) {
	85	CFTreeRef tree = (CFTreeRef)cf;
	86	CFMutableStringRef result;
	87	CFStringRef contextDesc = NULL;
d8925383	88	Boolean safeToReleaseContextDesc = true;
9ce05555 A	89	const struct __CFTreeCallBacks *cb;
	90	CFAllocatorRef allocator;
	91	allocator = CFGetAllocator(tree);
	92	result = CFStringCreateMutable(allocator, 0);
	93	cb = __CFTreeGetCallBacks(tree);
	94	if (NULL != cb->copyDescription) {
	95	contextDesc = (CFStringRef)INVOKE_CALLBACK1(cb->copyDescription, tree->_info);
d8925383	96	safeToReleaseContextDesc = _CFExecutableLinkedOnOrAfter(CFSystemVersionTiger); // Because it came from elsewhere, only free it compatibly (3593254)
9ce05555 A	97	}
	98	if (NULL == contextDesc) {
	99	contextDesc = CFStringCreateWithFormat(allocator, NULL, CFSTR("<CFTree context %p>"), tree->_info);
	100	}
	101	CFStringAppendFormat(result, NULL, CFSTR("<CFTree %p [%p]>{children = %u, context = %@}"), cf, allocator, CFTreeGetChildCount(tree), contextDesc);
d8925383	102	if (contextDesc && safeToReleaseContextDesc) CFRelease(contextDesc);
9ce05555 A	103	return result;
	104	}
	105
	106	static void __CFTreeDeallocate(CFTypeRef cf) {
	107	CFTreeRef tree = (CFTreeRef)cf;
	108	const struct __CFTreeCallBacks *cb;
d8925383 A	109	CFAllocatorRef allocator = __CFGetAllocator(tree);
	110	if (!CF_IS_COLLECTABLE_ALLOCATOR(allocator)) {
	111	// GC: keep the tree intact during finalization.
	112	CFTreeRemoveAllChildren(tree);
	113	}
9ce05555 A	114	cb = __CFTreeGetCallBacks(tree);
	115	if (NULL != cb->release) {
	116	INVOKE_CALLBACK1(cb->release, tree->_info);
	117	}
	118	if (__kCFTreeHasCustomCallBacks == __CFTreeGetCallBacksType(tree)) {
d8925383	119	_CFAllocatorDeallocateGC(CFGetAllocator(tree), tree->_callbacks);
9ce05555 A	120	}
	121	}
	122
d8925383	123
9ce05555 A	124	static CFTypeID __kCFTreeTypeID = _kCFRuntimeNotATypeID;
	125
	126	static const CFRuntimeClass __CFTreeClass = {
d8925383	127	_kCFRuntimeScannedObject,
9ce05555 A	128	"CFTree",
	129	NULL, // init
	130	NULL, // copy
	131	__CFTreeDeallocate,
	132	NULL, // equal
	133	NULL, // hash
	134	NULL, //
	135	__CFTreeCopyDescription
	136	};
	137
	138	__private_extern__ void __CFTreeInitialize(void) {
	139	__kCFTreeTypeID = _CFRuntimeRegisterClass(&__CFTreeClass);
	140	}
	141
	142	CFTypeID CFTreeGetTypeID(void) {
	143	return __kCFTreeTypeID;
	144	}
	145
	146	CFTreeRef CFTreeCreate(CFAllocatorRef allocator, const CFTreeContext *context) {
	147	CFTreeRef memory;
	148	uint32_t size;
	149
	150	CFAssert1(NULL != context, __kCFLogAssertion, "%s(): pointer to context may not be NULL", __PRETTY_FUNCTION__);
	151	CFAssert1(0 == context->version, __kCFLogAssertion, "%s(): context version not initialized to 0", __PRETTY_FUNCTION__);
	152	size = sizeof(struct __CFTree) - sizeof(CFRuntimeBase);
	153	memory = (CFTreeRef)_CFRuntimeCreateInstance(allocator, __kCFTreeTypeID, size, NULL);
	154	if (NULL == memory) {
	155	return NULL;
	156	}
	157	memory->_parent = NULL;
	158	memory->_sibling = NULL;
	159	memory->_child = NULL;
d8925383	160	memory->_rightmostChild = NULL;
9ce05555 A	161
9ce05555 A	162	/* Start the context off in a recognizable state */
bd5b749c	163	__CFBitfieldSetValue(memory->_base._cfinfo[CF_INFO_BITS], 1, 0, __kCFTreeHasNullCallBacks);
9ce05555 A	164	CFTreeSetContext(memory, context);
	165	return memory;
	166	}
	167
	168	CFIndex CFTreeGetChildCount(CFTreeRef tree) {
	169	SInt32 cnt = 0;
	170	__CFGenericValidateType(tree, __kCFTreeTypeID);
	171	tree = tree->_child;
	172	while (NULL != tree) {
	173	cnt++;
	174	tree = tree->_sibling;
	175	}
	176	return cnt;
	177	}
	178
	179	CFTreeRef CFTreeGetParent(CFTreeRef tree) {
	180	__CFGenericValidateType(tree, __kCFTreeTypeID);
	181	return tree->_parent;
	182	}
	183
	184	CFTreeRef CFTreeGetNextSibling(CFTreeRef tree) {
	185	__CFGenericValidateType(tree, __kCFTreeTypeID);
	186	return tree->_sibling;
	187	}
	188
	189	CFTreeRef CFTreeGetFirstChild(CFTreeRef tree) {
	190	__CFGenericValidateType(tree, __kCFTreeTypeID);
	191	return tree->_child;
	192	}
	193
	194	CFTreeRef CFTreeFindRoot(CFTreeRef tree) {
	195	__CFGenericValidateType(tree, __kCFTreeTypeID);
	196	while (NULL != tree->_parent) {
	197	tree = tree->_parent;
	198	}
	199	return tree;
	200	}
	201
	202	void CFTreeGetContext(CFTreeRef tree, CFTreeContext *context) {
	203	const struct __CFTreeCallBacks *cb;
	204	__CFGenericValidateType(tree, __kCFTreeTypeID);
	205	CFAssert1(0 == context->version, __kCFLogAssertion, "%s(): context version not initialized to 0", __PRETTY_FUNCTION__);
	206	cb = __CFTreeGetCallBacks(tree);
	207	context->version = 0;
	208	context->info = tree->_info;
9ce05555 A	209	context->retain = cb->retain;
	210	context->release = cb->release;
	211	context->copyDescription = cb->copyDescription;
bd5b749c A	212	UNFAULT_CALLBACK(context->retain);
	213	UNFAULT_CALLBACK(context->release);
	214	UNFAULT_CALLBACK(context->copyDescription);
9ce05555 A	215	}
	216
	217	void CFTreeSetContext(CFTreeRef tree, const CFTreeContext *context) {
	218	uint32_t newtype, oldtype = __CFTreeGetCallBacksType(tree);
	219	struct __CFTreeCallBacks oldcb = (struct __CFTreeCallBacks )__CFTreeGetCallBacks(tree);
	220	struct __CFTreeCallBacks *newcb;
	221	void *oldinfo = tree->_info;
d8925383 A	222	CFAllocatorRef allocator = CFGetAllocator(tree);
d8925383 A	223
9ce05555	224	if (__CFTreeCallBacksMatchNull(context)) {
d8925383	225	newtype = __kCFTreeHasNullCallBacks;
9ce05555	226	} else if (__CFTreeCallBacksMatchCFType(context)) {
d8925383	227	newtype = __kCFTreeHasCFTypeCallBacks;
9ce05555	228	} else {
d8925383 A	229	newtype = __kCFTreeHasCustomCallBacks;
	230	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_callbacks, _CFAllocatorAllocateGC(allocator, sizeof(struct __CFTreeCallBacks), 0));
	231	if (__CFOASafe) __CFSetLastAllocationEventName(tree->_callbacks, "CFTree (callbacks)");
9ce05555 A	232	tree->_callbacks->retain = context->retain;
	233	tree->_callbacks->release = context->release;
	234	tree->_callbacks->copyDescription = context->copyDescription;
d8925383 A	235	FAULT_CALLBACK((void **)&(tree->_callbacks->retain));
	236	FAULT_CALLBACK((void **)&(tree->_callbacks->release));
	237	FAULT_CALLBACK((void **)&(tree->_callbacks->copyDescription));
9ce05555	238	}
bd5b749c	239	__CFBitfieldSetValue(tree->_base._cfinfo[CF_INFO_BITS], 1, 0, newtype);
9ce05555 A	240	newcb = (struct __CFTreeCallBacks *)__CFTreeGetCallBacks(tree);
	241	if (NULL != newcb->retain) {
	242	tree->_info = (void *)INVOKE_CALLBACK1(newcb->retain, context->info);
	243	} else {
d8925383	244	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_info, context->info);
9ce05555 A	245	}
9ce05555 A	246	if (NULL != oldcb->release) {
d8925383	247	INVOKE_CALLBACK1(oldcb->release, oldinfo);
9ce05555 A	248	}
9ce05555 A	249	if (oldtype == __kCFTreeHasCustomCallBacks) {
d8925383	250	_CFAllocatorDeallocateGC(allocator, oldcb);
9ce05555 A	251	}
	252	}
	253
	254	#if 0
	255	CFTreeRef CFTreeFindNextSibling(CFTreeRef tree, const void *info) {
	256	__CFGenericValidateType(tree, __kCFTreeTypeID);
	257	tree = tree->_sibling;
	258	while (NULL != tree) {
	259	if (info == tree->_context.info \|\| (tree->_context.equal && tree->_context.equal(info, tree->_context.info))) {
	260	return tree;
	261	}
	262	tree = tree->_sibling;
	263	}
	264	return NULL;
	265	}
	266
	267	CFTreeRef CFTreeFindFirstChild(CFTreeRef tree, const void *info) {
	268	__CFGenericValidateType(tree, __kCFTreeTypeID);
	269	tree = tree->_child;
	270	while (NULL != tree) {
	271	if (info == tree->_context.info \|\| (tree->_context.equal && tree->_context.equal(info, tree->_context.info))) {
	272	return tree;
	273	}
	274	tree = tree->_sibling;
	275	}
	276	return NULL;
	277	}
	278
	279	CFTreeRef CFTreeFind(CFTreeRef tree, const void *info) {
	280	__CFGenericValidateType(tree, __kCFTreeTypeID);
	281	if (info == tree->_context.info \|\| (tree->_context.equal && tree->_context.equal(info, tree->info))) {
	282	return tree;
	283	}
	284	tree = tree->_child;
	285	while (NULL != tree) {
	286	CFTreeRef found = CFTreeFind(tree, info);
	287	if (NULL != found) {
	288	return found;
	289	}
	290	tree = tree->_sibling;
	291	}
	292	return NULL;
	293	}
	294	#endif
	295
	296	CFTreeRef CFTreeGetChildAtIndex(CFTreeRef tree, CFIndex idx) {
	297	__CFGenericValidateType(tree, __kCFTreeTypeID);
	298	tree = tree->_child;
	299	while (NULL != tree) {
	300	if (0 == idx) return tree;
	301	idx--;
	302	tree = tree->_sibling;
	303	}
	304	return NULL;
	305	}
	306
	307	void CFTreeGetChildren(CFTreeRef tree, CFTreeRef *children) {
	308	__CFGenericValidateType(tree, __kCFTreeTypeID);
	309	tree = tree->_child;
	310	while (NULL != tree) {
	311	*children++ = tree;
	312	tree = tree->_sibling;
	313	}
	314	}
315
316	void CFTreeApplyFunctionToChildren(CFTreeRef tree, CFTreeApplierFunction applier, void *context) {
317	__CFGenericValidateType(tree, __kCFTreeTypeID);
318	CFAssert1(NULL != applier, __kCFLogAssertion, "%s(): pointer to applier function may not be NULL", __PRETTY_FUNCTION__);
319	tree = tree->_child;
320	while (NULL != tree) {
321	applier(tree, context);
322	tree = tree->_sibling;
323	}
324	}
325
326	void CFTreePrependChild(CFTreeRef tree, CFTreeRef newChild) {
d8925383	327	CFAllocatorRef allocator = CFGetAllocator(tree);
9ce05555 A	328	__CFGenericValidateType(tree, __kCFTreeTypeID);
	329	__CFGenericValidateType(newChild, __kCFTreeTypeID);
	330	CFAssert1(NULL == newChild->_parent, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
	331	CFAssert1(NULL == newChild->_sibling, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
d8925383 A	332	_CFRetainGC(newChild);
	333	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newChild, newChild->_parent, tree);
	334	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newChild, newChild->_sibling, tree->_child);
	335	if (!tree->_child) {
	336	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_rightmostChild, newChild);
	337	}
	338	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_child, newChild);
9ce05555 A	339	}
	340
	341	void CFTreeAppendChild(CFTreeRef tree, CFTreeRef newChild) {
d8925383	342	CFAllocatorRef allocator;
9ce05555 A	343	__CFGenericValidateType(tree, __kCFTreeTypeID);
	344	__CFGenericValidateType(newChild, __kCFTreeTypeID);
	345	CFAssert1(NULL == newChild->_parent, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
	346	CFAssert1(NULL == newChild->_sibling, __kCFLogAssertion, "%s(): must remove newChild from previous parent first", __PRETTY_FUNCTION__);
	347	if (newChild->_parent) {
	348	HALT;
	349	}
d8925383 A	350	_CFRetainGC(newChild);
	351	allocator = CFGetAllocator(tree);
	352	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newChild, newChild->_parent, tree);
9ce05555 A	353	newChild->_sibling = NULL;
9ce05555 A	354	if (!tree->_child) {
d8925383	355	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_child, newChild);
9ce05555	356	} else {
d8925383	357	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_rightmostChild, tree->_rightmostChild->_sibling, newChild);
9ce05555	358	}
d8925383	359	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_rightmostChild, newChild);
9ce05555 A	360	}
	361
	362	void CFTreeInsertSibling(CFTreeRef tree, CFTreeRef newSibling) {
d8925383	363	CFAllocatorRef allocator;
9ce05555 A	364	__CFGenericValidateType(tree, __kCFTreeTypeID);
	365	__CFGenericValidateType(newSibling, __kCFTreeTypeID);
	366	CFAssert1(NULL != tree->_parent, __kCFLogAssertion, "%s(): tree must have a parent", __PRETTY_FUNCTION__);
	367	CFAssert1(NULL == newSibling->_parent, __kCFLogAssertion, "%s(): must remove newSibling from previous parent first", __PRETTY_FUNCTION__);
	368	CFAssert1(NULL == newSibling->_sibling, __kCFLogAssertion, "%s(): must remove newSibling from previous parent first", __PRETTY_FUNCTION__);
d8925383 A	369	_CFRetainGC(newSibling);
	370	allocator = CFGetAllocator(tree);
	371	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newSibling, newSibling->_parent, tree->_parent);
	372	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, newSibling, newSibling->_sibling, tree->_sibling);
	373	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_sibling, newSibling);
	374	if (tree->_parent) {
	375	if (tree->_parent->_rightmostChild == tree) {
	376	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_parent, tree->_parent->_rightmostChild, newSibling);
	377	}
	378	}
9ce05555 A	379	}
	380
	381	void CFTreeRemove(CFTreeRef tree) {
	382	__CFGenericValidateType(tree, __kCFTreeTypeID);
	383	if (NULL != tree->_parent) {
d8925383	384	CFAllocatorRef allocator = CFGetAllocator(tree);
9ce05555	385	if (tree == tree->_parent->_child) {
d8925383 A	386	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_parent, tree->_parent->_child, tree->_sibling);
	387	if (tree->_sibling == NULL) {
	388	tree->_parent->_rightmostChild = NULL;
	389	}
9ce05555 A	390	} else {
	391	CFTreeRef prevSibling = NULL;
	392	for (prevSibling = tree->_parent->_child; prevSibling; prevSibling = prevSibling->_sibling) {
	393	if (prevSibling->_sibling == tree) {
d8925383 A	394	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, prevSibling, prevSibling->_sibling, tree->_sibling);
	395	if (tree->_parent->_rightmostChild == tree) {
	396	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree->_parent, tree->_parent->_rightmostChild, prevSibling);
	397	}
9ce05555 A	398	break;
	399	}
	400	}
	401	}
	402	tree->_parent = NULL;
	403	tree->_sibling = NULL;
d8925383	404	_CFReleaseGC(tree);
9ce05555 A	405	}
	406	}
	407
	408	void CFTreeRemoveAllChildren(CFTreeRef tree) {
	409	CFTreeRef nextChild;
	410	__CFGenericValidateType(tree, __kCFTreeTypeID);
	411	nextChild = tree->_child;
	412	tree->_child = NULL;
d8925383	413	tree->_rightmostChild = NULL;
9ce05555 A	414	while (NULL != nextChild) {
	415	CFTreeRef nextSibling = nextChild->_sibling;
	416	nextChild->_parent = NULL;
	417	nextChild->_sibling = NULL;
d8925383	418	_CFReleaseGC(nextChild);
9ce05555 A	419	nextChild = nextSibling;
	420	}
	421	}
	422
	423	struct _tcompareContext {
	424	CFComparatorFunction func;
	425	void *context;
	426	};
	427
	428	static CFComparisonResult __CFTreeCompareValues(const void v1, const void v2, struct _tcompareContext *context) {
	429	const void val1 = (const void )v1;
	430	const void val2 = (const void )v2;
	431	return (CFComparisonResult)(INVOKE_CALLBACK3(context->func, val1, val2, context->context));
	432	}
	433
	434	void CFTreeSortChildren(CFTreeRef tree, CFComparatorFunction comparator, void *context) {
	435	CFIndex children;
	436	__CFGenericValidateType(tree, __kCFTreeTypeID);
	437	CFAssert1(NULL != comparator, __kCFLogAssertion, "%s(): pointer to comparator function may not be NULL", __PRETTY_FUNCTION__);
	438	children = CFTreeGetChildCount(tree);
	439	if (1 < children) {
	440	CFIndex idx;
	441	CFTreeRef nextChild;
	442	struct _tcompareContext ctx;
	443	CFTreeRef *list, buffer[128];
d8925383	444	CFAllocatorRef allocator = __CFGetAllocator(tree);
9ce05555	445
bd5b749c	446	list = (children < 128) ? buffer : (CFTreeRef )CFAllocatorAllocate(kCFAllocatorSystemDefault, children sizeof(CFTreeRef), 0); // XXX_PCB GC OK
9ce05555 A	447	if (__CFOASafe && list != buffer) __CFSetLastAllocationEventName(tree->_callbacks, "CFTree (temp)");
	448	nextChild = tree->_child;
	449	for (idx = 0; NULL != nextChild; idx++) {
	450	list[idx] = nextChild;
	451	nextChild = nextChild->_sibling;
	452	}
	453
	454	ctx.func = comparator;
	455	ctx.context = context;
	456	CFQSortArray(list, children, sizeof(CFTreeRef), (CFComparatorFunction)__CFTreeCompareValues, &ctx);
	457
d8925383	458	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, tree, tree->_child, list[0]);
9ce05555	459	for (idx = 1; idx < children; idx++) {
d8925383	460	CF_WRITE_BARRIER_BASE_ASSIGN(allocator, list[idx - 1], list[idx - 1]->_sibling, list[idx]);
9ce05555 A	461	}
9ce05555 A	462	list[idx - 1]->_sibling = NULL;
d8925383	463	tree->_rightmostChild = list[children - 1];
bd5b749c	464	if (list != buffer) CFAllocatorDeallocate(kCFAllocatorSystemDefault, list); // XXX_PCB GC OK
9ce05555 A	465	}
	466	}
	467