Skip to content

Force Break Undo Groups When Forcing Grouping #81

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

Merged
merged 1 commit into from
Apr 8, 2025
Merged

Force Break Undo Groups When Forcing Grouping #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 20 additions & 10 deletions Sources/CodeEditTextView/Utils/CEUndoManager.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ public class CEUndoManager {

private weak var textView: TextView?
private(set) public var isGrouping: Bool = false

/// After ``endUndoGrouping`` is called, we'd expect the next mutation to be exclusive no matter what. This
/// flag facilitates that, and is set by ``endUndoGrouping``
private var shouldBreakNextGroup: Bool = false

/// True when the manager is ignoring mutations.
private var isDisabled: Bool = false

Expand Down Expand Up @@ -154,18 +159,19 @@ public class CEUndoManager {
return
}
let newMutation = Mutation(mutation: mutation, inverse: textStorage.inverseMutation(for: mutation))
if !undoStack.isEmpty, let lastMutation = undoStack.last?.mutations.last {
if isGrouping || shouldContinueGroup(newMutation, lastMutation: lastMutation) {
undoStack[undoStack.count - 1].mutations.append(newMutation)
} else {
undoStack.append(UndoGroup(mutations: [newMutation]))
}
// We can continue a group if:
// - A group exists
// - We're not direct to break the current group
// - We're forced grouping OR we automagically detect we can group.
if !undoStack.isEmpty,
let lastMutation = undoStack.last?.mutations.last,
!shouldBreakNextGroup,
isGrouping || shouldContinueGroup(newMutation, lastMutation: lastMutation) {
undoStack[undoStack.count - 1].mutations.append(newMutation)
} else {
undoStack.append(
UndoGroup(mutations: [newMutation])
)
undoStack.append(UndoGroup(mutations: [newMutation]))
shouldBreakNextGroup = false
}

redoStack.removeAll()
}

Expand All @@ -178,6 +184,8 @@ public class CEUndoManager {
return
}
isGrouping = true
// This is a new undo group, break for it.
shouldBreakNextGroup = true
}

/// Stops grouping all incoming mutations.
Expand All @@ -187,6 +195,8 @@ public class CEUndoManager {
return
}
isGrouping = false
// We just ended a group, do not allow the next mutation to be added to the group we just made.
shouldBreakNextGroup = true
}

/// Determines whether or not two mutations should be grouped.
Expand Down