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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
// Copyright 2020 CoD Technologies Corp.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Time definition.

use crate::common::*;
use crate::error::DateTimeError;
use crate::interval::Interval;
use crate::parse::{decode_time_only, parse_date_time, timestamp2time};
use crate::token::*;
use crate::{DateOrder, DateStyle, DateTime, DateUnit, FieldType, Timestamp};
use std::convert::TryFrom;
use std::mem::MaybeUninit;

const TIME_SCALES: [i64; MAX_TIME_PRECISION as usize + 1] =
    [1_000_000, 100_000, 10_000, 1000, 100, 10, 1];

const TIME_OFFSETS: [i64; MAX_TIME_PRECISION as usize + 1] = [500_000, 50_000, 5000, 500, 50, 5, 0];

/// Time of day (no date).
#[derive(Copy, Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
#[repr(transparent)]
pub struct Time(i64);

impl Time {
    /// Construct a `Time` value.
    #[inline]
    pub const fn new() -> Self {
        Self(0)
    }

    /// Gets value of `Time`.
    #[inline]
    pub(crate) const fn value(self) -> i64 {
        self.0
    }

    /// Constructs `Time` use hour, minute and second. second can indicate milliseconds an microseconds
    /// THe min unit is microseconds.
    #[inline]
    pub fn try_from_hms(h: i32, m: i32, s: f64) -> Result<Time, DateTimeError> {
        // This should match the checks in DecodeTimeOnly
        // test for > 24:00:00
        if h < 0
            || m < 0
            || m > MINS_PER_HOUR - 1
            || s < 0.0
            || s > SECS_PER_MINUTE as f64
            || h > HOURS_PER_DAY
            || (h == HOURS_PER_DAY && (m > 0 || s > 0.0))
        {
            return Err(DateTimeError::overflow());
        }

        // This should match tm2time
        let time = (((h * MINS_PER_HOUR + m) * SECS_PER_MINUTE) as i64 * USECS_PER_SEC)
            + (s * USECS_PER_SEC as f64).round() as i64;
        Ok(Time::from(time))
    }

    /// Constructs `Time` from pgtime.
    #[inline]
    fn from_pgtime(tm: &PgTime, f_sec: i64) -> Self {
        let secs = ((tm.hour * MINS_PER_HOUR + tm.min) * SECS_PER_MINUTE) as i64;
        let usecs = (secs + tm.sec as i64) * USECS_PER_SEC;
        Time::from(usecs + f_sec)
    }

    /// Force the precision of the time value to a specified value.
    /// Uses *exactly* the same code as in AdjustTimestampForTypemod()
    /// but we make a separate copy because those types do not
    /// have a fundamental tie together but rather a coincidence of
    /// implementation. - thomas.
    #[inline]
    fn adjust_by_typmod(self, typmod: i32) -> Self {
        if typmod >= 0 && typmod <= MAX_TIME_PRECISION {
            let ret = if self.value() >= 0 {
                ((self.value() + TIME_OFFSETS[typmod as usize]) / TIME_SCALES[typmod as usize])
                    * TIME_SCALES[typmod as usize]
            } else {
                -((((-self.value()) + TIME_OFFSETS[typmod as usize])
                    / TIME_SCALES[typmod as usize])
                    * TIME_SCALES[typmod as usize])
            };

            Time::from(ret)
        } else {
            self
        }
    }

    /// Parses `Time` string. type_mod should be 0 ~ 6, else will have no affect.
    #[allow(clippy::uninit_assumed_init)]
    pub fn try_from_str(
        s: &str,
        type_mod: i32,
        date_order: DateOrder,
    ) -> Result<Time, DateTimeError> {
        let s = s.as_bytes();
        let mut fields: [&[u8]; MAX_DATE_FIELDS] = unsafe { MaybeUninit::uninit().assume_init() };
        let mut work_buf: [u8; MAX_DATE_LEN] = unsafe { MaybeUninit::uninit().assume_init() };
        let mut f_types: [TokenField; MAX_DATE_FIELDS] =
            unsafe { MaybeUninit::uninit().assume_init() };
        let mut tm = PgTime::new();

        let field_num =
            parse_date_time(s, &mut work_buf, &mut fields, &mut f_types, MAX_DATE_FIELDS)?;
        let mut tz = Some(0);
        let fsec = decode_time_only(
            &fields[0..field_num],
            &mut f_types[0..field_num],
            &mut tm,
            &mut tz,
            date_order,
        )?;

        let time = Time::from_pgtime(&tm, fsec).adjust_by_typmod(type_mod);
        Ok(time)
    }

