IGListKit/Source/Common/IGListDiff.h
Ryan Nystrom ad30e53507 Move macOS and diffing files to Common dir
Summary:
Moving files to `Common` dir so changes are more automated with Buck and easier to manage in the long run. Ran `pod install` on test and example targets. Updated buck file to include `Common` so diffing lib still works.

Part of #270

Reviewed By: jessesquires

Differential Revision: D4346722

fbshipit-source-id: 366d89f6dd571b158b5fccd542080c51517ed341
2016-12-19 12:29:24 -08:00

62 lines
2.1 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.
*/
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.
*/
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.
*/
FOUNDATION_EXTERN IGListIndexPathResult *IGListDiffPaths(NSInteger fromSection,
NSInteger toSection,
NSArray<id<IGListDiffable>> *_Nullable oldArray,
NSArray<id<IGListDiffable>> *_Nullable newArray,
IGListDiffOption option);
NS_ASSUME_NONNULL_END