DateTime.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
#pragma once
#ifndef _TIME_SHIELD_DATE_TIME_HPP_INCLUDED
#define _TIME_SHIELD_DATE_TIME_HPP_INCLUDED

 
#include "config.hpp"
#include "constants.hpp"
#include "date_conversions.hpp"
#include "date_time_conversions.hpp"
#include "date_time_struct.hpp"
#include "iso_week_conversions.hpp"
#include "time_formatting.hpp"
#include "time_parser.hpp"
#include "time_struct.hpp"
#include "time_utils.hpp"
#include "time_zone_offset_conversions.hpp"
#include "time_zone_struct.hpp"
#include "types.hpp"
#include "validation.hpp"
 
#include <cstdint>
#include <cstring>
#include <stdexcept>
#include <string>
#ifdef TIME_SHIELD_CPP17
#include <string_view>
#endif
 
namespace time_shield {

    class DateTime {
    public:
        DateTime() noexcept
            : m_utc_ms(0)
            , m_offset(0) {}

        static DateTime from_unix_ms(ts_ms_t utc_ms, tz_t offset = 0) noexcept {
            return DateTime(utc_ms, offset);
        }

        static DateTime from_unix_s(ts_t utc_s, tz_t offset = 0) noexcept {
            return DateTime(sec_to_ms(utc_s), offset);
        }

        static DateTime now_utc(tz_t offset = 0) noexcept {
            return DateTime(ts_ms(), offset);
        }

        static DateTime from_components(
                year_t year,
                int month,
                int day,
                int hour = 0,
                int min = 0,
                int sec = 0,
                int ms = 0,
                tz_t offset = 0) {
            const ts_ms_t local_ms = to_timestamp_ms(year, month, day, hour, min, sec, ms);
            const ts_ms_t utc_ms = local_ms - offset_to_ms(offset);
            return DateTime(utc_ms, offset);
        }

        static bool try_from_components(
                year_t year,
                int month,
                int day,
                int hour,
                int min,
                int sec,
                int ms,
                tz_t offset,
                DateTime& out) noexcept {
            if (!is_valid_date_time(year, month, day, hour, min, sec, ms)) {
                return false;
            }
            if (!is_valid_tz_offset(offset)) {
                return false;
            }
            const ts_ms_t local_ms = to_timestamp_ms(year, month, day, hour, min, sec, ms);
            out = DateTime(local_ms - offset_to_ms(offset), offset);
            return true;
        }

        static DateTime from_date_time_struct(const DateTimeStruct& local_dt, tz_t offset = 0) {
            const ts_ms_t local_ms = dt_to_timestamp_ms(local_dt);
            const ts_ms_t utc_ms = local_ms - offset_to_ms(offset);
            return DateTime(utc_ms, offset);
        }

        static bool try_from_date_time_struct(
                const DateTimeStruct& local_dt,
                tz_t offset,
                DateTime& out) noexcept {
            if (!is_valid_date_time(local_dt)) {
                return false;
            }
            if (!is_valid_tz_offset(offset)) {
                return false;
            }
            const ts_ms_t local_ms = dt_to_timestamp_ms(local_dt);
            out = DateTime(local_ms - offset_to_ms(offset), offset);
            return true;
        }

        DateTimeStruct to_date_time_struct_local() const {
            return to_date_time_ms<DateTimeStruct>(local_ms());
        }

        DateTimeStruct to_date_time_struct_utc() const {
            return to_date_time_ms<DateTimeStruct>(m_utc_ms);
        }

        static DateTime from_iso_week_date(
                const IsoWeekDateStruct& iso,
                int hour = 0,
                int min = 0,
                int sec = 0,
                int ms = 0,
                tz_t offset = 0) {
            const DateStruct date = iso_week_date_to_date(iso);
            return from_components(date.year, date.mon, date.day, hour, min, sec, ms, offset);
        }

        static bool try_parse_iso8601(const std::string& str, DateTime& out) noexcept {
            return try_parse_iso8601_buffer(str.data(), str.size(), out);
        }
 
        #ifdef TIME_SHIELD_CPP17
        static bool try_parse_iso8601(std::string_view str, DateTime& out) noexcept {
            return try_parse_iso8601_buffer(str.data(), str.size(), out);
        }
        #endif

        static bool try_parse_iso8601(const char* str, DateTime& out) noexcept {
            if (str == nullptr) {
                return false;
            }
            return try_parse_iso8601_buffer(str, std::strlen(str), out);
        }

        static DateTime parse_iso8601(const std::string& str) {
            return parse_iso8601_buffer(str.data(), str.size());
        }
 