    /// Converts `Time` to string.
    #[inline]
    pub fn format(self, date_style: DateStyle) -> Result<String, DateTimeError> {
        let mut buf = Vec::with_capacity(128);
        unsafe { buf.set_len(128) };
        let mut tm: PgTime = PgTime::new();
        let mut fsec = 0;
        self.to_pgtime(&mut tm, &mut fsec);
        let len = format_time(&tm, buf.as_mut_slice(), fsec, false, 0, date_style);
        unsafe {
            buf.set_len(len);
            Ok(String::from_utf8_unchecked(buf))
        }
    }

    /// `Time` Adds `Interval`.
    #[inline]
    pub fn add_interval(self, span: Interval) -> Time {
        let mut result = self.value().wrapping_add(span.time());
        result -= result / USECS_PER_DAY * USECS_PER_DAY;
        if result < 0 {
            result += USECS_PER_DAY;
        }
        Time::from(result)
    }

    /// `Time` subtracts `Time`
    #[inline]
    pub fn sub_time(self, time: Time) -> Interval {
        let time = self.0.wrapping_sub(time.0);
        Interval::from_mdt(0, 0, time)
    }

    /// `Time` subtracts `Interval`.
    #[inline]
    pub fn sub_interval(self, span: Interval) -> Time {
        let mut result = self.value().wrapping_sub(span.time());
        result -= result / USECS_PER_DAY * USECS_PER_DAY;
        if result < 0 {
            result += USECS_PER_DAY;
        }
        Time::from(result)
    }

    /// Converts `Time` to `PgTime`
    #[inline]
    pub(crate) fn to_pgtime(self, tm: &mut PgTime, fsec: &mut i64) {
        let mut time = self.value();
        tm.hour = (time / USECS_PER_HOUR) as i32;
        time -= tm.hour as i64 * USECS_PER_HOUR;
        tm.min = (time / USECS_PER_MINUTE) as i32;
        time -= tm.min as i64 * USECS_PER_MINUTE;
        tm.sec = (time / USECS_PER_SEC) as i32;
        time -= tm.sec as i64 * USECS_PER_SEC;
        *fsec = time;
    }
}

/// Encode time fields only.
/// tm and fsec are the value to encode, print_tz determines whether to include
/// a time zone (the difference between time and timetz types), tz is the
/// numeric time zone offset, style is the date style, str is where to write the
/// output.
#[inline]
fn format_time(
    tm: &PgTime,
    str: &mut [u8],
    fsec: i64,
    _print_tz: bool,
    _tz: i32,
    _style: DateStyle,
) -> usize {
    let mut offset = pg_ltostr_zeropad(str, tm.hour, 2);
    str[offset] = b':';
    offset += 1;
    offset += pg_ltostr_zeropad(&mut str[offset..], tm.min, 2);
    str[offset] = b':';
    offset += 1;
    offset += append_seconds(&mut str[offset..], tm.sec, fsec, MAX_TIME_PRECISION, true);
    /*    if print_tz {
        offset += encode_timezone(&mut str[offset..], tz, style);
    }*/
    offset
}

/// Converts `Time` to `i64` type.
impl From<Time> for i64 {
    #[inline]
    fn from(t: Time) -> Self {
        t.0
    }
}

/// Converts `i64` to `Date` to type.
impl From<i64> for Time {
    #[inline]
    fn from(v: i64) -> Self {
        Time(v)
    }
}

/// Converts `Timestamp` to `Time`.
impl TryFrom<Timestamp> for Option<Time> {
    type Error = DateTimeError;

    #[inline]
    fn try_from(value: Timestamp) -> Result<Self, Self::Error> {
        if value.is_infinite() {
            return Ok(None);
        }

        let mut tm: PgTime = PgTime::new();
        let mut fsec = 0;
        timestamp2time(value.value(), &None, &mut tm, &mut fsec, &mut None, &None)?;
        // Could also do this with time = (timestamp / USECS_PER_DAY *
        // USECS_PER_DAY) - timestamp;
        let result = ((((tm.hour * MINS_PER_HOUR + tm.min) * SECS_PER_MINUTE) as i64
            + tm.sec as i64)
            * USECS_PER_SEC)
            + fsec;

        Ok(Some(Time::from(result)))
    }
}

/// Converts `Interval` to `Time`.
/// This is defined as producing the fractional-day portion of the interval.
/// Therefore, we can just ignore the months field.  It is not real clear
/// what to do with negative intervals, but we choose to subtract the floor,
/// so that, say, '-2 hours' becomes '22:00:00'.
impl From<Interval> for Time {
    #[inline]
    fn from(value: Interval) -> Self {
        let mut result = value.time();
        if result >= USECS_PER_DAY {
            let days = result / USECS_PER_DAY;
            result -= days * USECS_PER_DAY;
        } else if result < 0 {
            let days = (-result + USECS_PER_DAY - 1) / USECS_PER_DAY;
            result += days * USECS_PER_DAY;
        }
        Time::from(result)
    }
}

