objc2-foundation 0.3.2

Bindings to the Foundation framework
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;

use crate::*;

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsvalue?language=objc)
    #[unsafe(super(NSObject))]

    pub struct NSValue;
);

#[cfg(feature = "NSObject")]
extern_conformance!(
    unsafe impl NSCoding for NSValue {}
);

#[cfg(feature = "NSObject")]
extern_conformance!(
    unsafe impl NSCopying for NSValue {}
);

#[cfg(feature = "NSObject")]
unsafe impl CopyingHelper for NSValue {
    type Result = Self;
}

extern_conformance!(
    unsafe impl NSObjectProtocol for NSValue {}
);

#[cfg(feature = "NSObject")]
extern_conformance!(
    unsafe impl NSSecureCoding for NSValue {}
);

impl NSValue {
    extern_methods!(
        /// # Safety
        ///
        /// `value` must be a valid pointer.
        #[unsafe(method(getValue:size:))]
        #[unsafe(method_family = none)]
        pub unsafe fn getValue_size(&self, value: NonNull<c_void>, size: NSUInteger);

        #[unsafe(method(objCType))]
        #[unsafe(method_family = none)]
        pub fn objCType(&self) -> NonNull<c_char>;

        /// # Safety
        ///
        /// - `value` must be a valid pointer.
        /// - `type` must be a valid pointer.
        #[unsafe(method(initWithBytes:objCType:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithBytes_objCType(
            this: Allocated<Self>,
            value: NonNull<c_void>,
            r#type: NonNull<c_char>,
        ) -> Retained<Self>;

        #[cfg(feature = "NSCoder")]
        /// # Safety
        ///
        /// `coder` possibly has further requirements.
        #[unsafe(method(initWithCoder:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCoder(
            this: Allocated<Self>,
            coder: &NSCoder,
        ) -> Option<Retained<Self>>;
    );
}

/// NSValueCreation.
impl NSValue {
    extern_methods!(
        /// # Safety
        ///
        /// - `value` must be a valid pointer.
        /// - `type` must be a valid pointer.
        #[unsafe(method(valueWithBytes:objCType:))]
        #[unsafe(method_family = none)]
        pub unsafe fn valueWithBytes_objCType(
            value: NonNull<c_void>,
            r#type: NonNull<c_char>,
        ) -> Retained<NSValue>;

        /// # Safety
        ///
        /// - `value` must be a valid pointer.
        /// - `type` must be a valid pointer.
        #[unsafe(method(value:withObjCType:))]
        #[unsafe(method_family = none)]
        pub unsafe fn value_withObjCType(
            value: NonNull<c_void>,
            r#type: NonNull<c_char>,
        ) -> Retained<NSValue>;
    );
}

/// NSValueExtensionMethods.
impl NSValue {
    extern_methods!(
        /// # Safety
        ///
        /// `an_object` should be of the correct type.
        #[unsafe(method(valueWithNonretainedObject:))]
        #[unsafe(method_family = none)]
        pub unsafe fn valueWithNonretainedObject(
            an_object: Option<&AnyObject>,
        ) -> Retained<NSValue>;

        #[unsafe(method(nonretainedObjectValue))]
        #[unsafe(method_family = none)]
        pub unsafe fn nonretainedObjectValue(&self) -> Option<Retained<AnyObject>>;

        /// # Safety
        ///
        /// `pointer` must be a valid pointer or null.
        #[unsafe(method(valueWithPointer:))]
        #[unsafe(method_family = none)]
        pub unsafe fn valueWithPointer(pointer: *const c_void) -> Retained<NSValue>;

        #[unsafe(method(pointerValue))]
        #[unsafe(method_family = none)]
        pub unsafe fn pointerValue(&self) -> *mut c_void;

        #[unsafe(method(isEqualToValue:))]
        #[unsafe(method_family = none)]
        pub fn isEqualToValue(&self, value: &NSValue) -> bool;
    );
}

extern_class!(
    /// [Apple's documentation](https://developer.apple.com/documentation/foundation/nsnumber?language=objc)
    #[unsafe(super(NSValue, NSObject))]

    pub struct NSNumber;
);

unsafe impl Send for NSNumber {}

unsafe impl Sync for NSNumber {}

#[cfg(feature = "NSObject")]
extern_conformance!(
    unsafe impl NSCoding for NSNumber {}
);

#[cfg(feature = "NSObject")]
extern_conformance!(
    unsafe impl NSCopying for NSNumber {}
);

#[cfg(feature = "NSObject")]
unsafe impl CopyingHelper for NSNumber {
    type Result = Self;
}

extern_conformance!(
    unsafe impl NSObjectProtocol for NSNumber {}
);

#[cfg(feature = "NSObject")]
extern_conformance!(
    unsafe impl NSSecureCoding for NSNumber {}
);

impl NSNumber {
    extern_methods!(
        #[cfg(feature = "NSCoder")]
        /// # Safety
        ///
        /// `coder` possibly has further requirements.
        #[unsafe(method(initWithCoder:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithCoder(
            this: Allocated<Self>,
            coder: &NSCoder,
        ) -> Option<Retained<Self>>;

