mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-22 00:38:42 +00:00
Summary: If an `IGListAdapterUpdater` was unable to retrieve a collection view in `[IGListAdapterUpdater performBatchUpdatesWithCollectionViewBlock:]`, it would return early without cleaning state. This would sometimes cause future updates to crash, as this `IGListAdapterUpdater`'s state would now be out-of-sync. This change also ensures that the `IGListAdapterUpdater`'s completion blocks run when `[IGListAdapterUpdater performBatchUpdatesWithCollectionViewBlock:]` and `[IGListAdapterUpdater performReloadDataWithCollectionViewBlock:]` return early due to having a nil `UICollectionView`. Reviewed By: rnystrom Differential Revision: D8056539 fbshipit-source-id: 1af7b675ec6805c2d8031f32d8a4c8e8929564e6
612 lines
26 KiB
Objective-C
612 lines
26 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 "IGListAdapterUpdater.h"
|
|
#import "IGListAdapterUpdaterInternal.h"
|
|
|
|
#import <IGListKit/IGListAssert.h>
|
|
#import <IGListKit/IGListBatchUpdateData.h>
|
|
#import <IGListKit/IGListDiff.h>
|
|
#import <IGListKit/IGListIndexSetResultInternal.h>
|
|
#import <IGListKit/IGListMoveIndexPathInternal.h>
|
|
|
|
#import "UICollectionView+IGListBatchUpdateData.h"
|
|
#import "IGListReloadIndexPath.h"
|
|
#import "IGListArrayUtilsInternal.h"
|
|
|
|
@implementation IGListAdapterUpdater
|
|
|
|
- (instancetype)init {
|
|
IGAssertMainThread();
|
|
|
|
if (self = [super init]) {
|
|
// the default is to use animations unless NO is passed
|
|
_queuedUpdateIsAnimated = YES;
|
|
_completionBlocks = [NSMutableArray new];
|
|
_batchUpdates = [IGListBatchUpdates new];
|
|
_allowsBackgroundReloading = YES;
|
|
}
|
|
return self;
|
|
}
|
|
|
|
#pragma mark - Private API
|
|
|
|
- (BOOL)hasChanges {
|
|
return self.hasQueuedReloadData
|
|
|| [self.batchUpdates hasChanges]
|
|
|| self.fromObjects != nil
|
|
|| self.toObjectsBlock != nil;
|
|
}
|
|
|
|
- (void)performReloadDataWithCollectionViewBlock:(IGListCollectionViewBlock)collectionViewBlock {
|
|
IGAssertMainThread();
|
|
|
|
id<IGListAdapterUpdaterDelegate> delegate = self.delegate;
|
|
void (^reloadUpdates)(void) = self.reloadUpdates;
|
|
IGListBatchUpdates *batchUpdates = self.batchUpdates;
|
|
NSMutableArray *completionBlocks = [self.completionBlocks mutableCopy];
|
|
|
|
[self cleanStateBeforeUpdates];
|
|
|
|
void (^executeCompletionBlocks)(BOOL) = ^(BOOL finished) {
|
|
for (IGListUpdatingCompletion block in completionBlocks) {
|
|
block(finished);
|
|
}
|
|
|
|
self.state = IGListBatchUpdateStateIdle;
|
|
};
|
|
|
|
// bail early if the collection view has been deallocated in the time since the update was queued
|
|
UICollectionView *collectionView = collectionViewBlock();
|
|
if (collectionView == nil) {
|
|
[self _cleanStateAfterUpdates];
|
|
executeCompletionBlocks(NO);
|
|
return;
|
|
}
|
|
|
|
// item updates must not send mutations to the collection view while we are reloading
|
|
self.state = IGListBatchUpdateStateExecutingBatchUpdateBlock;
|
|
|
|
if (reloadUpdates) {
|
|
reloadUpdates();
|
|
}
|
|
|
|
// execute all stored item update blocks even if we are just calling reloadData. the actual collection view
|
|
// mutations will be discarded, but clients are encouraged to put their actual /data/ mutations inside the
|
|
// update block as well, so if we don't execute the block the changes will never happen
|
|
for (IGListItemUpdateBlock itemUpdateBlock in batchUpdates.itemUpdateBlocks) {
|
|
itemUpdateBlock();
|
|
}
|
|
|
|
// add any completion blocks from item updates. added after item blocks are executed in order to capture any
|
|
// re-entrant updates
|
|
[completionBlocks addObjectsFromArray:batchUpdates.itemCompletionBlocks];
|
|
|
|
self.state = IGListBatchUpdateStateExecutedBatchUpdateBlock;
|
|
|
|
[self _cleanStateAfterUpdates];
|
|
|
|
[delegate listAdapterUpdater:self willReloadDataWithCollectionView:collectionView];
|
|
[collectionView reloadData];
|
|
[collectionView.collectionViewLayout invalidateLayout];
|
|
[collectionView layoutIfNeeded];
|
|
[delegate listAdapterUpdater:self didReloadDataWithCollectionView:collectionView];
|
|
|
|
executeCompletionBlocks(YES);
|
|
}
|
|
|
|
- (void)performBatchUpdatesWithCollectionViewBlock:(IGListCollectionViewBlock)collectionViewBlock {
|
|
IGAssertMainThread();
|
|
IGAssert(self.state == IGListBatchUpdateStateIdle, @"Should not call batch updates when state isn't idle");
|
|
|
|
// create local variables so we can immediately clean our state but pass these items into the batch update block
|
|
id<IGListAdapterUpdaterDelegate> delegate = self.delegate;
|
|
NSArray *fromObjects = [self.fromObjects copy];
|
|
IGListToObjectBlock toObjectsBlock = [self.toObjectsBlock copy];
|
|
NSMutableArray *completionBlocks = [self.completionBlocks mutableCopy];
|
|
void (^objectTransitionBlock)(NSArray *) = [self.objectTransitionBlock copy];
|
|
const BOOL animated = self.queuedUpdateIsAnimated;
|
|
IGListBatchUpdates *batchUpdates = self.batchUpdates;
|
|
|
|
// clean up all state so that new updates can be coalesced while the current update is in flight
|
|
[self cleanStateBeforeUpdates];
|
|
|
|
void (^executeCompletionBlocks)(BOOL) = ^(BOOL finished) {
|
|
self.applyingUpdateData = nil;
|
|
self.state = IGListBatchUpdateStateIdle;
|
|
|
|
for (IGListUpdatingCompletion block in completionBlocks) {
|
|
block(finished);
|
|
}
|
|
};
|
|
|
|
// bail early if the collection view has been deallocated in the time since the update was queued
|
|
UICollectionView *collectionView = collectionViewBlock();
|
|
if (collectionView == nil) {
|
|
[self _cleanStateAfterUpdates];
|
|
executeCompletionBlocks(NO);
|
|
return;
|
|
}
|
|
|
|
NSArray *toObjects = nil;
|
|
if (toObjectsBlock != nil) {
|
|
toObjects = objectsWithDuplicateIdentifiersRemoved(toObjectsBlock());
|
|
}
|
|
#ifdef DEBUG
|
|
for (id obj in toObjects) {
|
|
IGAssert([obj conformsToProtocol:@protocol(IGListDiffable)],
|
|
@"In order to use IGListAdapterUpdater, object %@ must conform to IGListDiffable", obj);
|
|
IGAssert([obj diffIdentifier] != nil,
|
|
@"Cannot have a nil diffIdentifier for object %@", obj);
|
|
}
|
|
#endif
|
|
|
|
void (^executeUpdateBlocks)(void) = ^{
|
|
self.state = IGListBatchUpdateStateExecutingBatchUpdateBlock;
|
|
|
|
// run the update block so that the adapter can set its items. this makes sure that just before the update is
|
|
// committed that the data source is updated to the /latest/ "toObjects". this makes the data source in sync
|
|
// with the items that the updater is transitioning to
|
|
if (objectTransitionBlock != nil) {
|
|
objectTransitionBlock(toObjects);
|
|
}
|
|
|
|
// execute each item update block which should make calls like insert, delete, and reload for index paths
|
|
// we collect all mutations in corresponding sets on self, then filter based on UICollectionView shortcomings
|
|
// call after the objectTransitionBlock so section level mutations happen before any items
|
|
for (IGListItemUpdateBlock itemUpdateBlock in batchUpdates.itemUpdateBlocks) {
|
|
itemUpdateBlock();
|
|
}
|
|
|
|
// add any completion blocks from item updates. added after item blocks are executed in order to capture any
|
|
// re-entrant updates
|
|
[completionBlocks addObjectsFromArray:batchUpdates.itemCompletionBlocks];
|
|
|
|
self.state = IGListBatchUpdateStateExecutedBatchUpdateBlock;
|
|
};
|
|
|
|
void (^reloadDataFallback)(void) = ^{
|
|
executeUpdateBlocks();
|
|
[self _cleanStateAfterUpdates];
|
|
[self _performBatchUpdatesItemBlockApplied];
|
|
[collectionView reloadData];
|
|
[collectionView layoutIfNeeded];
|
|
executeCompletionBlocks(YES);
|
|
};
|
|
|
|
// if the collection view isn't in a visible window, skip diffing and batch updating. execute all transition blocks,
|
|
// reload data, execute completion blocks, and get outta here
|
|
const BOOL iOS83OrLater = (NSFoundationVersionNumber >= NSFoundationVersionNumber_iOS_8_3);
|
|
if (iOS83OrLater && self.allowsBackgroundReloading && collectionView.window == nil) {
|
|
[self _beginPerformBatchUpdatesToObjects:toObjects];
|
|
reloadDataFallback();
|
|
return;
|
|
}
|
|
|
|
// disables multiple performBatchUpdates: from happening at the same time
|
|
[self _beginPerformBatchUpdatesToObjects:toObjects];
|
|
|
|
const IGListExperiment experiments = self.experiments;
|
|
|
|
IGListIndexSetResult *(^performDiff)(void) = ^{
|
|
return IGListDiffExperiment(fromObjects, toObjects, IGListDiffEquality, experiments);
|
|
};
|
|
|
|
// block executed in the first param block of -[UICollectionView performBatchUpdates:completion:]
|
|
void (^batchUpdatesBlock)(IGListIndexSetResult *result) = ^(IGListIndexSetResult *result){
|
|
executeUpdateBlocks();
|
|
|
|
self.applyingUpdateData = [self _flushCollectionView:collectionView
|
|
withDiffResult:result
|
|
batchUpdates:self.batchUpdates
|
|
fromObjects:fromObjects];
|
|
|
|
[self _cleanStateAfterUpdates];
|
|
[self _performBatchUpdatesItemBlockApplied];
|
|
};
|
|
|
|
// block used as the second param of -[UICollectionView performBatchUpdates:completion:]
|
|
void (^batchUpdatesCompletionBlock)(BOOL) = ^(BOOL finished) {
|
|
IGListBatchUpdateData *oldApplyingUpdateData = self.applyingUpdateData;
|
|
executeCompletionBlocks(finished);
|
|
|
|
[delegate listAdapterUpdater:self didPerformBatchUpdates:oldApplyingUpdateData collectionView:collectionView];
|
|
|
|
// queue another update in case something changed during batch updates. this method will bail next runloop if
|
|
// there are no changes
|
|
[self _queueUpdateWithCollectionViewBlock:collectionViewBlock];
|
|
};
|
|
|
|
// block that executes the batch update and exception handling
|
|
void (^performUpdate)(IGListIndexSetResult *) = ^(IGListIndexSetResult *result){
|
|
[collectionView layoutIfNeeded];
|
|
|
|
@try {
|
|
[delegate listAdapterUpdater:self willPerformBatchUpdatesWithCollectionView:collectionView];
|
|
if (result.changeCount > 100 && IGListExperimentEnabled(experiments, IGListExperimentReloadDataFallback)) {
|
|
reloadDataFallback();
|
|
} else if (animated) {
|
|
[collectionView performBatchUpdates:^{
|
|
batchUpdatesBlock(result);
|
|
} completion:batchUpdatesCompletionBlock];
|
|
} else {
|
|
[CATransaction begin];
|
|
[CATransaction setDisableActions:YES];
|
|
[collectionView performBatchUpdates:^{
|
|
batchUpdatesBlock(result);
|
|
} completion:^(BOOL finished) {
|
|
[CATransaction commit];
|
|
batchUpdatesCompletionBlock(finished);
|
|
}];
|
|
}
|
|
} @catch (NSException *exception) {
|
|
[delegate listAdapterUpdater:self
|
|
collectionView:collectionView
|
|
willCrashWithException:exception
|
|
fromObjects:fromObjects
|
|
toObjects:toObjects
|
|
updates:(id)self.applyingUpdateData];
|
|
@throw exception;
|
|
}
|
|
};
|
|
|
|
// temporary test to try out background diffing
|
|
if (IGListExperimentEnabled(experiments, IGListExperimentBackgroundDiffing)) {
|
|
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
|
|
IGListIndexSetResult *result = performDiff();
|
|
dispatch_async(dispatch_get_main_queue(), ^{
|
|
performUpdate(result);
|
|
});
|
|
});
|
|
} else {
|
|
IGListIndexSetResult *result = performDiff();
|
|
performUpdate(result);
|
|
}
|
|
}
|
|
|
|
void convertReloadToDeleteInsert(NSMutableIndexSet *reloads,
|
|
NSMutableIndexSet *deletes,
|
|
NSMutableIndexSet *inserts,
|
|
IGListIndexSetResult *result,
|
|
NSArray<id<IGListDiffable>> *fromObjects) {
|
|
// reloadSections: is unsafe to use within performBatchUpdates:, so instead convert all reloads into deletes+inserts
|
|
const BOOL hasObjects = [fromObjects count] > 0;
|
|
[[reloads copy] enumerateIndexesUsingBlock:^(NSUInteger idx, BOOL *stop) {
|
|
// if a diff was not performed, there are no changes. instead use the same index that was originally queued
|
|
id<NSObject> diffIdentifier = hasObjects ? [fromObjects[idx] diffIdentifier] : nil;
|
|
const NSInteger from = hasObjects ? [result oldIndexForIdentifier:diffIdentifier] : idx;
|
|
const NSInteger to = hasObjects ? [result newIndexForIdentifier:diffIdentifier] : idx;
|
|
[reloads removeIndex:from];
|
|
|
|
// if a reload is queued outside the diff and the object was inserted or deleted it cannot be
|
|
if (from != NSNotFound && to != NSNotFound) {
|
|
[deletes addIndex:from];
|
|
[inserts addIndex:to];
|
|
} else {
|
|
IGAssert([result.deletes containsIndex:idx],
|
|
@"Reloaded section %lu was not found in deletes with from: %li, to: %li, deletes: %@, fromClass: %@",
|
|
(unsigned long)idx, (long)from, (long)to, deletes, [(id)fromObjects[idx] class]);
|
|
}
|
|
}];
|
|
}
|
|
|
|
- (IGListBatchUpdateData *)_flushCollectionView:(UICollectionView *)collectionView
|
|
withDiffResult:(IGListIndexSetResult *)diffResult
|
|
batchUpdates:(IGListBatchUpdates *)batchUpdates
|
|
fromObjects:(NSArray <id<IGListDiffable>> *)fromObjects {
|
|
NSSet *moves = [[NSSet alloc] initWithArray:diffResult.moves];
|
|
|
|
// combine section reloads from the diff and manual reloads via reloadItems:
|
|
NSMutableIndexSet *reloads = [diffResult.updates mutableCopy];
|
|
[reloads addIndexes:batchUpdates.sectionReloads];
|
|
|
|
NSMutableIndexSet *inserts = [diffResult.inserts mutableCopy];
|
|
NSMutableIndexSet *deletes = [diffResult.deletes mutableCopy];
|
|
if (self.movesAsDeletesInserts) {
|
|
for (IGListMoveIndex *move in moves) {
|
|
[deletes addIndex:move.from];
|
|
[inserts addIndex:move.to];
|
|
}
|
|
// clear out all moves
|
|
moves = [NSSet new];
|
|
}
|
|
|
|
// reloadSections: is unsafe to use within performBatchUpdates:, so instead convert all reloads into deletes+inserts
|
|
convertReloadToDeleteInsert(reloads, deletes, inserts, diffResult, fromObjects);
|
|
|
|
NSMutableArray<NSIndexPath *> *itemInserts = batchUpdates.itemInserts;
|
|
NSMutableArray<NSIndexPath *> *itemDeletes = batchUpdates.itemDeletes;
|
|
NSMutableArray<IGListMoveIndexPath *> *itemMoves = batchUpdates.itemMoves;
|
|
|
|
NSSet<NSIndexPath *> *uniqueDeletes = [NSSet setWithArray:itemDeletes];
|
|
NSMutableSet<NSIndexPath *> *reloadDeletePaths = [NSMutableSet new];
|
|
NSMutableSet<NSIndexPath *> *reloadInsertPaths = [NSMutableSet new];
|
|
for (IGListReloadIndexPath *reload in batchUpdates.itemReloads) {
|
|
if (![uniqueDeletes containsObject:reload.fromIndexPath]) {
|
|
[reloadDeletePaths addObject:reload.fromIndexPath];
|
|
[reloadInsertPaths addObject:reload.toIndexPath];
|
|
}
|
|
}
|
|
[itemDeletes addObjectsFromArray:[reloadDeletePaths allObjects]];
|
|
[itemInserts addObjectsFromArray:[reloadInsertPaths allObjects]];
|
|
|
|
if (IGListExperimentEnabled(self.experiments, IGListExperimentDedupeItemUpdates)) {
|
|
itemDeletes = [[[NSSet setWithArray:itemDeletes] allObjects] mutableCopy];
|
|
itemInserts = [[[NSSet setWithArray:itemInserts] allObjects] mutableCopy];
|
|
}
|
|
|
|
IGListBatchUpdateData *updateData = [[IGListBatchUpdateData alloc] initWithInsertSections:inserts
|
|
deleteSections:deletes
|
|
moveSections:moves
|
|
insertIndexPaths:itemInserts
|
|
deleteIndexPaths:itemDeletes
|
|
moveIndexPaths:itemMoves];
|
|
[collectionView ig_applyBatchUpdateData:updateData];
|
|
return updateData;
|
|
}
|
|
|
|
- (void)_beginPerformBatchUpdatesToObjects:(NSArray *)toObjects {
|
|
self.pendingTransitionToObjects = toObjects;
|
|
self.state = IGListBatchUpdateStateQueuedBatchUpdate;
|
|
}
|
|
|
|
- (void)_performBatchUpdatesItemBlockApplied {
|
|
self.pendingTransitionToObjects = nil;
|
|
}
|
|
|
|
- (void)cleanStateBeforeUpdates {
|
|
self.queuedUpdateIsAnimated = YES;
|
|
|
|
// destroy to/from transition items
|
|
self.fromObjects = nil;
|
|
self.toObjectsBlock = nil;
|
|
|
|
// destroy reloadData state
|
|
self.reloadUpdates = nil;
|
|
self.queuedReloadData = NO;
|
|
|
|
// remove indexpath/item changes
|
|
self.objectTransitionBlock = nil;
|
|
|
|
// removes all object completion blocks. done before updates to start collecting completion blocks for coalesced
|
|
// or re-entrant object updates
|
|
[self.completionBlocks removeAllObjects];
|
|
}
|
|
|
|
- (void)_cleanStateAfterUpdates {
|
|
self.batchUpdates = [IGListBatchUpdates new];
|
|
}
|
|
|
|
- (void)_queueUpdateWithCollectionViewBlock:(IGListCollectionViewBlock)collectionViewBlock {
|
|
IGAssertMainThread();
|
|
|
|
// callers may hold weak refs and lose the collection view by the time we requeue, bail if that's the case
|
|
// if (collectionView == nil) {
|
|
// return;
|
|
// }
|
|
|
|
__weak __typeof__(self) weakSelf = self;
|
|
// __weak __typeof__(collectionView) weakCollectionView = collectionView;
|
|
|
|
// dispatch after a given amount of time to coalesce other updates and execute as one
|
|
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, self.coalescanceTime * NSEC_PER_SEC), dispatch_get_main_queue(), ^{
|
|
if (weakSelf.state != IGListBatchUpdateStateIdle
|
|
|| ![weakSelf hasChanges]) {
|
|
return;
|
|
}
|
|
|
|
if (weakSelf.hasQueuedReloadData) {
|
|
[weakSelf performReloadDataWithCollectionViewBlock:collectionViewBlock];
|
|
} else {
|
|
[weakSelf performBatchUpdatesWithCollectionViewBlock:collectionViewBlock];
|
|
}
|
|
});
|
|
}
|
|
|
|
|
|
#pragma mark - IGListUpdatingDelegate
|
|
|
|
static BOOL IGListIsEqual(const void *a, const void *b, NSUInteger (*size)(const void *item)) {
|
|
const id<IGListDiffable, NSObject> left = (__bridge id<IGListDiffable, NSObject>)a;
|
|
const id<IGListDiffable, NSObject> right = (__bridge id<IGListDiffable, NSObject>)b;
|
|
return [left class] == [right class]
|
|
&& [[left diffIdentifier] isEqual:[right diffIdentifier]];
|
|
}
|
|
|
|
// since the diffing algo used in this updater keys items based on their -diffIdentifier, we must use a map table that
|
|
// precisely mimics this behavior
|
|
static NSUInteger IGListIdentifierHash(const void *item, NSUInteger (*size)(const void *item)) {
|
|
return [[(__bridge id<IGListDiffable>)item diffIdentifier] hash];
|
|
}
|
|
|
|
- (NSPointerFunctions *)objectLookupPointerFunctions {
|
|
NSPointerFunctions *functions = [NSPointerFunctions pointerFunctionsWithOptions:NSPointerFunctionsStrongMemory];
|
|
functions.hashFunction = IGListIdentifierHash;
|
|
functions.isEqualFunction = IGListIsEqual;
|
|
return functions;
|
|
}
|
|
|
|
- (void)performUpdateWithCollectionViewBlock:(IGListCollectionViewBlock)collectionViewBlock
|
|
fromObjects:(NSArray *)fromObjects
|
|
toObjectsBlock:(IGListToObjectBlock)toObjectsBlock
|
|
animated:(BOOL)animated
|
|
objectTransitionBlock:(IGListObjectTransitionBlock)objectTransitionBlock
|
|
completion:(IGListUpdatingCompletion)completion {
|
|
IGAssertMainThread();
|
|
IGParameterAssert(collectionViewBlock != nil);
|
|
IGParameterAssert(objectTransitionBlock != nil);
|
|
|
|
// only update the items that we are coming from if it has not been set
|
|
// this allows multiple updates to be called while an update is already in progress, and the transition from > to
|
|
// will be done on the first "fromObjects" received and the last "toObjects"
|
|
// if performBatchUpdates: hasn't applied the update block, then data source hasn't transitioned its state. if an
|
|
// update is queued in between then we must use the pending toObjects
|
|
self.fromObjects = self.fromObjects ?: self.pendingTransitionToObjects ?: fromObjects;
|
|
self.toObjectsBlock = toObjectsBlock;
|
|
|
|
// disabled animations will always take priority
|
|
// reset to YES in -cleanupState
|
|
self.queuedUpdateIsAnimated = self.queuedUpdateIsAnimated && animated;
|
|
|
|
// always use the last update block, even though this should always do the exact same thing
|
|
self.objectTransitionBlock = objectTransitionBlock;
|
|
|
|
IGListUpdatingCompletion localCompletion = completion;
|
|
if (localCompletion) {
|
|
[self.completionBlocks addObject:localCompletion];
|
|
}
|
|
|
|
[self _queueUpdateWithCollectionViewBlock:collectionViewBlock];
|
|
}
|
|
|
|
- (void)performUpdateWithCollectionViewBlock:(IGListCollectionViewBlock)collectionViewBlock
|
|
animated:(BOOL)animated
|
|
itemUpdates:(void (^)(void))itemUpdates
|
|
completion:(void (^)(BOOL))completion {
|
|
IGAssertMainThread();
|
|
IGParameterAssert(collectionViewBlock != nil);
|
|
IGParameterAssert(itemUpdates != nil);
|
|
|
|
IGListBatchUpdates *batchUpdates = self.batchUpdates;
|
|
if (completion != nil) {
|
|
[batchUpdates.itemCompletionBlocks addObject:completion];
|
|
}
|
|
|
|
// if already inside the execution of the update block, immediately unload the itemUpdates block.
|
|
// the completion blocks are executed later in the lifecycle, so that still needs to be added to the batch
|
|
if (self.state == IGListBatchUpdateStateExecutingBatchUpdateBlock) {
|
|
itemUpdates();
|
|
} else {
|
|
[batchUpdates.itemUpdateBlocks addObject:itemUpdates];
|
|
|
|
// disabled animations will always take priority
|
|
// reset to YES in -cleanupState
|
|
self.queuedUpdateIsAnimated = self.queuedUpdateIsAnimated && animated;
|
|
|
|
[self _queueUpdateWithCollectionViewBlock:collectionViewBlock];
|
|
}
|
|
}
|
|
|
|
- (void)insertItemsIntoCollectionView:(UICollectionView *)collectionView indexPaths:(NSArray <NSIndexPath *> *)indexPaths {
|
|
IGAssertMainThread();
|
|
IGParameterAssert(collectionView != nil);
|
|
IGParameterAssert(indexPaths != nil);
|
|
if (self.state == IGListBatchUpdateStateExecutingBatchUpdateBlock) {
|
|
[self.batchUpdates.itemInserts addObjectsFromArray:indexPaths];
|
|
} else {
|
|
[self.delegate listAdapterUpdater:self willInsertIndexPaths:indexPaths collectionView:collectionView];
|
|
[collectionView insertItemsAtIndexPaths:indexPaths];
|
|
}
|
|
}
|
|
|
|
- (void)deleteItemsFromCollectionView:(UICollectionView *)collectionView indexPaths:(NSArray <NSIndexPath *> *)indexPaths {
|
|
IGAssertMainThread();
|
|
IGParameterAssert(collectionView != nil);
|
|
IGParameterAssert(indexPaths != nil);
|
|
if (self.state == IGListBatchUpdateStateExecutingBatchUpdateBlock) {
|
|
[self.batchUpdates.itemDeletes addObjectsFromArray:indexPaths];
|
|
} else {
|
|
[self.delegate listAdapterUpdater:self willDeleteIndexPaths:indexPaths collectionView:collectionView];
|
|
[collectionView deleteItemsAtIndexPaths:indexPaths];
|
|
}
|
|
}
|
|
|
|
- (void)moveItemInCollectionView:(UICollectionView *)collectionView
|
|
fromIndexPath:(NSIndexPath *)fromIndexPath
|
|
toIndexPath:(NSIndexPath *)toIndexPath {
|
|
if (self.state == IGListBatchUpdateStateExecutingBatchUpdateBlock) {
|
|
IGListMoveIndexPath *move = [[IGListMoveIndexPath alloc] initWithFrom:fromIndexPath to:toIndexPath];
|
|
[self.batchUpdates.itemMoves addObject:move];
|
|
} else {
|
|
[self.delegate listAdapterUpdater:self willMoveFromIndexPath:fromIndexPath toIndexPath:toIndexPath collectionView:collectionView];
|
|
[collectionView moveItemAtIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
}
|
|
}
|
|
|
|
- (void)reloadItemInCollectionView:(UICollectionView *)collectionView
|
|
fromIndexPath:(NSIndexPath *)fromIndexPath
|
|
toIndexPath:(NSIndexPath *)toIndexPath {
|
|
if (self.state == IGListBatchUpdateStateExecutingBatchUpdateBlock) {
|
|
IGListReloadIndexPath *reload = [[IGListReloadIndexPath alloc] initWithFromIndexPath:fromIndexPath toIndexPath:toIndexPath];
|
|
[self.batchUpdates.itemReloads addObject:reload];
|
|
} else {
|
|
[collectionView reloadItemsAtIndexPaths:@[fromIndexPath]];
|
|
}
|
|
}
|
|
|
|
- (void)moveSectionInCollectionView:(UICollectionView *)collectionView
|
|
fromIndex:(NSInteger)fromIndex
|
|
toIndex:(NSInteger)toIndex {
|
|
IGAssertMainThread();
|
|
IGParameterAssert(collectionView != nil);
|
|
|
|
// iOS expects interactive reordering to be movement of items not sections
|
|
// after moving a single-item section controller,
|
|
// you end up with two items in the section for the drop location,
|
|
// and zero items in the section originating at the drag location
|
|
// so, we have to reload data rather than doing a section move
|
|
|
|
[collectionView reloadData];
|
|
|
|
// It seems that reloadData called during UICollectionView's moveItemAtIndexPath
|
|
// delegate call does not reload all cells as intended
|
|
// So, we further reload all visible sections to make sure none of our cells
|
|
// are left with data that's out of sync with our dataSource
|
|
|
|
id<IGListAdapterUpdaterDelegate> delegate = self.delegate;
|
|
|
|
NSMutableIndexSet *visibleSections = [NSMutableIndexSet new];
|
|
NSArray *visibleIndexPaths = [collectionView indexPathsForVisibleItems];
|
|
for (NSIndexPath *visibleIndexPath in visibleIndexPaths) {
|
|
[visibleSections addIndex:visibleIndexPath.section];
|
|
}
|
|
|
|
[delegate listAdapterUpdater:self willReloadSections:visibleSections collectionView:collectionView];
|
|
|
|
// prevent double-animation from reloadData + reloadSections
|
|
|
|
[CATransaction begin];
|
|
[CATransaction setDisableActions:YES];
|
|
[collectionView performBatchUpdates:^{
|
|
[collectionView reloadSections:visibleSections];
|
|
} completion:^(BOOL finished) {
|
|
[CATransaction commit];
|
|
}];
|
|
}
|
|
|
|
- (void)reloadDataWithCollectionViewBlock:(IGListCollectionViewBlock)collectionViewBlock
|
|
reloadUpdateBlock:(IGListReloadUpdateBlock)reloadUpdateBlock
|
|
completion:(nullable IGListUpdatingCompletion)completion {
|
|
IGAssertMainThread();
|
|
IGParameterAssert(collectionViewBlock != nil);
|
|
IGParameterAssert(reloadUpdateBlock != nil);
|
|
|
|
IGListUpdatingCompletion localCompletion = completion;
|
|
if (localCompletion) {
|
|
[self.completionBlocks addObject:localCompletion];
|
|
}
|
|
|
|
self.reloadUpdates = reloadUpdateBlock;
|
|
self.queuedReloadData = YES;
|
|
[self _queueUpdateWithCollectionViewBlock:collectionViewBlock];
|
|
}
|
|
|
|
- (void)reloadCollectionView:(UICollectionView *)collectionView sections:(NSIndexSet *)sections {
|
|
IGAssertMainThread();
|
|
IGParameterAssert(collectionView != nil);
|
|
IGParameterAssert(sections != nil);
|
|
if (self.state == IGListBatchUpdateStateExecutingBatchUpdateBlock) {
|
|
[self.batchUpdates.sectionReloads addIndexes:sections];
|
|
} else {
|
|
[self.delegate listAdapterUpdater:self willReloadSections:sections collectionView:collectionView];
|
|
[collectionView reloadSections:sections];
|
|
}
|
|
}
|
|
|
|
|
|
@end
|
|
|