OFDictionary.h

/*
 * 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/>.
 */
 
#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif
 
#include <stdarg.h>
 
#import "OFObject.h"
#import "OFCollection.h"
#import "OFEnumerator.h"
#import "OFJSONRepresentation.h"
#import "OFMessagePackRepresentation.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
 
#ifdef OF_HAVE_BLOCKS
typedef void (^OFDictionaryEnumerationBlock)(id key, id object, bool *stop);
 
typedef bool (^OFDictionaryFilterBlock)(id key, id object);
 
typedef id _Nonnull (^OFDictionaryMapBlock)(id key, id object);
#endif
 
@interface OFDictionary OF_GENERIC(KeyType, ObjectType): OFObject <OFCopying,
    OFMutableCopying, OFCollection, OFJSONRepresentation,
    OFMessagePackRepresentation>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define KeyType id
# define ObjectType id
#endif
@property (readonly, nonatomic) OFArray OF_GENERIC(KeyType) *allKeys;
 
@property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *allObjects;
 
+ (instancetype)dictionary;
 
+ (instancetype)dictionaryWithDictionary:
   (OFDictionary OF_GENERIC(KeyType, ObjectType) *)dictionary;
 
+ (instancetype)dictionaryWithObject: (ObjectType)object forKey: (KeyType)key;
 
+ (instancetype)dictionaryWithObjects: (OFArray OF_GENERIC(ObjectType) *)objects
                  forKeys: (OFArray OF_GENERIC(KeyType) *)keys;
 
+ (instancetype)
    dictionaryWithObjects: (ObjectType const _Nonnull *_Nonnull)objects
          forKeys: (KeyType const _Nonnull *_Nonnull)keys
            count: (size_t)count;
 
+ (instancetype)dictionaryWithKeysAndObjects: (KeyType)firstKey, ...
    OF_SENTINEL;
 
- (instancetype)init OF_DESIGNATED_INITIALIZER;
 
- (instancetype)initWithDictionary:
    (OFDictionary OF_GENERIC(KeyType, ObjectType) *)dictionary;
 
- (instancetype)initWithObject: (ObjectType)object forKey: (KeyType)key;
 
- (instancetype)initWithObjects: (OFArray OF_GENERIC(ObjectType) *)objects
            forKeys: (OFArray OF_GENERIC(KeyType) *)keys;
 
- (instancetype)initWithObjects: (ObjectType const _Nonnull *_Nonnull)objects
            forKeys: (KeyType const _Nonnull *_Nonnull)keys
              count: (size_t)count OF_DESIGNATED_INITIALIZER;
 
- (instancetype)initWithKeysAndObjects: (KeyType)firstKey, ... OF_SENTINEL;
 
- (instancetype)initWithKey: (KeyType)firstKey arguments: (va_list)arguments;
 
- (nullable ObjectType)objectForKey: (KeyType)key;
- (nullable ObjectType)objectForKeyedSubscript: (KeyType)key;
 
- (nullable id)valueForKey: (OFString *)key;
 
- (void)setValue: (nullable id)value forKey: (OFString *)key;
 
- (bool)containsObject: (ObjectType)object;
 
- (bool)containsObjectIdenticalTo: (ObjectType)object;
 
- (OFEnumerator OF_GENERIC(KeyType) *)keyEnumerator;
 
- (OFEnumerator OF_GENERIC(ObjectType) *)objectEnumerator;
 
#ifdef OF_HAVE_BLOCKS
- (void)enumerateKeysAndObjectsUsingBlock: (OFDictionaryEnumerationBlock)block;
 
- (OFDictionary OF_GENERIC(KeyType, id) *)
    mappedDictionaryUsingBlock: (OFDictionaryMapBlock)block;
 
- (OFDictionary OF_GENERIC(KeyType, ObjectType) *)
    filteredDictionaryUsingBlock: (OFDictionaryFilterBlock)block;
#endif
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef KeyType
# undef ObjectType
#endif
@end
 
OF_ASSUME_NONNULL_END
 
#import "OFMutableDictionary.h"
 
#if !defined(NSINTEGER_DEFINED) && !__has_feature(modules)
/* Required for dictionary literals to work */
@compatibility_alias NSDictionary OFDictionary;
#endif