blob: 06cbc4abbd60e2663041aebc87dfa6c93b190565 [file] [log] [blame]
Tim Peters2a799bf2002-12-16 20:18:38 +00001/* datetime.h
2 */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00003#ifndef Py_LIMITED_API
Tim Peters2a799bf2002-12-16 20:18:38 +00004#ifndef DATETIME_H
5#define DATETIME_H
Tim Peters9ddf40b2004-06-20 22:41:32 +00006#ifdef __cplusplus
7extern "C" {
8#endif
Tim Peters2a799bf2002-12-16 20:18:38 +00009
10/* Fields are packed into successive bytes, each viewed as unsigned and
11 * big-endian, unless otherwise noted:
12 *
13 * byte offset
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000014 * 0 year 2 bytes, 1-9999
15 * 2 month 1 byte, 1-12
16 * 3 day 1 byte, 1-31
17 * 4 hour 1 byte, 0-23
18 * 5 minute 1 byte, 0-59
19 * 6 second 1 byte, 0-59
20 * 7 usecond 3 bytes, 0-999999
Tim Peters2a799bf2002-12-16 20:18:38 +000021 * 10
22 */
23
24/* # of bytes for year, month, and day. */
25#define _PyDateTime_DATE_DATASIZE 4
26
27/* # of bytes for hour, minute, second, and usecond. */
28#define _PyDateTime_TIME_DATASIZE 6
29
30/* # of bytes for year, month, day, hour, minute, second, and usecond. */
31#define _PyDateTime_DATETIME_DATASIZE 10
32
Tim Petersa032d2e2003-01-11 00:15:54 +000033
34typedef struct
35{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000036 PyObject_HEAD
Benjamin Peterson8f67d082010-10-17 20:54:53 +000037 Py_hash_t hashcode; /* -1 when unknown */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000038 int days; /* -MAX_DELTA_DAYS <= days <= MAX_DELTA_DAYS */
39 int seconds; /* 0 <= seconds < 24*3600 is invariant */
40 int microseconds; /* 0 <= microseconds < 1000000 is invariant */
Tim Petersa032d2e2003-01-11 00:15:54 +000041} PyDateTime_Delta;
42
43typedef struct
44{
Ezio Melotti85a86292013-08-17 16:57:41 +030045 PyObject_HEAD /* a pure abstract base class */
Tim Petersa032d2e2003-01-11 00:15:54 +000046} PyDateTime_TZInfo;
Tim Peters37f39822003-01-10 03:49:02 +000047
Tim Petersa032d2e2003-01-11 00:15:54 +000048
49/* The datetime and time types have hashcodes, and an optional tzinfo member,
50 * present if and only if hastzinfo is true.
51 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000052#define _PyTZINFO_HEAD \
53 PyObject_HEAD \
Benjamin Peterson8f67d082010-10-17 20:54:53 +000054 Py_hash_t hashcode; \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000055 char hastzinfo; /* boolean flag */
Tim Petersa032d2e2003-01-11 00:15:54 +000056
57/* No _PyDateTime_BaseTZInfo is allocated; it's just to have something
58 * convenient to cast to, when getting at the hastzinfo member of objects
59 * starting with _PyTZINFO_HEAD.
60 */
61typedef struct
62{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000063 _PyTZINFO_HEAD
Tim Petersa032d2e2003-01-11 00:15:54 +000064} _PyDateTime_BaseTZInfo;
65
66/* All time objects are of PyDateTime_TimeType, but that can be allocated
67 * in two ways, with or without a tzinfo member. Without is the same as
68 * tzinfo == None, but consumes less memory. _PyDateTime_BaseTime is an
69 * internal struct used to allocate the right amount of space for the
70 * "without" case.
71 */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072#define _PyDateTime_TIMEHEAD \
73 _PyTZINFO_HEAD \
74 unsigned char data[_PyDateTime_TIME_DATASIZE];
Tim Petersa032d2e2003-01-11 00:15:54 +000075
76typedef struct
77{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000078 _PyDateTime_TIMEHEAD
79} _PyDateTime_BaseTime; /* hastzinfo false */
Tim Petersa032d2e2003-01-11 00:15:54 +000080
81typedef struct
82{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000083 _PyDateTime_TIMEHEAD
84 PyObject *tzinfo;
85} PyDateTime_Time; /* hastzinfo true */
Tim Petersa032d2e2003-01-11 00:15:54 +000086
Tim Petersa9bc1682003-01-11 03:39:11 +000087
88/* All datetime objects are of PyDateTime_DateTimeType, but that can be
89 * allocated in two ways too, just like for time objects above. In addition,
90 * the plain date type is a base class for datetime, so it must also have
91 * a hastzinfo member (although it's unused there).
92 */
93typedef struct
94{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000095 _PyTZINFO_HEAD
96 unsigned char data[_PyDateTime_DATE_DATASIZE];
Tim Petersa9bc1682003-01-11 03:39:11 +000097} PyDateTime_Date;
98
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000099#define _PyDateTime_DATETIMEHEAD \
100 _PyTZINFO_HEAD \
101 unsigned char data[_PyDateTime_DATETIME_DATASIZE];
Tim Petersa032d2e2003-01-11 00:15:54 +0000102
Tim Peters2a799bf2002-12-16 20:18:38 +0000103typedef struct
104{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000105 _PyDateTime_DATETIMEHEAD
106} _PyDateTime_BaseDateTime; /* hastzinfo false */
Tim Peters2a799bf2002-12-16 20:18:38 +0000107
108typedef struct
109{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000110 _PyDateTime_DATETIMEHEAD
111 PyObject *tzinfo;
112} PyDateTime_DateTime; /* hastzinfo true */
Tim Peters2a799bf2002-12-16 20:18:38 +0000113
Tim Peters37f39822003-01-10 03:49:02 +0000114
Tim Petersa9bc1682003-01-11 03:39:11 +0000115/* Apply for date and datetime instances. */
Tim Peters2a799bf2002-12-16 20:18:38 +0000116#define PyDateTime_GET_YEAR(o) ((((PyDateTime_Date*)o)->data[0] << 8) | \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000117 ((PyDateTime_Date*)o)->data[1])
Tim Peters2a799bf2002-12-16 20:18:38 +0000118#define PyDateTime_GET_MONTH(o) (((PyDateTime_Date*)o)->data[2])
119#define PyDateTime_GET_DAY(o) (((PyDateTime_Date*)o)->data[3])
120
121#define PyDateTime_DATE_GET_HOUR(o) (((PyDateTime_DateTime*)o)->data[4])
122#define PyDateTime_DATE_GET_MINUTE(o) (((PyDateTime_DateTime*)o)->data[5])
123#define PyDateTime_DATE_GET_SECOND(o) (((PyDateTime_DateTime*)o)->data[6])
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124#define PyDateTime_DATE_GET_MICROSECOND(o) \
125 ((((PyDateTime_DateTime*)o)->data[7] << 16) | \
126 (((PyDateTime_DateTime*)o)->data[8] << 8) | \
127 ((PyDateTime_DateTime*)o)->data[9])
Tim Peters2a799bf2002-12-16 20:18:38 +0000128
Tim Peters37f39822003-01-10 03:49:02 +0000129/* Apply for time instances. */
Tim Peters2a799bf2002-12-16 20:18:38 +0000130#define PyDateTime_TIME_GET_HOUR(o) (((PyDateTime_Time*)o)->data[0])
131#define PyDateTime_TIME_GET_MINUTE(o) (((PyDateTime_Time*)o)->data[1])
132#define PyDateTime_TIME_GET_SECOND(o) (((PyDateTime_Time*)o)->data[2])
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000133#define PyDateTime_TIME_GET_MICROSECOND(o) \
134 ((((PyDateTime_Time*)o)->data[3] << 16) | \
135 (((PyDateTime_Time*)o)->data[4] << 8) | \
136 ((PyDateTime_Time*)o)->data[5])
Tim Peters2a799bf2002-12-16 20:18:38 +0000137
Amaury Forgeot d'Arc5e8260b2012-01-17 21:31:50 +0100138/* Apply for time delta instances */
139#define PyDateTime_DELTA_GET_DAYS(o) (((PyDateTime_Delta*)o)->days)
140#define PyDateTime_DELTA_GET_SECONDS(o) (((PyDateTime_Delta*)o)->seconds)
141#define PyDateTime_DELTA_GET_MICROSECONDS(o) \
142 (((PyDateTime_Delta*)o)->microseconds)
143
Tim Peters9ddf40b2004-06-20 22:41:32 +0000144
145/* Define structure for C API. */
146typedef struct {
147 /* type objects */
148 PyTypeObject *DateType;
149 PyTypeObject *DateTimeType;
150 PyTypeObject *TimeType;
151 PyTypeObject *DeltaType;
152 PyTypeObject *TZInfoType;
153
154 /* constructors */
155 PyObject *(*Date_FromDate)(int, int, int, PyTypeObject*);
156 PyObject *(*DateTime_FromDateAndTime)(int, int, int, int, int, int, int,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000157 PyObject*, PyTypeObject*);
Tim Peters9ddf40b2004-06-20 22:41:32 +0000158 PyObject *(*Time_FromTime)(int, int, int, int, PyObject*, PyTypeObject*);
159 PyObject *(*Delta_FromDelta)(int, int, int, int, PyTypeObject*);
160
161 /* constructors for the DB API */
162 PyObject *(*DateTime_FromTimestamp)(PyObject*, PyObject*, PyObject*);
163 PyObject *(*Date_FromTimestamp)(PyObject*, PyObject*);
164
165} PyDateTime_CAPI;
166
Benjamin Petersonb173f782009-05-05 22:31:58 +0000167#define PyDateTime_CAPSULE_NAME "datetime.datetime_CAPI"
Tim Peters9ddf40b2004-06-20 22:41:32 +0000168
Tim Peters9ddf40b2004-06-20 22:41:32 +0000169
170#ifdef Py_BUILD_CORE
171
172/* Macros for type checking when building the Python core. */
Tim Peters2a799bf2002-12-16 20:18:38 +0000173#define PyDate_Check(op) PyObject_TypeCheck(op, &PyDateTime_DateType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000174#define PyDate_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DateType)
Tim Peters2a799bf2002-12-16 20:18:38 +0000175
176#define PyDateTime_Check(op) PyObject_TypeCheck(op, &PyDateTime_DateTimeType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000177#define PyDateTime_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DateTimeType)
Tim Peters2a799bf2002-12-16 20:18:38 +0000178
Tim Peters2a799bf2002-12-16 20:18:38 +0000179#define PyTime_Check(op) PyObject_TypeCheck(op, &PyDateTime_TimeType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000180#define PyTime_CheckExact(op) (Py_TYPE(op) == &PyDateTime_TimeType)
Tim Peters2a799bf2002-12-16 20:18:38 +0000181
Tim Peters2a799bf2002-12-16 20:18:38 +0000182#define PyDelta_Check(op) PyObject_TypeCheck(op, &PyDateTime_DeltaType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000183#define PyDelta_CheckExact(op) (Py_TYPE(op) == &PyDateTime_DeltaType)
Tim Peters2a799bf2002-12-16 20:18:38 +0000184
185#define PyTZInfo_Check(op) PyObject_TypeCheck(op, &PyDateTime_TZInfoType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000186#define PyTZInfo_CheckExact(op) (Py_TYPE(op) == &PyDateTime_TZInfoType)
Tim Peters2a799bf2002-12-16 20:18:38 +0000187
Tim Peters9ddf40b2004-06-20 22:41:32 +0000188#else
189
190/* Define global variable for the C API and a macro for setting it. */
Benjamin Peterson91d58bd2009-12-13 21:30:54 +0000191static PyDateTime_CAPI *PyDateTimeAPI = NULL;
Tim Peters9ddf40b2004-06-20 22:41:32 +0000192
193#define PyDateTime_IMPORT \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000194 PyDateTimeAPI = (PyDateTime_CAPI *)PyCapsule_Import(PyDateTime_CAPSULE_NAME, 0)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000195
196/* Macros for type checking when not building the Python core. */
197#define PyDate_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->DateType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000198#define PyDate_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->DateType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000199
200#define PyDateTime_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->DateTimeType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000201#define PyDateTime_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->DateTimeType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000202
203#define PyTime_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->TimeType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000204#define PyTime_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->TimeType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000205
206#define PyDelta_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->DeltaType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000207#define PyDelta_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->DeltaType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000208
209#define PyTZInfo_Check(op) PyObject_TypeCheck(op, PyDateTimeAPI->TZInfoType)
Christian Heimes90aa7642007-12-19 02:45:37 +0000210#define PyTZInfo_CheckExact(op) (Py_TYPE(op) == PyDateTimeAPI->TZInfoType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000211
212/* Macros for accessing constructors in a simplified fashion. */
213#define PyDate_FromDate(year, month, day) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 PyDateTimeAPI->Date_FromDate(year, month, day, PyDateTimeAPI->DateType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000215
216#define PyDateTime_FromDateAndTime(year, month, day, hour, min, sec, usec) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217 PyDateTimeAPI->DateTime_FromDateAndTime(year, month, day, hour, \
218 min, sec, usec, Py_None, PyDateTimeAPI->DateTimeType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000219
220#define PyTime_FromTime(hour, minute, second, usecond) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000221 PyDateTimeAPI->Time_FromTime(hour, minute, second, usecond, \
222 Py_None, PyDateTimeAPI->TimeType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000223
224#define PyDelta_FromDSU(days, seconds, useconds) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000225 PyDateTimeAPI->Delta_FromDelta(days, seconds, useconds, 1, \
226 PyDateTimeAPI->DeltaType)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000227
228/* Macros supporting the DB API. */
229#define PyDateTime_FromTimestamp(args) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000230 PyDateTimeAPI->DateTime_FromTimestamp( \
231 (PyObject*) (PyDateTimeAPI->DateTimeType), args, NULL)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000232
233#define PyDate_FromTimestamp(args) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000234 PyDateTimeAPI->Date_FromTimestamp( \
235 (PyObject*) (PyDateTimeAPI->DateType), args)
Tim Peters9ddf40b2004-06-20 22:41:32 +0000236
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000237#endif /* Py_BUILD_CORE */
Tim Peters9ddf40b2004-06-20 22:41:32 +0000238
239#ifdef __cplusplus
240}
241#endif
Tim Peters2a799bf2002-12-16 20:18:38 +0000242#endif
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000243#endif /* !Py_LIMITED_API */