impl DateTime for Time {
    /// Extracts specified field from time type.
    #[inline]
    fn date_part(&self, ty: FieldType, unit: DateUnit) -> Result<Option<f64>, DateTimeError> {
        match ty {
            FieldType::Unit => {
                let mut tm = PgTime::new();
                let mut fsec = 0;
                self.to_pgtime(&mut tm, &mut fsec);
                match unit {
                    DateUnit::MicroSec => Ok(Some(tm.sec as f64 * 1_000_000.0 + fsec as f64)),
                    DateUnit::MilliSec => Ok(Some(tm.sec as f64 * 1000.0 + fsec as f64 / 1000.0)),
                    DateUnit::Second => Ok(Some(tm.sec as f64 + fsec as f64 / 1_000_000.0)),
                    DateUnit::Minute => Ok(Some(tm.min as f64)),
                    DateUnit::Hour => Ok(Some(tm.hour as f64)),
                    _ => Err(DateTimeError::invalid(format!(
                        "unit: {:?} is invalid for time",
                        unit
                    ))),
                }
            }
            FieldType::Epoch => {
                if unit == DateUnit::Epoch {
                    Ok(Some(self.value() as f64 / 1_000_000.0))
                } else {
                    Err(DateTimeError::invalid(format!("type: {:?} is invalid", ty)))
                }
            }
        }
    }

    /// Checks whether `Time` is finite.
    #[inline]
    fn is_finite(&self) -> bool {
        true
    }

    /// Truncates `Time` to specified units.
    #[inline]
    fn truncate(&self, ty: FieldType, unit: DateUnit) -> Result<Self, DateTimeError> {
        let interval: Interval = From::from(*self);
        let it = interval.truncate(ty, unit)?;
        Ok(From::from(it))
    }
}

#[cfg(test)]
mod tests {
    use crate::error::DateTimeError;
    use crate::time::*;
    use crate::{DateOrder, DateStyle, DateTime, DateUnit, FieldType};

