date_time.hpp

Go to the documentation of this file.

#pragma once
#include "globalization/culture_info.hpp"
#include "chrono.hpp"
#include "date_time_kind.hpp"
#include "day_of_week.hpp"
#include "icomparable.hpp"
#include "iequatable.hpp"
#include "iformatable.hpp"
#include "month_of_year.hpp"
#include "object.hpp"
#include "ticks.hpp"
#include "time_span.hpp"
#include "string.hpp"
#include <ctime>

namespace xtd {
  class time_zone_info;
  
  
  class core_export_ date_time : public xtd::object, public xtd::icomparable<date_time>, public xtd::iequatable<date_time>, public xtd::iformatable {
  public:
    
    static const date_time max_value;
    static const date_time min_value;
    
    
    date_time() = default;
    explicit date_time(xtd::int64 ticks);
    explicit date_time(xtd::ticks ticks);
    date_time(xtd::int64 ticks, xtd::date_time_kind kind);
    date_time(xtd::ticks ticks, xtd::date_time_kind kind);
    date_time(xtd::uint32 year, xtd::uint32 month, xtd::uint32 day);
    date_time(xtd::uint32 year, xtd::uint32 month, xtd::uint32 day, xtd::uint32 hour, xtd::uint32 minute, xtd::uint32 second);
    date_time(xtd::uint32 year, xtd::uint32 month, xtd::uint32 day, xtd::uint32 hour, xtd::uint32 minute, xtd::uint32 second, xtd::date_time_kind kind);
    date_time(xtd::uint32 year, xtd::uint32 month, xtd::uint32 day, xtd::uint32 hour, xtd::uint32 minute, xtd::uint32 second, xtd::uint32 millisecond);
    date_time(xtd::uint32 year, xtd::uint32 month, xtd::uint32 day, xtd::uint32 hour, xtd::uint32 minute, xtd::uint32 second, xtd::uint32 millisecond, xtd::date_time_kind kind);
    
    template<typename clock_t, typename duration_t = clock_t::duration> // Can't be explicit by design.
    date_time(const std::chrono::time_point<clock_t, duration_t>& time_point) {
      *this = from_time_t(std::chrono::system_clock::to_time_t(std::chrono::system_clock::now() + std::chrono::duration_cast<std::chrono::system_clock::duration>(time_point - clock_t::now())), date_time_kind::local);
    }
    
    template<typename clock_t, typename duration_t = clock_t::duration>
    date_time(const std::chrono::time_point<clock_t, duration_t>& time_point, date_time_kind kind) {
      *this = from_time_t(std::chrono::system_clock::to_time_t(std::chrono::system_clock::now() + std::chrono::duration_cast<std::chrono::system_clock::duration>(time_point - clock_t::now())), kind);
    }

    
    date_time(const date_time&) = default;
    date_time(date_time&&) = default;
    date_time& operator =(const date_time&) = default;
    
    
    
    [[nodiscard]] auto date() const noexcept -> date_time;
    
    [[nodiscard]] auto day() const noexcept -> xtd::uint32;
    
    [[nodiscard]] auto day_of_week() const noexcept -> xtd::day_of_week;
    
    [[nodiscard]] auto day_of_year() const noexcept -> xtd::uint32;
    
    [[nodiscard]] auto hour() const noexcept -> xtd::uint32;
    
    [[nodiscard]] auto kind() const noexcept -> xtd::date_time_kind;
    
    [[nodiscard]] auto millisecond() const noexcept -> xtd::uint32;
    
    [[nodiscard]] auto minute() const noexcept -> xtd::uint32;
    
    [[nodiscard]] auto month() const noexcept -> xtd::uint32;
    
    [[nodiscard]] auto second() const noexcept -> xtd::uint32;
    
    [[nodiscard]] auto ticks() const noexcept -> xtd::int64;
    
    [[nodiscard]] auto ticks_duration() const noexcept -> xtd::ticks;
    
    [[nodiscard]] auto time_of_day() const noexcept -> xtd::time_span;
    
    [[nodiscard]] auto year() const noexcept -> xtd::uint32;
    
    
    [[nodiscard]] auto add(const xtd::time_span& value) const -> date_time;
    
    [[nodiscard]] auto add_days(double value) const -> date_time;
    
