1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#if canImport(FoundationEssentials)
import FoundationEssentials
#endif
internal import _FoundationICU
typealias CalendarComponentAndValue = (component: Calendar.Component, value: Int)
extension Date {
@available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *)
public struct RelativeFormatStyle : Codable, Hashable, Sendable {
@available(FoundationPreview 0.4, *)
public typealias Field = Date.ComponentsFormatStyle.Field
public struct UnitsStyle : Codable, Hashable, Sendable {
enum Option : Int, Codable, Hashable {
case wide
case spellOut
case abbreviated
case narrow
}
var option: Option
// ICURelativeDateFormatter compatibility
var icuNumberFormatStyle: UNumberFormatStyle? {
switch self.option {
case .spellOut:
return .spellout
case .wide:
return nil
case .abbreviated:
return nil
case .narrow:
return nil
}
}
var icuRelativeDateStyle: UDateRelativeDateTimeFormatterStyle {
switch self.option {
case .spellOut:
return .long
case .wide:
return .long
case .abbreviated:
return .short
case .narrow:
return .narrow
}
}
/// "2 months ago", "next Wednesday"
public static var wide: Self { .init(option: .wide) }
/// "two months ago", "next Wednesday"
public static var spellOut: Self { .init(option: .spellOut) }
/// "2 mo. ago", "next Wed."
public static var abbreviated: Self { .init(option: .abbreviated) }
/// "2 mo. ago", "next W"
public static var narrow: Self { .init(option: .narrow) }
}
public struct Presentation : Codable, Hashable, Sendable {
enum Option : Int, Codable, Hashable {
case numeric
case named
}
var option: Option
/// "1 day ago", "2 days ago", "1 week ago", "in 1 week"
public static var numeric: Self { .init(option: .numeric) }
/// "yesterday", "2 days ago", "last week", "next week"; falls back to the numeric style if no name is available.
public static var named: Self { .init(option: .named) }
}
public var presentation: Presentation
public var unitsStyle: UnitsStyle
public var capitalizationContext: FormatStyleCapitalizationContext
public var locale: Locale
public var calendar: Calendar
/// The fields that can be used in the formatted output.
@available(FoundationPreview 0.4, *)
public var allowedFields: Set<Field> {
get {
_allowedFields
}
set {
_allowedFields = newValue
}
}
var _allowedFields: Set<Date.ComponentsFormatStyle.Field>
private enum CodingKeys: String, CodingKey {
case presentation
case unitsStyle
case capitalizationContext
case locale
case calendar
case _allowedFields = "allowedFields"
}
public init(presentation: Presentation = .numeric, unitsStyle: UnitsStyle = .wide, locale: Locale = .autoupdatingCurrent, calendar: Calendar = .autoupdatingCurrent, capitalizationContext: FormatStyleCapitalizationContext = .unknown) {
self.presentation = presentation
self.unitsStyle = unitsStyle
self.capitalizationContext = capitalizationContext
self.locale = locale
self.calendar = calendar
self._allowedFields = Set(Date.ComponentsFormatStyle.Field.Option.allCases.map { .init(option: $0) })
}
@available(FoundationPreview 0.4, *)
public init(allowedFields: Set<Field>, presentation: Presentation = .numeric, unitsStyle: UnitsStyle = .wide, locale: Locale = .autoupdatingCurrent, calendar: Calendar = .autoupdatingCurrent, capitalizationContext: FormatStyleCapitalizationContext = .unknown) {
self.presentation = presentation
self.unitsStyle = unitsStyle
self.capitalizationContext = capitalizationContext
self.locale = locale
self.calendar = calendar
self._allowedFields = allowedFields
}
// MARK: - FormatStyle conformance
public func format(_ destDate: Date) -> String {
return _format(destDate, refDate: Date.now)
}
public func locale(_ locale: Locale) -> Self {
var new = self
new.locale = locale
return new
}
enum ComponentAdjustmentStrategy : Codable, Hashable {
case alignedWithComponentBoundary
case rounded
}
var componentAdjustmentStrategy: ComponentAdjustmentStrategy {
switch presentation.option {
case .numeric:
return .rounded
case .named:
return .alignedWithComponentBoundary
}
}
var sortedAllowedComponents: [Calendar.Component] {
ICURelativeDateFormatter.sortedAllowedComponents.filter({ component in
guard let field = Date.ComponentsFormatStyle.Field.Option(component: component) else {
return false
}
return _allowedFields.contains(.init(option: field))
})
}
internal func _format(_ destDate: Date, refDate: Date) -> String {
guard let (component, value) = _largestNonZeroComponent(destDate, reference: refDate, adjustComponent: componentAdjustmentStrategy) else {
return ""
}
return ICURelativeDateFormatter.formatter(for: self).format(value: value, component: component, presentation: self.presentation)!
}
private static func _alignedComponentValue(component: Calendar.Component, for destDate: Date, reference refDate: Date, calendar: Calendar, allowedComponents: Set<Calendar.Component>) -> CalendarComponentAndValue? {
// Calculates the value for the specified component in `destDate` by shifting (aligning) the reference date to the start or end of the specified component.
// For example, we're interested the day component value for `refDate` of 2020-06-10 10:00:00 and `destDate` of 2020-06-12 09:00:00.
// Without alignment, `refDate` and `destDate` are one day and 23 hours apart, so the value for the day component is 1.
// With alignment, `refDate` is shifted to the beginning of the day, 2020-06-10 00:00:00, and is 2 days and 9 hours apart from `destDate`. This makes the value of the day component 2.
var refDateStart: Date = refDate
var interval: TimeInterval = 0
guard calendar.dateInterval(of: component, start: &refDateStart, interval: &interval, for: refDate) else {
return nil
}
let refDateEnd = refDateStart.addingTimeInterval(interval - 1)
let dateComponents: DateComponents
if refDate < destDate {
dateComponents = calendar.dateComponents(allowedComponents, from: refDateStart, to: destDate)
} else {
dateComponents = calendar.dateComponents(allowedComponents, from: refDateEnd, to: destDate)
}
return dateComponents.nonZeroComponentsAndValue.first
}
private static func _roundedLargestComponentValue(refDate: Date, for destDate: Date, calendar: Calendar, allowedComponents: Set<Calendar.Component>, largestAllowedComponent: Calendar.Component) -> CalendarComponentAndValue? {
// "day: 1, hour: 11" -> "day: 1"
// "day: 1, hour: 15" -> "day: 2"
// "hour: 23, minute: 50" -> "hour: 24" // only carry to the immediate previous value
// "hour: -23, minute: -30" -> "hour: -24"
var components = calendar.dateComponents(Set(ICURelativeDateFormatter.sortedAllowedComponents.filter({
Date.ComponentsFormatStyle.Field.Option(component: $0)! <= Date.ComponentsFormatStyle.Field.Option(component: largestAllowedComponent)!
})).union([.nanosecond]), from: refDate, to: destDate)
if let seconds = components.second,
abs(components.nanosecond!) >= 500_000_000 {
components.second = seconds + components.nanosecond!.signum()
}
let largestNonZeroComponent = components.nonZeroComponentsAndValue.first?.component
// the smallest allowed component that is greater or equal to the largestNonZeroComponent
let largest = ICURelativeDateFormatter.sortedAllowedComponents.last(where: { component in
guard allowedComponents.contains(component) else {
return false
}
guard let field = Date.ComponentsFormatStyle.Field.Option(component: component) else {
return false
}
guard let largestNonZeroComponent,
let largestNonZeroField = Date.ComponentsFormatStyle.Field.Option(component: largestNonZeroComponent) else {
return true
}
return field >= largestNonZeroField
})
guard let largest else {
return nil
}
let secondLargest = ICURelativeDateFormatter.sortedAllowedComponents.first(where: { component in
Date.ComponentsFormatStyle.Field.Option(component: component)! < Date.ComponentsFormatStyle.Field.Option(component: largest)!
}).map { component in
(component: component, value: components.value(for: component) ?? 0)
} ?? (.nanosecond, components.nanosecond!)
var roundedLargest = (component: largest, value: components.value(for: largest) ?? 0)
if let range = calendar.range(of: secondLargest.component, in: largest, for: destDate) {
let v = secondLargest.value
if abs(v) * 2 >= range.count {
roundedLargest.value += v > 0 ? 1 : -1
}
}
guard let shiftedDate = calendar.date(byAdding: roundedLargest.component, value: -roundedLargest.value, to: destDate) else {
return nil
}
// re-calculate component in case rounding caused next larger component to become non-zero
if let newRoundedLargest = calendar.dateComponents(allowedComponents, from: shiftedDate, to: destDate).nonZeroComponentsAndValue.first, newRoundedLargest.component != roundedLargest.component {
return newRoundedLargest
} else {
// if the component didn't change, use the original calculation, which is more precise
return roundedLargest
}
}
func _largestNonZeroComponent(_ destDate: Date, reference refDate: Date, adjustComponent: ComponentAdjustmentStrategy) -> CalendarComponentAndValue? {
guard let smallest = self.sortedAllowedComponents.last else {
return nil
}
// Precision of `Date` is higher than second, which is the smallest supported unit. Round to seconds.
let refDate = destDate.addingTimeInterval(refDate.timeIntervalSince(destDate).rounded(increment: 1.0, rule: .toNearestOrAwayFromZero))
let allowedComponents = Set(self.sortedAllowedComponents)
let dateComponents = self.calendar.dateComponents(allowedComponents, from: refDate, to: destDate)
let compAndValue: CalendarComponentAndValue
let largest = dateComponents.nonZeroComponentsAndValue.first ?? (smallest, 0)
let comp = largest.component
if comp == .hour || comp == .minute || comp == .second {
compAndValue = Self._roundedLargestComponentValue(
refDate: refDate,
for: destDate,
calendar: calendar,
allowedComponents: allowedComponents,
largestAllowedComponent: comp) ?? largest
} else {
compAndValue = Self._alignedComponentValue(component: largest.component, for: destDate, reference: refDate, calendar: calendar, allowedComponents: allowedComponents) ?? largest
}
return compAndValue
}
}
}
@available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *)
extension Date.RelativeFormatStyle : FormatStyle {}
extension DateComponents {
var nonZeroComponentsAndValue: [CalendarComponentAndValue] {
return ICURelativeDateFormatter.sortedAllowedComponents.compactMap {
guard let value = self.value(for: $0), value != 0 else {
return nil
}
return ($0, value)
}
}
}
@available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *)
public extension FormatStyle where Self == Date.RelativeFormatStyle {
static func relative(presentation: Date.RelativeFormatStyle.Presentation, unitsStyle: Date.RelativeFormatStyle.UnitsStyle = .wide) -> Self {
.init(presentation: presentation, unitsStyle: unitsStyle)
}
}
|