fruity__bbqsrc 0.2.0

Rusty bindings for Apple libraries
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
use super::{CGAffineTransform, CGFloat, CGPoint, CGSize};
use std::mem;

/// The location and dimensions of a rectangle.
///
/// See [documentation](https://developer.apple.com/documentation/coregraphics/CGRect).
#[repr(C)]
#[derive(Copy, Clone, Debug, Default, PartialOrd, PartialEq)]
pub struct CGRect {
    /// The coordinates of the rectangle's origin.
    pub origin: CGPoint,
    /// The height and width of the rectangle.
    pub size: CGSize,
}

/// Rectangle construction.
impl CGRect {
    /// A rectangle with zero origin and size.
    #[doc(alias = "CGRectZero")]
    pub const ZERO: Self = Self::from_parts(CGPoint::ZERO, CGSize::ZERO);

    /// The null rectangle, representing an invalid value.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/cgrectnull).
    #[doc(alias = "CGRectNull")]
    pub const NULL: Self = Self::from_parts(
        CGPoint::new(CGFloat::INFINITY, CGFloat::INFINITY),
        CGSize::ZERO,
    );

    /// A rectangle that has infinite extent.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/cgrectinfinite).
    #[doc(alias = "CGRectInfinite")]
    pub const INFINITE: Self = {
        let max = CGFloat::MAX;
        let min = CGFloat::MIN / 2.0;

        Self::new(min, min, max, max)
    };

    /// Returns a rectangle with the given components.
    ///
    /// This is equivalent to
    /// [`CGRectMake`](https://developer.apple.com/documentation/coregraphics/1455245-cgrectmake).
    #[inline]
    #[doc(alias = "CGRectMake")]
    pub const fn new(x: CGFloat, y: CGFloat, width: CGFloat, height: CGFloat) -> Self {
        Self::from_parts(CGPoint::new(x, y), CGSize::new(width, height))
    }

    /// Returns a rectangle with the given components losslessly converted to
    /// [`CGFloat`]s.
    #[inline]
    pub const fn from_i16s(x: i16, y: i16, width: i16, height: i16) -> Self {
        Self::new(x as _, y as _, width as _, height as _)
    }

    /// Returns a rectangle with the specified parts.
    #[inline]
    pub const fn from_parts(origin: CGPoint, size: CGSize) -> Self {
        Self { origin, size }
    }
}

/// Get and set rectangle properties.
impl CGRect {
    /// Returns the x-coordinate of `self`.
    #[inline]
    pub const fn x(&self) -> CGFloat {
        self.origin.x
    }

    /// Returns the y-coordinate of `self`.
    #[inline]
    pub const fn y(&self) -> CGFloat {
        self.origin.y
    }

    /// Returns the width of `self`.
    #[inline]
    pub const fn width(&self) -> CGFloat {
        self.size.width
    }

    /// Returns the height of `self`.
    #[inline]
    pub const fn height(&self) -> CGFloat {
        self.size.height
    }

    /// Returns `self` with an updated x-coordinate.
    #[inline]
    #[must_use]
    pub const fn with_x(mut self, x: CGFloat) -> Self {
        self.origin.x = x;
        self
    }

    /// Returns `self` with an updated y-coordinate.
    #[inline]
    #[must_use]
    pub const fn with_y(mut self, y: CGFloat) -> Self {
        self.origin.y = y;
        self
    }

    /// Returns `self` with an updated width.
    #[inline]
    #[must_use]
    pub const fn with_width(mut self, width: CGFloat) -> Self {
        self.size.width = width;
        self
    }

    /// Returns `self` with an updated height.
    #[inline]
    #[must_use]
    pub const fn with_height(mut self, height: CGFloat) -> Self {
        self.size.height = height;
        self
    }

    /// Updates the x-coordinate of `self` in-place.
    #[inline]
    pub fn set_x(&mut self, x: CGFloat) -> &mut Self {
        self.origin.x = x;
        self
    }

    /// Updates the y-coordinate of `self` in-place.
    #[inline]
    pub fn set_y(&mut self, y: CGFloat) -> &mut Self {
        self.origin.y = y;
        self
    }

    /// Updates the width of `self` in-place.
    #[inline]
    pub fn set_width(&mut self, width: CGFloat) -> &mut Self {
        self.size.width = width;
        self
    }

    /// Updates the height of `self` in-place.
    #[inline]
    pub fn set_height(&mut self, height: CGFloat) -> &mut Self {
        self.size.height = height;
        self
    }
}

/// Get rectangle bounds.
impl CGRect {
    /// Returns the smallest value for the x-coordinate of `self`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1455948-cgrectgetminx).
    #[inline]
    #[doc(alias = "CGRectGetMinX")]
    pub fn min_x(&self) -> CGFloat {
        extern "C" {
            fn CGRectGetMinX(rect: CGRect) -> CGFloat;
        }
        unsafe { CGRectGetMinX(*self) }
    }

    /// Returns the smallest value for the y-coordinate of `self`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454832-cgrectgetminy).
    #[inline]
    #[doc(alias = "CGRectGetMinY")]
    pub fn min_y(&self) -> CGFloat {
        extern "C" {
            fn CGRectGetMinY(rect: CGRect) -> CGFloat;
        }
        unsafe { CGRectGetMinY(*self) }
    }

