1/**************************************************************************/
2/* time.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef TIME_H
32#define TIME_H
33
34#include "core/object/class_db.h"
35#include "time_enums.h"
36
37// This Time class conforms with as many of the ISO 8601 standards as possible.
38// * As per ISO 8601:2004 4.3.2.1, all dates follow the Proleptic Gregorian
39// calendar. As such, the day before 1582-10-15 is 1582-10-14, not 1582-10-04.
40// See: https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar
41// * As per ISO 8601:2004 3.4.2 and 4.1.2.4, the year before 1 AD (aka 1 BC)
42// is number "0", with the year before that (2 BC) being "-1", etc.
43// Conversion methods assume "the same timezone", and do not handle DST.
44// Leap seconds are not handled, they must be done manually if desired.
45// Suffixes such as "Z" are not handled, you need to strip them away manually.
46
47class Time : public Object {
48 GDCLASS(Time, Object);
49 static void _bind_methods();
50 static Time *singleton;
51
52public:
53 static Time *get_singleton();
54
55 // Methods that convert times.
56 Dictionary get_datetime_dict_from_unix_time(int64_t p_unix_time_val) const;
57 Dictionary get_date_dict_from_unix_time(int64_t p_unix_time_val) const;
58 Dictionary get_time_dict_from_unix_time(int64_t p_unix_time_val) const;
59 String get_datetime_string_from_unix_time(int64_t p_unix_time_val, bool p_use_space = false) const;
60 String get_date_string_from_unix_time(int64_t p_unix_time_val) const;
61 String get_time_string_from_unix_time(int64_t p_unix_time_val) const;
62 Dictionary get_datetime_dict_from_datetime_string(String p_datetime, bool p_weekday = true) const;
63 String get_datetime_string_from_datetime_dict(const Dictionary p_datetime, bool p_use_space = false) const;
64 int64_t get_unix_time_from_datetime_dict(const Dictionary p_datetime) const;
65 int64_t get_unix_time_from_datetime_string(String p_datetime) const;
66 String get_offset_string_from_offset_minutes(int64_t p_offset_minutes) const;
67
68 // Methods that get information from OS.
69 Dictionary get_datetime_dict_from_system(bool p_utc = false) const;
70 Dictionary get_date_dict_from_system(bool p_utc = false) const;
71 Dictionary get_time_dict_from_system(bool p_utc = false) const;
72 String get_datetime_string_from_system(bool p_utc = false, bool p_use_space = false) const;
73 String get_date_string_from_system(bool p_utc = false) const;
74 String get_time_string_from_system(bool p_utc = false) const;
75 Dictionary get_time_zone_from_system() const;
76 double get_unix_time_from_system() const;
77 uint64_t get_ticks_msec() const;
78 uint64_t get_ticks_usec() const;
79
80 Time();
81 virtual ~Time();
82};
83
84VARIANT_ENUM_CAST(Month);
85VARIANT_ENUM_CAST(Weekday);
86
87#endif // TIME_H
88