IGListKit/Source/IGListDiffKit/IGListIndexSetResult.h
3a4oT a1036e06e3 SPM number10 (#1487)
Summary:
## Changes in this pull request

 A better version of https://github.com/Instagram/IGListKit/issues/1465 =)

- SPM support with script-based generations.

- added macOS Catalyst support

 ### Generate SPM layout

1. From **project's root** run:

   `bash scripts/generate_spm_sources_layout.sh`

  2. Commit Changes

 Repeat those steps each time you delete/add the project's files. **Make sure** to have this CI step which will check that `generate_spm_sources_layout.sh` is not broken.

Issue fixed: https://github.com/Instagram/IGListKit/issues/1368 #1406

### Checklist

- [ ] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)

Pull Request resolved: https://github.com/Instagram/IGListKit/pull/1487

Reviewed By: DimaVartanian, candance

Differential Revision: D30428297

Pulled By: lorixx

fbshipit-source-id: 655291ff03445dec9b0b8cd97916f0c88207e9a7
2021-08-31 19:28:37 -07:00

85 lines
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 "IGListMoveIndex.h"
NS_ASSUME_NONNULL_BEGIN
/**
A result object returned when diffing with indexes.
*/
NS_SWIFT_NAME(ListIndexSetResult)
@interface IGListIndexSetResult : NSObject
/**
The indexes inserted into the new collection.
*/
@property (nonatomic, strong, readonly) NSIndexSet *inserts;
/**
The indexes deleted from the old collection.
*/
@property (nonatomic, strong, readonly) NSIndexSet *deletes;
/**
The indexes in the old collection that need updated.
*/
@property (nonatomic, strong, readonly) NSIndexSet *updates;
/**
The moves from an index in the old collection to an index in the new collection.
*/
@property (nonatomic, copy, readonly) NSArray<IGListMoveIndex *> *moves;
/**
A Read-only boolean that indicates whether the result has any changes or not.
`YES` if the result has changes, `NO` otherwise.
*/
@property (nonatomic, assign, readonly) BOOL hasChanges;
/**
Returns the index of the object with the specified identifier *before* the diff.
@param identifier The diff identifier of the object.
@return The index of the object before the diff, or `NSNotFound`.
@see `-[IGListDiffable diffIdentifier]`.
*/
- (NSInteger)oldIndexForIdentifier:(id<NSObject>)identifier;
/**
Returns the index of the object with the specified identifier *after* the diff.
@param identifier The diff identifier of the object.
@return The index path of the object after the diff, or `NSNotFound`.
@see `-[IGListDiffable diffIdentifier]`.
*/
- (NSInteger)newIndexForIdentifier:(id<NSObject>)identifier;
/**
Creates a new result object with operations safe for use in `UITableView` and `UICollectionView` batch updates.
*/
- (IGListIndexSetResult *)resultForBatchUpdates;
/**
:nodoc:
*/
- (instancetype)init NS_UNAVAILABLE;
/**
:nodoc:
*/
+ (instancetype)new NS_UNAVAILABLE;
@end
NS_ASSUME_NONNULL_END