Mark protocols with MainActor so they can be applied to UIKit types a…

…nd adjust all call sites to match
square · May 29, 2024 · da34c78 · da34c78
1 parent 0205655
commit da34c78
Show file tree

Hide file tree

Showing 17 changed files with 113 additions and 33 deletions.
diff --git a/Example/ParalayoutSnapshotTests/ViewAlignmentSnapshotTests.swift b/Example/ParalayoutSnapshotTests/ViewAlignmentSnapshotTests.swift
@@ -19,6 +19,7 @@ import SnapshotTesting
 
 final class ViewAlignmentSnapshotTests: SnapshotTestCase {
 
+    @MainActor
     func testSiblingAlignment() {
         let containerView = UIView(frame: .init(x: 0, y: 0, width: 200, height: 200))
         containerView.backgroundColor = .white
@@ -31,6 +32,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         secondSubview.backgroundColor = .red
         containerView.addSubview(secondSubview)
 
+        @MainActor
         func verifySnapshot(
             receiverPosition: Position,
             targetPosition: Position,
@@ -80,6 +82,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         verifySnapshot(receiverPosition: .center, targetPosition: .topRight, verticalOffset: -15)
     }
 
+    @MainActor
     func testLayoutDirection() {
         let containerView = UIView(frame: .init(x: 0, y: 0, width: 100, height: 100))
         containerView.backgroundColor = .white
@@ -140,6 +143,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         assertSnapshot(matching: containerView, as: .image, named: nameForSnapshot(with: []))
     }
 
+    @MainActor
     func testTransformHasNoEffect() {
         let containerView = UIView(frame: .init(x: 0, y: 0, width: 100, height: 100))
         containerView.backgroundColor = .white
@@ -152,6 +156,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         secondSubview.backgroundColor = .red
         containerView.addSubview(secondSubview)
 
+        @MainActor
         func verifySnapshot(
             receiverTransform: CGAffineTransform,
             targetTransform: CGAffineTransform,
@@ -185,6 +190,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         verifySnapshot(receiverTransform: .identity, targetTransform: .init(scaleX: 2, y: 3))
     }
 
+    @MainActor
     func testNonZeroBoundsOrigin() {
         let containerView = UIView(frame: CGRect(x: 0, y: 0, width: 200, height: 200))
         containerView.backgroundColor = .white
@@ -213,6 +219,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         assertSnapshot(matching: containerView, as: .image, named: nameForSnapshot(with: []))
     }
 
+    @MainActor
     func testAlignmentWithLayoutMargins() {
         let containerView = UIView(frame: CGRect(x: 0, y: 0, width: 200, height: 200))
         containerView.backgroundColor = .white
@@ -246,6 +253,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         assertSnapshot(matching: containerView, as: .image, named: nameForSnapshot(with: ["bothLayoutMargins"]))
     }
 
+    @MainActor
     func testAlignmentUsingCapInsets() {
         let containerView = UIView(frame: CGRect(x: 0, y: 0, width: 250, height: 100))
         containerView.backgroundColor = .white
@@ -269,6 +277,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         assertSnapshot(matching: containerView, as: .image, named: nameForSnapshot(with: []))
     }
 
+    @MainActor
     func testAlignmentUsingFirstLine() {
         let containerView = UIView(frame: CGRect(x: 0, y: 0, width: 250, height: 100))
         containerView.backgroundColor = .white
@@ -299,6 +308,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         assertSnapshot(matching: containerView, as: .image, named: nameForSnapshot(with: []))
     }
 
+    @MainActor
     func testAlignmentUsingFirstLineCapInsets() {
         let containerView = UIView(frame: CGRect(x: 0, y: 0, width: 250, height: 100))
         containerView.backgroundColor = .white
@@ -329,6 +339,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         assertSnapshot(matching: containerView, as: .image, named: nameForSnapshot(with: []))
     }
 
+    @MainActor
     func testAlignmentWithRect() {
         let containerView = UIView(frame: CGRect(x: 0, y: 0, width: 200, height: 200))
         containerView.backgroundColor = .white
@@ -365,6 +376,7 @@ final class ViewAlignmentSnapshotTests: SnapshotTestCase {
         assertSnapshot(matching: containerView, as: .image, named: nameForSnapshot(with: []))
     }
 
+    @MainActor
     func testAlignmentWithFrame() {
         let targetTransform = CGAffineTransform(translationX: -20, y: 10)
         let receiverTransform = CGAffineTransform(scaleX: 0.8, y: 0.8)

diff --git a/Paralayout/Alignable.swift b/Paralayout/Alignable.swift
@@ -19,10 +19,12 @@ import UIKit
 /// Describes an object that can participate in alignment. In practice, this represents a view.
 public protocol Alignable {
 
+    @MainActor
     var alignmentContext: AlignmentContext { get }
 
 }
 
+@MainActor
 public struct AlignmentContext {
 
     // MARK: - Life Cycle
@@ -47,6 +49,7 @@ public struct AlignmentContext {
 
 extension UIView: Alignable {
 
+    @MainActor
     public var alignmentContext: AlignmentContext {
         return AlignmentContext(view: self, alignmentBounds: bounds)
     }
@@ -168,6 +171,7 @@ public struct FrameAlignmentProxy: Alignable {
 
     // MARK: - Private Methods
 
+    @MainActor
     private func withViewInSuperview<T>(view: UIView, perform: (_ superview: UIView) -> T) -> T {
         if let superview = view.superview {
             return perform(superview)

diff --git a/Paralayout/AspectRatio.swift b/Paralayout/AspectRatio.swift
@@ -105,15 +105,15 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     ///
     /// - parameter width: The desired width.
     /// - parameter scaleFactor: The view/window/screen to use for pixel rounding.
-    public func height(forWidth width: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGFloat {
+    @MainActor public func height(forWidth width: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGFloat {
         return (ratioHeight * width / ratioWidth).roundedToPixel(in: scaleFactor)
     }
 
     /// Returns the width of the aspect ratio for a given `height` rounded to the nearest pixel.
     ///
     /// - parameter height: The desired height.
     /// - parameter scaleFactor: The view/window/screen to use for pixel rounding.
-    public func width(forHeight height: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGFloat {
+    @MainActor public func width(forHeight height: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGFloat {
         return (ratioWidth * height / ratioHeight).roundedToPixel(in: scaleFactor)
     }
 
@@ -122,7 +122,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     ///
     /// - parameter width: The desired width.
     /// - parameter scaleFactor: The view/window/screen to use for pixel rounding.
-    public func size(forWidth width: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGSize {
+    @MainActor public func size(forWidth width: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGSize {
         return CGSize(
             width: width,
             height: height(forWidth: width, in: scaleFactor)
@@ -134,7 +134,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     ///
     /// - parameter height: The desired height.
     /// - parameter scaleFactor: The view/window/screen to use for pixel rounding.
-    public func size(forHeight height: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGSize {
+    @MainActor public func size(forHeight height: CGFloat, in scaleFactor: ScaleFactorProviding) -> CGSize {
         return CGSize(
             width: width(forHeight: height, in: scaleFactor),
             height: height
@@ -147,7 +147,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     /// - parameter size: The bounding size.
     /// - parameter scaleFactor: The view/window/screen to use for pixel alignment.
     /// - returns: A size with the receiver's aspect ratio, no larger than the bounding size.
-    public func size(toFit size: CGSize, in scaleFactor: ScaleFactorProviding) -> CGSize {
+    @MainActor public func size(toFit size: CGSize, in scaleFactor: ScaleFactorProviding) -> CGSize {
         if size.aspectRatio <= self {
             // Match width, narrow the height.
             let fitHeight = min(size.height, height(forWidth: size.width, in: scaleFactor))
@@ -169,7 +169,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     /// - parameter scaleFactor: The view/window/screen to use for pixel alignment.
     /// - parameter layoutDirection: The effective layout direction of the view in which the `rect` is defined.
     /// - returns: A rect with the receiver's aspect ratio, strictly within the bounding rect.
-    public func rect(
+    @MainActor public func rect(
         toFit rect: CGRect,
         at position: Position,
         in scaleFactor: ScaleFactorProviding,
@@ -193,7 +193,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     /// - parameter context: The view/window/screen that provides the scale factor and effective layout direction in
     /// which the rect should be positioned.
     /// - returns: A rect with the receiver's aspect ratio, strictly within the bounding rect.
-    public func rect(
+    @MainActor public func rect(
         toFit rect: CGRect,
         at position: Position,
         in context: (ScaleFactorProviding & LayoutDirectionProviding)
@@ -212,7 +212,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     /// - parameter size: The bounding size.
     /// - parameter scaleFactor: The view/window/screen to use for pixel alignment.
     /// - returns: A size with the receiver's aspect ratio, at least as large as the bounding size.
-    public func size(toFill size: CGSize, in scaleFactor: ScaleFactorProviding) -> CGSize {
+    @MainActor public func size(toFill size: CGSize, in scaleFactor: ScaleFactorProviding) -> CGSize {
         if size.aspectRatio <= self {
             // Match height, expand the width.
             let fillWidth = width(forHeight: size.height, in: scaleFactor)
@@ -234,7 +234,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     /// - parameter scaleFactor: The view/window/screen to use for pixel alignment.
     /// - parameter layoutDirection: The effective layout direction of the view in which the `rect` is defined.
     /// - returns: A rect with the receiver's aspect ratio, strictly containing the bounding rect.
-    public func rect(
+    @MainActor public func rect(
         toFill rect: CGRect,
         at position: Position,
         in scaleFactor: ScaleFactorProviding,
@@ -257,7 +257,7 @@ public struct AspectRatio: Comparable, CustomDebugStringConvertible, Sendable {
     /// - parameter context: The view/window/screen that provides the scale factor and effective layout direction in
     /// which the rect should be positioned.
     /// - returns: A rect with the receiver's aspect ratio, strictly containing the bounding rect.
-    public func rect(
+    @MainActor public func rect(
         toFill rect: CGRect,
         at position: Position,
         in context: (ScaleFactorProviding & LayoutDirectionProviding)
@@ -294,6 +294,7 @@ extension CGRect {
 
     // MARK: - Life Cycle
 
+    @MainActor
     fileprivate init(
         size newSize: CGSize,
         at position: Position,

diff --git a/Paralayout/LayoutDirection.swift b/Paralayout/LayoutDirection.swift
@@ -19,6 +19,7 @@ import UIKit
 /// Defines an object that vends its current user interface layout direction.
 public protocol LayoutDirectionProviding {
 
+    @MainActor
     var effectiveUserInterfaceLayoutDirection: UIUserInterfaceLayoutDirection { get }
 
 }

diff --git a/Paralayout/PixelRounding.swift b/Paralayout/PixelRounding.swift
@@ -19,6 +19,7 @@ import UIKit
 /// The ratio of pixels to points, either of a UIScreen, a UIView's screen, or an explicit value.
 public protocol ScaleFactorProviding {
 
+    @MainActor
     var pixelsPerPoint: CGFloat { get }
 
 }
@@ -76,7 +77,7 @@ extension CGFloat {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func flooredToPixel(in scaleFactor: ScaleFactorProviding) -> CGFloat {
+    @MainActor public func flooredToPixel(in scaleFactor: ScaleFactorProviding) -> CGFloat {
         return adjustedToPixel(scaleFactor) { floor($0) }
     }
 
@@ -85,7 +86,7 @@ extension CGFloat {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func ceiledToPixel(in scaleFactor: ScaleFactorProviding) -> CGFloat {
+    @MainActor public func ceiledToPixel(in scaleFactor: ScaleFactorProviding) -> CGFloat {
         return adjustedToPixel(scaleFactor) { ceil($0) }
     }
 
@@ -94,14 +95,15 @@ extension CGFloat {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func roundedToPixel(in scaleFactor: ScaleFactorProviding) -> CGFloat {
+    @MainActor public func roundedToPixel(in scaleFactor: ScaleFactorProviding) -> CGFloat {
         // Invoke the namespaced Darwin.round() function since round() is ambiguous (it's also a mutating instance
         // method).
         return adjustedToPixel(scaleFactor) { Darwin.round($0) }
     }
 
     // MARK: - Private Methods
 
+    @MainActor
     private func adjustedToPixel(_ scaleFactor: ScaleFactorProviding, _ adjustment: (CGFloat) -> CGFloat) -> CGFloat {
         let scale = scaleFactor.pixelsPerPoint
         return (scale > 0.0) ? (adjustment(self * scale) / scale) : self
@@ -117,7 +119,7 @@ extension CGPoint {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func flooredToPixel(in scaleFactor: ScaleFactorProviding) -> CGPoint {
+    @MainActor public func flooredToPixel(in scaleFactor: ScaleFactorProviding) -> CGPoint {
         return CGPoint(x: x.flooredToPixel(in: scaleFactor), y: y.flooredToPixel(in: scaleFactor))
     }
 
@@ -127,7 +129,7 @@ extension CGPoint {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func ceiledToPixel(in scaleFactor: ScaleFactorProviding) -> CGPoint {
+    @MainActor public func ceiledToPixel(in scaleFactor: ScaleFactorProviding) -> CGPoint {
         return CGPoint(x: x.ceiledToPixel(in: scaleFactor), y: y.ceiledToPixel(in: scaleFactor))
     }
 
@@ -137,7 +139,7 @@ extension CGPoint {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func roundedToPixel(in scaleFactor: ScaleFactorProviding) -> CGPoint {
+    @MainActor public func roundedToPixel(in scaleFactor: ScaleFactorProviding) -> CGPoint {
         return CGPoint(x: x.roundedToPixel(in: scaleFactor), y: y.roundedToPixel(in: scaleFactor))
     }
 
@@ -150,7 +152,7 @@ extension CGSize {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func flooredToPixel(in scaleFactor: ScaleFactorProviding) -> CGSize {
+    @MainActor public func flooredToPixel(in scaleFactor: ScaleFactorProviding) -> CGSize {
         return CGSize(width: width.flooredToPixel(in: scaleFactor), height: height.flooredToPixel(in: scaleFactor))
     }
 
@@ -159,7 +161,7 @@ extension CGSize {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func ceiledToPixel(in scaleFactor: ScaleFactorProviding) -> CGSize {
+    @MainActor public func ceiledToPixel(in scaleFactor: ScaleFactorProviding) -> CGSize {
         return CGSize(width: width.ceiledToPixel(in: scaleFactor), height: height.ceiledToPixel(in: scaleFactor))
     }
 
@@ -168,7 +170,7 @@ extension CGSize {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: The adjusted coordinate.
-    public func roundedToPixel(in scaleFactor: ScaleFactorProviding) -> CGSize {
+    @MainActor public func roundedToPixel(in scaleFactor: ScaleFactorProviding) -> CGSize {
         return CGSize(width: width.roundedToPixel(in: scaleFactor), height: height.roundedToPixel(in: scaleFactor))
     }
 
@@ -181,7 +183,7 @@ extension CGRect {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: A new rect with pixel-aligned boundaries, enclosing the original rect.
-    public func expandedToPixel(in scaleFactor: ScaleFactorProviding) -> CGRect {
+    @MainActor public func expandedToPixel(in scaleFactor: ScaleFactorProviding) -> CGRect {
         return CGRect(
             left: minX.flooredToPixel(in: scaleFactor),
             top: minY.flooredToPixel(in: scaleFactor),
@@ -195,7 +197,7 @@ extension CGRect {
     /// - parameter scaleFactor: The pixel scale to use, e.g. a UIScreen, UIView, or explicit value (pass `0` to *not*
     /// snap to pixel).
     /// - returns: A new rect with pixel-aligned boundaries, enclosed by the original rect.
-    public func contractedToPixel(in scaleFactor: ScaleFactorProviding) -> CGRect {
+    @MainActor public func contractedToPixel(in scaleFactor: ScaleFactorProviding) -> CGRect {
         return CGRect(
             left: minX.ceiledToPixel(in: scaleFactor),
             top: minY.ceiledToPixel(in: scaleFactor),

diff --git a/Paralayout/UIFont+CapInsets.swift b/Paralayout/UIFont+CapInsets.swift
@@ -61,7 +61,7 @@ extension UIFont {
     /// The space above and below the receiver's capHeight and baseline, as displayed in a UILabel.
     /// - parameter scaleFactor: The UI scale factor for pixel rounding.
     /// - returns: The insets.
-    public func labelCapInsets(in scaleFactor: ScaleFactorProviding) -> LabelCapInsets {
+    @MainActor public func labelCapInsets(in scaleFactor: ScaleFactorProviding) -> LabelCapInsets {
         // One would expect ceil(ascender) - floor(descender) so that the baseline would land on a pixel boundary, but
         // sadly no--this is what `UILabel.sizeToFit()` does.
         let lineHeight = (ascender - descender).ceiledToPixel(in: scaleFactor)

diff --git a/Paralayout/UILabel+Alignment.swift b/Paralayout/UILabel+Alignment.swift
@@ -55,6 +55,7 @@ public struct TextRectLayoutProxy: Alignable {
 
     // MARK: - Alignable
 
+    @MainActor
     public var alignmentContext: AlignmentContext {
         var alignmentBounds = proxiedLabel.textRect(
             forBounds: proxiedLabel.bounds,

diff --git a/Paralayout/UIView+Alignment.swift b/Paralayout/UIView+Alignment.swift
@@ -46,7 +46,7 @@ extension Alignable {
     /// - parameter otherView: The other view for the measurement.
     /// - parameter otherPosition: The position in the `otherView`'s untransformed frame to use for the measurement.
     /// - returns: The offset from the receiver's `position` to the `otherView`'s `otherPosition`.
-    public func untransformedFrameOffset(
+    @MainActor public func untransformedFrameOffset(
         from position: Position,
         to otherView: Alignable,
         _ otherPosition: Position,
@@ -126,7 +126,7 @@ extension Alignable {
     /// calculated. Defaults to `.automatic`, which will align the views in the most common way based on their
     /// relationship in the view hierarchy.
     /// - parameter offset: An additional offset to apply to the alignment, e.g. to leave a space between the two views.
-    public func align(
+    @MainActor public func align(
         _ position: Position,
         with otherView: Alignable,
         _ otherPosition: Position,