blob: d9012ce93ec9bdecbf56e9b0ca55cc7c91903fe1 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* List object interface */
3
4/*
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005Another generally useful object type is an list of object pointers.
6This is a mutable type: the list items can be changed, and items can be
7added or removed. Out-of-range indices or non-list objects are ignored.
8
Guido van Rossumcaa63801995-01-12 11:45:45 +00009*** WARNING *** PyList_SetItem does not increment the new item's reference
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000010count, but does decrement the reference count of the item it replaces,
11if not nil. It does *decrement* the reference count if it is *not*
Guido van Rossumcaa63801995-01-12 11:45:45 +000012inserted in the list. Similarly, PyList_GetItem does not increment the
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013returned item's reference count.
14*/
15
Fred Drakeea9cb5a2000-07-09 00:20:36 +000016#ifndef Py_LISTOBJECT_H
17#define Py_LISTOBJECT_H
18#ifdef __cplusplus
19extern "C" {
20#endif
21
Guido van Rossum3f5da241990-12-20 15:06:42 +000022typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000023 PyObject_VAR_HEAD
Neal Norwitz4ecd8cd2004-08-01 22:45:27 +000024 /* Vector of pointers to list elements. list[0] is ob_item[0], etc. */
Fred Drakeea9cb5a2000-07-09 00:20:36 +000025 PyObject **ob_item;
Tim Petersa995a2d2004-07-29 03:29:15 +000026
27 /* ob_item contains space for 'allocated' elements. The number
28 * currently in use is ob_size.
29 * Invariants:
30 * 0 <= ob_size <= allocated
31 * len(list) == ob_size
32 * ob_item == NULL implies ob_size == allocated == 0
Armin Rigo93677f02004-07-29 12:40:23 +000033 * list.sort() temporarily sets allocated to -1 to detect mutations.
Armin Rigo89a39462004-10-28 16:32:00 +000034 *
35 * Items must normally not be NULL, except during construction when
36 * the list is not yet visible outside the function that builds it.
Tim Petersa995a2d2004-07-29 03:29:15 +000037 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000038 Py_ssize_t allocated;
Guido van Rossumcaa63801995-01-12 11:45:45 +000039} PyListObject;
Guido van Rossum3f5da241990-12-20 15:06:42 +000040
Mark Hammond91a681d2002-08-12 07:21:58 +000041PyAPI_DATA(PyTypeObject) PyList_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000042
Tim Peters6d6c1a32001-08-02 04:15:00 +000043#define PyList_Check(op) PyObject_TypeCheck(op, &PyList_Type)
Tim Petersb1c46982001-10-05 20:41:38 +000044#define PyList_CheckExact(op) ((op)->ob_type == &PyList_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000045
Martin v. Löwis18e16552006-02-15 17:27:45 +000046PyAPI_FUNC(PyObject *) PyList_New(Py_ssize_t size);
47PyAPI_FUNC(Py_ssize_t) PyList_Size(PyObject *);
48PyAPI_FUNC(PyObject *) PyList_GetItem(PyObject *, Py_ssize_t);
49PyAPI_FUNC(int) PyList_SetItem(PyObject *, Py_ssize_t, PyObject *);
50PyAPI_FUNC(int) PyList_Insert(PyObject *, Py_ssize_t, PyObject *);
Mark Hammond91a681d2002-08-12 07:21:58 +000051PyAPI_FUNC(int) PyList_Append(PyObject *, PyObject *);
Martin v. Löwis18e16552006-02-15 17:27:45 +000052PyAPI_FUNC(PyObject *) PyList_GetSlice(PyObject *, Py_ssize_t, Py_ssize_t);
53PyAPI_FUNC(int) PyList_SetSlice(PyObject *, Py_ssize_t, Py_ssize_t, PyObject *);
Mark Hammond91a681d2002-08-12 07:21:58 +000054PyAPI_FUNC(int) PyList_Sort(PyObject *);
55PyAPI_FUNC(int) PyList_Reverse(PyObject *);
56PyAPI_FUNC(PyObject *) PyList_AsTuple(PyObject *);
Raymond Hettinger8ca92ae2004-03-11 09:13:12 +000057PyAPI_FUNC(PyObject *) _PyList_Extend(PyListObject *, PyObject *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000058
59/* Macro, trading safety for speed */
Barry Warsaw1f2bd071997-01-06 22:42:00 +000060#define PyList_GET_ITEM(op, i) (((PyListObject *)(op))->ob_item[i])
Guido van Rossuma937d141998-04-24 18:22:02 +000061#define PyList_SET_ITEM(op, i, v) (((PyListObject *)(op))->ob_item[i] = (v))
Barry Warsaw1f2bd071997-01-06 22:42:00 +000062#define PyList_GET_SIZE(op) (((PyListObject *)(op))->ob_size)
Guido van Rossuma3309961993-07-28 09:05:47 +000063
64#ifdef __cplusplus
65}
66#endif
67#endif /* !Py_LISTOBJECT_H */