Make CursorPosition More Flexible

Author: thecoolwinter

Package.resolved

@@ -15,18 +15,30 @@ extension TextViewController {
         if isPostingCursorNotification { return }
         var newSelectedRanges: [NSRange] = []
         for position in positions {
-            let line = position.line
-            let column = position.column
-            guard (line > 0 && column > 0) || (position.range != .notFound) else { continue }
+            guard (position.start.isPositive && position.end?.isPositive ?? true)
+                    || (position.range != .notFound) else {
+                continue
+            }
 
             if position.range == .notFound {
                 if textView.textStorage.length == 0 {
                     // If the file is blank, automatically place the cursor in the first index.
                     newSelectedRanges.append(NSRange(location: 0, length: 0))
-                } else if let linePosition = textView.layoutManager.textLineForIndex(line - 1) {
+                } else if let linePosition = textView.layoutManager.textLineForIndex(position.start.line - 1) {
                     // If this is a valid line, set the new position
-                    let index = linePosition.range.lowerBound + min(linePosition.range.upperBound, column - 1)
-                    newSelectedRanges.append(NSRange(location: index, length: 0))
+                    let startCharacter = linePosition.range.lowerBound + min(
+                        linePosition.range.upperBound,
+                        position.start.column - 1
+                    )
+                    if let end = position.end, let endLine = textView.layoutManager.textLineForIndex(end.line - 1) {
+                        let endCharacter = endLine.range.lowerBound + min(
+                            endLine.range.upperBound,
+                            end.column - 1
+                        )
+                        newSelectedRanges.append(NSRange(start: startCharacter, end: endCharacter))
+                    } else {
+                        newSelectedRanges.append(NSRange(location: startCharacter, length: 0))
+                    }
                 }
             } else {
                 newSelectedRanges.append(position.range)
@@ -46,9 +58,20 @@ extension TextViewController {
             guard let linePosition = textView.layoutManager.textLineForOffset(selectedRange.range.location) else {
                 continue
             }
-            let column = (selectedRange.range.location - linePosition.range.location) + 1
-            let line = linePosition.index + 1
-            positions.append(CursorPosition(range: selectedRange.range, line: line, column: column))
+            let start = CursorPosition.Position(
+                line: linePosition.index + 1,
+                column: (selectedRange.range.location - linePosition.range.location) + 1
+            )
+            let end = if !selectedRange.range.isEmpty,
+                         let endPosition = textView.layoutManager.textLineForOffset(selectedRange.range.max) {
+                CursorPosition.Position(
+                    line: endPosition.index + 1,
+                    column: selectedRange.range.max - endPosition.range.location + 1
+                )
+            } else {
+                CursorPosition.Position?.none
+            }
+            positions.append(CursorPosition(range: selectedRange.range, start: start, end: end))
         }
 
         isPostingCursorNotification = true
@@ -66,26 +89,43 @@ extension TextViewController {
 
     /// Fills out all properties on the given cursor position if it's missing either the range or line/column
     /// information.
-    func resolveCursorPosition(_ position: CursorPosition) -> CursorPosition? {
+    public func resolveCursorPosition(_ position: CursorPosition) -> CursorPosition? {
         var range = position.range
         if range == .notFound {
-            guard position.line > 0, position.column > 0,
-                    let linePosition = textView.layoutManager.textLineForIndex(position.line - 1) else {
+            guard position.start.line > 0, position.start.column > 0,
+                    let linePosition = textView.layoutManager.textLineForIndex(position.start.line - 1) else {
                 return nil
             }
-            range = NSRange(location: linePosition.range.location + position.column, length: 0)
+            if let end = position.end, let endPosition = textView.layoutManager.textLineForIndex(end.line - 1) {
+                range = NSRange(
+                    location: linePosition.range.location + position.start.column,
+                    length: linePosition.range.max
+                )
+            } else {
+                range = NSRange(location: linePosition.range.location + position.start.column, length: 0)
+            }
         }
 
-        var line = position.line
-        var column = position.column
-        if position.line <= 0 || position.column <= 0 {
-            guard range != .notFound, let linePosition = textView.layoutManager.textLineForOffset(range.location) else {
-                return nil
-            }
-            column = (range.location - linePosition.range.location) + 1
-            line = linePosition.index + 1
+        var start: CursorPosition.Position
+        var end: CursorPosition.Position?
+
+        guard let startLinePosition = textView.layoutManager.textLineForOffset(range.location) else {
+            return nil
+        }
+
+        start = CursorPosition.Position(
+            line: startLinePosition.index + 1,
+            column: (range.location - startLinePosition.range.location) + 1
+        )
+
+        if !range.isEmpty {
+            guard let endLinePosition = textView.layoutManager.textLineForOffset(range.max) else { return nil }
+            end = CursorPosition.Position(
+                line: endLinePosition.index + 1,
+                column: (range.max - endLinePosition.range.location) + 1
+            )
         }
 
-        return CursorPosition(range: range, line: line, column: column)
+        return CursorPosition(range: range, start: start, end: end)
     }
 }

Sources/CodeEditSourceEditor/Controller/TextViewController+Cursor.swift

@@ -8,6 +8,6 @@
 import Foundation
 
 public protocol JumpToDefinitionDelegate: AnyObject {
-    func queryLinks(forRange range: NSRange) async -> [JumpToDefinitionLink]?
-    func openLink(url: URL, targetRange: NSRange)
+    func queryLinks(forRange range: NSRange, textView: TextViewController) async -> [JumpToDefinitionLink]?
+    func openLink(link: JumpToDefinitionLink)
 }

Sources/CodeEditSourceEditor/JumpToDefinition/JumpToDefinitionDelegate.swift

@@ -12,30 +12,30 @@ public struct JumpToDefinitionLink: Identifiable, Sendable, CodeSuggestionEntry
     public var id: String { url?.absoluteString ?? "\(targetRange)" }
     /// Leave as `nil` if the link is in the same document.
     public let url: URL?
-    public let targetPosition: CursorPosition?
-    public let targetRange: NSRange
+    public var targetPosition: CursorPosition? {
+        targetRange
+    }
+    public let targetRange: CursorPosition
 
     public let label: String
     public let sourcePreview: String?
 
     public let image: Image
     public let imageColor: Color
 
-    public var detail: String? { nil }
+    public var detail: String? { url?.lastPathComponent }
     public var pathComponents: [String]? { url?.pathComponents ?? [] }
     public var deprecated: Bool { false }
 
     public init(
         url: URL?,
-        targetPosition: CursorPosition,
-        targetRange: NSRange,
+        targetRange: CursorPosition,
         typeName: String,
         sourcePreview: String,
         image: Image = Image(systemName: "dot.square.fill"),
         imageColor: Color = Color(NSColor.lightGray)
     ) {
         self.url = url
-        self.targetPosition = targetPosition
         self.targetRange = targetRange
         self.label = typeName
         self.sourcePreview = sourcePreview

Sources/CodeEditSourceEditor/JumpToDefinition/JumpToDefinitionLink.swift

@@ -62,7 +62,8 @@ final class JumpToDefinitionModel {
         jumpRequestTask?.cancel()
         jumpRequestTask = Task {
             currentLinks = nil
-            guard let links = await delegate?.queryLinks(forRange: location),
+            guard let controller,
+                  let links = await delegate?.queryLinks(forRange: location, textView: controller),
                   !links.isEmpty else {
                 NSSound.beep()
                 if let textView {
@@ -72,10 +73,10 @@ final class JumpToDefinitionModel {
             }
             if links.count == 1 {
                 let link = links[0]
-                if let url = link.url {
-                    delegate?.openLink(url: url, targetRange: link.targetRange)
+                if link.url != nil {
+                    delegate?.openLink(link: link)
                 } else {
-                    textView?.selectionManager.setSelectedRange(link.targetRange)
+                    textView?.selectionManager.setSelectedRange(link.targetRange.range)
                 }
 
                 textView?.scrollSelectionToVisible()
@@ -106,8 +107,10 @@ final class JumpToDefinitionModel {
     // MARK: - Local Link
 
     private func openLocalLink(link: JumpToDefinitionLink) {
-        guard let controller = controller else { return }
-        controller.textView.selectionManager.setSelectedRange(link.targetRange)
+        guard let controller = controller, let range = controller.resolveCursorPosition(link.targetRange) else {
+            return
+        }
+        controller.textView.selectionManager.setSelectedRange(range.range)
         controller.textView.scrollSelectionToVisible()
     }
 
@@ -183,7 +186,7 @@ extension JumpToDefinitionModel: CodeSuggestionDelegate {
     ) {
         guard let link = item as? JumpToDefinitionLink else { return }
         if let url = link.url {
-            delegate?.openLink(url: url, targetRange: link.targetRange)
+            delegate?.openLink(link: link)
         } else {
             openLocalLink(link: link)
         }

Sources/CodeEditSourceEditor/JumpToDefinition/JumpToDefinitionModel.swift

@@ -17,6 +17,22 @@ import Foundation
 /// controller.
 /// 
 public struct CursorPosition: Sendable, Codable, Equatable, Hashable {
+    public struct Position: Sendable, Codable, Equatable, Hashable {
+        /// The line the cursor is located at. 1-indexed.
+        /// If ``CursorPosition/range`` is not empty, this is the line at the beginning of the selection.
+        public let line: Int
+        /// The column the cursor is located at. 1-indexed.
+        /// If ``CursorPosition/range`` is not empty, this is the column at the beginning of the selection.
+        public let column: Int
+
+        public init(line: Int, column: Int) {
+            self.line = line
+            self.column = column
+        }
+
+        var isPositive: Bool { line > 0 && column > 0 }
+    }
+
     /// Initialize a cursor position.
     ///
     /// When this initializer is used, ``CursorPosition/range`` will be initialized to `NSNotFound`.
@@ -28,8 +44,14 @@ public struct CursorPosition: Sendable, Codable, Equatable, Hashable {
     ///   - column: The column of the cursor position, 1-indexed.
     public init(line: Int, column: Int) {
         self.range = .notFound
-        self.line = line
-        self.column = column
+        self.start = Position(line: line, column: column)
+        self.end = nil
+    }
+
+    public init(start: Position, end: Position) {
+        self.range = .notFound
+        self.start = start
+        self.end = end
     }
 
     /// Initialize a cursor position.
@@ -41,27 +63,23 @@ public struct CursorPosition: Sendable, Codable, Equatable, Hashable {
     /// - Parameter range: The range of the cursor position.
     public init(range: NSRange) {
         self.range = range
-        self.line = -1
-        self.column = -1
+        self.start = Position(line: -1, column: -1)
+        self.end = nil
     }
 
     /// Private initializer.
     /// - Parameters:
     ///   - range: The range of the position.
-    ///   - line: The line of the position.
-    ///   - column: The column of the position.
-    package init(range: NSRange, line: Int, column: Int) {
+    ///   - start: The start position of the range.
+    ///   - end: The end position of the range.
+    package init(range: NSRange, start: Position, end: Position?) {
         self.range = range
-        self.line = line
-        self.column = column
+        self.start = start
+        self.end = end
     }
 
     /// The range of the selection.
     public let range: NSRange
-    /// The line the cursor is located at. 1-indexed.
-    /// If ``CursorPosition/range`` is not empty, this is the line at the beginning of the selection.
-    public let line: Int
-    /// The column the cursor is located at. 1-indexed.
-    /// If ``CursorPosition/range`` is not empty, this is the column at the beginning of the selection.
-    public let column: Int
+    public let start: Position
+    public let end: Position?
 }