        #[unsafe(method(initWithChar:))]
        #[unsafe(method_family = init)]
        pub fn initWithChar(this: Allocated<Self>, value: c_char) -> Retained<NSNumber>;

        #[unsafe(method(initWithUnsignedChar:))]
        #[unsafe(method_family = init)]
        pub fn initWithUnsignedChar(this: Allocated<Self>, value: c_uchar) -> Retained<NSNumber>;

        #[unsafe(method(initWithShort:))]
        #[unsafe(method_family = init)]
        pub fn initWithShort(this: Allocated<Self>, value: c_short) -> Retained<NSNumber>;

        #[unsafe(method(initWithUnsignedShort:))]
        #[unsafe(method_family = init)]
        pub fn initWithUnsignedShort(this: Allocated<Self>, value: c_ushort) -> Retained<NSNumber>;

        #[unsafe(method(initWithInt:))]
        #[unsafe(method_family = init)]
        pub fn initWithInt(this: Allocated<Self>, value: c_int) -> Retained<NSNumber>;

        #[unsafe(method(initWithUnsignedInt:))]
        #[unsafe(method_family = init)]
        pub fn initWithUnsignedInt(this: Allocated<Self>, value: c_uint) -> Retained<NSNumber>;

        #[unsafe(method(initWithLong:))]
        #[unsafe(method_family = init)]
        pub fn initWithLong(this: Allocated<Self>, value: c_long) -> Retained<NSNumber>;

        #[unsafe(method(initWithUnsignedLong:))]
        #[unsafe(method_family = init)]
        pub fn initWithUnsignedLong(this: Allocated<Self>, value: c_ulong) -> Retained<NSNumber>;

        #[unsafe(method(initWithLongLong:))]
        #[unsafe(method_family = init)]
        pub fn initWithLongLong(this: Allocated<Self>, value: c_longlong) -> Retained<NSNumber>;

        #[unsafe(method(initWithUnsignedLongLong:))]
        #[unsafe(method_family = init)]
        pub fn initWithUnsignedLongLong(
            this: Allocated<Self>,
            value: c_ulonglong,
        ) -> Retained<NSNumber>;

        #[unsafe(method(initWithFloat:))]
        #[unsafe(method_family = init)]
        pub fn initWithFloat(this: Allocated<Self>, value: c_float) -> Retained<NSNumber>;

        #[unsafe(method(initWithDouble:))]
        #[unsafe(method_family = init)]
        pub fn initWithDouble(this: Allocated<Self>, value: c_double) -> Retained<NSNumber>;

        #[unsafe(method(initWithBool:))]
        #[unsafe(method_family = init)]
        pub fn initWithBool(this: Allocated<Self>, value: bool) -> Retained<NSNumber>;

        #[unsafe(method(initWithInteger:))]
        #[unsafe(method_family = init)]
        pub fn initWithInteger(this: Allocated<Self>, value: NSInteger) -> Retained<NSNumber>;

        #[unsafe(method(initWithUnsignedInteger:))]
        #[unsafe(method_family = init)]
        pub fn initWithUnsignedInteger(
            this: Allocated<Self>,
            value: NSUInteger,
        ) -> Retained<NSNumber>;

        #[unsafe(method(charValue))]
        #[unsafe(method_family = none)]
        pub fn charValue(&self) -> c_char;

        #[unsafe(method(unsignedCharValue))]
        #[unsafe(method_family = none)]
        pub fn unsignedCharValue(&self) -> c_uchar;

        #[unsafe(method(shortValue))]
        #[unsafe(method_family = none)]
        pub fn shortValue(&self) -> c_short;

        #[unsafe(method(unsignedShortValue))]
        #[unsafe(method_family = none)]
        pub fn unsignedShortValue(&self) -> c_ushort;

        #[unsafe(method(intValue))]
        #[unsafe(method_family = none)]
        pub fn intValue(&self) -> c_int;

        #[unsafe(method(unsignedIntValue))]
        #[unsafe(method_family = none)]
        pub fn unsignedIntValue(&self) -> c_uint;

        #[unsafe(method(longValue))]
        #[unsafe(method_family = none)]
        pub fn longValue(&self) -> c_long;

        #[unsafe(method(unsignedLongValue))]
        #[unsafe(method_family = none)]
        pub fn unsignedLongValue(&self) -> c_ulong;

        #[unsafe(method(longLongValue))]
        #[unsafe(method_family = none)]
        pub fn longLongValue(&self) -> c_longlong;

        #[unsafe(method(unsignedLongLongValue))]
        #[unsafe(method_family = none)]
        pub fn unsignedLongLongValue(&self) -> c_ulonglong;

        #[unsafe(method(floatValue))]
        #[unsafe(method_family = none)]
        pub fn floatValue(&self) -> c_float;

        #[unsafe(method(doubleValue))]
        #[unsafe(method_family = none)]
        pub fn doubleValue(&self) -> c_double;

