15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
|
* file.
*/
#import "OFDictionary.h"
OF_ASSUME_NONNULL_BEGIN
/*! @file */
/** @file */
#ifdef OF_HAVE_BLOCKS
/*!
/**
* @brief A block for replacing objects in an OFMutableDictionary.
*
* @param key The key of the object to replace
* @param object The object to replace
* @return The object to replace the object with
*/
typedef id _Nonnull (^of_dictionary_replace_block_t)(id key, id object);
#endif
/*!
/**
* @class OFMutableDictionary OFDictionary.h ObjFW/OFDictionary.h
*
* @brief An abstract class for storing and changing objects in a dictionary.
*
* @note Subclasses must implement @ref setObject:forKey:,
* @ref removeObjectForKey: as well as all methods of @ref OFDictionary
* that need to be implemented.
*/
@interface OFMutableDictionary OF_GENERIC(KeyType, ObjectType):
OFDictionary OF_GENERIC(KeyType, ObjectType)
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define KeyType id
# define ObjectType id
#endif
/*!
/**
* @brief Creates a new OFMutableDictionary with enough memory to hold the
* specified number of objects.
*
* @param capacity The initial capacity for the OFMutableDictionary
* @return A new autoreleased OFMutableDictionary
*/
+ (instancetype)dictionaryWithCapacity: (size_t)capacity;
/*!
/**
* @brief Initializes an already allocated OFMutableDictionary with enough
* memory to hold the specified number of objects.
*
* @param capacity The initial capacity for the OFMutableDictionary
* @return An initialized OFMutableDictionary
*/
- (instancetype)initWithCapacity: (size_t)capacity;
/*!
/**
* @brief Sets an object for a key.
*
* A key can be any object that conforms to the OFCopying protocol.
*
* @param key The key to set
* @param object The object to set the key to
*/
- (void)setObject: (ObjectType)object
forKey: (KeyType)key;
/*!
/**
* @brief Sets an object for a key.
*
* A key can be any object that conforms to the OFCopying protocol.
*
* This method is also used by the subscripting syntax.
*
* @param key The key to set
* @param object The object to set the key to. If it is nil, this is equal to
* calling @ref removeObjectForKey:.
*/
- (void)setObject: (nullable ObjectType)object
forKeyedSubscript: (KeyType)key;
/*!
/**
* @brief Removes the object for the specified key from the dictionary.
*
* @param key The key whose object should be removed
*/
- (void)removeObjectForKey: (KeyType)key;
/*!
/**
* @brief Removes all objects.
*/
- (void)removeAllObjects;
/*!
/**
* @brief Adds the entries from the specified dictionary.
*
* @param dictionary The dictionary whose entries should be added
*/
- (void)addEntriesFromDictionary:
(OFDictionary OF_GENERIC(KeyType, ObjectType) *)dictionary;
#ifdef OF_HAVE_BLOCKS
/*!
/**
* @brief Replaces each object with the object returned by the block.
*
* @param block The block which returns a new object for each object
*/
- (void)replaceObjectsUsingBlock: (of_dictionary_replace_block_t)block;
#endif
/*!
/**
* @brief Converts the mutable dictionary to an immutable dictionary.
*/
- (void)makeImmutable;
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef KeyType
# undef ObjectType
#endif
@end
OF_ASSUME_NONNULL_END
|