OFDictionary.h

/*
 * 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.
 */

#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 "OFSerialization.h"
#import "OFJSONRepresentation.h"
#import "OFMessagePackRepresentation.h"

OF_ASSUME_NONNULL_BEGIN

@class OFArray OF_GENERIC(ObjectType);

#ifdef OF_HAVE_BLOCKS
typedef void (^of_dictionary_enumeration_block_t)(id key, id object,
     bool *stop);
typedef bool (^of_dictionary_filter_block_t)(id key, id object);
typedef id OF_NONNULL (^of_dictionary_map_block_t)(id key, id object);
#endif

#ifdef OF_HAVE_GENERICS
@interface OFDictionary <KeyType, ObjectType>:
#else
# ifndef DOXYGEN
#  define KeyType id
#  define ObjectType id
# endif
@interface OFDictionary:
#endif
    OFObject <OFCopying, OFMutableCopying, OFCollection, OFSerialization,
    OFJSONRepresentation, OFMessagePackRepresentation>
+ (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 OF_NONNULL *OF_NONNULL)objects
          forKeys: (KeyType const OF_NONNULL *OF_NONNULL)keys
            count: (size_t)count;

+ (instancetype)dictionaryWithKeysAndObjects: (KeyType)firstKey, ...
    OF_SENTINEL;

- initWithDictionary: (OFDictionary OF_GENERIC(KeyType, ObjectType)*)dictionary;

- initWithObject: (ObjectType)object
      forKey: (KeyType)key;

- initWithObjects: (OFArray OF_GENERIC(ObjectType)*)objects
      forKeys: (OFArray OF_GENERIC(KeyType)*)keys;

- initWithObjects: (ObjectType const OF_NONNULL *OF_NONNULL)objects
      forKeys: (KeyType const OF_NONNULL *OF_NONNULL)keys
        count: (size_t)count;

- initWithKeysAndObjects: (KeyType)firstKey, ... OF_SENTINEL;

- initWithKey: (KeyType)firstKey
    arguments: (va_list)arguments;

- (nullable ObjectType)objectForKey: (KeyType)key;
- (nullable ObjectType)objectForKeyedSubscript: (KeyType)key;

- (bool)containsObject: (nullable ObjectType)object;

- (bool)containsObjectIdenticalTo: (nullable ObjectType)object;

- (OFArray OF_GENERIC(KeyType)*)allKeys;

- (OFArray OF_GENERIC(ObjectType)*)allObjects;

- (OFEnumerator OF_GENERIC(KeyType)*)keyEnumerator;

- (OFEnumerator OF_GENERIC(ObjectType)*)objectEnumerator;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateKeysAndObjectsUsingBlock:
    (of_dictionary_enumeration_block_t)block;

- (OFDictionary OF_GENERIC(KeyType, id)*)mappedDictionaryUsingBlock:
    (of_dictionary_map_block_t)block;

- (OFDictionary OF_GENERIC(KeyType, ObjectType)*)filteredDictionaryUsingBlock:
    (of_dictionary_filter_block_t)block;
#endif
@end
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef KeyType
# undef ObjectType
#endif

OF_ASSUME_NONNULL_END

#import "OFMutableDictionary.h"

#ifndef NSINTEGER_DEFINED
/* Required for dictionary literals to work */
@compatibility_alias NSDictionary OFDictionary;
#endif