Source/WTF/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/text/WTFString.h>
  53
  54 namespace WTF {
  55
  56 struct LocalTimeOffset {
  57     LocalTimeOffset()
  58         : isDST(false)
  59         , offset(0)
  60     {
  61     }
  62
  63     LocalTimeOffset(bool isDST, int offset)
  64         : isDST(isDST)
  65         , offset(offset)
  66     {
  67     }
  68
  69     bool operator==(const LocalTimeOffset& other)
  70     {
  71         return isDST == other.isDST && offset == other.offset;
  72     }
  73
  74     bool operator!=(const LocalTimeOffset& other)
  75     {
  76         return isDST != other.isDST || offset != other.offset;
  77     }
  78
  79     bool isDST;
  80     int offset;
  81 };
  82
  83 void initializeDates();
  84 int equivalentYearForDST(int year);
  85
  86 // Not really math related, but this is currently the only shared place to put these.
  87 WTF_EXPORT_PRIVATE double parseES5DateFromNullTerminatedCharacters(const char* dateString);
  88 WTF_EXPORT_PRIVATE double parseDateFromNullTerminatedCharacters(const char* dateString);
  89 WTF_EXPORT_PRIVATE double parseDateFromNullTerminatedCharacters(const char* dateString, bool& haveTZ, int& offset);
  90 WTF_EXPORT_PRIVATE double timeClip(double);
  91 // 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].
  92 String makeRFC2822DateString(unsigned dayOfWeek, unsigned day, unsigned month, unsigned year, unsigned hours, unsigned minutes, unsigned seconds, int utcOffset);
  93
  94 inline double jsCurrentTime()
  95 {
  96     // JavaScript doesn't recognize fractions of a millisecond.
  97     return floor(WTF::currentTimeMS());
  98 }
  99
 100 const char* const weekdayName[7] = { "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" };
 101 const char* const monthName[12] = { "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec" };
 102 const char* const monthFullName[12] = { "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" };
 103
 104 const double hoursPerDay = 24.0;
 105 const double minutesPerHour = 60.0;
 106 const double secondsPerMinute = 60.0;
 107 const double msPerSecond = 1000.0;
 108 const double msPerMonth = 2592000000.0;
 109 const double secondsPerHour = secondsPerMinute * minutesPerHour;
 110 const double secondsPerDay = secondsPerHour * hoursPerDay;
 111 const double msPerMinute = msPerSecond * secondsPerMinute;
 112 const double msPerHour = msPerSecond * secondsPerHour;
 113 const double msPerDay = msPerSecond * secondsPerDay;
 114
 115 WTF_EXPORT_PRIVATE bool isLeapYear(int year);
 116
 117 // Returns the number of days from 1970-01-01 to the specified date.
 118 WTF_EXPORT_PRIVATE double dateToDaysFrom1970(int year, int month, int day);
 119 WTF_EXPORT_PRIVATE int msToYear(double ms);
 120 WTF_EXPORT_PRIVATE double msToDays(double ms);
 121 WTF_EXPORT_PRIVATE int msToMinutes(double ms);
 122 WTF_EXPORT_PRIVATE int msToHours(double ms);
 123 WTF_EXPORT_PRIVATE int dayInYear(int year, int month, int day);
 124 WTF_EXPORT_PRIVATE int dayInYear(double ms, int year);
 125 WTF_EXPORT_PRIVATE int monthFromDayInYear(int dayInYear, bool leapYear);
 126 WTF_EXPORT_PRIVATE int dayInMonthFromDayInYear(int dayInYear, bool leapYear);
 127
 128 // Returns combined offset in millisecond (UTC + DST).
 129 WTF_EXPORT_PRIVATE LocalTimeOffset calculateLocalTimeOffset(double utcInMilliseconds);
 130
 131 } // namespace WTF
 132
 133 using WTF::isLeapYear;
 134 using WTF::dateToDaysFrom1970;
 135 using WTF::dayInMonthFromDayInYear;
 136 using WTF::dayInYear;
 137 using WTF::minutesPerHour;
 138 using WTF::monthFromDayInYear;
 139 using WTF::msPerDay;
 140 using WTF::msPerHour;
 141 using WTF::msPerMinute;
 142 using WTF::msPerSecond;
 143 using WTF::msToYear;
 144 using WTF::msToDays;
 145 using WTF::msToMinutes;
 146 using WTF::msToHours;
 147 using WTF::secondsPerDay;
 148 using WTF::secondsPerMinute;
 149 using WTF::parseDateFromNullTerminatedCharacters;
 150 using WTF::makeRFC2822DateString;
 151 using WTF::LocalTimeOffset;
 152 using WTF::calculateLocalTimeOffset;
 153
 154 #endif // DateMath_h