Chris@87: /*  datetime.h
Chris@87:  */
Chris@87: 
Chris@87: #ifndef DATETIME_H
Chris@87: #define DATETIME_H
Chris@87: #ifdef __cplusplus
Chris@87: extern "C" {
Chris@87: #endif
Chris@87: 
Chris@87: /* Fields are packed into successive bytes, each viewed as unsigned and
Chris@87:  * big-endian, unless otherwise noted:
Chris@87:  *
Chris@87:  * byte offset
Chris@87:  *  0           year     2 bytes, 1-9999
Chris@87:  *  2           month    1 byte, 1-12
Chris@87:  *  3           day      1 byte, 1-31
Chris@87:  *  4           hour     1 byte, 0-23
Chris@87:  *  5           minute   1 byte, 0-59
Chris@87:  *  6           second   1 byte, 0-59
Chris@87:  *  7           usecond  3 bytes, 0-999999
Chris@87:  * 10
Chris@87:  */
Chris@87: 
Chris@87: /* # of bytes for year, month, and day. */
Chris@87: #define _PyDateTime_DATE_DATASIZE 4
Chris@87: 
Chris@87: /* # of bytes for hour, minute, second, and usecond. */
Chris@87: #define _PyDateTime_TIME_DATASIZE 6
Chris@87: 
Chris@87: /* # of bytes for year, month, day, hour, minute, second, and usecond. */
Chris@87: #define _PyDateTime_DATETIME_DATASIZE 10
Chris@87: 
Chris@87: 
Chris@87: typedef struct
Chris@87: {
Chris@87:     PyObject_HEAD
Chris@87:     long hashcode;              /* -1 when unknown */
Chris@87:     int days;                   /* -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS */
Chris@87:     int seconds;                /* 0 <= seconds < 24*3600 is invariant */
Chris@87:     int microseconds;           /* 0 <= microseconds < 1000000 is invariant */
Chris@87: } PyDateTime_Delta;
Chris@87: 
Chris@87: typedef struct
Chris@87: {
Chris@87:     PyObject_HEAD               /* a pure abstract base class */
Chris@87: } PyDateTime_TZInfo;
Chris@87: 
Chris@87: 
Chris@87: /* The datetime and time types have hashcodes, and an optional tzinfo member,
Chris@87:  * present if and only if hastzinfo is true.
Chris@87:  */
Chris@87: #define _PyTZINFO_HEAD          \
Chris@87:     PyObject_HEAD               \
Chris@87:     long hashcode;              \
Chris@87:     char hastzinfo;             /* boolean flag */
Chris@87: 
Chris@87: /* No _PyDateTime_BaseTZInfo is allocated; it's just to have something
Chris@87:  * convenient to cast to, when getting at the hastzinfo member of objects
Chris@87:  * starting with _PyTZINFO_HEAD.
Chris@87:  */
Chris@87: typedef struct
Chris@87: {
Chris@87:     _PyTZINFO_HEAD
Chris@87: } _PyDateTime_BaseTZInfo;
Chris@87: 
Chris@87: /* All time objects are of PyDateTime_TimeType, but that can be allocated
Chris@87:  * in two ways, with or without a tzinfo member.  Without is the same as
Chris@87:  * tzinfo == None, but consumes less memory.  _PyDateTime_BaseTime is an
Chris@87:  * internal struct used to allocate the right amount of space for the
Chris@87:  * "without" case.
Chris@87:  */
Chris@87: #define _PyDateTime_TIMEHEAD    \
Chris@87:     _PyTZINFO_HEAD              \
Chris@87:     unsigned char data[_PyDateTime_TIME_DATASIZE];
Chris@87: 
Chris@87: typedef struct
Chris@87: {
Chris@87:     _PyDateTime_TIMEHEAD
Chris@87: } _PyDateTime_BaseTime;         /* hastzinfo false */
Chris@87: 
Chris@87: typedef struct
Chris@87: {
Chris@87:     _PyDateTime_TIMEHEAD
Chris@87:     PyObject *tzinfo;
Chris@87: } PyDateTime_Time;              /* hastzinfo true */
Chris@87: 
Chris@87: 
Chris@87: /* All datetime objects are of PyDateTime_DateTimeType, but that can be
Chris@87:  * allocated in two ways too, just like for time objects above.  In addition,
Chris@87:  * the plain date type is a base class for datetime, so it must also have
Chris@87:  * a hastzinfo member (although it's unused there).
Chris@87:  */
Chris@87: typedef struct
Chris@87: {
Chris@87:     _PyTZINFO_HEAD
Chris@87:     unsigned char data[_PyDateTime_DATE_DATASIZE];
Chris@87: } PyDateTime_Date;
Chris@87: 
Chris@87: #define _PyDateTime_DATETIMEHEAD        \
Chris@87:     _PyTZINFO_HEAD                      \
Chris@87:     unsigned char data[_PyDateTime_DATETIME_DATASIZE];
Chris@87: 
Chris@87: typedef struct
Chris@87: {
Chris@87:     _PyDateTime_DATETIMEHEAD
Chris@87: } _PyDateTime_BaseDateTime;     /* hastzinfo false */
Chris@87: 
Chris@87: typedef struct
Chris@87: {
Chris@87:     _PyDateTime_DATETIMEHEAD
Chris@87:     PyObject *tzinfo;
Chris@87: } PyDateTime_DateTime;          /* hastzinfo true */
Chris@87: 
Chris@87: 
Chris@87: /* Apply for date and datetime instances. */
Chris@87: #define PyDateTime_GET_YEAR(o)     ((((PyDateTime_Date*)o)->data[0] << 8) | \
Chris@87:                      ((PyDateTime_Date*)o)->data[1])
Chris@87: #define PyDateTime_GET_MONTH(o)    (((PyDateTime_Date*)o)->data[2])
Chris@87: #define PyDateTime_GET_DAY(o)      (((PyDateTime_Date*)o)->data[3])
Chris@87: 
Chris@87: #define PyDateTime_DATE_GET_HOUR(o)        (((PyDateTime_DateTime*)o)->data[4])
Chris@87: #define PyDateTime_DATE_GET_MINUTE(o)      (((PyDateTime_DateTime*)o)->data[5])
Chris@87: #define PyDateTime_DATE_GET_SECOND(o)      (((PyDateTime_DateTime*)o)->data[6])
Chris@87: #define PyDateTime_DATE_GET_MICROSECOND(o)              \
Chris@87:     ((((PyDateTime_DateTime*)o)->data[7] << 16) |       \
Chris@87:      (((PyDateTime_DateTime*)o)->data[8] << 8)  |       \
Chris@87:       ((PyDateTime_DateTime*)o)->data[9])
Chris@87: 
Chris@87: /* Apply for time instances. */
Chris@87: #define PyDateTime_TIME_GET_HOUR(o)        (((PyDateTime_Time*)o)->data[0])
Chris@87: #define PyDateTime_TIME_GET_MINUTE(o)      (((PyDateTime_Time*)o)->data[1])
Chris@87: #define PyDateTime_TIME_GET_SECOND(o)      (((PyDateTime_Time*)o)->data[2])
Chris@87: #define PyDateTime_TIME_GET_MICROSECOND(o)              \
Chris@87:     ((((PyDateTime_Time*)o)->data[3] << 16) |           \
Chris@87:      (((PyDateTime_Time*)o)->data[4] << 8)  |           \
Chris@87:       ((PyDateTime_Time*)o)->data[5])
Chris@87: 
Chris@87: 
Chris@87: /* Define structure for C API. */
Chris@87: typedef struct {
Chris@87:     /* type objects */
Chris@87:     PyTypeObject *DateType;
Chris@87:     PyTypeObject *DateTimeType;
Chris@87:     PyTypeObject *TimeType;
Chris@87:     PyTypeObject *DeltaType;
Chris@87:     PyTypeObject *TZInfoType;
Chris@87: 
Chris@87:     /* constructors */
Chris@87:     PyObject *(*Date_FromDate)(int, int, int, PyTypeObject*);
Chris@87:     PyObject *(*DateTime_FromDateAndTime)(int, int, int, int, int, int, int,
Chris@87:         PyObject*, PyTypeObject*);
Chris@87:     PyObject *(*Time_FromTime)(int, int, int, int, PyObject*, PyTypeObject*);
Chris@87:     PyObject *(*Delta_FromDelta)(int, int, int, int, PyTypeObject*);
Chris@87: 
Chris@87:     /* constructors for the DB API */
Chris@87:     PyObject *(*DateTime_FromTimestamp)(PyObject*, PyObject*, PyObject*);
Chris@87:     PyObject *(*Date_FromTimestamp)(PyObject*, PyObject*);
Chris@87: 
Chris@87: } PyDateTime_CAPI;
Chris@87: 
Chris@87: #define PyDateTime_CAPSULE_NAME "datetime.datetime_CAPI"
Chris@87: 
Chris@87: 
Chris@87: /* "magic" constant used to partially protect against developer mistakes. */
Chris@87: #define DATETIME_API_MAGIC 0x414548d5
Chris@87: 
Chris@87: #ifdef Py_BUILD_CORE
Chris@87: 
Chris@87: /* Macros for type checking when building the Python core. */
Chris@87: #define PyDate_Check(op) PyObject_TypeCheck(op, &PyDateTime_DateType)
Chris@87: #define PyDate_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DateType)
Chris@87: 
Chris@87: #define PyDateTime_Check(op) PyObject_TypeCheck(op, &PyDateTime_DateTimeType)
Chris@87: #define PyDateTime_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DateTimeType)
Chris@87: 
Chris@87: #define PyTime_Check(op) PyObject_TypeCheck(op, &PyDateTime_TimeType)
Chris@87: #define PyTime_CheckExact(op) (Py_TYPE(op) == &PyDateTime_TimeType)
Chris@87: 
Chris@87: #define PyDelta_Check(op) PyObject_TypeCheck(op, &PyDateTime_DeltaType)
Chris@87: #define PyDelta_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DeltaType)
Chris@87: 
Chris@87: #define PyTZInfo_Check(op) PyObject_TypeCheck(op, &PyDateTime_TZInfoType)
Chris@87: #define PyTZInfo_CheckExact(op) (Py_TYPE(op) == &PyDateTime_TZInfoType)
Chris@87: 
Chris@87: #else
Chris@87: 
Chris@87: /* Define global variable for the C API and a macro for setting it. */
Chris@87: static PyDateTime_CAPI *PyDateTimeAPI = NULL;
Chris@87: 
Chris@87: #define PyDateTime_IMPORT \
Chris@87:     PyDateTimeAPI = (PyDateTime_CAPI *)PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0)
Chris@87: 
Chris@87: /* Macros for type checking when not building the Python core. */
Chris@87: #define PyDate_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->DateType)
Chris@87: #define PyDate_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->DateType)
Chris@87: 
Chris@87: #define PyDateTime_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->DateTimeType)
Chris@87: #define PyDateTime_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->DateTimeType)
Chris@87: 
Chris@87: #define PyTime_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->TimeType)
Chris@87: #define PyTime_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->TimeType)
Chris@87: 
Chris@87: #define PyDelta_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->DeltaType)
Chris@87: #define PyDelta_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->DeltaType)
Chris@87: 
Chris@87: #define PyTZInfo_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->TZInfoType)
Chris@87: #define PyTZInfo_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->TZInfoType)
Chris@87: 
Chris@87: /* Macros for accessing constructors in a simplified fashion. */
Chris@87: #define PyDate_FromDate(year, month, day) \
Chris@87:     PyDateTimeAPI->Date_FromDate(year, month, day, PyDateTimeAPI->DateType)
Chris@87: 
Chris@87: #define PyDateTime_FromDateAndTime(year, month, day, hour, min, sec, usec) \
Chris@87:     PyDateTimeAPI->DateTime_FromDateAndTime(year, month, day, hour, \
Chris@87:         min, sec, usec, Py_None, PyDateTimeAPI->DateTimeType)
Chris@87: 
Chris@87: #define PyTime_FromTime(hour, minute, second, usecond) \
Chris@87:     PyDateTimeAPI->Time_FromTime(hour, minute, second, usecond, \
Chris@87:         Py_None, PyDateTimeAPI->TimeType)
Chris@87: 
Chris@87: #define PyDelta_FromDSU(days, seconds, useconds) \
Chris@87:     PyDateTimeAPI->Delta_FromDelta(days, seconds, useconds, 1, \
Chris@87:         PyDateTimeAPI->DeltaType)
Chris@87: 
Chris@87: /* Macros supporting the DB API. */
Chris@87: #define PyDateTime_FromTimestamp(args) \
Chris@87:     PyDateTimeAPI->DateTime_FromTimestamp( \
Chris@87:         (PyObject*) (PyDateTimeAPI->DateTimeType), args, NULL)
Chris@87: 
Chris@87: #define PyDate_FromTimestamp(args) \
Chris@87:     PyDateTimeAPI->Date_FromTimestamp( \
Chris@87:         (PyObject*) (PyDateTimeAPI->DateType), args)
Chris@87: 
Chris@87: #endif  /* Py_BUILD_CORE */
Chris@87: 
Chris@87: #ifdef __cplusplus
Chris@87: }
Chris@87: #endif
Chris@87: #endif