    /// Returns the center value for the x-coordinate of `self`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1456175-cgrectgetmidx).
    #[inline]
    #[doc(alias = "CGRectGetMidX")]
    pub fn mid_x(&self) -> CGFloat {
        extern "C" {
            fn CGRectGetMidX(rect: CGRect) -> CGFloat;
        }
        unsafe { CGRectGetMidX(*self) }
    }

    /// Returns the center value for the y-coordinate of `self`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1456550-cgrectgetmidy).
    #[inline]
    #[doc(alias = "CGRectGetMidY")]
    pub fn mid_y(&self) -> CGFloat {
        extern "C" {
            fn CGRectGetMidY(rect: CGRect) -> CGFloat;
        }
        unsafe { CGRectGetMidY(*self) }
    }

    /// Returns the largest value for the x-coordinate of `self`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454334-cgrectgetmaxx).
    #[inline]
    #[doc(alias = "CGRectGetMaxX")]
    pub fn max_x(&self) -> CGFloat {
        extern "C" {
            fn CGRectGetMaxX(rect: CGRect) -> CGFloat;
        }
        unsafe { CGRectGetMaxX(*self) }
    }

    /// Returns the largest value for the y-coordinate of `self`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454060-cgrectgetmaxy).
    #[inline]
    #[doc(alias = "CGRectGetMaxY")]
    pub fn max_y(&self) -> CGFloat {
        extern "C" {
            fn CGRectGetMaxY(rect: CGRect) -> CGFloat;
        }
        unsafe { CGRectGetMaxY(*self) }
    }
}

impl CGRect {
    /// Returns `true` if `self` has zero width or height, or is a null
    /// rectangle.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454917-cgrectisempty).
    #[inline]
    #[doc(alias = "CGRectIsEmpty")]
    pub fn is_empty(&self) -> bool {
        extern "C" {
            fn CGRectIsEmpty(rect: CGRect) -> u8;
        }
        unsafe { CGRectIsEmpty(*self) != 0 }
    }

    /// Returns `true` if `self` is a null rectangle.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1455471-cgrectisnull).
    #[inline]
    #[doc(alias = "CGRectIsNull")]
    pub fn is_null(&self) -> bool {
        extern "C" {
            fn CGRectIsNull(rect: CGRect) -> u8;
        }
        unsafe { CGRectIsNull(*self) != 0 }
    }

    /// Returns `true` if `self` is infinite.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1455008-cgrectisinfinite).
    #[inline]
    #[doc(alias = "CGRectIsInfinite")]
    pub fn is_infinite(&self) -> bool {
        extern "C" {
            fn CGRectIsInfinite(rect: CGRect) -> u8;
        }
        unsafe { CGRectIsInfinite(*self) != 0 }
    }

    /// Returns `true` if `self` contains `point`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1456316-cgrectcontainspoint).
    #[inline]
    #[doc(alias = "CGRectContainsPoint")]
    pub fn contains_point(&self, point: CGPoint) -> bool {
        extern "C" {
            fn CGRectContainsPoint(rect: CGRect, point: CGPoint) -> u8;
        }
        unsafe { CGRectContainsPoint(*self, point) != 0 }
    }

    /// Returns `true` if `self` contains `other`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454186-cgrectcontainsrect).
    #[inline]
    #[doc(alias = "CGRectContainsRect")]
    pub fn contains_rect(&self, other: &Self) -> bool {
        extern "C" {
            fn CGRectContainsRect(r1: CGRect, r2: CGRect) -> u8;
        }
        unsafe { CGRectContainsRect(*self, *other) != 0 }
    }

    /// Returns `true` if `self` intersects `other`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454747-cgrectintersectsrect).
    #[inline]
    #[doc(alias = "CGRectIntersectsRect")]
    pub fn intersects(&self, other: &Self) -> bool {
        extern "C" {
            fn CGRectIntersectsRect(r1: CGRect, r2: CGRect) -> u8;
        }
        unsafe { CGRectIntersectsRect(*self, *other) != 0 }
    }

    /// Returns `self` with a positive width and height.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1456432-cgrectstandardize).
    #[inline]
    #[doc(alias = "CGRectStandardize")]
    pub fn standardize(self) -> Self {
        extern "C" {
            fn CGRectStandardize(rect: CGRect) -> CGRect;
        }
        unsafe { CGRectStandardize(self) }
    }

    /// Returns the smallest rectangle that results from converting the values
    /// of `self` to integers.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1456348-cgrectintegral).
    #[inline]
    #[doc(alias = "CGRectIntegral")]
    pub fn integral(self) -> Self {
        extern "C" {
            fn CGRectIntegral(rect: CGRect) -> CGRect;
        }
        unsafe { CGRectIntegral(self) }
    }