        #[unsafe(method(boolValue))]
        #[unsafe(method_family = none)]
        pub fn boolValue(&self) -> bool;

        #[unsafe(method(integerValue))]
        #[unsafe(method_family = none)]
        pub fn integerValue(&self) -> NSInteger;

        #[unsafe(method(unsignedIntegerValue))]
        #[unsafe(method_family = none)]
        pub fn unsignedIntegerValue(&self) -> NSUInteger;

        #[cfg(feature = "NSString")]
        #[unsafe(method(stringValue))]
        #[unsafe(method_family = none)]
        pub fn stringValue(&self) -> Retained<NSString>;

        #[cfg(feature = "NSObjCRuntime")]
        #[unsafe(method(compare:))]
        #[unsafe(method_family = none)]
        pub fn compare(&self, other_number: &NSNumber) -> NSComparisonResult;

        #[unsafe(method(isEqualToNumber:))]
        #[unsafe(method_family = none)]
        pub fn isEqualToNumber(&self, number: &NSNumber) -> bool;

        #[cfg(feature = "NSString")]
        /// # Safety
        ///
        /// `locale` should be of the correct type.
        #[unsafe(method(descriptionWithLocale:))]
        #[unsafe(method_family = none)]
        pub unsafe fn descriptionWithLocale(
            &self,
            locale: Option<&AnyObject>,
        ) -> Retained<NSString>;
    );
}

/// Methods declared on superclass `NSValue`.
impl NSNumber {
    extern_methods!(
        /// # Safety
        ///
        /// - `value` must be a valid pointer.
        /// - `type` must be a valid pointer.
        #[unsafe(method(initWithBytes:objCType:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithBytes_objCType(
            this: Allocated<Self>,
            value: NonNull<c_void>,
            r#type: NonNull<c_char>,
        ) -> Retained<Self>;
    );
}

/// NSNumberCreation.
impl NSNumber {
    extern_methods!(
        #[unsafe(method(numberWithChar:))]
        #[unsafe(method_family = none)]
        pub fn numberWithChar(value: c_char) -> Retained<NSNumber>;

        #[unsafe(method(numberWithUnsignedChar:))]
        #[unsafe(method_family = none)]
        pub fn numberWithUnsignedChar(value: c_uchar) -> Retained<NSNumber>;

        #[unsafe(method(numberWithShort:))]
        #[unsafe(method_family = none)]
        pub fn numberWithShort(value: c_short) -> Retained<NSNumber>;

        #[unsafe(method(numberWithUnsignedShort:))]
        #[unsafe(method_family = none)]
        pub fn numberWithUnsignedShort(value: c_ushort) -> Retained<NSNumber>;

        #[unsafe(method(numberWithInt:))]
        #[unsafe(method_family = none)]
        pub fn numberWithInt(value: c_int) -> Retained<NSNumber>;

        #[unsafe(method(numberWithUnsignedInt:))]
        #[unsafe(method_family = none)]
        pub fn numberWithUnsignedInt(value: c_uint) -> Retained<NSNumber>;

        #[unsafe(method(numberWithLong:))]
        #[unsafe(method_family = none)]
        pub fn numberWithLong(value: c_long) -> Retained<NSNumber>;

        #[unsafe(method(numberWithUnsignedLong:))]
        #[unsafe(method_family = none)]
        pub fn numberWithUnsignedLong(value: c_ulong) -> Retained<NSNumber>;

        #[unsafe(method(numberWithLongLong:))]
        #[unsafe(method_family = none)]
        pub fn numberWithLongLong(value: c_longlong) -> Retained<NSNumber>;

        #[unsafe(method(numberWithUnsignedLongLong:))]
        #[unsafe(method_family = none)]
        pub fn numberWithUnsignedLongLong(value: c_ulonglong) -> Retained<NSNumber>;

        #[unsafe(method(numberWithFloat:))]
        #[unsafe(method_family = none)]
        pub fn numberWithFloat(value: c_float) -> Retained<NSNumber>;

        #[unsafe(method(numberWithDouble:))]
        #[unsafe(method_family = none)]
        pub fn numberWithDouble(value: c_double) -> Retained<NSNumber>;

        #[unsafe(method(numberWithBool:))]
        #[unsafe(method_family = none)]
        pub fn numberWithBool(value: bool) -> Retained<NSNumber>;

        #[unsafe(method(numberWithInteger:))]
        #[unsafe(method_family = none)]
        pub fn numberWithInteger(value: NSInteger) -> Retained<NSNumber>;

        #[unsafe(method(numberWithUnsignedInteger:))]
        #[unsafe(method_family = none)]
        pub fn numberWithUnsignedInteger(value: NSUInteger) -> Retained<NSNumber>;
    );
}

/// NSDeprecated.
impl NSValue {
    extern_methods!(
        /// # Safety
        ///
        /// `value` must be a valid pointer.
        #[deprecated]
        #[unsafe(method(getValue:))]
        #[unsafe(method_family = none)]
        pub unsafe fn getValue(&self, value: NonNull<c_void>);
    );
}