Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix NSTableView animations #70

Merged
merged 6 commits into from
Jun 16, 2020
Merged

Fix NSTableView animations #70

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8f57c69
Fix wrong NSTableView move animations by using ExtendedPatch sequence…
hannesoid May 28, 2020
1c08885
Prevent unwanted height processing: no UITableView.beginUpdates/endUp…
hannesoid May 28, 2020
888cd41
Revert "Prevent unwanted height processing: no UITableView.beginUpdat…
hannesoid Jun 3, 2020
0f7490d
Remove skipping of beginUpdates/endUpdates when applying patches to N…
hannesoid Jun 3, 2020
8c99037
Revert removal of default param on deprecated NSTableView extension m…
hannesoid Jun 3, 2020
6636cd5
Apply Review comments for NSTableView diffing
hannesoid Jun 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 95 additions & 9 deletions Sources/Differ/Diff+AppKit.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,86 @@
#if canImport(AppKit) && !targetEnvironment(macCatalyst)
import AppKit

// MARK: - NSTableView

extension NSTableView {

/// Animates rows which changed between oldData and newData using custom `isEqual`.
///
/// - Parameters:
/// - oldData: Data which reflects the previous state of `NSTableView`
/// - newData: Data which reflects the current state of `NSTableView`
/// - isEqual: A function comparing two elements of `T`
/// - deletionAnimation: Animation type for deletions
/// - insertionAnimation: Animation type for insertions
/// - rowIndexTransform: Closure which transforms a zero-based row to the desired index
public func animateRowChanges<T: Collection>(
oldData: T,
newData: T,
isEqual: EqualityChecker<T>,
deletionAnimation: NSTableView.AnimationOptions = [],
insertionAnimation: NSTableView.AnimationOptions = [],
rowIndexTransform: (Int) -> Int = { $0 }
) {
apply(
oldData.extendedDiff(newData, isEqual: isEqual).patch(from: oldData, to: newData),
deletionAnimation: deletionAnimation,
insertionAnimation: insertionAnimation,
rowIndexTransform: rowIndexTransform
)
}

/// Animates rows which changed between oldData and newData.
///
/// - Parameters:
/// - oldData: Data which reflects the previous state of `NSTableView`
/// - newData: Data which reflects the current state of `NSTableView`
/// - deletionAnimation: Animation type for deletions
/// - insertionAnimation: Animation type for insertions
/// - indexPathTransform: Closure which transforms zero-based `IndexPath` to desired `IndexPath`
/// - rowIndexTransform: Closure which transforms a zero-based row to the desired index
public func animateRowChanges<T: Collection>(
oldData: T,
newData: T,
deletionAnimation: NSTableView.AnimationOptions = [],
insertionAnimation: NSTableView.AnimationOptions = [],
indexPathTransform: (IndexPath) -> IndexPath = { $0 }
rowIndexTransform: (Int) -> Int = { $0 }
) where T.Element: Equatable {
apply(
oldData.extendedDiff(newData),
extendedPatch(from: oldData, to: newData),
tonyarnold marked this conversation as resolved.
Show resolved Hide resolved
deletionAnimation: deletionAnimation,
insertionAnimation: insertionAnimation,
indexPathTransform: indexPathTransform
rowIndexTransform: rowIndexTransform
)
}

/// Animates a series of patches in a single beginUpdates/endUpdates batch.
/// - Parameters:
/// - patches: A series of patches to apply
/// - deletionAnimation: Animation type for deletions
/// - insertionAnimation: Animation type for insertions
/// - rowIndexTransform: Closure which transforms a zero-based row to the desired index
public func apply<T>(
_ patches: [ExtendedPatch<T>],
deletionAnimation: NSTableView.AnimationOptions = [],
insertionAnimation: NSTableView.AnimationOptions = [],
rowIndexTransform: (Int) -> Int = { $0 }
) {
beginUpdates()
for patch in patches {
switch patch {
case .insertion(index: let index, element: _):
insertRows(at: .init(integer: rowIndexTransform(index)), withAnimation: insertionAnimation)
case .deletion(index: let index):
removeRows(at: .init(integer: rowIndexTransform(index)), withAnimation: deletionAnimation)
case .move(from: let from, to: let to):
moveRow(at: rowIndexTransform(from), to: rowIndexTransform(to))
}
}
endUpdates()
}

// MARK: Deprecated

/// Animates rows which changed between oldData and newData.
///
/// - Parameters:
Expand All @@ -34,23 +89,52 @@ extension NSTableView {
/// - isEqual: A function comparing two elements of `T`
/// - deletionAnimation: Animation type for deletions
/// - insertionAnimation: Animation type for insertions
/// - indexPathTransform: Closure which transforms zero-based `IndexPath` to desired `IndexPath`
/// - indexPathTransform: Closure which transforms zero-based `IndexPath` to desired `IndexPath`. Only the `.item` is used, not the `.section`.
@available(*, deprecated, message: "Use `animateRowChanges(…rowIndexTransform:)`instead. Deprecated because indexPaths are not used in `NSTableView` rows, just Integer row indices.")
tonyarnold marked this conversation as resolved.
Show resolved Hide resolved
public func animateRowChanges<T: Collection>(
oldData: T,
newData: T,
isEqual: EqualityChecker<T>,
deletionAnimation: NSTableView.AnimationOptions = [],
insertionAnimation: NSTableView.AnimationOptions = [],
indexPathTransform: (IndexPath) -> IndexPath = { $0 }
indexPathTransform: (IndexPath) -> IndexPath
) {
apply(
oldData.extendedDiff(newData, isEqual: isEqual),
animateRowChanges(
oldData: oldData,
newData: newData,
isEqual: isEqual,
deletionAnimation: deletionAnimation,
insertionAnimation: insertionAnimation,
rowIndexTransform: { indexPathTransform(.init(item: $0, section: 0)).item }
)
}

/// Animates rows which changed between oldData and newData.
///
/// - Parameters:
/// - oldData: Data which reflects the previous state of `NSTableView`
/// - newData: Data which reflects the current state of `NSTableView`
/// - deletionAnimation: Animation type for deletions
/// - insertionAnimation: Animation type for insertions
/// - indexPathTransform: Closure which transforms zero-based `IndexPath` to desired `IndexPath`. Only the `.item` is used, not the `.section`.
@available(*, deprecated, message: "Use `animateRowChanges(…rowIndexTransform:)`instead. Deprecated because indexPaths are not used in `NSTableView` rows, just Integer row indices.")
public func animateRowChanges<T: Collection>(
oldData: T,
newData: T,
deletionAnimation: NSTableView.AnimationOptions = [],
insertionAnimation: NSTableView.AnimationOptions = [],
indexPathTransform: (IndexPath) -> IndexPath
) where T.Element: Equatable {
animateRowChanges(
oldData: oldData,
newData: newData,
deletionAnimation: deletionAnimation,
insertionAnimation: insertionAnimation,
indexPathTransform: indexPathTransform
rowIndexTransform: { indexPathTransform(.init(item: $0, section: 0)).item }
)
}

@available(*, deprecated, message: "Use `apply(_ patches: …)` based on `ExtendedPatch` instead. Deprecated because it has errors animating multiple moves.")
public func apply(
_ diff: ExtendedDiff,
deletionAnimation: NSTableView.AnimationOptions = [],
Expand All @@ -67,6 +151,8 @@ extension NSTableView {
}
}

// MARK: - NSCollectionView

@available(macOS 10.11, *)
public extension NSCollectionView {
/// Animates items which changed between oldData and newData.
Expand Down