blob: 76b49be334e68a0d55e785b536c875c83feec526 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_LISTOBJECT_H
2#define Py_LISTOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007/***********************************************************
Guido van Rossum5799b521995-01-04 19:06:22 +00008Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
13Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
15provided that the above copyright notice appear in all copies and that
16both that copyright notice and this permission notice appear in
17supporting documentation, and that the names of Stichting Mathematisch
18Centrum or CWI not be used in advertising or publicity pertaining to
19distribution of the software without specific, written prior permission.
20
21STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
22THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
23FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
24FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
25WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
26ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
27OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
28
29******************************************************************/
30
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031/* List object interface */
32
33/*
34123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
35
36Another generally useful object type is an list of object pointers.
37This is a mutable type: the list items can be changed, and items can be
38added or removed. Out-of-range indices or non-list objects are ignored.
39
Guido van Rossumcaa63801995-01-12 11:45:45 +000040*** WARNING *** PyList_SetItem does not increment the new item's reference
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000041count, but does decrement the reference count of the item it replaces,
42if not nil. It does *decrement* the reference count if it is *not*
Guido van Rossumcaa63801995-01-12 11:45:45 +000043inserted in the list. Similarly, PyList_GetItem does not increment the
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000044returned item's reference count.
45*/
46
Guido van Rossum3f5da241990-12-20 15:06:42 +000047typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000048 PyObject_VAR_HEAD
49 PyObject **ob_item;
50} PyListObject;
Guido van Rossum3f5da241990-12-20 15:06:42 +000051
Guido van Rossum051ab121995-02-27 10:17:52 +000052extern DL_IMPORT(PyTypeObject) PyList_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053
Guido van Rossumcaa63801995-01-12 11:45:45 +000054#define PyList_Check(op) ((op)->ob_type == &PyList_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000055
Guido van Rossumcaa63801995-01-12 11:45:45 +000056extern PyObject *PyList_New Py_PROTO((int size));
57extern int PyList_Size Py_PROTO((PyObject *));
58extern PyObject *PyList_GetItem Py_PROTO((PyObject *, int));
59extern int PyList_SetItem Py_PROTO((PyObject *, int, PyObject *));
60extern int PyList_Insert Py_PROTO((PyObject *, int, PyObject *));
61extern int PyList_Append Py_PROTO((PyObject *, PyObject *));
62extern PyObject *PyList_GetSlice Py_PROTO((PyObject *, int, int));
63extern int PyList_SetSlice Py_PROTO((PyObject *, int, int, PyObject *));
64extern int PyList_Sort Py_PROTO((PyObject *));
Guido van Rossum93817821995-01-17 16:01:01 +000065extern int PyList_Reverse Py_PROTO((PyObject *));
Guido van Rossum855d0b31995-01-20 16:52:42 +000066extern PyObject *PyList_AsTuple Py_PROTO((PyObject *));
Guido van Rossum3f5da241990-12-20 15:06:42 +000067
68/* Macro, trading safety for speed */
Guido van Rossumcaa63801995-01-12 11:45:45 +000069#define PyList_GET_ITEM(op, i) ((op)->ob_item[i])
Guido van Rossuma3309961993-07-28 09:05:47 +000070
71#ifdef __cplusplus
72}
73#endif
74#endif /* !Py_LISTOBJECT_H */