tupleobject.h 2.28 KB
Newer Older
1

Guido van Rossum's avatar
Guido van Rossum committed
2 3
/* Tuple object interface */

4 5 6 7 8 9
#ifndef Py_TUPLEOBJECT_H
#define Py_TUPLEOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

Guido van Rossum's avatar
Guido van Rossum committed
10
/*
11 12 13 14 15
Another generally useful object type is a tuple of object pointers.
For Python, this is an immutable type.  C code can change the tuple items
(but not their number), and even use tuples are general-purpose arrays of
object references, but in general only brand new tuples should be mutated,
not ones that might already have been exposed to Python code.
Guido van Rossum's avatar
Guido van Rossum committed
16

17
*** WARNING *** PyTuple_SetItem does not increment the new item's reference
Guido van Rossum's avatar
Guido van Rossum committed
18 19
count, but does decrement the reference count of the item it replaces,
if not nil.  It does *decrement* the reference count if it is *not*
20
inserted in the tuple.  Similarly, PyTuple_GetItem does not increment the
Guido van Rossum's avatar
Guido van Rossum committed
21 22 23
returned item's reference count.
*/

24
#ifndef Py_LIMITED_API
Guido van Rossum's avatar
Guido van Rossum committed
25
typedef struct {
26 27
    PyObject_VAR_HEAD
    PyObject *ob_item[1];
28 29 30 31 32

    /* ob_item contains space for 'ob_size' elements.
     * Items must normally not be NULL, except during construction when
     * the tuple is not yet visible outside the function that builds it.
     */
33
} PyTupleObject;
34
#endif
Guido van Rossum's avatar
Guido van Rossum committed
35

36
PyAPI_DATA(PyTypeObject) PyTuple_Type;
37
PyAPI_DATA(PyTypeObject) PyTupleIter_Type;
Guido van Rossum's avatar
Guido van Rossum committed
38

39
#define PyTuple_Check(op) \
40 41
                 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_TUPLE_SUBCLASS)
#define PyTuple_CheckExact(op) (Py_TYPE(op) == &PyTuple_Type)
Guido van Rossum's avatar
Guido van Rossum committed
42

Martin v. Löwis's avatar
Martin v. Löwis committed
43 44 45 46 47
PyAPI_FUNC(PyObject *) PyTuple_New(Py_ssize_t size);
PyAPI_FUNC(Py_ssize_t) PyTuple_Size(PyObject *);
PyAPI_FUNC(PyObject *) PyTuple_GetItem(PyObject *, Py_ssize_t);
PyAPI_FUNC(int) PyTuple_SetItem(PyObject *, Py_ssize_t, PyObject *);
PyAPI_FUNC(PyObject *) PyTuple_GetSlice(PyObject *, Py_ssize_t, Py_ssize_t);
48
#ifndef Py_LIMITED_API
Martin v. Löwis's avatar
Martin v. Löwis committed
49
PyAPI_FUNC(int) _PyTuple_Resize(PyObject **, Py_ssize_t);
50
#endif
Martin v. Löwis's avatar
Martin v. Löwis committed
51
PyAPI_FUNC(PyObject *) PyTuple_Pack(Py_ssize_t, ...);
52
#ifndef Py_LIMITED_API
53
PyAPI_FUNC(void) _PyTuple_MaybeUntrack(PyObject *);
54
#endif
Guido van Rossum's avatar
Guido van Rossum committed
55 56

/* Macro, trading safety for speed */
57
#ifndef Py_LIMITED_API
58
#define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i])
59
#define PyTuple_GET_SIZE(op)    Py_SIZE(op)
60 61 62

/* Macro, *only* to be used to fill in brand new tuples */
#define PyTuple_SET_ITEM(op, i, v) (((PyTupleObject *)(op))->ob_item[i] = v)
63
#endif
64

Christian Heimes's avatar
Christian Heimes committed
65 66
PyAPI_FUNC(int) PyTuple_ClearFreeList(void);

67 68 69 70
#ifdef __cplusplus
}
#endif
#endif /* !Py_TUPLEOBJECT_H */