OFMapTable.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * 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.
 */

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

OF_ASSUME_NONNULL_BEGIN

typedef struct {
    void *_Nullable (*_Nullable retain)(void *_Nullable object);
    void (*_Nullable release)(void *_Nullable object);
    uint32_t (*_Nullable hash)(void *_Nullable object);
    bool (*_Nullable equal)(void *_Nullable object1,
        void *_Nullable object2);
} of_map_table_functions_t;

#ifdef OF_HAVE_BLOCKS

typedef void (^of_map_table_enumeration_block_t)(void *key, void *object,
    bool *stop);

typedef void *_Nonnull (^of_map_table_replace_block_t)(void *key, void *object);
#endif

@class OFMapTableEnumerator;

@interface OFMapTable: OFObject <OFCopying, OFFastEnumeration>
{
    of_map_table_functions_t _keyFunctions, _objectFunctions;
    struct of_map_table_bucket *_Nonnull *_Nullable _buckets;
    uint32_t _count, _capacity;
    uint8_t _rotate;
    unsigned long _mutations;
}

@property (readonly, nonatomic) of_map_table_functions_t keyFunctions;

@property (readonly, nonatomic) of_map_table_functions_t objectFunctions;

+ (instancetype)mapTableWithKeyFunctions: (of_map_table_functions_t)keyFunctions
             objectFunctions: (of_map_table_functions_t)
                          objectFunctions;

+ (instancetype)mapTableWithKeyFunctions: (of_map_table_functions_t)keyFunctions
             objectFunctions: (of_map_table_functions_t)
                          objectFunctions
                capacity: (size_t)capacity;

- init OF_UNAVAILABLE;

- initWithKeyFunctions: (of_map_table_functions_t)keyFunctions
       objectFunctions: (of_map_table_functions_t)objectFunctions;

- initWithKeyFunctions: (of_map_table_functions_t)keyFunctions
       objectFunctions: (of_map_table_functions_t)objectFunctions
          capacity: (size_t)capacity OF_DESIGNATED_INITIALIZER;

- (size_t)count;

- (nullable void *)objectForKey: (void *)key;

- (void)setObject: (void *)object
       forKey: (void *)key;

- (void)removeObjectForKey: (void *)key;

- (void)removeAllObjects;

- (bool)containsObject: (nullable void *)object;

- (bool)containsObjectIdenticalTo: (nullable void *)object;

- (OFMapTableEnumerator *)keyEnumerator;

- (OFMapTableEnumerator *)objectEnumerator;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateKeysAndObjectsUsingBlock:
    (of_map_table_enumeration_block_t)block;

- (void)replaceObjectsUsingBlock: (of_map_table_replace_block_t)block;
#endif
@end

@interface OFMapTableEnumerator: OFObject
{
    OFMapTable *_mapTable;
    struct of_map_table_bucket *_Nonnull *_Nullable _buckets;
    uint32_t _capacity;
    unsigned long _mutations;
    unsigned long *_Nullable _mutationsPtr;
    uint32_t _position;
}

- init OF_UNAVAILABLE;

- (nullable void *)nextObject;

- (void)reset;
@end

OF_ASSUME_NONNULL_END