OFDictionary.h

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

@class OFArray;

#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_dictionary_map_block_t)(id key, id object);
#endif

@interface OFDictionary: OFObject <OFCopying, OFMutableCopying, OFCollection,
    OFSerialization, OFJSONRepresentation>
+ (instancetype)dictionary;

+ (instancetype)dictionaryWithDictionary: (OFDictionary*)dictionary;

+ (instancetype)dictionaryWithObject: (id)object
                  forKey: (id)key;

+ (instancetype)dictionaryWithObjects: (OFArray*)objects
                  forKeys: (OFArray*)keys;

+ (instancetype)dictionaryWithObjects: (id const*)objects
                  forKeys: (id const*)keys
                count: (size_t)count;

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

- initWithDictionary: (OFDictionary*)dictionary;

- initWithObject: (id)object
      forKey: (id)key;

- initWithObjects: (OFArray*)objects
      forKeys: (OFArray*)keys;

- initWithObjects: (id const*)objects
      forKeys: (id const*)keys
        count: (size_t)count;

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

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

- (id)objectForKey: (id)key;
- (id)objectForKeyedSubscript: (id)key;

- (BOOL)containsObjectIdenticalTo: (id)object;

- (OFArray*)allKeys;

- (OFArray*)allObjects;

- (OFEnumerator*)keyEnumerator;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateKeysAndObjectsUsingBlock:
    (of_dictionary_enumeration_block_t)block;

- (OFDictionary*)mappedDictionaryUsingBlock: (of_dictionary_map_block_t)block;

- (OFDictionary*)filteredDictionaryUsingBlock:
    (of_dictionary_filter_block_t)block;
#endif
@end

#import "OFMutableDictionary.h"

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