Repository Public
1// ORIX Docs2// File: App/Sources/Document/Commands.swift3// Description: The editor's command set: one enum drives the main menu, contextual menus, toolbars and keyboard shortcuts.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import AppKit8import UniformTypeIdentifiers9import DocModel10import DocContainer11import DocLayout12import DocAutomation1314enum EditorCommand: String, CaseIterable {15 // Character16 case bold, italic, underline, strikethrough, superscript, `subscript`, smallCaps, clearFormatting, biggerText, smallerText17 // Paragraph18 case alignLeft, alignCenter, alignRight, alignJustify, bullets, numbering, multilevel, indent, outdent19 case styleBody, styleTitle, styleHeading1, styleHeading2, styleHeading3, styleQuote, styleCode20 // Insert21 case insertPageBreak, insertColumnBreak, insertSectionNextPage, insertSectionContinuous, insertFootnote, insertEndnote, insertEquation, insertLink22 case insertTable, insertImage, insertContents, insertListOfFigures, insertListOfTables, insertBibliography, insertCitation, insertCrossReference23 case insertFigureCaption, insertTableCaption, insertEquationNumber, insertPageNumber, insertPageCount, insertDate, insertComment, insertBookmark24 case insertRectangle, insertEllipse, insertCallout, insertArrow, insertLine25 case editHeader, editFooter, returnToBody26 // Table27 case rowAbove, rowBelow, columnLeft, columnRight, deleteRow, deleteColumn, deleteTable, mergeCells, splitCell, toggleHeaderRow, sortAscending, sortDescending, cellFormula, recalculate28 // Review29 case trackChanges, toggleMarkup, acceptChange, rejectChange, acceptAll, rejectAll, nextChange, previousChange, compare30 // View31 case modeWriting, modePageLayout, modeReview, modeAcademic, modePublishing, modeFocus32 case toggleSidebar, toggleInspector, toggleRuler, zoomIn, zoomOut, zoomActual, zoomFitWidth33 case find, findNext, findPrevious34 // File and tools35 case export, exportPDF, properties, audit, automation3637 var title: String {38 switch self {39 case .bold: return String(localized: "Bold")40 case .italic: return String(localized: "Italic")41 case .underline: return String(localized: "Underline")42 case .strikethrough: return String(localized: "Strikethrough")43 case .superscript: return String(localized: "Superscript")44 case .subscript: return String(localized: "Subscript")45 case .smallCaps: return String(localized: "Small Capitals")46 case .clearFormatting: return String(localized: "Clear Formatting")47 case .biggerText: return String(localized: "Bigger")48 case .smallerText: return String(localized: "Smaller")49 case .alignLeft: return String(localized: "Align Left")50 case .alignCenter: return String(localized: "Centre")51 case .alignRight: return String(localized: "Align Right")52 case .alignJustify: return String(localized: "Justify")53 case .bullets: return String(localized: "Bulleted List")54 case .numbering: return String(localized: "Numbered List")55 case .multilevel: return String(localized: "Multilevel List")56 case .indent: return String(localized: "Increase Indent")57 case .outdent: return String(localized: "Decrease Indent")58 case .styleBody: return String(localized: "Body")59 case .styleTitle: return String(localized: "Title")60 case .styleHeading1: return String(localized: "Heading 1")61 case .styleHeading2: return String(localized: "Heading 2")62 case .styleHeading3: return String(localized: "Heading 3")63 case .styleQuote: return String(localized: "Block Quote")64 case .styleCode: return String(localized: "Code Block")65 case .insertPageBreak: return String(localized: "Page Break")66 case .insertColumnBreak: return String(localized: "Column Break")67 case .insertSectionNextPage: return String(localized: "Section Break (Next Page)")68 case .insertSectionContinuous: return String(localized: "Section Break (Continuous)")69 case .insertFootnote: return String(localized: "Footnote")70 case .insertEndnote: return String(localized: "Endnote")71 case .insertEquation: return String(localized: "Equation…")72 case .insertLink: return String(localized: "Link…")73 case .insertTable: return String(localized: "Table…")74 case .insertImage: return String(localized: "Image…")75 case .insertContents: return String(localized: "Table of Contents")76 case .insertListOfFigures: return String(localized: "List of Figures")77 case .insertListOfTables: return String(localized: "List of Tables")78 case .insertBibliography: return String(localized: "Bibliography")79 case .insertCitation: return String(localized: "Citation…")80 case .insertCrossReference: return String(localized: "Cross-Reference…")81 case .insertFigureCaption: return String(localized: "Figure Caption")82 case .insertTableCaption: return String(localized: "Table Caption")83 case .insertEquationNumber: return String(localized: "Numbered Display Equation…")84 case .insertPageNumber: return String(localized: "Page Number")85 case .insertPageCount: return String(localized: "Page Count")86 case .insertDate: return String(localized: "Date")87 case .insertComment: return String(localized: "Comment")88 case .insertBookmark: return String(localized: "Bookmark")89 case .insertRectangle: return String(localized: "Rectangle")90 case .insertEllipse: return String(localized: "Ellipse")91 case .insertCallout: return String(localized: "Callout")92 case .insertArrow: return String(localized: "Arrow")93 case .insertLine: return String(localized: "Line")94 case .editHeader: return String(localized: "Edit Header")95 case .editFooter: return String(localized: "Edit Footer")96 case .returnToBody: return String(localized: "Return to Body Text")97 case .rowAbove: return String(localized: "Add Row Above")98 case .rowBelow: return String(localized: "Add Row Below")99 case .columnLeft: return String(localized: "Add Column Before")100 case .columnRight: return String(localized: "Add Column After")101 case .deleteRow: return String(localized: "Delete Rows")102 case .deleteColumn: return String(localized: "Delete Columns")103 case .deleteTable: return String(localized: "Delete Table")104 case .mergeCells: return String(localized: "Merge Cells")105 case .splitCell: return String(localized: "Split Cell")106 case .toggleHeaderRow: return String(localized: "Header Row")107 case .sortAscending: return String(localized: "Sort Ascending")108 case .sortDescending: return String(localized: "Sort Descending")109 case .cellFormula: return String(localized: "Cell Formula…")110 case .recalculate: return String(localized: "Recalculate Formulas")111 case .trackChanges: return String(localized: "Track Changes")112 case .toggleMarkup: return String(localized: "Show Markup")113 case .acceptChange: return String(localized: "Accept Change")114 case .rejectChange: return String(localized: "Reject Change")115 case .acceptAll: return String(localized: "Accept All Changes")116 case .rejectAll: return String(localized: "Reject All Changes")117 case .nextChange: return String(localized: "Next Change")118 case .previousChange: return String(localized: "Previous Change")119 case .compare: return String(localized: "Compare with Document…")120 case .modeWriting: return String(localized: "Writing")121 case .modePageLayout: return String(localized: "Page Layout")122 case .modeReview: return String(localized: "Review")123 case .modeAcademic: return String(localized: "Academic")124 case .modePublishing: return String(localized: "Publishing")125 case .modeFocus: return String(localized: "Focus")126 case .toggleSidebar: return String(localized: "Sidebar")127 case .toggleInspector: return String(localized: "Inspector")128 case .toggleRuler: return String(localized: "Ruler")129 case .zoomIn: return String(localized: "Zoom In")130 case .zoomOut: return String(localized: "Zoom Out")131 case .zoomActual: return String(localized: "Actual Size")132 case .zoomFitWidth: return String(localized: "Fit Width")133 case .find: return String(localized: "Find and Replace…")134 case .findNext: return String(localized: "Find Next")135 case .findPrevious: return String(localized: "Find Previous")136 case .export: return String(localized: "Export…")137 case .exportPDF: return String(localized: "Export as PDF…")138 case .properties: return String(localized: "Document Properties…")139 case .audit: return String(localized: "Audit Document")140 case .automation: return String(localized: "Workflows…")141 }142 }143144 /// Key equivalent and modifiers.145 var shortcut: (key: String, modifiers: NSEvent.ModifierFlags)? {146 switch self {147 case .bold: return ("b", .command)148 case .italic: return ("i", .command)149 case .underline: return ("u", .command)150 case .strikethrough: return ("x", [.command, .shift])151 case .superscript: return ("+", [.command, .control])152 case .subscript: return ("-", [.command, .control])153 case .biggerText: return ("+", .command)154 case .smallerText: return ("-", .command)155 case .alignLeft: return ("{", .command)156 case .alignCenter: return ("|", .command)157 case .alignRight: return ("}", .command)158 case .alignJustify: return ("j", [.command, .option])159 case .bullets: return ("8", [.command, .shift])160 case .numbering: return ("7", [.command, .shift])161 case .indent: return ("]", .command)162 case .outdent: return ("[", .command)163 case .styleBody: return ("0", [.command, .option])164 case .styleHeading1: return ("1", [.command, .option])165 case .styleHeading2: return ("2", [.command, .option])166 case .styleHeading3: return ("3", [.command, .option])167 case .insertPageBreak: return ("\r", .command)168 case .insertFootnote: return ("f", [.command, .option])169 case .insertEquation: return ("e", [.command, .option])170 case .insertLink: return ("k", .command)171 case .insertComment: return ("m", [.command, .option])172 case .insertCitation: return ("c", [.command, .option, .shift])173 case .insertTable: return ("t", [.command, .option])174 case .trackChanges: return ("e", [.command, .shift])175 case .modeWriting: return ("1", [.command, .control])176 case .modePageLayout: return ("2", [.command, .control])177 case .modeReview: return ("3", [.command, .control])178 case .modeAcademic: return ("4", [.command, .control])179 case .modePublishing: return ("5", [.command, .control])180 case .modeFocus: return ("6", [.command, .control])181 case .toggleSidebar: return ("s", [.command, .control])182 case .toggleInspector: return ("i", [.command, .option])183 case .toggleRuler: return ("r", .command)184 case .zoomIn: return (">", .command)185 case .zoomOut: return ("<", .command)186 case .zoomActual: return ("0", .command)187 case .find: return ("f", .command)188 case .findNext: return ("g", .command)189 case .findPrevious: return ("g", [.command, .shift])190 case .export: return ("e", [.command, .shift, .option])191 case .exportPDF: return ("p", [.command, .option])192 default: return nil193 }194 }195}196197extension DocumentSession {198 private var inTable: Bool { editor.tableSelection != nil }199200 func isEnabled(_ c: EditorCommand) -> Bool {201 switch c {202 case .rowAbove, .rowBelow, .columnLeft, .columnRight, .deleteRow, .deleteColumn, .deleteTable, .splitCell, .toggleHeaderRow, .sortAscending, .sortDescending, .cellFormula, .recalculate:203 return inTable204 case .mergeCells: if case .cells = editor.target { return true } else { return false }205 case .insertTable, .insertPageBreak, .insertColumnBreak, .insertSectionNextPage, .insertSectionContinuous, .insertContents, .insertListOfFigures,206 .insertListOfTables, .insertBibliography:207 return selection.story == .body && selection.head.path.cell == nil208 case .insertFootnote, .insertEndnote: return selection.story == .body209 case .insertLink, .insertComment: return true210 case .acceptChange, .rejectChange, .acceptAll, .rejectAll, .nextChange, .previousChange: return doc.hasTrackedChanges211 case .returnToBody: return selection.story != .body212 case .findNext, .findPrevious: return !findQuery.isEmpty213 default: return true214 }215 }216217 func isOn(_ c: EditorCommand) -> Bool {218 let ch = editor.currentCharacterFormat()219 let p = editor.currentParagraphFormat()220 switch c {221 case .bold: return ch.isBold222 case .italic: return ch.italic223 case .underline: return ch.underline224 case .strikethrough: return ch.strikethrough225 case .superscript: return ch.vertical == .superscript226 case .subscript: return ch.vertical == .subscript227 case .smallCaps: return ch.smallCaps228 case .alignLeft: return p.alignment == .left229 case .alignCenter: return p.alignment == .center230 case .alignRight: return p.alignment == .right231 case .alignJustify: return p.alignment == .justified232 case .bullets: return editor.currentParagraph()?.list.flatMap { doc.list($0.listID) }?.isBulleted == true233 case .numbering: return editor.currentParagraph()?.list.flatMap { doc.list($0.listID) }.map { !$0.isBulleted } ?? false234 case .trackChanges: return doc.settings.trackChanges235 case .toggleMarkup: return showMarkup236 case .toggleSidebar: return showSidebar237 case .toggleInspector: return showInspector238 case .toggleRuler: return showRuler239 case .modeWriting: return mode == .writing240 case .modePageLayout: return mode == .pageLayout241 case .modeReview: return mode == .review242 case .modeAcademic: return mode == .academic243 case .modePublishing: return mode == .publishing244 case .modeFocus: return mode == .focus245 case .toggleHeaderRow: return editor.currentTable?.rows.first?.isHeader ?? false246 case .styleBody: return editor.currentParagraph()?.style == StyleID.normal247 case .styleTitle: return editor.currentParagraph()?.style == StyleID.title248 case .styleHeading1: return editor.currentParagraph()?.style == StyleID.heading(1)249 case .styleHeading2: return editor.currentParagraph()?.style == StyleID.heading(2)250 case .styleHeading3: return editor.currentParagraph()?.style == StyleID.heading(3)251 default: return false252 }253 }254255 /// Commands offered in the contextual menu (nil = separator).256 func contextCommands() -> [EditorCommand?] {257 var out: [EditorCommand?] = [.insertComment, .insertLink, .insertFootnote]258 if inTable { out += [nil, .rowAbove, .rowBelow, .columnLeft, .columnRight, nil, .mergeCells, .splitCell, .cellFormula, nil, .deleteRow, .deleteColumn, .deleteTable] }259 if doc.hasTrackedChanges { out += [nil, .acceptChange, .rejectChange] }260 if selection.story != .body { out += [nil, .returnToBody] }261 return out262 }263264 private func setAlignment(_ a: TextAlignment) { perform(String(localized: "Alignment")) { $0.formatParagraphs { $0.props.alignment = a } } }265 private func setStyle(_ id: String) { perform(String(localized: "Apply Style")) { $0.setParagraphStyle(id) } }266267 var columnWidthAtCaret: Points {268 let setup = doc.setup(ofSection: currentSectionIndex)269 return setup.columnWidth270 }271272 func run(_ c: EditorCommand) {273 guard isEnabled(c) else { NSSound.beep(); return }274 switch c {275 case .bold: perform(c.title) { $0.toggle(.bold) }276 case .italic: perform(c.title) { $0.toggle(.italic) }277 case .underline: perform(c.title) { $0.toggle(.underline) }278 case .strikethrough: perform(c.title) { $0.toggle(.strikethrough) }279 case .superscript: perform(c.title) { $0.toggle(.superscript) }280 case .subscript: perform(c.title) { $0.toggle(.subscript) }281 case .smallCaps: perform(c.title) { $0.toggle(.smallCaps) }282 case .clearFormatting: perform(c.title) { e in e.clearCharacterFormatting(); e.formatParagraphs { $0.props = ParaProps() } }283 case .biggerText, .smallerText:284 let size = editor.currentCharacterFormat().fontSize285 perform(c.title, coalesce: "font-size") { $0.formatCharacters { $0.fontSize = max(4, min(400, size + (c == .biggerText ? 1 : -1))) } }286 case .alignLeft: setAlignment(.left)287 case .alignCenter: setAlignment(.center)288 case .alignRight: setAlignment(.right)289 case .alignJustify: setAlignment(.justified)290 case .bullets: perform(c.title) { $0.toggleList(.bulleted) }291 case .numbering: perform(c.title) { $0.toggleList(.numbered) }292 case .multilevel: perform(c.title) { $0.toggleList(.multilevel) }293 case .indent:294 perform(c.title) { e in if !e.changeListLevel(by: 1) { e.formatParagraphs { $0.props.indentLeft = min(432, ($0.props.indentLeft ?? 0) + 18) } } }295 case .outdent:296 perform(c.title) { e in if !e.changeListLevel(by: -1) { e.formatParagraphs { $0.props.indentLeft = max(0, ($0.props.indentLeft ?? 0) - 18) } } }297 case .styleBody: setStyle(StyleID.normal)298 case .styleTitle: setStyle(StyleID.title)299 case .styleHeading1: setStyle(StyleID.heading(1))300 case .styleHeading2: setStyle(StyleID.heading(2))301 case .styleHeading3: setStyle(StyleID.heading(3))302 case .styleQuote: setStyle(StyleID.quote)303 case .styleCode: setStyle(StyleID.code)304 case .insertPageBreak: perform(c.title) { $0.insertBlock(.pageBreak(BreakBlock(kind: .page))) }305 case .insertColumnBreak: perform(c.title) { $0.insertBlock(.pageBreak(BreakBlock(kind: .column))) }306 case .insertSectionNextPage, .insertSectionContinuous:307 let setup = doc.setup(ofSection: currentSectionIndex)308 perform(c.title) { $0.insertBlock(.sectionBreak(SectionBreak(kind: c == .insertSectionNextPage ? .nextPage : .continuous, setup: setup))) }309 case .insertFootnote, .insertEndnote:310 var noteID: String?311 perform(c.title) { noteID = $0.insertNote(c == .insertFootnote ? .footnote : .endnote) }312 if let id = noteID {313 activePage = layout.fragments(story: .note(id), path: ParaPath(block: 0)).first?.page314 select(Selection(story: .note(id), caret: Position(block: 0, offset: 0)))315 }316 case .insertEquation: activeSheet = .equation(existing: nil)317 case .insertEquationNumber: insertNumberedEquation()318 case .insertLink: activeSheet = .link319 case .insertTable: activeSheet = .insertTable320 case .insertImage: chooseImage()321 case .insertContents: perform(c.title) { $0.insertBlock(.toc(TOCBlock(kind: .contents, title: String(localized: "Contents")))) }322 case .insertListOfFigures: perform(c.title) { $0.insertBlock(.toc(TOCBlock(kind: .figures, title: String(localized: "List of Figures")))) }323 case .insertListOfTables: perform(c.title) { $0.insertBlock(.toc(TOCBlock(kind: .tables, title: String(localized: "List of Tables")))) }324 case .insertBibliography: perform(c.title) { $0.insertBlock(.bibliography(BibliographyBlock(title: String(localized: "References")))) }325 case .insertCitation: activeSheet = .citation326 case .insertCrossReference: activeSheet = .crossReference327 case .insertFigureCaption: insertCaption(sequence: "Figure", label: String(localized: "Figure"))328 case .insertTableCaption: insertCaption(sequence: "Table", label: String(localized: "Table"))329 case .insertPageNumber: perform(c.title) { $0.insertInline(.field(.pageNumber)) }330 case .insertPageCount: perform(c.title) { $0.insertInline(.field(.pageCount)) }331 case .insertDate:332 let format = doc.meta.language.hasPrefix("fr") ? "d MMMM yyyy" : "MMMM d, yyyy"333 perform(c.title) { $0.insertInline(.field(.date(format: format))) }334 case .insertComment:335 var id: String?336 perform(c.title) { id = $0.addComment("") }337 if id != nil { mode = mode == .focus ? .review : mode; sidebarTab = .review; showSidebar = true; pendingCommentFocus = id }338 case .insertBookmark:339 let name = "bookmark-" + DocID.make()340 perform(c.title) { $0.insertInline(.bookmark(name)) }341 case .insertRectangle: insertShape(.rectangle)342 case .insertEllipse: insertShape(.ellipse)343 case .insertCallout: insertShape(.callout)344 case .insertArrow: insertShape(.arrow)345 case .insertLine: insertShape(.line)346 case .editHeader, .editFooter: editHeaderFooter(header: c == .editHeader)347 case .returnToBody: returnToBody()348 case .rowAbove: perform(c.title) { $0.insertRow(below: false) }349 case .rowBelow: perform(c.title) { $0.insertRow(below: true) }350 case .columnLeft: perform(c.title) { $0.insertColumn(after: false) }351 case .columnRight: perform(c.title) { $0.insertColumn(after: true) }352 case .deleteRow: perform(c.title) { $0.deleteRows() }353 case .deleteColumn: perform(c.title) { $0.deleteColumns() }354 case .deleteTable: perform(c.title) { $0.deleteTable() }355 case .mergeCells: perform(c.title) { $0.mergeCells() }356 case .splitCell: perform(c.title) { $0.splitCell() }357 case .toggleHeaderRow: perform(c.title) { $0.mutateTable { t in if !t.rows.isEmpty { t.rows[0].isHeader.toggle() } } }358 case .sortAscending, .sortDescending:359 guard let sel = editor.tableSelection, let t = editor.currentTable else { return }360 let g = sel.columns.lowerBound361 let numeric = t.rows.filter { !$0.isHeader }.allSatisfy { row in362 DocumentEditor.cells(in: row, columns: g...g).first.map { TableFormula.number(from: row.cells[$0].plainText) != nil || row.cells[$0].plainText.isEmpty } ?? true363 }364 var ok = true365 perform(c.title) { ok = $0.sortRows(byGridColumn: g, ascending: c == .sortAscending, numeric: numeric) }366 if !ok { statusMessage = String(localized: "Tables with vertically merged cells cannot be sorted.") }367 case .cellFormula: activeSheet = .formula368 case .recalculate: perform(c.title) { $0.recalculateAllTables() }369 case .trackChanges: perform(c.title) { $0.doc.settings.trackChanges.toggle() }370 case .toggleMarkup: showMarkup.toggle()371 case .acceptChange, .rejectChange:372 let accept = c == .acceptChange373 // The change under the selection, otherwise the next one.374 let changes = doc.trackedChanges().filter { $0.story == selection.story }375 let s = selection.start, e = selection.end376 let hit = changes.first { $0.path == s.path && $0.range.lowerBound <= e.offset && $0.range.upperBound >= s.offset && (s.path == e.path) }377 if let hit {378 perform(c.title) { $0.resolveChanges(accept: accept, ids: [hit.revisionID]) }379 var e2 = editor; if e2.selectAdjacentChange(forward: true) != nil { select(e2.selection) }380 } else {381 var e2 = editor; if e2.selectAdjacentChange(forward: true) != nil { select(e2.selection) }382 }383 case .acceptAll: perform(c.title) { $0.resolveChanges(accept: true) }384 case .rejectAll: perform(c.title) { $0.resolveChanges(accept: false) }385 case .nextChange, .previousChange:386 var e2 = editor387 if let change = e2.selectAdjacentChange(forward: c == .nextChange) {388 if change.story != .body { activePage = layout.fragments(story: change.story, path: change.path).first?.page }389 select(e2.selection)390 }391 case .compare: activeSheet = .compare392 case .modeWriting: mode = .writing393 case .modePageLayout: mode = .pageLayout394 case .modeReview: mode = .review395 case .modeAcademic: mode = .academic396 case .modePublishing: mode = .publishing397 case .modeFocus: mode = mode == .focus ? .writing : .focus398 case .toggleSidebar: showSidebar.toggle()399 case .toggleInspector: showInspector.toggle()400 case .toggleRuler: showRuler.toggle()401 case .zoomIn: zoom = min(4, (zoom * 1.15 * 20).rounded() / 20)402 case .zoomOut: zoom = max(0.25, (zoom / 1.15 * 20).rounded() / 20)403 case .zoomActual: zoom = 1404 case .zoomFitWidth: if let z = canvas?.zoomToFitWidth() { zoom = z }405 case .find: sidebarTab = .search; showSidebar = true; focusFindField &+= 1406 case .findNext: findNext(forward: true)407 case .findPrevious: findNext(forward: false)408 case .export: activeSheet = .export409 case .exportPDF: exportInteractively(format: .pdf)410 case .properties: activeSheet = .properties411 case .audit: inspectorTab = .audit; showInspector = true; auditRequest &+= 1412 case .automation: activeSheet = .automation413 }414 }415416 // MARK: Helpers417418 func setEditorState(doc: DocumentModel, selection: Selection) {419 mutateEditor { e in e.doc = doc; e.selection = selection; e.sanitizeSelection() }420 }421422 func follow(link: String) {423 if link.hasPrefix("#") {424 let target = String(link.dropFirst())425 let id = numbering.bookmarks[target] ?? target426 revealBlock(id: id)427 } else if let url = URL(string: link), let scheme = url.scheme?.lowercased(), ["http", "https", "mailto"].contains(scheme) {428 NSWorkspace.shared.open(url)429 }430 }431432 func editHeaderFooter(header: Bool) {433 let page = currentPage434 guard layout.pages.indices.contains(page) else { return }435 let pg = layout.pages[page]436 let section = pg.sectionIndex437 var variant = pg.headerVariant438 let setup = doc.setup(ofSection: section)439 if variant == .even, (header ? setup.header.even : setup.footer.even).isEmpty { variant = .default }440 let story: StoryID = header ? .header(section: section, variant: variant) : .footer(section: section, variant: variant)441 if doc.blocks(in: story).isEmpty {442 // Create the first paragraph of the header or footer.443 perform(header ? String(localized: "Add Header") : String(localized: "Add Footer")) { e in444 e.doc.setBlocks([.paragraph(Paragraph(style: header ? StyleID.header : StyleID.footer))], in: story)445 }446 }447 activePage = page448 select(Selection(story: story, caret: Position(block: 0, offset: 0)))449 canvas?.window?.makeFirstResponder(canvas)450 }451452 func insertCaption(sequence: String, label: String) {453 perform(String(localized: "Insert Caption")) { e in454 if let p = e.currentParagraph(), !p.isEmpty {455 e.selection = Selection(story: e.selection.story, caret: Position(path: e.selection.head.path, offset: p.length))456 e.insertParagraphBreak()457 }458 e.setParagraphStyle(StyleID.caption)459 e.insertRuns([Run(label + "\u{00A0}", props: CharProps(bold: true)), Run(inline: .field(.sequence(sequence)), props: CharProps(bold: true)), Run(". ")])460 }461 }462463 func insertNumberedEquation() { activeSheet = .equation(existing: nil); pendingDisplayEquation = true }464465 /// Inserts an equation; display equations get their own centred paragraph, optionally numbered at the right margin.466 func insertEquation(latex: String, display: Bool, numbered: Bool) {467 let width = columnWidthAtCaret468 perform(String(localized: "Insert Equation")) { e in469 guard display else { e.insertInline(.equation(Equation(latex: latex, display: false))); return }470 if let p = e.currentParagraph(), !p.isEmpty {471 e.insertParagraphBreak()472 }473 e.setParagraphStyle(StyleID.normal)474 if numbered {475 e.formatParagraphs { $0.props = ParaProps(alignment: .left, firstLineIndent: 0, tabs: [TabStop(position: width / 2, kind: .center), TabStop(position: width - 0.5, kind: .right)]) }476 e.insertRuns([Run("\t"), Run(inline: .equation(Equation(latex: latex, display: true))), Run("\t("), Run(inline: .field(.sequence("Equation"))), Run(")")])477 } else {478 e.formatParagraphs { $0.props = ParaProps(alignment: .center, firstLineIndent: 0) }479 e.insertInline(.equation(Equation(latex: latex, display: true)))480 }481 e.insertParagraphBreak()482 e.formatParagraphs { $0.props = ParaProps() }483 }484 }485486 func insertShape(_ kind: ShapeObject.Kind) {487 let size: (Points, Points) = kind == .line || kind == .arrow ? (160, 14) : (kind == .callout ? (170, 80) : (150, 90))488 perform(String(localized: "Insert Shape")) { e in489 e.insertInline(.shape(ShapeObject(kind: kind, width: size.0, height: size.1, stroke: RGBA(hex: 0x4F46E5), strokeWidth: 1.25,490 fill: kind == .line || kind == .arrow ? nil : RGBA(hex: 0xEEF0FF))))491 // Select the new object so it can be resized or styled at once.492 let head = e.selection.head493 e.selection = Selection(story: e.selection.story, anchor: Position(path: head.path, offset: head.offset - 1), head: head)494 }495 inspectorTab = .object; showInspector = true496 }497498 func chooseImage() {499 let panel = NSOpenPanel()500 panel.allowedContentTypes = [.image, .pdf]501 panel.allowsMultipleSelection = true502 guard let window = canvas?.window else { return }503 panel.beginSheetModal(for: window) { [weak self] response in504 guard response == .OK else { return }505 for url in panel.urls { _ = self?.insertImage(from: url) }506 }507 }508509 @discardableResult510 func insertImage(from url: URL) -> Bool {511 guard let data = try? Data(contentsOf: url), data.count < 200 * 1024 * 1024 else { return false }512 let type = UTType(filenameExtension: url.pathExtension)513 let mime = type?.preferredMIMEType ?? "image/png"514 return insertImage(data: data, mimeType: mime, altText: "")515 }516517 @discardableResult518 func insertImage(data: Data, mimeType: String, altText: String = "") -> Bool {519 var size: CGSize?520 if mimeType == "application/pdf" {521 if let provider = CGDataProvider(data: data as CFData), let page = CGPDFDocument(provider)?.page(at: 1) { size = page.getBoxRect(.cropBox).size }522 } else {523 size = ImageStore.naturalSize(of: data)524 }525 guard var s = size, s.width > 0, s.height > 0 else { statusMessage = String(localized: "The image could not be read."); return false }526 let maxWidth = columnWidthAtCaret527 let setup = doc.setup(ofSection: currentSectionIndex)528 let maxHeight = max(72, setup.pageHeight - setup.margins.top - setup.margins.bottom - 60)529 let scale = min(1, maxWidth / s.width, maxHeight / s.height)530 s = CGSize(width: (s.width * scale).rounded(), height: (s.height * scale).rounded())531 perform(String(localized: "Insert Image")) { e in532 e.insertImage(data: data, mimeType: mimeType, width: s.width, height: s.height, altText: altText)533 let head = e.selection.head534 e.selection = Selection(story: e.selection.story, anchor: Position(path: head.path, offset: head.offset - 1), head: head)535 }536 return true537 }538539 /// Asks where to save, shows what the format cannot carry, then writes the file.540 func exportInteractively(format: DocFormat, pdfOptions: PDFOptions = PDFOptions()) {541 guard let window = canvas?.window else { return }542 let panel = NSSavePanel()543 panel.allowedContentTypes = [UTType(filenameExtension: format.fileExtension) ?? .data]544 let base = document?.displayName ?? (doc.meta.title.isEmpty ? String(localized: "Untitled") : doc.meta.title)545 panel.nameFieldStringValue = (base as NSString).deletingPathExtension + "." + format.fileExtension546 panel.canCreateDirectories = true547 let model = doc548 panel.beginSheetModal(for: window) { [weak self] response in549 guard response == .OK, let url = panel.url else { return }550 do {551 let warnings = try DocumentConverter.export(model, to: url, pdfOptions: pdfOptions)552 self?.statusMessage = warnings.isEmpty ? String(localized: "Exported to \(url.lastPathComponent)")553 : String(localized: "Exported to \(url.lastPathComponent) with \(warnings.count) notes")554 self?.lastExportWarnings = warnings555 } catch {556 let alert = NSAlert()557 alert.messageText = String(localized: "The document could not be exported.")558 alert.informativeText = "\(error)"559 alert.beginSheetModal(for: window)560 }561 }562 }563}564565/// A menu item bound to an editor command for a given session.566func commandMenuItem(_ command: EditorCommand, session: DocumentSession) -> NSMenuItem {567 let item = closureMenuItem(title: command.title) { [weak session] in session?.run(command) }568 item.isEnabled = session.isEnabled(command)569 item.state = session.isOn(command) ? .on : .off570 return item571}572