Repository Public
1// ORIX Docs2// File: App/Sources/Canvas/EditorCanvasView+Keyboard.swift3// Description: Keyboard input for the canvas: the text input client (typing, input methods, dictation) and the standard key-binding commands4// (caret movement, selection extension, deletion).5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import AppKit9import DocModel10import DocLayout1112extension EditorCanvasView: @preconcurrency NSTextInputClient {13 override func keyDown(with event: NSEvent) {14 NSCursor.setHiddenUntilMouseMoves(true)15 if inputContext?.handleEvent(event) != true { super.keyDown(with: event) }16 }1718 private var currentParagraph: Paragraph? { session.blocks.paragraph(at: session.selection.head.path) }1920 // MARK: NSTextInputClient — ranges are relative to the paragraph that holds the caret2122 func insertText(_ string: Any, replacementRange: NSRange) {23 let text = (string as? String) ?? (string as? NSAttributedString)?.string ?? ""24 let hadComposition = marked != nil25 if let m = marked {26 // Commit the composition: the provisional text is replaced by the final text as a single undo step.27 if let base = compositionBase { session.restoreForComposition(doc: base.doc, selection: base.selection) }28 marked = nil29 compositionBase = nil30 _ = m31 } else if replacementRange.location != NSNotFound, let p = currentParagraph, replacementRange.location + replacementRange.length <= p.length {32 let path = session.selection.head.path33 session.select(Selection(story: session.selection.story, anchor: Position(path: path, offset: replacementRange.location),34 head: Position(path: path, offset: replacementRange.location + replacementRange.length)), scroll: false)35 }36 guard !text.isEmpty else { if hadComposition { session.documentChanged() }; return }37 goalX = nil38 if text == "\n" || text == "\r" { session.perform(String(localized: "Typing")) { $0.insertParagraphBreak() }; return }39 if hadComposition { session.perform(String(localized: "Typing")) { $0.insertText(text) } } else { session.type(text) }40 }4142 func setMarkedText(_ string: Any, selectedRange: NSRange, replacementRange: NSRange) {43 let text = (string as? String) ?? (string as? NSAttributedString)?.string ?? ""44 if compositionBase == nil { compositionBase = (session.doc, session.selection) }45 guard let base = compositionBase else { return }46 // Rebuild from the state before the composition started, then insert the provisional text without recording undo.47 var editor = DocumentEditor(doc: base.doc, selection: base.selection, author: session.author)48 let tracking = editor.doc.settings.trackChanges49 editor.doc.settings.trackChanges = false50 if !editor.selection.isCaret { editor.deleteSelection() }51 let start = editor.selection.head52 editor.insertText(text.replacingOccurrences(of: "\n", with: " "))53 editor.doc.settings.trackChanges = tracking54 let length = (text as NSString).length55 if length == 0 {56 marked = nil57 compositionBase = nil58 session.restoreForComposition(doc: base.doc, selection: base.selection)59 session.documentChanged()60 return61 }62 marked = (editor.selection.story, start.path, start.offset..<(start.offset + length))63 let caret = Position(path: start.path, offset: start.offset + min(length, max(0, selectedRange.location)))64 session.applyComposition(doc: editor.doc, selection: Selection(story: editor.selection.story, caret: caret))65 }6667 func unmarkText() {68 guard marked != nil, let base = compositionBase else { return }69 // Keep what was composed: insert it again from the state before the composition, as one tracked, undoable step.70 var text = ""71 if let m = marked, let p = session.doc.blocks(in: m.story).paragraph(at: m.path) { text = p.plainText.utf16Substring(m.range) }72 marked = nil73 compositionBase = nil74 session.restoreForComposition(doc: base.doc, selection: base.selection)75 if text.isEmpty { session.documentChanged() } else { session.perform(String(localized: "Typing")) { $0.insertText(text) } }76 inputContext?.discardMarkedText()77 }7879 func selectedRange() -> NSRange {80 let s = session.selection81 guard s.start.path == s.end.path, currentParagraph != nil else { return NSRange(location: s.head.offset, length: 0) }82 return NSRange(location: s.start.offset, length: s.end.offset - s.start.offset)83 }8485 func markedRange() -> NSRange {86 guard let m = marked else { return NSRange(location: NSNotFound, length: 0) }87 return NSRange(location: m.range.lowerBound, length: m.range.count)88 }8990 func hasMarkedText() -> Bool { marked != nil }9192 func attributedSubstring(forProposedRange range: NSRange, actualRange: NSRangePointer?) -> NSAttributedString? {93 guard let p = currentParagraph else { return nil }94 let lo = max(0, min(p.length, range.location)), hi = max(lo, min(p.length, range.location + range.length))95 actualRange?.pointee = NSRange(location: lo, length: hi - lo)96 return NSAttributedString(string: p.plainText.utf16Substring(lo..<hi))97 }9899 func validAttributesForMarkedText() -> [NSAttributedString.Key] { [] }100101 func firstRect(forCharacterRange range: NSRange, actualRange: NSRangePointer?) -> NSRect {102 let path = session.selection.head.path103 let pos = Position(path: path, offset: range.location == NSNotFound ? session.selection.head.offset : range.location)104 guard let c = layout.caret(story: session.selection.story, position: pos, blocks: session.blocks, preferredPage: session.activePage), let window else { return .zero }105 let r = viewRect(page: c.page, rect: c.rect)106 return window.convertToScreen(convert(r, to: nil))107 }108109 func characterIndex(for point: NSPoint) -> Int {110 guard let window else { return NSNotFound }111 let local = convert(window.convertPoint(fromScreen: point), from: nil)112 guard let pp = pagePoint(local), let hit = layout.hitTest(page: pp.page, point: pp.point, restrictTo: session.selection.story),113 hit.position.path == session.selection.head.path else { return NSNotFound }114 return hit.position.offset115 }116117 // MARK: Key-binding commands118119 override func doCommand(by selector: Selector) {120 let name = NSStringFromSelector(selector)121 let keepGoal = name.hasPrefix("moveUp") || name.hasPrefix("moveDown") || name.hasPrefix("pageUp") || name.hasPrefix("pageDown") || name.hasPrefix("scrollPage")122 if !keepGoal { goalX = nil }123 if marked != nil, name != "insertNewline:" { unmarkText() }124 switch name {125 case "moveLeft:", "moveBackward:": horizontal(forward: false, extend: false, word: false)126 case "moveRight:", "moveForward:": horizontal(forward: true, extend: false, word: false)127 case "moveLeftAndModifySelection:", "moveBackwardAndModifySelection:": horizontal(forward: false, extend: true, word: false)128 case "moveRightAndModifySelection:", "moveForwardAndModifySelection:": horizontal(forward: true, extend: true, word: false)129 case "moveWordLeft:", "moveWordBackward:": horizontal(forward: false, extend: false, word: true)130 case "moveWordRight:", "moveWordForward:": horizontal(forward: true, extend: false, word: true)131 case "moveWordLeftAndModifySelection:", "moveWordBackwardAndModifySelection:": horizontal(forward: false, extend: true, word: true)132 case "moveWordRightAndModifySelection:", "moveWordForwardAndModifySelection:": horizontal(forward: true, extend: true, word: true)133 case "moveUp:": vertical(down: false, extend: false)134 case "moveDown:": vertical(down: true, extend: false)135 case "moveUpAndModifySelection:": vertical(down: false, extend: true)136 case "moveDownAndModifySelection:": vertical(down: true, extend: true)137 case "moveToBeginningOfLine:", "moveToLeftEndOfLine:": lineEdge(end: false, extend: false)138 case "moveToEndOfLine:", "moveToRightEndOfLine:": lineEdge(end: true, extend: false)139 case "moveToBeginningOfLineAndModifySelection:", "moveToLeftEndOfLineAndModifySelection:": lineEdge(end: false, extend: true)140 case "moveToEndOfLineAndModifySelection:", "moveToRightEndOfLineAndModifySelection:": lineEdge(end: true, extend: true)141 case "moveToBeginningOfParagraph:": paragraphEdge(end: false, extend: false)142 case "moveToEndOfParagraph:": paragraphEdge(end: true, extend: false)143 case "moveToBeginningOfParagraphAndModifySelection:", "moveParagraphBackwardAndModifySelection:": paragraphEdge(end: false, extend: true)144 case "moveToEndOfParagraphAndModifySelection:", "moveParagraphForwardAndModifySelection:": paragraphEdge(end: true, extend: true)145 case "moveToBeginningOfDocument:", "scrollToBeginningOfDocument:": documentEdge(end: false, extend: false)146 case "moveToEndOfDocument:", "scrollToEndOfDocument:": documentEdge(end: true, extend: false)147 case "moveToBeginningOfDocumentAndModifySelection:": documentEdge(end: false, extend: true)148 case "moveToEndOfDocumentAndModifySelection:": documentEdge(end: true, extend: true)149 case "pageUp:", "scrollPageUp:": page(down: false, extend: false)150 case "pageDown:", "scrollPageDown:": page(down: true, extend: false)151 case "pageUpAndModifySelection:": page(down: false, extend: true)152 case "pageDownAndModifySelection:": page(down: true, extend: true)153 case "deleteBackward:": session.perform(String(localized: "Delete"), coalesce: "delete") { $0.deleteBackward() }154 case "deleteForward:": session.perform(String(localized: "Delete"), coalesce: "delete") { $0.deleteForward() }155 case "deleteWordBackward:": session.perform(String(localized: "Delete")) { $0.deleteBackward(.word) }156 case "deleteWordForward:": session.perform(String(localized: "Delete")) { $0.deleteForward(.word) }157 case "deleteToBeginningOfLine:": deleteToLineEdge(end: false)158 case "deleteToEndOfLine:", "deleteToEndOfParagraph:": deleteToLineEdge(end: true)159 case "insertNewline:", "insertNewlineIgnoringFieldEditor:": session.perform(String(localized: "Typing")) { $0.insertParagraphBreak() }160 case "insertLineBreak:": session.perform(String(localized: "Typing")) { $0.insertLineBreak() }161 case "insertTab:", "insertTabIgnoringFieldEditor:":162 session.perform(String(localized: "Typing")) { e in163 if e.moveToAdjacentCell(backward: false) { return }164 if e.selection.isCaret, e.selection.head.offset == 0, e.changeListLevel(by: 1) { return }165 e.insertText("\t")166 }167 case "insertBacktab:":168 session.perform(String(localized: "Typing")) { e in169 if e.moveToAdjacentCell(backward: true) { return }170 e.changeListLevel(by: -1)171 }172 case "cancelOperation:": if session.selection.story != .body { session.returnToBody() } else if session.mode == .focus { session.mode = .writing }173 case "selectAll:": selectAll(nil)174 case "centerSelectionInVisibleArea:": scrollToCaret(center: true)175 default: break176 }177 }178179 // MARK: Movement180181 private func horizontal(forward: Bool, extend: Bool, word: Bool) {182 let sel = session.selection183 let blocks = session.blocks184 if !sel.isCaret && !extend {185 session.moveCaret(to: forward ? sel.end : sel.start, extending: false)186 return187 }188 var pos = sel.head189 if word, let p = blocks.paragraph(at: pos.path) {190 let text = p.plainText191 let target = forward ? text.wordBoundary(after: pos.offset) : text.wordBoundary(before: pos.offset)192 if target != pos.offset { session.moveCaret(to: Position(path: pos.path, offset: target), extending: extend); return }193 }194 if let next = forward ? DocumentEditor.position(after: pos, in: blocks) : DocumentEditor.position(before: pos, in: blocks) { pos = next }195 session.moveCaret(to: pos, extending: extend)196 }197198 private func vertical(down: Bool, extend: Bool) {199 let sel = session.selection200 guard let c = caretGeometry else { return }201 let x = goalX ?? c.rect.midX202 goalX = x203 if let r = layout.verticalMove(story: sel.story, from: sel.head, goalX: x, down: down, upstream: session.caretUpstream, preferredPage: session.activePage) {204 session.moveCaret(to: r.position, extending: extend, upstream: r.upstream)205 } else {206 // First or last line: go to the very start or end.207 let blocks = session.blocks208 session.moveCaret(to: down ? DocumentEditor.documentEnd(blocks) : DocumentEditor.firstPosition(inBlock: 0, blocks), extending: extend)209 }210 goalX = x211 }212213 private func lineEdge(end: Bool, extend: Bool) {214 let sel = session.selection215 guard let r = layout.lineRange(story: sel.story, position: sel.head, upstream: session.caretUpstream, preferredPage: session.activePage) else { return }216 session.moveCaret(to: Position(path: sel.head.path, offset: end ? r.upperBound : r.lowerBound), extending: extend, upstream: end)217 }218219 private func paragraphEdge(end: Bool, extend: Bool) {220 let sel = session.selection221 guard let p = session.blocks.paragraph(at: sel.head.path) else { return }222 session.moveCaret(to: Position(path: sel.head.path, offset: end ? p.length : 0), extending: extend)223 }224225 private func documentEdge(end: Bool, extend: Bool) {226 let blocks = session.blocks227 session.moveCaret(to: end ? DocumentEditor.documentEnd(blocks) : DocumentEditor.firstPosition(inBlock: 0, blocks), extending: extend)228 }229230 private func page(down: Bool, extend: Bool) {231 guard let c = caretGeometry else { return }232 let x = goalX ?? c.rect.midX233 let viewCaret = viewRect(page: c.page, rect: c.rect)234 let delta = max(60, visibleRect.height - 60) * (down ? 1 : -1)235 let target = CGPoint(x: viewRect(page: c.page, rect: CGRect(x: x, y: 0, width: 0, height: 0)).minX, y: min(max(viewCaret.midY + delta, 0), bounds.height - 1))236 if let pp = pagePoint(target), let hit = layout.hitTest(page: pp.page, point: pp.point, restrictTo: session.selection.story) {237 session.moveCaret(to: hit.position, extending: extend, upstream: hit.upstream)238 }239 goalX = x240 }241242 private func deleteToLineEdge(end: Bool) {243 let sel = session.selection244 guard sel.isCaret, let r = layout.lineRange(story: sel.story, position: sel.head, upstream: session.caretUpstream, preferredPage: session.activePage) else {245 session.perform(String(localized: "Delete")) { $0.deleteSelection() }246 return247 }248 let other = Position(path: sel.head.path, offset: end ? r.upperBound : r.lowerBound)249 session.perform(String(localized: "Delete")) { e in250 e.selection = Selection(story: sel.story, anchor: sel.head, head: other)251 e.deleteSelection()252 }253 }254}255256extension DocumentSession {257 /// Shows a provisional state while an input method composes text. Nothing is registered for undo.258 func applyComposition(doc: DocumentModel, selection: Selection) {259 setEditorState(doc: doc, selection: selection)260 relayout()261 canvas?.layoutChanged(scrollToCaret: true)262 }263264 func restoreForComposition(doc: DocumentModel, selection: Selection) {265 setEditorState(doc: doc, selection: selection)266 }267}268