    [[nodiscard]] auto add_hours(double value) const -> date_time;
    
    [[nodiscard]] auto add_milliseconds(double value) const -> date_time;
    
    [[nodiscard]] auto add_minutes(double value) const -> date_time;
    
    [[nodiscard]] auto add_months(xtd::int32 months) const -> date_time;
    
    [[nodiscard]] auto add_seconds(double value) const -> date_time;
    
    [[nodiscard]] auto add_ticks(xtd::int64 value) const -> date_time;
    
    [[nodiscard]] auto add_years(xtd::int32 value) const -> date_time;
    
    [[nodiscard]] auto compare_to(const date_time& value) const noexcept -> xtd::int32 override;
    
    [[nodiscard]] auto equals(const object& obj) const noexcept -> bool override;
    [[nodiscard]] auto equals(const date_time& other) const noexcept -> bool override;
    
    [[nodiscard]] auto get_hash_code() const noexcept -> xtd::size override;
    
    [[nodiscard]] auto get_date_time_formats() const noexcept -> xtd::array<xtd::string>;
    
    [[nodiscard]] auto is_daylight_saving_time() const noexcept -> bool;
    
    [[nodiscard]] auto subtract(const date_time& value) const -> xtd::time_span;
    [[nodiscard]] auto subtract(const xtd::time_span& value) const -> date_time;
    
    [[nodiscard]] auto to_binary() const -> xtd::int64;
    
    [[nodiscard]] auto to_file_time() const -> xtd::int64;
    
    [[nodiscard]] auto to_file_time_utc() const -> xtd::int64;
    
    [[nodiscard]] auto to_local_time() const -> date_time;
    
    [[nodiscard]] auto to_long_date_string() const -> xtd::string;
    
    [[nodiscard]] auto to_long_time_string() const -> xtd::string;
    
    [[nodiscard]] auto to_short_date_string() const -> xtd::string;
    
    [[nodiscard]] auto to_short_time_string() const -> xtd::string;
    
    [[nodiscard]] auto to_string() const noexcept -> xtd::string override;
    [[nodiscard]] auto to_string(const xtd::string& format) const -> xtd::string;
    [[nodiscard]] auto to_string(const xtd::string& format, const xtd::globalization::culture_info& culture) const -> xtd::string override;
    [[nodiscard]] auto to_string(const xtd::globalization::culture_info& culture) const -> xtd::string;
    
    [[nodiscard]] auto to_time_t() const -> std::time_t;
    
    [[nodiscard]] auto to_tm() const -> std::tm;
    
    [[nodiscard]] auto to_universal_time() const -> date_time;
    
    
    [[nodiscard]] static auto now() noexcept -> date_time;
    
    [[nodiscard]] static auto today() noexcept -> date_time;
    
    [[nodiscard]] static auto utc_now() noexcept -> date_time;
    
    [[nodiscard]] static auto days_in_month(xtd::uint32 year, xtd::month_of_year month) -> xtd::int32;
    
    [[nodiscard]] static auto days_in_month(xtd::uint32 year, xtd::uint32 month) -> xtd::int32;
    
    [[nodiscard]] static auto from_binary(xtd::int64 date_data) -> date_time;
    
    [[nodiscard]] static auto from_file_time(xtd::int64 file_time) -> date_time;
    [[nodiscard]] static auto from_file_time_utc(xtd::int64 file_time) -> date_time;
    
    [[nodiscard]] static auto from_duration(const xtd::time_span& value) -> date_time;
    static auto from_duration(const xtd::time_span& value, xtd::date_time_kind kind) -> date_time;
    
    [[nodiscard]] static auto from_time_t(std::time_t value) -> date_time;
    [[nodiscard]] static auto from_time_t(std::time_t value, xtd::date_time_kind kind) -> date_time;
    
    [[nodiscard]] static auto from_tm(const std::tm& value) -> date_time;
    [[nodiscard]] static auto from_tm(const std::tm& value, xtd::date_time_kind kind) -> date_time;
    
    [[nodiscard]] static auto is_leap_year(xtd::uint32 year) -> bool;
    
    [[nodiscard]] static auto parse(const xtd::string& s) -> date_time;
    [[nodiscard]] static auto parse(const xtd::string& s, const xtd::globalization::culture_info& culture) -> date_time;
    
