Add time.to_string* formatters.

This commit is contained in:
Jeroen van Rijn
2024-07-25 19:43:42 +02:00
parent 9e82ae10ac
commit 9088a493d9
2 changed files with 373 additions and 0 deletions

View File

@@ -389,6 +389,342 @@ clock_from_seconds :: proc "contextless" (nsec: u64) -> (hour, min, sec: int) {
return
}
/*
Formats a `Time` as a 24-hour `HH:MM:SS` string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current time, the following code can be used:
```odin
buf: [8]u8
now := time.now()
fmt.println(time.to_string_hms(now, buf[:]))
```
*/
time_to_string_hms :: proc(t: Time, buf: []u8) -> (res: string) #no_bounds_check {
assert(len(buf) >= 8)
h, m, s := clock(t)
buf[7] = '0' + u8(s % 10); s /= 10
buf[6] = '0' + u8(s)
buf[5] = ':'
buf[4] = '0' + u8(m % 10); m /= 10
buf[3] = '0' + u8(m)
buf[2] = ':'
buf[1] = '0' + u8(h % 10); h /= 10
buf[0] = '0' + u8(h)
return string(buf[:8])
}
/*
Formats a `Duration` as a 24-hour `HH:MM:SS` string.
**Inputs**:
- `d`: The `Duration` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format a duration, the following code can be used:
```odin
buf: [8]u8
d := time.since(earlier)
fmt.println(time.to_string_hms(d, buf[:]))
```
*/
duration_to_string_hms :: proc(d: Duration, buf: []u8) -> (res: string) #no_bounds_check {
return time_to_string_hms(Time{_nsec=i64(d)}, buf)
}
to_string_hms :: proc{time_to_string_hms, duration_to_string_hms}
/*
Formats a `Time` as a 12-hour `HH:MM:SS pm` string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
- `ampm`: An optional pair of AM/PM strings to use in place of the default.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current time, the following code can be used:
```odin
buf: [64]u8
now := time.now()
fmt.println(time.to_string_hms_12(now, buf[:]))
fmt.println(time.to_string_hms_12(now, buf[:], {"", ""}))
```
*/
to_string_hms_12 :: proc(t: Time, buf: []u8, ampm: [2]string = {" am", " pm"}) -> (res: string) #no_bounds_check {
assert(len(buf) >= 8 + max(len(ampm[0]), len(ampm[1])))
h, m, s := clock(t)
_h := h % 12
buf[7] = '0' + u8(s % 10); s /= 10
buf[6] = '0' + u8(s)
buf[5] = ':'
buf[4] = '0' + u8(m % 10); m /= 10
buf[3] = '0' + u8(m)
buf[2] = ':'
buf[1] = '0' + u8(_h% 10); _h /= 10
buf[0] = '0' + u8(_h)
if h < 13 {
copy(buf[8:], ampm[0])
return string(buf[:8+len(ampm[0])])
} else {
copy(buf[8:], ampm[1])
return string(buf[:8+len(ampm[1])])
}
}
/*
Formats a `Time` as a `yyyy-mm-dd` date string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current date, the following code can be used:
```odin
buf: [10]u8
now := time.now()
fmt.println(time.to_string_yyyy_mm_dd(now, buf[:]))
```
*/
to_string_yyyy_mm_dd :: proc(t: Time, buf: []u8) -> (res: string) #no_bounds_check {
assert(len(buf) >= 10)
y, _m, d := date(t)
m := u8(_m)
buf[9] = '0' + u8(d % 10); d /= 10
buf[8] = '0' + u8(d % 10)
buf[7] = '-'
buf[6] = '0' + u8(m % 10); m /= 10
buf[5] = '0' + u8(m % 10)
buf[4] = '-'
buf[3] = '0' + u8(y % 10); y /= 10
buf[2] = '0' + u8(y % 10); y /= 10
buf[1] = '0' + u8(y % 10); y /= 10
buf[0] = '0' + u8(y)
return string(buf[:10])
}
/*
Formats a `Time` as a `yy-mm-dd` date string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current date, the following code can be used:
```odin
buf: [8]u8
now := time.now()
fmt.println(time.to_string_yy_mm_dd(now, buf[:]))
```
*/
to_string_yy_mm_dd :: proc(t: Time, buf: []u8) -> (res: string) #no_bounds_check {
assert(len(buf) >= 8)
y, _m, d := date(t)
y %= 100; m := u8(_m)
buf[7] = '0' + u8(d % 10); d /= 10
buf[6] = '0' + u8(d % 10)
buf[5] = '-'
buf[4] = '0' + u8(m % 10); m /= 10
buf[3] = '0' + u8(m % 10)
buf[2] = '-'
buf[1] = '0' + u8(y % 10); y /= 10
buf[0] = '0' + u8(y)
return string(buf[:8])
}
/*
Formats a `Time` as a `dd-mm-yyyy` date string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current date, the following code can be used:
```odin
buf: [10]u8
now := time.now()
fmt.println(time.to_string_dd_mm_yyyy(now, buf[:]))
```
*/
to_string_dd_mm_yyyy :: proc(t: Time, buf: []u8) -> (res: string) #no_bounds_check {
assert(len(buf) >= 10)
y, _m, d := date(t)
m := u8(_m)
buf[9] = '0' + u8(y % 10); y /= 10
buf[8] = '0' + u8(y % 10); y /= 10
buf[7] = '0' + u8(y % 10); y /= 10
buf[6] = '0' + u8(y)
buf[5] = '-'
buf[4] = '0' + u8(m % 10); m /= 10
buf[3] = '0' + u8(m % 10)
buf[2] = '-'
buf[1] = '0' + u8(d % 10); d /= 10
buf[0] = '0' + u8(d % 10)
return string(buf[:10])
}
/*
Formats a `Time` as a `dd-mm-yy` date string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current date, the following code can be used:
```odin
buf: [8]u8
now := time.now()
fmt.println(time.to_string_dd_mm_yy(now, buf[:]))
```
*/
to_string_dd_mm_yy :: proc(t: Time, buf: []u8) -> (res: string) #no_bounds_check {
assert(len(buf) >= 8)
y, _m, d := date(t)
y %= 100; m := u8(_m)
buf[7] = '0' + u8(y % 10); y /= 10
buf[6] = '0' + u8(y)
buf[5] = '-'
buf[4] = '0' + u8(m % 10); m /= 10
buf[3] = '0' + u8(m % 10)
buf[2] = '-'
buf[1] = '0' + u8(d % 10); d /= 10
buf[0] = '0' + u8(d % 10)
return string(buf[:8])
}
/*
Formats a `Time` as a `mm-dd-yyyy` date string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current date, the following code can be used:
```odin
buf: [10]u8
now := time.now()
fmt.println(time.to_string_mm_dd_yyyy(now, buf[:]))
```
*/
to_string_mm_dd_yyyy :: proc(t: Time, buf: []u8) -> (res: string) #no_bounds_check {
assert(len(buf) >= 10)
y, _m, d := date(t)
m := u8(_m)
buf[9] = '0' + u8(y % 10); y /= 10
buf[8] = '0' + u8(y % 10); y /= 10
buf[7] = '0' + u8(y % 10); y /= 10
buf[6] = '0' + u8(y)
buf[5] = '-'
buf[4] = '0' + u8(d % 10); d /= 10
buf[3] = '0' + u8(d % 10)
buf[2] = '-'
buf[1] = '0' + u8(m % 10); m /= 10
buf[0] = '0' + u8(m % 10)
return string(buf[:10])
}
/*
Formats a `Time` as a `mm-dd-yy` date string.
**Inputs**:
- `t`: The `Time` to format.
- `buf`: The backing buffer to use.
**Returns**:
- The formatted string `res`, backed by `buf`.
**Example**:
In order to format the current date, the following code can be used:
```odin
buf: [8]u8
now := time.now()
fmt.println(time.to_string_mm_dd_yy(now, buf[:]))
```
*/
to_string_mm_dd_yy :: proc(t: Time, buf: []u8) -> (res: string) #no_bounds_check {
assert(len(buf) >= 8)
y, _m, d := date(t)
y %= 100; m := u8(_m)
buf[7] = '0' + u8(y % 10); y /= 10
buf[6] = '0' + u8(y)
buf[5] = '-'
buf[4] = '0' + u8(d % 10); d /= 10
buf[3] = '0' + u8(d % 10)
buf[2] = '-'
buf[1] = '0' + u8(m % 10); m /= 10
buf[0] = '0' + u8(m % 10)
return string(buf[:8])
}
/*
Read the timestamp counter of the CPU.
*/

