mirror of
https://github.com/Instagram/IGListKit
synced 2026-05-11 03:20:55 +00:00
40625f8ff9
Summary: This adds `NS_SWIFT_NAME` annotations to all public API's to provide cleaner integration into Swift: - Removes the need to prefix classes in Swift code, instead rely on Swift module name spacing - Adds more argument labels to C function API's like `IGListDiff([], [], .equality)` => `ListDiff(oldArray: [], newArray: [], option: .equality)` While this is a large API change it should be as easy as: - Find and replace `(IGList)([^K])` to `List$2` in Xcode with a scope set to Swift - Build and follow compiler's auto fix corrections for C API's or any missed renames I have not updated the documentation to reflect this yet, I am totally willing to do so but before I sink that amount of time into it I wanted to see if the Instagram team is even open to this change! - [x] All tests pass. Demo project builds and runs. - [x] I added tests, an experiment, or detailed why my change isn't tested. - [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes. - [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) - [ ] I have updated the documentation Closes https://github.com/Instagram/IGListKit/pull/593 Reviewed By: jessesquires Differential Revision: D5028039 Pulled By: rnystrom fbshipit-source-id: b473d874a1f9574e56b2ebaabd5b73d1b57d4bab
65 lines
2.3 KiB
Objective-C
65 lines
2.3 KiB
Objective-C
/**
|
|
* Copyright (c) 2016-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import <IGListKit/IGListDiffable.h>
|
|
#import <IGListKit/IGListIndexPathResult.h>
|
|
#import <IGListKit/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
|