CFBasicHash.h

/*
 * Copyright (c) 2009-2012 Brent Fulgham <bfulgham@gmail.org>. All rights reserved.
 *
 * This source code is a modified version of the CoreFoundation sources released by Apple Inc. under
 * the terms of the APSL version 2.0 (see below).
 *
 * For information about changes from the original Apple source release can be found by reviewing the
 * source control system for the project at https://sourceforge.net/svn/?group_id=246198.
 *
 * The original license information is as follows:
 * 
 * Copyright (c) 2012 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@
 */

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

#include<CoreFoundation/CFBase.h>
#include<CoreFoundation/CoreFoundation_Prefix.h>
#include<CoreFoundation/CFString.h>
#include"CFInternal.h"

CF_EXTERN_C_BEGIN

struct__objcFastEnumerationStateEquivalent2 {
unsigned longstate;
unsigned long*itemsPtr;
unsigned long*mutationsPtr;
unsigned longextra[5];
};

enum {
__kCFBasicHashLinearHashingValue=1,
__kCFBasicHashDoubleHashingValue=2,
__kCFBasicHashExponentialHashingValue=3,
};

enum {
kCFBasicHashHasKeys= (1UL << 0),
kCFBasicHashHasCounts= (1UL << 1),
kCFBasicHashHasHashCache= (1UL << 2),

kCFBasicHashIntegerValues= (1UL << 6),
kCFBasicHashIntegerKeys= (1UL << 7),

kCFBasicHashStrongValues= (1UL << 8),
kCFBasicHashStrongKeys= (1UL << 9),

kCFBasicHashWeakValues= (1UL << 10),
kCFBasicHashWeakKeys= (1UL << 11),

kCFBasicHashIndirectKeys= (1UL << 12),

kCFBasicHashLinearHashing= (__kCFBasicHashLinearHashingValue << 13), // bits 13-14
kCFBasicHashDoubleHashing= (__kCFBasicHashDoubleHashingValue << 13),
kCFBasicHashExponentialHashing= (__kCFBasicHashExponentialHashingValue << 13),

kCFBasicHashAggressiveGrowth= (1UL << 15),

kCFBasicHashCompactableValues= (1UL << 16),
kCFBasicHashCompactableKeys= (1UL << 17),
};

// Note that for a hash table without keys, the value is treated as the key,
// and the value should be passed in as the key for operations which take a key.

typedefstruct {
CFIndexidx;
uintptr_tweak_key;
uintptr_tweak_value;
uintptr_tcount;
} CFBasicHashBucket;

typedefstruct__CFBasicHash*CFBasicHashRef;
typedefconststruct__CFBasicHash*CFConstBasicHashRef;

// Bit 6 in the CF_INFO_BITS of the CFRuntimeBase inside the CFBasicHashRef is the "is immutable" bit
CF_INLINEBooleanCFBasicHashIsMutable(CFConstBasicHashRefht) {
return__CFBitfieldGetValue(((CFRuntimeBase*)ht)->_cfinfo[CF_INFO_BITS], 6, 6) ? false : true;
}

CF_INLINEvoidCFBasicHashMakeImmutable(CFBasicHashRefht) {
__CFBitfieldSetValue(((CFRuntimeBase*)ht)->_cfinfo[CF_INFO_BITS], 6, 6, 1);
}


typedefstruct__CFBasicHashCallbacksCFBasicHashCallbacks;

struct__CFBasicHashCallbacks {
CFBasicHashCallbacks*(*copyCallbacks)(CFConstBasicHashRefht, CFAllocatorRefallocator, CFBasicHashCallbacks*cb); // Return new value
void (*freeCallbacks)(CFConstBasicHashRefht, CFAllocatorRefallocator, CFBasicHashCallbacks*cb);
uintptr_t (*retainValue)(CFConstBasicHashRefht, uintptr_tstack_value); // Return 2nd arg or new value
uintptr_t (*retainKey)(CFConstBasicHashRefht, uintptr_tstack_key); // Return 2nd arg or new key
void (*releaseValue)(CFConstBasicHashRefht, uintptr_tstack_value);
void (*releaseKey)(CFConstBasicHashRefht, uintptr_tstack_key);
Boolean (*equateValues)(CFConstBasicHashRefht, uintptr_tcoll_value1, uintptr_tstack_value2); // 2nd arg is in-collection value, 3rd arg is probe parameter OR in-collection value for a second collection
Boolean (*equateKeys)(CFConstBasicHashRefht, uintptr_tcoll_key1, uintptr_tstack_key2); // 2nd arg is in-collection key, 3rd arg is probe parameter
uintptr_t (*hashKey)(CFConstBasicHashRefht, uintptr_tstack_key);
uintptr_t (*getIndirectKey)(CFConstBasicHashRefht, uintptr_tcoll_value); // Return key; 2nd arg is in-collection value
CFStringRef (*copyValueDescription)(CFConstBasicHashRefht, uintptr_tstack_value);
CFStringRef (*copyKeyDescription)(CFConstBasicHashRefht, uintptr_tstack_key);
uintptr_tcontext[0]; // variable size; any pointers in here must remain valid as long as the CFBasicHash
};

