[wxWidgets.git] / include / wx / datetime.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/datetime.h
// Purpose:     declarations of time/date related classes (wxDateTime,
//              wxTimeSpan)
// Author:      Vadim Zeitlin
// Modified by:
// Created:     10.02.99
// RCS-ID:      $Id$
// Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_DATETIME_H
#define _WX_DATETIME_H

#ifdef __GNUG__
    #pragma interface "datetime.h"
#endif

#include <time.h>
#include <limits.h>             // for INT_MIN

#include "wx/longlong.h"

class WXDLLEXPORT wxDateTime;
class WXDLLEXPORT wxTimeSpan;
class WXDLLEXPORT wxDateSpan;

// don't use inline functions in debug builds - we don't care about
// performances and this only leads to increased rebuild time (because every
// time an inline method is changed, all files including the header must be
// rebuilt)
#ifdef __WXDEBUG__
    #define inline
#endif // Debug

/*
 * TODO Well, everything :-)
 *
 * 1. Time zones with minutes (make wxTimeZone a class)
 * 2. getdate() function like under Solaris
 * 3. text conversion for wxDateSpan
 */

/*
  The three 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
     (wxTimeSpan)
  3. A logical difference between two dates expressed in
     years/months/weeks/days (wxDateSpan)

  The following arithmetic operations are permitted (all others are not):

  addition
  --------

  wxDateTime + wxTimeSpan = wxDateTime
  wxDateTime + wxDateSpan = wxDateTime
  wxTimeSpan + wxTimeSpan = wxTimeSpan
  wxDateSpan + wxDateSpan = wxDateSpan

  substraction
  ------------
  wxDateTime - wxDateTime = wxTimeSpan
  wxTimeSpan - wxTimeSpan = wxTimeSpan
  wxDateSpan - wxDateSpan = wxDateSpan

  multiplication
  --------------
  wxTimeSpan * number = wxTimeSpan
  wxDateSpan * number = wxDateSpan

  unitary minus
  -------------
  -wxTimeSpan = wxTimeSpan
  -wxDateSpan = wxDateSpan
*/

// ----------------------------------------------------------------------------
// This class represents an absolute moment in the time
// ----------------------------------------------------------------------------

class WXDLLEXPORT wxDateTime
{
public:
    // types
    // ------------------------------------------------------------------------

        // a small unsigned integer type for storing things like seconds, days
        // of the week, &c. It should be at least short (i.e. not char) to
        // contain the number of milliseconds - it may also be 'int' because
        // there is no size penalty associated with it in our code, we don't
        // store any data in this format
    typedef unsigned short wxDateTime_t;

        // the timezones
    enum TZ
    {
        // the time in the current time zone
        Local,

        // zones from GMT (= Greenwhich Mean Time): they're guaranteed to be
        // consequent numbers, so writing something like `GMT0 + offset' is
        // safe if abs(offset) <= 12

        // underscore stands for minus
        GMT_12, GMT_11, GMT_10, GMT_9, GMT_8, GMT_7,
        GMT_6, GMT_5, GMT_4, GMT_3, GMT_2, GMT_1,
        GMT0,
        GMT1, GMT2, GMT3, GMT4, GMT5, GMT6,
        GMT7, GMT8, GMT9, GMT10, GMT11, GMT12,
        // Note that GMT12 and GMT_12 are not the same: there is a difference
        // of exactly one day between them

        // 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
    };

        // the calendar systems we know about: notice that it's valid (for
        // this classes purpose anyhow) to work with any of these calendars
        // even with the dates before the historical appearance of the
        // calendar
    enum Calendar
    {
        Gregorian,  // current calendar
        Julian      // calendar in use since -45 until the 1582 (or later)

        // TODO Hebrew, Chinese, Maya, ... (just kidding) (or then may be not?)
    };