    [[nodiscard]] static auto specify_kind(const date_time& value, xtd::date_time_kind kind) -> date_time;
    
    [[nodiscard]] static auto sprintf(const xtd::string& format, const xtd::date_time& value) -> xtd::string;
    [[nodiscard]] static auto sprintf(const xtd::string& format, const date_time& value, const xtd::globalization::culture_info& culture) -> xtd::string;
    
    [[nodiscard]] static auto try_parse(const xtd::string& s, date_time& result) noexcept -> bool;
    [[nodiscard]] static auto try_parse(const xtd::string& s, date_time& result, const xtd::globalization::culture_info& culture) noexcept -> bool;
    
    [[nodiscard]] static auto try_parse_exact(const xtd::string& text, const xtd::string& format, date_time& result) noexcept -> bool;
    [[nodiscard]] static auto try_parse_exact(const xtd::string& text, const xtd::string& format, date_time& result, const xtd::globalization::culture_info& culture) noexcept -> bool;
    [[nodiscard]] static auto try_parse_exact(const xtd::string& text, const xtd::array<xtd::string>& formats, date_time& result) noexcept -> bool;
    [[nodiscard]] static auto try_parse_exact(const xtd::string& text, const xtd::array<xtd::string>& formats, date_time& result, const xtd::globalization::culture_info& culture) noexcept -> bool;
    
    operator xtd::time_span() const;
    auto operator +=(const date_time& value) -> date_time = delete;
    auto operator +=(const xtd::time_span& value) -> date_time;
    auto operator -=(const date_time& value) -> xtd::time_span;
    auto operator -=(const xtd::time_span& value) -> xtd::time_span;
    auto operator +() const -> date_time;
    auto operator -() const -> date_time;
    auto operator +(const date_time& value) const -> date_time = delete;
    auto operator +(const xtd::time_span& value) const -> date_time;
    auto operator -(const date_time& value) const -> xtd::time_span;
    auto operator -(const xtd::time_span& value) const -> date_time;
    auto operator ++() -> date_time&;
    auto operator ++(int) -> date_time;
    auto operator --() -> date_time&;
    auto operator --(int) -> date_time;
    friend auto operator << (std::ostream& os, const date_time& value) -> std::ostream& {return os << value.to_string();}
    
  private:
    friend class xtd::time_zone_info;
    [[nodiscard]] auto utc_offset() const -> xtd::ticks;
    [[nodiscard]] auto get_date_time() const -> std::tuple<xtd::uint32, xtd::uint32, xtd::uint32, xtd::uint32, xtd::uint32, xtd::uint32, xtd::uint32, xtd::int32>;
    auto set_date_time(xtd::uint32 year, xtd::uint32 month, xtd::uint32 day, xtd::uint32 hour, xtd::uint32 minute, xtd::uint32 second, xtd::uint32 millisecond, xtd::date_time_kind kind) -> void;
    [[nodiscard]] static auto standard_format_to_custom_format(char standard_format, const xtd::globalization::culture_info& culture) noexcept -> xtd::string;
    [[nodiscard]] auto to_string_custom(const xtd::string& format, const xtd::globalization::culture_info& culture) const -> xtd::string;
    [[nodiscard]] auto to_string_put_time(const xtd::string& format, const xtd::globalization::culture_info& culture) const -> xtd::string;
    [[nodiscard]] auto to_string_standard(char format, const xtd::globalization::culture_info& culture) const -> xtd::string;
    
    xtd::ticks value_ {0};
    date_time_kind kind_ {date_time_kind::unspecified};
  };

}
 
/*
#if defined(__xtd__cpp_lib_format)
template <>
struct std::formatter<xtd::date_time> : std::formatter<std::string> {
  template<typename format_context_t>
  constexpr auto parse(format_context_t& ctx) {
    auto iterator = ctx.begin();
    for (; iterator != ctx.end() && *iterator != '}'; ++iterator)
      format_value += *iterator;
    return iterator;
  }
 
  template<typename object_t, typename format_context_t>
  auto format(const object_t& obj, format_context_t& ctx) const {return std::format_to(ctx.out(), "{}", std::string {obj.to_string(format_value)});}
 
private:
  std::string format_value;
};
#endif
*/