Sources/OrgCore/Time/ReadDate.swift
308 lines · 16656 bytes
15 symbols in this file
1import Foundation
2
3/// Org's date prompt (`org-read-date-analyze`, Org 9.8.7) and the `parse-time-string` it uses,
4/// with `org-read-date-prefer-future` t. `now` and `defaultDate` stand in for the clock.
5public enum ReadDate {
6 public struct Answer: Sendable, Equatable {
7 public var year: Int, month: Int, day: Int, hour: Int, minute: Int
8 /// The answer included a time (`org-time-was-given`).
9 public var timeGiven: Bool
10 /// An end time such as `11:00`, from `10:00-11:00` (`org-end-time-was-given`).
11 public var endTime: String?
12
13 /// Normalized like `encode-time` (day 32 becomes the next month).
14 public func components(_ calendar: Calendar) -> DateComponents {
15 var components = DateComponents(year: year, month: month, day: 1, hour: 0, minute: 0)
16 let base = calendar.date(from: components)!
17 let date = calendar.date(byAdding: DateComponents(month: 0, day: day - 1, hour: hour, minute: minute), to: base)!
18 components = calendar.dateComponents([.year, .month, .day, .hour, .minute, .weekday], from: date)
19 return components
20 }
21 }
22
23 static let weekdays: [(String, Int)] = [
24 ("sun", 0), ("mon", 1), ("tue", 2), ("wed", 3), ("thu", 4), ("fri", 5), ("sat", 6),
25 ("sunday", 0), ("monday", 1), ("tuesday", 2), ("wednesday", 3), ("thursday", 4), ("friday", 5), ("saturday", 6),
26 ]
27 static let months: [(String, Int)] = [
28 ("jan", 1), ("feb", 2), ("mar", 3), ("apr", 4), ("may", 5), ("jun", 6), ("jul", 7), ("aug", 8), ("sep", 9),
29 ("oct", 10), ("nov", 11), ("dec", 12), ("january", 1), ("february", 2), ("march", 3), ("april", 4), ("june", 6),
30 ("july", 7), ("august", 8), ("september", 9), ("october", 10), ("november", 11), ("december", 12),
31 ]
32
33 enum Token: Equatable {
34 case number(Int)
35 case word(String)
36 }
37
38 /// `parse-time-tokenize` on the downcased string.
39 static func tokenize(_ string: String) -> [Token] {
40 let chars = Array(string.lowercased().unicodeScalars)
41 func kind(_ c: Unicode.Scalar) -> Character? {
42 switch c {
43 case "a"..."z": "a"
44 case "0"..."9": "0"
45 case "+", "-", ":": Character(c)
46 default: nil
47 }
48 }
49 var tokens: [Token] = []
50 var index = 0
51 while index < chars.count {
52 while index < chars.count, kind(chars[index]) == nil { index += 1 }
53 guard index < chars.count else { break }
54 let start = index
55 var digits = kind(chars[index]) == "0"
56 index += 1
57 while index < chars.count, let k = kind(chars[index]) {
58 digits = digits && k == "0"
59 index += 1
60 }
61 let text = String(String.UnicodeScalarView(chars[start..<index]))
62 tokens.append(digits ? .number(Int(text) ?? 0) : .word(text))
63 }
64 return tokens
65 }
66
67 /// `parse-time-string`'s fallback: (sec, min, hour, day, month, year, weekday).
68 static func parseTime(_ string: String) -> [Int?] {
69 var time: [Int?] = Array(repeating: nil, count: 9)
70 func digits(_ text: String, _ range: Range<Int>) -> Int? {
71 let chars = Array(text)
72 guard range.upperBound <= chars.count else { return nil }
73 return Int(String(chars[range]))
74 }
75 for token in tokenize(string) {
76 if time[6] == nil, case .word(let w) = token, let day = weekdays.first(where: { $0.0 == w }) {
77 time[6] = day.1
78 } else if time[3] == nil, case .number(let n) = token, (1...31).contains(n) {
79 time[3] = n
80 } else if time[4] == nil, case .word(let w) = token, let month = months.first(where: { $0.0 == w }) {
81 time[4] = month.1
82 } else if time[5] == nil, case .number(let n) = token, n >= 100 {
83 time[5] = n
84 } else if time[2] == nil, case .word(let w) = token, w.count == 8, Array(w)[2] == ":", Array(w)[5] == ":" {
85 (time[2], time[1], time[0]) = (digits(w, 0..<2), digits(w, 3..<5), digits(w, 6..<8))
86 } else if time[5] == nil, case .word(let w) = token, w.count == 10, Array(w)[4] == "-", Array(w)[7] == "-" {
87 (time[5], time[4], time[3]) = (digits(w, 0..<4), digits(w, 5..<7), digits(w, 8..<10))
88 } else if time[2] == nil, case .word(let w) = token, w.count == 5, Array(w)[2] == ":" {
89 (time[2], time[1], time[0]) = (digits(w, 0..<2), digits(w, 3..<5), 0)
90 } else if time[2] == nil, case .word(let w) = token, w.count == 4, Array(w)[1] == ":" {
91 (time[2], time[1], time[0]) = (digits(w, 0..<1), digits(w, 2..<4), 0)
92 } else if time[2] == nil, case .word(let w) = token, w.count == 7, Array(w)[1] == ":" {
93 (time[2], time[1], time[0]) = (digits(w, 0..<1), digits(w, 2..<4), digits(w, 5..<7))
94 } else if time[5] == nil, case .number(let n) = token, (50...110).contains(n) {
95 time[5] = 1900 + n
96 } else if time[5] == nil, case .number(let n) = token, (0...49).contains(n) {
97 time[5] = 2000 + n
98 }
99 }
100 return time
101 }
102
103 /// `org-small-year-to-year`.
104 static func smallYear(_ year: Int, currentYear: Int) -> Int {
105 guard year < 100 else { return year }
106 let century = currentYear / 100
107 let offset = year - currentYear % 100
108 if offset > 30 { return (century - 1) * 100 + year }
109 if offset > -70 { return century * 100 + year }
110 return (century + 1) * 100 + year
111 }
112
113 /// Replaces the first match of `pattern` in `string`, with `$n` group references.
114 private static func replaceFirst(_ string: inout String, _ match: NSTextCheckingResult, _ template: String) {
115 let ns = string as NSString
116 var result = ""
117 var chars = Array(template)
118 var i = 0
119 while i < chars.count {
120 if chars[i] == "\\", i + 1 < chars.count, let n = chars[i + 1].wholeNumberValue {
121 let range = match.range(at: n)
122 if range.location != NSNotFound { result += ns.substring(with: range) }
123 i += 2
124 } else {
125 result.append(chars[i])
126 i += 1
127 }
128 }
129 chars = []
130 string = ns.replacingCharacters(in: match.range, with: result)
131 }
132
133 private static func firstMatch(_ pattern: String, _ string: String, caseInsensitive: Bool = false) -> NSTextCheckingResult? {
134 let regex = try! NSRegularExpression(pattern: pattern, options: caseInsensitive ? [.caseInsensitive] : [])
135 return regex.firstMatch(in: string, range: NSRange(location: 0, length: (string as NSString).length))
136 }
137
138 private static func group(_ match: NSTextCheckingResult, _ i: Int, _ string: String) -> String? {
139 let range = match.range(at: i)
140 return range.location == NSNotFound ? nil : (string as NSString).substring(with: range)
141 }
142
143 /// `org-read-date-get-relative`: (shift, unit, relative to the default).
144 static func relative(_ string: String, today: DateComponents, default def: DateComponents) -> (Int, String, Bool, NSTextCheckingResult)? {
145 let names = weekdays.map(\.0).joined(separator: "|")
146 guard let match = firstMatch("^[ \\t]*([-+]{0,2})([0-9]+)?([hdwmy]|(" + names + "))?([ \\t]|$)", string, caseInsensitive: true) else { return nil }
147 let sign = group(match, 1, string) ?? ""
148 guard !sign.isEmpty || match.range(at: 4).location != NSNotFound else { return nil }
149 let direction: Character = sign.last ?? "+"
150 let relativeToDefault = sign.count == 2
151 let n = group(match, 2, string).flatMap { Int($0) } ?? 1
152 let what = group(match, 3, string) ?? "d"
153 let date = relativeToDefault ? def : today
154 if let target = weekdays.first(where: { $0.0 == what.lowercased() })?.1 {
155 let weekday = (date.weekday ?? 1) - 1
156 var delta = (7 + target - weekday) % 7
157 if delta == 0 { delta = 7 }
158 if direction == "-" {
159 delta -= 7
160 if delta == 0 { delta = -7 }
161 }
162 if n > 1 { delta += (n - 1) * (direction == "-" ? -7 : 7) }
163 return (delta, "d", relativeToDefault, match)
164 }
165 return (n * (direction == "-" ? -1 : 1), what, relativeToDefault, match)
166 }
167
168 /// `org-read-date`'s reading of a prompt answer: an empty one takes the default date.
169 public static func read(_ answer: String, default defaultDate: Date?, now: Date, calendar: Calendar) -> Answer {
170 let def = defaultDate ?? now
171 var input = answer
172 if input.trimmingCharacters(in: .whitespaces).isEmpty {
173 let c = calendar.dateComponents([.year, .month, .day], from: def)
174 input = String(format: "%04d-%02d-%02d", c.year!, c.month!, c.day!)
175 }
176 return analyze(input, default: def, now: now, calendar: calendar)
177 }
178
179 /// `org-read-date-analyze` with `org-read-date-prefer-future` t.
180 public static func analyze(_ input: String, default defaultDate: Date, now: Date, calendar: Calendar) -> Answer {
181 let units: Set<Calendar.Component> = [.year, .month, .day, .hour, .minute, .second, .weekday]
182 let def = calendar.dateComponents(units, from: defaultDate)
183 let today = calendar.dateComponents(units, from: now)
184 let currentYear = today.year!
185 var ans = input
186 if firstMatch("^[ \\t]*\\.[ \\t]*$", ans) != nil { ans = "+0" }
187 var delta: (Int, String, Bool)?
188 if let relative = relative(ans, today: today, default: def) {
189 delta = (relative.0, relative.1, relative.2)
190 ans = (ans as NSString).replacingCharacters(in: relative.3.range, with: "")
191 }
192 var isoYear: Int?, isoWeekday: Int?, isoWeek: Int?
193 if let match = firstMatch("\\b(?:([0-9]+)-)?[wW]([0-9]{1,2})(?:-([0-6]))?([ \\t]|$)", ans) {
194 isoYear = group(match, 1, ans).flatMap { Int($0) }.map { smallYear($0, currentYear: currentYear) }
195 isoWeekday = group(match, 3, ans).flatMap { Int($0) }
196 isoWeek = group(match, 2, ans).flatMap { Int($0) }
197 ans = (ans as NSString).replacingCharacters(in: match.range, with: "")
198 }
199 var killYear = false
200 if let match = firstMatch("^ *(([0-9]+)-)?([0-1]?[0-9])-([0-3]?[0-9])([^-0-9]|$)", ans) {
201 var year = group(match, 2, ans).flatMap { Int($0) } ?? { killYear = true; return currentYear }()
202 year = smallYear(year, currentYear: currentYear)
203 let month = Int(group(match, 3, ans)!)!, day = Int(group(match, 4, ans)!)!
204 replaceFirst(&ans, match, String(format: "%04d-%02d-%02d", year, month, day) + "\\5")
205 }
206 if let match = firstMatch("^ *(3[01]|0?[1-9]|[12][0-9])\\. ?(0?[1-9]|1[012])\\.( ?[1-9][0-9]{3})?", ans) {
207 let year = group(match, 3, ans).flatMap { Int($0.trimmingCharacters(in: .whitespaces)) } ?? { killYear = true; return currentYear }()
208 let day = Int(group(match, 1, ans)!)!, month = Int(group(match, 2, ans)!)!
209 replaceFirst(&ans, match, String(format: "%04d-%02d-%02d", year, month, day))
210 }
211 if let match = firstMatch("^ *(0?[1-9]|1[012])/(0?[1-9]|[12][0-9]|3[01])(/([0-9]+))?([^/0-9]|$)", ans) {
212 var year = group(match, 4, ans).flatMap { Int($0) } ?? { killYear = true; return currentYear }()
213 year = smallYear(year, currentYear: currentYear)
214 let month = Int(group(match, 1, ans)!)!, day = Int(group(match, 2, ans)!)!
215 replaceFirst(&ans, match, String(format: "%04d-%02d-%02d", year, month, day) + "\\5")
216 }
217 let plainTime = "(^|[^+])[012]?[0-9]:[0-9][0-9]([ \\t\\n]|$)"
218 for _ in 0..<2 where firstMatch(plainTime, ans) == nil {
219 guard let match = firstMatch("([012]?[0-9])(:([0-5][0-9]))?(am|AM|pm|PM)\\b", ans) else { break }
220 var hour = Int(group(match, 1, ans)!)!
221 let minute = group(match, 3, ans).flatMap { Int($0) } ?? 0
222 let pm = group(match, 4, ans)!.lowercased() == "pm"
223 if hour == 12, !pm { hour = 0 } else if pm, hour < 12 { hour += 12 }
224 ans = (ans as NSString).replacingCharacters(in: match.range, with: String(format: "%02d:%02d", hour, minute))
225 }
226 for _ in 0..<2 where firstMatch(plainTime, ans) == nil {
227 guard let match = firstMatch("(?:([012]?[0-9])?h([0-5][0-9]))|(?:([012]?[0-9])h([0-5][0-9])?)\\b", ans) else { break }
228 let hour = (group(match, 1, ans) ?? group(match, 3, ans)).flatMap { Int($0) } ?? 0
229 let minute = (group(match, 2, ans) ?? group(match, 4, ans)).flatMap { Int($0) } ?? 0
230 ans = (ans as NSString).replacingCharacters(in: match.range, with: String(format: "%02d:%02d", hour, minute))
231 }
232 if let match = firstMatch("([012]?[0-9]):([0-6][0-9])\\+([012]?[0-9])(:([0-5][0-9]))?", ans) {
233 let hour = Int(group(match, 1, ans)!)!, minute = Int(group(match, 2, ans)!)!
234 var h2 = hour + Int(group(match, 3, ans)!)!
235 var m2 = minute + (group(match, 5, ans).flatMap { Int($0) } ?? 0)
236 if m2 >= 60 { h2 += 1; m2 -= 60 }
237 ans = (ans as NSString).replacingCharacters(in: match.range, with: String(format: "%02d:%02d-%02d:%02d", hour, minute, h2, m2))
238 }
239 var timeGiven = false
240 var endTime: String?
241 let timeOfDay = "(\\b[012]?[0-9]((:([0-5][0-9]([AaPp][Mm])?))|([AaPp][Mm]))\\b)(--?(\\b[012]?[0-9]((:([0-5][0-9]([AaPp][Mm])?))|([AaPp][Mm]))\\b))?"
242 if let match = firstMatch(timeOfDay, ans), let end = group(match, 8, ans) {
243 endTime = end
244 let range = match.range(at: 7)
245 ans = (ans as NSString).replacingCharacters(in: range, with: "")
246 }
247 let tl = parseTime(ans)
248 var futurep = false
249 var day = tl[3] ?? def.day!
250 let month: Int
251 if let m = tl[4] {
252 month = m
253 } else if tl[3] != nil {
254 futurep = true
255 month = day < today.day! ? today.month! + 1 : today.month!
256 } else {
257 month = def.month!
258 }
259 var year: Int
260 if !killYear, let y = tl[5] {
261 year = y
262 } else if futurep {
263 year = (month > today.month! || day >= today.day!) ? today.year! : today.year! + 1
264 } else if tl[4] != nil {
265 futurep = true
266 if month > today.month! { year = today.year! } else if month < today.month! { year = today.year! + 1 } else if day < today.day! { year = today.year! + 1 } else { year = today.year! }
267 } else {
268 year = def.year!
269 }
270 var month2 = month
271 var hour = tl[2] ?? def.hour!
272 let minute = tl[1] ?? def.minute!
273 var wday = tl[6]
274 if let isoWeek {
275 let isoYearValue = isoYear ?? year
276 let weekday = isoWeekday ?? wday ?? 1
277 wday = nil
278 var iso = Calendar(identifier: .iso8601)
279 iso.timeZone = calendar.timeZone
280 let isoComponents = DateComponents(weekday: weekday == 0 ? 1 : weekday + 1, weekOfYear: isoWeek, yearForWeekOfYear: isoYearValue)
281 if let date = iso.date(from: isoComponents) {
282 let c = iso.dateComponents([.year, .month, .day], from: date)
283 (year, month2, day) = (c.year!, c.month!, c.day!)
284 }
285 } else if let (n, unit, relativeToDefault) = delta {
286 if !relativeToDefault { (day, month2, year) = (today.day!, today.month!, today.year!) }
287 switch unit.lowercased() {
288 case "h", "":
289 timeGiven = true
290 hour += n
291 case "d": day += n
292 case "w": day += 7 * n
293 case "m": month2 += n
294 case "y": year += n
295 default: break
296 }
297 } else if let target = wday, tl[3] == nil {
298 let base = calendar.date(from: DateComponents(year: year, month: month2, day: 1))!
299 let date = calendar.date(byAdding: .day, value: day - 1, to: base)!
300 let current = calendar.component(.weekday, from: date) - 1
301 if target != current { day += ((target - current + 7) % 7 + 7) % 7 }
302 }
303 if tl[2] != nil { timeGiven = true }
304 if year < 100 { year += 2000 }
305 _ = futurep
306 return Answer(year: year, month: month2, day: day, hour: hour, minute: minute, timeGiven: timeGiven, endTime: endTime)
307 }
308}