        // these values only are used to identify the different dates of
        // adoption of the Gregorian calendar (see IsGregorian())
        //
        // All data and comments taken verbatim from "The Calendar FAQ (v 2.0)"
Commit	Line	Data
0979c962 VZ	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/datetime.h
	3	// Purpose: declarations of time/date related classes (wxDateTime,
	4	// wxTimeSpan)
	5	// Author: Vadim Zeitlin
	6	// Modified by:
	7	// Created: 10.02.99
	8	// RCS-ID: $Id$
	9	// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
	10	// Licence: wxWindows license
	11	/////////////////////////////////////////////////////////////////////////////
	12
2f02cb89 VZ	13	#ifndef _WX_DATETIME_H
2f02cb89 VZ	14	#define _WX_DATETIME_H
0979c962 VZ	15
	16	#ifdef __GNUG__
	17	#pragma interface "datetime.h"
	18	#endif
	19
	20	#include <time.h>
b76b015e	21	#include <limits.h> // for INT_MIN
0979c962 VZ	22
	23	#include "wx/longlong.h"
	24
	25	class WXDLLEXPORT wxDateTime;
	26	class WXDLLEXPORT wxTimeSpan;
	27	class WXDLLEXPORT wxDateSpan;
	28
2f02cb89 VZ	29	// don't use inline functions in debug builds - we don't care about
	30	// performances and this only leads to increased rebuild time (because every
	31	// time an inline method is changed, all files including the header must be
	32	// rebuilt)
	33	#ifdef __WXDEBUG__
	34	#define inline
	35	#endif // Debug
	36
0979c962 VZ	37	/*
	38	* TODO Well, everything :-)
	39	*
	40	* 1. Time zones with minutes (make wxTimeZone a class)
	41	* 2. getdate() function like under Solaris
	42	* 3. text conversion for wxDateSpan
	43	*/
	44
	45	/*
	46	The three classes declared in this header represent:
	47
	48	1. An absolute moment in the time (wxDateTime)
	49	2. A difference between two moments in the time, positive or negative
	50	(wxTimeSpan)
	51	3. A logical difference between two dates expressed in
	52	years/months/weeks/days (wxDateSpan)
	53
	54	The following arithmetic operations are permitted (all others are not):
	55
	56	addition
	57	--------
	58
	59	wxDateTime + wxTimeSpan = wxDateTime
	60	wxDateTime + wxDateSpan = wxDateTime
	61	wxTimeSpan + wxTimeSpan = wxTimeSpan
	62	wxDateSpan + wxDateSpan = wxDateSpan
	63
	64	substraction
	65	------------
	66	wxDateTime - wxDateTime = wxTimeSpan
	67	wxTimeSpan - wxTimeSpan = wxTimeSpan
	68	wxDateSpan - wxDateSpan = wxDateSpan
	69
	70	multiplication
	71	--------------
	72	wxTimeSpan * number = wxTimeSpan
	73	wxDateSpan * number = wxDateSpan
	74
	75	unitary minus
	76	-------------
	77	-wxTimeSpan = wxTimeSpan
	78	-wxDateSpan = wxDateSpan
	79	*/
	80
	81	// ----------------------------------------------------------------------------
	82	// This class represents an absolute moment in the time
	83	// ----------------------------------------------------------------------------
b76b015e	84
0979c962 VZ	85	class WXDLLEXPORT wxDateTime
	86	{
	87	public:
	88	// types
	89	// ------------------------------------------------------------------------
	90
	91	// a small unsigned integer type for storing things like seconds, days
	92	// of the week, &c. It should be at least short (i.e. not char) to
	93	// contain the number of milliseconds - it may also be 'int' because
	94	// there is no size penalty associated with it in our code, we don't
	95	// store any data in this format
	96	typedef unsigned short wxDateTime_t;
	97
	98	// the timezones
b76b015e	99	enum TZ
0979c962 VZ	100	{
	101	// the time in the current time zone
	102	Local,
	103
	104	// zones from GMT (= Greenwhich Mean Time): they're guaranteed to be
	105	// consequent numbers, so writing something like `GMT0 + offset' is
	106	// safe if abs(offset) <= 12
	107
	108	// underscore stands for minus
	109	GMT_12, GMT_11, GMT_10, GMT_9, GMT_8, GMT_7,
	110	GMT_6, GMT_5, GMT_4, GMT_3, GMT_2, GMT_1,
	111	GMT0,
	112	GMT1, GMT2, GMT3, GMT4, GMT5, GMT6,
	113	GMT7, GMT8, GMT9, GMT10, GMT11, GMT12,
	114	// Note that GMT12 and GMT_12 are not the same: there is a difference
	115	// of exactly one day between them
	116
fcc3d7cb VZ	117	// some symbolic names for TZ
	118
	119	// Europe
	120	WET = GMT0, // Western Europe Time
	121	WEST = GMT1, // Western Europe Summer Time
	122	CET = GMT1, // Central Europe Time
	123	CEST = GMT2, // Central Europe Summer Time
	124	EET = GMT2, // Eastern Europe Time
	125	EEST = GMT3, // Eastern Europe Summer Time
	126	MSK = GMT3, // Moscow Time
	127	MSD = GMT4, // Moscow Summer Time
	128
	129	// US and Canada
	130	AST = GMT_4, // Atlantic Standard Time
	131	ADT = GMT_3, // Atlantic Daylight Time
	132	EST = GMT_5, // Eastern Standard Time
	133	EDT = GMT_4, // Eastern Daylight Saving Time
	134	CST = GMT_6, // Central Standard Time
	135	CDT = GMT_5, // Central Daylight Saving Time
	136	MST = GMT_7, // Mountain Standard Time
	137	MDT = GMT_6, // Mountain Daylight Saving Time
	138	PST = GMT_8, // Pacific Standard Time
	139	PDT = GMT_7, // Pacific Daylight Saving Time
	140	HST = GMT_10, // Hawaiian Standard Time
	141	AKST = GMT_9, // Alaska Standard Time
	142	AKDT = GMT_8, // Alaska Daylight Saving Time
	143
	144	// Australia
	145
	146	A_WST = GMT8, // Western Standard Time
	147	A_CST = GMT12 + 1, // Central Standard Time (+9.5)
	148	A_EST = GMT10, // Eastern Standard Time
	149	A_ESST = GMT11, // Eastern Summer Time
	150
	151	// TODO add more symbolic timezone names here
	152
	153	// Universal Coordinated Time = the new and politically correct name
	154	// for GMT
0979c962	155	UTC = GMT0
0979c962 VZ	156	};
	157
	158	// the calendar systems we know about: notice that it's valid (for
	159	// this classes purpose anyhow) to work with any of these calendars
	160	// even with the dates before the historical appearance of the
	161	// calendar
	162	enum Calendar
	163	{
	164	Gregorian, // current calendar
	165	Julian // calendar in use since -45 until the 1582 (or later)
	166
	167	// TODO Hebrew, Chinese, Maya, ... (just kidding) (or then may be not?)
	168	};
	169
	170	// these values only are used to identify the different dates of
	171	// adoption of the Gregorian calendar (see IsGregorian())
	172	//
	173	// All data and comments taken verbatim from "The Calendar FAQ (v 2.0)"
	174