Marked Text, Remove Common Module, lineBreakStrategy

Author: thecoolwinter

Package.resolved

@@ -9,6 +9,15 @@
         "version" : "0.1.17"
       }
     },
+    {
+      "identity" : "mainoffender",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/mattmassicotte/MainOffender",
+      "state" : {
+        "revision" : "343cc3797618c29b48b037b4e2beea0664e75315",
+        "version" : "0.1.0"
+      }
+    },
     {
       "identity" : "rearrange",
       "kind" : "remoteSourceControl",
@@ -50,17 +59,17 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/ChimeHQ/TextFormation",
       "state" : {
-        "revision" : "158a603054ed5176f18d7c08ba355c0e05cb0586",
-        "version" : "0.7.0"
+        "revision" : "b4987856bc860643ac2c9cdbc7d5f3e9ade68377",
+        "version" : "0.8.1"
       }
     },
     {
       "identity" : "textstory",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/ChimeHQ/TextStory",
       "state" : {
-        "revision" : "b7b3fc551bd0177c32b3dc46d0478e9f0b6f8c6f",
-        "version" : "0.7.2"
+        "revision" : "8883fa739aa213e70e6cb109bfbf0a0b551e4cb5",
+        "version" : "0.8.0"
       }
     }
   ],

Package.swift

@@ -29,10 +29,15 @@ let package = Package(
             url: "https://github.com/lukepistrol/SwiftLintPlugin",
             from: "0.2.2"
         ),
