Green shading in the line number column means the source is part of the translation unit, red means it is conditionally excluded. Highlighted line numbers link to the translation unit page. Highlighted macros link to the macro page.
1: 2: /* List object interface */ 3: 4: /* 5: Another generally useful object type is a 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: #ifndef Py_LIMITED_API 23: typedef struct { 24: PyObject_VAR_HEAD 25: /* Vector of pointers to list elements. list[0] is ob_item[0], etc. */ 26: PyObject **ob_item; 27: 28: /* ob_item contains space for 'allocated' elements. The number 29: * currently in use is ob_size. 30: * Invariants: 31: * 0 <= ob_size <= allocated 32: * len(list) == ob_size 33: * ob_item == NULL implies ob_size == allocated == 0 34: * list.sort() temporarily sets allocated to -1 to detect mutations. 35: * 36: * Items must normally not be NULL, except during construction when 37: * the list is not yet visible outside the function that builds it. 38: */ 39: Py_ssize_t allocated; 40: } PyListObject; 41: #endif 42: 43: PyAPI_DATA(PyTypeObject) PyList_Type; 44: PyAPI_DATA(PyTypeObject) PyListIter_Type; 45: PyAPI_DATA(PyTypeObject) PyListRevIter_Type; 46: PyAPI_DATA(PyTypeObject) PySortWrapper_Type; 47: 48: #define PyList_Check(op) \ 49: PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_LIST_SUBCLASS) 50: #define PyList_CheckExact(op) (Py_TYPE(op) == &PyList_Type) 51: 52: PyAPI_FUNC(PyObject *) PyList_New(Py_ssize_t size); 53: PyAPI_FUNC(Py_ssize_t) PyList_Size(PyObject *); 54: PyAPI_FUNC(PyObject *) PyList_GetItem(PyObject *, Py_ssize_t); 55: PyAPI_FUNC(int) PyList_SetItem(PyObject *, Py_ssize_t, PyObject *); 56: PyAPI_FUNC(int) PyList_Insert(PyObject *, Py_ssize_t, PyObject *); 57: PyAPI_FUNC(int) PyList_Append(PyObject *, PyObject *); 58: PyAPI_FUNC(PyObject *) PyList_GetSlice(PyObject *, Py_ssize_t, Py_ssize_t); 59: PyAPI_FUNC(int) PyList_SetSlice(PyObject *, Py_ssize_t, Py_ssize_t, PyObject *); 60: PyAPI_FUNC(int) PyList_Sort(PyObject *); 61: PyAPI_FUNC(int) PyList_Reverse(PyObject *); 62: PyAPI_FUNC(PyObject *) PyList_AsTuple(PyObject *); 63: #ifndef Py_LIMITED_API 64: PyAPI_FUNC(PyObject *) _PyList_Extend(PyListObject *, PyObject *); 65: 66: PyAPI_FUNC(int) PyList_ClearFreeList(void); 67: PyAPI_FUNC(void) _PyList_DebugMallocStats(FILE *out); 68: #endif 69: 70: /* Macro, trading safety for speed */ 71: #ifndef Py_LIMITED_API 72: #define PyList_GET_ITEM(op, i) (((PyListObject *)(op))->ob_item[i]) 73: #define PyList_SET_ITEM(op, i, v) (((PyListObject *)(op))->ob_item[i] = (v)) 74: #define PyList_GET_SIZE(op) Py_SIZE(op) 75: #define _PyList_ITEMS(op) (((PyListObject *)(op))->ob_item) 76: #endif 77: 78: #ifdef __cplusplus 79: } 80: #endif 81: #endif /* !Py_LISTOBJECT_H */ 82: