mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-06 06:58:26 +00:00
e4c60650f2
Summary: Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1377 This splits the diffing-only components from `IGListKit` out into a separate library, `IGListDiffKit`, allowing them to be used independently of the rest of `IGListKit`. We've found that the diffing components of the library are useful independently of the rest of the `UICollectionView` infrastructure, and separating the libraries allows apps to take advantage of those components without paying the full binary size cost of `IGListKit`. The diffing components are available as a subspec in Cocoapods, and as an independent framework in Carthage and direct Xcode project import (i.e. Git submodules). This is a breaking change, necessitating a major version bump, although it should have only minor impact for projects using the umbrella header `IGListKit.h`, as that header continues to import the diffing utilities. In particular, for a project using Cocoapods and importing `IGListKit.h`, there should be no code changes required. Reviewed By: calimarkus Differential Revision: D18114249 fbshipit-source-id: 363b5a427e32800bbc6e82f897230963b4167245
63 lines
2.2 KiB
Objective-C
63 lines
2.2 KiB
Objective-C
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import <IGListDiffKit/IGListDiffable.h>
|
|
#import <IGListDiffKit/IGListIndexPathResult.h>
|
|
#import <IGListDiffKit/IGListIndexSetResult.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
An option for how to do comparisons between similar objects.
|
|
*/
|
|
NS_SWIFT_NAME(ListDiffOption)
|
|
typedef NS_ENUM(NSInteger, IGListDiffOption) {
|
|
/**
|
|
Compare objects using pointer personality.
|
|
*/
|
|
IGListDiffPointerPersonality,
|
|
/**
|
|
Compare objects using `-[IGListDiffable isEqualToDiffableObject:]`.
|
|
*/
|
|
IGListDiffEquality
|
|
};
|
|
|
|
/**
|
|
Creates a diff using indexes between two collections.
|
|
|
|
@param oldArray The old objects to diff against.
|
|
@param newArray The new objects.
|
|
@param option An option on how to compare objects.
|
|
|
|
@return A result object containing affected indexes.
|
|
*/
|
|
NS_SWIFT_NAME(ListDiff(oldArray:newArray:option:))
|
|
FOUNDATION_EXTERN IGListIndexSetResult *IGListDiff(NSArray<id<IGListDiffable>> *_Nullable oldArray,
|
|
NSArray<id<IGListDiffable>> *_Nullable newArray,
|
|
IGListDiffOption option);
|
|
|
|
/**
|
|
Creates a diff using index paths between two collections.
|
|
|
|
@param fromSection The old section.
|
|
@param toSection The new section.
|
|
@param oldArray The old objects to diff against.
|
|
@param newArray The new objects.
|
|
@param option An option on how to compare objects.
|
|
|
|
@return A result object containing affected indexes.
|
|
*/
|
|
NS_SWIFT_NAME(ListDiffPaths(fromSection:toSection:oldArray:newArray:option:))
|
|
FOUNDATION_EXTERN IGListIndexPathResult *IGListDiffPaths(NSInteger fromSection,
|
|
NSInteger toSection,
|
|
NSArray<id<IGListDiffable>> *_Nullable oldArray,
|
|
NSArray<id<IGListDiffable>> *_Nullable newArray,
|
|
IGListDiffOption option);
|
|
|
|
NS_ASSUME_NONNULL_END
|