summaryrefslogtreecommitdiffstats
path: root/Include/pytime.h
blob: 6d438f3877ea9ce352483da377c0620bed033065 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#ifndef Py_LIMITED_API
#ifndef Py_PYTIME_H
#define Py_PYTIME_H

#include "pyport.h"
#include "object.h"

/**************************************************************************
Symbols and macros to supply platform-independent interfaces to time related
functions and constants
**************************************************************************/
#ifdef __cplusplus
extern "C" {
#endif

#ifdef HAVE_GETTIMEOFDAY
typedef struct timeval _PyTime_timeval;
#else
typedef struct {
    time_t       tv_sec;   /* seconds since Jan. 1, 1970 */
    long         tv_usec;  /* and microseconds */
} _PyTime_timeval;
#endif

/* Similar to POSIX gettimeofday but cannot fail.  If system gettimeofday
 * fails or is not available, fall back to lower resolution clocks.
 */
PyAPI_FUNC(void) _PyTime_gettimeofday(_PyTime_timeval *tp);

#define _PyTime_ADD_SECONDS(tv, interval) \
do { \
    tv.tv_usec += (long) (((long) interval - interval) * 1000000); \
    tv.tv_sec += (time_t) interval + (time_t) (tv.tv_usec / 1000000); \
    tv.tv_usec %= 1000000; \
} while (0)

#define _PyTime_INTERVAL(tv_start, tv_end) \
    ((tv_end.tv_sec - tv_start.tv_sec) + \
     (tv_end.tv_usec - tv_start.tv_usec) * 0.000001)

#if defined(HAVE_LONG_LONG)
typedef unsigned PY_LONG_LONG _PyTime_fraction_t;
#else
typedef size_t _PyTime_fraction_t;
#endif

typedef struct
{
    /* timestamp = seconds + numerator / denominator */
    time_t seconds;
    _PyTime_fraction_t numerator;
    /* denominator cannot be zero */
    _PyTime_fraction_t denominator;
    /* the timestamp resolution is 1/divisor */
} _PyTime_t;

/* Similar to POSIX gettimeofday.  If system gettimeofday
   fails or is not available, fall back to lower resolution clocks.  */
PyAPI_FUNC(void) _PyTime_get(_PyTime_t *tp);

/* Convert a timestamp structure to the specified timestamp type.

   Raise a ValueError if the timestamp type is unknown. */
PyAPI_FUNC(PyObject*) _PyTime_Convert(_PyTime_t *ts, PyObject *timestamp);

/* Dummy to force linking. */
PyAPI_FUNC(void) _PyTime_Init(void);

#ifdef __cplusplus
}
#endif

#endif /* Py_PYTIME_H */
#endif /* Py_LIMITED_API */