Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | |
2 | /* List object interface */ | |
3 | ||
4 | /* | |
5 | Another generally useful object type is an list of object pointers. | |
6 | This is a mutable type: the list items can be changed, and items can be | |
7 | added or removed. Out-of-range indices or non-list objects are ignored. | |
8 | ||
9 | *** WARNING *** PyList_SetItem does not increment the new item's reference | |
10 | count, but does decrement the reference count of the item it replaces, | |
11 | if not nil. It does *decrement* the reference count if it is *not* | |
12 | inserted in the list. Similarly, PyList_GetItem does not increment the | |
13 | returned item's reference count. | |
14 | */ | |
15 | ||
16 | #ifndef Py_LISTOBJECT_H | |
17 | #define Py_LISTOBJECT_H | |
18 | #ifdef __cplusplus | |
19 | extern "C" { | |
20 | #endif | |
21 | ||
22 | typedef struct { | |
23 | PyObject_VAR_HEAD | |
24 | /* Vector of pointers to list elements. list[0] is ob_item[0], etc. */ | |
25 | PyObject **ob_item; | |
26 | ||
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 | |
33 | * list.sort() temporarily sets allocated to -1 to detect mutations. | |
34 | * | |
35 | * Items must normally not be NULL, except during construction when | |
36 | * the list is not yet visible outside the function that builds it. | |
37 | */ | |
38 | int allocated; | |
39 | } PyListObject; | |
40 | ||
41 | PyAPI_DATA(PyTypeObject) PyList_Type; | |
42 | ||
43 | #define PyList_Check(op) PyObject_TypeCheck(op, &PyList_Type) | |
44 | #define PyList_CheckExact(op) ((op)->ob_type == &PyList_Type) | |
45 | ||
46 | PyAPI_FUNC(PyObject *) PyList_New(int size); | |
47 | PyAPI_FUNC(int) PyList_Size(PyObject *); | |
48 | PyAPI_FUNC(PyObject *) PyList_GetItem(PyObject *, int); | |
49 | PyAPI_FUNC(int) PyList_SetItem(PyObject *, int, PyObject *); | |
50 | PyAPI_FUNC(int) PyList_Insert(PyObject *, int, PyObject *); | |
51 | PyAPI_FUNC(int) PyList_Append(PyObject *, PyObject *); | |
52 | PyAPI_FUNC(PyObject *) PyList_GetSlice(PyObject *, int, int); | |
53 | PyAPI_FUNC(int) PyList_SetSlice(PyObject *, int, int, PyObject *); | |
54 | PyAPI_FUNC(int) PyList_Sort(PyObject *); | |
55 | PyAPI_FUNC(int) PyList_Reverse(PyObject *); | |
56 | PyAPI_FUNC(PyObject *) PyList_AsTuple(PyObject *); | |
57 | PyAPI_FUNC(PyObject *) _PyList_Extend(PyListObject *, PyObject *); | |
58 | ||
59 | /* Macro, trading safety for speed */ | |
60 | #define PyList_GET_ITEM(op, i) (((PyListObject *)(op))->ob_item[i]) | |
61 | #define PyList_SET_ITEM(op, i, v) (((PyListObject *)(op))->ob_item[i] = (v)) | |
62 | #define PyList_GET_SIZE(op) (((PyListObject *)(op))->ob_size) | |
63 | ||
64 | #ifdef __cplusplus | |
65 | } | |
66 | #endif | |
67 | #endif /* !Py_LISTOBJECT_H */ |