root/trunk/bevutils/date.d

// Written in the D programming language.

/**
 * Dates are represented in several formats. The date implementation revolves
 * around a central type, d_time, from which other formats are converted to and
 * from.
 * Dates are calculated using the Gregorian calendar.
 * References:
 *  $(LINK2 http://en.wikipedia.org/wiki/Gregorian_calendar, Gregorian calendar (Wikipedia))
 * Macros:
 *  WIKI = Phobos/StdDate
 */

// Copyright (c) 1999-2006 by Digital Mars
// All Rights Reserved
// written by Walter Bright
// www.digitalmars.com

module std.date;

private import std.stdio;
private import std.dateparse;

/**
 * d_time is a signed arithmetic type giving the time elapsed since January 1,
 * 1970.
 * Negative values are for dates preceding 1970. The time unit used is Ticks.
 * Ticks are milliseconds or smaller intervals.
 *
 * The usual arithmetic operations can be performed on d_time, such as adding,
 * subtracting, etc. Elapsed time in Ticks can be computed by subtracting a
 * starting d_time from an ending d_time. 
 */
alias long d_time;

/**
 * A value for d_time that does not represent a valid time.
 */
const d_time d_time_nan = long.min;

/**
 * Time broken down into its components.
 */
struct Date
{
    int year = int.min; /// use int.min as "nan" year value
    int month;         /// 1..12
    int day;           /// 1..31
    int hour;          /// 0..23
    int minute;     /// 0..59
    int second;     /// 0..59
    int ms;           /// 0..999
    int weekday;       /// 0: not specified, 1..7: Sunday..Saturday
    int yday;        /// 1..365(366)
    int tzcorrection = int.min; /// -1200..1200 correction in hours

    void fromTicks(d_time t)
    {   
        int y;
        int d;
        int m;

        if (t == d_time_nan)
            throw new Exception("Bad d_time value");

        // Hazard a guess
        y = 1970 + cast(int) (t / (3652425 * (msPerDay / 10000)));

        if (TimeFromYear(y) <= t)
        {
            while (TimeFromYear(y + 1) <= t)
                y++;
        }
        else
        {
            do
            {
                y--;
            } while (TimeFromYear(y) > t);
        }
        year = y;

        int leap = LeapYear(y);
        d = Day(t) - DayFromYear(year);
        yday = d;

        if (d < 59)
        {
            if (d < 31)
            {
                assert(d >= 0);
                m = 0;
            }
            else
            {
                m = 1;
            }
        }
        else
        {
            d -= leap;
            if (d < 212)
            {
                if (d < 59)
                    m = 1;
                else if (d < 90)
                    m = 2;
                else if (d < 120)
                    m = 3;
                else if (d < 151)
                    m = 4;
                else if (d < 181)
                    m = 5;
                else
                    m = 6;
            }
            else
            {
                if (d < 243)
                    m = 7;
                else if (d < 273)
                    m = 8;
                else if (d < 304)
                    m = 9;
                else if (d < 334)
                    m = 10;
                else if (d < 365)
                    m = 11;
                else
                    assert(0);
            }
        }
        month = m+1;
        switch (m)
        {
            case 0:  day = d +   1;      break;
            case 1:  day = d -  30;      break;
            case 2:  day = d -  58 - leap;   break;
            case 3:  day = d -  89 - leap;   break;
            case 4:  day = d - 119 - leap;   break;
            case 5:  day = d - 150 - leap;   break;
            case 6:  day = d - 180 - leap;   break;
            case 7:  day = d - 211 - leap;   break;
            case 8:  day = d - 242 - leap;   break;
            case 9:  day = d - 272 - leap;   break;
            case 10: day = d - 303 - leap;   break;
            case 11: day = d - 333 - leap;   break;
            default:
                assert(0);
        }
        hour = HourFromTime(t);
        minute = MinFromTime(t);
        second = SecFromTime(t);
        ms = msFromTime(t);
        weekday = WeekDay(t);
    }

    /// Parse date out of string s[] and store it in this Date instance.
    void parse(char[] s)
    {
         DateParse dp;
         dp.parse(s, *this);
    }
}

enum
{
    HoursPerDay    = 24,
    MinutesPerHour = 60,
    msPerMinute    = 60 * 1000,
    msPerHour      = 60 * msPerMinute,
    msPerDay       = 86400000,
    TicksPerMs     = 1,
    TicksPerSecond = 1000,          /// Will be at least 1000
    TicksPerMinute = TicksPerSecond * 60,
    TicksPerHour   = TicksPerMinute * 60,
    TicksPerDay    = TicksPerHour   * 24,
}

