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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
* file.
*/
#import "OFObject.h"
OF_ASSUME_NONNULL_BEGIN
/*!
* @class OFValue OFValue.h ObjFW/OFValue.h
*
* @brief A class for storing arbitrary values in an object.
*/
@interface OFValue: OFObject <OFCopying>
{
OF_RESERVE_IVARS(4)
}
/*!
* @brief The ObjC type encoding of the value.
*/
@property (readonly, nonatomic) const char *objCType;
/*!
* @brief The value as a pointer to void.
*
* If the value is not pointer-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) void *pointerValue;
/*!
* @brief The value as a non-retained object.
*
* If the value is not pointer-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) id nonretainedObjectValue;
/*!
* @brief The value as a range.
*
* If the value is not range-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_range_t rangeValue;
/*!
* @brief The value as a point.
*
* If the value is not point-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_point_t pointValue;
/*!
* @brief The value as a dimension.
*
* If the value is not dimension-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_dimension_t dimensionValue;
/*!
* @brief The value as a rectangle.
*
* If the value is not rectangle-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_rectangle_t rectangleValue;
/*!
* @brief Creates a new, autorelease OFValue with the specified bytes of the
* specified type.
*
* @param bytes The bytes containing the value
* @param objCType The ObjC type encoding for the value
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithBytes: (const void *)bytes
objCType: (const char *)objCType;
/*!
* @brief Creates a new, autoreleased OFValue containing the specified pointer.
*
* Only the raw value of the pointer is stored and no data will be copied.
*
* @param pointer The pointer the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithPointer: (const void *)pointer;
/*!
* @brief Creates a new, autoreleased OFValue containing the specified
* non-retained object.
*
* The object is not retained, which makes this useful for storing objects in
* collections without retaining them.
*
* @param object The object the OFValue should contain without retaining it
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithNonretainedObject: (id)object;
/*!
* @brief Creates a new, autoreleased OFValue containing the specified range.
*
* @param range The range the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithRange: (of_range_t)range;
/*!
* @brief Creates a new, autoreleased OFValue containing the specified point.
*
* @param point The point the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithPoint: (of_point_t)point;
/*!
* @brief Creates a new, autoreleased OFValue containing the specified
* dimension.
*
* @param dimension The dimension the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithDimension: (of_dimension_t)dimension;
/*!
* @brief Creates a new, autoreleased OFValue containing the specified
* rectangle.
*
* @param rectangle The rectangle the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithRectangle: (of_rectangle_t)rectangle;
/*!
* @brief Initializes an already allocated OFValue with the specified bytes of
* the specified type.
*
* @param bytes The bytes containing the value
* @param objCType The ObjC type encoding for the value
* @return An initialized OFValue
*/
- (instancetype)initWithBytes: (const void *)bytes
objCType: (const char *)objCType;
/*!
* @brief Initializes an already allocated OFValue containing the specified
* pointer.
*
* Only the raw value of the pointer is stored and no data will be copied.
*
* @param pointer The pointer the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithPointer: (const void *)pointer;
/*!
* @brief Initializes an already allocated OFValue containing the specified
* non-retained object.
*
* The object is not retained, which makes this useful for storing objects in
* collections without retaining them.
*
* @param object The object the OFValue should contain without retaining it
* @return An initialized OFValue
*/
- (instancetype)initWithNonretainedObject: (id)object;
/*!
* @brief Initializes an already allocated OFValue containing the specified
* range.
*
* @param range The range the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithRange: (of_range_t)range;
/*!
* @brief Initializes an already allocated OFValue containing the specified
* point.
*
* @param point The point the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithPoint: (of_point_t)point;
/*!
* @brief Initializes an already allocated OFValue containing the specified
* dimension.
*
* @param dimension The dimension the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithDimension: (of_dimension_t)dimension;
/*!
* @brief Initializes an already allocated OFValue containing the specified
* rectangle.
*
* @param rectangle The rectangle the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithRectangle: (of_rectangle_t)rectangle;
/*!
* @brief Gets the value.
*
* If the specified size does not match, this raises an
* @ref OFOutOfRangeException.
*
* @param value The buffer to copy the value into
* @param size The size of the value
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
* file.
*/
#import "OFObject.h"
OF_ASSUME_NONNULL_BEGIN
/**
* @class OFValue OFValue.h ObjFW/OFValue.h
*
* @brief A class for storing arbitrary values in an object.
*/
@interface OFValue: OFObject <OFCopying>
{
OF_RESERVE_IVARS(OFValue, 4)
}
/**
* @brief The ObjC type encoding of the value.
*/
@property (readonly, nonatomic) const char *objCType;
/**
* @brief The value as a pointer to void.
*
* If the value is not pointer-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) void *pointerValue;
/**
* @brief The value as a non-retained object.
*
* If the value is not pointer-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) id nonretainedObjectValue;
/**
* @brief The value as a range.
*
* If the value is not range-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_range_t rangeValue;
/**
* @brief The value as a point.
*
* If the value is not point-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_point_t pointValue;
/**
* @brief The value as a dimension.
*
* If the value is not dimension-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_dimension_t dimensionValue;
/**
* @brief The value as a rectangle.
*
* If the value is not rectangle-sized, @ref OFOutOfRangeException is thrown.
*/
@property (readonly, nonatomic) of_rectangle_t rectangleValue;
/**
* @brief Creates a new, autorelease OFValue with the specified bytes of the
* specified type.
*
* @param bytes The bytes containing the value
* @param objCType The ObjC type encoding for the value
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithBytes: (const void *)bytes
objCType: (const char *)objCType;
/**
* @brief Creates a new, autoreleased OFValue containing the specified pointer.
*
* Only the raw value of the pointer is stored and no data will be copied.
*
* @param pointer The pointer the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithPointer: (const void *)pointer;
/**
* @brief Creates a new, autoreleased OFValue containing the specified
* non-retained object.
*
* The object is not retained, which makes this useful for storing objects in
* collections without retaining them.
*
* @param object The object the OFValue should contain without retaining it
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithNonretainedObject: (id)object;
/**
* @brief Creates a new, autoreleased OFValue containing the specified range.
*
* @param range The range the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithRange: (of_range_t)range;
/**
* @brief Creates a new, autoreleased OFValue containing the specified point.
*
* @param point The point the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithPoint: (of_point_t)point;
/**
* @brief Creates a new, autoreleased OFValue containing the specified
* dimension.
*
* @param dimension The dimension the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithDimension: (of_dimension_t)dimension;
/**
* @brief Creates a new, autoreleased OFValue containing the specified
* rectangle.
*
* @param rectangle The rectangle the OFValue should contain
* @return A new, autoreleased OFValue
*/
+ (instancetype)valueWithRectangle: (of_rectangle_t)rectangle;
/**
* @brief Initializes an already allocated OFValue with the specified bytes of
* the specified type.
*
* @param bytes The bytes containing the value
* @param objCType The ObjC type encoding for the value
* @return An initialized OFValue
*/
- (instancetype)initWithBytes: (const void *)bytes
objCType: (const char *)objCType;
/**
* @brief Initializes an already allocated OFValue containing the specified
* pointer.
*
* Only the raw value of the pointer is stored and no data will be copied.
*
* @param pointer The pointer the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithPointer: (const void *)pointer;
/**
* @brief Initializes an already allocated OFValue containing the specified
* non-retained object.
*
* The object is not retained, which makes this useful for storing objects in
* collections without retaining them.
*
* @param object The object the OFValue should contain without retaining it
* @return An initialized OFValue
*/
- (instancetype)initWithNonretainedObject: (id)object;
/**
* @brief Initializes an already allocated OFValue containing the specified
* range.
*
* @param range The range the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithRange: (of_range_t)range;
/**
* @brief Initializes an already allocated OFValue containing the specified
* point.
*
* @param point The point the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithPoint: (of_point_t)point;
/**
* @brief Initializes an already allocated OFValue containing the specified
* dimension.
*
* @param dimension The dimension the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithDimension: (of_dimension_t)dimension;
/**
* @brief Initializes an already allocated OFValue containing the specified
* rectangle.
*
* @param rectangle The rectangle the OFValue should contain
* @return An initialized OFValue
*/
- (instancetype)initWithRectangle: (of_rectangle_t)rectangle;
/**
* @brief Gets the value.
*
* If the specified size does not match, this raises an
* @ref OFOutOfRangeException.
*
* @param value The buffer to copy the value into
* @param size The size of the value
|