Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 1 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 2 | /* Tuple object interface */ |
| 3 | |
Fred Drake | 3cf4d2b | 2000-07-09 00:55:06 +0000 | [diff] [blame] | 4 | #ifndef Py_TUPLEOBJECT_H |
| 5 | #define Py_TUPLEOBJECT_H |
| 6 | #ifdef __cplusplus |
| 7 | extern "C" { |
| 8 | #endif |
| 9 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 10 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 11 | Another generally useful object type is an tuple of object pointers. |
| 12 | This is a mutable type: the tuple items can be changed (but not their |
| 13 | number). Out-of-range indices or non-tuple objects are ignored. |
| 14 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 15 | *** WARNING *** PyTuple_SetItem does not increment the new item's reference |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 16 | count, but does decrement the reference count of the item it replaces, |
| 17 | if not nil. It does *decrement* the reference count if it is *not* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 18 | inserted in the tuple. Similarly, PyTuple_GetItem does not increment the |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 19 | returned item's reference count. |
| 20 | */ |
| 21 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 22 | typedef struct { |
Fred Drake | 3cf4d2b | 2000-07-09 00:55:06 +0000 | [diff] [blame] | 23 | PyObject_VAR_HEAD |
| 24 | PyObject *ob_item[1]; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 25 | } PyTupleObject; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 26 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 27 | PyAPI_DATA(PyTypeObject) PyTuple_Type; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 28 | |
Guido van Rossum | 5eef77a | 2001-08-30 03:08:07 +0000 | [diff] [blame] | 29 | #define PyTuple_Check(op) PyObject_TypeCheck(op, &PyTuple_Type) |
Tim Peters | 4c3a0a3 | 2001-09-10 23:37:46 +0000 | [diff] [blame] | 30 | #define PyTuple_CheckExact(op) ((op)->ob_type == &PyTuple_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 31 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 32 | PyAPI_FUNC(PyObject *) PyTuple_New(int size); |
| 33 | PyAPI_FUNC(int) PyTuple_Size(PyObject *); |
| 34 | PyAPI_FUNC(PyObject *) PyTuple_GetItem(PyObject *, int); |
| 35 | PyAPI_FUNC(int) PyTuple_SetItem(PyObject *, int, PyObject *); |
| 36 | PyAPI_FUNC(PyObject *) PyTuple_GetSlice(PyObject *, int, int); |
| 37 | PyAPI_FUNC(int) _PyTuple_Resize(PyObject **, int); |
Raymond Hettinger | cb2da43 | 2003-10-12 18:24:34 +0000 | [diff] [blame^] | 38 | PyAPI_FUNC(PyObject *) PyTuple_Pack(int, ...); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 39 | |
| 40 | /* Macro, trading safety for speed */ |
Guido van Rossum | 599de5a | 1995-03-09 12:10:16 +0000 | [diff] [blame] | 41 | #define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i]) |
Barry Warsaw | 9c5494a | 1997-01-06 22:44:27 +0000 | [diff] [blame] | 42 | #define PyTuple_GET_SIZE(op) (((PyTupleObject *)(op))->ob_size) |
Guido van Rossum | 599de5a | 1995-03-09 12:10:16 +0000 | [diff] [blame] | 43 | |
| 44 | /* Macro, *only* to be used to fill in brand new tuples */ |
| 45 | #define PyTuple_SET_ITEM(op, i, v) (((PyTupleObject *)(op))->ob_item[i] = v) |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 46 | |
| 47 | #ifdef __cplusplus |
| 48 | } |
| 49 | #endif |
| 50 | #endif /* !Py_TUPLEOBJECT_H */ |