OFMapTable.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   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.
 */

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

OF_ASSUME_NONNULL_BEGIN

typedef struct {
    void *OF_NONNULL (*OF_NULLABLE retain)(void *value);
    void (*OF_NULLABLE release)(void *value);
    uint32_t (*OF_NULLABLE hash)(void *value);
    bool (*OF_NULLABLE equal)(void *value1, void *value2);
} of_map_table_functions_t;

#ifdef OF_HAVE_BLOCKS

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

typedef void *OF_NONNULL (^of_map_table_replace_block_t)(
    void *key, void *value);
#endif

@class OFMapTableEnumerator;

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

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

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

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

- initWithKeyFunctions: (of_map_table_functions_t)keyFunctions
    valueFunctions: (of_map_table_functions_t)valueFunctions
          capacity: (size_t)capacity;

- (size_t)count;

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

- (void)setValue: (void*)value
      forKey: (void*)key;

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

- (void)removeAllValues;

- (bool)containsValue: (nullable void*)value;

- (bool)containsValueIdenticalTo: (nullable void*)value;

- (OFMapTableEnumerator*)keyEnumerator;

- (OFMapTableEnumerator*)valueEnumerator;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateKeysAndValuesUsingBlock:
    (of_map_table_enumeration_block_t)block;

- (void)replaceValuesUsingBlock: (of_map_table_replace_block_t)block;
#endif

- (of_map_table_functions_t)keyFunctions;

- (of_map_table_functions_t)valueFunctions;
@end

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

- (void*)nextValue;

- (void)reset;
@end

OF_ASSUME_NONNULL_END