Repository Public
1// ORIX Docs2// File: Packages/ORIXDocsKit/Sources/DocReview/FormatDescriptions.swift3// Description: Human-readable descriptions of formatting differences (character, paragraph, page setup, table) for the change list.4//5// Author: Simon-Pierre Boucher6// Contact: contact@spboucher.ai7import Foundation8import DocModel910enum FormatDescription {11 static func pt(_ v: Double) -> String {12 v == v.rounded() ? String(Int(v)) : String(format: "%.1f", v)13 }1415 private static func toggle(_ name: String, _ a: Bool, _ b: Bool, _ out: inout [String]) {16 if a != b { out.append(b ? "\(name) added" : "\(name) removed") }17 }1819 static func character(_ a: ResolvedChar, _ b: ResolvedChar) -> [String] {20 var out: [String] = []21 toggle("Bold", a.isBold, b.isBold, &out)22 if a.isBold == b.isBold && a.weight != b.weight { out.append("Font weight \(a.weight) → \(b.weight)") }23 toggle("Italic", a.italic, b.italic, &out)24 toggle("Underline", a.underline, b.underline, &out)25 toggle("Strikethrough", a.strikethrough, b.strikethrough, &out)26 if a.fontFamily != b.fontFamily { out.append("Font \(a.fontFamily) → \(b.fontFamily)") }27 if a.fontSize != b.fontSize { out.append("Font size \(pt(a.fontSize)) → \(pt(b.fontSize))") }28 if a.color != b.color { out.append("Colour #\(a.color.hexString) → #\(b.color.hexString)") }29 if a.highlight != b.highlight {30 out.append(b.highlight == nil ? "Highlight removed" : (a.highlight == nil ? "Highlight added" : "Highlight changed"))31 }32 if a.vertical != b.vertical { out.append("Position \(a.vertical.rawValue) → \(b.vertical.rawValue)") }33 toggle("Small caps", a.smallCaps, b.smallCaps, &out)34 toggle("All caps", a.allCaps, b.allCaps, &out)35 if a.link != b.link { out.append(b.link == nil ? "Link removed" : (a.link == nil ? "Link added" : "Link changed")) }36 if a.tracking != b.tracking { out.append("Character spacing \(pt(a.tracking)) → \(pt(b.tracking))") }37 if a.baselineShift != b.baselineShift { out.append("Baseline shift \(pt(a.baselineShift)) → \(pt(b.baselineShift))") }38 if a.language != b.language { out.append("Language \(a.language ?? "none") → \(b.language ?? "none")") }39 if a.kerning != b.kerning || a.ligatures != b.ligatures { out.append("Typographic features changed") }40 return out41 }4243 private static func spacing(_ s: LineSpacing) -> String {44 switch s {45 case .multiple(let m): return "×\(String(format: "%.2f", m))"46 case .exact(let p): return "exactly \(pt(p)) pt"47 case .atLeast(let p): return "at least \(pt(p)) pt"48 }49 }5051 static func paragraph(_ a: ResolvedPara, _ b: ResolvedPara) -> [String] {52 var out: [String] = []53 if a.alignment != b.alignment { out.append("Alignment \(a.alignment.rawValue) → \(b.alignment.rawValue)") }54 if a.indentLeft != b.indentLeft { out.append("Left indent \(pt(a.indentLeft)) → \(pt(b.indentLeft))") }55 if a.indentRight != b.indentRight { out.append("Right indent \(pt(a.indentRight)) → \(pt(b.indentRight))") }56 if a.firstLineIndent != b.firstLineIndent { out.append("First-line indent \(pt(a.firstLineIndent)) → \(pt(b.firstLineIndent))") }57 if a.spaceBefore != b.spaceBefore { out.append("Space before \(pt(a.spaceBefore)) → \(pt(b.spaceBefore))") }58 if a.spaceAfter != b.spaceAfter { out.append("Space after \(pt(a.spaceAfter)) → \(pt(b.spaceAfter))") }59 if a.lineSpacing != b.lineSpacing { out.append("Line spacing \(spacing(a.lineSpacing)) → \(spacing(b.lineSpacing))") }60 toggle("Keep with next", a.keepWithNext, b.keepWithNext, &out)61 toggle("Keep lines together", a.keepLinesTogether, b.keepLinesTogether, &out)62 toggle("Page break before", a.pageBreakBefore, b.pageBreakBefore, &out)63 toggle("Widow control", a.widowControl, b.widowControl, &out)64 if a.tabs != b.tabs { out.append("Tab stops changed") }65 toggle("Hyphenation", a.hyphenate, b.hyphenate, &out)66 if a.outlineLevel != b.outlineLevel { out.append("Outline level \(a.outlineLevel) → \(b.outlineLevel)") }67 if a.dropCapLines != b.dropCapLines { out.append("Drop cap \(a.dropCapLines) → \(b.dropCapLines) lines") }68 if a.shading != b.shading { out.append(b.shading == nil ? "Shading removed" : (a.shading == nil ? "Shading added" : "Shading changed")) }69 if a.borderTop != b.borderTop || a.borderBottom != b.borderBottom || a.borderLeft != b.borderLeft { out.append("Borders changed") }70 toggle("Right-to-left", a.rightToLeft, b.rightToLeft, &out)71 return out72 }7374 static func list(_ a: ListItem?, _ b: ListItem?) -> String? {75 switch (a, b) {76 case (nil, nil): return nil77 case (nil, _?): return "List added"78 case (_?, nil): return "List removed"79 case let (x?, y?):80 if x.level != y.level { return "List level \(x.level + 1) → \(y.level + 1)" }81 return nil82 }83 }8485 /// Page setup differences, headers and footers excluded (they are compared as text).86 static func setup(_ a: PageSetup, _ b: PageSetup) -> [String] {87 var out: [String] = []88 if a.paper != b.paper { out.append("Paper \(a.paper.name) → \(b.paper.name)") }89 if a.landscape != b.landscape { out.append("Orientation \(a.landscape ? "landscape" : "portrait") → \(b.landscape ? "landscape" : "portrait")") }90 if a.margins != b.margins {91 func m(_ i: Insets) -> String { "\(pt(i.top))/\(pt(i.left))/\(pt(i.bottom))/\(pt(i.right))" }92 out.append("Margins (top/left/bottom/right) \(m(a.margins)) → \(m(b.margins))")93 }94 if a.columns != b.columns { out.append("Columns \(a.columns) → \(b.columns)") }95 if a.columnGap != b.columnGap && (a.columns > 1 || b.columns > 1) { out.append("Column gap \(pt(a.columnGap)) → \(pt(b.columnGap))") }96 if a.columnRule != b.columnRule { out.append(b.columnRule ? "Column rule added" : "Column rule removed") }97 if a.headerDistance != b.headerDistance { out.append("Header distance \(pt(a.headerDistance)) → \(pt(b.headerDistance))") }98 if a.footerDistance != b.footerDistance { out.append("Footer distance \(pt(a.footerDistance)) → \(pt(b.footerDistance))") }99 if a.differentFirstPage != b.differentFirstPage { out.append(b.differentFirstPage ? "Different first page turned on" : "Different first page turned off") }100 if a.differentOddEven != b.differentOddEven { out.append(b.differentOddEven ? "Different odd and even pages turned on" : "Different odd and even pages turned off") }101 if a.pageNumberStart != b.pageNumberStart {102 out.append("Page numbering start \(a.pageNumberStart.map(String.init) ?? "continue") → \(b.pageNumberStart.map(String.init) ?? "continue")")103 }104 if a.pageNumberFormat != b.pageNumberFormat { out.append("Page number format \(a.pageNumberFormat.rawValue) → \(b.pageNumberFormat.rawValue)") }105 if a.border != b.border { out.append(b.border == nil ? "Page border removed" : (a.border == nil ? "Page border added" : "Page border changed")) }106 if a.background != b.background { out.append("Page background changed") }107 if a.watermark != b.watermark { out.append("Watermark \(a.watermark.map { "“\($0)”" } ?? "none") → \(b.watermark.map { "“\($0)”" } ?? "none")") }108 return out109 }110111 static func inlineObject(_ a: Inline, _ b: Inline) -> String? {112 switch (a, b) {113 case let (.image(x), .image(y)):114 var parts: [String] = []115 if x.altText != y.altText { parts.append("alternative text") }116 if x.crop != y.crop { parts.append("crop") }117 if x.rotation != y.rotation { parts.append("rotation") }118 if x.placement != y.placement { parts.append("placement") }119 return parts.isEmpty ? nil : "Image \(parts.joined(separator: ", ")) changed"120 case let (.shape(x), .shape(y)):121 return x == y ? nil : "Shape appearance changed"122 default: return nil123 }124 }125}126