blob: 506f96532fce58fa0897422db52f941a1923eb1a [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_TUPLEOBJECT_H
2#define Py_TUPLEOBJECT_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/* Tuple object interface */
39
40/*
41123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
42
43Another generally useful object type is an tuple of object pointers.
44This is a mutable type: the tuple items can be changed (but not their
45number). Out-of-range indices or non-tuple objects are ignored.
46
Guido van Rossumcaa63801995-01-12 11:45:45 +000047*** WARNING *** PyTuple_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 tuple. Similarly, PyTuple_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[1];
57} PyTupleObject;
Guido van Rossum3f5da241990-12-20 15:06:42 +000058
Sjoerd Mullender107c7471995-04-25 11:53:24 +000059extern DL_IMPORT(PyTypeObject) PyTuple_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000060
Guido van Rossumcaa63801995-01-12 11:45:45 +000061#define PyTuple_Check(op) ((op)->ob_type == &PyTuple_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062
Guido van Rossumcaa63801995-01-12 11:45:45 +000063extern PyObject *PyTuple_New Py_PROTO((int size));
64extern int PyTuple_Size Py_PROTO((PyObject *));
65extern PyObject *PyTuple_GetItem Py_PROTO((PyObject *, int));
66extern int PyTuple_SetItem Py_PROTO((PyObject *, int, PyObject *));
67extern PyObject *PyTuple_GetSlice Py_PROTO((PyObject *, int, int));
Guido van Rossum93817821995-01-17 16:01:01 +000068extern int _PyTuple_Resize Py_PROTO((PyObject **, int, int));
Guido van Rossum3f5da241990-12-20 15:06:42 +000069
70/* Macro, trading safety for speed */
Guido van Rossum599de5a1995-03-09 12:10:16 +000071#define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i])
Barry Warsaw9c5494a1997-01-06 22:44:27 +000072#define PyTuple_GET_SIZE(op) (((PyTupleObject *)(op))->ob_size)
Guido van Rossum599de5a1995-03-09 12:10:16 +000073
74/* Macro, *only* to be used to fill in brand new tuples */
75#define PyTuple_SET_ITEM(op, i, v) (((PyTupleObject *)(op))->ob_item[i] = v)
Guido van Rossuma3309961993-07-28 09:05:47 +000076
77#ifdef __cplusplus
78}
79#endif
80#endif /* !Py_TUPLEOBJECT_H */