diff options
| author | Damien George <damien@micropython.org> | 2024-10-24 11:22:22 +1100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-10-24 11:22:22 +1100 |
| commit | 43bd57f94bb3a3ef06638105cebefac9611b7329 (patch) | |
| tree | b49b0c4904e0981b0809629e7ed5995f8398c4aa /shared | |
| parent | 078ead24f392deedaad2f391baac4aaefe96f49b (diff) | |
| download | micropython-43bd57f94bb3a3ef06638105cebefac9611b7329.tar.gz micropython-43bd57f94bb3a3ef06638105cebefac9611b7329.zip | |
shared/timeutils: Document the range of year/month/day etc input values.
These differ to, eg, the standard `mktime()` function.
Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'shared')
| -rw-r--r-- | shared/timeutils/timeutils.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/shared/timeutils/timeutils.h b/shared/timeutils/timeutils.h index 69cbd95df5..82032600f3 100644 --- a/shared/timeutils/timeutils.h +++ b/shared/timeutils/timeutils.h @@ -49,9 +49,11 @@ mp_uint_t timeutils_year_day(mp_uint_t year, mp_uint_t month, mp_uint_t date); void timeutils_seconds_since_2000_to_struct_time(mp_uint_t t, timeutils_struct_time_t *tm); +// Year is absolute, month/date are 1-based, hour/minute/second are 0-based. mp_uint_t timeutils_seconds_since_2000(mp_uint_t year, mp_uint_t month, mp_uint_t date, mp_uint_t hour, mp_uint_t minute, mp_uint_t second); +// Year is absolute, month/mday are 1-based, hours/minutes/seconds are 0-based. mp_uint_t timeutils_mktime_2000(mp_uint_t year, mp_int_t month, mp_int_t mday, mp_int_t hours, mp_int_t minutes, mp_int_t seconds); @@ -63,10 +65,12 @@ static inline void timeutils_seconds_since_epoch_to_struct_time(uint64_t t, time timeutils_seconds_since_2000_to_struct_time(t - TIMEUTILS_SECONDS_1970_TO_2000, tm); } +// Year is absolute, month/mday are 1-based, hours/minutes/seconds are 0-based. static inline uint64_t timeutils_mktime(mp_uint_t year, mp_int_t month, mp_int_t mday, mp_int_t hours, mp_int_t minutes, mp_int_t seconds) { return timeutils_mktime_2000(year, month, mday, hours, minutes, seconds) + TIMEUTILS_SECONDS_1970_TO_2000; } +// Year is absolute, month/date are 1-based, hour/minute/second are 0-based. static inline uint64_t timeutils_seconds_since_epoch(mp_uint_t year, mp_uint_t month, mp_uint_t date, mp_uint_t hour, mp_uint_t minute, mp_uint_t second) { // TODO this will give incorrect results for dates before 2000/1/1 |