-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce ASCollectionGalleryLayoutDelegate (#76)
* Implement ASCollectionGalleryLayoutDelegate - It arranges items of the same size into a multi-line stack (say photo gallery or pager). It takes advantage of the fact that its items always have a fixed size to measure as few items as possible while still being able to track their positions at all time. This helps reduce startup/reloadData time, as well as memory footprint. - It then uses a measure range, which also works as a allocate range, to figure out which items to measure ahead of time. And it guarantees that each item is scheduled to measure only once. - Lastly, ASCollectionLayoutDelegate has some new methods that allow delegates to hook up and stay ahead of layout attributes requests from the backing view. ASCollectionGalleryLayoutDelegate for example uses these methods to ensure elements that have their layout attributes requested are always ready for consumption, and to measure more elements in the background. * Handle items that span multiple pages and other improvements in gallery delegate * Minor fixes * Fix failing tests * Fix custom collection example * Implement missing method in gallery layout delegate * Fix warnings * Some improvements - Collection layout delegates must have a crollable directions property. - Simplify gallery delegate by not storing unmeasured attributes since calling measure on already measured elements should be cache hits and super fast. - Abstact some code in gallery delegate to ASCollectionLayoutState+Private and _ASCollectionGalleryLayoutItem. - Other improvements in gallery delegate * Fix file licenses * Move measure range logic to ASCollectionLayout * Track unmeasured elements * Remove pending layout in ASCollectionLayout * Get back pending layout because the timing to latch new data is not ideal * Add ASCollectionLayoutCache * Fix file licenses * Fix xcodeproj * Add async collection layout to examples/ASCollectionView * Measure method in ASCollectionLayout to be a class method * Encourage more immutable states - Make -calculateLayoutWithContext: to be class methods in ASDataControllerLayoutDelegate and ASCollectionLayoutDelegate. - Add layout delegate class and layout cache to ASCollectionLayoutContext+Private, to be use by ASCollectionLayout only. - ASDataController no longer allocates all nodes but lets ASCollectionLayout determine. - Add scrollableDirections to the layout context since it's often needed by the layout pass. Otherwise users have to wrap it in an info object. - Update built-in layout delegates and CustomCollectionView example. - Publish ASHashing. It might be helpful for clients that implement custom collection info objects. * Remove additionalInfo property in ASCollectionLayoutState * ASCollectionLayoutState to correctly filter unmeasured elements * Add ASHashing to umbrella header * Fix file licenses * Add ASDispatchAsync and use it in ASCollectionLayout * Improve code comment in ASCollectionLayoutState
- Loading branch information
Showing
40 changed files
with
1,477 additions
and
466 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // | ||
| // ASCollectionGalleryLayoutDelegate.h | ||
| // Texture | ||
| // | ||
| // Copyright (c) 2017-present, Pinterest, Inc. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
|
|
||
| #import <AsyncDisplayKit/ASCollectionLayoutDelegate.h> | ||
| #import <AsyncDisplayKit/ASScrollDirection.h> | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| /** | ||
| * A thread-safe layout delegate that arranges items with the same size into a flow layout. | ||
| * | ||
| * @note Supplemenraty elements are not supported. | ||
| */ | ||
| AS_SUBCLASSING_RESTRICTED | ||
| @interface ASCollectionGalleryLayoutDelegate : NSObject <ASCollectionLayoutDelegate> | ||
|
|
||
| - (instancetype)initWithScrollableDirections:(ASScrollDirection)scrollableDirections itemSize:(CGSize)itemSize NS_DESIGNATED_INITIALIZER; | ||
|
|
||
| - (instancetype)init __unavailable; | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| // | ||
| // ASCollectionGalleryLayoutDelegate.m | ||
| // Texture | ||
| // | ||
| // Copyright (c) 2017-present, Pinterest, Inc. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
|
|
||
| #import <AsyncDisplayKit/ASCollectionGalleryLayoutDelegate.h> | ||
|
|
||
| #import <AsyncDisplayKit/_ASCollectionGalleryLayoutItem.h> | ||
| #import <AsyncDisplayKit/ASAssert.h> | ||
| #import <AsyncDisplayKit/ASCellNode.h> | ||
| #import <AsyncDisplayKit/ASCollectionElement.h> | ||
| #import <AsyncDisplayKit/ASCollectionLayoutContext.h> | ||
| #import <AsyncDisplayKit/ASCollectionLayoutDefines.h> | ||
| #import <AsyncDisplayKit/ASCollectionLayoutState.h> | ||
| #import <AsyncDisplayKit/ASElementMap.h> | ||
| #import <AsyncDisplayKit/ASLayout.h> | ||
| #import <AsyncDisplayKit/ASLayoutRangeType.h> | ||
| #import <AsyncDisplayKit/ASStackLayoutSpec.h> | ||
|
|
||
| #pragma mark - ASCollectionGalleryLayoutDelegate | ||
|
|
||
| @implementation ASCollectionGalleryLayoutDelegate { | ||
| ASScrollDirection _scrollableDirections; | ||
| CGSize _itemSize; | ||
| } | ||
|
|
||
| - (instancetype)initWithScrollableDirections:(ASScrollDirection)scrollableDirections itemSize:(CGSize)itemSize | ||
| { | ||
| self = [super init]; | ||
| if (self) { | ||
| ASDisplayNodeAssertFalse(CGSizeEqualToSize(CGSizeZero, itemSize)); | ||
| _scrollableDirections = scrollableDirections; | ||
| _itemSize = itemSize; | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| - (ASScrollDirection)scrollableDirections | ||
| { | ||
| return _scrollableDirections; | ||
| } | ||
|
|
||
| - (id)additionalInfoForLayoutWithElements:(ASElementMap *)elements | ||
| { | ||
| return [NSValue valueWithCGSize:_itemSize]; | ||
| } | ||
|
|
||
| + (ASCollectionLayoutState *)calculateLayoutWithContext:(ASCollectionLayoutContext *)context | ||
| { | ||
| ASElementMap *elements = context.elements; | ||
| CGSize pageSize = context.viewportSize; | ||
| CGSize itemSize = ((NSValue *)context.additionalInfo).CGSizeValue; | ||
| ASScrollDirection scrollableDirections = context.scrollableDirections; | ||
| NSMutableArray<_ASGalleryLayoutItem *> *children = ASArrayByFlatMapping(elements.itemElements, | ||
| ASCollectionElement *element, | ||
| [[_ASGalleryLayoutItem alloc] initWithItemSize:itemSize collectionElement:element]); | ||
| if (children.count == 0) { | ||
| return [[ASCollectionLayoutState alloc] initWithContext:context | ||
| contentSize:CGSizeZero | ||
| elementToLayoutAttributesTable:[NSMapTable weakToStrongObjectsMapTable]]; | ||
| } | ||
|
|
||
| // Use a stack spec to calculate layout content size and frames of all elements without actually measuring each element | ||
| ASStackLayoutSpec *stackSpec = [ASStackLayoutSpec stackLayoutSpecWithDirection:ASStackLayoutDirectionHorizontal | ||
| spacing:0 | ||
| justifyContent:ASStackLayoutJustifyContentStart | ||
| alignItems:ASStackLayoutAlignItemsStart | ||
| flexWrap:ASStackLayoutFlexWrapWrap | ||
| alignContent:ASStackLayoutAlignContentStart | ||
| children:children]; | ||
| stackSpec.concurrent = YES; | ||
| ASLayout *layout = [stackSpec layoutThatFits:ASSizeRangeForCollectionLayoutThatFitsViewportSize(pageSize, scrollableDirections)]; | ||
|
|
||
| return [[ASCollectionLayoutState alloc] initWithContext:context layout:layout getElementBlock:^ASCollectionElement *(ASLayout *sublayout) { | ||
| return ((_ASGalleryLayoutItem *)sublayout.layoutElement).collectionElement; | ||
| }]; | ||
| } | ||
|
|
||
| @end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // | ||
| // ASCollectionLayoutContext.m | ||
| // Texture | ||
| // | ||
| // Copyright (c) 2017-present, Pinterest, Inc. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
|
|
||
| #import <AsyncDisplayKit/ASCollectionLayoutContext.h> | ||
| #import <AsyncDisplayKit/ASCollectionLayoutContext+Private.h> | ||
|
|
||
| #import <AsyncDisplayKit/ASAssert.h> | ||
| #import <AsyncDisplayKit/ASCollectionLayoutDelegate.h> | ||
| #import <AsyncDisplayKit/ASCollectionLayoutCache.h> | ||
| #import <AsyncDisplayKit/ASElementMap.h> | ||
| #import <AsyncDisplayKit/ASEqualityHelpers.h> | ||
| #import <AsyncDisplayKit/ASHashing.h> | ||
|
|
||
| @implementation ASCollectionLayoutContext { | ||
| Class<ASCollectionLayoutDelegate> _layoutDelegateClass; | ||
|
|
||
| // This ivar doesn't directly involve in the layout calculation process, i.e contexts can be equal regardless of the layout caches. | ||
| // As a result, this ivar is ignored in -isEqualToContext: and -hash. | ||
| __weak ASCollectionLayoutCache *_layoutCache; | ||
| } | ||
|
|
||
| - (instancetype)initWithViewportSize:(CGSize)viewportSize | ||
| scrollableDirections:(ASScrollDirection)scrollableDirections | ||
| elements:(ASElementMap *)elements | ||
| layoutDelegateClass:(Class<ASCollectionLayoutDelegate>)layoutDelegateClass | ||
| layoutCache:(ASCollectionLayoutCache *)layoutCache | ||
| additionalInfo:(id)additionalInfo | ||
| { | ||
| self = [super init]; | ||
| if (self) { | ||
| ASDisplayNodeAssertTrue([layoutDelegateClass conformsToProtocol:@protocol(ASCollectionLayoutDelegate)]); | ||
| _viewportSize = viewportSize; | ||
| _scrollableDirections = scrollableDirections; | ||
| _elements = elements; | ||
| _layoutDelegateClass = layoutDelegateClass; | ||
| _layoutCache = layoutCache; | ||
| _additionalInfo = additionalInfo; | ||
| } | ||
| return self; | ||
| } | ||
|
|
||
| - (Class<ASCollectionLayoutDelegate>)layoutDelegateClass | ||
| { | ||
| return _layoutDelegateClass; | ||
| } | ||
|
|
||
| - (ASCollectionLayoutCache *)layoutCache | ||
| { | ||
| return _layoutCache; | ||
| } | ||
|
|
||
| - (BOOL)isEqualToContext:(ASCollectionLayoutContext *)context | ||
| { | ||
| if (context == nil) { | ||
| return NO; | ||
| } | ||
|
|
||
| // NOTE: ASObjectIsEqual returns YES when both objects are nil. | ||
| // So don't use ASObjectIsEqual on _elements. | ||
| // It is a weak property and 2 layouts generated from different sets of elements | ||
| // should never be considered the same even if they are nil now. | ||
| return CGSizeEqualToSize(_viewportSize, context.viewportSize) | ||
| && _scrollableDirections == context.scrollableDirections | ||
| && [_elements isEqual:context.elements] | ||
| && _layoutDelegateClass == context.layoutDelegateClass | ||
| && ASObjectIsEqual(_additionalInfo, context.additionalInfo); | ||
| } | ||
|
|
||
| - (BOOL)isEqual:(id)other | ||
| { | ||
| if (self == other) { | ||
| return YES; | ||
| } | ||
| if (! [other isKindOfClass:[ASCollectionLayoutContext class]]) { | ||
| return NO; | ||
| } | ||
| return [self isEqualToContext:other]; | ||
| } | ||
|
|
||
| - (NSUInteger)hash | ||
| { | ||
| struct { | ||
| CGSize viewportSize; | ||
| ASScrollDirection scrollableDirections; | ||
| NSUInteger elementsHash; | ||
| NSUInteger layoutDelegateClassHash; | ||
| NSUInteger additionalInfoHash; | ||
| } data = { | ||
| _viewportSize, | ||
| _scrollableDirections, | ||
| _elements.hash, | ||
| _layoutDelegateClass.hash, | ||
| [_additionalInfo hash] | ||
| }; | ||
| return ASHashBytes(&data, sizeof(data)); | ||
| } | ||
|
|
||
| @end |
Oops, something went wrong.