mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-23 01:08:27 +00:00
039e77e359
Summary: This would help us understands what was the diff result from the algorithm and compare it with the `updates` to check what went wrong. Essentially, this would make our debugging easier going forward. Reviewed By: calimarkus Differential Revision: D12828892 fbshipit-source-id: 6dc52cdba1adb5a841760b51599e2df4c845c364
157 lines
7 KiB
Objective-C
157 lines
7 KiB
Objective-C
/**
|
|
* Copyright (c) 2016-present, Facebook, Inc.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <UIKit/UIKit.h>
|
|
|
|
#import <IGListKit/IGListBatchUpdateData.h>
|
|
|
|
@class IGListAdapterUpdater;
|
|
@class IGListBatchUpdates;
|
|
@class IGListIndexSetResult;
|
|
@protocol IGListDiffable;
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
A protocol that receives events about `IGListAdapterUpdater` operations.
|
|
*/
|
|
NS_SWIFT_NAME(ListAdapterUpdaterDelegate)
|
|
@protocol IGListAdapterUpdaterDelegate <NSObject>
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView performBatchUpdates:completion:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that will perform the batch updates.
|
|
@param fromObjects The items transitioned from in the batch updates, if any.
|
|
@param toObjects The items transitioned to in the batch updates, if any.
|
|
@param listIndexSetResults The diffing result of indices to be inserted/removed/updated/moved/etc.
|
|
*/
|
|
- (void) listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willPerformBatchUpdatesWithCollectionView:(UICollectionView *)collectionView
|
|
fromObjects:(nullable NSArray <id<IGListDiffable>> *)fromObjects
|
|
toObjects:(nullable NSArray <id<IGListDiffable>> *)toObjects
|
|
listIndexSetResult:(nullable IGListIndexSetResult *)listIndexSetResults;
|
|
|
|
/**
|
|
Notifies the delegate that the updater successfully finished `-[UICollectionView performBatchUpdates:completion:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param updates The batch updates that were applied to the collection view.
|
|
@param collectionView The collection view that performed the batch updates.
|
|
|
|
@note This event is called in the completion block of the batch update.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
didPerformBatchUpdates:(IGListBatchUpdateData *)updates
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView insertItemsAtIndexPaths:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be inserted.
|
|
@param collectionView The collection view that will perform the insert.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willInsertIndexPaths:(NSArray<NSIndexPath *> *)indexPaths
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView deleteItemsAtIndexPaths:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be deleted.
|
|
@param collectionView The collection view that will perform the delete.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willDeleteIndexPaths:(NSArray<NSIndexPath *> *)indexPaths
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView moveItemAtIndexPath:toIndexPath:]`
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param fromIndexPath The index path of the item that will be moved.
|
|
@param toIndexPath The index path to move the item to.
|
|
@param collectionView The collection view that will perform the move.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willMoveFromIndexPath:(NSIndexPath *)fromIndexPath
|
|
toIndexPath:(NSIndexPath *)toIndexPath
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView reloadItemsAtIndexPaths:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param indexPaths An array of index paths that will be reloaded.
|
|
@param collectionView The collection view that will perform the reload.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willReloadIndexPaths:(NSArray<NSIndexPath *> *)indexPaths
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView reloadSections:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param sections The sections that will be reloaded
|
|
@param collectionView The collection view that will perform the reload.
|
|
|
|
@note This event is only sent when outside of `-[UICollectionView performBatchUpdates:completion:]`.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
willReloadSections:(NSIndexSet *)sections
|
|
collectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater will call `-[UICollectionView reloadData]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that will be reloaded.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater willReloadDataWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the updater successfully called `-[UICollectionView reloadData]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view that reloaded.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater didReloadDataWithCollectionView:(UICollectionView *)collectionView;
|
|
|
|
/**
|
|
Notifies the delegate that the collection view threw an exception in `-[UICollectionView performBatchUpdates:completion:]`.
|
|
|
|
@param listAdapterUpdater The adapter updater owning the transition.
|
|
@param collectionView The collection view being updated.
|
|
@param exception The exception thrown by the collection view.
|
|
@param fromObjects The items transitioned from in the diff, if any.
|
|
@param toObjects The items transitioned to in the diff, if any.
|
|
@param diffResult The diff result that were computed from `fromObjects` and `toObjects`.
|
|
@param updates The batch updates that were applied to the collection view.
|
|
*/
|
|
- (void)listAdapterUpdater:(IGListAdapterUpdater *)listAdapterUpdater
|
|
collectionView:(UICollectionView *)collectionView
|
|
willCrashWithException:(NSException *)exception
|
|
fromObjects:(nullable NSArray *)fromObjects
|
|
toObjects:(nullable NSArray *)toObjects
|
|
diffResult:(IGListIndexSetResult *)diffResult
|
|
updates:(IGListBatchUpdateData *)updates;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|