Rename Box to Any

Author: thecoolwinter

Sources/CodeEditTextView/TextLayoutManager/TextAttachments/TextAttachment.swift

@@ -7,19 +7,24 @@
 
 import AppKit
 
-public struct TextAttachmentBox: Equatable {
+/// Type-erasing type for ``TextAttachment`` that also contains range information about the attachment.
+///
+/// This type cannot be initialized outside of `CodeEditTextView`, but will be received when interrogating
+/// the ``TextAttachmentManager``.
+public struct AnyTextAttachment: Equatable {
     var range: NSRange
     let attachment: any TextAttachment
 
     var width: CGFloat {
         attachment.width
     }
 
-    public static func == (_ lhs: TextAttachmentBox, _ rhs: TextAttachmentBox) -> Bool {
+    public static func == (_ lhs: AnyTextAttachment, _ rhs: AnyTextAttachment) -> Bool {
         lhs.range == rhs.range && lhs.attachment === rhs.attachment
     }
 }
 
+/// Represents an attachment type. Attachments take up some set width, and draw their contents in a receiver view.
 public protocol TextAttachment: AnyObject {
     var width: CGFloat { get }
     func draw(in context: CGContext, rect: NSRect)

Sources/CodeEditTextView/TextLayoutManager/TextAttachments/TextAttachmentManager.swift

@@ -13,16 +13,16 @@ import Foundation
 /// If two attachments are overlapping, the one placed further along in the document will be
 /// ignored when laying out attachments.
 public final class TextAttachmentManager {
-    private var orderedAttachments: [TextAttachmentBox] = []
+    private var orderedAttachments: [AnyTextAttachment] = []
     weak var layoutManager: TextLayoutManager?
 
-    /// Adds a new attachment box, keeping `orderedAttachments` sorted by range.location.
+    /// Adds a new attachment, keeping `orderedAttachments` sorted by range.location.
     /// If two attachments overlap, the layout phase will later ignore the one with the higher start.
     /// - Complexity: `O(n log(n))` due to array insertion. Could be improved with a binary tree.
     public func add(_ attachment: any TextAttachment, for range: NSRange) {
-        let box = TextAttachmentBox(range: range, attachment: attachment)
+        let attachment = AnyTextAttachment(range: range, attachment: attachment)
         let insertIndex = findInsertionIndex(for: range.location)
-        orderedAttachments.insert(box, at: insertIndex)
+        orderedAttachments.insert(attachment, at: insertIndex)
         layoutManager?.lineStorage.linesInRange(range).dropFirst().forEach {
             if $0.height != 0 {
                 layoutManager?.lineStorage.update(atOffset: $0.range.location, delta: 0, deltaHeight: -$0.height)
@@ -46,20 +46,20 @@ public final class TextAttachmentManager {
     /// Finds attachments starting in the given line range, and returns them as an array.
     /// Returned attachment's ranges will be relative to the _document_, not the line.
     /// - Complexity: `O(n log(n))`, ideally `O(log(n))`
-    public func get(startingIn range: NSRange) -> [TextAttachmentBox] {
-        var results: [TextAttachmentBox] = []
+    public func get(startingIn range: NSRange) -> [AnyTextAttachment] {
+        var results: [AnyTextAttachment] = []
         var idx = findInsertionIndex(for: range.location)
         while idx < orderedAttachments.count {
-            let box = orderedAttachments[idx]
-            let loc = box.range.location
+            let attachment = orderedAttachments[idx]
+            let loc = attachment.range.location
             if loc >= range.upperBound {
                 break
             }
             if range.contains(loc) {
-                if let lastResult = results.last, !lastResult.range.contains(box.range.location) {
-                    results.append(box)
+                if let lastResult = results.last, !lastResult.range.contains(attachment.range.location) {
+                    results.append(attachment)
                 } else if results.isEmpty {
-                    results.append(box)
+                    results.append(attachment)
                 }
             }
             idx += 1
@@ -70,25 +70,25 @@ public final class TextAttachmentManager {
     /// Returns all attachments whose ranges overlap the given query range.
     ///
     /// - Parameter query: The `NSRange` to test for overlap.
-    /// - Returns: An array of `TextAttachmentBox` instances whose ranges intersect `query`.
-    public func get(overlapping query: NSRange) -> [TextAttachmentBox] {
+    /// - Returns: An array of `AnyTextAttachment` instances whose ranges intersect `query`.
+    public func get(overlapping query: NSRange) -> [AnyTextAttachment] {
         // Find the first attachment whose end is beyond the start of the query.
         guard let startIdx = firstIndex(where: { $0.range.upperBound > query.location }) else {
             return []
         }
 
-        var results: [TextAttachmentBox] = []
+        var results: [AnyTextAttachment] = []
         var idx = startIdx
 
         // Collect every subsequent attachment that truly overlaps the query.
         while idx < orderedAttachments.count {
-            let box = orderedAttachments[idx]
-            if box.range.location >= query.upperBound {
+            let attachment = orderedAttachments[idx]
+            if attachment.range.location >= query.upperBound {
                 break
             }
-            if NSIntersectionRange(box.range, query).length > 0,
-               results.last?.range != box.range {
-                results.append(box)
+            if NSIntersectionRange(attachment.range, query).length > 0,
+               results.last?.range != attachment.range {
+                results.append(attachment)
             }
             idx += 1
         }
@@ -97,10 +97,10 @@ public final class TextAttachmentManager {
     }
 
     package func textUpdated(atOffset: Int, delta: Int) {
-        for (idx, box) in orderedAttachments.enumerated().reversed() {
-            if box.range.contains(atOffset) {
+        for (idx, attachment) in orderedAttachments.enumerated().reversed() {
+            if attachment.range.contains(atOffset) {
                 orderedAttachments.remove(at: idx)
-            } else if box.range.location > atOffset {
+            } else if attachment.range.location > atOffset {
                 orderedAttachments[idx].range.location += delta
             }
         }
@@ -115,7 +115,7 @@ private extension TextAttachmentManager {
     ///         If it returns `orderedAttachments.count`, no element satisfied
     ///         the predicate, but that’s still a valid insertion point.
     func lowerBoundIndex(
-        where predicate: (TextAttachmentBox) -> Bool
+        where predicate: (AnyTextAttachment) -> Bool
     ) -> Int {
         var low = 0
         var high = orderedAttachments.count
@@ -144,7 +144,7 @@ private extension TextAttachmentManager {
     /// - Parameter predicate: the query predicate.
     /// - Returns: the first matching index, or `nil` if none of the
     ///            attachments satisfy the predicate.
-    func firstIndex(where predicate: (TextAttachmentBox) -> Bool) -> Int? {
+    func firstIndex(where predicate: (AnyTextAttachment) -> Bool) -> Int? {
         let idx = lowerBoundIndex { predicate($0) }
         return idx < orderedAttachments.count ? idx : nil
     }

Sources/CodeEditTextView/TextLayoutManager/TextLayoutManagerRenderDelegate.swift

@@ -18,7 +18,7 @@ public protocol TextLayoutManagerRenderDelegate: AnyObject {
         range: NSRange,
         stringRef: NSTextStorage,
         markedRanges: MarkedRanges?,
-        attachments: [TextAttachmentBox]
+        attachments: [AnyTextAttachment]
     )
 
     func estimatedLineHeight() -> CGFloat?
@@ -35,7 +35,7 @@ public extension TextLayoutManagerRenderDelegate {
         range: NSRange,
         stringRef: NSTextStorage,
         markedRanges: MarkedRanges?,
-        attachments: [TextAttachmentBox]
+        attachments: [AnyTextAttachment]
     ) {
         textLine.prepareForDisplay(
             displayData: displayData,

Sources/CodeEditTextView/TextLine/LineFragment.swift

@@ -14,7 +14,7 @@ public final class LineFragment: Identifiable, Equatable {
     public struct FragmentContent: Equatable {
         public enum Content: Equatable {
             case text(line: CTLine)
-            case attachment(attachment: TextAttachmentBox)
+            case attachment(attachment: AnyTextAttachment)
         }
 
         let data: Content

Sources/CodeEditTextView/TextLine/TextLine.swift

@@ -54,7 +54,7 @@ public final class TextLine: Identifiable, Equatable {
         range: NSRange,
         stringRef: NSTextStorage,
         markedRanges: MarkedRanges?,
-        attachments: [TextAttachmentBox]
+        attachments: [AnyTextAttachment]
     ) {
         let string = stringRef.attributedSubstring(from: range)
         self.maxWidth = displayData.maxWidth

Sources/CodeEditTextView/TextLine/Typesetter/TypesetContext.swift

@@ -19,7 +19,7 @@ struct TypesetContext {
     /// Tracks the current position when laying out runs
     var currentPosition: Int = 0
 
-    mutating func appendAttachment(_ attachment: TextAttachmentBox) {
+    mutating func appendAttachment(_ attachment: AnyTextAttachment) {
         // Check if we can append this attachment to the current line
         if fragmentContext.width + attachment.width > displayData.maxWidth {
             popCurrentData()

Sources/CodeEditTextView/TextLine/Typesetter/Typesetter.swift

@@ -14,7 +14,7 @@ final public class Typesetter {
         let type: RunType
 
         enum RunType {
-            case attachment(TextAttachmentBox)
+            case attachment(AnyTextAttachment)
             case string(CTTypesetter)
         }
     }
@@ -32,7 +32,7 @@ final public class Typesetter {
         documentRange: NSRange,
         displayData: TextLine.DisplayData,
         markedRanges: MarkedRanges?,
-        attachments: [TextAttachmentBox] = []
+        attachments: [AnyTextAttachment] = []
     ) {
         makeString(string: string, markedRanges: markedRanges)
         lineFragments.removeAll()
@@ -69,7 +69,7 @@ final public class Typesetter {
     ///   - documentRange: The range in the string reference.
     ///   - attachments: Any text attachments overlapping the string reference.
     /// - Returns: A series of content runs making up this line.
-    func createContentRuns(documentRange: NSRange, attachments: [TextAttachmentBox]) -> [ContentRun] {
+    func createContentRuns(documentRange: NSRange, attachments: [AnyTextAttachment]) -> [ContentRun] {
         var attachments = attachments
         var currentPosition = 0
         let maxPosition = documentRange.length
@@ -118,7 +118,7 @@ final public class Typesetter {
     func typesetLineFragments(
         documentRange: NSRange,
         displayData: TextLine.DisplayData,
-        attachments: [TextAttachmentBox]
+        attachments: [AnyTextAttachment]
     ) -> (lines: [TextLineStorage<LineFragment>.BuildItem], maxHeight: CGFloat) {
         let contentRuns = createContentRuns(documentRange: documentRange, attachments: attachments)
         var context = TypesetContext(documentRange: documentRange, displayData: displayData)

Tests/CodeEditTextViewTests/LayoutManager/OverridingLayoutManagerRenderingTests.swift

@@ -19,7 +19,7 @@ class MockRenderDelegate: TextLayoutManagerRenderDelegate {
         range: NSRange,
         stringRef: NSTextStorage,
         markedRanges: MarkedRanges?,
-        attachments: [TextAttachmentBox]
+        attachments: [AnyTextAttachment]
     ) {
         prepareForDisplay?(
             textLine,

Tests/CodeEditTextViewTests/TypesetterTests.swift

@@ -156,7 +156,7 @@ class TypesetterTests: XCTestCase {
                 breakStrategy: .character
             ),
             markedRanges: nil,
-            attachments: [TextAttachmentBox(range: NSRange(location: 1, length: 1), attachment: attachment)]
+            attachments: [AnyTextAttachment(range: NSRange(location: 1, length: 1), attachment: attachment)]
         )
 
         XCTAssertEqual(typesetter.lineFragments.count, 1)
@@ -186,7 +186,7 @@ class TypesetterTests: XCTestCase {
                 breakStrategy: .character
             ),
             markedRanges: nil,
-            attachments: [TextAttachmentBox(range: NSRange(location: 0, length: 3), attachment: attachment)]
+            attachments: [AnyTextAttachment(range: NSRange(location: 0, length: 3), attachment: attachment)]
         )
 
         XCTAssertEqual(typesetter.lineFragments.count, 1)