Finish Rename

Author: thecoolwinter

Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeContainer.swift

@@ -18,7 +18,7 @@ protocol StyledRangeContainerDelegate: AnyObject {
 /// See ``runsIn(range:)`` for more details on how conflicting highlights are handled.
 @MainActor
 class StyledRangeContainer {
-    struct StyleElement: StyledRangeStoreElement, CustomDebugStringConvertible {
+    struct StyleElement: RangeStoreElement, CustomDebugStringConvertible {
         var capture: CaptureName?
         var modifiers: CaptureModifierSet
 
@@ -82,10 +82,10 @@ class StyledRangeContainer {
     ///
     /// - Parameter range: The range to query.
     /// - Returns: An array of continuous styled runs.
-    func runsIn(range: NSRange) -> [StyledRangeStoreRun<StyleElement>] {
+    func runsIn(range: NSRange) -> [RangeStoreRun<StyleElement>] {
         // Ordered by priority, lower = higher priority.
         var allRuns = _storage.sorted(by: { $0.key < $1.key }).map { $0.value.runs(in: range.intRange) }
-        var runs: [StyledRangeStoreRun<StyleElement>] = []
+        var runs: [RangeStoreRun<StyleElement>] = []
 
         var minValue = allRuns.compactMap { $0.last }.enumerated().min(by: { $0.1.length < $1.1.length })
 
@@ -140,7 +140,7 @@ extension StyledRangeContainer: HighlightProviderStateDelegate {
             assertionFailure("No storage found for the given provider: \(provider)")
             return
         }
-        var runs: [StyledRangeStoreRun<StyleElement>] = []
+        var runs: [RangeStoreRun<StyleElement>] = []
         var lastIndex = rangeToHighlight.lowerBound
 
         for highlight in highlights {
@@ -150,7 +150,7 @@ extension StyledRangeContainer: HighlightProviderStateDelegate {
                 continue // Skip! Overlapping
             }
             runs.append(
-                StyledRangeStoreRun<StyleElement>(
+                RangeStoreRun<StyleElement>(
                     length: highlight.range.length,
                     value: StyleElement(capture: highlight.capture, modifiers: highlight.modifiers)
                 )

Sources/CodeEditSourceEditor/RangeStore/RangeStore+OffsetMetric.swift

@@ -9,13 +9,13 @@ import _RopeModule
 
 extension RangeStore {
     struct OffsetMetric: RopeMetric {
-        typealias Element = StyledRun
+        typealias Element = StoredRun
 
-        func size(of summary: RangeStore.StyledRun.Summary) -> Int {
+        func size(of summary: RangeStore.StoredRun.Summary) -> Int {
             summary.length
         }
 
-        func index(at offset: Int, in element: RangeStore.StyledRun) -> Int {
+        func index(at offset: Int, in element: RangeStore.StoredRun) -> Int {
             return offset
         }
     }

…or/RangeStore/RangeStore+StyledRun.swift …or/RangeStore/RangeStore+StoredRun.swiftSources/CodeEditSourceEditor/RangeStore/RangeStore+StyledRun.swift renamed to Sources/CodeEditSourceEditor/RangeStore/RangeStore+StoredRun.swift Sources/CodeEditSourceEditor/RangeStore/RangeStore+StyledRun.swift renamed to Sources/CodeEditSourceEditor/RangeStore/RangeStore+StoredRun.swift

@@ -1,18 +1,18 @@
 //
-//  RangeStore+StyledRun.swift
+//  RangeStore+StoredRun.swift
 //  CodeEditSourceEditor
 //
 //  Created by Khan Winter on 10/25/24
 
 import _RopeModule
 
 extension RangeStore {
-    struct StyledRun {
+    struct StoredRun {
         var length: Int
         let value: Element?
 
         static func empty(length: Int) -> Self {
-            StyledRun(length: length, value: nil)
+            StoredRun(length: length, value: nil)
         }
 
         /// Compare two styled ranges by their stored styles.
@@ -32,7 +32,7 @@ extension RangeStore {
     }
 }
 
-extension RangeStore.StyledRun: RopeElement {
+extension RangeStore.StoredRun: RopeElement {
     typealias Index = Int
 
     var summary: Summary { Summary(length: length) }
@@ -63,28 +63,28 @@ extension RangeStore.StyledRun: RopeElement {
     }
 }
 
-extension RangeStore.StyledRun {
+extension RangeStore.StoredRun {
     struct Summary {
         var length: Int
     }
 }
 
-extension RangeStore.StyledRun.Summary: RopeSummary {
+extension RangeStore.StoredRun.Summary: RopeSummary {
     // FIXME: This is entirely arbitrary. Benchmark this.
     @inline(__always)
     static var maxNodeSize: Int { 10 }
 
     @inline(__always)
-    static var zero: RangeStore.StyledRun.Summary { Self(length: 0) }
+    static var zero: RangeStore.StoredRun.Summary { Self(length: 0) }
 
     @inline(__always)
     var isZero: Bool { length == 0 }
 
-    mutating func add(_ other: RangeStore.StyledRun.Summary) {
+    mutating func add(_ other: RangeStore.StoredRun.Summary) {
         length += other.length
     }
 
-    mutating func subtract(_ other: RangeStore.StyledRun.Summary) {
+    mutating func subtract(_ other: RangeStore.StoredRun.Summary) {
         length -= other.length
     }
 }

Sources/CodeEditSourceEditor/RangeStore/RangeStore.swift

@@ -7,14 +7,16 @@
 
 import _RopeModule
 
-/// RangeStore is a container type that allows for setting and querying captures and modifiers for syntax
-/// highlighting. The container reflects a text document in that its length needs to be kept up-to-date.
+/// RangeStore is a container type that allows for setting and querying values for relative ranges in text. The
+/// container reflects a text document in that its length needs to be kept up-to-date. It can efficiently remove and
+/// replace subranges even for large documents. Provides helper methods for keeping some state in-sync with a text
+/// document's content.
 ///
 /// Internally this class uses a `Rope` from the swift-collections package, allowing for efficient updates and
 /// retrievals.
-struct RangeStore<Element: StyledRangeStoreElement>: Sendable {
-    typealias Run = StyledRangeStoreRun<Element>
-    typealias RopeType = Rope<StyledRun>
+struct RangeStore<Element: RangeStoreElement>: Sendable {
+    typealias Run = RangeStoreRun<Element>
+    typealias RopeType = Rope<StoredRun>
     typealias Index = RopeType.Index
     var _guts = RopeType()
 
@@ -27,7 +29,7 @@ struct RangeStore<Element: StyledRangeStoreElement>: Sendable {
     private var cache: (range: Range<Int>, runs: [Run])?
 
     init(documentLength: Int) {
-        self._guts = RopeType([StyledRun(length: documentLength, value: nil)])
+        self._guts = RopeType([StoredRun(length: documentLength, value: nil)])
     }
 
     // MARK: - Core
@@ -83,7 +85,7 @@ struct RangeStore<Element: StyledRangeStoreElement>: Sendable {
         _guts.replaceSubrange(
             range,
             in: OffsetMetric(),
-            with: runs.map { StyledRun(length: $0.length, value: $0.value) }
+            with: runs.map { StoredRun(length: $0.length, value: $0.value) }
         )
 
         coalesceNearby(range: range)

Sources/CodeEditSourceEditor/RangeStore/RangeStoreElement.swift

@@ -0,0 +1,12 @@
+//
+//  RangeStoreElement.swift
+//  CodeEditSourceEditor
+//
+//  Created by Khan Winter on 5/28/25.
+//
+
+protocol RangeStoreElement: Equatable, Hashable {
+    var isEmpty: Bool { get }
+    func combineLowerPriority(_ other: Self?) -> Self
+    func combineHigherPriority(_ other: Self?) -> Self
+}

Sources/CodeEditSourceEditor/RangeStore/RangeStoreRun.swift

@@ -1,43 +1,37 @@
 //
-//  StyledRangeStoreRun.swift
+//  RangeStoreRun.swift
 //  CodeEditSourceEditor
 //
 //  Created by Khan Winter on 11/4/24.
 //
 
-protocol StyledRangeStoreElement: Equatable, Hashable {
-    var isEmpty: Bool { get }
-    func combineLowerPriority(_ other: Self?) -> Self
-    func combineHigherPriority(_ other: Self?) -> Self
-}
-
 /// Consumer-facing value type for the stored values in this container.
-struct StyledRangeStoreRun<Element: StyledRangeStoreElement>: Equatable, Hashable {
+struct RangeStoreRun<Element: RangeStoreElement>: Equatable, Hashable {
     var length: Int
     var value: Element?
 
     static func empty(length: Int) -> Self {
-        StyledRangeStoreRun(length: length, value: nil)
+        RangeStoreRun(length: length, value: nil)
     }
 
     var isEmpty: Bool {
         value?.isEmpty ?? true
     }
 
-    mutating func combineLowerPriority(_ other: StyledRangeStoreRun) {
+    mutating func combineLowerPriority(_ other: RangeStoreRun) {
         value = value?.combineLowerPriority(other.value) ?? other.value
     }
 
-    mutating func combineHigherPriority(_ other: StyledRangeStoreRun) {
+    mutating func combineHigherPriority(_ other: RangeStoreRun) {
         value = value?.combineHigherPriority(other.value) ?? other.value
     }
 
-    mutating func subtractLength(_ other: borrowing StyledRangeStoreRun) {
+    mutating func subtractLength(_ other: borrowing RangeStoreRun) {
         self.length -= other.length
     }
 }
 
-extension StyledRangeStoreRun: CustomDebugStringConvertible {
+extension RangeStoreRun: CustomDebugStringConvertible {
     var debugDescription: String {
         if let value = value as? CustomDebugStringConvertible {
             "\(length) (\(value.debugDescription))"

Tests/CodeEditSourceEditorTests/Highlighting/StyledRangeContainerTests.swift

@@ -2,7 +2,7 @@ import XCTest
 @testable import CodeEditSourceEditor
 
 final class StyledRangeContainerTests: XCTestCase {
-    typealias Run = StyledRangeStoreRun<StyledRangeContainer.StyleElement>
+    typealias Run = RangeStoreRun<StyledRangeContainer.StyleElement>
 
     @MainActor
     func test_init() {