Repository Public
1import Foundation23/// A keyboard shortcut: one key plus modifiers. Stored as text such as `cmd+shift+p`.4public struct KeyChord: Hashable, Sendable, Codable, CustomStringConvertible {5 public struct Modifiers: OptionSet, Hashable, Sendable {6 public let rawValue: Int7 public init(rawValue: Int) { self.rawValue = rawValue }8 public static let command = Modifiers(rawValue: 1)9 public static let shift = Modifiers(rawValue: 2)10 public static let option = Modifiers(rawValue: 4)11 public static let control = Modifiers(rawValue: 8)12 }1314 /// Lower-case key: a character (`p`, `1`, `[`) or a name (`left`, `return`, `tab`, `space`, `escape`, `f5`…).15 public var key: String16 public var modifiers: Modifiers1718 public init(_ key: String, _ modifiers: Modifiers) {19 self.key = key.lowercased()20 self.modifiers = modifiers21 }2223 public static let namedKeys: Set<String> = ["left", "right", "up", "down", "return", "tab", "space", "escape", "delete",24 "home", "end", "pageup", "pagedown"]2526 /// Parses `cmd+shift+p`, `ctrl+opt+left`, `⌘⇧P`… Returns `nil` for an empty or key-less chord.27 public init?(_ text: String) {28 var modifiers: Modifiers = []29 var key: String?30 var remaining = text.trimmingCharacters(in: .whitespaces)31 let symbols: [(Character, Modifiers)] = [("⌘", .command), ("⇧", .shift), ("⌥", .option), ("⌃", .control)]32 while let first = remaining.first, let match = symbols.first(where: { $0.0 == first }) {33 modifiers.insert(match.1)34 remaining.removeFirst()35 }36 // "+" itself can be the key: "cmd++".37 var parts = remaining.split(separator: "+", omittingEmptySubsequences: false).map { String($0).lowercased() }38 if parts.count >= 2, parts.suffix(2).allSatisfy(\.isEmpty) { parts.removeLast(2); parts.append("+") }39 for part in parts where !part.isEmpty {40 switch part {41 case "cmd", "command": modifiers.insert(.command)42 case "shift": modifiers.insert(.shift)43 case "opt", "option", "alt": modifiers.insert(.option)44 case "ctrl", "control": modifiers.insert(.control)45 default:46 guard key == nil else { return nil }47 key = part48 }49 }50 guard let key, key.count == 1 || KeyChord.namedKeys.contains(key) || KeyChord.isFunctionKey(key) else { return nil }51 self.init(key, modifiers)52 }5354 static func isFunctionKey(_ key: String) -> Bool {55 guard key.hasPrefix("f"), let n = Int(key.dropFirst()) else { return false }56 return (1...20).contains(n)57 }5859 /// Canonical text form (`cmd+shift+p`).60 public var description: String {61 var parts: [String] = []62 if modifiers.contains(.control) { parts.append("ctrl") }63 if modifiers.contains(.option) { parts.append("opt") }64 if modifiers.contains(.shift) { parts.append("shift") }65 if modifiers.contains(.command) { parts.append("cmd") }66 parts.append(key)67 return parts.joined(separator: "+")68 }6970 /// Display form (`⌃⌥⇧⌘P`).71 public var symbolic: String {72 var text = ""73 if modifiers.contains(.control) { text += "⌃" }74 if modifiers.contains(.option) { text += "⌥" }75 if modifiers.contains(.shift) { text += "⇧" }76 if modifiers.contains(.command) { text += "⌘" }77 let names = ["left": "←", "right": "→", "up": "↑", "down": "↓", "return": "↩", "tab": "⇥", "space": "Space",78 "escape": "⎋", "delete": "⌫", "home": "↖", "end": "↘", "pageup": "⇞", "pagedown": "⇟"]79 return text + (names[key] ?? key.uppercased())80 }8182 public init(from decoder: Decoder) throws {83 let text = try decoder.singleValueContainer().decode(String.self)84 guard let chord = KeyChord(text) else {85 throw DecodingError.dataCorrupted(.init(codingPath: decoder.codingPath, debugDescription: "invalid shortcut \(text)"))86 }87 self = chord88 }89 public func encode(to encoder: Encoder) throws { var c = encoder.singleValueContainer(); try c.encode(description) }90}91