    #[test]
    fn test_time_from_str() -> Result<(), DateTimeError> {
        let time = Time::try_from_str("PST", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("azot", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("10.2 2010-10", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("dow345", -1, DateOrder::MDY);
        assert!(time.is_err());

        let time = Time::try_from_str("j-345", -1, DateOrder::MDY);
        assert!(time.is_err());

        let time = Time::try_from_str("azot45", -1, DateOrder::MDY);
        assert!(time.is_err());

        let time = Time::try_from_str("y1989m3d10.45", -1, DateOrder::MDY);
        assert!(time.is_err());

        let time = Time::try_from_str("allballs", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "00:00:00");

        let time = Time::try_from_str("2010-10-10 04:05 PM", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "16:05:00");

        let time = Time::try_from_str("040506", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:06");

        let time = Time::try_from_str("040506.456", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:06.456");

        let time: Time = Time::try_from_str("y1989m3d10h12mm30s20.4567", -1, DateOrder::MDY)?;
        assert_eq!(time.format(DateStyle::ISO)?, "12:30:20.4567".to_string());

        let time: Time = Time::try_from_str("y1989m3d10h12m30s20.4567", -1, DateOrder::MDY)?;
        assert_eq!(time.format(DateStyle::ISO)?, "12:30:20.4567".to_string());

        let time: Time = Time::try_from_str("J2451187.345", -1, DateOrder::MDY)?;
        assert_eq!(time.format(DateStyle::ISO)?, "08:16:47.999999".to_string());

        let time = Time::try_from_str("+567h", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("+567h", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("4 hours 5 minutes", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str(".2344", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("allballs", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "00:00:00");

        let time = Time::try_from_str("04:05:06.789t", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("t04:05:06.789", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:06.789");

        let time = Time::try_from_str("at 04:05:06.789", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:06.789");

        let time = Time::try_from_str("04:05:06", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:06");

        let time = Time::try_from_str("04:05", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:00");

        let time = Time::try_from_str("04:05.234", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "00:04:05.234");

        let time = Time::try_from_str("040506", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:06");

        let time = Time::try_from_str("04:05 AM", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "04:05:00");

        let time = Time::try_from_str("12:20:05 AM", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "00:20:05");

        let time = Time::try_from_str("04:05 PM", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "16:05:00");

        let ret = Time::try_from_str("04:05:06-08:00", 3, DateOrder::YMD);
        assert!(ret.is_err());

        let time = Time::try_from_str("2010-10-10 04:05 PM", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "16:05:00");

        let time = Time::try_from_str("14:04:05 AM", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("now", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("current", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("2003-04-12 04:05:06 America/New_York", 3, DateOrder::YMD);
        assert!(time.is_err());

        let time = Time::try_from_str("2003-04-12 04:05:06 shanghai", 3, DateOrder::YMD);
        assert!(time.is_err());
        Ok(())
    }

    #[test]
    fn test_time_range() -> Result<(), DateTimeError> {
        let time = Time::try_from_str("00:00:00", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "00:00:00");

        let time = Time::try_from_str("24:00:00", 3, DateOrder::YMD)?;
        assert_eq!(time.format(DateStyle::ISO)?, "24:00:00");

        let time = Time::try_from_str("24:00:01", 3, DateOrder::YMD);
        assert!(time.is_err());
        Ok(())
    }

    #[test]
    fn test_from_hms() -> Result<(), DateTimeError> {
        let time = Time::try_from_hms(23, 24, 56.67)?;
        assert_eq!(time.format(DateStyle::ISO)?, "23:24:56.67");

        let time = Time::try_from_hms(23, 24, 56.6789289)?;
        assert_eq!(time.format(DateStyle::ISO)?, "23:24:56.678929");

        let ret = Time::try_from_hms(-2, 24, 56.67);
        assert!(ret.is_err());

        let ret = Time::try_from_hms(-2, 24, 56.67);
        assert!(ret.is_err());

        let ret = Time::try_from_hms(23, -24, 56.67);
        assert!(ret.is_err());

        let ret = Time::try_from_hms(23, 24, -56.67);
        assert!(ret.is_err());
        let ret = Time::try_from_hms(25, 24, 56.67);
        assert!(ret.is_err());
        let time = Time::try_from_hms(24, 0, 0.0)?;
        assert_eq!(time.format(DateStyle::ISO)?, "24:00:00");
        let ret = Time::try_from_hms(24, 1, 0.0);
        assert!(ret.is_err());
        let ret = Time::try_from_hms(24, 0, 1.0);
        assert!(ret.is_err());

        let ret = Time::try_from_hms(23, 60, 1.0);
        assert!(ret.is_err());

        let time = Time::try_from_hms(23, 10, 60.0)?;
        assert_eq!(time.format(DateStyle::ISO)?, "23:11:00");

        let ret = Time::try_from_hms(23, 60, 60.1);
        assert!(ret.is_err());

        Ok(())
    }

    #[test]
    fn test_time_part() -> Result<(), DateTimeError> {
        let time = Time::try_from_str("20:45:34.673452", -1, DateOrder::YMD)?;
        let ret = time.date_part(FieldType::Unit, DateUnit::Hour)?;
        assert_eq!(ret, Some(20.0));

        let ret = time.date_part(FieldType::Unit, DateUnit::Minute)?;
        assert_eq!(ret, Some(45.0));

        let ret = time.date_part(FieldType::Unit, DateUnit::Second)?;
        assert_eq!(ret, Some(34.673452));

        let ret = time.date_part(FieldType::Unit, DateUnit::MilliSec)?;
        assert_eq!(ret, Some(34673.452));

        let ret = time.date_part(FieldType::Unit, DateUnit::MicroSec)?;
        assert_eq!(ret, Some(34673452.0));

        let ret = time.date_part(FieldType::Epoch, DateUnit::Epoch)?;
        assert_eq!(ret, Some(74734.673452));

        let ret = time.date_part(FieldType::Unit, DateUnit::Year);
        assert!(ret.is_err());

        let ret = time.date_part(FieldType::Epoch, DateUnit::Year);
        assert!(ret.is_err());

        Ok(())
    }

    #[test]
    fn test_time_truncate() -> Result<(), DateTimeError> {
        let time = Time::try_from_str("20:38:40.456789", 6, DateOrder::YMD)?;
        let ret = time.truncate(FieldType::Unit, DateUnit::Hour)?;
        assert_eq!(ret.format(DateStyle::ISO)?, "20:00:00");

        let ret = time.truncate(FieldType::Unit, DateUnit::Minute)?;
        assert_eq!(ret.format(DateStyle::ISO)?, "20:38:00");

        let ret = time.truncate(FieldType::Unit, DateUnit::Second)?;
        assert_eq!(ret.format(DateStyle::ISO)?, "20:38:40");

        let ret = time.truncate(FieldType::Unit, DateUnit::MilliSec)?;
        assert_eq!(ret.format(DateStyle::ISO)?, "20:38:40.456");

        let ret = time.truncate(FieldType::Unit, DateUnit::MicroSec)?;
        assert_eq!(ret.format(DateStyle::ISO)?, "20:38:40.456789");
        Ok(())
    }

    #[test]
    fn test_time_finite() -> Result<(), DateTimeError> {
        let time = Time::try_from_str("10:23:45", 6, DateOrder::YMD)?;
        assert!(!time.is_infinite());
        assert!(time.is_finite());

        Ok(())
    }

    #[test]
    fn test_adjust_by_type_mod() -> Result<(), DateTimeError> {
        let time = Time::from(-12345).adjust_by_typmod(5);
        assert_eq!(time.format(DateStyle::ISO)?, "00:00:00.01235");
        Ok(())
    }
}