First Attempt At Overlapping Ranges

Author: thecoolwinter

Sources/CodeEditSourceEditor/Highlighting/HighlighProviding/HighlightProviderState.swift

@@ -11,7 +11,8 @@ import CodeEditTextView
 import OSLog
 
 protocol HighlightProviderStateDelegate: AnyObject {
-    func applyHighlightResult(provider: UUID, highlights: [HighlightRange], rangeToHighlight: NSRange)
+    typealias ProviderID = Int
+    func applyHighlightResult(provider: ProviderID, highlights: [HighlightRange], rangeToHighlight: NSRange)
 }
 
 @MainActor
@@ -24,7 +25,7 @@ class HighlightProviderState {
     // MARK: - State
 
     /// A unique identifier for this provider. Used by the delegate to determine the source of results.
-    let id: UUID
+    let id: Int
 
     /// Any indexes that highlights have been requested for, but haven't been applied.
     /// Indexes/ranges are added to this when highlights are requested and removed
@@ -65,7 +66,7 @@ class HighlightProviderState {
     ///   - visibleRangeProvider: A visible range provider for determining which ranges to query.
     ///   - language: The language to set up the provider with.
     init(
-        id: UUID = UUID(),
+        id: Int,
         delegate: HighlightProviderStateDelegate,
         highlightProvider: HighlightProviding,
         textView: TextView,

Sources/CodeEditSourceEditor/Highlighting/Highlighter.swift

@@ -88,7 +88,7 @@ class Highlighter: NSObject {
         self.attributeProvider = attributeProvider
         self.visibleRangeProvider = VisibleRangeProvider(textView: textView)
 
-        let providerIds = providers.indices.map({ _ in UUID() })
+        let providerIds = providers.indices.map({ $0 })
         self.rangeContainer = StyledRangeContainer(documentLength: textView.length, providers: providerIds)
 
         super.init()

Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeContainer.swift

@@ -8,17 +8,44 @@
 import Foundation
 
 class StyledRangeContainer {
-    typealias Run = StyledRangeStore.Run
-    var _storage: [UUID: StyledRangeStore] = [:]
+    var _storage: [ProviderID: StyledRangeStore] = [:]
 
-    init(documentLength: Int, providers: [UUID]) {
+    init(documentLength: Int, providers: [ProviderID]) {
         for provider in providers {
             _storage[provider] = StyledRangeStore(documentLength: documentLength)
         }
     }
 
-    func runsIn(range: NSRange) -> [Run] {
-        
+    func runsIn(range: NSRange) -> [HighlightedRun] {
+        // Ordered by priority, lower = higher priority.
+        var allRuns = _storage.sorted(by: { $0.key < $1.key }).map { $0.value.runs(in: range.intRange) }
+        var runs: [HighlightedRun] = []
+
+        var minValue = allRuns.compactMap { $0.last }.enumerated().min(by: { $0.1.length < $1.1.length })
+
+        while let value = minValue {
+            // Get minimum length off the end of each array
+            let minRunIdx = value.offset
+            var minRun = value.element
+
+            for idx in 0..<allRuns.count where idx != minRunIdx {
+                guard let last = allRuns[idx].last else { continue }
+                minRun.combineLowerPriority(last)
+                if last.length == minRun.length {
+                    allRuns[idx].removeLast()
+                } else {
+                    // safe due to guard a few lines above.
+                    allRuns[idx][allRuns[idx].count - 1].subtractLength(minRun)
+                }
+            }
+
+            allRuns[minRunIdx].removeLast()
+
+            runs.append(minRun)
+            minValue = allRuns.compactMap { $0.last }.enumerated().min(by: { $0.1.length < $1.1.length })
+        }
+
+        return runs.reversed()
     }
 
     func storageUpdated(replacedContentIn range: Range<Int>, withCount newLength: Int) {
@@ -29,21 +56,21 @@ class StyledRangeContainer {
 }
 
 extension StyledRangeContainer: HighlightProviderStateDelegate {
-    func applyHighlightResult(provider: UUID, highlights: [HighlightRange], rangeToHighlight: NSRange) {
+    func applyHighlightResult(provider: ProviderID, highlights: [HighlightRange], rangeToHighlight: NSRange) {
         assert(rangeToHighlight != .notFound, "NSNotFound is an invalid highlight range")
         guard let storage = _storage[provider] else {
             assertionFailure("No storage found for the given provider: \(provider)")
             return
         }
-        var runs: [Run] = []
+        var runs: [HighlightedRun] = []
         var lastIndex = rangeToHighlight.lowerBound
 
         for highlight in highlights {
             if highlight.range.lowerBound != lastIndex {
                 runs.append(.empty(length: highlight.range.lowerBound - lastIndex))
             }
             // TODO: Modifiers
-            runs.append(Run(length: highlight.range.length, capture: highlight.capture, modifiers: []))
+            runs.append(HighlightedRun(length: highlight.range.length, capture: highlight.capture, modifiers: []))
             lastIndex = highlight.range.max
         }
 

Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeStore/HighlightedRun.swift

@@ -0,0 +1,28 @@
+//
+//  HighlightedRun.swift
+//  CodeEditSourceEditor
+//
+//  Created by Khan Winter on 11/4/24.
+//
+
+/// Consumer-facing value type for the stored values in this container.
+struct HighlightedRun: Equatable, Hashable {
+    var length: Int
+    var capture: CaptureName?
+    var modifiers: Set<CaptureModifiers>
+
+    static func empty(length: Int) -> Self {
+        HighlightedRun(length: length, capture: nil, modifiers: [])
+    }
+
+    mutating func combineLowerPriority(_ other: borrowing HighlightedRun) {
+        if self.capture == nil {
+            self.capture = other.capture
+        }
+        self.modifiers.formUnion(other.modifiers)
+    }
+
+    mutating func subtractLength(_ other: borrowing HighlightedRun) {
+        self.length -= other.length
+    }
+}

Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeStore/StyledRangeStore.swift

@@ -13,6 +13,7 @@ import _RopeModule
 /// Internally this class uses a `Rope` from the swift-collections package, allowing for efficient updates and
 /// retrievals.
 final class StyledRangeStore {
+    typealias Run = HighlightedRun
     typealias Index = Rope<StyledRun>.Index
     var _guts = Rope<StyledRun>()
 
@@ -24,17 +25,6 @@ final class StyledRangeStore {
         self._guts = Rope([StyledRun(length: documentLength, capture: nil, modifiers: [])])
     }
 
-    /// Consumer-facing value type for the stored values in this container.
-    struct Run: Equatable, Hashable, Sendable {
-        let length: Int
-        let capture: CaptureName?
-        let modifiers: Set<CaptureModifiers>
-
-        static func empty(length: Int) -> Self {
-            Run(length: length, capture: nil, modifiers: [])
-        }
-    }
-
     // MARK: - Core
 
     func runs(in range: Range<Int>) -> [Run] {

Tests/CodeEditSourceEditorTests/Highlighting/StyledRangeContainerTests.swift

@@ -2,19 +2,19 @@ import XCTest
 @testable import CodeEditSourceEditor
 
 final class StyledRangeContainerTests: XCTestCase {
-    typealias Run = StyledRangeContainer.Run
+    typealias Run = HighlightedRun
 
     func test_init() {
-        let providers = [UUID(), UUID()]
+        let providers = [0, 1]
         let store = StyledRangeContainer(documentLength: 100, providers: providers)
 
         // Have to do string conversion due to missing Comparable conformance pre-macOS 14
-        XCTAssertEqual(store._storage.keys.map(\.uuidString).sorted(), providers.map(\.uuidString).sorted())
+        XCTAssertEqual(store._storage.keys.sorted(), providers)
         XCTAssert(store._storage.values.allSatisfy({ $0.length == 100 }), "One or more providers have incorrect length")
     }
 
     func test_setHighlights() {
-        let providers = [UUID(), UUID()]
+        let providers = [0, 1]
         let store = StyledRangeContainer(documentLength: 100, providers: providers)
 
         store.applyHighlightResult(
@@ -38,4 +38,8 @@ final class StyledRangeContainerTests: XCTestCase {
             ]
         )
     }
+
+    func test_overlappingRuns() {
+        
+    }
 }