blob: 1565f2a5c3d986ac041208e57d32e8969e48a583 [file] [log] [blame]
Victor Stinner54ba5562018-11-28 13:01:32 +01001#ifndef Py_CPYTHON_TUPLEOBJECT_H
2# error "this header file must not be included directly"
3#endif
4
5#ifdef __cplusplus
6extern "C" {
7#endif
8
9typedef struct {
10 PyObject_VAR_HEAD
11 /* ob_item contains space for 'ob_size' elements.
12 Items must normally not be NULL, except during construction when
13 the tuple is not yet visible outside the function that builds it. */
14 PyObject *ob_item[1];
15} PyTupleObject;
16
17PyAPI_FUNC(int) _PyTuple_Resize(PyObject **, Py_ssize_t);
18PyAPI_FUNC(void) _PyTuple_MaybeUntrack(PyObject *);
19
20/* Macros trading safety for speed */
21
22/* Cast argument to PyTupleObject* type. */
23#define _PyTuple_CAST(op) (assert(PyTuple_Check(op)), (PyTupleObject *)(op))
24
25#define PyTuple_GET_SIZE(op) Py_SIZE(_PyTuple_CAST(op))
26
27#define PyTuple_GET_ITEM(op, i) (_PyTuple_CAST(op)->ob_item[i])
28
29/* Macro, *only* to be used to fill in brand new tuples */
30#define PyTuple_SET_ITEM(op, i, v) (_PyTuple_CAST(op)->ob_item[i] = v)
31
32PyAPI_FUNC(void) _PyTuple_DebugMallocStats(FILE *out);
33
34#ifdef __cplusplus
35}
36#endif