Correctly Prioritize Rearranged Providers

Author: thecoolwinter

Sources/CodeEditSourceEditor/Highlighting/Highlighter.swift

@@ -163,7 +163,7 @@ class Highlighter: NSObject {
         let difference = newIds.difference(from: existingIds).inferringMoves()
 
         var highlightProviders = self.highlightProviders // Make a mutable copy
-        var moveMap: [Int: HighlightProviderState] = [:]
+        var moveMap: [Int: (Int, HighlightProviderState)] = [:]
 
         for change in difference {
             switch change {
@@ -174,7 +174,8 @@ class Highlighter: NSObject {
                     guard let movedProvider = moveMap[offset] else {
                         continue
                     }
-                    highlightProviders.insert(movedProvider, at: offset)
+                    highlightProviders.insert(movedProvider.1, at: offset)
+                    styleContainer.setPriority(providerId: movedProvider.0, priority: offset)
                     continue
                 }
                 // Set up a new provider and insert it with a unique ID
@@ -188,12 +189,12 @@ class Highlighter: NSObject {
                     language: language
                 )
                 highlightProviders.insert(state, at: offset)
-                styleContainer.addProvider(providerIdCounter, documentLength: textView.length)
+                styleContainer.addProvider(providerIdCounter, priority: offset, documentLength: textView.length)
                 state.invalidate() // Invalidate this new one
             case let .remove(offset, _, associatedOffset):
-                guard associatedOffset == nil else {
+                if let associatedOffset {
                     // Moved, add it to the move map
-                    moveMap[associatedOffset!] = highlightProviders.remove(at: offset)
+                    moveMap[associatedOffset] = (offset, highlightProviders.remove(at: offset))
                     continue
                 }
                 // Removed entirely

Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeContainer+runsIn.swift

@@ -26,7 +26,9 @@ extension StyledRangeContainer {
         }
 
         // Ordered by priority, lower = higher priority.
-        var allRuns = _storage.sorted(by: { $0.key < $1.key }).map { $0.value.runs(in: range.intRange) }
+        var allRuns = _storage.values
+            .sorted(by: { $0.priority < $1.priority })
+            .map { $0.store.runs(in: range.intRange) }
 
         var runs: [RangeStoreRun<StyleElement>] = []
         var minValue = allRuns.compactMap { $0.last }.enumerated().min(by: { $0.1.length < $1.1.length })

Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeContainer.swift

@@ -70,7 +70,7 @@ class StyledRangeContainer {
         }
     }
 
-    var _storage: [ProviderID: RangeStore<StyleElement>] = [:]
+    var _storage: [ProviderID: (store: RangeStore<StyleElement>, priority: Int)] = [:]
     weak var delegate: StyledRangeContainerDelegate?
 
     /// Initialize the container with a list of provider identifiers. Each provider is given an id, they should be
@@ -80,17 +80,21 @@ class StyledRangeContainer {
     ///   - providers: An array of identifiers given to providers.
     init(documentLength: Int, providers: [ProviderID]) {
         for provider in providers {
-            _storage[provider] = RangeStore<StyleElement>(documentLength: documentLength)
+            _storage[provider] = (store: RangeStore<StyleElement>(documentLength: documentLength), priority: provider)
         }
     }
 
-    func addProvider(_ id: ProviderID, documentLength: Int) {
+    func addProvider(_ id: ProviderID, priority: Int, documentLength: Int) {
         assert(!_storage.keys.contains(id), "Provider already exists")
-        _storage[id] = RangeStore<StyleElement>(documentLength: documentLength)
+        _storage[id] = (store: RangeStore<StyleElement>(documentLength: documentLength), priority: priority)
+    }
+
+    func setPriority(providerId: ProviderID, priority: Int) {
+        _storage[providerId]?.priority = priority
     }
 
     func removeProvider(_ id: ProviderID) {
-        guard let provider = _storage[id] else { return }
+        guard let provider = _storage[id]?.store else { return }
         applyHighlightResult(
             provider: id,
             highlights: [],
@@ -101,7 +105,7 @@ class StyledRangeContainer {
 
     func storageUpdated(editedRange: NSRange, changeInLength delta: Int) {
         for key in _storage.keys {
-            _storage[key]?.storageUpdated(editedRange: editedRange, changeInLength: delta)
+            _storage[key]?.store.storageUpdated(editedRange: editedRange, changeInLength: delta)
         }
     }
 }
@@ -116,7 +120,7 @@ extension StyledRangeContainer: HighlightProviderStateDelegate {
     ///   - rangeToHighlight: The range to apply the highlights to.
     func applyHighlightResult(provider: ProviderID, highlights: [HighlightRange], rangeToHighlight: NSRange) {
         assert(rangeToHighlight != .notFound, "NSNotFound is an invalid highlight range")
-        guard var storage = _storage[provider] else {
+        guard var storage = _storage[provider]?.store else {
             assertionFailure("No storage found for the given provider: \(provider)")
             return
         }
@@ -143,7 +147,7 @@ extension StyledRangeContainer: HighlightProviderStateDelegate {
         }
 
         storage.set(runs: runs, for: rangeToHighlight.intRange)
-        _storage[provider] = storage
+        _storage[provider]?.store = storage
         delegate?.styleContainerDidUpdate(in: rangeToHighlight)
     }
 }