Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_LISTOBJECT_H |
| 2 | #define Py_LISTOBJECT_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 7 | /*********************************************************** |
Guido van Rossum | 5799b52 | 1995-01-04 19:06:22 +0000 | [diff] [blame] | 8 | Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam, |
| 9 | The Netherlands. |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 10 | |
| 11 | All Rights Reserved |
| 12 | |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame^] | 13 | Copyright (c) 2000, BeOpen.com. |
| 14 | Copyright (c) 1995-2000, Corporation for National Research Initiatives. |
| 15 | Copyright (c) 1990-1995, Stichting Mathematisch Centrum. |
| 16 | All rights reserved. |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 17 | |
Guido van Rossum | fd71b9e | 2000-06-30 23:50:40 +0000 | [diff] [blame^] | 18 | See the file "Misc/COPYRIGHT" for information on usage and |
| 19 | redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 20 | |
| 21 | ******************************************************************/ |
| 22 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 23 | /* List object interface */ |
| 24 | |
| 25 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 26 | Another generally useful object type is an list of object pointers. |
| 27 | This is a mutable type: the list items can be changed, and items can be |
| 28 | added or removed. Out-of-range indices or non-list objects are ignored. |
| 29 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 30 | *** WARNING *** PyList_SetItem does not increment the new item's reference |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 31 | count, but does decrement the reference count of the item it replaces, |
| 32 | if not nil. It does *decrement* the reference count if it is *not* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 33 | inserted in the list. Similarly, PyList_GetItem does not increment the |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 34 | returned item's reference count. |
| 35 | */ |
| 36 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 37 | typedef struct { |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 38 | PyObject_VAR_HEAD |
| 39 | PyObject **ob_item; |
| 40 | } PyListObject; |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 41 | |
Guido van Rossum | 051ab12 | 1995-02-27 10:17:52 +0000 | [diff] [blame] | 42 | extern DL_IMPORT(PyTypeObject) PyList_Type; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 43 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 44 | #define PyList_Check(op) ((op)->ob_type == &PyList_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 45 | |
Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame] | 46 | extern DL_IMPORT(PyObject *) PyList_New Py_PROTO((int size)); |
| 47 | extern DL_IMPORT(int) PyList_Size Py_PROTO((PyObject *)); |
| 48 | extern DL_IMPORT(PyObject *) PyList_GetItem Py_PROTO((PyObject *, int)); |
| 49 | extern DL_IMPORT(int) PyList_SetItem Py_PROTO((PyObject *, int, PyObject *)); |
| 50 | extern DL_IMPORT(int) PyList_Insert Py_PROTO((PyObject *, int, PyObject *)); |
| 51 | extern DL_IMPORT(int) PyList_Append Py_PROTO((PyObject *, PyObject *)); |
| 52 | extern DL_IMPORT(PyObject *) PyList_GetSlice Py_PROTO((PyObject *, int, int)); |
| 53 | extern DL_IMPORT(int) PyList_SetSlice Py_PROTO((PyObject *, int, int, PyObject *)); |
| 54 | extern DL_IMPORT(int) PyList_Sort Py_PROTO((PyObject *)); |
| 55 | extern DL_IMPORT(int) PyList_Reverse Py_PROTO((PyObject *)); |
| 56 | extern DL_IMPORT(PyObject *) PyList_AsTuple Py_PROTO((PyObject *)); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 57 | |
| 58 | /* Macro, trading safety for speed */ |
Barry Warsaw | 1f2bd07 | 1997-01-06 22:42:00 +0000 | [diff] [blame] | 59 | #define PyList_GET_ITEM(op, i) (((PyListObject *)(op))->ob_item[i]) |
Guido van Rossum | a937d14 | 1998-04-24 18:22:02 +0000 | [diff] [blame] | 60 | #define PyList_SET_ITEM(op, i, v) (((PyListObject *)(op))->ob_item[i] = (v)) |
Barry Warsaw | 1f2bd07 | 1997-01-06 22:42:00 +0000 | [diff] [blame] | 61 | #define PyList_GET_SIZE(op) (((PyListObject *)(op))->ob_size) |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 62 | |
| 63 | #ifdef __cplusplus |
| 64 | } |
| 65 | #endif |
| 66 | #endif /* !Py_LISTOBJECT_H */ |