d_time LocalTZA = 0;


const char[] daystr = "SunMonTueWedThuFriSat";
const char[] monstr = "JanFebMarAprMayJunJulAugSepOctNovDec";

const int[12] mdays = [ 0,31,59,90,120,151,181,212,243,273,304,334 ];

/********************************
 * Compute year and week [1..53] from t. The ISO 8601 week 1 is the first week
 * of the year that includes January 4. Monday is the first day of the week.
 * References:
 *  $(LINK2 http://en.wikipedia.org/wiki/ISO_8601, ISO 8601 (Wikipedia))
 */

void toISO8601YearWeek(d_time t, out int year, out int week)
{
    year = YearFromTime(t);

    int yday = Day(t) - DayFromYear(year);
    int d;
    int w;
    int ydaybeg;

    /* Determine day of week Jan 4 falls on.
     * Weeks begin on a Monday.
     */

    d = DayFromYear(year);
    w = (d + 3/*Jan4*/ + 3) % 7;
    if (w < 0)
        w += 7;

    /* Find yday of beginning of ISO 8601 year
     */
    ydaybeg = 3/*Jan4*/ - w;

    /* Check if yday is actually the last week of the previous year
     */
    if (yday < ydaybeg)
    {
    year -= 1;
    week = 53;
        return;
    }

    /* Check if yday is actually the first week of the next year
     */
    if (yday >= 362)                            // possible
    {   int d2;
        int ydaybeg2;

        d2 = DayFromYear(year + 1);
        w = (d2 + 3/*Jan4*/ + 3) % 7;
        if (w < 0)
            w += 7;
        //printf("w = %d\n", w);
        ydaybeg2 = 3/*Jan4*/ - w;
        if (d + yday >= d2 + ydaybeg2)
        {
        year += 1;
        week = 1;
            return;
        }
    }

    week = (yday - ydaybeg) / 7 + 1;
}

/* ***********************************
 * Divide time by divisor. Always round down, even if d is negative.
 */

d_time floor(d_time d, int divisor)
{
    if (d < 0)
    d -= divisor - 1;
    return d / divisor;
}

int dmod(d_time n, d_time d)
{   d_time r;

    r = n % d;
    if (r < 0)
    r += d;
    assert(cast(int)r == r);
    return cast(int)r;
}

int HourFromTime(d_time t)
{
    return dmod(floor(t, msPerHour), HoursPerDay);
}

int MinFromTime(d_time t)
{
    return dmod(floor(t, msPerMinute), MinutesPerHour);
}

int SecFromTime(d_time t)
{
    return dmod(floor(t, TicksPerSecond), 60);
}

int msFromTime(d_time t)
{
    return dmod(t / (TicksPerSecond / 1000), 1000);
}

int TimeWithinDay(d_time t)
{
    return dmod(t, msPerDay);
}

d_time toInteger(d_time n)
{
    return n;
}

int Day(d_time t)
{
    return cast(int)floor(t, msPerDay);
}

int LeapYear(int y)
{
    return ((y & 3) == 0 &&
        (y % 100 || (y % 400) == 0));
}

int DaysInYear(int y)
{
    return 365 + LeapYear(y);
}

int DayFromYear(int y)
{
    return cast(int) (365 * (y - 1970) +
        floor((y - 1969), 4) -
        floor((y - 1901), 100) +
        floor((y - 1601), 400));
}

d_time TimeFromYear(int y)
{
    return cast(d_time)msPerDay * DayFromYear(y);
}

/*****************************
 * Calculates the year from the d_time t.
 */

int YearFromTime(d_time t)
{   
    int y;

    if (t == d_time_nan)
        return 0;

    // Hazard a guess
    // y = 1970 + cast(int) (t / (365.2425 * msPerDay));
    // Use integer only math
    y = 1970 + cast(int) (t / (3652425 * (msPerDay / 10000)));

    if (TimeFromYear(y) <= t)
    {
         while (TimeFromYear(y + 1) <= t)
             y++;
    }
    else
    {
         do
         {
             y--;
         } while (TimeFromYear(y) > t);
    }
    return y;
}

