Include/tupleobject.h

   1 #ifndef Py_TUPLEOBJECT_H
   2 #define Py_TUPLEOBJECT_H
   3 #ifdef __cplusplus
   4 extern "C" {
   5 #endif
   6
   7 /***********************************************************
   8 Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
   9 The Netherlands.
  10
  11                         All Rights Reserved
  12
  13 Permission to use, copy, modify, and distribute this software and its
  14 documentation for any purpose and without fee is hereby granted,
  15 provided that the above copyright notice appear in all copies and that
  16 both that copyright notice and this permission notice appear in
  17 supporting documentation, and that the names of Stichting Mathematisch
  18 Centrum or CWI not be used in advertising or publicity pertaining to
  19 distribution of the software without specific, written prior permission.
  20
  21 STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
  22 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  23 FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
  24 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  25 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  26 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  27 OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  28
  29 ******************************************************************/
  30
  31 /* Tuple object interface */
  32
  33 /*
  34 123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
  35
  36 Another generally useful object type is an tuple of object pointers.
  37 This is a mutable type: the tuple items can be changed (but not their
  38 number).  Out-of-range indices or non-tuple objects are ignored.
  39
  40 *** WARNING *** PyTuple_SetItem does not increment the new item's reference
  41 count, but does decrement the reference count of the item it replaces,
  42 if not nil.  It does *decrement* the reference count if it is *not*
  43 inserted in the tuple.  Similarly, PyTuple_GetItem does not increment the
  44 returned item's reference count.
  45 */
  46
  47 typedef struct {
  48         PyObject_VAR_HEAD
  49         PyObject *ob_item[1];
  50 } PyTupleObject;
  51
  52 extern DL_IMPORT(PyTypeObject) PyTuple_Type;
  53
  54 #define PyTuple_Check(op) ((op)->ob_type == &PyTuple_Type)
  55
  56 extern PyObject *PyTuple_New Py_PROTO((int size));
  57 extern int PyTuple_Size Py_PROTO((PyObject *));
  58 extern PyObject *PyTuple_GetItem Py_PROTO((PyObject *, int));
  59 extern int PyTuple_SetItem Py_PROTO((PyObject *, int, PyObject *));
  60 extern PyObject *PyTuple_GetSlice Py_PROTO((PyObject *, int, int));
  61 extern int _PyTuple_Resize Py_PROTO((PyObject **, int, int));
  62
  63 /* Macro, trading safety for speed */
  64 #define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i])
  65
  66 /* Macro, *only* to be used to fill in brand new tuples */
  67 #define PyTuple_SET_ITEM(op, i, v) (((PyTupleObject *)(op))->ob_item[i] = v)
  68
  69 #ifdef __cplusplus
  70 }
  71 #endif
  72 #endif /* !Py_TUPLEOBJECT_H */