-        // Filters for indentation, pair completion, whitespace
+        // Text mutation, storage helpers
+        .package(
+            url: "https://github.com/ChimeHQ/TextStory",
+            from: "0.8.0"
+        ),
+        // Rules for indentation, pair completion, whitespace
         .package(
             url: "https://github.com/ChimeHQ/TextFormation",
-            from: "0.7.0"
+            from: "0.8.1"
         ),
         // Useful data structures
         .package(
@@ -45,7 +50,6 @@ let package = Package(
         .target(
             name: "CodeEditTextView",
             dependencies: [
-                "Common",
                 "CodeEditInputView",
                 "CodeEditLanguages",
                 "TextFormation",
@@ -59,18 +63,8 @@ let package = Package(
         .target(
             name: "CodeEditInputView",
             dependencies: [
-                "Common",
-                "TextFormation"
-            ],
-            plugins: [
-                .plugin(name: "SwiftLint", package: "SwiftLintPlugin")
-            ]
-        ),
-
-        // Common classes and extensions used in both CodeEditTextView and CodeEditInputView
-        .target(
-            name: "Common",
-            dependencies: [
+                "TextStory",
+                "TextFormation",
                 .product(name: "Collections", package: "swift-collections")
             ],
             plugins: [

Sources/Common/Extensions/NSRange+isEmpty.swift renamed to Sources/CodeEditInputView/Extensions/NSRange+isEmpty.swift

@@ -29,7 +29,7 @@ class MarkedTextManager {
     func removeAll() {
         markedRanges.removeAll()
     }
-    
+
     /// Updates the stored marked ranges.
     /// - Parameters:
     ///   - insertLength: The length of the string being inserted.
@@ -50,7 +50,7 @@ class MarkedTextManager {
             markedRanges = [selectedRange]
         }
     }
-    
+
     /// Finds any marked ranges for a line and returns them.
     /// - Parameter lineRange: The range of the line.
     /// - Returns: A `MarkedRange` struct with information about attributes and ranges. `nil` if there is no marked
@@ -68,4 +68,31 @@ class MarkedTextManager {
             return MarkedRanges(ranges: ranges, attributes: attributes)
         }
     }
+
+    /// Updates marked text ranges for a new set of selections.
+    /// - Parameter textSelections: The new text selections.
+    /// - Returns: `True` if the marked text needs layout.
+    func updateForNewSelections(textSelections: [TextSelectionManager.TextSelection]) -> Bool {
+        // Ensure every marked range has a matching selection.
+        // If any marked ranges do not have a matching selection, unmark.
+        // Matching, in this context, means having a selection in the range location...max
+        var markedRanges = markedRanges
+        for textSelection in textSelections {
+            if let markedRangeIdx = markedRanges.firstIndex(where: {
+                ($0.location...$0.max).contains(textSelection.range.location)
+                && ($0.location...$0.max).contains(textSelection.range.max)
+            }) {
+                markedRanges.remove(at: markedRangeIdx)
+            } else {
+                return true
+            }
+        }
+
+        // If any remaining marked ranges, we need to unmark.
+        if !markedRanges.isEmpty {
+            return false
+        } else {
+            return true
+        }
+    }
 }

Sources/Common/Extensions/NSTextStorage+getLine.swift renamed to Sources/CodeEditInputView/Extensions/NSTextStorage+getLine.swift

@@ -6,7 +6,6 @@
 //
 
 import AppKit
-import Common
 
 // MARK: - Edits
 

Sources/Common/Extensions/PixelAligned.swift renamed to Sources/CodeEditInputView/Extensions/PixelAligned.swift

@@ -188,13 +188,17 @@ extension TextLayoutManager {
     /// - Parameter offset: The offset to ensure layout until.
     private func ensureLayoutFor(position: TextLineStorage<TextLine>.TextLinePosition) -> CGFloat {
         guard let textStorage else { return 0 }
-        position.data.prepareForDisplay(
+        let displayData = TextLine.DisplayData(
             maxWidth: maxLineLayoutWidth,
             lineHeightMultiplier: lineHeightMultiplier,
-            estimatedLineHeight: estimateLineHeight(),
+            estimatedLineHeight: estimateLineHeight()
+        )
+        position.data.prepareForDisplay(
+            displayData: displayData,
             range: position.range,
             stringRef: textStorage,
-            markedRanges: markedTextManager.markedRanges(in: position.range)
+            markedRanges: markedTextManager.markedRanges(in: position.range),
+            breakStrategy: lineBreakStrategy
         )
         var height: CGFloat = 0
         for fragmentPosition in position.data.lineFragments {

Sources/CodeEditInputView/MarkedTextManager/MarkedTextManager.swift

@@ -7,7 +7,6 @@
 
 import Foundation
 import AppKit
-import Common
 
 public protocol TextLayoutManagerDelegate: AnyObject {
     func layoutManagerHeightDidUpdate(newHeight: CGFloat)
@@ -48,10 +47,17 @@ public class TextLayoutManager: NSObject {
         lineStorage.count
     }
 
+    /// The strategy to use when breaking lines. Defaults to ``LineBreakStrategy/word``.
+    public var lineBreakStrategy: LineBreakStrategy = .word {
+        didSet {
+            setNeedsLayout()
+        }
+    }
+
     // MARK: - Internal
 
-    internal weak var textStorage: NSTextStorage?
-    internal var lineStorage: TextLineStorage<TextLine> = TextLineStorage()
+    weak var textStorage: NSTextStorage?
+    var lineStorage: TextLineStorage<TextLine> = TextLineStorage()
     var markedTextManager: MarkedTextManager = MarkedTextManager()
     private let viewReuseQueue: ViewReuseQueue<LineFragmentView, UUID> = ViewReuseQueue()
     private var visibleLineIds: Set<TextLine.ID> = []
@@ -63,7 +69,7 @@ public class TextLayoutManager: NSObject {
         transactionCounter > 0
     }
 
-    weak internal var layoutView: NSView?
+    weak var layoutView: NSView?
 
     /// The calculated maximum width of all laid out lines.
     /// - Note: This does not indicate *the* maximum width of the text view if all lines have not been laid out.
@@ -79,6 +85,13 @@ public class TextLayoutManager: NSObject {
         : .greatestFiniteMagnitude
     }
 
+    /// Contains all data required to perform layout on a text line.
+    private struct LineLayoutData {
+        let minY: CGFloat
+        let maxY: CGFloat
+        let maxWidth: CGFloat
+    }
+
     // MARK: - Init
 
     /// Initialize a text layout manager and prepare it for use.
@@ -124,7 +137,7 @@ public class TextLayoutManager: NSObject {
         print("Text Layout Manager built in: ", TimeInterval(nanos) / TimeInterval(NSEC_PER_MSEC), "ms")
         #endif
     }
-    
+
     /// Resets the layout manager to an initial state.
     internal func reset() {
         lineStorage.removeAll()
@@ -235,9 +248,7 @@ public class TextLayoutManager: NSObject {
                 let lineSize = layoutLine(
                     linePosition,
                     textStorage: textStorage,
-                    minY: linePosition.yPos,
-                    maxY: maxY,
-                    maxWidth: maxLineLayoutWidth,
+                    layoutData: LineLayoutData(minY: linePosition.yPos, maxY: maxY, maxWidth: maxLineLayoutWidth),
                     laidOutFragmentIDs: &usedFragmentIDs
                 )
                 if lineSize.height != linePosition.height {
@@ -297,19 +308,22 @@ public class TextLayoutManager: NSObject {
     private func layoutLine(
         _ position: TextLineStorage<TextLine>.TextLinePosition,
         textStorage: NSTextStorage,
-        minY: CGFloat,
-        maxY: CGFloat,
-        maxWidth: CGFloat,
+        layoutData: LineLayoutData,
         laidOutFragmentIDs: inout Set<UUID>
     ) -> CGSize {
+        let lineDisplayData = TextLine.DisplayData(
+            maxWidth: layoutData.maxWidth,
+            lineHeightMultiplier: lineHeightMultiplier,
+            estimatedLineHeight: estimateLineHeight()
+        )
+
         let line = position.data
         line.prepareForDisplay(
-            maxWidth: maxWidth,
-            lineHeightMultiplier: lineHeightMultiplier,
-            estimatedLineHeight: estimateLineHeight(),
+            displayData: lineDisplayData,
             range: position.range,
             stringRef: textStorage,
-            markedRanges: markedTextManager.markedRanges(in: position.range)
+            markedRanges: markedTextManager.markedRanges(in: position.range),
+            breakStrategy: lineBreakStrategy
         )
 
         if position.range.isEmpty {
@@ -323,7 +337,7 @@ public class TextLayoutManager: NSObject {
         for lineFragmentPosition in line.typesetter.lineFragments {
             let lineFragment = lineFragmentPosition.data
 
-            layoutFragmentView(for: lineFragmentPosition, at: minY + lineFragmentPosition.yPos)
+            layoutFragmentView(for: lineFragmentPosition, at: layoutData.minY + lineFragmentPosition.yPos)
 
             width = max(width, lineFragment.width)
             height += lineFragment.scaledHeight

Sources/CodeEditInputView/TextLayoutManager/TextLayoutManager+Edits.swift

@@ -5,7 +5,10 @@
 //  Created by Khan Winter on 9/19/23.
 //
 
+/// Options for breaking lines when they cannot fit in the viewport.
 public enum LineBreakStrategy {
+    /// Break lines at word boundaries when possible.
     case word
+    /// Break lines at the nearest character, regardless of grouping.
     case character
 }

Sources/CodeEditInputView/TextLayoutManager/TextLayoutManager+Public.swift

@@ -6,7 +6,6 @@
 //
 
 import AppKit
-import Common
 
 /// Displays a line fragment.
 final class LineFragmentView: NSView {

Sources/CodeEditInputView/TextLayoutManager/TextLayoutManager.swift

@@ -36,27 +36,24 @@ public final class TextLine: Identifiable, Equatable {
 
     /// Prepares the line for display, generating all potential line breaks and calculating the real height of the line.
     /// - Parameters:
-    ///   - maxWidth: The maximum width the line can be. Used to find line breaks.
-    ///   - lineHeightMultiplier: The multiplier to use for lines.
-    ///   - estimatedLineHeight: The estimated height for an empty line.
+    ///   - displayData: Information required to display a text line.
     ///   - range: The range this text range represents in the entire document.
     ///   - stringRef: A reference to the string storage for the document.
     ///   - markedRanges: Any marked ranges in the line.
+    ///   - breakStrategy: Determines how line breaks are calculated.
     func prepareForDisplay(
-        maxWidth: CGFloat,
-        lineHeightMultiplier: CGFloat,
-        estimatedLineHeight: CGFloat,
+        displayData: DisplayData,
         range: NSRange,
         stringRef: NSTextStorage,
-        markedRanges: MarkedTextManager.MarkedRanges?
+        markedRanges: MarkedTextManager.MarkedRanges?,
+        breakStrategy: LineBreakStrategy
     ) {
         let string = stringRef.attributedSubstring(from: range)
-        self.maxWidth = maxWidth
+        self.maxWidth = displayData.maxWidth
         typesetter.typeset(
             string,
-            maxWidth: maxWidth,
-            lineHeightMultiplier: lineHeightMultiplier,
-            estimatedLineHeight: estimatedLineHeight,
+            displayData: displayData,
+            breakStrategy: breakStrategy,
             markedRanges: markedRanges
         )
         needsLayout = false
@@ -65,4 +62,11 @@ public final class TextLine: Identifiable, Equatable {
     public static func == (lhs: TextLine, rhs: TextLine) -> Bool {
         lhs.id == rhs.id
     }
+
+    /// Contains all required data to perform a typeset and layout operation on a text line.
+    struct DisplayData {
+        let maxWidth: CGFloat
+        let lineHeightMultiplier: CGFloat
+        let estimatedLineHeight: CGFloat
+    }
 }

Sources/CodeEditInputView/TextLine/LineBreakStrategy.swift

@@ -19,9 +19,8 @@ final class Typesetter {
 
     func typeset(
         _ string: NSAttributedString,
-        maxWidth: CGFloat,
-        lineHeightMultiplier: CGFloat,
-        estimatedLineHeight: CGFloat,
+        displayData: TextLine.DisplayData,
+        breakStrategy: LineBreakStrategy,
         markedRanges: MarkedTextManager.MarkedRanges?
     ) {
         lineFragments.removeAll()
@@ -36,9 +35,10 @@ final class Typesetter {
         }
         self.typesetter = CTTypesetterCreateWithAttributedString(self.string)
         generateLines(
-            maxWidth: maxWidth,
-            lineHeightMultiplier: lineHeightMultiplier,
-            estimatedLineHeight: estimatedLineHeight
+            maxWidth: displayData.maxWidth,
+            lineHeightMultiplier: displayData.lineHeightMultiplier,
+            estimatedLineHeight: displayData.estimatedLineHeight,
+            breakStrategy: breakStrategy
         )
     }
 
@@ -49,7 +49,12 @@ final class Typesetter {
     ///   - maxWidth: The maximum width the line can be.
     ///   - lineHeightMultiplier: The multiplier to apply to an empty line's height.
     ///   - estimatedLineHeight: The estimated height of an empty line.
-    private func generateLines(maxWidth: CGFloat, lineHeightMultiplier: CGFloat, estimatedLineHeight: CGFloat) {
+    private func generateLines(
+        maxWidth: CGFloat,
+        lineHeightMultiplier: CGFloat,
+        estimatedLineHeight: CGFloat,
+        breakStrategy: LineBreakStrategy
+    ) {
         guard let typesetter else { return }
         var lines: [TextLineStorage<LineFragment>.BuildItem] = []
         var height: CGFloat = 0
@@ -69,7 +74,7 @@ final class Typesetter {
             while startIndex < string.length {
                 let lineBreak = suggestLineBreak(
                     using: typesetter,
-                    strategy: .word, // TODO: Make this configurable
+                    strategy: breakStrategy,
                     startingOffset: startIndex,
                     constrainingWidth: maxWidth
                 )

Sources/CodeEditInputView/TextLine/LineFragmentView.swift

@@ -6,7 +6,6 @@
 //
 
 import AppKit
-import Common
 
 extension TextLineStorage where Data == TextLine {
     /// Builds the line storage object from the given `NSTextStorage`.