src/OFDictionary.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#include <stdarg.h>

#import "OFObject.h"
#import "OFCollection.h"
#import "OFEnumerator.h"

@class OFArray;

#ifdef OF_HAVE_BLOCKS
typedef void (^of_dictionary_enumeration_block_t)(id key, id obj, BOOL *stop);
typedef BOOL (^of_dictionary_filter_block_t)(id key, id obj);
typedef id (^of_dictionary_map_block_t)(id key, id obj);
#endif

struct of_dictionary_bucket
{
        id <OFCopying> key;
        id object;
        uint32_t hash;
};

@interface OFDictionary: OFObject <OFCopying, OFMutableCopying, OFCollection,
    OFFastEnumeration>
{
        struct of_dictionary_bucket **data;
        uint32_t size;
        size_t count;
}

+ dictionary;

+ dictionaryWithDictionary: (OFDictionary*)dict;

+ dictionaryWithObject: (id)obj
                forKey: (id <OFCopying>)key;

+ dictionaryWithObjects: (OFArray*)objs
                forKeys: (OFArray*)keys;

+ dictionaryWithKeysAndObjects: (id <OFCopying>)key, ...;

- init;

- initWithDictionary: (OFDictionary*)dict;

- initWithObject: (id)obj
          forKey: (id <OFCopying>)key;

- initWithObjects: (OFArray*)objs
          forKeys: (OFArray*)keys;

- initWithKeysAndObjects: (id <OFCopying>)first, ...;

- initWithKey: (id <OFCopying>)first
      argList: (va_list)args;

- (id)objectForKey: (id)key;

- (OFEnumerator*)keyEnumerator;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateKeysAndObjectsUsingBlock:
    (of_dictionary_enumeration_block_t)block;

- (OFDictionary*)mappedDictionaryUsingBlock: (of_dictionary_map_block_t)block;

- (OFDictionary*)filteredDictionaryUsingBlock:
    (of_dictionary_filter_block_t)block;
#endif
@end

@interface OFDictionaryEnumerator: OFEnumerator
{
        OFDictionary *dictionary;
        struct of_dictionary_bucket **data;
        uint32_t size;
        unsigned long mutations;
        unsigned long *mutationsPtr;
        uint32_t pos;
}

- initWithDictionary: (OFDictionary*)dictionary
                data: (struct of_dictionary_bucket**)data
                size: (uint32_t)size
    mutationsPointer: (unsigned long*)mutationsPtr;
@end

@interface OFDictionaryObjectEnumerator: OFDictionaryEnumerator
@end

@interface OFDictionaryKeyEnumerator: OFDictionaryEnumerator
@end

#import "OFMutableDictionary.h"

#ifdef __cplusplus
extern "C" {
#endif
extern struct of_dictionary_bucket of_dictionary_deleted_bucket;
#ifdef __cplusplus
}
#endif