@@ -28,11 +28,11 @@ #import "OFEnumerator.h" #import "OFSerialization.h" #import "OFJSONRepresentation.h" #import "OFMessagePackRepresentation.h" -@class OFArray; +@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); @@ -47,12 +47,21 @@ * Keys are copied and thus must conform to the OFCopying protocol. * * @note Fast enumeration on a dictionary enumerates through the keys of the * dictionary. */ -@interface OFDictionary: OFObject +#ifdef OF_HAVE_GENERICS +@interface OFDictionary : +#else +# ifndef DOXYGEN +# define KeyType id +# define ObjectType id +# endif +@interface OFDictionary: +#endif + OFObject /*! * @brief Creates a new OFDictionary. * * @return A new autoreleased OFDictionary */ @@ -62,82 +71,85 @@ * @brief Creates a new OFDictionary with the specified dictionary. * * @param dictionary An OFDictionary * @return A new autoreleased OFDictionary */ -+ (instancetype)dictionaryWithDictionary: (OFDictionary*)dictionary; ++ (instancetype)dictionaryWithDictionary: + (OFDictionary OF_GENERIC(KeyType, ObjectType)*)dictionary; /*! * @brief Creates a new OFDictionary with the specified key and object. * * @param key The key * @param object The object * @return A new autoreleased OFDictionary */ -+ (instancetype)dictionaryWithObject: (id)object - forKey: (id)key; ++ (instancetype)dictionaryWithObject: (ObjectType)object + forKey: (KeyType)key; /*! * @brief Creates a new OFDictionary with the specified keys and objects. * * @param keys An array of keys * @param objects An array of objects * @return A new autoreleased OFDictionary */ -+ (instancetype)dictionaryWithObjects: (OFArray*)objects - forKeys: (OFArray*)keys; ++ (instancetype) + dictionaryWithObjects: (OFArray OF_GENERIC(ObjectType)*)objects + forKeys: (OFArray OF_GENERIC(KeyType)*)keys; /*! * @brief Creates a new OFDictionary with the specified keys and objects. * * @param keys An array of keys * @param objects An array of objects * @param count The number of objects in the arrays * @return A new autoreleased OFDictionary */ -+ (instancetype)dictionaryWithObjects: (id const*)objects - forKeys: (id const*)keys ++ (instancetype)dictionaryWithObjects: (ObjectType const*)objects + forKeys: (KeyType const*)keys count: (size_t)count; /*! * @brief Creates a new OFDictionary with the specified keys objects. * * @param firstKey The first key * @return A new autoreleased OFDictionary */ -+ (instancetype)dictionaryWithKeysAndObjects: (id)firstKey, ... OF_SENTINEL; ++ (instancetype)dictionaryWithKeysAndObjects: (KeyType)firstKey, ... + OF_SENTINEL; /*! * @brief Initializes an already allocated OFDictionary with the specified * OFDictionary. * * @param dictionary An OFDictionary * @return An initialized OFDictionary */ -- initWithDictionary: (OFDictionary*)dictionary; +- initWithDictionary: (OFDictionary OF_GENERIC(KeyType, ObjectType)*)dictionary; /*! * @brief Initializes an already allocated OFDictionary with the specified key * and object. * * @param key The key * @param object The object * @return An initialized OFDictionary */ -- initWithObject: (id)object - forKey: (id)key; +- initWithObject: (ObjectType)object + forKey: (KeyType)key; /*! * @brief Initializes an already allocated OFDictionary with the specified keys * and objects. * * @param keys An array of keys * @param objects An array of objects * @return An initialized OFDictionary */ -- initWithObjects: (OFArray*)objects - forKeys: (OFArray*)keys; +- initWithObjects: (OFArray OF_GENERIC(ObjectType)*)objects + forKeys: (OFArray OF_GENERIC(KeyType)*)keys; /*! * @brief Initializes an already allocated OFDictionary with the specified keys * and objects. * @@ -144,32 +156,32 @@ * @param keys An array of keys * @param objects An array of objects * @param count The number of objects in the arrays * @return An initialized OFDictionary */ -- initWithObjects: (id const*)objects - forKeys: (id const*)keys +- initWithObjects: (ObjectType const*)objects + forKeys: (KeyType const*)keys count: (size_t)count; /*! * @brief Initializes an already allocated OFDictionary with the specified keys * and objects. * * @param firstKey The first key * @return An initialized OFDictionary */ -- initWithKeysAndObjects: (id)firstKey, ... OF_SENTINEL; +- initWithKeysAndObjects: (KeyType)firstKey, ... OF_SENTINEL; /*! * @brief Initializes an already allocated OFDictionary with the specified key * and va_list. * * @param firstKey The first key * @param arguments A va_list of the other arguments * @return An initialized OFDictionary */ -- initWithKey: (id)firstKey +- initWithKey: (KeyType)firstKey arguments: (va_list)arguments; /*! * @brief Returns the object for the given key or nil if the key was not found. * @@ -177,43 +189,59 @@ * performance reasons! * * @param key The key whose object should be returned * @return The object for the given key or nil if the key was not found */ -- (id)objectForKey: (id)key; -- (id)objectForKeyedSubscript: (id)key; +- (ObjectType)objectForKey: (KeyType)key; +- (ObjectType)objectForKeyedSubscript: (KeyType)key; + +/*! + * @brief Checks whether the dictionary contains an object equal to the + * specified object. + * + * @param object The object which is checked for being in the dictionary + * @return A boolean whether the dictionary contains the specified object + */ +- (bool)containsObject: (ObjectType)object; /*! * @brief Checks whether the dictionary contains an object with the specified * address. * * @param object The object which is checked for being in the dictionary * @return A boolean whether the dictionary contains an object with the - * specified address. + * specified address */ -- (bool)containsObjectIdenticalTo: (id)object; +- (bool)containsObjectIdenticalTo: (ObjectType)object; /*! * @brief Returns an array of all keys. * * @return An array of all keys */ -- (OFArray*)allKeys; +- (OFArray OF_GENERIC(KeyType)*)allKeys; /*! * @brief Returns an array of all objects. * * @return An array of all objects */ -- (OFArray*)allObjects; +- (OFArray OF_GENERIC(ObjectType)*)allObjects; /*! * @brief Returns an OFEnumerator to enumerate through the dictionary's keys. * * @return An OFEnumerator to enumerate through the dictionary's keys */ -- (OFEnumerator*)keyEnumerator; +- (OFEnumerator OF_GENERIC(KeyType)*)keyEnumerator; + +/*! + * @brief Returns an OFEnumerator to enumerate through the dictionary's objects. + * + * @return An OFEnumerator to enumerate through the dictionary's objects + */ +- (OFEnumerator OF_GENERIC(ObjectType)*)objectEnumerator; #ifdef OF_HAVE_BLOCKS /*! * @brief Executes a block for each key / object pair. * @@ -227,26 +255,31 @@ * block. * * @param block A block which maps an object for each object * @return A new autoreleased OFDictionary */ -- (OFDictionary*)mappedDictionaryUsingBlock: (of_dictionary_map_block_t)block; +- (OFDictionary OF_GENERIC(KeyType, id)*)mappedDictionaryUsingBlock: + (of_dictionary_map_block_t)block; /*! * @brief Creates a new dictionary, only containing the objects for which the * block returns true. * * @param block A block which determines if the object should be in the new * dictionary * @return A new autoreleased OFDictionary */ -- (OFDictionary*)filteredDictionaryUsingBlock: +- (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 #import "OFMutableDictionary.h" #ifndef NSINTEGER_DEFINED /* Required for dictionary literals to work */ @compatibility_alias NSDictionary OFDictionary; #endif