Include/listobject.h

   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     Py_ssize_t allocated;
  39 } PyListObject;
  40
  41 PyAPI_DATA(PyTypeObject) PyList_Type;
  42 PyAPI_DATA(PyTypeObject) PyListIter_Type;
  43 PyAPI_DATA(PyTypeObject) PyListRevIter_Type;
  44 PyAPI_DATA(PyTypeObject) PySortWrapper_Type;
  45
  46 #define PyList_Check(op) \
  47                 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_LIST_SUBCLASS)
  48 #define PyList_CheckExact(op) (Py_TYPE(op) == &PyList_Type)
  49
  50 PyAPI_FUNC(PyObject *) PyList_New(Py_ssize_t size);
  51 PyAPI_FUNC(Py_ssize_t) PyList_Size(PyObject *);
  52 PyAPI_FUNC(PyObject *) PyList_GetItem(PyObject *, Py_ssize_t);
  53 PyAPI_FUNC(int) PyList_SetItem(PyObject *, Py_ssize_t, PyObject *);
  54 PyAPI_FUNC(int) PyList_Insert(PyObject *, Py_ssize_t, PyObject *);
  55 PyAPI_FUNC(int) PyList_Append(PyObject *, PyObject *);
  56 PyAPI_FUNC(PyObject *) PyList_GetSlice(PyObject *, Py_ssize_t, Py_ssize_t);
  57 PyAPI_FUNC(int) PyList_SetSlice(PyObject *, Py_ssize_t, Py_ssize_t, PyObject *);
  58 PyAPI_FUNC(int) PyList_Sort(PyObject *);
  59 PyAPI_FUNC(int) PyList_Reverse(PyObject *);
  60 PyAPI_FUNC(PyObject *) PyList_AsTuple(PyObject *);
  61 PyAPI_FUNC(PyObject *) _PyList_Extend(PyListObject *, PyObject *);
  62
  63 /* Macro, trading safety for speed */
  64 #define PyList_GET_ITEM(op, i) (((PyListObject *)(op))->ob_item[i])
  65 #define PyList_SET_ITEM(op, i, v) (((PyListObject *)(op))->ob_item[i] = (v))
  66 #define PyList_GET_SIZE(op)    Py_SIZE(op)
  67
  68 #ifdef __cplusplus
  69 }
  70 #endif
  71 #endif /* !Py_LISTOBJECT_H */