File: TimeCalculations.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (295 lines) | stat: -rw-r--r-- 10,473 bytes parent folder | download
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftCertificates open source project
//
// Copyright (c) 2022 Apple Inc. and the SwiftCertificates project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftCertificates project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//

// This file contains code derived from the musl implementation at
// https://git.musl-libc.org/cgit/musl/tree/src/time/__secs_to_tm.c and
// https://git.musl-libc.org/cgit/musl/tree/src/time/__tm_to_secs.c.
//
// These implementations have been translated into Swift appropriately for this
// use-case.
//
// The copyright for the original implementation is:
//
//----------------------------------------------------------------------
// Copyright © 2005-2020 Rich Felker, et al.
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//----------------------------------------------------------------------

extension Int64 {
    // 2000-03-01 (mod 400 year, immediately after feb29
    @inlinable
    static var leapoch: Int64 {
        .secondsFromEpochToYear2000 + .secondsPerDay * (31 + 29)
    }

    @inlinable
    static var secondsFromEpochToYear2000: Int64 {
        946_684_800
    }

    @inlinable
    static var daysPer400Years: Int64 {
        365 * 400 + 97
    }

    @inlinable
    static var daysPer100Years: Int64 {
        365 * 100 + 24
    }

    @inlinable
    static var daysPer4Years: Int64 {
        365 * 4 + 1
    }

    @inlinable
    static var secondsPerDay: Int64 {
        24 * 60 * 60
    }

    @inlinable
    static var secondsPerYear: Int64 {
        .secondsPerDay * .daysPerYear
    }

    @inlinable
    static var daysPerYear: Int64 {
        365
    }

    @inlinable
    static func daysInMonth(_ month: Int) -> Int64 {
        // This may seem weird, but these months are indexed from _March_.
        // Thus, month 0 is March, month 11 is February.
        switch month {
        case 0, 2, 4, 5, 7, 9, 10:
            return 31
        case 1, 3, 6, 8:
            return 30
        case 11:
            return 29
        default:
            fatalError()
        }
    }

    @inlinable
    var utcDateFromTimestamp: (year: Int, month: Int, day: Int, hours: Int, minutes: Int, seconds: Int) {
        let secs = self - .leapoch
        var (days, remsecs) = secs.quotientAndRemainder(dividingBy: 86400)

        // Tolerate negative values
        if remsecs < 0 {
            // Unchecked is safe here: we know remsecs is negative, and we know
            // days cannot be Int64.min
            remsecs &+= .secondsPerDay
            days &-= 1
        }

        var (qcCycles, remdays) = days.quotientAndRemainder(dividingBy: .daysPer400Years)
        if remdays < 0 {
            // Same justification here for unchecked arithmetic
            remdays &+= .daysPer400Years
            qcCycles &-= 1
        }

        // Unchecked arithmetic here is safe: the subtraction is all known values (4 - 1),
        // and the multiplication cannot exceed the original value of remdays.
        var cCycles = remdays / .daysPer100Years
        if cCycles == 4 { cCycles &-= 1 }
        remdays &-= cCycles &* .daysPer100Years

        // Unchecked arithmetic here is safe: the subtraction is all known values (25 - 1),
        // and the multiplication cannot exceed the original value of remdays.
        var qCycles = remdays / .daysPer4Years
        if qCycles == 25 { qCycles &-= 1 }
        remdays &-= qCycles &* .daysPer4Years

        // Unchecked arithmetic here is safe: the subtraction is all known values (4 - 1),
        // and the multiplication cannot exceed the original value of remdays.
        var remyears = remdays / .daysPerYear
        if remyears == 4 { remyears &-= 1 }
        remdays &-= remyears &* .daysPerYear

        // Unchecked multiplication here is safe: each of these has earlier been multiplied by
        // a much larger number and we didn't need checked math then, so we don't need it now.
        var years = remyears + (4 &* qCycles) + (100 &* cCycles) + (400 &* qcCycles)

        var months = 0
        while Int64.daysInMonth(months) <= remdays {
            remdays -= Int64.daysInMonth(months)

            // Unchecked because daysInMonth will crash if given a value greater than 12, so this
            // cannot exceed 12.
            months &+= 1
        }

        // Now we normalise the months count back to starting in January.
        // Safe to do unchecked subtraction here because for all numbers 10 or
        // larger we can subtract by 12.
        if months >= 10 {
            months &-= 12
            years += 1
        }

        // Normalise out the values.
        //
        // Safe to do unchecked math on the months as we just checked its value above.
        // Same for remdays, the loop only terminates if the number is smaller than at most 31.
        //
        // Note that, unlike struct tm, we return ordinal month numbers as well as days (i.e. 1 to 12).
        // This fits us better when working with GeneralizedTime and friends.
        return (
            year: Int(years + 2000),
            month: Int(months &+ 3),
            day: Int(remdays &+ 1),
            hours: Int(remsecs / 3600),
            minutes: Int(remsecs / 60 % 60),
            seconds: Int(remsecs % 60)
        )
    }

