cc2e84226c80f550de741d1396b053b17b3d0fd5
[WebKit-https.git] / Source / JavaScriptCore / wtf / DateMath.h
1 /*
2  * Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
4  * Copyright (C) 2009 Google Inc. All rights reserved.
5  * Copyright (C) 2010 Research In Motion Limited. All rights reserved.
6  *
7  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
8  *
9  * The contents of this file are subject to the Mozilla Public License Version
10  * 1.1 (the "License"); you may not use this file except in compliance with
11  * the License. You may obtain a copy of the License at
12  * http://www.mozilla.org/MPL/
13  *
14  * Software distributed under the License is distributed on an "AS IS" basis,
15  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
16  * for the specific language governing rights and limitations under the
17  * License.
18  *
19  * The Original Code is Mozilla Communicator client code, released
20  * March 31, 1998.
21  *
22  * The Initial Developer of the Original Code is
23  * Netscape Communications Corporation.
24  * Portions created by the Initial Developer are Copyright (C) 1998
25  * the Initial Developer. All Rights Reserved.
26  *
27  * Contributor(s):
28  *
29  * Alternatively, the contents of this file may be used under the terms of
30  * either of the GNU General Public License Version 2 or later (the "GPL"),
31  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
32  * in which case the provisions of the GPL or the LGPL are applicable instead
33  * of those above. If you wish to allow use of your version of this file only
34  * under the terms of either the GPL or the LGPL, and not to allow others to
35  * use your version of this file under the terms of the MPL, indicate your
36  * decision by deleting the provisions above and replace them with the notice
37  * and other provisions required by the GPL or the LGPL. If you do not delete
38  * the provisions above, a recipient may use your version of this file under
39  * the terms of any one of the MPL, the GPL or the LGPL.
40  *
41  */
42
43 #ifndef DateMath_h
44 #define DateMath_h
45
46 #include <math.h>
47 #include <stdint.h>
48 #include <string.h>
49 #include <time.h>
50 #include <wtf/CurrentTime.h>
51 #include <wtf/Noncopyable.h>
52 #include <wtf/OwnArrayPtr.h>
53 #include <wtf/PassOwnArrayPtr.h>
54 #include <wtf/text/WTFString.h>
55 #include <wtf/UnusedParam.h>
56
57 namespace WTF {
58 void initializeDates();
59 int equivalentYearForDST(int year);
60
61 // Not really math related, but this is currently the only shared place to put these.
62 double parseES5DateFromNullTerminatedCharacters(const char* dateString);
63 double parseDateFromNullTerminatedCharacters(const char* dateString);
64 double timeClip(double);
65 // dayOfWeek: [0, 6] 0 being Monday, day: [1, 31], month: [0, 11], year: ex: 2011, hours: [0, 23], minutes: [0, 59], seconds: [0, 59], utcOffset: [-720,720]. 
66 String makeRFC2822DateString(unsigned dayOfWeek, unsigned day, unsigned month, unsigned year, unsigned hours, unsigned minutes, unsigned seconds, int utcOffset);
67
68 inline double jsCurrentTime()
69 {
70     // JavaScript doesn't recognize fractions of a millisecond.
71     return floor(WTF::currentTimeMS());
72 }
73
74 const char * const weekdayName[7] = { "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" };
75 const char * const monthName[12] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
76
77 const double hoursPerDay = 24.0;
78 const double minutesPerHour = 60.0;
79 const double secondsPerHour = 60.0 * 60.0;
80 const double secondsPerMinute = 60.0;
81 const double msPerSecond = 1000.0;
82 const double msPerMinute = 60.0 * 1000.0;
83 const double msPerHour = 60.0 * 60.0 * 1000.0;
84 const double msPerDay = 24.0 * 60.0 * 60.0 * 1000.0;
85 const double msPerMonth = 2592000000.0;
86
87 // Returns the number of days from 1970-01-01 to the specified date.
88 double dateToDaysFrom1970(int year, int month, int day);
89 int msToYear(double ms);
90 int dayInYear(double ms, int year);
91 int monthFromDayInYear(int dayInYear, bool leapYear);
92 int dayInMonthFromDayInYear(int dayInYear, bool leapYear);
93
94 // Returns offset milliseconds for UTC and DST.
95 int32_t calculateUTCOffset();
96 double calculateDSTOffset(double ms, double utcOffset);
97
98 } // namespace WTF
99
100 using WTF::adoptArrayPtr;
101 using WTF::dateToDaysFrom1970;
102 using WTF::dayInMonthFromDayInYear;
103 using WTF::dayInYear;
104 using WTF::minutesPerHour;
105 using WTF::monthFromDayInYear;
106 using WTF::msPerDay;
107 using WTF::msPerMinute;
108 using WTF::msPerSecond;
109 using WTF::msToYear;
110 using WTF::secondsPerMinute;
111 using WTF::parseDateFromNullTerminatedCharacters;
112 using WTF::makeRFC2822DateString;
113 using WTF::calculateUTCOffset;
114 using WTF::calculateDSTOffset;
115
116 #if USE(JSC)
117 namespace JSC {
118 class ExecState;
119 struct GregorianDateTime;
120
121 void msToGregorianDateTime(ExecState*, double, bool outputIsUTC, GregorianDateTime&);
122 double gregorianDateTimeToMS(ExecState*, const GregorianDateTime&, double, bool inputIsUTC);
123 double getUTCOffset(ExecState*);
124 double parseDateFromNullTerminatedCharacters(ExecState*, const char* dateString);
125
126 // Intentionally overridding the default tm of the system.
127 // The members of tm differ on various operating systems.
128 struct GregorianDateTime {
129     WTF_MAKE_NONCOPYABLE(GregorianDateTime);
130 public:
131     GregorianDateTime()
132         : second(0)
133         , minute(0)
134         , hour(0)
135         , weekDay(0)
136         , monthDay(0)
137         , yearDay(0)
138         , month(0)
139         , year(0)
140         , isDST(0)
141         , utcOffset(0)
142     {
143     }
144
145     GregorianDateTime(ExecState* exec, const tm& inTm)
146         : second(inTm.tm_sec)
147         , minute(inTm.tm_min)
148         , hour(inTm.tm_hour)
149         , weekDay(inTm.tm_wday)
150         , monthDay(inTm.tm_mday)
151         , yearDay(inTm.tm_yday)
152         , month(inTm.tm_mon)
153         , year(inTm.tm_year)
154         , isDST(inTm.tm_isdst)
155     {
156         UNUSED_PARAM(exec);
157 #if HAVE(TM_GMTOFF)
158         utcOffset = static_cast<int>(inTm.tm_gmtoff);
159 #else
160         utcOffset = static_cast<int>(getUTCOffset(exec) / WTF::msPerSecond + (isDST ? WTF::secondsPerHour : 0));
161 #endif
162
163 #if HAVE(TM_ZONE)
164         int inZoneSize = strlen(inTm.tm_zone) + 1;
165         timeZone = adoptArrayPtr(new char[inZoneSize]);
166         strncpy(timeZone.get(), inTm.tm_zone, inZoneSize);
167 #else
168         timeZone = nullptr;
169 #endif
170     }
171
172     operator tm() const
173     {
174         tm ret;
175         memset(&ret, 0, sizeof(ret));
176
177         ret.tm_sec   =  second;
178         ret.tm_min   =  minute;
179         ret.tm_hour  =  hour;
180         ret.tm_wday  =  weekDay;
181         ret.tm_mday  =  monthDay;
182         ret.tm_yday  =  yearDay;
183         ret.tm_mon   =  month;
184         ret.tm_year  =  year;
185         ret.tm_isdst =  isDST;
186
187 #if HAVE(TM_GMTOFF)
188         ret.tm_gmtoff = static_cast<long>(utcOffset);
189 #endif
190 #if HAVE(TM_ZONE)
191         ret.tm_zone = timeZone.get();
192 #endif
193
194         return ret;
195     }
196
197     void copyFrom(const GregorianDateTime& rhs)
198     {
199         second = rhs.second;
200         minute = rhs.minute;
201         hour = rhs.hour;
202         weekDay = rhs.weekDay;
203         monthDay = rhs.monthDay;
204         yearDay = rhs.yearDay;
205         month = rhs.month;
206         year = rhs.year;
207         isDST = rhs.isDST;
208         utcOffset = rhs.utcOffset;
209         if (rhs.timeZone) {
210             int inZoneSize = strlen(rhs.timeZone.get()) + 1;
211             timeZone = adoptArrayPtr(new char[inZoneSize]);
212             strncpy(timeZone.get(), rhs.timeZone.get(), inZoneSize);
213         } else
214             timeZone = nullptr;
215     }
216
217     int second;
218     int minute;
219     int hour;
220     int weekDay;
221     int monthDay;
222     int yearDay;
223     int month;
224     int year;
225     int isDST;
226     int utcOffset;
227     OwnArrayPtr<char> timeZone;
228 };
229
230 static inline int gmtoffset(const GregorianDateTime& t)
231 {
232     return t.utcOffset;
233 }
234 } // namespace JSC
235 #endif // USE(JSC)
236
237 #endif // DateMath_h