OFMapTable.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#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);
    unsigned long (*_Nullable hash)(void *_Nullable object);
    bool (*_Nullable equal)(void *_Nullable object1,
        void *_Nullable object2);
} OFMapTableFunctions;
 
#ifdef OF_HAVE_BLOCKS
typedef void (^OFMapTableEnumerationBlock)(void *_Nullable key,
    void *_Nullable object, bool *stop);
 
typedef void *_Nullable (^OFMapTableReplaceBlock)(void *_Nullable key,
    void *_Nullable object);
#endif
 
@class OFMapTableEnumerator;
 
OF_SUBCLASSING_RESTRICTED
@interface OFMapTable: OFObject <OFCopying, OFFastEnumeration>
{
    OFMapTableFunctions _keyFunctions, _objectFunctions;
    struct OFMapTableBucket *_Nonnull *_Nullable _buckets;
    uint32_t _count, _capacity;
    unsigned char _rotation;
    unsigned long _mutations;
}
 
@property (readonly, nonatomic) OFMapTableFunctions keyFunctions;
 
@property (readonly, nonatomic) OFMapTableFunctions objectFunctions;
 
@property (readonly, nonatomic) size_t count;
 
+ (instancetype)mapTableWithKeyFunctions: (OFMapTableFunctions)keyFunctions
             objectFunctions: (OFMapTableFunctions)objectFunctions;
 
+ (instancetype)mapTableWithKeyFunctions: (OFMapTableFunctions)keyFunctions
             objectFunctions: (OFMapTableFunctions)objectFunctions
                capacity: (size_t)capacity;
 
- (instancetype)init OF_UNAVAILABLE;
 
- (instancetype)initWithKeyFunctions: (OFMapTableFunctions)keyFunctions
             objectFunctions: (OFMapTableFunctions)objectFunctions;
 
- (instancetype)initWithKeyFunctions: (OFMapTableFunctions)keyFunctions
             objectFunctions: (OFMapTableFunctions)objectFunctions
                capacity: (size_t)capacity
    OF_DESIGNATED_INITIALIZER;
 
- (nullable void *)objectForKey: (void *)key;
 
- (void)setObject: (nullable void *)object forKey: (nullable void *)key;
 
- (void)removeObjectForKey: (nullable void *)key;
 
- (void)removeAllObjects;
 
- (bool)containsObject: (nullable void *)object;
 
- (bool)containsObjectIdenticalTo: (nullable void *)object;
 
- (OFMapTableEnumerator *)keyEnumerator;
 
- (OFMapTableEnumerator *)objectEnumerator;
 
#ifdef OF_HAVE_BLOCKS
- (void)enumerateKeysAndObjectsUsingBlock: (OFMapTableEnumerationBlock)block;
 
- (void)replaceObjectsUsingBlock: (OFMapTableReplaceBlock)block;
#endif
@end
 
#ifndef OF_MAP_TABLE_M
OF_SUBCLASSING_RESTRICTED
#endif
@interface OFMapTableEnumerator: OFObject
{
    OFMapTable *_mapTable;
    struct OFMapTableBucket *_Nonnull *_Nullable _buckets;
    uint32_t _capacity;
    unsigned long _mutations, *_Nullable _mutationsPtr, _position;
}
 
- (instancetype)init OF_UNAVAILABLE;
 
- (void *_Nullable *_Nullable)nextObject;
@end
 
OF_ASSUME_NONNULL_END