/*******************************
 * Determines if d_time t is a leap year.
 *
 * A leap year is every 4 years except years ending in 00 that are not
 * divsible by 400.
 *
 * Returns: !=0 if it is a leap year.
 *
 * References:
 *  $(LINK2 http://en.wikipedia.org/wiki/Leap_year, Wikipedia)
 */

int inLeapYear(d_time t)
{
    return LeapYear(YearFromTime(t));
}

/*****************************
 * Calculates the month from the d_time t.
 *
 * Returns: Integer in the range 0..11, where
 *  0 represents January and 11 represents December.
 */

int MonthFromTime(d_time t)
{
    int day;
    int month;
    int year;

    year = YearFromTime(t);
    day = Day(t) - DayFromYear(year);

    if (day < 59)
    {
    if (day < 31)
    {   assert(day >= 0);
        month = 0;
    }
    else
        month = 1;
    }
    else
    {
    day -= LeapYear(year);
    if (day < 212)
    {
        if (day < 59)
        month = 1;
        else if (day < 90)
        month = 2;
        else if (day < 120)
        month = 3;
        else if (day < 151)
        month = 4;
        else if (day < 181)
        month = 5;
        else
        month = 6;
    }
    else
    {
        if (day < 243)
        month = 7;
        else if (day < 273)
        month = 8;
        else if (day < 304)
        month = 9;
        else if (day < 334)
        month = 10;
        else if (day < 365)
        month = 11;
        else
        assert(0);
    }
    }
    return month;
}

/*******************************
 * Compute which day in a month a d_time t is.
 * Returns:
 *  Integer in the range 1..31
 */
int DateFromTime(d_time t)
{
    int day;
    int leap;
    int month;
    int year;
    int date;

    year = YearFromTime(t);
    day = Day(t) - DayFromYear(year);
    leap = LeapYear(year);
    month = MonthFromTime(t);
    switch (month)
    {
    case 0:  date = day +   1;      break;
    case 1:  date = day -  30;      break;
    case 2:  date = day -  58 - leap;   break;
    case 3:  date = day -  89 - leap;   break;
    case 4:  date = day - 119 - leap;   break;
    case 5:  date = day - 150 - leap;   break;
    case 6:  date = day - 180 - leap;   break;
    case 7:  date = day - 211 - leap;   break;
    case 8:  date = day - 242 - leap;   break;
    case 9:  date = day - 272 - leap;   break;
    case 10: date = day - 303 - leap;   break;
    case 11: date = day - 333 - leap;   break;
    default:
        assert(0);
    }
    return date;
}

/*******************************
 * Compute which day of the week a d_time t is.
 * Returns:
 *  Integer in the range 0..6, where 0 represents Sunday
 *  and 6 represents Saturday.
 */
int WeekDay(d_time t)
{   int w;

    w = (cast(int)Day(t) + 4) % 7;
    if (w < 0)
    w += 7;
    return w;
}

/***********************************
 * Convert from UTC to local time.
 */

d_time UTCtoLocalTime(d_time t)
{
    return t + LocalTZA + DaylightSavingTA(t);
}

/***********************************
 * Convert from local time to UTC.
 */

d_time LocalTimetoUTC(d_time t)
{
    return t - LocalTZA - DaylightSavingTA(t - LocalTZA);
}


d_time MakeTime(d_time hour, d_time min, d_time sec, d_time ms)
{
    return hour * TicksPerHour +
       min * TicksPerMinute +
       sec * TicksPerSecond +
       ms * TicksPerMs;
}


d_time MakeDay(d_time year, d_time month, d_time date)
{   d_time t;
    int y;
    int m;
    int leap;

    y = cast(int)(year + floor(month, 12));
    m = dmod(month, 12);

    leap = LeapYear(y);
    t = TimeFromYear(y) + cast(d_time)mdays[m] * msPerDay;
    if (leap && month >= 2)
    t += msPerDay;

    if (YearFromTime(t) != y ||
    MonthFromTime(t) != m ||
    DateFromTime(t) != 1)
    {
    return  d_time_nan;
    }

    return Day(t) + date - 1;
}

d_time MakeDate(d_time day, d_time time)
{
    if (day == d_time_nan || time == d_time_nan)
    return d_time_nan;

    return day * TicksPerDay + time;
}

d_time TimeClip(d_time time)
{
    //printf("TimeClip(%g) = %g\n", time, toInteger(time));

    return toInteger(time);
}

