blob: f14286ec4345b7cb22af02c94e99dda7a09baea4 [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
40*** WARNING *** setlistitem does not increment the new item's reference
41count, but does decrement the reference count of the item it replaces,
42if not nil. It does *decrement* the reference count if it is *not*
43inserted in the list. Similarly, getlistitem does not increment the
44returned item's reference count.
45*/
46
Guido van Rossum3f5da241990-12-20 15:06:42 +000047typedef struct {
48 OB_VARHEAD
49 object **ob_item;
50} listobject;
51
Guido van Rossume89bc751994-08-18 16:18:13 +000052extern DL_IMPORT typeobject Listtype;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053
54#define is_listobject(op) ((op)->ob_type == &Listtype)
55
56extern object *newlistobject PROTO((int size));
57extern int getlistsize PROTO((object *));
58extern object *getlistitem PROTO((object *, int));
59extern int setlistitem PROTO((object *, int, object *));
60extern int inslistitem PROTO((object *, int, object *));
61extern int addlistitem PROTO((object *, object *));
Guido van Rossum234f9421993-06-17 12:35:49 +000062extern object *getlistslice PROTO((object *, int, int));
63extern int setlistslice PROTO((object *, int, int, object *));
Guido van Rossum14da5801990-10-30 13:32:39 +000064extern int sortlist PROTO((object *));
Guido van Rossumb6775db1994-08-01 11:34:53 +000065extern object *listtuple PROTO((object *));
Guido van Rossum3f5da241990-12-20 15:06:42 +000066
67/* Macro, trading safety for speed */
68#define GETLISTITEM(op, i) ((op)->ob_item[i])
Guido van Rossuma3309961993-07-28 09:05:47 +000069
70#ifdef __cplusplus
71}
72#endif
73#endif /* !Py_LISTOBJECT_H */