blob: 221279b3fcb9d71e72060b5d309c42f38f945ee1 [file] [log] [blame]
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001#ifndef Py_LIMITED_API
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +00002#ifndef Py_PYTIME_H
3#define Py_PYTIME_H
4
Victor Stinner4195b5c2012-02-08 23:03:19 +01005#include "pyconfig.h" /* include for defines */
Victor Stinner643cd682012-03-02 22:54:03 +01006#include "object.h"
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +00007
8/**************************************************************************
9Symbols and macros to supply platform-independent interfaces to time related
10functions and constants
11**************************************************************************/
12#ifdef __cplusplus
13extern "C" {
14#endif
15
16#ifdef HAVE_GETTIMEOFDAY
17typedef struct timeval _PyTime_timeval;
18#else
19typedef struct {
20 time_t tv_sec; /* seconds since Jan. 1, 1970 */
21 long tv_usec; /* and microseconds */
22} _PyTime_timeval;
23#endif
24
25/* Similar to POSIX gettimeofday but cannot fail. If system gettimeofday
26 * fails or is not available, fall back to lower resolution clocks.
27 */
28PyAPI_FUNC(void) _PyTime_gettimeofday(_PyTime_timeval *tp);
29
Antoine Pitrou3e1fd272010-09-28 21:23:11 +000030#define _PyTime_ADD_SECONDS(tv, interval) \
31do { \
32 tv.tv_usec += (long) (((long) interval - interval) * 1000000); \
33 tv.tv_sec += (time_t) interval + (time_t) (tv.tv_usec / 1000000); \
34 tv.tv_usec %= 1000000; \
35} while (0)
36
37#define _PyTime_INTERVAL(tv_start, tv_end) \
38 ((tv_end.tv_sec - tv_start.tv_sec) + \
39 (tv_end.tv_usec - tv_start.tv_usec) * 0.000001)
40
Victor Stinner643cd682012-03-02 22:54:03 +010041#ifndef Py_LIMITED_API
Victor Stinner5d272cc2012-03-13 13:35:55 +010042/* Convert a number of seconds, int or float, to time_t. */
43PyAPI_FUNC(int) _PyTime_ObjectToTime_t(
44 PyObject *obj,
45 time_t *sec);
46
Larry Hastings6fe20b32012-04-19 15:07:49 -070047/* Convert a time_t to a PyLong. */
48PyAPI_FUNC(PyObject *) _PyLong_FromTime_t(
49 time_t sec);
50
Victor Stinner5d272cc2012-03-13 13:35:55 +010051/* Convert a number of seconds, int or float, to a timeval structure.
52 usec is in the range [0; 999999] and rounded towards zero.
53 For example, -1.2 is converted to (-2, 800000). */
54PyAPI_FUNC(int) _PyTime_ObjectToTimeval(
55 PyObject *obj,
56 time_t *sec,
57 long *usec);
58
Victor Stinner643cd682012-03-02 22:54:03 +010059/* Convert a number of seconds, int or float, to a timespec structure.
Victor Stinner5d272cc2012-03-13 13:35:55 +010060 nsec is in the range [0; 999999999] and rounded towards zero.
61 For example, -1.2 is converted to (-2, 800000000). */
Victor Stinner643cd682012-03-02 22:54:03 +010062PyAPI_FUNC(int) _PyTime_ObjectToTimespec(
63 PyObject *obj,
64 time_t *sec,
65 long *nsec);
66#endif
67
Alexander Belopolsky6fc4ade2010-08-05 17:34:27 +000068/* Dummy to force linking. */
69PyAPI_FUNC(void) _PyTime_Init(void);
70
71#ifdef __cplusplus
72}
73#endif
74
75#endif /* Py_PYTIME_H */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000076#endif /* Py_LIMITED_API */