/*************************************
 * Converts UTC time into a text string of the form:
 * "Www Mmm dd hh:mm:ss GMT+-TZ yyyy".
 * For example, "Tue Apr 02 02:04:57 GMT-0800 1996".
 * If time is invalid, i.e. is d_time_nan,
 * the string "Invalid date" is returned.
 *
 * Example:
 * ------------------------------------
  d_time lNow;
  char[] lNowString;

  // Grab the date and time relative to UTC
  lNow = std.date.getUTCtime();
  // Convert this into the local date and time for display.
  lNowString = std.date.toString(lNow);
 * ------------------------------------
 */

char[] toString(d_time time)
{
    d_time t;
    char sign;
    int hr;
    int mn;
    int len;
    d_time offset;
    d_time dst;

    // Years are supposed to be -285616 .. 285616, or 7 digits
    // "Tue Apr 02 02:04:57 GMT-0800 1996"
    char[] buffer = new char[29 + 7 + 1];

    if (time == d_time_nan)
    return "Invalid Date";

    dst = DaylightSavingTA(time);
    offset = LocalTZA + dst;
    t = time + offset;
    sign = '+';
    if (offset < 0)
    {   sign = '-';
//  offset = -offset;
    offset = -(LocalTZA + dst);
    }

    mn = cast(int)(offset / msPerMinute);
    hr = mn / 60;
    mn %= 60;

    //printf("hr = %d, offset = %g, LocalTZA = %g, dst = %g, + = %g\n", hr, offset, LocalTZA, dst, LocalTZA + dst);

    len = sprintf(buffer.ptr, "%.3s %.3s %02d %02d:%02d:%02d GMT%c%02d%02d %d",
    &daystr[WeekDay(t) * 3],
    &monstr[MonthFromTime(t) * 3],
    DateFromTime(t),
    HourFromTime(t), MinFromTime(t), SecFromTime(t),
    sign, hr, mn,
    cast(long)YearFromTime(t));

    // Ensure no buggy buffer overflows
    //printf("len = %d, buffer.length = %d\n", len, buffer.length);
    assert(len < buffer.length);

    return buffer[0 .. len];
}

/***********************************
 * Converts t into a text string of the form: "Www, dd Mmm yyyy hh:mm:ss UTC".
 * If t is invalid, "Invalid date" is returned.
 */

char[] toUTCString(d_time t)
{
    // Years are supposed to be -285616 .. 285616, or 7 digits
    // "Tue, 02 Apr 1996 02:04:57 GMT"
    char[] buffer = new char[25 + 7 + 1];
    int len;

    if (t == d_time_nan)
    return "Invalid Date";

    len = sprintf(buffer.ptr, "%.3s, %02d %.3s %d %02d:%02d:%02d UTC",
    &daystr[WeekDay(t) * 3], DateFromTime(t),
    &monstr[MonthFromTime(t) * 3],
    YearFromTime(t),
    HourFromTime(t), MinFromTime(t), SecFromTime(t));

    // Ensure no buggy buffer overflows
    assert(len < buffer.length);

    return buffer[0 .. len];
}

/************************************
 * Converts the date portion of time into a text string of the form: "Www Mmm dd
 * yyyy", for example, "Tue Apr 02 1996".
 * If time is invalid, "Invalid date" is returned.
 */

char[] toDateString(d_time time)
{
    d_time t;
    d_time offset;
    d_time dst;
    int len;

    // Years are supposed to be -285616 .. 285616, or 7 digits
    // "Tue Apr 02 1996"
    char[] buffer = new char[29 + 7 + 1];

    if (time == d_time_nan)
    return "Invalid Date";

    dst = DaylightSavingTA(time);
    offset = LocalTZA + dst;
    t = time + offset;

    len = sprintf(buffer.ptr, "%.3s %.3s %02d %d",
    &daystr[WeekDay(t) * 3],
    &monstr[MonthFromTime(t) * 3],
    DateFromTime(t),
    cast(long)YearFromTime(t));

    // Ensure no buggy buffer overflows
    assert(len < buffer.length);

    return buffer[0 .. len];
}

/******************************************
 * Converts the time portion of t into a text string of the form: "hh:mm:ss
 * GMT+-TZ", for example, "02:04:57 GMT-0800".
 * If t is invalid, "Invalid date" is returned.
 */

char[] toTimeString(d_time time)
{
    d_time t;
    char sign;
&nb