    /// Returns the result of applying an affine transformation to `self`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1455875-cgrectapplyaffinetransform).
    #[inline]
    #[doc(alias = "CGRectApplyAffineTransform")]
    pub fn apply(self, transform: CGAffineTransform) -> Self {
        extern "C" {
            fn CGRectApplyAffineTransform(rect: CGRect, transform: CGAffineTransform) -> CGRect;
        }
        unsafe { CGRectApplyAffineTransform(self, transform) }
    }

    /// Returns `self` with its origin offset.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454841-cgrectoffset).
    #[inline]
    #[doc(alias = "CGRectOffset")]
    pub fn offset(self, dx: CGFloat, dy: CGFloat) -> Self {
        extern "C" {
            fn CGRectOffset(rect: CGRect, dx: CGFloat, dy: CGFloat) -> CGRect;
        }
        unsafe { CGRectOffset(self, dx, dy) }
    }

    /// Returns a rectangle that is smaller or larger than `self`, with the same
    /// center point.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1454218-cgrectinset).
    #[inline]
    #[doc(alias = "CGRectInset")]
    pub fn inset(self, dx: CGFloat, dy: CGFloat) -> Self {
        extern "C" {
            fn CGRectInset(rect: CGRect, dx: CGFloat, dy: CGFloat) -> CGRect;
        }
        unsafe { CGRectInset(self, dx, dy) }
    }

    /// Returns two rectangles by dividing `self`.
    ///
    /// Together `edge` and `amount` define a line (parallel to the specified
    /// edge of the rectangle and at the specified distance from that edge) that
    /// divides the rectangle into two component rectangles.
    ///
    /// The returned tuple consists of:
    ///
    /// - `slice`: The component rectangle nearest the edge of the original
    ///   rectangle specified by `edge`, with width equal to `amount`.
    ///
    /// - `remainder`: The component rectangle equal to the remaining area of
    ///   the original rectangle not included in the `slice` rectangle.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1455925-cgrectdivide).
    #[inline]
    #[doc(alias = "CGRectDivide")]
    pub fn divide(self, amount: CGFloat, edge: CGRectEdge) -> (Self, Self) {
        extern "C" {
            fn CGRectDivide(
                rect: CGRect,
                slice: *mut CGRect,
                remainder: *mut CGRect,
                amount: CGFloat,
                edge: CGRectEdge,
            );
        }

        let mut slice = mem::MaybeUninit::uninit();
        let mut remainder = mem::MaybeUninit::uninit();

        unsafe {
            CGRectDivide(
                self,
                slice.as_mut_ptr(),
                remainder.as_mut_ptr(),
                amount,
                edge,
            );
            (slice.assume_init(), remainder.assume_init())
        }
    }

    /// Returns the smallest rectangle that contains `self` and `other`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1455837-cgrectunion).
    #[inline]
    #[doc(alias = "CGRectUnion")]
    pub fn union(self, other: Self) -> Self {
        extern "C" {
            fn CGRectUnion(r1: CGRect, r2: CGRect) -> CGRect;
        }
        unsafe { CGRectUnion(self, other) }
    }

    /// Returns the intersection of `self` and `other`.
    ///
    /// See [documentation](https://developer.apple.com/documentation/coregraphics/1455346-cgrectintersection).
    #[inline]
    #[doc(alias = "CGRectIntersection")]
    pub fn intersection(self, other: Self) -> Self {
        extern "C" {
            fn CGRectIntersection(r1: CGRect, r2: CGRect) -> CGRect;
        }
        unsafe { CGRectIntersection(self, other) }
    }
}

/// Coordinates that establish the edges of a rectangle.
///
/// See [documentation](https://developer.apple.com/documentation/coregraphics/cgrectedge).
#[repr(u32)]
#[derive(Copy, Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub enum CGRectEdge {
    /// The minimum value for the x-coordinate of the rectangle.
    ///
    /// In macOS and iOS with the default coordinate system this is the left
    /// edge of the rectangle.
    MinX,

    /// The minimum value for the y-coordinate of the rectangle.
    ///
    /// In macOS with the default coordinate system this is the bottom edge of
    /// the rectangle. In iOS with the default coordinate system this is the top
    /// edge of the rectangle.
    MinY,

    /// The maximum value for the x-coordinate of the rectangle.
    ///
    /// In macOS and iOS with the default coordinate system this is the right
    /// edge of the rectangle.
    MaxX,

    /// The maximum value for the y-coordinate of the rectangle.
    ///
    /// In macOS with the default coordinate system this is the top edge of the
    /// rectangle. In iOS with the default coordinate system this is the bottom
    /// edge of the rectangle.
    MaxY,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn zero() {
        let expected = unsafe {
            extern "C" {
                static CGRectZero: CGRect;
            }
            CGRectZero
        };
        assert_eq!(CGRect::ZERO, expected);
    }

    #[test]
    fn null() {
        let expected = unsafe {
            extern "C" {
                static CGRectNull: CGRect;
            }
            CGRectNull
        };
        assert_eq!(CGRect::NULL, expected);
    }

    #[test]
    fn infinite() {
        let expected = unsafe {
            extern "C" {
                static CGRectInfinite: CGRect;
            }
            CGRectInfinite
        };
        assert_eq!(CGRect::INFINITE, expected);
    }
}