Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_OBJECT_H |
| 2 | #define Py_OBJECT_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 | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 8 | /* Object and type object interface */ |
| 9 | |
| 10 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 11 | Objects are structures allocated on the heap. Special rules apply to |
| 12 | the use of objects to ensure they are properly garbage-collected. |
| 13 | Objects are never allocated statically or on the stack; they must be |
| 14 | accessed through special macros and functions only. (Type objects are |
| 15 | exceptions to the first rule; the standard types are represented by |
| 16 | statically initialized type objects.) |
| 17 | |
| 18 | An object has a 'reference count' that is increased or decreased when a |
| 19 | pointer to the object is copied or deleted; when the reference count |
| 20 | reaches zero there are no references to the object left and it can be |
| 21 | removed from the heap. |
| 22 | |
| 23 | An object has a 'type' that determines what it represents and what kind |
| 24 | of data it contains. An object's type is fixed when it is created. |
| 25 | Types themselves are represented as objects; an object contains a |
| 26 | pointer to the corresponding type object. The type itself has a type |
| 27 | pointer pointing to the object representing the type 'type', which |
| 28 | contains a pointer to itself!). |
| 29 | |
| 30 | Objects do not float around in memory; once allocated an object keeps |
| 31 | the same size and address. Objects that must hold variable-size data |
| 32 | can contain pointers to variable-size parts of the object. Not all |
| 33 | objects of the same type have the same size; but the size cannot change |
| 34 | after allocation. (These restrictions are made so a reference to an |
| 35 | object can be simply a pointer -- moving an object would require |
| 36 | updating all the pointers, and changing an object's size would require |
| 37 | moving it if there was another object right next to it.) |
| 38 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 39 | Objects are always accessed through pointers of the type 'PyObject *'. |
| 40 | The type 'PyObject' is a structure that only contains the reference count |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 41 | and the type pointer. The actual memory allocated for an object |
| 42 | contains other data that can only be accessed after casting the pointer |
| 43 | to a pointer to a longer structure type. This longer type must start |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 44 | with the reference count and type fields; the macro PyObject_HEAD should be |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 45 | used for this (to accommodate for future changes). The implementation |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 46 | of a particular object type can cast the object pointer to the proper |
| 47 | type and back. |
| 48 | |
| 49 | A standard interface exists for objects that contain an array of items |
| 50 | whose size is determined when the object is allocated. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 51 | */ |
| 52 | |
Guido van Rossum | 408027e | 1996-12-30 16:17:54 +0000 | [diff] [blame] | 53 | #ifdef Py_DEBUG |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 54 | |
| 55 | /* Turn on heavy reference debugging */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 56 | #define Py_TRACE_REFS |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 57 | |
| 58 | /* Turn on reference counting */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 59 | #define Py_REF_DEBUG |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 60 | |
Guido van Rossum | 408027e | 1996-12-30 16:17:54 +0000 | [diff] [blame] | 61 | #endif /* Py_DEBUG */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 62 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 63 | #ifdef Py_TRACE_REFS |
| 64 | #define PyObject_HEAD \ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 65 | struct _object *_ob_next, *_ob_prev; \ |
Guido van Rossum | c8564cd | 1990-11-02 17:51:56 +0000 | [diff] [blame] | 66 | int ob_refcnt; \ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 67 | struct _typeobject *ob_type; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 68 | #define PyObject_HEAD_INIT(type) 0, 0, 1, type, |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 69 | #else /* !Py_TRACE_REFS */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 70 | #define PyObject_HEAD \ |
Guido van Rossum | 5799b52 | 1995-01-04 19:06:22 +0000 | [diff] [blame] | 71 | int ob_refcnt; \ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 72 | struct _typeobject *ob_type; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 73 | #define PyObject_HEAD_INIT(type) 1, type, |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 74 | #endif /* !Py_TRACE_REFS */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 75 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 76 | #define PyObject_VAR_HEAD \ |
| 77 | PyObject_HEAD \ |
Guido van Rossum | 5799b52 | 1995-01-04 19:06:22 +0000 | [diff] [blame] | 78 | int ob_size; /* Number of items in variable part */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 79 | |
| 80 | typedef struct _object { |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 81 | PyObject_HEAD |
| 82 | } PyObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 83 | |
| 84 | typedef struct { |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 85 | PyObject_VAR_HEAD |
Guido van Rossum | d0c87ee | 1997-05-15 21:31:03 +0000 | [diff] [blame] | 86 | } PyVarObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 87 | |
| 88 | |
| 89 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 90 | Type objects contain a string containing the type name (to help somewhat |
| 91 | in debugging), the allocation parameters (see newobj() and newvarobj()), |
| 92 | and methods for accessing objects of the type. Methods are optional,a |
| 93 | nil pointer meaning that particular kind of access is not available for |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 94 | this type. The Py_DECREF() macro uses the tp_dealloc method without |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 95 | checking for a nil pointer; it should always be implemented except if |
| 96 | the implementation can guarantee that the reference count will never |
| 97 | reach zero (e.g., for type objects). |
| 98 | |
| 99 | NB: the methods for certain type groups are now contained in separate |
| 100 | method blocks. |
| 101 | */ |
| 102 | |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 103 | typedef PyObject * (*unaryfunc)(PyObject *); |
| 104 | typedef PyObject * (*binaryfunc)(PyObject *, PyObject *); |
| 105 | typedef PyObject * (*ternaryfunc)(PyObject *, PyObject *, PyObject *); |
| 106 | typedef int (*inquiry)(PyObject *); |
| 107 | typedef int (*coercion)(PyObject **, PyObject **); |
| 108 | typedef PyObject *(*intargfunc)(PyObject *, int); |
| 109 | typedef PyObject *(*intintargfunc)(PyObject *, int, int); |
| 110 | typedef int(*intobjargproc)(PyObject *, int, PyObject *); |
| 111 | typedef int(*intintobjargproc)(PyObject *, int, int, PyObject *); |
| 112 | typedef int(*objobjargproc)(PyObject *, PyObject *, PyObject *); |
| 113 | typedef int (*getreadbufferproc)(PyObject *, int, void **); |
| 114 | typedef int (*getwritebufferproc)(PyObject *, int, void **); |
| 115 | typedef int (*getsegcountproc)(PyObject *, int *); |
| 116 | typedef int (*getcharbufferproc)(PyObject *, int, const char **); |
| 117 | typedef int (*objobjproc)(PyObject *, PyObject *); |
| 118 | typedef int (*visitproc)(PyObject *, void *); |
| 119 | typedef int (*traverseproc)(PyObject *, visitproc, void *); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 120 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 121 | typedef struct { |
Neil Schemenauer | a7ed694 | 2001-01-04 01:31:50 +0000 | [diff] [blame] | 122 | /* For old style numbers all arguments are guaranteed to be of the |
| 123 | object's type (modulo coercion hacks that is); new style numbers |
| 124 | should check both arguments for proper type and implement the |
| 125 | necessary conversions in the slots themselves. */ |
| 126 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 127 | binaryfunc nb_add; |
| 128 | binaryfunc nb_subtract; |
| 129 | binaryfunc nb_multiply; |
| 130 | binaryfunc nb_divide; |
| 131 | binaryfunc nb_remainder; |
| 132 | binaryfunc nb_divmod; |
Guido van Rossum | 75abc63 | 1994-08-09 13:21:54 +0000 | [diff] [blame] | 133 | ternaryfunc nb_power; |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 134 | unaryfunc nb_negative; |
| 135 | unaryfunc nb_positive; |
| 136 | unaryfunc nb_absolute; |
| 137 | inquiry nb_nonzero; |
| 138 | unaryfunc nb_invert; |
| 139 | binaryfunc nb_lshift; |
| 140 | binaryfunc nb_rshift; |
| 141 | binaryfunc nb_and; |
| 142 | binaryfunc nb_xor; |
| 143 | binaryfunc nb_or; |
| 144 | coercion nb_coerce; |
| 145 | unaryfunc nb_int; |
| 146 | unaryfunc nb_long; |
| 147 | unaryfunc nb_float; |
| 148 | unaryfunc nb_oct; |
| 149 | unaryfunc nb_hex; |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 150 | binaryfunc nb_inplace_add; |
| 151 | binaryfunc nb_inplace_subtract; |
| 152 | binaryfunc nb_inplace_multiply; |
| 153 | binaryfunc nb_inplace_divide; |
| 154 | binaryfunc nb_inplace_remainder; |
| 155 | ternaryfunc nb_inplace_power; |
| 156 | binaryfunc nb_inplace_lshift; |
| 157 | binaryfunc nb_inplace_rshift; |
| 158 | binaryfunc nb_inplace_and; |
| 159 | binaryfunc nb_inplace_xor; |
| 160 | binaryfunc nb_inplace_or; |
Neil Schemenauer | a7ed694 | 2001-01-04 01:31:50 +0000 | [diff] [blame] | 161 | |
| 162 | /* New style number slots; these are only used the |
| 163 | Py_TPFLAGS_NEWSTYLENUMBER flag is set */ |
| 164 | |
| 165 | binaryfunc nb_cmp; /* XXX this should be richcmpfunc */ |
| 166 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 167 | } PyNumberMethods; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 168 | |
| 169 | typedef struct { |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 170 | inquiry sq_length; |
| 171 | binaryfunc sq_concat; |
| 172 | intargfunc sq_repeat; |
| 173 | intargfunc sq_item; |
| 174 | intintargfunc sq_slice; |
| 175 | intobjargproc sq_ass_item; |
| 176 | intintobjargproc sq_ass_slice; |
Guido van Rossum | cecb27a | 2000-02-28 15:00:40 +0000 | [diff] [blame] | 177 | objobjproc sq_contains; |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 178 | binaryfunc sq_inplace_concat; |
| 179 | intargfunc sq_inplace_repeat; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 180 | } PySequenceMethods; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 181 | |
| 182 | typedef struct { |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 183 | inquiry mp_length; |
| 184 | binaryfunc mp_subscript; |
| 185 | objobjargproc mp_ass_subscript; |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 186 | } PyMappingMethods; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 187 | |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 188 | typedef struct { |
| 189 | getreadbufferproc bf_getreadbuffer; |
| 190 | getwritebufferproc bf_getwritebuffer; |
| 191 | getsegcountproc bf_getsegcount; |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 192 | getcharbufferproc bf_getcharbuffer; |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 193 | } PyBufferProcs; |
| 194 | |
| 195 | |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 196 | typedef void (*destructor)(PyObject *); |
| 197 | typedef int (*printfunc)(PyObject *, FILE *, int); |
| 198 | typedef PyObject *(*getattrfunc)(PyObject *, char *); |
| 199 | typedef PyObject *(*getattrofunc)(PyObject *, PyObject *); |
| 200 | typedef int (*setattrfunc)(PyObject *, char *, PyObject *); |
| 201 | typedef int (*setattrofunc)(PyObject *, PyObject *, PyObject *); |
| 202 | typedef int (*cmpfunc)(PyObject *, PyObject *); |
| 203 | typedef PyObject *(*reprfunc)(PyObject *); |
| 204 | typedef long (*hashfunc)(PyObject *); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 205 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 206 | typedef struct _typeobject { |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 207 | PyObject_VAR_HEAD |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 208 | char *tp_name; /* For printing */ |
Guido van Rossum | 5799b52 | 1995-01-04 19:06:22 +0000 | [diff] [blame] | 209 | int tp_basicsize, tp_itemsize; /* For allocation */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 210 | |
| 211 | /* Methods to implement standard operations */ |
| 212 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 213 | destructor tp_dealloc; |
| 214 | printfunc tp_print; |
| 215 | getattrfunc tp_getattr; |
| 216 | setattrfunc tp_setattr; |
| 217 | cmpfunc tp_compare; |
| 218 | reprfunc tp_repr; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 219 | |
| 220 | /* Method suites for standard classes */ |
| 221 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 222 | PyNumberMethods *tp_as_number; |
| 223 | PySequenceMethods *tp_as_sequence; |
| 224 | PyMappingMethods *tp_as_mapping; |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 225 | |
Fred Drake | 0e12bcd | 2000-03-21 16:14:47 +0000 | [diff] [blame] | 226 | /* More standard operations (here for binary compatibility) */ |
Guido van Rossum | 9bfef44 | 1993-03-29 10:43:31 +0000 | [diff] [blame] | 227 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 228 | hashfunc tp_hash; |
Guido van Rossum | 884afd6 | 1995-07-18 14:21:06 +0000 | [diff] [blame] | 229 | ternaryfunc tp_call; |
Guido van Rossum | 6fde390 | 1995-01-07 10:32:04 +0000 | [diff] [blame] | 230 | reprfunc tp_str; |
Guido van Rossum | 0693dd2 | 1996-08-09 20:48:52 +0000 | [diff] [blame] | 231 | getattrofunc tp_getattro; |
| 232 | setattrofunc tp_setattro; |
Guido van Rossum | 6fde390 | 1995-01-07 10:32:04 +0000 | [diff] [blame] | 233 | |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 234 | /* Functions to access object as input/output buffer */ |
| 235 | PyBufferProcs *tp_as_buffer; |
| 236 | |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 237 | /* Flags to define presence of optional/expanded features */ |
| 238 | long tp_flags; |
Guido van Rossum | 6fde390 | 1995-01-07 10:32:04 +0000 | [diff] [blame] | 239 | |
| 240 | char *tp_doc; /* Documentation string */ |
| 241 | |
Jeremy Hylton | 8caad49 | 2000-06-23 14:18:11 +0000 | [diff] [blame] | 242 | /* call function for all accessible objects */ |
| 243 | traverseproc tp_traverse; |
| 244 | |
| 245 | /* delete references to contained objects */ |
| 246 | inquiry tp_clear; |
| 247 | |
Guido van Rossum | a9c2d7a | 1998-04-23 19:16:44 +0000 | [diff] [blame] | 248 | /* More spares */ |
Guido van Rossum | a9c2d7a | 1998-04-23 19:16:44 +0000 | [diff] [blame] | 249 | long tp_xxx7; |
| 250 | long tp_xxx8; |
| 251 | |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 252 | #ifdef COUNT_ALLOCS |
| 253 | /* these must be last */ |
| 254 | int tp_alloc; |
| 255 | int tp_free; |
| 256 | int tp_maxalloc; |
| 257 | struct _typeobject *tp_next; |
| 258 | #endif |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 259 | } PyTypeObject; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 260 | |
Sjoerd Mullender | 107c747 | 1995-04-25 11:53:24 +0000 | [diff] [blame] | 261 | extern DL_IMPORT(PyTypeObject) PyType_Type; /* The type of type objects */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 262 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 263 | #define PyType_Check(op) ((op)->ob_type == &PyType_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 264 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 265 | /* Generic operations on objects */ |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 266 | extern DL_IMPORT(int) PyObject_Print(PyObject *, FILE *, int); |
| 267 | extern DL_IMPORT(PyObject *) PyObject_Repr(PyObject *); |
| 268 | extern DL_IMPORT(PyObject *) PyObject_Str(PyObject *); |
| 269 | extern DL_IMPORT(int) PyObject_Compare(PyObject *, PyObject *); |
| 270 | extern DL_IMPORT(PyObject *) PyObject_GetAttrString(PyObject *, char *); |
| 271 | extern DL_IMPORT(int) PyObject_SetAttrString(PyObject *, char *, PyObject *); |
| 272 | extern DL_IMPORT(int) PyObject_HasAttrString(PyObject *, char *); |
| 273 | extern DL_IMPORT(PyObject *) PyObject_GetAttr(PyObject *, PyObject *); |
| 274 | extern DL_IMPORT(int) PyObject_SetAttr(PyObject *, PyObject *, PyObject *); |
| 275 | extern DL_IMPORT(int) PyObject_HasAttr(PyObject *, PyObject *); |
| 276 | extern DL_IMPORT(long) PyObject_Hash(PyObject *); |
| 277 | extern DL_IMPORT(int) PyObject_IsTrue(PyObject *); |
| 278 | extern DL_IMPORT(int) PyObject_Not(PyObject *); |
| 279 | extern DL_IMPORT(int) PyCallable_Check(PyObject *); |
| 280 | extern DL_IMPORT(int) PyNumber_Coerce(PyObject **, PyObject **); |
| 281 | extern DL_IMPORT(int) PyNumber_CoerceEx(PyObject **, PyObject **); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 282 | |
Guido van Rossum | 26d4ac3 | 1998-04-10 22:32:24 +0000 | [diff] [blame] | 283 | /* Helpers for printing recursive container types */ |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 284 | extern DL_IMPORT(int) Py_ReprEnter(PyObject *); |
| 285 | extern DL_IMPORT(void) Py_ReprLeave(PyObject *); |
Guido van Rossum | 26d4ac3 | 1998-04-10 22:32:24 +0000 | [diff] [blame] | 286 | |
Jeremy Hylton | 4a3dd2d | 2000-04-14 19:13:24 +0000 | [diff] [blame] | 287 | /* tstate dict key for PyObject_Compare helper */ |
| 288 | extern PyObject *_PyCompareState_Key; |
| 289 | |
Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 290 | /* Helpers for hash functions */ |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 291 | extern DL_IMPORT(long) _Py_HashDouble(double); |
| 292 | extern DL_IMPORT(long) _Py_HashPointer(void*); |
Fred Drake | 13634cf | 2000-06-29 19:17:04 +0000 | [diff] [blame] | 293 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 294 | /* Flag bits for printing: */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 295 | #define Py_PRINT_RAW 1 /* No string quotes etc. */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 296 | |
| 297 | /* |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 298 | |
| 299 | Type flags (tp_flags) |
| 300 | |
| 301 | These flags are used to extend the type structure in a backwards-compatible |
| 302 | fashion. Extensions can use the flags to indicate (and test) when a given |
| 303 | type structure contains a new feature. The Python core will use these when |
| 304 | introducing new functionality between major revisions (to avoid mid-version |
| 305 | changes in the PYTHON_API_VERSION). |
| 306 | |
| 307 | Arbitration of the flag bit positions will need to be coordinated among |
| 308 | all extension writers who publically release their extensions (this will |
| 309 | be fewer than you might expect!).. |
| 310 | |
| 311 | Python 1.5.2 introduced the bf_getcharbuffer slot into PyBufferProcs. |
| 312 | |
| 313 | Type definitions should use Py_TPFLAGS_DEFAULT for their tp_flags value. |
| 314 | |
| 315 | Code can use PyType_HasFeature(type_ob, flag_value) to test whether the |
| 316 | given type object has a specified feature. |
| 317 | |
| 318 | */ |
| 319 | |
| 320 | /* PyBufferProcs contains bf_getcharbuffer */ |
| 321 | #define Py_TPFLAGS_HAVE_GETCHARBUFFER (1L<<0) |
| 322 | |
Guido van Rossum | cecb27a | 2000-02-28 15:00:40 +0000 | [diff] [blame] | 323 | /* PySequenceMethods contains sq_contains */ |
| 324 | #define Py_TPFLAGS_HAVE_SEQUENCE_IN (1L<<1) |
| 325 | |
Jeremy Hylton | d08b4c4 | 2000-06-23 19:37:02 +0000 | [diff] [blame] | 326 | /* Objects which participate in garbage collection (see objimp.h) */ |
| 327 | #ifdef WITH_CYCLE_GC |
| 328 | #define Py_TPFLAGS_GC (1L<<2) |
| 329 | #else |
| 330 | #define Py_TPFLAGS_GC 0 |
| 331 | #endif |
| 332 | |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 333 | /* PySequenceMethods and PyNumberMethods contain in-place operators */ |
| 334 | #define Py_TPFLAGS_HAVE_INPLACEOPS (1L<<3) |
| 335 | |
Neil Schemenauer | a7ed694 | 2001-01-04 01:31:50 +0000 | [diff] [blame] | 336 | /* PyNumberMethods do their own coercion */ |
| 337 | #define Py_TPFLAGS_NEWSTYLENUMBER (1L<<4) |
| 338 | |
Guido van Rossum | cecb27a | 2000-02-28 15:00:40 +0000 | [diff] [blame] | 339 | #define Py_TPFLAGS_DEFAULT (Py_TPFLAGS_HAVE_GETCHARBUFFER | \ |
Thomas Wouters | dd8dbdb | 2000-08-24 20:09:45 +0000 | [diff] [blame] | 340 | Py_TPFLAGS_HAVE_SEQUENCE_IN | \ |
| 341 | Py_TPFLAGS_HAVE_INPLACEOPS) |
Guido van Rossum | 36eef3c | 1998-10-08 02:10:56 +0000 | [diff] [blame] | 342 | |
| 343 | #define PyType_HasFeature(t,f) (((t)->tp_flags & (f)) != 0) |
| 344 | |
| 345 | |
| 346 | /* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 347 | The macros Py_INCREF(op) and Py_DECREF(op) are used to increment or decrement |
| 348 | reference counts. Py_DECREF calls the object's deallocator function; for |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 349 | objects that don't contain references to other objects or heap memory |
| 350 | this can be the standard function free(). Both macros can be used |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 351 | wherever a void expression is allowed. The argument shouldn't be a |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 352 | NIL pointer. The macro _Py_NewReference(op) is used only to initialize |
| 353 | reference counts to 1; it is defined here for convenience. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 354 | |
| 355 | We assume that the reference count field can never overflow; this can |
| 356 | be proven when the size of the field is the same as the pointer size |
| 357 | but even with a 16-bit reference count field it is pretty unlikely so |
| 358 | we ignore the possibility. (If you are paranoid, make it a long.) |
| 359 | |
| 360 | Type objects should never be deallocated; the type pointer in an object |
| 361 | is not considered to be a reference to the type object, to save |
| 362 | complications in the deallocation function. (This is actually a |
| 363 | decision that's up to the implementer of each new type so if you want, |
| 364 | you can count such references to the type object.) |
| 365 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 366 | *** WARNING*** The Py_DECREF macro must have a side-effect-free argument |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 367 | since it may evaluate its argument multiple times. (The alternative |
| 368 | would be to mace it a proper function or assign it to a global temporary |
| 369 | variable first, both of which are slower; and in a multi-threaded |
| 370 | environment the global variable trick is not safe.) |
| 371 | */ |
| 372 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 373 | #ifdef Py_TRACE_REFS |
| 374 | #ifndef Py_REF_DEBUG |
| 375 | #define Py_REF_DEBUG |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 376 | #endif |
| 377 | #endif |
| 378 | |
Guido van Rossum | d86b380 | 1996-08-12 21:31:32 +0000 | [diff] [blame] | 379 | #ifdef Py_TRACE_REFS |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 380 | extern DL_IMPORT(void) _Py_Dealloc(PyObject *); |
| 381 | extern DL_IMPORT(void) _Py_NewReference(PyObject *); |
| 382 | extern DL_IMPORT(void) _Py_ForgetReference(PyObject *); |
| 383 | extern DL_IMPORT(void) _Py_PrintReferences(FILE *); |
| 384 | extern DL_IMPORT(void) _Py_ResetReferences(void); |
Guido van Rossum | d86b380 | 1996-08-12 21:31:32 +0000 | [diff] [blame] | 385 | #endif |
| 386 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 387 | #ifndef Py_TRACE_REFS |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 388 | #ifdef COUNT_ALLOCS |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 389 | #define _Py_Dealloc(op) ((op)->ob_type->tp_free++, (*(op)->ob_type->tp_dealloc)((PyObject *)(op))) |
Sjoerd Mullender | 91e7a0b | 1995-04-06 13:47:48 +0000 | [diff] [blame] | 390 | #define _Py_ForgetReference(op) ((op)->ob_type->tp_free++) |
Guido van Rossum | d86b380 | 1996-08-12 21:31:32 +0000 | [diff] [blame] | 391 | #else /* !COUNT_ALLOCS */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 392 | #define _Py_Dealloc(op) (*(op)->ob_type->tp_dealloc)((PyObject *)(op)) |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 393 | #define _Py_ForgetReference(op) /*empty*/ |
Guido van Rossum | d86b380 | 1996-08-12 21:31:32 +0000 | [diff] [blame] | 394 | #endif /* !COUNT_ALLOCS */ |
| 395 | #endif /* !Py_TRACE_REFS */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 396 | |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 397 | #ifdef COUNT_ALLOCS |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 398 | extern DL_IMPORT(void) inc_count(PyTypeObject *); |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 399 | #endif |
| 400 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 401 | #ifdef Py_REF_DEBUG |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 402 | |
Guido van Rossum | 43466ec | 1998-12-04 18:48:25 +0000 | [diff] [blame] | 403 | extern DL_IMPORT(long) _Py_RefTotal; |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 404 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 405 | #ifndef Py_TRACE_REFS |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 406 | #ifdef COUNT_ALLOCS |
Guido van Rossum | 6f9e433 | 1995-03-29 16:57:48 +0000 | [diff] [blame] | 407 | #define _Py_NewReference(op) (inc_count((op)->ob_type), _Py_RefTotal++, (op)->ob_refcnt = 1) |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 408 | #else |
Guido van Rossum | 6f9e433 | 1995-03-29 16:57:48 +0000 | [diff] [blame] | 409 | #define _Py_NewReference(op) (_Py_RefTotal++, (op)->ob_refcnt = 1) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 410 | #endif |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 411 | #endif /* !Py_TRACE_REFS */ |
| 412 | |
Guido van Rossum | 6f9e433 | 1995-03-29 16:57:48 +0000 | [diff] [blame] | 413 | #define Py_INCREF(op) (_Py_RefTotal++, (op)->ob_refcnt++) |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 414 | #define Py_DECREF(op) \ |
Guido van Rossum | 6f9e433 | 1995-03-29 16:57:48 +0000 | [diff] [blame] | 415 | if (--_Py_RefTotal, --(op)->ob_refcnt != 0) \ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 416 | ; \ |
| 417 | else \ |
Guido van Rossum | 1d529d1 | 1997-08-05 02:30:44 +0000 | [diff] [blame] | 418 | _Py_Dealloc((PyObject *)(op)) |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 419 | #else /* !Py_REF_DEBUG */ |
| 420 | |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 421 | #ifdef COUNT_ALLOCS |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 422 | #define _Py_NewReference(op) (inc_count((op)->ob_type), (op)->ob_refcnt = 1) |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 423 | #else |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 424 | #define _Py_NewReference(op) ((op)->ob_refcnt = 1) |
Sjoerd Mullender | a9c3c22 | 1993-10-11 12:54:31 +0000 | [diff] [blame] | 425 | #endif |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 426 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 427 | #define Py_INCREF(op) ((op)->ob_refcnt++) |
| 428 | #define Py_DECREF(op) \ |
Guido van Rossum | 5799b52 | 1995-01-04 19:06:22 +0000 | [diff] [blame] | 429 | if (--(op)->ob_refcnt != 0) \ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 430 | ; \ |
| 431 | else \ |
Guido van Rossum | 1d529d1 | 1997-08-05 02:30:44 +0000 | [diff] [blame] | 432 | _Py_Dealloc((PyObject *)(op)) |
Guido van Rossum | 60be1db | 1996-05-22 16:33:22 +0000 | [diff] [blame] | 433 | #endif /* !Py_REF_DEBUG */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 434 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 435 | /* Macros to use in case the object pointer may be NULL: */ |
| 436 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 437 | #define Py_XINCREF(op) if ((op) == NULL) ; else Py_INCREF(op) |
| 438 | #define Py_XDECREF(op) if ((op) == NULL) ; else Py_DECREF(op) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 439 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 440 | /* |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 441 | _Py_NoneStruct is an object of undefined type which can be used in contexts |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 442 | where NULL (nil) is not suitable (since NULL often means 'error'). |
| 443 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 444 | Don't forget to apply Py_INCREF() when returning this value!!! |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 445 | */ |
| 446 | |
Sjoerd Mullender | 107c747 | 1995-04-25 11:53:24 +0000 | [diff] [blame] | 447 | extern DL_IMPORT(PyObject) _Py_NoneStruct; /* Don't use this directly */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 448 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 449 | #define Py_None (&_Py_NoneStruct) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 450 | |
Neil Schemenauer | a7ed694 | 2001-01-04 01:31:50 +0000 | [diff] [blame] | 451 | /* |
| 452 | Py_NotImplemented is a singleton used to signal that an operation is |
| 453 | not implemented for a given type combination. |
| 454 | */ |
| 455 | |
| 456 | extern DL_IMPORT(PyObject) _Py_NotImplementedStruct; /* Don't use this directly */ |
| 457 | |
| 458 | #define Py_NotImplemented (&_Py_NotImplementedStruct) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 459 | |
| 460 | /* |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 461 | A common programming style in Python requires the forward declaration |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 462 | of static, initialized structures, e.g. for a type object that is used |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 463 | by the functions whose address must be used in the initializer. |
| 464 | Some compilers (notably SCO ODT 3.0, I seem to remember early AIX as |
| 465 | well) botch this if you use the static keyword for both declarations |
| 466 | (they allocate two objects, and use the first, uninitialized one until |
| 467 | the second declaration is encountered). Therefore, the forward |
| 468 | declaration should use the 'forwardstatic' keyword. This expands to |
| 469 | static on most systems, but to extern on a few. The actual storage |
| 470 | and name will still be static because the second declaration is |
| 471 | static, so no linker visible symbols will be generated. (Standard C |
| 472 | compilers take offense to the extern forward declaration of a static |
| 473 | object, so I can't just put extern in all cases. :-( ) |
| 474 | */ |
| 475 | |
| 476 | #ifdef BAD_STATIC_FORWARD |
| 477 | #define staticforward extern |
Guido van Rossum | 57836fe | 1995-02-21 21:06:10 +0000 | [diff] [blame] | 478 | #define statichere static |
Guido van Rossum | 57836fe | 1995-02-21 21:06:10 +0000 | [diff] [blame] | 479 | #else /* !BAD_STATIC_FORWARD */ |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 480 | #define staticforward static |
Guido van Rossum | 57836fe | 1995-02-21 21:06:10 +0000 | [diff] [blame] | 481 | #define statichere static |
| 482 | #endif /* !BAD_STATIC_FORWARD */ |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 483 | |
| 484 | |
| 485 | /* |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 486 | More conventions |
| 487 | ================ |
| 488 | |
| 489 | Argument Checking |
| 490 | ----------------- |
| 491 | |
| 492 | Functions that take objects as arguments normally don't check for nil |
| 493 | arguments, but they do check the type of the argument, and return an |
| 494 | error if the function doesn't apply to the type. |
| 495 | |
| 496 | Failure Modes |
| 497 | ------------- |
| 498 | |
| 499 | Functions may fail for a variety of reasons, including running out of |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 500 | memory. This is communicated to the caller in two ways: an error string |
| 501 | is set (see errors.h), and the function result differs: functions that |
| 502 | normally return a pointer return NULL for failure, functions returning |
| 503 | an integer return -1 (which could be a legal return value too!), and |
| 504 | other functions return 0 for success and -1 for failure. |
| 505 | Callers should always check for errors before using the result. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 506 | |
| 507 | Reference Counts |
| 508 | ---------------- |
| 509 | |
| 510 | It takes a while to get used to the proper usage of reference counts. |
| 511 | |
| 512 | Functions that create an object set the reference count to 1; such new |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 513 | objects must be stored somewhere or destroyed again with Py_DECREF(). |
| 514 | Functions that 'store' objects such as PyTuple_SetItem() and |
| 515 | PyDict_SetItemString() |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 516 | don't increment the reference count of the object, since the most |
| 517 | frequent use is to store a fresh object. Functions that 'retrieve' |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 518 | objects such as PyTuple_GetItem() and PyDict_GetItemString() also |
| 519 | don't increment |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 520 | the reference count, since most frequently the object is only looked at |
| 521 | quickly. Thus, to retrieve an object and store it again, the caller |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 522 | must call Py_INCREF() explicitly. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 523 | |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 524 | NOTE: functions that 'consume' a reference count like |
Fred Drake | 49bb0e3 | 1997-09-05 17:53:53 +0000 | [diff] [blame] | 525 | PyList_SetItemString() even consume the reference if the object wasn't |
| 526 | stored, to simplify error handling. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 527 | |
| 528 | It seems attractive to make other functions that take an object as |
| 529 | argument consume a reference count; however this may quickly get |
| 530 | confusing (even the current practice is already confusing). Consider |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 531 | it carefully, it may save lots of calls to Py_INCREF() and Py_DECREF() at |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 532 | times. |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 533 | */ |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 534 | |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 535 | /* |
| 536 | trashcan |
| 537 | CT 2k0130 |
| 538 | non-recursively destroy nested objects |
| 539 | |
| 540 | CT 2k0223 |
| 541 | redefinition for better locality and less overhead. |
| 542 | |
| 543 | Objects that want to be recursion safe need to use |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 544 | the macro's |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 545 | Py_TRASHCAN_SAFE_BEGIN(name) |
| 546 | and |
| 547 | Py_TRASHCAN_SAFE_END(name) |
| 548 | surrounding their actual deallocation code. |
| 549 | |
| 550 | It would be nice to do this using the thread state. |
| 551 | Also, we could do an exact stack measure then. |
| 552 | Unfortunately, deallocations also take place when |
| 553 | the thread state is undefined. |
Guido van Rossum | e92e610 | 2000-04-24 15:40:53 +0000 | [diff] [blame] | 554 | |
| 555 | CT 2k0422 complete rewrite. |
| 556 | There is no need to allocate new objects. |
| 557 | Everything is done vialob_refcnt and ob_type now. |
| 558 | Adding support for free-threading should be easy, too. |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 559 | */ |
| 560 | |
| 561 | #define PyTrash_UNWIND_LEVEL 50 |
| 562 | |
| 563 | #define Py_TRASHCAN_SAFE_BEGIN(op) \ |
| 564 | { \ |
| 565 | ++_PyTrash_delete_nesting; \ |
| 566 | if (_PyTrash_delete_nesting < PyTrash_UNWIND_LEVEL) { \ |
| 567 | |
| 568 | #define Py_TRASHCAN_SAFE_END(op) \ |
| 569 | ;} \ |
| 570 | else \ |
| 571 | _PyTrash_deposit_object((PyObject*)op);\ |
| 572 | --_PyTrash_delete_nesting; \ |
| 573 | if (_PyTrash_delete_later && _PyTrash_delete_nesting <= 0) \ |
Guido van Rossum | e92e610 | 2000-04-24 15:40:53 +0000 | [diff] [blame] | 574 | _PyTrash_destroy_chain(); \ |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 575 | } \ |
| 576 | |
Tim Peters | 9ace6bc | 2000-07-08 00:32:04 +0000 | [diff] [blame] | 577 | extern DL_IMPORT(void) _PyTrash_deposit_object(PyObject*); |
Greg Stein | a90b23c | 2000-07-08 00:46:19 +0000 | [diff] [blame] | 578 | extern DL_IMPORT(void) _PyTrash_destroy_chain(void); |
Guido van Rossum | d724b23 | 2000-03-13 16:01:29 +0000 | [diff] [blame] | 579 | |
| 580 | extern DL_IMPORT(int) _PyTrash_delete_nesting; |
| 581 | extern DL_IMPORT(PyObject *) _PyTrash_delete_later; |
| 582 | |
| 583 | /* swap the "xx" to check the speed loss */ |
| 584 | |
| 585 | #define xxPy_TRASHCAN_SAFE_BEGIN(op) |
| 586 | #define xxPy_TRASHCAN_SAFE_END(op) ; |
Guido van Rossum | e92e610 | 2000-04-24 15:40:53 +0000 | [diff] [blame] | 587 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 588 | #ifdef __cplusplus |
| 589 | } |
| 590 | #endif |
| 591 | #endif /* !Py_OBJECT_H */ |