source: vendor/python/2.5/Include/tupleobject.h

Last change on this file was 3225, checked in by bird, 18 years ago

Python 2.5

File size: 2.0 KB
Line 
1
2/* Tuple object interface */
3
4#ifndef Py_TUPLEOBJECT_H
5#define Py_TUPLEOBJECT_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
10/*
11Another generally useful object type is a tuple of object pointers.
12For Python, this is an immutable type. C code can change the tuple items
13(but not their number), and even use tuples are general-purpose arrays of
14object references, but in general only brand new tuples should be mutated,
15not ones that might already have been exposed to Python code.
16
17*** WARNING *** PyTuple_SetItem does not increment the new item's reference
18count, but does decrement the reference count of the item it replaces,
19if not nil. It does *decrement* the reference count if it is *not*
20inserted in the tuple. Similarly, PyTuple_GetItem does not increment the
21returned item's reference count.
22*/
23
24typedef struct {
25 PyObject_VAR_HEAD
26 PyObject *ob_item[1];
27
28 /* ob_item contains space for 'ob_size' elements.
29 * Items must normally not be NULL, except during construction when
30 * the tuple is not yet visible outside the function that builds it.
31 */
32} PyTupleObject;
33
34PyAPI_DATA(PyTypeObject) PyTuple_Type;
35
36#define PyTuple_Check(op) PyObject_TypeCheck(op, &PyTuple_Type)
37#define PyTuple_CheckExact(op) ((op)->ob_type == &PyTuple_Type)
38
39PyAPI_FUNC(PyObject *) PyTuple_New(Py_ssize_t size);
40PyAPI_FUNC(Py_ssize_t) PyTuple_Size(PyObject *);
41PyAPI_FUNC(PyObject *) PyTuple_GetItem(PyObject *, Py_ssize_t);
42PyAPI_FUNC(int) PyTuple_SetItem(PyObject *, Py_ssize_t, PyObject *);
43PyAPI_FUNC(PyObject *) PyTuple_GetSlice(PyObject *, Py_ssize_t, Py_ssize_t);
44PyAPI_FUNC(int) _PyTuple_Resize(PyObject **, Py_ssize_t);
45PyAPI_FUNC(PyObject *) PyTuple_Pack(Py_ssize_t, ...);
46
47/* Macro, trading safety for speed */
48#define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i])
49#define PyTuple_GET_SIZE(op) (((PyTupleObject *)(op))->ob_size)
50
51/* Macro, *only* to be used to fill in brand new tuples */
52#define PyTuple_SET_ITEM(op, i, v) (((PyTupleObject *)(op))->ob_item[i] = v)
53
54#ifdef __cplusplus
55}
56#endif
57#endif /* !Py_TUPLEOBJECT_H */
Note: See TracBrowser for help on using the repository browser.