blob: dfbc6af837d211a580fa70314068d578b57b64d9 [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
Guido van Rossumd266eb41996-10-25 14:44:06 +000013Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015provided that the above copyright notice appear in all copies and that
Guido van Rossumd266eb41996-10-25 14:44:06 +000016both that copyright notice and this permission notice appear in
Guido van Rossumf70e43a1991-02-19 12:39:46 +000017supporting documentation, and that the names of Stichting Mathematisch
Guido van Rossumd266eb41996-10-25 14:44:06 +000018Centrum or CWI or Corporation for National Research Initiatives or
19CNRI not be used in advertising or publicity pertaining to
20distribution of the software without specific, written prior
21permission.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000022
Guido van Rossumd266eb41996-10-25 14:44:06 +000023While CWI is the initial source for this software, a modified version
24is made available by the Corporation for National Research Initiatives
25(CNRI) at the Internet address ftp://ftp.python.org.
26
27STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
28REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
29MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
30CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
31DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
33TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
34PERFORMANCE OF THIS SOFTWARE.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000035
36******************************************************************/
37
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038/* List object interface */
39
40/*
41123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
42
43Another generally useful object type is an list of object pointers.
44This is a mutable type: the list items can be changed, and items can be
45added or removed. Out-of-range indices or non-list objects are ignored.
46
Guido van Rossumcaa63801995-01-12 11:45:45 +000047*** WARNING *** PyList_SetItem does not increment the new item's reference
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000048count, but does decrement the reference count of the item it replaces,
49if not nil. It does *decrement* the reference count if it is *not*
Guido van Rossumcaa63801995-01-12 11:45:45 +000050inserted in the list. Similarly, PyList_GetItem does not increment the
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000051returned item's reference count.
52*/
53
Guido van Rossum3f5da241990-12-20 15:06:42 +000054typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000055 PyObject_VAR_HEAD
56 PyObject **ob_item;
57} PyListObject;
Guido van Rossum3f5da241990-12-20 15:06:42 +000058
Guido van Rossum051ab121995-02-27 10:17:52 +000059extern DL_IMPORT(PyTypeObject) PyList_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000060
Guido van Rossumcaa63801995-01-12 11:45:45 +000061#define PyList_Check(op) ((op)->ob_type == &PyList_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062
Guido van Rossum43466ec1998-12-04 18:48:25 +000063extern DL_IMPORT(PyObject *) PyList_New Py_PROTO((int size));
64extern DL_IMPORT(int) PyList_Size Py_PROTO((PyObject *));
65extern DL_IMPORT(PyObject *) PyList_GetItem Py_PROTO((PyObject *, int));
66extern DL_IMPORT(int) PyList_SetItem Py_PROTO((PyObject *, int, PyObject *));
67extern DL_IMPORT(int) PyList_Insert Py_PROTO((PyObject *, int, PyObject *));
68extern DL_IMPORT(int) PyList_Append Py_PROTO((PyObject *, PyObject *));
69extern DL_IMPORT(PyObject *) PyList_GetSlice Py_PROTO((PyObject *, int, int));
70extern DL_IMPORT(int) PyList_SetSlice Py_PROTO((PyObject *, int, int, PyObject *));
71extern DL_IMPORT(int) PyList_Sort Py_PROTO((PyObject *));
72extern DL_IMPORT(int) PyList_Reverse Py_PROTO((PyObject *));
73extern DL_IMPORT(PyObject *) PyList_AsTuple Py_PROTO((PyObject *));
Guido van Rossum3f5da241990-12-20 15:06:42 +000074
75/* Macro, trading safety for speed */
Barry Warsaw1f2bd071997-01-06 22:42:00 +000076#define PyList_GET_ITEM(op, i) (((PyListObject *)(op))->ob_item[i])
Guido van Rossuma937d141998-04-24 18:22:02 +000077#define PyList_SET_ITEM(op, i, v) (((PyListObject *)(op))->ob_item[i] = (v))
Barry Warsaw1f2bd071997-01-06 22:42:00 +000078#define PyList_GET_SIZE(op) (((PyListObject *)(op))->ob_size)
Guido van Rossuma3309961993-07-28 09:05:47 +000079
80#ifdef __cplusplus
81}
82#endif
83#endif /* !Py_LISTOBJECT_H */