        #ifdef TIME_SHIELD_CPP17
        static DateTime parse_iso8601(std::string_view str) {
            return parse_iso8601_buffer(str.data(), str.size());
        }
        #endif

        static DateTime parse_iso8601(const char* str) {
            if (str == nullptr) {
                throw std::invalid_argument("Invalid ISO8601 datetime");
            }
            return parse_iso8601_buffer(str, std::strlen(str));
        }

        static bool try_parse_iso_week_date(const std::string& str, IsoWeekDateStruct& iso) noexcept {
            return parse_iso_week_date(str.data(), str.size(), iso);
        }
 
        #ifdef TIME_SHIELD_CPP17
        static bool try_parse_iso_week_date(std::string_view str, IsoWeekDateStruct& iso) noexcept {
            return parse_iso_week_date(str.data(), str.size(), iso);
        }
        #endif

        static bool try_parse_iso_week_date(const char* str, IsoWeekDateStruct& iso) noexcept {
            if (str == nullptr) {
                return false;
            }
            return parse_iso_week_date(str, std::strlen(str), iso);
        }

        std::string to_iso8601() const {
            return to_iso8601_ms(m_utc_ms, m_offset);
        }

        std::string to_iso8601_utc() const {
            return to_iso8601_utc_ms(m_utc_ms);
        }

        std::string format(const std::string& fmt) const {
            return to_string_ms(fmt, m_utc_ms, m_offset);
        }
 
        #ifdef TIME_SHIELD_CPP17
        std::string format(std::string_view fmt) const {
            return to_string_ms(std::string(fmt), m_utc_ms, m_offset);
        }
        #endif

        std::string format(const char* fmt) const {
            if (fmt == nullptr) {
                return std::string();
            }
            return to_string_ms(std::string(fmt), m_utc_ms, m_offset);
        }

        std::string to_mql5_date_time() const {
            return time_shield::to_mql5_date_time(ms_to_sec<ts_t>(local_ms()));
        }

        ts_ms_t unix_ms() const noexcept {
            return m_utc_ms;
        }

        ts_t unix_s() const noexcept {
            return ms_to_sec<ts_t>(m_utc_ms);
        }

        tz_t utc_offset() const noexcept {
            return m_offset;
        }

        TimeZoneStruct time_zone() const {
            return to_time_zone_struct(m_offset);
        }

        year_t year() const {
            return to_date_time_struct_local().year;
        }

        int month() const {
            return to_date_time_struct_local().mon;
        }

        int day() const {
            return to_date_time_struct_local().day;
        }

        int hour() const {
            return to_date_time_struct_local().hour;
        }

        int minute() const {
            return to_date_time_struct_local().min;
        }

        int second() const {
            return to_date_time_struct_local().sec;
        }

        int millisecond() const {
            return to_date_time_struct_local().ms;
        }

        DateStruct date() const {
            const DateTimeStruct local_dt = to_date_time_struct_local();
            return create_date_struct(local_dt.year, local_dt.mon, local_dt.day);
        }

        TimeStruct time_of_day() const {
            const DateTimeStruct local_dt = to_date_time_struct_local();
            return create_time_struct(
                    static_cast<int16_t>(local_dt.hour),
                    static_cast<int16_t>(local_dt.min),
                    static_cast<int16_t>(local_dt.sec),
                    static_cast<int16_t>(local_dt.ms));
        }

        DateStruct utc_date() const {
            const DateTimeStruct utc_dt = to_date_time_struct_utc();
            return create_date_struct(utc_dt.year, utc_dt.mon, utc_dt.day);
        }

        TimeStruct utc_time_of_day() const {
            const DateTimeStruct utc_dt = to_date_time_struct_utc();
            return create_time_struct(
                    static_cast<int16_t>(utc_dt.hour),
                    static_cast<int16_t>(utc_dt.min),
                    static_cast<int16_t>(utc_dt.sec),
                    static_cast<int16_t>(utc_dt.ms));
        }

        year_t utc_year() const {
            return to_date_time_struct_utc().year;
        }

        int utc_month() const {
            return to_date_time_struct_utc().mon;
        }

        int utc_day() const {
            return to_date_time_struct_utc().day;
        }

        int utc_hour() const {
            return to_date_time_struct_utc().hour;
        }

        int utc_minute() const {
            return to_date_time_struct_utc().min;
        }

        int utc_second() const {
            return to_date_time_struct_utc().sec;
        }

        int utc_millisecond() const {
            return to_date_time_struct_utc().ms;
        }

        Weekday weekday() const {
            const DateStruct local_date = date();
            return weekday_of_date<Weekday>(local_date);
        }

