mirror of
https://github.com/Swiftgram/Telegram-iOS.git
synced 2025-06-16 05:55:20 +00:00
219 lines
8.3 KiB
Objective-C
219 lines
8.3 KiB
Objective-C
//
|
||
// _ASHierarchyChangeSet.h
|
||
// Texture
|
||
//
|
||
// Copyright (c) Facebook, Inc. and its affiliates. All rights reserved.
|
||
// Changes after 4/13/2017 are: Copyright (c) Pinterest, Inc. All rights reserved.
|
||
// Licensed under Apache 2.0: http://www.apache.org/licenses/LICENSE-2.0
|
||
//
|
||
|
||
#ifndef MINIMAL_ASDK
|
||
|
||
#import <Foundation/Foundation.h>
|
||
#import <vector>
|
||
#import <AsyncDisplayKit/ASObjectDescriptionHelpers.h>
|
||
#import <AsyncDisplayKit/ASIntegerMap.h>
|
||
#import <AsyncDisplayKit/ASLog.h>
|
||
|
||
NS_ASSUME_NONNULL_BEGIN
|
||
|
||
typedef NSUInteger ASDataControllerAnimationOptions;
|
||
|
||
typedef NS_ENUM(NSInteger, _ASHierarchyChangeType) {
|
||
/**
|
||
* A reload change, as submitted by the user. When a change set is
|
||
* completed, these changes are decomposed into delete-insert pairs
|
||
* and combined with the original deletes and inserts of the change.
|
||
*/
|
||
_ASHierarchyChangeTypeReload,
|
||
|
||
/**
|
||
* A change that was either an original delete, or the first
|
||
* part of a decomposed reload.
|
||
*/
|
||
_ASHierarchyChangeTypeDelete,
|
||
|
||
/**
|
||
* A change that was submitted by the user as a delete.
|
||
*/
|
||
_ASHierarchyChangeTypeOriginalDelete,
|
||
|
||
/**
|
||
* A change that was either an original insert, or the second
|
||
* part of a decomposed reload.
|
||
*/
|
||
_ASHierarchyChangeTypeInsert,
|
||
|
||
/**
|
||
* A change that was submitted by the user as an insert.
|
||
*/
|
||
_ASHierarchyChangeTypeOriginalInsert
|
||
};
|
||
|
||
/**
|
||
* Returns YES if the given change type is either .Insert or .Delete, NO otherwise.
|
||
* Other change types – .Reload, .OriginalInsert, .OriginalDelete – are
|
||
* intermediary types used while building the change set. All changes will
|
||
* be reduced to either .Insert or .Delete when the change is marked completed.
|
||
*/
|
||
BOOL ASHierarchyChangeTypeIsFinal(_ASHierarchyChangeType changeType);
|
||
|
||
NSString *NSStringFromASHierarchyChangeType(_ASHierarchyChangeType changeType);
|
||
|
||
@interface _ASHierarchySectionChange : NSObject <ASDescriptionProvider, ASDebugDescriptionProvider>
|
||
|
||
// FIXME: Generalize this to `changeMetadata` dict?
|
||
@property (nonatomic, readonly) ASDataControllerAnimationOptions animationOptions;
|
||
|
||
@property (nonatomic, readonly) NSIndexSet *indexSet;
|
||
|
||
@property (nonatomic, readonly) _ASHierarchyChangeType changeType;
|
||
|
||
/**
|
||
* If this is a .OriginalInsert or .OriginalDelete change, this returns a copied change
|
||
* with type .Insert or .Delete. Calling this on changes of other types is an error.
|
||
*/
|
||
- (_ASHierarchySectionChange *)changeByFinalizingType;
|
||
|
||
@end
|
||
|
||
@interface _ASHierarchyItemChange : NSObject <ASDescriptionProvider, ASDebugDescriptionProvider>
|
||
|
||
@property (nonatomic, readonly) ASDataControllerAnimationOptions animationOptions;
|
||
|
||
/// Index paths are sorted descending for changeType .Delete, ascending otherwise
|
||
@property (nonatomic, readonly) NSArray<NSIndexPath *> *indexPaths;
|
||
|
||
@property (nonatomic, readonly) _ASHierarchyChangeType changeType;
|
||
|
||
+ (NSDictionary<NSNumber *, NSIndexSet *> *)sectionToIndexSetMapFromChanges:(NSArray<_ASHierarchyItemChange *> *)changes;
|
||
|
||
/**
|
||
* If this is a .OriginalInsert or .OriginalDelete change, this returns a copied change
|
||
* with type .Insert or .Delete. Calling this on changes of other types is an error.
|
||
*/
|
||
- (_ASHierarchyItemChange *)changeByFinalizingType;
|
||
|
||
@end
|
||
|
||
@interface _ASHierarchyChangeSet : NSObject <ASDescriptionProvider, ASDebugDescriptionProvider>
|
||
|
||
/// @precondition The change set must be completed.
|
||
@property (nonatomic, readonly) NSIndexSet *deletedSections;
|
||
|
||
/// @precondition The change set must be completed.
|
||
@property (nonatomic, readonly) NSIndexSet *insertedSections;
|
||
|
||
@property (nonatomic, readonly) BOOL completed;
|
||
|
||
/// Whether or not changes should be animated.
|
||
// TODO: if any update in this chagne set is non-animated, the whole update should be non-animated.
|
||
@property (nonatomic) BOOL animated;
|
||
|
||
@property (nonatomic, readonly) BOOL includesReloadData;
|
||
|
||
/// Indicates whether the change set is empty, that is it includes neither reload data nor per item or section changes.
|
||
@property (nonatomic, readonly) BOOL isEmpty;
|
||
|
||
/// The count of new ASCellNodes that can undergo async layout calculation. May be zero if all UIKit passthrough cells.
|
||
@property (nonatomic, assign) NSUInteger countForAsyncLayout;
|
||
|
||
/// The top-level activity for this update.
|
||
@property (nonatomic, OS_ACTIVITY_NULLABLE) os_activity_t rootActivity;
|
||
|
||
/// The activity for submitting this update i.e. between -beginUpdates and -endUpdates.
|
||
@property (nonatomic, OS_ACTIVITY_NULLABLE) os_activity_t submitActivity;
|
||
|
||
- (instancetype)initWithOldData:(std::vector<NSInteger>)oldItemCounts NS_DESIGNATED_INITIALIZER;
|
||
|
||
/**
|
||
* Append the given completion handler to the combined @c completionHandler.
|
||
*
|
||
* @discussion Since batch updates can be nested, we have to support multiple
|
||
* completion handlers per update.
|
||
*
|
||
* @precondition The change set must not be completed.
|
||
*/
|
||
- (void)addCompletionHandler:(nullable void(^)(BOOL finished))completion;
|
||
|
||
/**
|
||
* Execute the combined completion handler.
|
||
*
|
||
* @warning The completion block is discarded after reading because it may have captured
|
||
* significant resources that we would like to reclaim as soon as possible.
|
||
*/
|
||
- (void)executeCompletionHandlerWithFinished:(BOOL)finished;
|
||
|
||
/**
|
||
* Get the section index after the update for the given section before the update.
|
||
*
|
||
* @precondition The change set must be completed.
|
||
* @return The new section index, or NSNotFound if the given section was deleted.
|
||
*/
|
||
- (NSUInteger)newSectionForOldSection:(NSUInteger)oldSection;
|
||
|
||
/**
|
||
* A table that maps old section indexes to new section indexes.
|
||
*/
|
||
@property (nonatomic, readonly) ASIntegerMap *sectionMapping;
|
||
|
||
/**
|
||
* A table that maps new section indexes to old section indexes.
|
||
*/
|
||
@property (nonatomic, readonly) ASIntegerMap *reverseSectionMapping;
|
||
|
||
/**
|
||
* A table that provides the item mapping for the old section. If the section was deleted
|
||
* or is out of bounds, returns the empty table.
|
||
*/
|
||
- (ASIntegerMap *)itemMappingInSection:(NSInteger)oldSection;
|
||
|
||
/**
|
||
* A table that provides the reverse item mapping for the new section. If the section was inserted
|
||
* or is out of bounds, returns the empty table.
|
||
*/
|
||
- (ASIntegerMap *)reverseItemMappingInSection:(NSInteger)newSection;
|
||
|
||
/**
|
||
* Get the old item index path for the given new index path.
|
||
*
|
||
* @precondition The change set must be completed.
|
||
* @return The old index path, or nil if the given item was inserted.
|
||
*/
|
||
- (nullable NSIndexPath *)oldIndexPathForNewIndexPath:(NSIndexPath *)indexPath;
|
||
|
||
/**
|
||
* Get the new item index path for the given old index path.
|
||
*
|
||
* @precondition The change set must be completed.
|
||
* @return The new index path, or nil if the given item was deleted.
|
||
*/
|
||
- (nullable NSIndexPath *)newIndexPathForOldIndexPath:(NSIndexPath *)indexPath;
|
||
|
||
/// Call this once the change set has been constructed to prevent future modifications to the changeset. Calling this more than once is a programmer error.
|
||
/// NOTE: Calling this method will cause the changeset to convert all reloads into delete/insert pairs.
|
||
- (void)markCompletedWithNewItemCounts:(std::vector<NSInteger>)newItemCounts;
|
||
|
||
- (nullable NSArray <_ASHierarchySectionChange *> *)sectionChangesOfType:(_ASHierarchyChangeType)changeType;
|
||
|
||
- (nullable NSArray <_ASHierarchyItemChange *> *)itemChangesOfType:(_ASHierarchyChangeType)changeType;
|
||
|
||
/// Returns all item indexes affected by changes of the given type in the given section.
|
||
- (NSIndexSet *)indexesForItemChangesOfType:(_ASHierarchyChangeType)changeType inSection:(NSUInteger)section;
|
||
|
||
- (void)reloadData;
|
||
- (void)deleteSections:(NSIndexSet *)sections animationOptions:(ASDataControllerAnimationOptions)options;
|
||
- (void)insertSections:(NSIndexSet *)sections animationOptions:(ASDataControllerAnimationOptions)options;
|
||
- (void)reloadSections:(NSIndexSet *)sections animationOptions:(ASDataControllerAnimationOptions)options;
|
||
- (void)insertItems:(NSArray<NSIndexPath *> *)indexPaths animationOptions:(ASDataControllerAnimationOptions)options;
|
||
- (void)deleteItems:(NSArray<NSIndexPath *> *)indexPaths animationOptions:(ASDataControllerAnimationOptions)options;
|
||
- (void)reloadItems:(NSArray<NSIndexPath *> *)indexPaths animationOptions:(ASDataControllerAnimationOptions)options;
|
||
- (void)moveSection:(NSInteger)section toSection:(NSInteger)newSection animationOptions:(ASDataControllerAnimationOptions)options;
|
||
- (void)moveItemAtIndexPath:(NSIndexPath *)indexPath toIndexPath:(NSIndexPath *)newIndexPath animationOptions:(ASDataControllerAnimationOptions)options;
|
||
|
||
@end
|
||
|
||
NS_ASSUME_NONNULL_END
|
||
|
||
#endif
|