    @inlinable
    init(timestampFromUTCDate date: (year: Int, month: Int, day: Int, hours: Int, minutes: Int, seconds: Int)) {
        assert((1...12).contains(date.month))
        assert((0...31).contains(date.day))
        assert((0..<24).contains(date.hours))
        assert((0..<60).contains(date.minutes))
        assert((0..<61).contains(date.seconds))

        // The algorithm as written expects a tm year, which is years away from 1900, and a tm_month, which is 0-11 instead of 1-12.
        // We don't want that nonsense. Undo it here.
        var (seconds, isLeap) = Self.yearToSeconds(Int64(date.year) - 1900)
        seconds += Self.monthToSeconds(Int64(date.month) - 1, isLeap: isLeap)

        // Note that we tolerate invalid day/hour/minute/seconds. That's ok in this context,
        // we validate elsewhere. However, we don't do unchecked math for that reason.
        seconds += .secondsPerDay * (Int64(date.day) - 1)
        seconds += 3600 * Int64(date.hours)
        seconds += 60 * Int64(date.minutes)
        seconds += Int64(date.seconds)

        self = seconds
    }

    @inlinable
    static func yearToSeconds(_ year: Int64) -> (seconds: Int64, isLeap: Bool) {
        var (cycles, rem) = (year - 100).quotientAndRemainder(dividingBy: 400)
        if rem < 0 {
            // Unchecked is safe here: we know rem is negative, and we know
            // cycles cannot be Int64.min
            cycles &-= 1
            rem &+= 400
        }

        let centuries: Int64
        let isLeap: Bool
        var leaps: Int64

        if rem == 0 {
            isLeap = true
            centuries = 0
            leaps = 0
        } else {
            switch rem {
            case 300...:
                centuries = 3
                rem &-= 300
            case 200...:
                centuries = 2
                rem &-= 200
            case 100...:
                centuries = 1
                rem &-= 100
            default:
                assert(rem > 0)
                centuries = 0
            }

            if rem == 0 {
                isLeap = false
                leaps = 0
            } else {
                (leaps, rem) = rem.quotientAndRemainder(dividingBy: 4)
                isLeap = (rem == 0)
            }
        }

        leaps += (97 * cycles) + (24 * centuries) - (isLeap ? 1 : 0)
        return (
            seconds: ((year - 100) * .secondsPerYear) + (leaps * .secondsPerDay) + .secondsFromEpochToYear2000
                + .secondsPerDay, isLeap: isLeap
        )
    }

    @inlinable
    static func monthToSeconds(_ month: Int64, isLeap: Bool) -> Int64 {
        var secondsThroughMonth: Int64

        // musl tolerates out-of-band months: we don't.
        switch month {
        case 0:
            secondsThroughMonth = 0
        case 1:
            secondsThroughMonth = 31 * .secondsPerDay
        case 2:
            secondsThroughMonth = 59 * .secondsPerDay
        case 3:
            secondsThroughMonth = 90 * .secondsPerDay
        case 4:
            secondsThroughMonth = 120 * .secondsPerDay
        case 5:
            secondsThroughMonth = 151 * .secondsPerDay
        case 6:
            secondsThroughMonth = 181 * .secondsPerDay
        case 7:
            secondsThroughMonth = 212 * .secondsPerDay
        case 8:
            secondsThroughMonth = 243 * .secondsPerDay
        case 9:
            secondsThroughMonth = 273 * .secondsPerDay
        case 10:
            secondsThroughMonth = 304 * .secondsPerDay
        case 11:
            secondsThroughMonth = 334 * .secondsPerDay
        default:
            fatalError("Invalid month: \(month)")
        }

        if isLeap && month >= 2 {
            // Unchecked is safe here, none of the above values will overflow when this is added to them.
            secondsThroughMonth &+= .secondsPerDay
        }

        return secondsThroughMonth
    }
}