        int iso_weekday() const {
            const DateStruct local_date = date();
            return iso_weekday_of_date(local_date.year, local_date.mon, local_date.day);
        }

        IsoWeekDateStruct iso_week_date() const {
            const DateStruct local_date = date();
            return to_iso_week_date(local_date.year, local_date.mon, local_date.day);
        }

        Weekday utc_weekday() const {
            const DateStruct utc_dt = utc_date();
            return weekday_of_date<Weekday>(utc_dt);
        }

        int utc_iso_weekday() const {
            const DateStruct utc_dt = utc_date();
            return iso_weekday_of_date(utc_dt.year, utc_dt.mon, utc_dt.day);
        }

        IsoWeekDateStruct utc_iso_week_date() const {
            const DateStruct utc_dt = utc_date();
            return to_iso_week_date(utc_dt.year, utc_dt.mon, utc_dt.day);
        }

        bool is_workday() const noexcept {
            return is_workday_ms(local_ms());
        }

        bool is_weekend() const noexcept {
            return time_shield::is_weekend(ms_to_sec<ts_t>(local_ms()));
        }

        bool utc_is_workday() const noexcept {
            const DateStruct utc_dt = utc_date();
            return time_shield::is_workday(utc_dt.year, utc_dt.mon, utc_dt.day);
        }

        bool utc_is_weekend() const noexcept {
            return time_shield::is_weekend(ms_to_sec<ts_t>(m_utc_ms));
        }

        bool operator==(const DateTime& other) const noexcept {
            return m_utc_ms == other.m_utc_ms;
        }

        bool operator!=(const DateTime& other) const noexcept {
            return !(*this == other);
        }

        bool operator<(const DateTime& other) const noexcept {
            return m_utc_ms < other.m_utc_ms;
        }

        bool operator<=(const DateTime& other) const noexcept {
            return m_utc_ms <= other.m_utc_ms;
        }

        bool operator>(const DateTime& other) const noexcept {
            return m_utc_ms > other.m_utc_ms;
        }

        bool operator>=(const DateTime& other) const noexcept {
            return m_utc_ms >= other.m_utc_ms;
        }

        bool same_local(const DateTime& other) const noexcept {
            return local_ms() == other.local_ms() && m_offset == other.m_offset;
        }

        DateTime add_ms(int64_t delta_ms) const noexcept {
            return DateTime(m_utc_ms + delta_ms, m_offset);
        }

        DateTime add_seconds(int64_t seconds) const noexcept {
            return add_ms(sec_to_ms(seconds));
        }

        DateTime add_minutes(int64_t minutes) const noexcept {
            return add_ms(sec_to_ms(minutes * SEC_PER_MIN));
        }

        DateTime add_hours(int64_t hours) const noexcept {
            return add_ms(sec_to_ms(hours * SEC_PER_HOUR));
        }

        DateTime add_days(int64_t days) const noexcept {
            return add_ms(days * MS_PER_DAY);
        }

        int64_t diff_ms(const DateTime& other) const noexcept {
            return m_utc_ms - other.m_utc_ms;
        }

        double diff_seconds(const DateTime& other) const noexcept {
            return static_cast<double>(diff_ms(other)) / static_cast<double>(MS_PER_SEC);
        }

        DateTime with_offset(tz_t new_offset) const noexcept {
            return DateTime(m_utc_ms, new_offset);
        }

        DateTime to_utc() const noexcept {
            return with_offset(0);
        }

        DateTime start_of_day() const {
            const DateTimeStruct local_dt = to_date_time_struct_local();
            const ts_ms_t local_start_ms = to_timestamp_ms(local_dt.year, local_dt.mon, local_dt.day);
            return from_unix_ms(local_start_ms - offset_to_ms(m_offset), m_offset);
        }

        DateTime end_of_day() const {
            const DateTimeStruct local_dt = to_date_time_struct_local();
            const ts_ms_t local_end_ms = to_timestamp_ms(
                    local_dt.year,
                    local_dt.mon,
                    local_dt.day,
                    23,
                    59,
                    59,
                    static_cast<int>(MS_PER_SEC - 1));
            return from_unix_ms(local_end_ms - offset_to_ms(m_offset), m_offset);
        }

        DateTime start_of_month() const {
            const DateTimeStruct local_dt = to_date_time_struct_local();
            const ts_ms_t local_start_ms = to_timestamp_ms(local_dt.year, local_dt.mon, 1);
            return from_unix_ms(local_start_ms - offset_to_ms(m_offset), m_offset);
        }

