/*
* TODO Well, everything :-)
*
- * 1. Time zones with minutes (make wxTimeZone a class)
- * 2. getdate() function like under Solaris
- * 3. text conversion for wxDateSpan
+ * + 1. Time zones with minutes (make TimeZone a class)
+ * 2. getdate() function like under Solaris
+ * + 3. text conversion for wxDateSpan
+ * 4. pluggable modules for the workdays calculations
*/
/*
- The three classes declared in this header represent:
+ The three (main) classes declared in this header represent:
1. An absolute moment in the time (wxDateTime)
2. A difference between two moments in the time, positive or negative
// Note that GMT12 and GMT_12 are not the same: there is a difference
// of exactly one day between them
- // Universal Coordinated Time
+ // some symbolic names for TZ
+
+ // Europe
+ WET = GMT0, // Western Europe Time
+ WEST = GMT1, // Western Europe Summer Time
+ CET = GMT1, // Central Europe Time
+ CEST = GMT2, // Central Europe Summer Time
+ EET = GMT2, // Eastern Europe Time
+ EEST = GMT3, // Eastern Europe Summer Time
+ MSK = GMT3, // Moscow Time
+ MSD = GMT4, // Moscow Summer Time
+
+ // US and Canada
+ AST = GMT_4, // Atlantic Standard Time
+ ADT = GMT_3, // Atlantic Daylight Time
+ EST = GMT_5, // Eastern Standard Time
+ EDT = GMT_4, // Eastern Daylight Saving Time
+ CST = GMT_6, // Central Standard Time
+ CDT = GMT_5, // Central Daylight Saving Time
+ MST = GMT_7, // Mountain Standard Time
+ MDT = GMT_6, // Mountain Daylight Saving Time
+ PST = GMT_8, // Pacific Standard Time
+ PDT = GMT_7, // Pacific Daylight Saving Time
+ HST = GMT_10, // Hawaiian Standard Time
+ AKST = GMT_9, // Alaska Standard Time
+ AKDT = GMT_8, // Alaska Daylight Saving Time
+
+ // Australia
+
+ A_WST = GMT8, // Western Standard Time
+ A_CST = GMT12 + 1, // Central Standard Time (+9.5)
+ A_EST = GMT10, // Eastern Standard Time
+ A_ESST = GMT11, // Eastern Summer Time
+
+ // TODO add more symbolic timezone names here
+
+ // Universal Coordinated Time = the new and politically correct name
+ // for GMT
UTC = GMT0
-
- // TODO add symbolic names for TZ (EST, MET, ...)?
};
// the calendar systems we know about: notice that it's valid (for
// helper classes
// ------------------------------------------------------------------------
+ // a class representing a time zone: basicly, this is just an offset
+ // (in seconds) from GMT
+ class TimeZone
+ {
+ public:
+ TimeZone(TZ tz);
+ TimeZone(wxDateTime_t offset = 0) { m_offset = offset; }
+
+ int GetOffset() const { return m_offset; }
+
+ private:
+ // offset for this timezone from GMT in seconds
+ int m_offset;
+ };
+
// standard struct tm is limited to the years from 1900 (because
// tm_year field is the offset from 1900), so we use our own struct
// instead to represent broken down time
+ //
+ // NB: this struct should always be kept normalized (i.e. mon should
+ // be < 12, 1 <= day <= 31 &c), so use AddMonths(), AddDays()
+ // instead of modifying the member fields directly!
struct Tm
{
- wxDateTime_t sec, min, hour,
- mday, mon, year;
+ wxDateTime_t msec, sec, min, hour, mday;
+ Month mon;
+ int year;
// default ctor inits the object to an invalid value
Tm();
- // ctor from struct tm
- Tm(const struct tm& tm);
+ // ctor from struct tm and the timezone
+ Tm(const struct tm& tm, const TimeZone& tz);
// check that the given date/time is valid (in Gregorian calendar)
bool IsValid() const;
return (WeekDay)wday;
}
+ // add the given number of months to the date keeping it normalized
+ void AddMonths(int monDiff);
+
+ // add the given number of months to the date keeping it normalized
+ void AddDays(int dayDiff);
+
private:
// compute the weekday from other fields
void ComputeWeekDay();
+ // the timezone we correspond to
+ TimeZone m_tz;
+
// these values can't be accessed directly because they're not always
// computed and we calculate them on demand
wxDateTime_t wday, yday;
};
- // a class representing a time zone: basicly, this is just an offset
- // (in minutes) from GMT
- class TimeZone
- {
- public:
- TimeZone(TZ tz);
- TimeZone(wxDateTime_t offset) { m_offset = offset; }
-
- wxDateTime_t GetOffset() const { return m_offset; }
-
- private:
- // offset for this timezone from GMT in minutes
- wxDateTime_t m_offset;
- };
-
// static methods
// ------------------------------------------------------------------------
// constructors: you should test whether the constructor succeeded with
// IsValid() function. The values Inv_Month and Inv_Year for the
// parameters mean take current month and/or year values.
- //
- // All new wxDateTime correspond to the local time, use ToUTC() or
- // MakeUTC() to get the time in UTC/GMT.
// ------------------------------------------------------------------------
// default ctor does not initialize the object, use Set()!
// from broken down time/date (any range)
inline wxDateTime(const Tm& tm);
+ // from JDN (beware of rounding errors)
+ inline wxDateTime(double jdn);
+
// from separate values for each component, date set to today
inline wxDateTime(wxDateTime_t hour,
wxDateTime_t minute = 0,
// set to given broken down time/date
inline wxDateTime& Set(const Tm& tm);
+ // set to given JDN (beware of rounding errors)
+ wxDateTime& Set(double jdn);
+
// set to given time, date = today
wxDateTime& Set(wxDateTime_t hour,
wxDateTime_t minute = 0,
// of days relative to a base date of December 31 of the year 0. Thus
// January 1 of the year 1 is Rata Die day 1.
- // get the Julian Day number
- long GetJulianDay() const;
+ // get the Julian Day number (the fractional part specifies the time of
+ // the day, related to noon - beware of rounding errors!)
+ double GetJulianDayNumber() const;
// get the Rata Die number
- long GetRataDie() const;
+ double GetRataDie() const;
// TODO algorithms for calculating some important dates, such as
// religious holidays (Easter...) or moon/solar eclipses? Some
// algorithms can be found in the calendar FAQ
- // timezone stuff: by default, we always work with local times, to get
- // anything else, it should be requested explicitly
+ // timezone stuff: a wxDateTime object constructed using given
+ // day/month/year/hour/min/sec values correspond to this moment in local
+ // time. Using the functions below, it may be converted to another time
+ // zone (for example, the Unix epoch is wxDateTime(1, Jan, 1970).ToGMT())
+ //
+ // Converting to the local time zone doesn't do anything.
// ------------------------------------------------------------------------
- // get the time corresponding to this one in UTC/GMT
- wxDateTime ToUTC() const;
- wxDateTime ToGMT() const { return ToUTC(); }
-
- // transform this object to UTC/GMT
- wxDateTime& MakeUTC();
- wxDateTime& MakeGMT() { return MakeUTC(); }
-
- // generic version: transform time to any given timezone
- wxDateTime ToTimezone(const TimeZone& tz);
+ // transform to any given timezone
+ inline wxDateTime ToTimezone(const TimeZone& tz) const;
wxDateTime& MakeTimezone(const TimeZone& tz);
+ // transform to GMT/UTC
+ wxDateTime ToGMT() const { return ToTimezone(GMT0); }
+ wxDateTime& MakeGMT() { return MakeTimezone(GMT0); }
+
// accessors: many of them take the timezone parameter which indicates the
// timezone for which to make the calculations and the default value means
// to do it for the current timezone of this machine (even if the function
// the functions which failed to convert the date to supported range)
inline bool IsValid() const { return this != &ms_InvDateTime; }
- // get the broken down date/time representation
- Tm GetTm() const;
+ // get the broken down date/time representation in the given timezone
+ //
+ // If you wish to get several time components (day, month and year),
+ // consider getting the whole Tm strcuture first and retrieving the
+ // value from it - this is much more efficient
+ Tm GetTm(const TimeZone& tz = Local) const;
// get the number of seconds since the Unix epoch - returns (time_t)-1
// if the value is out of range
inline time_t GetTicks() const;
// get the year (returns Inv_Year if date is invalid)
- int GetYear() const { return GetTm().year; }
+ int GetYear(const TimeZone& tz = Local) const
+ { return GetTm(tz).year; }
// get the month (Inv_Month if date is invalid)
- Month GetMonth() const { return (Month)GetTm().mon; }
+ Month GetMonth(const TimeZone& tz = Local) const
+ { return (Month)GetTm(tz).mon; }
// get the month day (in 1..31 range, 0 if date is invalid)
- wxDateTime_t GetDay() const { return GetTm().mday; }
+ wxDateTime_t GetDay(const TimeZone& tz = Local) const
+ { return GetTm(tz).mday; }
// get the day of the week (Inv_WeekDay if date is invalid)
- WeekDay GetWeekDay() const { return GetTm().GetWeekDay(); }
+ WeekDay GetWeekDay(const TimeZone& tz = Local) const
+ { return GetTm(tz).GetWeekDay(); }
// get the hour of the day
- wxDateTime_t GetHour() const { return GetTm().hour; }
+ wxDateTime_t GetHour(const TimeZone& tz = Local) const
+ { return GetTm(tz).hour; }
// get the minute
- wxDateTime_t GetMinute() const { return GetTm().min; }
+ wxDateTime_t GetMinute(const TimeZone& tz = Local) const
+ { return GetTm(tz).min; }
// get the second
- wxDateTime_t GetSecond() const { return GetTm().sec; }
+ wxDateTime_t GetSecond(const TimeZone& tz = Local) const
+ { return GetTm(tz).sec; }
// get milliseconds
- wxDateTime_t GetMillisecond() const { return m_time.GetLo() % 1000; }
+ wxDateTime_t GetMillisecond(const TimeZone& tz = Local) const
+ { return GetTm(tz).msec; }
// get the day since the year start (1..366, 0 if date is invalid)
- wxDateTime_t GetDayOfYear() const;
+ wxDateTime_t GetDayOfYear(const TimeZone& tz = Local) const;
// get the week number since the year start (1..52, 0 if date is
// invalid)
- wxDateTime_t GetWeekOfYear() const;
+ wxDateTime_t GetWeekOfYear(const TimeZone& tz = Local) const;
// is this date a work day? This depends on a country, of course,
// because the holidays are different in different countries
bool IsWorkDay(Country country = Country_Default,
- TimeZone zone = Local) const;
+ const TimeZone& tz = Local) const;
// is this date later than Gregorian calendar introduction for the
// given country (see enum GregorianAdoption)?
// adoption of the Gregorian calendar is simply unknown.
bool IsGregorianDate(GregorianAdoption country = Gr_Standard) const;
- // is daylight savings time in effect at this moment?
+ // is daylight savings time in effect at this moment according to the
+ // rules of the specified country?
//
// Return value is > 0 if DST is in effect, 0 if it is not and -1 if
// the information is not available (this is compatible with ANSI C)
- int IsDST(Country country = Country_Default, TimeZone zone = Local) const;
+ int IsDST(Country country = Country_Default) const;
// comparison (see also functions below for operator versions)
// ------------------------------------------------------------------------
// argument corresponds to the preferred date and time representation
// for the current locale) and returns the string containing the
// resulting text representation
- wxString Format(const wxChar *format = _T("%c")) const;
+ wxString Format(const wxChar *format = _T("%c"),
+ const TimeZone& tz = Local) const;
// preferred date representation for the current locale
wxString FormatDate() const { return Format(_T("%x")); }
// preferred time representation for the current locale
// returns TRUE if we fall in range in which we can use standard ANSI C
// functions
- inline IsInStdRange() const;
+ inline bool IsInStdRange() const;
// the internal representation of the time is the amount of milliseconds
// elapsed since the origin which is set by convention to the UNIX/C epoch
// constructors
// ------------------------------------------------------------------------
+ // return the timespan for the given number of seconds
+ static wxTimeSpan Seconds(int sec) { return wxTimeSpan(0, 0, sec); }
+
+ // return the timespan for the given number of minutes
+ static wxTimeSpan Minutes(int min) { return wxTimeSpan(0, min, 0 ); }
+
+ // return the timespan for the given number of hours
+ static wxTimeSpan Hours(int hours) { return wxTimeSpan(hours, 0, 0); }
+
// default ctor constructs the 0 time span
wxTimeSpan() { }
// from separate values for each component, date set to 0 (hours are
// not restricted to 0..24 range, neither are minutes, seconds or
// milliseconds)
- wxTimeSpan(int hours,
- int minutes = 0,
- int seconds = 0,
- int milliseconds = 0);
- // from separate values for each component with explicit date (none of
- // the parameters isn't restricted to any range)
- wxTimeSpan(int years,
- int months,
- int days,
- int hours = 0,
- int minutes = 0,
- int seconds = 0,
- int milliseconds = 0);
+ inline wxTimeSpan(int hours,
+ int minutes = 0,
+ int seconds = 0,
+ int milliseconds = 0);
// from internal representation
wxTimeSpan(wxLongLong diff) : m_diff(diff) { }
// timespans are equal in absolute value.
bool IsShorterThan(const wxTimeSpan& t) const { return !IsLongerThan(t); }
- // breaking into years, ..., days, ..., seconds: all these functions
- // behave like GetYears() which returns 1 for the timespan of 1 year and 1
- // day, but 0 (and not -1) for the negative timespan of 1 year without 1
- // day. IOW, (ts - wxTimeSpan(ts.GetYears())).GetYears() is always 0.
+ // breaking into days, hours, minutes and seconds
// ------------------------------------------------------------------------
- // get the max number of years in this timespan
- inline int GetYears() const;
- // get the max number of months in this timespan
- inline int GetMonths() const;
// get the max number of weeks in this timespan
inline int GetWeeks() const;
// get the max number of days in this timespan
// get the max number of minutes in this timespan
inline int GetMinutes() const;
// get the max number of seconds in this timespan
- inline int GetSeconds() const;
+ inline wxLongLong GetSeconds() const;
// get the number of milliseconds in this timespan
wxLongLong GetMilliseconds() const { return m_diff; }
// resulting text representation. Notice that only some of format
// specifiers valid for wxDateTime are valid for wxTimeSpan: hours,
// minutes and seconds make sense, but not "PM/AM" string for example.
- wxString Format(const char *format = "%c") const;
+ wxString Format(const wxChar *format = _T("%c")) const;
// preferred date representation for the current locale
- wxString FormatDate() const { return Format("%x"); }
+ wxString FormatDate() const { return Format(_T("%x")); }
// preferred time representation for the current locale
- wxString FormatTime() const { return Format("%X"); }
+ wxString FormatTime() const { return Format(_T("%X")); }
// implementation
// ------------------------------------------------------------------------
projects / wxWidgets.git / blobdiff