Merge NS_SWIFT_UI_ACTOR update from main repo (#8)

Co-authored-by: rqueue <[email protected]> Co-authored-by: Andrew Yates <[email protected]> Co-authored-by: rqueue <[email protected]> Co-authored-by: Sylvain Defresne <[email protected]> Co-authored-by: ricky <[email protected]> Co-authored-by: Huy Nguyen <[email protected]> Co-authored-by: David Ha <[email protected]> Co-authored-by: Mussa Charles <[email protected]> Co-authored-by: Garrett Moon <[email protected]> Co-authored-by: Joe Ferrucci <[email protected]> Co-authored-by: Koichiro Ueki <[email protected]> Co-authored-by: Carlos Compean <[email protected]> Co-authored-by: Andy Finnell <[email protected]> Co-authored-by: Gabriel Liévano <[email protected]>
FluidGroup · Feb 25, 2025 · f6aba69 · f6aba69
1 parent dbf101a
commit f6aba69
Show file tree

Hide file tree

Showing 17 changed files with 113 additions and 93 deletions.
diff --git a/Source/ASCellNode.h b/Source/ASCellNode.h
@@ -133,7 +133,7 @@ typedef NS_ENUM(NSUInteger, ASCellNodeVisibilityEvent) {
  * The backing view controller, or @c nil if the node wasn't initialized with backing view controller
  * @note This property must be accessed on the main thread.
  */
-@property (nullable, nonatomic, readonly) UIViewController *viewController;
+@property (nullable, nonatomic, readonly) UIViewController *viewController NS_SWIFT_UI_ACTOR;
 
 
 /**

diff --git a/Source/ASCollectionNode+Beta.h b/Source/ASCollectionNode+Beta.h
@@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN
 /**
  * The elements that are currently displayed. The "UIKit index space". Must be accessed on main thread.
  */
-@property (nonatomic, readonly) ASElementMap *visibleElements;
+@property (nonatomic, readonly) ASElementMap *visibleElements NS_SWIFT_UI_ACTOR;
 
 @property (nullable, readonly) id<ASCollectionLayoutDelegate> layoutDelegate;
 
@@ -62,7 +62,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  *  When isSynchronized == YES, the block is run block immediately (before the method returns).
  */
-- (void)onDidFinishSynchronizing:(void (^)(void))didFinishSynchronizing;
+- (void)onDidFinishSynchronizing:(NS_SWIFT_UI_ACTOR void (^)(void))didFinishSynchronizing;
 
 - (instancetype)initWithFrame:(CGRect)frame collectionViewLayout:(UICollectionViewLayout *)layout layoutFacilitator:(nullable id<ASCollectionViewLayoutFacilitatorProtocol>)layoutFacilitator;
 

diff --git a/Source/ASCollectionNode.h b/Source/ASCollectionNode.h
@@ -231,7 +231,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * This method must be called on the main thread.
  */
-- (void)scrollToItemAtIndexPath:(NSIndexPath *)indexPath atScrollPosition:(UICollectionViewScrollPosition)scrollPosition animated:(BOOL)animated;
+- (void)scrollToItemAtIndexPath:(NSIndexPath *)indexPath atScrollPosition:(UICollectionViewScrollPosition)scrollPosition animated:(BOOL)animated NS_SWIFT_UI_ACTOR;
 
 /**
  * Determines collection node's current scroll direction. Supports 2-axis collection nodes.
@@ -271,7 +271,7 @@ NS_ASSUME_NONNULL_BEGIN
  *                    Boolean parameter that contains the value YES if all of the related animations completed successfully or
  *                    NO if they were interrupted. This parameter may be nil. If supplied, the block is run on the main thread.
  */
-- (void)performBatchAnimated:(BOOL)animated updates:(nullable AS_NOESCAPE void (^)(void))updates completion:(nullable void (^)(BOOL finished))completion;
+- (void)performBatchAnimated:(BOOL)animated updates:(nullable AS_NOESCAPE void (^)(void))updates completion:(nullable NS_SWIFT_UI_ACTOR void (^)(BOOL finished))completion NS_SWIFT_UI_ACTOR;
 
 /**
  *  Perform a batch of updates asynchronously, optionally disabling all animations in the batch. This method must be called from the main thread.
@@ -282,7 +282,7 @@ NS_ASSUME_NONNULL_BEGIN
  *                    Boolean parameter that contains the value YES if all of the related animations completed successfully or
  *                    NO if they were interrupted. This parameter may be nil. If supplied, the block is run on the main thread.
  */
-- (void)performBatchUpdates:(nullable AS_NOESCAPE void (^)(void))updates completion:(nullable void (^)(BOOL finished))completion;
+- (void)performBatchUpdates:(nullable AS_NOESCAPE void (^)(void))updates completion:(nullable void (^)(BOOL finished))completion NS_SWIFT_UI_ACTOR;
 
 /**
  *  Returns YES if the ASCollectionNode is still processing changes from performBatchUpdates:.
@@ -311,7 +311,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  *  Calling -waitUntilAllUpdatesAreProcessed is one way to flush any pending update completion blocks.
  */
-- (void)onDidFinishProcessingUpdates:(void (^)(void))didFinishProcessingUpdates;
+- (void)onDidFinishProcessingUpdates:(NS_SWIFT_UI_ACTOR void (^)(void))didFinishProcessingUpdates;
 
 /**
  *  Blocks execution of the main thread until all section and item updates are committed to the view. This method must be called from the main thread.
@@ -326,7 +326,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)insertSections:(NSIndexSet *)sections;
+- (void)insertSections:(NSIndexSet *)sections NS_SWIFT_UI_ACTOR;
 
 /**
  * Deletes one or more sections.
@@ -336,7 +336,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)deleteSections:(NSIndexSet *)sections;
+- (void)deleteSections:(NSIndexSet *)sections NS_SWIFT_UI_ACTOR;
 
 /**
  * Reloads the specified sections.
@@ -346,7 +346,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)reloadSections:(NSIndexSet *)sections;
+- (void)reloadSections:(NSIndexSet *)sections NS_SWIFT_UI_ACTOR;
 
 /**
  * Moves a section to a new location.
@@ -358,7 +358,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)moveSection:(NSInteger)section toSection:(NSInteger)newSection;
+- (void)moveSection:(NSInteger)section toSection:(NSInteger)newSection NS_SWIFT_UI_ACTOR;
 
 /**
  * Inserts items at the locations identified by an array of index paths.
@@ -368,7 +368,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)insertItemsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths;
+- (void)insertItemsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths NS_SWIFT_UI_ACTOR;
 
 /**
  * Deletes the items specified by an array of index paths.
@@ -378,7 +378,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)deleteItemsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths;
+- (void)deleteItemsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths NS_SWIFT_UI_ACTOR;
 
 /**
  * Reloads the specified items.
@@ -388,7 +388,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)reloadItemsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths;
+- (void)reloadItemsAtIndexPaths:(NSArray<NSIndexPath *> *)indexPaths NS_SWIFT_UI_ACTOR;
 
 /**
  * Moves the item at a specified location to a destination location.
@@ -400,7 +400,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method must be called from the main thread. The data source must be updated to reflect the changes
  * before this method is called.
  */
-- (void)moveItemAtIndexPath:(NSIndexPath *)indexPath toIndexPath:(NSIndexPath *)newIndexPath;
+- (void)moveItemAtIndexPath:(NSIndexPath *)indexPath toIndexPath:(NSIndexPath *)newIndexPath NS_SWIFT_UI_ACTOR;
 
 /**
  * Reload everything from scratch, destroying the working range and all cached nodes.
@@ -409,7 +409,7 @@ NS_ASSUME_NONNULL_BEGIN
  * the main thread.
  * @warning This method is substantially more expensive than UICollectionView's version.
  */
-- (void)reloadDataWithCompletion:(nullable void (^)(void))completion;
+- (void)reloadDataWithCompletion:(nullable NS_SWIFT_UI_ACTOR void (^)(void))completion;
 
 
 /**
@@ -446,7 +446,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @discussion This method must be called from the main thread.
  */
-- (void)selectItemAtIndexPath:(nullable NSIndexPath *)indexPath animated:(BOOL)animated scrollPosition:(UICollectionViewScrollPosition)scrollPosition;
+- (void)selectItemAtIndexPath:(nullable NSIndexPath *)indexPath animated:(BOOL)animated scrollPosition:(UICollectionViewScrollPosition)scrollPosition NS_SWIFT_UI_ACTOR;
 
 /**
  * Deselects the item at the specified index.
@@ -459,7 +459,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @discussion This method must be called from the main thread.
  */
-- (void)deselectItemAtIndexPath:(NSIndexPath *)indexPath animated:(BOOL)animated;
+- (void)deselectItemAtIndexPath:(NSIndexPath *)indexPath animated:(BOOL)animated NS_SWIFT_UI_ACTOR;
 
 #pragma mark - Querying Data
 
@@ -482,7 +482,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @return an array containing the nodes being displayed on screen. This must be called on the main thread.
  */
-@property (nonatomic, readonly) NSArray<__kindof ASCellNode *> *visibleNodes;
+@property (nonatomic, readonly) NSArray<__kindof ASCellNode *> *visibleNodes NS_SWIFT_UI_ACTOR;
 
 /**
  * Retrieves the node for the item at the given index path.
@@ -518,7 +518,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @return an array containing the index paths of all visible items. This must be called on the main thread.
  */
-@property (nonatomic, readonly) NSArray<NSIndexPath *> *indexPathsForVisibleItems;
+@property (nonatomic, readonly) NSArray<NSIndexPath *> *indexPathsForVisibleItems NS_SWIFT_UI_ACTOR;
 
 /**
  * Retrieve the index path of the item at the given point.
@@ -527,7 +527,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @return The indexPath for the item at the given point. This must be called on the main thread.
  */
-- (nullable NSIndexPath *)indexPathForItemAtPoint:(CGPoint)point AS_WARN_UNUSED_RESULT;
+- (nullable NSIndexPath *)indexPathForItemAtPoint:(CGPoint)point AS_WARN_UNUSED_RESULT NS_SWIFT_UI_ACTOR;
 
 /**
  * Retrieve the cell at the given index path.
@@ -536,7 +536,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @return The cell for the given index path. This must be called on the main thread.
  */
-- (nullable UICollectionViewCell *)cellForItemAtIndexPath:(NSIndexPath *)indexPath;
+- (nullable UICollectionViewCell *)cellForItemAtIndexPath:(NSIndexPath *)indexPath NS_SWIFT_UI_ACTOR;
 
 /**
  * Retrieves the context object for the given section, as provided by the data source in
@@ -615,7 +615,7 @@ NS_ASSUME_NONNULL_BEGIN
  *   not implement reuse (it will be called once per item).  Unlike UICollectionView's version,
  *   this method is not called when the item is about to display.
  */
-- (ASCellNode *)collectionNode:(ASCollectionNode *)collectionNode nodeForItemAtIndexPath:(NSIndexPath *)indexPath;
+- (ASCellNode *)collectionNode:(ASCollectionNode *)collectionNode nodeForItemAtIndexPath:(NSIndexPath *)indexPath NS_SWIFT_UI_ACTOR;
 
 /**
  * Asks the data source to provide a node-block to display for the given supplementary element in the collection view.

diff --git a/Source/ASCollectionView.h b/Source/ASCollectionView.h
@@ -79,7 +79,7 @@ NS_ASSUME_NONNULL_BEGIN
  *
  * @return The context object, or @c nil if no context was provided.
  */
-- (nullable id<ASSectionContext>)contextForSection:(NSInteger)section AS_WARN_UNUSED_RESULT;
+- (nullable id<ASSectionContext>)contextForSection:(NSInteger)section AS_WARN_UNUSED_RESULT NS_SWIFT_UI_ACTOR;
 
 @end
 

diff --git a/Source/ASDisplayNode+Convenience.h b/Source/ASDisplayNode+Convenience.h
@@ -21,7 +21,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @warning This property may only be accessed on the main thread. This property may
  *   be @c nil until the node's view is actually hosted in the view hierarchy.
  */
-@property (nonatomic, nullable, readonly) __kindof UIViewController *closestViewController;
+@property (nonatomic, nullable, readonly) __kindof UIViewController *closestViewController NS_SWIFT_UI_ACTOR;
 
 @end
 

diff --git a/Source/ASDisplayNode+InterfaceState.h b/Source/ASDisplayNode+InterfaceState.h
@@ -46,63 +46,63 @@ typedef NS_OPTIONS(unsigned char, ASInterfaceState)
  * @discussion Subclasses may use this to monitor when they become visible, should free cached data, and much more.
  * @see ASInterfaceState
  */
-- (void)interfaceStateDidChange:(ASInterfaceState)newState fromState:(ASInterfaceState)oldState;
+- (void)interfaceStateDidChange:(ASInterfaceState)newState fromState:(ASInterfaceState)oldState NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called whenever the node becomes visible.
  * @discussion Subclasses may use this to monitor when they become visible.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didEnterVisibleState;
+- (void)didEnterVisibleState NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called whenever the node is no longer visible.
  * @discussion Subclasses may use this to monitor when they are no longer visible.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didExitVisibleState;
+- (void)didExitVisibleState NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called whenever the the node has entered the display state.
  * @discussion Subclasses may use this to monitor when a node should be rendering its content.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didEnterDisplayState;
+- (void)didEnterDisplayState NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called whenever the the node has exited the display state.
  * @discussion Subclasses may use this to monitor when a node should no longer be rendering its content.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didExitDisplayState;
+- (void)didExitDisplayState NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called whenever the the node has entered the preload state.
  * @discussion Subclasses may use this to monitor data for a node should be preloaded, either from a local or remote source.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didEnterPreloadState;
+- (void)didEnterPreloadState NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called whenever the the node has exited the preload state.
  * @discussion Subclasses may use this to monitor whether preloading data for a node should be canceled.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didExitPreloadState;
+- (void)didExitPreloadState NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called when the node has completed applying the layout.
  * @discussion Can be used for operations that are performed after layout has completed.
  * @note This method is guaranteed to be called on main.
  */
-- (void)nodeDidLayout;
+- (void)nodeDidLayout NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called when the node loads.
  * @discussion Can be used for operations that are performed after the node's view is available.
  * @note This method is guaranteed to be called on main.
  */
-- (void)nodeDidLoad;
+- (void)nodeDidLoad NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Indicates that the receiver and all subnodes have finished displaying.
@@ -114,7 +114,7 @@ typedef NS_OPTIONS(unsigned char, ASInterfaceState)
  * the progressImage block.
  * @note This method is guaranteed to be called on main.
  */
-- (void)hierarchyDisplayDidFinish;
+- (void)hierarchyDisplayDidFinish NS_SWIFT_UI_ACTOR;
 
 @optional
 /**
@@ -125,7 +125,7 @@ typedef NS_OPTIONS(unsigned char, ASInterfaceState)
  * to attempt to ascend the node tree when handling this, as the root node is locked when this is
  * called.
  */
-- (void)nodeWillCalculateLayout:(ASSizeRange)constrainedSize;
+- (void)nodeWillCalculateLayout:(ASSizeRange)constrainedSize NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called when the node's layer is about to enter the hierarchy.
@@ -134,7 +134,7 @@ typedef NS_OPTIONS(unsigned char, ASInterfaceState)
  * re-parented multiple times, and each time will trigger this call.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didEnterHierarchy;
+- (void)didEnterHierarchy NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called when the node's layer has exited the hierarchy.
@@ -143,6 +143,6 @@ typedef NS_OPTIONS(unsigned char, ASInterfaceState)
  * re-parented multiple times, and each time will trigger this call.
  * @note This method is guaranteed to be called on main.
  */
-- (void)didExitHierarchy;
+- (void)didExitHierarchy NS_SWIFT_UI_ACTOR;
 
 @end
diff --git a/Source/ASDisplayNode+Subclasses.h b/Source/ASDisplayNode+Subclasses.h
@@ -71,7 +71,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This is the best time to add gesture recognizers to the view.
  */
 AS_CATEGORY_IMPLEMENTABLE
-- (void)didLoad ASDISPLAYNODE_REQUIRES_SUPER;
+- (void)didLoad ASDISPLAYNODE_REQUIRES_SUPER NS_SWIFT_UI_ACTOR;
 
 /**
  * An empty method that you can implement in a category to add global
@@ -95,7 +95,7 @@ AS_CATEGORY_IMPLEMENTABLE
  *
  * @discussion Subclasses override this method to layout all subnodes or subviews.
  */
-- (void)layout ASDISPLAYNODE_REQUIRES_SUPER;
+- (void)layout ASDISPLAYNODE_REQUIRES_SUPER NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called on the main thread by the view's -layoutSubviews, after -layout.
@@ -104,7 +104,7 @@ AS_CATEGORY_IMPLEMENTABLE
  * out.
  */
 AS_CATEGORY_IMPLEMENTABLE
-- (void)layoutDidFinish ASDISPLAYNODE_REQUIRES_SUPER;
+- (void)layoutDidFinish ASDISPLAYNODE_REQUIRES_SUPER NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Called on a background thread if !isNodeLoaded - called on the main thread if isNodeLoaded.
@@ -255,7 +255,7 @@ AS_CATEGORY_IMPLEMENTABLE
  *
  * @note Called on the main thread only
  */
-- (nullable id<NSObject>)drawParametersForAsyncLayer:(_ASDisplayLayer *)layer;
+- (nullable id<NSObject>)drawParametersForAsyncLayer:(_ASDisplayLayer *)layer NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Indicates that the receiver is about to display.
@@ -317,7 +317,7 @@ AS_CATEGORY_IMPLEMENTABLE
  * @discussion Called by -recursivelyClearContents. Always called on main thread. Base class implements self.contents = nil, clearing any backing
  * store, for asynchronous regeneration when needed.
  */
-- (void)clearContents ASDISPLAYNODE_REQUIRES_SUPER;
+- (void)clearContents ASDISPLAYNODE_REQUIRES_SUPER NS_SWIFT_UI_ACTOR;
 
 /**
  * @abstract Indicates that the receiver is about to display its subnodes. This method is not called if there are no
-Original file line number
+Diff line change
@@ Expand Up / @@ -79,7 +79,7 @@ NS_ASSUME_NONNULL_BEGIN @@
      *
      * @return The context object, or @c nil if no context was provided.
      */
-    - (nullable id<ASSectionContext>)contextForSection:(NSInteger)section AS_WARN_UNUSED_RESULT;
+    - (nullable id<ASSectionContext>)contextForSection:(NSInteger)section AS_WARN_UNUSED_RESULT NS_SWIFT_UI_ACTOR;
     @end
@@ Expand Down @@