        DateTime end_of_month() const {
            const DateTimeStruct local_dt = to_date_time_struct_local();
            const int days = num_days_in_month(local_dt.year, local_dt.mon);
            const ts_ms_t local_end_ms = to_timestamp_ms(
                    local_dt.year,
                    local_dt.mon,
                    days,
                    23,
                    59,
                    59,
                    static_cast<int>(MS_PER_SEC - 1));
            return from_unix_ms(local_end_ms - offset_to_ms(m_offset), m_offset);
        }

        DateTime start_of_year() const {
            const year_t local_year = year();
            const ts_ms_t local_start_ms = to_timestamp_ms(local_year, 1, 1);
            return from_unix_ms(local_start_ms - offset_to_ms(m_offset), m_offset);
        }

        DateTime end_of_year() const {
            const year_t local_year = year();
            const ts_ms_t local_end_ms = to_timestamp_ms(
                    local_year,
                    12,
                    31,
                    23,
                    59,
                    59,
                    static_cast<int>(MS_PER_SEC - 1));
            return from_unix_ms(local_end_ms - offset_to_ms(m_offset), m_offset);
        }

        DateTime start_of_utc_day() const {
            const DateTimeStruct utc_dt = to_date_time_struct_utc();
            return from_unix_ms(to_timestamp_ms(utc_dt.year, utc_dt.mon, utc_dt.day), m_offset);
        }

        DateTime end_of_utc_day() const {
            const DateTimeStruct utc_dt = to_date_time_struct_utc();
            return from_unix_ms(
                    to_timestamp_ms(
                        utc_dt.year,
                        utc_dt.mon,
                        utc_dt.day,
                        23,
                        59,
                        59,
                        static_cast<int>(MS_PER_SEC - 1)),
                    m_offset);
        }

        DateTime start_of_utc_month() const {
            const DateTimeStruct utc_dt = to_date_time_struct_utc();
            return from_unix_ms(to_timestamp_ms(utc_dt.year, utc_dt.mon, 1), m_offset);
        }

        DateTime end_of_utc_month() const {
            const DateTimeStruct utc_dt = to_date_time_struct_utc();
            const int days = num_days_in_month(utc_dt.year, utc_dt.mon);
            return from_unix_ms(
                    to_timestamp_ms(
                        utc_dt.year,
                        utc_dt.mon,
                        days,
                        23,
                        59,
                        59,
                        static_cast<int>(MS_PER_SEC - 1)),
                    m_offset);
        }

        DateTime start_of_utc_year() const {
            const year_t utc_year_value = utc_year();
            return from_unix_ms(to_timestamp_ms(utc_year_value, 1, 1), m_offset);
        }

        DateTime end_of_utc_year() const {
            const year_t utc_year_value = utc_year();
            return from_unix_ms(
                    to_timestamp_ms(
                        utc_year_value,
                        12,
                        31,
                        23,
                        59,
                        59,
                        static_cast<int>(MS_PER_SEC - 1)),
                    m_offset);
        }
 
    private:
        static bool try_parse_iso8601_buffer(const char* data, std::size_t size, DateTime& out) noexcept {
            if (data == nullptr) {
                return false;
            }
            DateTimeStruct dt = create_date_time_struct(0);
            TimeZoneStruct tz = create_time_zone_struct(0, 0, true);
            if (!time_shield::parse_iso8601(data, size, dt, tz)) {
                return false;
            }
            const tz_t offset = time_zone_struct_to_offset(tz);
            if (!is_valid_tz_offset(offset)) {
                return false;
            }
            const ts_ms_t utc_ms = dt_to_timestamp_ms(dt) - offset_to_ms(offset);
            out = from_unix_ms(utc_ms, offset);
            return true;
        }
 
        static DateTime parse_iso8601_buffer(const char* data, std::size_t size) {
            DateTime result;
            if (!try_parse_iso8601_buffer(data, size, result)) {
                throw std::invalid_argument("Invalid ISO8601 datetime");
            }
            return result;
        }
 
        DateTime(ts_ms_t utc_ms, tz_t offset) noexcept
            : m_utc_ms(utc_ms)
            , m_offset(offset) {}
 
        static TIME_SHIELD_CONSTEXPR ts_ms_t offset_to_ms(tz_t offset) noexcept {
            return static_cast<ts_ms_t>(offset) * MS_PER_SEC;
        }
 
        ts_ms_t local_ms() const noexcept {
            return m_utc_ms + offset_to_ms(m_offset);
        }
 
        ts_ms_t m_utc_ms;
        tz_t m_offset;
    };
 
} // namespace time_shield
 
#endif // _TIME_SHIELD_DATE_TIME_HPP_INCLUDED