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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
-
-
+
-
-
+
-
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
+
+
-
+
-
+
|
#import "OFObject.h"
#import "OFCollection.h"
#import "OFEnumerator.h"
#import "OFSerialization.h"
OF_ASSUME_NONNULL_BEGIN
typedef struct of_list_object_t of_list_object_t;
typedef struct OFListItem OFListItem;
/**
* @struct of_list_object_t OFList.h ObjFW/OFList.h
* @struct OFListItem OFList.h ObjFW/OFList.h
*
* @brief A list object.
* @brief A list item.
*
* A struct that contains a pointer to the next list object, the previous list
* object and the object.
* A struct that contains a pointer to the next list item, the previous list
* item and the object.
*/
struct of_list_object_t {
struct OFListItem {
/** A pointer to the next list object in the list */
of_list_object_t *_Nullable next;
OFListItem *_Nullable next;
/** A pointer to the previous list object in the list */
of_list_object_t *_Nullable previous;
OFListItem *_Nullable previous;
/** The object for the list object */
id __unsafe_unretained object;
};
/**
* @class OFList OFList.h ObjFW/OFList.h
*
* @brief A class which provides easy to use double-linked lists.
*/
@interface OFList OF_GENERIC(ObjectType): OFObject <OFCopying, OFCollection,
OFSerialization>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif
{
of_list_object_t *_Nullable _firstListObject;
of_list_object_t *_Nullable _lastListObject;
OFListItem *_Nullable _firstListItem;
OFListItem *_Nullable _lastListItem;
size_t _count;
unsigned long _mutations;
unsigned long _mutations;
OF_RESERVE_IVARS(OFList, 4)
}
/**
* @brief The first list object of the list.
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFListItem *firstListItem;
of_list_object_t *firstListObject;
@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFListItem *lastListItem;
of_list_object_t *lastListObject;
* @return An of_list_object_t, needed to identify the object inside the list.
* @return An OFListItem, needed to identify the object inside the list.
* For example, if you want to remove an object from the list, you need
* its of_list_object_t.
* its OFListItem.
*/
- (of_list_object_t *)appendObject: (ObjectType)object;
- (OFListItem *)appendObject: (ObjectType)object;
/**
* @brief Prepends an object to the list.
*
* @param object The object to prepend
* @return An of_list_object_t, needed to identify the object inside the list.
* @return An OFListItem, needed to identify the object inside the list.
* For example, if you want to remove an object from the list, you need
* its of_list_object_t.
* its OFListItem.
*/
- (of_list_object_t *)prependObject: (ObjectType)object;
- (OFListItem *)prependObject: (ObjectType)object;
/**
* @brief Inserts an object before another list object.
*
* @param object The object to insert
* @param listObject The of_list_object_t of the object before which it should
* be inserted
* @return An of_list_object_t, needed to identify the object inside the list.
* @param listItem The OFListItem of the object before which it should be
* inserted
* @return An OFListItem, needed to identify the object inside the list.
* For example, if you want to remove an object from the list, you need
* its of_list_object_t.
* its OFListItem.
*/
- (of_list_object_t *)insertObject: (ObjectType)object
beforeListObject: (of_list_object_t *)listObject;
- (OFListItem *)insertObject: (ObjectType)object
beforeListItem: (OFListItem *)listItem;
/**
* @brief Inserts an object after another list object.
*
* @param object The object to insert
* @param listObject The of_list_object_t of the object after which it should be
* @param listItem The OFListItem of the object after which it should be
* inserted
* @return An of_list_object_t, needed to identify the object inside the list.
* @return An OFListItem, needed to identify the object inside the list.
* For example, if you want to remove an object from the list, you need
* its of_list_object_t.
* its OFListItem.
*/
- (of_list_object_t *)insertObject: (ObjectType)object
afterListObject: (of_list_object_t *)listObject;
- (OFListItem *)insertObject: (ObjectType)object
afterListItem: (OFListItem *)listItem;
/**
* @brief Removes the object with the specified list object from the list.
*
* @param listObject The list object returned by append / prepend
* @param listItem The list object returned by append / prepend
*/
- (void)removeListObject: (of_list_object_t *)listObject;
- (void)removeListItem: (OFListItem *)listItem;
/**
* @brief Checks whether the list contains an object equal to the specified
* object.
*
* @param object The object which is checked for being in the list
* @return A boolean whether the list contains the specified object
|