Code Style, Add Docs, Clean Tests

Author: thecoolwinter

Sources/CodeEditSourceEditor/Enums/CaptureModifier.swift

@@ -7,6 +7,20 @@
 
 // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#semanticTokenModifiers
 
+/// A collection of possible syntax capture modifiers. Represented by an integer for memory efficiency, and with the
+/// ability to convert to and from strings for ease of use with tools.
+///
+/// These are useful for helping differentiate between similar types of syntax. Eg two variables may be declared like
+/// ```swift
+/// var a = 1
+/// let b = 1
+/// ```
+/// ``CaptureName`` will represent both these later in code, but combined ``CaptureModifier`` themes can differentiate
+/// between constants (`b` in the example) and regular variables (`a` in the example).
+///
+/// This is `Int8` raw representable for memory considerations. In large documents there can be *lots* of these created
+/// and passed around, so representing them with a single integer is preferable to a string to save memory.
+///
 public enum CaptureModifier: Int8, CaseIterable, Sendable {
     case declaration
     case definition
@@ -74,20 +88,7 @@ public enum CaptureModifier: Int8, CaseIterable, Sendable {
 }
 
 extension CaptureModifier: CustomDebugStringConvertible {
-    public var debugDescription: String {
-        switch self {
-        case .declaration: return "declaration"
-        case .definition: return "definition"
-        case .readonly: return "readonly"
-        case .static: return "static"
-        case .deprecated: return "deprecated"
-        case .abstract: return "abstract"
-        case .async: return "async"
-        case .modification: return "modification"
-        case .documentation: return "documentation"
-        case .defaultLibrary: return "defaultLibrary"
-        }
-    }
+    public var debugDescription: String { stringValue }
 }
 
 /// A set of capture modifiers, efficiently represented by a single integer.
@@ -112,9 +113,15 @@ public struct CaptureModifierSet: OptionSet, Equatable, Hashable, Sendable {
     /// All values in the set.
     public var values: [CaptureModifier] {
         var rawValue = self.rawValue
+
+        // This set is represented by an integer, where each `1` in the binary number represents a value.
+        // We can treat the index of the `1` as the raw value of a ``CaptureModifier`` (the index in 0b0100 would be 2).
+        // This loops through each `1` in the `rawValue`, finds the represented modifier, and 0's out the `1` so we can
+        // get the next one using the binary & operator (0b0110 -> 0b0100 -> 0b0000 -> finish).
         var values: [Int8] = []
         while rawValue > 0 {
             values.append(Int8(rawValue.trailingZeroBitCount))
+            // Clears the bit at the desired index (0b011 & 0b110 = 0b010 if clearing index 0)
             rawValue &= ~UInt(1 << rawValue.trailingZeroBitCount)
         }
         return values.compactMap({ CaptureModifier(rawValue: $0) })

Sources/CodeEditSourceEditor/Enums/CaptureName.swift

@@ -5,7 +5,8 @@
 //  Created by Lukas Pistrol on 16.08.22.
 //
 
-/// A collection of possible capture names for `tree-sitter` with their respected raw values.
+/// A collection of possible syntax capture types. Represented by an integer for memory efficiency, and with the
+/// ability to convert to and from strings for ease of use with tools.
 ///
 /// This is `Int8` raw representable for memory considerations. In large documents there can be *lots* of these created
 /// and passed around, so representing them with a single integer is preferable to a string to save memory.

Sources/CodeEditSourceEditor/Highlighting/HighlighProviding/HighlightProviderState.swift

@@ -40,10 +40,10 @@ class HighlightProviderState {
     /// 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
     /// after they are applied
-    private var pendingSet: IndexSet = .init()
+    private var pendingSet: IndexSet = IndexSet()
 
     /// The set of valid indexes
-    private var validSet: IndexSet = .init()
+    private var validSet: IndexSet = IndexSet()
 
     // MARK: - Providers
 

Sources/CodeEditSourceEditor/Highlighting/HighlightRange.swift

@@ -9,9 +9,9 @@ import Foundation
 
 /// This struct represents a range to highlight, as well as the capture name for syntax coloring.
 public struct HighlightRange: Sendable {
-    let range: NSRange
-    let capture: CaptureName?
-    let modifiers: CaptureModifierSet
+    public let range: NSRange
+    public let capture: CaptureName?
+    public let modifiers: CaptureModifierSet
 
     public init(range: NSRange, capture: CaptureName?, modifiers: CaptureModifierSet = []) {
         self.range = range

Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeContainer.swift

@@ -40,10 +40,10 @@ class StyledRangeContainer {
     ///
     /// - Parameter range: The range to query.
     /// - Returns: An array of continuous styled runs.
-    func runsIn(range: NSRange) -> [HighlightedRun] {
+    func runsIn(range: NSRange) -> [StyledRangeStoreRun] {
         // 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 runs: [StyledRangeStoreRun] = []
 
         var minValue = allRuns.compactMap { $0.last }.enumerated().min(by: { $0.1.length < $1.1.length })
 
@@ -98,7 +98,7 @@ extension StyledRangeContainer: HighlightProviderStateDelegate {
             assertionFailure("No storage found for the given provider: \(provider)")
             return
         }
-        var runs: [HighlightedRun] = []
+        var runs: [StyledRangeStoreRun] = []
         var lastIndex = rangeToHighlight.lowerBound
 
         for highlight in highlights {
@@ -108,7 +108,7 @@ extension StyledRangeContainer: HighlightProviderStateDelegate {
                 continue // Skip! Overlapping
             }
             runs.append(
-                HighlightedRun(
+                StyledRangeStoreRun(
                     length: highlight.range.length,
                     capture: highlight.capture,
                     modifiers: highlight.modifiers

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

@@ -13,7 +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 Run = StyledRangeStoreRun
     typealias Index = Rope<StyledRun>.Index
     var _guts = Rope<StyledRun>()
 

…er/StyledRangeStore/HighlightedRun.swift …yledRangeStore/StyledRangeStoreRun.swiftSources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeStore/HighlightedRun.swift renamed to Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeStore/StyledRangeStoreRun.swift Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeStore/HighlightedRun.swift renamed to Sources/CodeEditSourceEditor/Highlighting/StyledRangeContainer/StyledRangeStore/StyledRangeStoreRun.swift

@@ -1,42 +1,42 @@
 //
-//  HighlightedRun.swift
+//  StyledRangeStoreRun.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 {
+struct StyledRangeStoreRun: Equatable, Hashable {
     var length: Int
     var capture: CaptureName?
     var modifiers: CaptureModifierSet
 
     static func empty(length: Int) -> Self {
-        HighlightedRun(length: length, capture: nil, modifiers: [])
+        StyledRangeStoreRun(length: length, capture: nil, modifiers: [])
     }
 
     var isEmpty: Bool {
         capture == nil && modifiers.isEmpty
     }
 
-    mutating package func combineLowerPriority(_ other: borrowing HighlightedRun) {
+    mutating package func combineLowerPriority(_ other: borrowing StyledRangeStoreRun) {
         if self.capture == nil {
             self.capture = other.capture
         }
         self.modifiers.formUnion(other.modifiers)
     }
 
-    mutating package func combineHigherPriority(_ other: borrowing HighlightedRun) {
+    mutating package func combineHigherPriority(_ other: borrowing StyledRangeStoreRun) {
         self.capture = other.capture ?? self.capture
         self.modifiers.formUnion(other.modifiers)
     }
 
-    mutating package func subtractLength(_ other: borrowing HighlightedRun) {
+    mutating package func subtractLength(_ other: borrowing StyledRangeStoreRun) {
         self.length -= other.length
     }
 }
 
-extension HighlightedRun: CustomDebugStringConvertible {
+extension StyledRangeStoreRun: CustomDebugStringConvertible {
     var debugDescription: String {
         if isEmpty {
             "\(length) (empty)"

Tests/CodeEditSourceEditorTests/Highlighting/HighlightProviderStateTest.swift

@@ -22,12 +22,20 @@ class EmptyHighlightProviderStateDelegate: HighlightProviderStateDelegate {
 }
 
 final class HighlightProviderStateTest: XCTestCase {
+    var textView: TextView!
+    var rangeProvider: MockVisibleRangeProvider!
+    var delegate: EmptyHighlightProviderStateDelegate!
+
     @MainActor
-    func test_setup() {
-        let textView = Mock.textView()
-        let rangeProvider = MockVisibleRangeProvider(textView: textView)
-        let delegate = EmptyHighlightProviderStateDelegate()
+    override func setUp() async throws {
+        try await super.setUp()
+        textView = Mock.textView()
+        rangeProvider = MockVisibleRangeProvider(textView: textView)
+        delegate = EmptyHighlightProviderStateDelegate()
+    }
 
+    @MainActor
+    func test_setup() {
         let setUpExpectation = XCTestExpectation(description: "Set up called.")
 
         let mockProvider = Mock.highlightProvider(
@@ -52,10 +60,6 @@ final class HighlightProviderStateTest: XCTestCase {
 
     @MainActor
     func test_setLanguage() {
-        let textView = Mock.textView()
-        let rangeProvider = MockVisibleRangeProvider(textView: textView)
-        let delegate = EmptyHighlightProviderStateDelegate()
-
         let firstSetUpExpectation = XCTestExpectation(description: "Set up called.")
         let secondSetUpExpectation = XCTestExpectation(description: "Set up called.")
 
@@ -92,10 +96,6 @@ final class HighlightProviderStateTest: XCTestCase {
 
     @MainActor
     func test_storageUpdatedRangesPassedOn() {
-        let textView = Mock.textView()
-        let rangeProvider = MockVisibleRangeProvider(textView: textView)
-        let delegate = EmptyHighlightProviderStateDelegate()
-
         var updatedRanges: [(NSRange, Int)] = []
 
         let mockProvider = Mock.highlightProvider(

Tests/CodeEditSourceEditorTests/Highlighting/StyledRangeContainerTests.swift

@@ -2,7 +2,7 @@ import XCTest
 @testable import CodeEditSourceEditor
 
 final class StyledRangeContainerTests: XCTestCase {
-    typealias Run = HighlightedRun
+    typealias Run = StyledRangeStoreRun
 
     @MainActor
     func test_init() {
@@ -27,9 +27,9 @@ final class StyledRangeContainerTests: XCTestCase {
 
         XCTAssertNotNil(store._storage[providers[0]])
         XCTAssertEqual(store._storage[providers[0]]!.count, 3)
-        XCTAssertEqual(store._storage[providers[0]]!.runs(in: 0..<100)[0].capture, nil)
+        XCTAssertNil(store._storage[providers[0]]!.runs(in: 0..<100)[0].capture)
         XCTAssertEqual(store._storage[providers[0]]!.runs(in: 0..<100)[1].capture, .comment)
-        XCTAssertEqual(store._storage[providers[0]]!.runs(in: 0..<100)[2].capture, nil)
+        XCTAssertNil(store._storage[providers[0]]!.runs(in: 0..<100)[2].capture)
 
         XCTAssertEqual(
             store.runsIn(range: NSRange(location: 0, length: 100)),

Tests/CodeEditSourceEditorTests/Highlighting/StyledRangeStoreTests.swift

@@ -120,9 +120,9 @@ final class StyledRangeStoreTests: XCTestCase {
         XCTAssertEqual(runs[1].length, 5)
         XCTAssertEqual(runs[2].length, 50)
 
-        XCTAssertEqual(runs[0].capture, nil)
+        XCTAssertNil(runs[0].capture)
         XCTAssertEqual(runs[1].capture, .comment)
-        XCTAssertEqual(runs[2].capture, nil)
+        XCTAssertNil(runs[2].capture)
 
         XCTAssertEqual(runs[0].modifiers, [])
         XCTAssertEqual(runs[1].modifiers, [.static])
@@ -141,7 +141,7 @@ final class StyledRangeStoreTests: XCTestCase {
         XCTAssertEqual(runs[1].length, 50)
 
         XCTAssertEqual(runs[0].capture, .comment)
-        XCTAssertEqual(runs[1].capture, nil)
+        XCTAssertNil(runs[1].capture)
 
         XCTAssertEqual(runs[0].modifiers, [.static])
         XCTAssertEqual(runs[1].modifiers, [])