BooleanCFBasicHashHasStrongValues(CFConstBasicHashRefht);
BooleanCFBasicHashHasStrongKeys(CFConstBasicHashRefht);

uint16_tCFBasicHashGetSpecialBits(CFConstBasicHashRefht);
uint16_tCFBasicHashSetSpecialBits(CFBasicHashRefht, uint16_tbits);

CFOptionFlagsCFBasicHashGetFlags(CFConstBasicHashRefht);
CFIndexCFBasicHashGetNumBuckets(CFConstBasicHashRefht);
CFIndexCFBasicHashGetCapacity(CFConstBasicHashRefht);
voidCFBasicHashSetCapacity(CFBasicHashRefht, CFIndexcapacity);

constCFBasicHashCallbacks*CFBasicHashGetCallbacks(CFConstBasicHashRefht);
CFIndexCFBasicHashGetCount(CFConstBasicHashRefht);
CFBasicHashBucketCFBasicHashGetBucket(CFConstBasicHashRefht, CFIndexidx);
CFBasicHashBucketCFBasicHashFindBucket(CFConstBasicHashRefht, uintptr_tstack_key);
CFIndexCFBasicHashGetCountOfKey(CFConstBasicHashRefht, uintptr_tstack_key);
CFIndexCFBasicHashGetCountOfValue(CFConstBasicHashRefht, uintptr_tstack_value);
BooleanCFBasicHashesAreEqual(CFConstBasicHashRefht1, CFConstBasicHashRefht2);
#if__BLOCKS__
voidCFBasicHashApply(CFConstBasicHashRefht, Boolean (^block)(CFBasicHashBucket));
voidCFBasicHashApplyIndexed(CFConstBasicHashRefht, CFRangerange, Boolean (^block)(CFBasicHashBucket));
#endif
voidCFBasicHashGetElements(CFConstBasicHashRefht, CFIndexbufferslen, uintptr_t*weak_values, uintptr_t*weak_keys);

BooleanCFBasicHashAddValue(CFBasicHashRefht, uintptr_tstack_key, uintptr_tstack_value);
voidCFBasicHashReplaceValue(CFBasicHashRefht, uintptr_tstack_key, uintptr_tstack_value);
voidCFBasicHashSetValue(CFBasicHashRefht, uintptr_tstack_key, uintptr_tstack_value);
CFIndexCFBasicHashRemoveValue(CFBasicHashRefht, uintptr_tstack_key);
CFIndexCFBasicHashRemoveValueAtIndex(CFBasicHashRefht, CFIndexidx);
voidCFBasicHashRemoveAllValues(CFBasicHashRefht);

BooleanCFBasicHashAddIntValueAndInc(CFBasicHashRefht, uintptr_tstack_key, uintptr_tint_value);
voidCFBasicHashRemoveIntValueAndDec(CFBasicHashRefht, uintptr_tint_value);

size_tCFBasicHashGetSize(CFConstBasicHashRefht, Booleantotal);

CFStringRefCFBasicHashCopyDescription(CFConstBasicHashRefht, Booleandetailed, CFStringReflinePrefix, CFStringRefentryLinePrefix, BooleandescribeElements);

CFTypeIDCFBasicHashGetTypeID(void);

externBoolean__CFBasicHashEqual(CFTypeRefcf1, CFTypeRefcf2);
externCFHashCode__CFBasicHashHash(CFTypeRefcf);
externCFStringRef__CFBasicHashCopyDescription(CFTypeRefcf);
externvoid__CFBasicHashDeallocate(CFTypeRefcf);
externunsigned long__CFBasicHashFastEnumeration(CFConstBasicHashRefht, struct__objcFastEnumerationStateEquivalent2*state, void*stackbuffer, unsigned longcount);

// creation functions create mutable CFBasicHashRefs
CFBasicHashRefCFBasicHashCreate(CFAllocatorRefallocator, CFOptionFlagsflags, constCFBasicHashCallbacks*cb);
CFBasicHashRefCFBasicHashCreateCopy(CFAllocatorRefallocator, CFConstBasicHashRefht);
void__CFBasicHashSetCallbacks(CFBasicHashRefht, constCFBasicHashCallbacks*cb);


CF_EXTERN_C_END