View File

@@ -6,6 +6,43 @@ import dt "core:time/datetime"
is_leap_year :: time.is_leap_year
@test
test_time_and_date_formatting :: proc(t: ^testing.T) {
buf: [64]u8
{
now := time.Time{_nsec=min(i64)} // 1677-09-21 00:12:44.145224192 +0000 UTC
d := time.Duration(now._nsec)
testing.expect_value(t, time.to_string_hms (now, buf[:]), "00:12:44")
testing.expect_value(t, time.to_string_hms_12 (now, buf[:]), "00:12:44 am")
testing.expect_value(t, time.to_string_hms_12 (now, buf[:], {"㏂", "㏘"}), "00:12:44㏂")
testing.expect_value(t, time.to_string_hms (d, buf[:]), "00:12:44")
testing.expect_value(t, time.to_string_yyyy_mm_dd(now, buf[:]), "1677-09-21")
testing.expect_value(t, time.to_string_yy_mm_dd (now, buf[:]), "77-09-21")
testing.expect_value(t, time.to_string_dd_mm_yyyy(now, buf[:]), "21-09-1677")
testing.expect_value(t, time.to_string_dd_mm_yy (now, buf[:]), "21-09-77")
testing.expect_value(t, time.to_string_mm_dd_yyyy(now, buf[:]), "09-21-1677")
testing.expect_value(t, time.to_string_mm_dd_yy (now, buf[:]), "09-21-77")
}
{
now := time.Time{_nsec=max(i64)} // 2262-04-11 23:47:16.854775807 +0000 UTC
d := time.Duration(now._nsec)
testing.expect_value(t, time.to_string_hms (now, buf[:]), "23:47:16")
testing.expect_value(t, time.to_string_hms_12 (now, buf[:]), "11:47:16 pm")
testing.expect_value(t, time.to_string_hms_12 (now, buf[:], {"㏂", "㏘"}), "11:47:16㏘")
testing.expect_value(t, time.to_string_hms (d, buf[:]), "23:47:16")
testing.expect_value(t, time.to_string_yyyy_mm_dd(now, buf[:]), "2262-04-11")
testing.expect_value(t, time.to_string_yy_mm_dd (now, buf[:]), "62-04-11")
testing.expect_value(t, time.to_string_dd_mm_yyyy(now, buf[:]), "11-04-2262")
testing.expect_value(t, time.to_string_dd_mm_yy (now, buf[:]), "11-04-62")
testing.expect_value(t, time.to_string_mm_dd_yyyy(now, buf[:]), "04-11-2262")
testing.expect_value(t, time.to_string_mm_dd_yy (now, buf[:]), "04-11-62")
}
}
@test
test_ordinal_date_roundtrip :: proc(t: ^testing.T) {
testing.expect(t, dt.unsafe_ordinal_to_date(dt.unsafe_date_to_ordinal(dt.MIN_DATE)) == dt.MIN_DATE, "Roundtripping MIN_DATE failed.")