blob: a12e7df84f4b6fc5cba1a7c8ea23271491428b96 [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Type object implementation */
2
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003#include "Python.h"
Tim Peters6d6c1a32001-08-02 04:15:00 +00004#include "structmember.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Guido van Rossum9923ffe2002-06-04 19:52:53 +00006#include <ctype.h>
7
8/* The *real* layout of a type object when allocated on the heap */
9/* XXX Should we publish this in a header file? */
10typedef struct {
Guido van Rossum09638c12002-06-13 19:17:46 +000011 /* Note: there's a dependency on the order of these members
12 in slotptr() below. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +000013 PyTypeObject type;
14 PyNumberMethods as_number;
Guido van Rossum9923ffe2002-06-04 19:52:53 +000015 PyMappingMethods as_mapping;
Guido van Rossum09638c12002-06-13 19:17:46 +000016 PySequenceMethods as_sequence; /* as_sequence comes after as_mapping,
17 so that the mapping wins when both
18 the mapping and the sequence define
19 a given operator (e.g. __getitem__).
20 see add_operators() below. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +000021 PyBufferProcs as_buffer;
22 PyObject *name, *slots;
23 PyMemberDef members[1];
24} etype;
25
Guido van Rossum6f799372001-09-20 20:46:19 +000026static PyMemberDef type_members[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +000027 {"__basicsize__", T_INT, offsetof(PyTypeObject,tp_basicsize),READONLY},
28 {"__itemsize__", T_INT, offsetof(PyTypeObject, tp_itemsize), READONLY},
29 {"__flags__", T_LONG, offsetof(PyTypeObject, tp_flags), READONLY},
Guido van Rossum9676b222001-08-17 20:32:36 +000030 {"__weakrefoffset__", T_LONG,
Tim Peters6d6c1a32001-08-02 04:15:00 +000031 offsetof(PyTypeObject, tp_weaklistoffset), READONLY},
32 {"__base__", T_OBJECT, offsetof(PyTypeObject, tp_base), READONLY},
33 {"__dictoffset__", T_LONG,
34 offsetof(PyTypeObject, tp_dictoffset), READONLY},
35 {"__bases__", T_OBJECT, offsetof(PyTypeObject, tp_bases), READONLY},
36 {"__mro__", T_OBJECT, offsetof(PyTypeObject, tp_mro), READONLY},
37 {0}
38};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000039
Guido van Rossumc0b618a1997-05-02 03:12:38 +000040static PyObject *
Guido van Rossumc3542212001-08-16 09:18:56 +000041type_name(PyTypeObject *type, void *context)
42{
43 char *s;
44
45 s = strrchr(type->tp_name, '.');
46 if (s == NULL)
47 s = type->tp_name;
48 else
49 s++;
50 return PyString_FromString(s);
51}
52
53static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000054type_module(PyTypeObject *type, void *context)
Guido van Rossum29ca26e1995-01-07 11:58:15 +000055{
Guido van Rossumc3542212001-08-16 09:18:56 +000056 PyObject *mod;
57 char *s;
58
59 s = strrchr(type->tp_name, '.');
60 if (s != NULL)
61 return PyString_FromStringAndSize(type->tp_name,
62 (int)(s - type->tp_name));
63 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE))
64 return PyString_FromString("__builtin__");
Guido van Rossum687ae002001-10-15 22:03:32 +000065 mod = PyDict_GetItemString(type->tp_dict, "__module__");
Guido van Rossumc3542212001-08-16 09:18:56 +000066 if (mod != NULL && PyString_Check(mod)) {
67 Py_INCREF(mod);
68 return mod;
69 }
70 PyErr_SetString(PyExc_AttributeError, "__module__");
71 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +000072}
73
Guido van Rossum3926a632001-09-25 16:25:58 +000074static int
75type_set_module(PyTypeObject *type, PyObject *value, void *context)
76{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +000077 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
Guido van Rossum3926a632001-09-25 16:25:58 +000078 strrchr(type->tp_name, '.')) {
79 PyErr_Format(PyExc_TypeError,
80 "can't set %s.__module__", type->tp_name);
81 return -1;
82 }
83 if (!value) {
84 PyErr_Format(PyExc_TypeError,
85 "can't delete %s.__module__", type->tp_name);
86 return -1;
87 }
88 return PyDict_SetItemString(type->tp_dict, "__module__", value);
89}
90
Tim Peters6d6c1a32001-08-02 04:15:00 +000091static PyObject *
92type_dict(PyTypeObject *type, void *context)
93{
94 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000095 Py_INCREF(Py_None);
96 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +000097 }
Tim Peters6d6c1a32001-08-02 04:15:00 +000098 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +000099}
100
Tim Peters24008312002-03-17 18:56:20 +0000101static PyObject *
102type_get_doc(PyTypeObject *type, void *context)
103{
104 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000105 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Tim Peters24008312002-03-17 18:56:20 +0000106 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000107 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000108 if (result == NULL) {
109 result = Py_None;
110 Py_INCREF(result);
111 }
112 else if (result->ob_type->tp_descr_get) {
Tim Peters2b858972002-04-18 04:12:28 +0000113 result = result->ob_type->tp_descr_get(result, NULL,
114 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000115 }
116 else {
117 Py_INCREF(result);
118 }
Tim Peters24008312002-03-17 18:56:20 +0000119 return result;
120}
121
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000122static PyGetSetDef type_getsets[] = {
Guido van Rossumc3542212001-08-16 09:18:56 +0000123 {"__name__", (getter)type_name, NULL, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000124 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000125 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000126 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000127 {0}
128};
129
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000130static int
131type_compare(PyObject *v, PyObject *w)
132{
133 /* This is called with type objects only. So we
134 can just compare the addresses. */
135 Py_uintptr_t vv = (Py_uintptr_t)v;
136 Py_uintptr_t ww = (Py_uintptr_t)w;
137 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
138}
139
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000140static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000141type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000142{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000143 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000144 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000145
146 mod = type_module(type, NULL);
147 if (mod == NULL)
148 PyErr_Clear();
149 else if (!PyString_Check(mod)) {
150 Py_DECREF(mod);
151 mod = NULL;
152 }
153 name = type_name(type, NULL);
154 if (name == NULL)
155 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000156
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000157 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
158 kind = "class";
159 else
160 kind = "type";
161
Barry Warsaw7ce36942001-08-24 18:34:26 +0000162 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000163 rtn = PyString_FromFormat("<%s '%s.%s'>",
164 kind,
Barry Warsaw7ce36942001-08-24 18:34:26 +0000165 PyString_AS_STRING(mod),
166 PyString_AS_STRING(name));
167 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000168 else
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000169 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000170
Guido van Rossumc3542212001-08-16 09:18:56 +0000171 Py_XDECREF(mod);
172 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000173 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000174}
175
Tim Peters6d6c1a32001-08-02 04:15:00 +0000176static PyObject *
177type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
178{
179 PyObject *obj;
180
181 if (type->tp_new == NULL) {
182 PyErr_Format(PyExc_TypeError,
183 "cannot create '%.100s' instances",
184 type->tp_name);
185 return NULL;
186 }
187
Tim Peters3f996e72001-09-13 19:18:27 +0000188 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000189 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000190 /* Ugly exception: when the call was type(something),
191 don't call tp_init on the result. */
192 if (type == &PyType_Type &&
193 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
194 (kwds == NULL ||
195 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
196 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000197 /* If the returned object is not an instance of type,
198 it won't be initialized. */
199 if (!PyType_IsSubtype(obj->ob_type, type))
200 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000201 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000202 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
203 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000204 type->tp_init(obj, args, kwds) < 0) {
205 Py_DECREF(obj);
206 obj = NULL;
207 }
208 }
209 return obj;
210}
211
212PyObject *
213PyType_GenericAlloc(PyTypeObject *type, int nitems)
214{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000215 PyObject *obj;
Tim Petersf2a67da2001-10-07 03:54:51 +0000216 const size_t size = _PyObject_VAR_SIZE(type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000217
218 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000219 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000220 else
Neil Schemenauerc806c882001-08-29 23:54:54 +0000221 obj = PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000222
Neil Schemenauerc806c882001-08-29 23:54:54 +0000223 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000224 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000225
Neil Schemenauerc806c882001-08-29 23:54:54 +0000226 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000227
Tim Peters6d6c1a32001-08-02 04:15:00 +0000228 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
229 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000230
Tim Peters6d6c1a32001-08-02 04:15:00 +0000231 if (type->tp_itemsize == 0)
232 PyObject_INIT(obj, type);
233 else
234 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000235
Tim Peters6d6c1a32001-08-02 04:15:00 +0000236 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000237 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000238 return obj;
239}
240
241PyObject *
242PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
243{
244 return type->tp_alloc(type, 0);
245}
246
Guido van Rossum9475a232001-10-05 20:51:39 +0000247/* Helpers for subtyping */
248
249static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000250traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
251{
252 int i, n;
253 PyMemberDef *mp;
254
255 n = type->ob_size;
256 mp = ((etype *)type)->members;
257 for (i = 0; i < n; i++, mp++) {
258 if (mp->type == T_OBJECT_EX) {
259 char *addr = (char *)self + mp->offset;
260 PyObject *obj = *(PyObject **)addr;
261 if (obj != NULL) {
262 int err = visit(obj, arg);
263 if (err)
264 return err;
265 }
266 }
267 }
268 return 0;
269}
270
271static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000272subtype_traverse(PyObject *self, visitproc visit, void *arg)
273{
274 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000275 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000276
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000277 /* Find the nearest base with a different tp_traverse,
278 and traverse slots while we're at it */
Guido van Rossum9475a232001-10-05 20:51:39 +0000279 type = self->ob_type;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000280 base = type;
281 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
282 if (base->ob_size) {
283 int err = traverse_slots(base, self, visit, arg);
284 if (err)
285 return err;
286 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000287 base = base->tp_base;
288 assert(base);
289 }
290
291 if (type->tp_dictoffset != base->tp_dictoffset) {
292 PyObject **dictptr = _PyObject_GetDictPtr(self);
293 if (dictptr && *dictptr) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000294 int err = visit(*dictptr, arg);
Guido van Rossum9475a232001-10-05 20:51:39 +0000295 if (err)
296 return err;
297 }
298 }
299
Guido van Rossuma3862092002-06-10 15:24:42 +0000300 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
301 /* For a heaptype, the instances count as references
302 to the type. Traverse the type so the collector
303 can find cycles involving this link. */
304 int err = visit((PyObject *)type, arg);
305 if (err)
306 return err;
307 }
308
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000309 if (basetraverse)
310 return basetraverse(self, visit, arg);
311 return 0;
312}
313
314static void
315clear_slots(PyTypeObject *type, PyObject *self)
316{
317 int i, n;
318 PyMemberDef *mp;
319
320 n = type->ob_size;
321 mp = ((etype *)type)->members;
322 for (i = 0; i < n; i++, mp++) {
323 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
324 char *addr = (char *)self + mp->offset;
325 PyObject *obj = *(PyObject **)addr;
326 if (obj != NULL) {
327 Py_DECREF(obj);
328 *(PyObject **)addr = NULL;
329 }
330 }
331 }
332}
333
334static int
335subtype_clear(PyObject *self)
336{
337 PyTypeObject *type, *base;
338 inquiry baseclear;
339
340 /* Find the nearest base with a different tp_clear
341 and clear slots while we're at it */
342 type = self->ob_type;
343 base = type;
344 while ((baseclear = base->tp_clear) == subtype_clear) {
345 if (base->ob_size)
346 clear_slots(base, self);
347 base = base->tp_base;
348 assert(base);
349 }
350
Guido van Rossuma3862092002-06-10 15:24:42 +0000351 /* There's no need to clear the instance dict (if any);
352 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000353
354 if (baseclear)
355 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000356 return 0;
357}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000358
359static void
360subtype_dealloc(PyObject *self)
361{
Guido van Rossum14227b42001-12-06 02:35:58 +0000362 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000363 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000364
Guido van Rossum22b13872002-08-06 21:41:44 +0000365 /* Extract the type; we expect it to be a heap type */
366 type = self->ob_type;
367 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000368
Guido van Rossum22b13872002-08-06 21:41:44 +0000369 /* Test whether the type has GC exactly once */
370
371 if (!PyType_IS_GC(type)) {
372 /* It's really rare to find a dynamic type that doesn't have
373 GC; it can only happen when deriving from 'object' and not
374 adding any slots or instance variables. This allows
375 certain simplifications: there's no need to call
376 clear_slots(), or DECREF the dict, or clear weakrefs. */
377
378 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000379 if (type->tp_del) {
380 type->tp_del(self);
381 if (self->ob_refcnt > 0)
382 return;
383 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000384
385 /* Find the nearest base with a different tp_dealloc */
386 base = type;
387 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
388 assert(base->ob_size == 0);
389 base = base->tp_base;
390 assert(base);
391 }
392
393 /* Call the base tp_dealloc() */
394 assert(basedealloc);
395 basedealloc(self);
396
397 /* Can't reference self beyond this point */
398 Py_DECREF(type);
399
400 /* Done */
401 return;
402 }
403
404 /* We get here only if the type has GC */
405
406 /* UnTrack and re-Track around the trashcan macro, alas */
Guido van Rossum0906e072002-08-07 20:42:09 +0000407 PyObject_GC_UnTrack(self);
Guido van Rossum22b13872002-08-06 21:41:44 +0000408 Py_TRASHCAN_SAFE_BEGIN(self);
409 _PyObject_GC_TRACK(self); /* We'll untrack for real later */
410
411 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000412 if (type->tp_del) {
413 type->tp_del(self);
414 if (self->ob_refcnt > 0)
415 goto endlabel;
416 }
Guido van Rossum7ad2d1e2001-10-29 22:11:00 +0000417
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000418 /* Find the nearest base with a different tp_dealloc
419 and clear slots while we're at it */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000420 base = type;
421 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
422 if (base->ob_size)
423 clear_slots(base, self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000424 base = base->tp_base;
425 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000426 }
427
Tim Peters6d6c1a32001-08-02 04:15:00 +0000428 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000429 if (type->tp_dictoffset && !base->tp_dictoffset) {
430 PyObject **dictptr = _PyObject_GetDictPtr(self);
431 if (dictptr != NULL) {
432 PyObject *dict = *dictptr;
433 if (dict != NULL) {
434 Py_DECREF(dict);
435 *dictptr = NULL;
436 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000437 }
438 }
439
Guido van Rossum9676b222001-08-17 20:32:36 +0000440 /* If we added weaklist, we clear it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000441 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
Guido van Rossum9676b222001-08-17 20:32:36 +0000442 PyObject_ClearWeakRefs(self);
443
Tim Peters6d6c1a32001-08-02 04:15:00 +0000444 /* Finalize GC if the base doesn't do GC and we do */
Guido van Rossum22b13872002-08-06 21:41:44 +0000445 if (!PyType_IS_GC(base))
Guido van Rossum048eb752001-10-02 21:24:57 +0000446 _PyObject_GC_UNTRACK(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000447
448 /* Call the base tp_dealloc() */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000449 assert(basedealloc);
450 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000451
452 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000453 Py_DECREF(type);
454
Guido van Rossum0906e072002-08-07 20:42:09 +0000455 endlabel:
Guido van Rossum22b13872002-08-06 21:41:44 +0000456 Py_TRASHCAN_SAFE_END(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000457}
458
Jeremy Hylton938ace62002-07-17 16:30:39 +0000459static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000460
Tim Peters6d6c1a32001-08-02 04:15:00 +0000461/* type test with subclassing support */
462
463int
464PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
465{
466 PyObject *mro;
467
Guido van Rossum9478d072001-09-07 18:52:13 +0000468 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
469 return b == a || b == &PyBaseObject_Type;
470
Tim Peters6d6c1a32001-08-02 04:15:00 +0000471 mro = a->tp_mro;
472 if (mro != NULL) {
473 /* Deal with multiple inheritance without recursion
474 by walking the MRO tuple */
475 int i, n;
476 assert(PyTuple_Check(mro));
477 n = PyTuple_GET_SIZE(mro);
478 for (i = 0; i < n; i++) {
479 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
480 return 1;
481 }
482 return 0;
483 }
484 else {
485 /* a is not completely initilized yet; follow tp_base */
486 do {
487 if (a == b)
488 return 1;
489 a = a->tp_base;
490 } while (a != NULL);
491 return b == &PyBaseObject_Type;
492 }
493}
494
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000495/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +0000496 without looking in the instance dictionary
497 (so we can't use PyObject_GetAttr) but still binding
498 it to the instance. The arguments are the object,
499 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000500 static variable used to cache the interned Python string.
501
502 Two variants:
503
504 - lookup_maybe() returns NULL without raising an exception
505 when the _PyType_Lookup() call fails;
506
507 - lookup_method() always raises an exception upon errors.
508*/
Guido van Rossum60718732001-08-28 17:47:51 +0000509
510static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000511lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +0000512{
513 PyObject *res;
514
515 if (*attrobj == NULL) {
516 *attrobj = PyString_InternFromString(attrstr);
517 if (*attrobj == NULL)
518 return NULL;
519 }
520 res = _PyType_Lookup(self->ob_type, *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000521 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +0000522 descrgetfunc f;
523 if ((f = res->ob_type->tp_descr_get) == NULL)
524 Py_INCREF(res);
525 else
526 res = f(res, self, (PyObject *)(self->ob_type));
527 }
528 return res;
529}
530
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000531static PyObject *
532lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
533{
534 PyObject *res = lookup_maybe(self, attrstr, attrobj);
535 if (res == NULL && !PyErr_Occurred())
536 PyErr_SetObject(PyExc_AttributeError, *attrobj);
537 return res;
538}
539
Guido van Rossum2730b132001-08-28 18:22:14 +0000540/* A variation of PyObject_CallMethod that uses lookup_method()
541 instead of PyObject_GetAttrString(). This uses the same convention
542 as lookup_method to cache the interned name string object. */
543
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000544static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +0000545call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
546{
547 va_list va;
548 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +0000549 va_start(va, format);
550
Guido van Rossumda21c012001-10-03 00:50:18 +0000551 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000552 if (func == NULL) {
553 va_end(va);
554 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +0000555 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000556 return NULL;
557 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000558
559 if (format && *format)
560 args = Py_VaBuildValue(format, va);
561 else
562 args = PyTuple_New(0);
563
564 va_end(va);
565
566 if (args == NULL)
567 return NULL;
568
569 assert(PyTuple_Check(args));
570 retval = PyObject_Call(func, args, NULL);
571
572 Py_DECREF(args);
573 Py_DECREF(func);
574
575 return retval;
576}
577
578/* Clone of call_method() that returns NotImplemented when the lookup fails. */
579
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000580static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000581call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
582{
583 va_list va;
584 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000585 va_start(va, format);
586
Guido van Rossumda21c012001-10-03 00:50:18 +0000587 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +0000588 if (func == NULL) {
589 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000590 if (!PyErr_Occurred()) {
591 Py_INCREF(Py_NotImplemented);
592 return Py_NotImplemented;
593 }
Guido van Rossum717ce002001-09-14 16:58:08 +0000594 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +0000595 }
596
597 if (format && *format)
598 args = Py_VaBuildValue(format, va);
599 else
600 args = PyTuple_New(0);
601
602 va_end(va);
603
Guido van Rossum717ce002001-09-14 16:58:08 +0000604 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +0000605 return NULL;
606
Guido van Rossum717ce002001-09-14 16:58:08 +0000607 assert(PyTuple_Check(args));
608 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +0000609
610 Py_DECREF(args);
611 Py_DECREF(func);
612
613 return retval;
614}
615
Tim Peters6d6c1a32001-08-02 04:15:00 +0000616/* Method resolution order algorithm from "Putting Metaclasses to Work"
617 by Forman and Danforth (Addison-Wesley 1999). */
618
619static int
620conservative_merge(PyObject *left, PyObject *right)
621{
622 int left_size;
623 int right_size;
624 int i, j, r, ok;
625 PyObject *temp, *rr;
626
627 assert(PyList_Check(left));
628 assert(PyList_Check(right));
629
630 again:
631 left_size = PyList_GET_SIZE(left);
632 right_size = PyList_GET_SIZE(right);
633 for (i = 0; i < left_size; i++) {
634 for (j = 0; j < right_size; j++) {
635 if (PyList_GET_ITEM(left, i) ==
636 PyList_GET_ITEM(right, j)) {
637 /* found a merge point */
638 temp = PyList_New(0);
639 if (temp == NULL)
640 return -1;
641 for (r = 0; r < j; r++) {
642 rr = PyList_GET_ITEM(right, r);
643 ok = PySequence_Contains(left, rr);
644 if (ok < 0) {
645 Py_DECREF(temp);
646 return -1;
647 }
648 if (!ok) {
649 ok = PyList_Append(temp, rr);
650 if (ok < 0) {
651 Py_DECREF(temp);
652 return -1;
653 }
654 }
655 }
656 ok = PyList_SetSlice(left, i, i, temp);
657 Py_DECREF(temp);
658 if (ok < 0)
659 return -1;
660 ok = PyList_SetSlice(right, 0, j+1, NULL);
661 if (ok < 0)
662 return -1;
663 goto again;
664 }
665 }
666 }
667 return PyList_SetSlice(left, left_size, left_size, right);
668}
669
670static int
671serious_order_disagreements(PyObject *left, PyObject *right)
672{
673 return 0; /* XXX later -- for now, we cheat: "don't do that" */
674}
675
Tim Petersa91e9642001-11-14 23:32:33 +0000676static int
677fill_classic_mro(PyObject *mro, PyObject *cls)
678{
679 PyObject *bases, *base;
680 int i, n;
681
682 assert(PyList_Check(mro));
683 assert(PyClass_Check(cls));
684 i = PySequence_Contains(mro, cls);
685 if (i < 0)
686 return -1;
687 if (!i) {
688 if (PyList_Append(mro, cls) < 0)
689 return -1;
690 }
691 bases = ((PyClassObject *)cls)->cl_bases;
692 assert(bases && PyTuple_Check(bases));
693 n = PyTuple_GET_SIZE(bases);
694 for (i = 0; i < n; i++) {
695 base = PyTuple_GET_ITEM(bases, i);
696 if (fill_classic_mro(mro, base) < 0)
697 return -1;
698 }
699 return 0;
700}
701
702static PyObject *
703classic_mro(PyObject *cls)
704{
705 PyObject *mro;
706
707 assert(PyClass_Check(cls));
708 mro = PyList_New(0);
709 if (mro != NULL) {
710 if (fill_classic_mro(mro, cls) == 0)
711 return mro;
712 Py_DECREF(mro);
713 }
714 return NULL;
715}
716
Tim Peters6d6c1a32001-08-02 04:15:00 +0000717static PyObject *
718mro_implementation(PyTypeObject *type)
719{
720 int i, n, ok;
721 PyObject *bases, *result;
722
Guido van Rossum63517572002-06-18 16:44:57 +0000723 if(type->tp_dict == NULL) {
724 if(PyType_Ready(type) < 0)
725 return NULL;
726 }
727
Tim Peters6d6c1a32001-08-02 04:15:00 +0000728 bases = type->tp_bases;
729 n = PyTuple_GET_SIZE(bases);
730 result = Py_BuildValue("[O]", (PyObject *)type);
731 if (result == NULL)
732 return NULL;
733 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +0000734 PyObject *base = PyTuple_GET_ITEM(bases, i);
735 PyObject *parentMRO;
736 if (PyType_Check(base))
737 parentMRO = PySequence_List(
738 ((PyTypeObject*)base)->tp_mro);
739 else
740 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000741 if (parentMRO == NULL) {
742 Py_DECREF(result);
743 return NULL;
744 }
745 if (serious_order_disagreements(result, parentMRO)) {
746 Py_DECREF(result);
747 return NULL;
748 }
749 ok = conservative_merge(result, parentMRO);
750 Py_DECREF(parentMRO);
751 if (ok < 0) {
752 Py_DECREF(result);
753 return NULL;
754 }
755 }
756 return result;
757}
758
759static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000760mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000761{
762 PyTypeObject *type = (PyTypeObject *)self;
763
Tim Peters6d6c1a32001-08-02 04:15:00 +0000764 return mro_implementation(type);
765}
766
767static int
768mro_internal(PyTypeObject *type)
769{
770 PyObject *mro, *result, *tuple;
771
772 if (type->ob_type == &PyType_Type) {
773 result = mro_implementation(type);
774 }
775 else {
Guido van Rossum60718732001-08-28 17:47:51 +0000776 static PyObject *mro_str;
777 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000778 if (mro == NULL)
779 return -1;
780 result = PyObject_CallObject(mro, NULL);
781 Py_DECREF(mro);
782 }
783 if (result == NULL)
784 return -1;
785 tuple = PySequence_Tuple(result);
786 Py_DECREF(result);
787 type->tp_mro = tuple;
788 return 0;
789}
790
791
792/* Calculate the best base amongst multiple base classes.
793 This is the first one that's on the path to the "solid base". */
794
795static PyTypeObject *
796best_base(PyObject *bases)
797{
798 int i, n;
799 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +0000800 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000801
802 assert(PyTuple_Check(bases));
803 n = PyTuple_GET_SIZE(bases);
804 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +0000805 base = NULL;
806 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000807 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +0000808 base_proto = PyTuple_GET_ITEM(bases, i);
809 if (PyClass_Check(base_proto))
810 continue;
811 if (!PyType_Check(base_proto)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000812 PyErr_SetString(
813 PyExc_TypeError,
814 "bases must be types");
815 return NULL;
816 }
Tim Petersa91e9642001-11-14 23:32:33 +0000817 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000818 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +0000819 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000820 return NULL;
821 }
822 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +0000823 if (winner == NULL) {
824 winner = candidate;
825 base = base_i;
826 }
827 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +0000828 ;
829 else if (PyType_IsSubtype(candidate, winner)) {
830 winner = candidate;
831 base = base_i;
832 }
833 else {
834 PyErr_SetString(
835 PyExc_TypeError,
836 "multiple bases have "
837 "instance lay-out conflict");
838 return NULL;
839 }
840 }
Guido van Rossume54616c2001-12-14 04:19:56 +0000841 if (base == NULL)
842 PyErr_SetString(PyExc_TypeError,
843 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +0000844 return base;
845}
846
847static int
848extra_ivars(PyTypeObject *type, PyTypeObject *base)
849{
Neil Schemenauerc806c882001-08-29 23:54:54 +0000850 size_t t_size = type->tp_basicsize;
851 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000852
Guido van Rossum9676b222001-08-17 20:32:36 +0000853 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000854 if (type->tp_itemsize || base->tp_itemsize) {
855 /* If itemsize is involved, stricter rules */
856 return t_size != b_size ||
857 type->tp_itemsize != base->tp_itemsize;
858 }
Guido van Rossum9676b222001-08-17 20:32:36 +0000859 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
860 type->tp_weaklistoffset + sizeof(PyObject *) == t_size)
861 t_size -= sizeof(PyObject *);
862 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
863 type->tp_dictoffset + sizeof(PyObject *) == t_size)
864 t_size -= sizeof(PyObject *);
865
866 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000867}
868
869static PyTypeObject *
870solid_base(PyTypeObject *type)
871{
872 PyTypeObject *base;
873
874 if (type->tp_base)
875 base = solid_base(type->tp_base);
876 else
877 base = &PyBaseObject_Type;
878 if (extra_ivars(type, base))
879 return type;
880 else
881 return base;
882}
883
Jeremy Hylton938ace62002-07-17 16:30:39 +0000884static void object_dealloc(PyObject *);
885static int object_init(PyObject *, PyObject *, PyObject *);
886static int update_slot(PyTypeObject *, PyObject *);
887static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000888
889static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000890subtype_dict(PyObject *obj, void *context)
891{
892 PyObject **dictptr = _PyObject_GetDictPtr(obj);
893 PyObject *dict;
894
895 if (dictptr == NULL) {
896 PyErr_SetString(PyExc_AttributeError,
897 "This object has no __dict__");
898 return NULL;
899 }
900 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +0000901 if (dict == NULL)
902 *dictptr = dict = PyDict_New();
903 Py_XINCREF(dict);
904 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000905}
906
Guido van Rossum6661be32001-10-26 04:26:12 +0000907static int
908subtype_setdict(PyObject *obj, PyObject *value, void *context)
909{
910 PyObject **dictptr = _PyObject_GetDictPtr(obj);
911 PyObject *dict;
912
913 if (dictptr == NULL) {
914 PyErr_SetString(PyExc_AttributeError,
915 "This object has no __dict__");
916 return -1;
917 }
Guido van Rossumd331cb52001-12-05 19:46:42 +0000918 if (value != NULL && !PyDict_Check(value)) {
Guido van Rossum6661be32001-10-26 04:26:12 +0000919 PyErr_SetString(PyExc_TypeError,
920 "__dict__ must be set to a dictionary");
921 return -1;
922 }
923 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +0000924 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +0000925 *dictptr = value;
926 Py_XDECREF(dict);
927 return 0;
928}
929
Guido van Rossumad47da02002-08-12 19:05:44 +0000930static PyObject *
931subtype_getweakref(PyObject *obj, void *context)
932{
933 PyObject **weaklistptr;
934 PyObject *result;
935
936 if (obj->ob_type->tp_weaklistoffset == 0) {
937 PyErr_SetString(PyExc_AttributeError,
938 "This object has no __weaklist__");
939 return NULL;
940 }
941 assert(obj->ob_type->tp_weaklistoffset > 0);
942 assert(obj->ob_type->tp_weaklistoffset + sizeof(PyObject *) <=
Guido van Rossum3747a0f2002-08-12 19:25:08 +0000943 (size_t)(obj->ob_type->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +0000944 weaklistptr = (PyObject **)
Guido van Rossum3747a0f2002-08-12 19:25:08 +0000945 ((char *)obj + obj->ob_type->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +0000946 if (*weaklistptr == NULL)
947 result = Py_None;
948 else
949 result = *weaklistptr;
950 Py_INCREF(result);
951 return result;
952}
953
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000954static PyGetSetDef subtype_getsets[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +0000955 /* Not all objects have these attributes!
956 The descriptor's __get__ method may raise AttributeError. */
957 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +0000958 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +0000959 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +0000960 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +0000961 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000962};
963
Guido van Rossum0628dcf2002-03-14 23:03:14 +0000964/* bozo: __getstate__ that raises TypeError */
965
966static PyObject *
967bozo_func(PyObject *self, PyObject *args)
968{
969 PyErr_SetString(PyExc_TypeError,
970 "a class that defines __slots__ without "
971 "defining __getstate__ cannot be pickled");
972 return NULL;
973}
974
Neal Norwitz93c1e232002-03-31 16:06:11 +0000975static PyMethodDef bozo_ml = {"__getstate__", bozo_func, METH_VARARGS};
Guido van Rossum0628dcf2002-03-14 23:03:14 +0000976
977static PyObject *bozo_obj = NULL;
978
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000979static int
980valid_identifier(PyObject *s)
981{
Guido van Rossum03013a02002-07-16 14:30:28 +0000982 unsigned char *p;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000983 int i, n;
984
985 if (!PyString_Check(s)) {
986 PyErr_SetString(PyExc_TypeError,
987 "__slots__ must be strings");
988 return 0;
989 }
Guido van Rossum03013a02002-07-16 14:30:28 +0000990 p = (unsigned char *) PyString_AS_STRING(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000991 n = PyString_GET_SIZE(s);
992 /* We must reject an empty name. As a hack, we bump the
993 length to 1 so that the loop will balk on the trailing \0. */
994 if (n == 0)
995 n = 1;
996 for (i = 0; i < n; i++, p++) {
997 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
998 PyErr_SetString(PyExc_TypeError,
999 "__slots__ must be identifiers");
1000 return 0;
1001 }
1002 }
1003 return 1;
1004}
1005
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001006static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001007type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1008{
1009 PyObject *name, *bases, *dict;
1010 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001011 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001012 PyTypeObject *type, *base, *tmptype, *winner;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001013 etype *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00001014 PyMemberDef *mp;
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00001015 int i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00001016 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001017
Tim Peters3abca122001-10-27 19:37:48 +00001018 assert(args != NULL && PyTuple_Check(args));
1019 assert(kwds == NULL || PyDict_Check(kwds));
1020
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001021 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00001022 {
1023 const int nargs = PyTuple_GET_SIZE(args);
1024 const int nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
1025
1026 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
1027 PyObject *x = PyTuple_GET_ITEM(args, 0);
1028 Py_INCREF(x->ob_type);
1029 return (PyObject *) x->ob_type;
1030 }
1031
1032 /* SF bug 475327 -- if that didn't trigger, we need 3
1033 arguments. but PyArg_ParseTupleAndKeywords below may give
1034 a msg saying type() needs exactly 3. */
1035 if (nargs + nkwds != 3) {
1036 PyErr_SetString(PyExc_TypeError,
1037 "type() takes 1 or 3 arguments");
1038 return NULL;
1039 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001040 }
1041
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001042 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001043 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
1044 &name,
1045 &PyTuple_Type, &bases,
1046 &PyDict_Type, &dict))
1047 return NULL;
1048
1049 /* Determine the proper metatype to deal with this,
1050 and check for metatype conflicts while we're at it.
1051 Note that if some other metatype wins to contract,
1052 it's possible that its instances are not types. */
1053 nbases = PyTuple_GET_SIZE(bases);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001054 winner = metatype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001055 for (i = 0; i < nbases; i++) {
1056 tmp = PyTuple_GET_ITEM(bases, i);
1057 tmptype = tmp->ob_type;
Tim Petersa91e9642001-11-14 23:32:33 +00001058 if (tmptype == &PyClass_Type)
1059 continue; /* Special case classic classes */
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001060 if (PyType_IsSubtype(winner, tmptype))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001061 continue;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001062 if (PyType_IsSubtype(tmptype, winner)) {
1063 winner = tmptype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001064 continue;
1065 }
1066 PyErr_SetString(PyExc_TypeError,
1067 "metatype conflict among bases");
1068 return NULL;
1069 }
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001070 if (winner != metatype) {
1071 if (winner->tp_new != type_new) /* Pass it to the winner */
1072 return winner->tp_new(winner, args, kwds);
1073 metatype = winner;
1074 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001075
1076 /* Adjust for empty tuple bases */
1077 if (nbases == 0) {
1078 bases = Py_BuildValue("(O)", &PyBaseObject_Type);
1079 if (bases == NULL)
1080 return NULL;
1081 nbases = 1;
1082 }
1083 else
1084 Py_INCREF(bases);
1085
1086 /* XXX From here until type is allocated, "return NULL" leaks bases! */
1087
1088 /* Calculate best base, and check that all bases are type objects */
1089 base = best_base(bases);
1090 if (base == NULL)
1091 return NULL;
1092 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
1093 PyErr_Format(PyExc_TypeError,
1094 "type '%.100s' is not an acceptable base type",
1095 base->tp_name);
1096 return NULL;
1097 }
1098
Tim Peters6d6c1a32001-08-02 04:15:00 +00001099 /* Check for a __slots__ sequence variable in dict, and count it */
1100 slots = PyDict_GetItemString(dict, "__slots__");
1101 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00001102 add_dict = 0;
1103 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00001104 may_add_dict = base->tp_dictoffset == 0;
1105 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
1106 if (slots == NULL) {
1107 if (may_add_dict) {
1108 add_dict++;
1109 }
1110 if (may_add_weak) {
1111 add_weak++;
1112 }
1113 }
1114 else {
1115 /* Have slots */
1116
Tim Peters6d6c1a32001-08-02 04:15:00 +00001117 /* Make it into a tuple */
1118 if (PyString_Check(slots))
1119 slots = Py_BuildValue("(O)", slots);
1120 else
1121 slots = PySequence_Tuple(slots);
1122 if (slots == NULL)
1123 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001124 assert(PyTuple_Check(slots));
1125
1126 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001127 nslots = PyTuple_GET_SIZE(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001128 if (nslots > 0 && base->tp_itemsize != 0) {
1129 PyErr_Format(PyExc_TypeError,
1130 "nonempty __slots__ "
1131 "not supported for subtype of '%s'",
1132 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00001133 bad_slots:
1134 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001135 return NULL;
1136 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001137
1138 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001139 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001140 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
1141 char *s;
1142 if (!valid_identifier(tmp))
1143 goto bad_slots;
1144 assert(PyString_Check(tmp));
1145 s = PyString_AS_STRING(tmp);
1146 if (strcmp(s, "__dict__") == 0) {
1147 if (!may_add_dict || add_dict) {
1148 PyErr_SetString(PyExc_TypeError,
1149 "__dict__ slot disallowed: "
1150 "we already got one");
1151 goto bad_slots;
1152 }
1153 add_dict++;
1154 }
1155 if (strcmp(s, "__weakref__") == 0) {
1156 if (!may_add_weak || add_weak) {
1157 PyErr_SetString(PyExc_TypeError,
1158 "__weakref__ slot disallowed: "
1159 "either we already got one, "
1160 "or __itemsize__ != 0");
1161 goto bad_slots;
1162 }
1163 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001164 }
1165 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001166
Guido van Rossumad47da02002-08-12 19:05:44 +00001167 /* Copy slots into yet another tuple, demangling names */
1168 newslots = PyTuple_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001169 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00001170 goto bad_slots;
1171 for (i = j = 0; i < nslots; i++) {
1172 char *s;
Guido van Rossum8e829202002-08-16 03:47:49 +00001173 char buffer[256];
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001174 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001175 s = PyString_AS_STRING(tmp);
1176 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1177 (add_weak && strcmp(s, "__weakref__") == 0))
1178 continue;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001179 if (_Py_Mangle(PyString_AS_STRING(name),
Guido van Rossumad47da02002-08-12 19:05:44 +00001180 PyString_AS_STRING(tmp),
1181 buffer, sizeof(buffer)))
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001182 {
1183 tmp = PyString_FromString(buffer);
1184 } else {
1185 Py_INCREF(tmp);
1186 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001187 PyTuple_SET_ITEM(newslots, j, tmp);
1188 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001189 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001190 assert(j == nslots - add_dict - add_weak);
1191 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001192 Py_DECREF(slots);
1193 slots = newslots;
1194
Guido van Rossum0628dcf2002-03-14 23:03:14 +00001195 /* See if *this* class defines __getstate__ */
Guido van Rossumad47da02002-08-12 19:05:44 +00001196 if (PyDict_GetItemString(dict, "__getstate__") == NULL) {
Guido van Rossum0628dcf2002-03-14 23:03:14 +00001197 /* If not, provide a bozo that raises TypeError */
1198 if (bozo_obj == NULL) {
1199 bozo_obj = PyCFunction_New(&bozo_ml, NULL);
Guido van Rossumad47da02002-08-12 19:05:44 +00001200 if (bozo_obj == NULL)
1201 goto bad_slots;
Guido van Rossum0628dcf2002-03-14 23:03:14 +00001202 }
1203 if (PyDict_SetItemString(dict,
1204 "__getstate__",
Guido van Rossumad47da02002-08-12 19:05:44 +00001205 bozo_obj) < 0)
1206 {
1207 Py_DECREF(bozo_obj);
1208 goto bad_slots;
Guido van Rossum0628dcf2002-03-14 23:03:14 +00001209 }
1210 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001211
1212 /* Secondary bases may provide weakrefs or dict */
1213 if (nbases > 1 &&
1214 ((may_add_dict && !add_dict) ||
1215 (may_add_weak && !add_weak))) {
1216 for (i = 0; i < nbases; i++) {
1217 tmp = PyTuple_GET_ITEM(bases, i);
1218 if (tmp == (PyObject *)base)
1219 continue; /* Skip primary base */
1220 if (PyClass_Check(tmp)) {
1221 /* Classic base class provides both */
1222 if (may_add_dict && !add_dict)
1223 add_dict++;
1224 if (may_add_weak && !add_weak)
1225 add_weak++;
1226 break;
1227 }
1228 assert(PyType_Check(tmp));
1229 tmptype = (PyTypeObject *)tmp;
1230 if (may_add_dict && !add_dict &&
1231 tmptype->tp_dictoffset != 0)
1232 add_dict++;
1233 if (may_add_weak && !add_weak &&
1234 tmptype->tp_weaklistoffset != 0)
1235 add_weak++;
1236 if (may_add_dict && !add_dict)
1237 continue;
1238 if (may_add_weak && !add_weak)
1239 continue;
1240 /* Nothing more to check */
1241 break;
1242 }
1243 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001244 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001245
1246 /* XXX From here until type is safely allocated,
1247 "return NULL" may leak slots! */
1248
1249 /* Allocate the type object */
1250 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001251 if (type == NULL) {
1252 Py_XDECREF(slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001253 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001254 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001255
1256 /* Keep name and slots alive in the extended type object */
1257 et = (etype *)type;
1258 Py_INCREF(name);
1259 et->name = name;
1260 et->slots = slots;
1261
Guido van Rossumdc91b992001-08-08 22:26:22 +00001262 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001263 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1264 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001265 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1266 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001267
1268 /* It's a new-style number unless it specifically inherits any
1269 old-style numeric behavior */
1270 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1271 (base->tp_as_number == NULL))
1272 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1273
1274 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001275 type->tp_as_number = &et->as_number;
1276 type->tp_as_sequence = &et->as_sequence;
1277 type->tp_as_mapping = &et->as_mapping;
1278 type->tp_as_buffer = &et->as_buffer;
1279 type->tp_name = PyString_AS_STRING(name);
1280
1281 /* Set tp_base and tp_bases */
1282 type->tp_bases = bases;
1283 Py_INCREF(base);
1284 type->tp_base = base;
1285
Guido van Rossum687ae002001-10-15 22:03:32 +00001286 /* Initialize tp_dict from passed-in dict */
1287 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001288 if (dict == NULL) {
1289 Py_DECREF(type);
1290 return NULL;
1291 }
1292
Guido van Rossumc3542212001-08-16 09:18:56 +00001293 /* Set __module__ in the dict */
1294 if (PyDict_GetItemString(dict, "__module__") == NULL) {
1295 tmp = PyEval_GetGlobals();
1296 if (tmp != NULL) {
1297 tmp = PyDict_GetItemString(tmp, "__name__");
1298 if (tmp != NULL) {
1299 if (PyDict_SetItemString(dict, "__module__",
1300 tmp) < 0)
1301 return NULL;
1302 }
1303 }
1304 }
1305
Tim Peters2f93e282001-10-04 05:27:00 +00001306 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00001307 and is a string. The __doc__ accessor will first look for tp_doc;
1308 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00001309 */
1310 {
1311 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
1312 if (doc != NULL && PyString_Check(doc)) {
1313 const size_t n = (size_t)PyString_GET_SIZE(doc);
Tim Peters59f809d2001-10-04 05:43:02 +00001314 type->tp_doc = (char *)PyObject_MALLOC(n+1);
Tim Peters2f93e282001-10-04 05:27:00 +00001315 if (type->tp_doc == NULL) {
1316 Py_DECREF(type);
1317 return NULL;
1318 }
1319 memcpy(type->tp_doc, PyString_AS_STRING(doc), n+1);
1320 }
1321 }
1322
Tim Peters6d6c1a32001-08-02 04:15:00 +00001323 /* Special-case __new__: if it's a plain function,
1324 make it a static function */
1325 tmp = PyDict_GetItemString(dict, "__new__");
1326 if (tmp != NULL && PyFunction_Check(tmp)) {
1327 tmp = PyStaticMethod_New(tmp);
1328 if (tmp == NULL) {
1329 Py_DECREF(type);
1330 return NULL;
1331 }
1332 PyDict_SetItemString(dict, "__new__", tmp);
1333 Py_DECREF(tmp);
1334 }
1335
1336 /* Add descriptors for custom slots from __slots__, or for __dict__ */
1337 mp = et->members;
Neil Schemenauerc806c882001-08-29 23:54:54 +00001338 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001339 if (slots != NULL) {
1340 for (i = 0; i < nslots; i++, mp++) {
1341 mp->name = PyString_AS_STRING(
1342 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00001343 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001344 mp->offset = slotoffset;
Guido van Rossum9676b222001-08-17 20:32:36 +00001345 if (base->tp_weaklistoffset == 0 &&
Guido van Rossum64b206c2001-12-04 17:13:22 +00001346 strcmp(mp->name, "__weakref__") == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001347 add_weak++;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001348 mp->type = T_OBJECT;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001349 mp->flags = READONLY;
Guido van Rossum9676b222001-08-17 20:32:36 +00001350 type->tp_weaklistoffset = slotoffset;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001351 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001352 slotoffset += sizeof(PyObject *);
1353 }
1354 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001355 if (add_dict) {
1356 if (base->tp_itemsize)
1357 type->tp_dictoffset = -(long)sizeof(PyObject *);
1358 else
1359 type->tp_dictoffset = slotoffset;
1360 slotoffset += sizeof(PyObject *);
1361 }
1362 if (add_weak) {
1363 assert(!base->tp_itemsize);
1364 type->tp_weaklistoffset = slotoffset;
1365 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001366 }
1367 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001368 type->tp_itemsize = base->tp_itemsize;
Guido van Rossum13d52f02001-08-10 21:24:08 +00001369 type->tp_members = et->members;
Guido van Rossumad47da02002-08-12 19:05:44 +00001370 type->tp_getset = subtype_getsets;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001371
1372 /* Special case some slots */
1373 if (type->tp_dictoffset != 0 || nslots > 0) {
1374 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
1375 type->tp_getattro = PyObject_GenericGetAttr;
1376 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
1377 type->tp_setattro = PyObject_GenericSetAttr;
1378 }
1379 type->tp_dealloc = subtype_dealloc;
1380
Guido van Rossum9475a232001-10-05 20:51:39 +00001381 /* Enable GC unless there are really no instance variables possible */
1382 if (!(type->tp_basicsize == sizeof(PyObject) &&
1383 type->tp_itemsize == 0))
1384 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
1385
Tim Peters6d6c1a32001-08-02 04:15:00 +00001386 /* Always override allocation strategy to use regular heap */
1387 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00001388 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001389 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00001390 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001391 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00001392 }
1393 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001394 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001395
1396 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001397 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001398 Py_DECREF(type);
1399 return NULL;
1400 }
1401
Guido van Rossum7b9144b2001-10-09 19:39:46 +00001402 /* Put the proper slots in place */
1403 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00001404
Tim Peters6d6c1a32001-08-02 04:15:00 +00001405 return (PyObject *)type;
1406}
1407
1408/* Internal API to look for a name through the MRO.
1409 This returns a borrowed reference, and doesn't set an exception! */
1410PyObject *
1411_PyType_Lookup(PyTypeObject *type, PyObject *name)
1412{
1413 int i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00001414 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001415
Guido van Rossum687ae002001-10-15 22:03:32 +00001416 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001417 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00001418
1419 /* If mro is NULL, the type is either not yet initialized
1420 by PyType_Ready(), or already cleared by type_clear().
1421 Either way the safest thing to do is to return NULL. */
1422 if (mro == NULL)
1423 return NULL;
1424
Tim Peters6d6c1a32001-08-02 04:15:00 +00001425 assert(PyTuple_Check(mro));
1426 n = PyTuple_GET_SIZE(mro);
1427 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001428 base = PyTuple_GET_ITEM(mro, i);
1429 if (PyClass_Check(base))
1430 dict = ((PyClassObject *)base)->cl_dict;
1431 else {
1432 assert(PyType_Check(base));
1433 dict = ((PyTypeObject *)base)->tp_dict;
1434 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001435 assert(dict && PyDict_Check(dict));
1436 res = PyDict_GetItem(dict, name);
1437 if (res != NULL)
1438 return res;
1439 }
1440 return NULL;
1441}
1442
1443/* This is similar to PyObject_GenericGetAttr(),
1444 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
1445static PyObject *
1446type_getattro(PyTypeObject *type, PyObject *name)
1447{
1448 PyTypeObject *metatype = type->ob_type;
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001449 PyObject *meta_attribute, *attribute;
1450 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001451
1452 /* Initialize this type (we'll assume the metatype is initialized) */
1453 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001454 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001455 return NULL;
1456 }
1457
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001458 /* No readable descriptor found yet */
1459 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00001460
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001461 /* Look for the attribute in the metatype */
1462 meta_attribute = _PyType_Lookup(metatype, name);
1463
1464 if (meta_attribute != NULL) {
1465 meta_get = meta_attribute->ob_type->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00001466
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001467 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
1468 /* Data descriptors implement tp_descr_set to intercept
1469 * writes. Assume the attribute is not overridden in
1470 * type's tp_dict (and bases): call the descriptor now.
1471 */
1472 return meta_get(meta_attribute, (PyObject *)type,
1473 (PyObject *)metatype);
1474 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001475 }
1476
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001477 /* No data descriptor found on metatype. Look in tp_dict of this
1478 * type and its bases */
1479 attribute = _PyType_Lookup(type, name);
1480 if (attribute != NULL) {
1481 /* Implement descriptor functionality, if any */
1482 descrgetfunc local_get = attribute->ob_type->tp_descr_get;
1483 if (local_get != NULL) {
1484 /* NULL 2nd argument indicates the descriptor was
1485 * found on the target object itself (or a base) */
1486 return local_get(attribute, (PyObject *)NULL,
1487 (PyObject *)type);
1488 }
Tim Peters34592512002-07-11 06:23:50 +00001489
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001490 Py_INCREF(attribute);
1491 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001492 }
1493
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001494 /* No attribute found in local __dict__ (or bases): use the
1495 * descriptor from the metatype, if any */
1496 if (meta_get != NULL)
1497 return meta_get(meta_attribute, (PyObject *)type,
1498 (PyObject *)metatype);
1499
1500 /* If an ordinary attribute was found on the metatype, return it now */
1501 if (meta_attribute != NULL) {
1502 Py_INCREF(meta_attribute);
1503 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001504 }
1505
1506 /* Give up */
1507 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00001508 "type object '%.50s' has no attribute '%.400s'",
1509 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00001510 return NULL;
1511}
1512
1513static int
1514type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
1515{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00001516 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
1517 PyErr_Format(
1518 PyExc_TypeError,
1519 "can't set attributes of built-in/extension type '%s'",
1520 type->tp_name);
1521 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00001522 }
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00001523 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
1524 return -1;
1525 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001526}
1527
1528static void
1529type_dealloc(PyTypeObject *type)
1530{
1531 etype *et;
1532
1533 /* Assert this is a heap-allocated type object */
1534 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00001535 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00001536 PyObject_ClearWeakRefs((PyObject *)type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001537 et = (etype *)type;
1538 Py_XDECREF(type->tp_base);
1539 Py_XDECREF(type->tp_dict);
1540 Py_XDECREF(type->tp_bases);
1541 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00001542 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00001543 Py_XDECREF(type->tp_subclasses);
Neal Norwitzcee5ca02002-07-30 00:42:06 +00001544 PyObject_Free(type->tp_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001545 Py_XDECREF(et->name);
1546 Py_XDECREF(et->slots);
1547 type->ob_type->tp_free((PyObject *)type);
1548}
1549
Guido van Rossum1c450732001-10-08 15:18:27 +00001550static PyObject *
1551type_subclasses(PyTypeObject *type, PyObject *args_ignored)
1552{
1553 PyObject *list, *raw, *ref;
1554 int i, n;
1555
1556 list = PyList_New(0);
1557 if (list == NULL)
1558 return NULL;
1559 raw = type->tp_subclasses;
1560 if (raw == NULL)
1561 return list;
1562 assert(PyList_Check(raw));
1563 n = PyList_GET_SIZE(raw);
1564 for (i = 0; i < n; i++) {
1565 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00001566 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00001567 ref = PyWeakref_GET_OBJECT(ref);
1568 if (ref != Py_None) {
1569 if (PyList_Append(list, ref) < 0) {
1570 Py_DECREF(list);
1571 return NULL;
1572 }
1573 }
1574 }
1575 return list;
1576}
1577
Tim Peters6d6c1a32001-08-02 04:15:00 +00001578static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001579 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00001580 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00001581 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00001582 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001583 {0}
1584};
1585
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001586PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00001587"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001588"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001589
Guido van Rossum048eb752001-10-02 21:24:57 +00001590static int
1591type_traverse(PyTypeObject *type, visitproc visit, void *arg)
1592{
Guido van Rossum048eb752001-10-02 21:24:57 +00001593 int err;
1594
Guido van Rossuma3862092002-06-10 15:24:42 +00001595 /* Because of type_is_gc(), the collector only calls this
1596 for heaptypes. */
1597 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00001598
1599#define VISIT(SLOT) \
1600 if (SLOT) { \
1601 err = visit((PyObject *)(SLOT), arg); \
1602 if (err) \
1603 return err; \
1604 }
1605
1606 VISIT(type->tp_dict);
Guido van Rossum687ae002001-10-15 22:03:32 +00001607 VISIT(type->tp_cache);
Guido van Rossum048eb752001-10-02 21:24:57 +00001608 VISIT(type->tp_mro);
1609 VISIT(type->tp_bases);
1610 VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00001611
1612 /* There's no need to visit type->tp_subclasses or
1613 ((etype *)type)->slots, because they can't be involved
1614 in cycles; tp_subclasses is a list of weak references,
1615 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00001616
1617#undef VISIT
1618
1619 return 0;
1620}
1621
1622static int
1623type_clear(PyTypeObject *type)
1624{
Guido van Rossum048eb752001-10-02 21:24:57 +00001625 PyObject *tmp;
1626
Guido van Rossuma3862092002-06-10 15:24:42 +00001627 /* Because of type_is_gc(), the collector only calls this
1628 for heaptypes. */
1629 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00001630
1631#define CLEAR(SLOT) \
1632 if (SLOT) { \
1633 tmp = (PyObject *)(SLOT); \
1634 SLOT = NULL; \
1635 Py_DECREF(tmp); \
1636 }
1637
Guido van Rossuma3862092002-06-10 15:24:42 +00001638 /* The only field we need to clear is tp_mro, which is part of a
1639 hard cycle (its first element is the class itself) that won't
1640 be broken otherwise (it's a tuple and tuples don't have a
1641 tp_clear handler). None of the other fields need to be
1642 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00001643
Guido van Rossuma3862092002-06-10 15:24:42 +00001644 tp_dict:
1645 It is a dict, so the collector will call its tp_clear.
1646
1647 tp_cache:
1648 Not used; if it were, it would be a dict.
1649
1650 tp_bases, tp_base:
1651 If these are involved in a cycle, there must be at least
1652 one other, mutable object in the cycle, e.g. a base
1653 class's dict; the cycle will be broken that way.
1654
1655 tp_subclasses:
1656 A list of weak references can't be part of a cycle; and
1657 lists have their own tp_clear.
1658
1659 slots (in etype):
1660 A tuple of strings can't be part of a cycle.
1661 */
1662
1663 CLEAR(type->tp_mro);
Tim Peters2f93e282001-10-04 05:27:00 +00001664
Guido van Rossum048eb752001-10-02 21:24:57 +00001665#undef CLEAR
1666
1667 return 0;
1668}
1669
1670static int
1671type_is_gc(PyTypeObject *type)
1672{
1673 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
1674}
1675
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001676PyTypeObject PyType_Type = {
1677 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001678 0, /* ob_size */
1679 "type", /* tp_name */
1680 sizeof(etype), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00001681 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001682 (destructor)type_dealloc, /* tp_dealloc */
1683 0, /* tp_print */
1684 0, /* tp_getattr */
1685 0, /* tp_setattr */
1686 type_compare, /* tp_compare */
1687 (reprfunc)type_repr, /* tp_repr */
1688 0, /* tp_as_number */
1689 0, /* tp_as_sequence */
1690 0, /* tp_as_mapping */
1691 (hashfunc)_Py_HashPointer, /* tp_hash */
1692 (ternaryfunc)type_call, /* tp_call */
1693 0, /* tp_str */
1694 (getattrofunc)type_getattro, /* tp_getattro */
1695 (setattrofunc)type_setattro, /* tp_setattro */
1696 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00001697 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
1698 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001699 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00001700 (traverseproc)type_traverse, /* tp_traverse */
1701 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001702 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00001703 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001704 0, /* tp_iter */
1705 0, /* tp_iternext */
1706 type_methods, /* tp_methods */
1707 type_members, /* tp_members */
1708 type_getsets, /* tp_getset */
1709 0, /* tp_base */
1710 0, /* tp_dict */
1711 0, /* tp_descr_get */
1712 0, /* tp_descr_set */
1713 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
1714 0, /* tp_init */
1715 0, /* tp_alloc */
1716 type_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001717 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00001718 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001719};
Tim Peters6d6c1a32001-08-02 04:15:00 +00001720
1721
1722/* The base type of all types (eventually)... except itself. */
1723
1724static int
1725object_init(PyObject *self, PyObject *args, PyObject *kwds)
1726{
1727 return 0;
1728}
1729
1730static void
1731object_dealloc(PyObject *self)
1732{
1733 self->ob_type->tp_free(self);
1734}
1735
Guido van Rossum8e248182001-08-12 05:17:56 +00001736static PyObject *
1737object_repr(PyObject *self)
1738{
Guido van Rossum76e69632001-08-16 18:52:43 +00001739 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00001740 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00001741
Guido van Rossum76e69632001-08-16 18:52:43 +00001742 type = self->ob_type;
1743 mod = type_module(type, NULL);
1744 if (mod == NULL)
1745 PyErr_Clear();
1746 else if (!PyString_Check(mod)) {
1747 Py_DECREF(mod);
1748 mod = NULL;
1749 }
1750 name = type_name(type, NULL);
1751 if (name == NULL)
1752 return NULL;
1753 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00001754 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00001755 PyString_AS_STRING(mod),
1756 PyString_AS_STRING(name),
1757 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00001758 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00001759 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00001760 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00001761 Py_XDECREF(mod);
1762 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00001763 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00001764}
1765
Guido van Rossumb8f63662001-08-15 23:57:02 +00001766static PyObject *
1767object_str(PyObject *self)
1768{
1769 unaryfunc f;
1770
1771 f = self->ob_type->tp_repr;
1772 if (f == NULL)
1773 f = object_repr;
1774 return f(self);
1775}
1776
Guido van Rossum8e248182001-08-12 05:17:56 +00001777static long
1778object_hash(PyObject *self)
1779{
1780 return _Py_HashPointer(self);
1781}
Guido van Rossum8e248182001-08-12 05:17:56 +00001782
Guido van Rossum5c294fb2001-09-25 03:43:42 +00001783static PyObject *
1784object_get_class(PyObject *self, void *closure)
1785{
1786 Py_INCREF(self->ob_type);
1787 return (PyObject *)(self->ob_type);
1788}
1789
1790static int
1791equiv_structs(PyTypeObject *a, PyTypeObject *b)
1792{
1793 return a == b ||
1794 (a != NULL &&
1795 b != NULL &&
1796 a->tp_basicsize == b->tp_basicsize &&
1797 a->tp_itemsize == b->tp_itemsize &&
1798 a->tp_dictoffset == b->tp_dictoffset &&
1799 a->tp_weaklistoffset == b->tp_weaklistoffset &&
1800 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
1801 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
1802}
1803
1804static int
1805same_slots_added(PyTypeObject *a, PyTypeObject *b)
1806{
1807 PyTypeObject *base = a->tp_base;
1808 int size;
1809
1810 if (base != b->tp_base)
1811 return 0;
1812 if (equiv_structs(a, base) && equiv_structs(b, base))
1813 return 1;
1814 size = base->tp_basicsize;
1815 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
1816 size += sizeof(PyObject *);
1817 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
1818 size += sizeof(PyObject *);
1819 return size == a->tp_basicsize && size == b->tp_basicsize;
1820}
1821
1822static int
1823object_set_class(PyObject *self, PyObject *value, void *closure)
1824{
1825 PyTypeObject *old = self->ob_type;
1826 PyTypeObject *new, *newbase, *oldbase;
1827
Guido van Rossumb6b89422002-04-15 01:03:30 +00001828 if (value == NULL) {
1829 PyErr_SetString(PyExc_TypeError,
1830 "can't delete __class__ attribute");
1831 return -1;
1832 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00001833 if (!PyType_Check(value)) {
1834 PyErr_Format(PyExc_TypeError,
1835 "__class__ must be set to new-style class, not '%s' object",
1836 value->ob_type->tp_name);
1837 return -1;
1838 }
1839 new = (PyTypeObject *)value;
Guido van Rossum40af8892002-08-10 05:42:07 +00001840 if (!(new->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
1841 !(old->tp_flags & Py_TPFLAGS_HEAPTYPE))
1842 {
1843 PyErr_Format(PyExc_TypeError,
1844 "__class__ assignment: only for heap types");
1845 return -1;
1846 }
Guido van Rossum9ee4b942002-05-24 18:47:47 +00001847 if (new->tp_dealloc != old->tp_dealloc ||
1848 new->tp_free != old->tp_free)
1849 {
1850 PyErr_Format(PyExc_TypeError,
1851 "__class__ assignment: "
1852 "'%s' deallocator differs from '%s'",
1853 new->tp_name,
1854 old->tp_name);
1855 return -1;
1856 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00001857 newbase = new;
1858 oldbase = old;
1859 while (equiv_structs(newbase, newbase->tp_base))
1860 newbase = newbase->tp_base;
1861 while (equiv_structs(oldbase, oldbase->tp_base))
1862 oldbase = oldbase->tp_base;
1863 if (newbase != oldbase &&
1864 (newbase->tp_base != oldbase->tp_base ||
1865 !same_slots_added(newbase, oldbase))) {
1866 PyErr_Format(PyExc_TypeError,
1867 "__class__ assignment: "
1868 "'%s' object layout differs from '%s'",
Tim Peters2f93e282001-10-04 05:27:00 +00001869 new->tp_name,
Guido van Rossum5c294fb2001-09-25 03:43:42 +00001870 old->tp_name);
1871 return -1;
1872 }
Guido van Rossum40af8892002-08-10 05:42:07 +00001873 Py_INCREF(new);
Guido van Rossum5c294fb2001-09-25 03:43:42 +00001874 self->ob_type = new;
Guido van Rossum40af8892002-08-10 05:42:07 +00001875 Py_DECREF(old);
Guido van Rossum5c294fb2001-09-25 03:43:42 +00001876 return 0;
1877}
1878
1879static PyGetSetDef object_getsets[] = {
1880 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001881 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001882 {0}
1883};
1884
Guido van Rossum3926a632001-09-25 16:25:58 +00001885static PyObject *
1886object_reduce(PyObject *self, PyObject *args)
1887{
1888 /* Call copy_reg._reduce(self) */
1889 static PyObject *copy_reg_str;
1890 PyObject *copy_reg, *res;
1891
1892 if (!copy_reg_str) {
1893 copy_reg_str = PyString_InternFromString("copy_reg");
1894 if (copy_reg_str == NULL)
1895 return NULL;
1896 }
1897 copy_reg = PyImport_Import(copy_reg_str);
1898 if (!copy_reg)
1899 return NULL;
1900 res = PyEval_CallMethod(copy_reg, "_reduce", "(O)", self);
1901 Py_DECREF(copy_reg);
1902 return res;
1903}
1904
1905static PyMethodDef object_methods[] = {
Neal Norwitz5dc2a372002-08-13 22:19:13 +00001906 {"__reduce__", object_reduce, METH_NOARGS,
1907 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00001908 {0}
1909};
1910
Tim Peters6d6c1a32001-08-02 04:15:00 +00001911PyTypeObject PyBaseObject_Type = {
1912 PyObject_HEAD_INIT(&PyType_Type)
1913 0, /* ob_size */
1914 "object", /* tp_name */
1915 sizeof(PyObject), /* tp_basicsize */
1916 0, /* tp_itemsize */
1917 (destructor)object_dealloc, /* tp_dealloc */
1918 0, /* tp_print */
1919 0, /* tp_getattr */
1920 0, /* tp_setattr */
1921 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00001922 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001923 0, /* tp_as_number */
1924 0, /* tp_as_sequence */
1925 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00001926 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001927 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00001928 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001929 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00001930 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001931 0, /* tp_as_buffer */
1932 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00001933 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001934 0, /* tp_traverse */
1935 0, /* tp_clear */
1936 0, /* tp_richcompare */
1937 0, /* tp_weaklistoffset */
1938 0, /* tp_iter */
1939 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00001940 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00001941 0, /* tp_members */
1942 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001943 0, /* tp_base */
1944 0, /* tp_dict */
1945 0, /* tp_descr_get */
1946 0, /* tp_descr_set */
1947 0, /* tp_dictoffset */
1948 object_init, /* tp_init */
1949 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossumc11e1922001-08-09 19:38:15 +00001950 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001951 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001952};
1953
1954
1955/* Initialize the __dict__ in a type object */
1956
Fred Drake7bf97152002-03-28 05:33:33 +00001957static PyObject *
1958create_specialmethod(PyMethodDef *meth, PyObject *(*func)(PyObject *))
1959{
1960 PyObject *cfunc;
1961 PyObject *result;
1962
1963 cfunc = PyCFunction_New(meth, NULL);
1964 if (cfunc == NULL)
1965 return NULL;
1966 result = func(cfunc);
1967 Py_DECREF(cfunc);
1968 return result;
1969}
1970
Tim Peters6d6c1a32001-08-02 04:15:00 +00001971static int
1972add_methods(PyTypeObject *type, PyMethodDef *meth)
1973{
Guido van Rossum687ae002001-10-15 22:03:32 +00001974 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001975
1976 for (; meth->ml_name != NULL; meth++) {
1977 PyObject *descr;
1978 if (PyDict_GetItemString(dict, meth->ml_name))
1979 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00001980 if (meth->ml_flags & METH_CLASS) {
1981 if (meth->ml_flags & METH_STATIC) {
1982 PyErr_SetString(PyExc_ValueError,
1983 "method cannot be both class and static");
1984 return -1;
1985 }
1986 descr = create_specialmethod(meth, PyClassMethod_New);
1987 }
1988 else if (meth->ml_flags & METH_STATIC) {
1989 descr = create_specialmethod(meth, PyStaticMethod_New);
1990 }
1991 else {
1992 descr = PyDescr_NewMethod(type, meth);
1993 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001994 if (descr == NULL)
1995 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00001996 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001997 return -1;
1998 Py_DECREF(descr);
1999 }
2000 return 0;
2001}
2002
2003static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002004add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002005{
Guido van Rossum687ae002001-10-15 22:03:32 +00002006 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002007
2008 for (; memb->name != NULL; memb++) {
2009 PyObject *descr;
2010 if (PyDict_GetItemString(dict, memb->name))
2011 continue;
2012 descr = PyDescr_NewMember(type, memb);
2013 if (descr == NULL)
2014 return -1;
2015 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2016 return -1;
2017 Py_DECREF(descr);
2018 }
2019 return 0;
2020}
2021
2022static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002023add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002024{
Guido van Rossum687ae002001-10-15 22:03:32 +00002025 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002026
2027 for (; gsp->name != NULL; gsp++) {
2028 PyObject *descr;
2029 if (PyDict_GetItemString(dict, gsp->name))
2030 continue;
2031 descr = PyDescr_NewGetSet(type, gsp);
2032
2033 if (descr == NULL)
2034 return -1;
2035 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2036 return -1;
2037 Py_DECREF(descr);
2038 }
2039 return 0;
2040}
2041
Guido van Rossum13d52f02001-08-10 21:24:08 +00002042static void
2043inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002044{
2045 int oldsize, newsize;
2046
Guido van Rossum13d52f02001-08-10 21:24:08 +00002047 /* Special flag magic */
2048 if (!type->tp_as_buffer && base->tp_as_buffer) {
2049 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2050 type->tp_flags |=
2051 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2052 }
2053 if (!type->tp_as_sequence && base->tp_as_sequence) {
2054 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2055 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2056 }
2057 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2058 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2059 if ((!type->tp_as_number && base->tp_as_number) ||
2060 (!type->tp_as_sequence && base->tp_as_sequence)) {
2061 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2062 if (!type->tp_as_number && !type->tp_as_sequence) {
2063 type->tp_flags |= base->tp_flags &
2064 Py_TPFLAGS_HAVE_INPLACEOPS;
2065 }
2066 }
2067 /* Wow */
2068 }
2069 if (!type->tp_as_number && base->tp_as_number) {
2070 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2071 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2072 }
2073
2074 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002075 oldsize = base->tp_basicsize;
2076 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2077 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2078 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002079 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2080 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002081 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002082 if (type->tp_traverse == NULL)
2083 type->tp_traverse = base->tp_traverse;
2084 if (type->tp_clear == NULL)
2085 type->tp_clear = base->tp_clear;
2086 }
2087 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002088 /* The condition below could use some explanation.
2089 It appears that tp_new is not inherited for static types
2090 whose base class is 'object'; this seems to be a precaution
2091 so that old extension types don't suddenly become
2092 callable (object.__new__ wouldn't insure the invariants
2093 that the extension type's own factory function ensures).
2094 Heap types, of course, are under our control, so they do
2095 inherit tp_new; static extension types that specify some
2096 other built-in type as the default are considered
2097 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002098 if (base != &PyBaseObject_Type ||
2099 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2100 if (type->tp_new == NULL)
2101 type->tp_new = base->tp_new;
2102 }
2103 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002104 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002105
2106 /* Copy other non-function slots */
2107
2108#undef COPYVAL
2109#define COPYVAL(SLOT) \
2110 if (type->SLOT == 0) type->SLOT = base->SLOT
2111
2112 COPYVAL(tp_itemsize);
2113 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2114 COPYVAL(tp_weaklistoffset);
2115 }
2116 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2117 COPYVAL(tp_dictoffset);
2118 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002119}
2120
2121static void
2122inherit_slots(PyTypeObject *type, PyTypeObject *base)
2123{
2124 PyTypeObject *basebase;
2125
2126#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002127#undef COPYSLOT
2128#undef COPYNUM
2129#undef COPYSEQ
2130#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002131#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002132
2133#define SLOTDEFINED(SLOT) \
2134 (base->SLOT != 0 && \
2135 (basebase == NULL || base->SLOT != basebase->SLOT))
2136
Tim Peters6d6c1a32001-08-02 04:15:00 +00002137#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002138 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002139
2140#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2141#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2142#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002143#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002144
Guido van Rossum13d52f02001-08-10 21:24:08 +00002145 /* This won't inherit indirect slots (from tp_as_number etc.)
2146 if type doesn't provide the space. */
2147
2148 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2149 basebase = base->tp_base;
2150 if (basebase->tp_as_number == NULL)
2151 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002152 COPYNUM(nb_add);
2153 COPYNUM(nb_subtract);
2154 COPYNUM(nb_multiply);
2155 COPYNUM(nb_divide);
2156 COPYNUM(nb_remainder);
2157 COPYNUM(nb_divmod);
2158 COPYNUM(nb_power);
2159 COPYNUM(nb_negative);
2160 COPYNUM(nb_positive);
2161 COPYNUM(nb_absolute);
2162 COPYNUM(nb_nonzero);
2163 COPYNUM(nb_invert);
2164 COPYNUM(nb_lshift);
2165 COPYNUM(nb_rshift);
2166 COPYNUM(nb_and);
2167 COPYNUM(nb_xor);
2168 COPYNUM(nb_or);
2169 COPYNUM(nb_coerce);
2170 COPYNUM(nb_int);
2171 COPYNUM(nb_long);
2172 COPYNUM(nb_float);
2173 COPYNUM(nb_oct);
2174 COPYNUM(nb_hex);
2175 COPYNUM(nb_inplace_add);
2176 COPYNUM(nb_inplace_subtract);
2177 COPYNUM(nb_inplace_multiply);
2178 COPYNUM(nb_inplace_divide);
2179 COPYNUM(nb_inplace_remainder);
2180 COPYNUM(nb_inplace_power);
2181 COPYNUM(nb_inplace_lshift);
2182 COPYNUM(nb_inplace_rshift);
2183 COPYNUM(nb_inplace_and);
2184 COPYNUM(nb_inplace_xor);
2185 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00002186 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
2187 COPYNUM(nb_true_divide);
2188 COPYNUM(nb_floor_divide);
2189 COPYNUM(nb_inplace_true_divide);
2190 COPYNUM(nb_inplace_floor_divide);
2191 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002192 }
2193
Guido van Rossum13d52f02001-08-10 21:24:08 +00002194 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
2195 basebase = base->tp_base;
2196 if (basebase->tp_as_sequence == NULL)
2197 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002198 COPYSEQ(sq_length);
2199 COPYSEQ(sq_concat);
2200 COPYSEQ(sq_repeat);
2201 COPYSEQ(sq_item);
2202 COPYSEQ(sq_slice);
2203 COPYSEQ(sq_ass_item);
2204 COPYSEQ(sq_ass_slice);
2205 COPYSEQ(sq_contains);
2206 COPYSEQ(sq_inplace_concat);
2207 COPYSEQ(sq_inplace_repeat);
2208 }
2209
Guido van Rossum13d52f02001-08-10 21:24:08 +00002210 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
2211 basebase = base->tp_base;
2212 if (basebase->tp_as_mapping == NULL)
2213 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002214 COPYMAP(mp_length);
2215 COPYMAP(mp_subscript);
2216 COPYMAP(mp_ass_subscript);
2217 }
2218
Tim Petersfc57ccb2001-10-12 02:38:24 +00002219 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
2220 basebase = base->tp_base;
2221 if (basebase->tp_as_buffer == NULL)
2222 basebase = NULL;
2223 COPYBUF(bf_getreadbuffer);
2224 COPYBUF(bf_getwritebuffer);
2225 COPYBUF(bf_getsegcount);
2226 COPYBUF(bf_getcharbuffer);
2227 }
2228
Guido van Rossum13d52f02001-08-10 21:24:08 +00002229 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002230
Tim Peters6d6c1a32001-08-02 04:15:00 +00002231 COPYSLOT(tp_dealloc);
2232 COPYSLOT(tp_print);
2233 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
2234 type->tp_getattr = base->tp_getattr;
2235 type->tp_getattro = base->tp_getattro;
2236 }
2237 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
2238 type->tp_setattr = base->tp_setattr;
2239 type->tp_setattro = base->tp_setattro;
2240 }
2241 /* tp_compare see tp_richcompare */
2242 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00002243 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002244 COPYSLOT(tp_call);
2245 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002246 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00002247 if (type->tp_compare == NULL &&
2248 type->tp_richcompare == NULL &&
2249 type->tp_hash == NULL)
2250 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00002251 type->tp_compare = base->tp_compare;
2252 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00002253 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002254 }
2255 }
2256 else {
2257 COPYSLOT(tp_compare);
2258 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002259 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
2260 COPYSLOT(tp_iter);
2261 COPYSLOT(tp_iternext);
2262 }
2263 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2264 COPYSLOT(tp_descr_get);
2265 COPYSLOT(tp_descr_set);
2266 COPYSLOT(tp_dictoffset);
2267 COPYSLOT(tp_init);
2268 COPYSLOT(tp_alloc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002269 COPYSLOT(tp_free);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00002270 COPYSLOT(tp_is_gc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002271 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002272}
2273
Jeremy Hylton938ace62002-07-17 16:30:39 +00002274static int add_operators(PyTypeObject *);
2275static int add_subclass(PyTypeObject *base, PyTypeObject *type);
Guido van Rossum13d52f02001-08-10 21:24:08 +00002276
Tim Peters6d6c1a32001-08-02 04:15:00 +00002277int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002278PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002279{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002280 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002281 PyTypeObject *base;
2282 int i, n;
2283
Guido van Rossumcab05802002-06-10 15:29:03 +00002284 if (type->tp_flags & Py_TPFLAGS_READY) {
2285 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00002286 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00002287 }
Guido van Rossumd614f972001-08-10 17:39:49 +00002288 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00002289
2290 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002291
2292 /* Initialize tp_base (defaults to BaseObject unless that's us) */
2293 base = type->tp_base;
2294 if (base == NULL && type != &PyBaseObject_Type)
2295 base = type->tp_base = &PyBaseObject_Type;
2296
Guido van Rossum323a9cf2002-08-14 17:26:30 +00002297 /* Initialize the base class */
2298 if (base && base->tp_dict == NULL) {
2299 if (PyType_Ready(base) < 0)
2300 goto error;
2301 }
2302
Guido van Rossum0986d822002-04-08 01:38:42 +00002303 /* Initialize ob_type if NULL. This means extensions that want to be
2304 compilable separately on Windows can call PyType_Ready() instead of
2305 initializing the ob_type field of their type objects. */
2306 if (type->ob_type == NULL)
2307 type->ob_type = base->ob_type;
2308
Tim Peters6d6c1a32001-08-02 04:15:00 +00002309 /* Initialize tp_bases */
2310 bases = type->tp_bases;
2311 if (bases == NULL) {
2312 if (base == NULL)
2313 bases = PyTuple_New(0);
2314 else
2315 bases = Py_BuildValue("(O)", base);
2316 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00002317 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002318 type->tp_bases = bases;
2319 }
2320
Guido van Rossum687ae002001-10-15 22:03:32 +00002321 /* Initialize tp_dict */
2322 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002323 if (dict == NULL) {
2324 dict = PyDict_New();
2325 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00002326 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00002327 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002328 }
2329
Guido van Rossum687ae002001-10-15 22:03:32 +00002330 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002331 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00002332 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002333 if (type->tp_methods != NULL) {
2334 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00002335 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002336 }
2337 if (type->tp_members != NULL) {
2338 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00002339 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002340 }
2341 if (type->tp_getset != NULL) {
2342 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00002343 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002344 }
2345
Tim Peters6d6c1a32001-08-02 04:15:00 +00002346 /* Calculate method resolution order */
2347 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00002348 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002349 }
2350
Guido van Rossum13d52f02001-08-10 21:24:08 +00002351 /* Inherit special flags from dominant base */
2352 if (type->tp_base != NULL)
2353 inherit_special(type, type->tp_base);
2354
Tim Peters6d6c1a32001-08-02 04:15:00 +00002355 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002356 bases = type->tp_mro;
2357 assert(bases != NULL);
2358 assert(PyTuple_Check(bases));
2359 n = PyTuple_GET_SIZE(bases);
2360 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00002361 PyObject *b = PyTuple_GET_ITEM(bases, i);
2362 if (PyType_Check(b))
2363 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002364 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002365
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00002366 /* if the type dictionary doesn't contain a __doc__, set it from
2367 the tp_doc slot.
2368 */
2369 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
2370 if (type->tp_doc != NULL) {
2371 PyObject *doc = PyString_FromString(type->tp_doc);
2372 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
2373 Py_DECREF(doc);
2374 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00002375 PyDict_SetItemString(type->tp_dict,
2376 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00002377 }
2378 }
2379
Guido van Rossum13d52f02001-08-10 21:24:08 +00002380 /* Some more special stuff */
2381 base = type->tp_base;
2382 if (base != NULL) {
2383 if (type->tp_as_number == NULL)
2384 type->tp_as_number = base->tp_as_number;
2385 if (type->tp_as_sequence == NULL)
2386 type->tp_as_sequence = base->tp_as_sequence;
2387 if (type->tp_as_mapping == NULL)
2388 type->tp_as_mapping = base->tp_as_mapping;
2389 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002390
Guido van Rossum1c450732001-10-08 15:18:27 +00002391 /* Link into each base class's list of subclasses */
2392 bases = type->tp_bases;
2393 n = PyTuple_GET_SIZE(bases);
2394 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00002395 PyObject *b = PyTuple_GET_ITEM(bases, i);
2396 if (PyType_Check(b) &&
2397 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00002398 goto error;
2399 }
2400
Guido van Rossum13d52f02001-08-10 21:24:08 +00002401 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00002402 assert(type->tp_dict != NULL);
2403 type->tp_flags =
2404 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002405 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00002406
2407 error:
2408 type->tp_flags &= ~Py_TPFLAGS_READYING;
2409 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002410}
2411
Guido van Rossum1c450732001-10-08 15:18:27 +00002412static int
2413add_subclass(PyTypeObject *base, PyTypeObject *type)
2414{
2415 int i;
2416 PyObject *list, *ref, *new;
2417
2418 list = base->tp_subclasses;
2419 if (list == NULL) {
2420 base->tp_subclasses = list = PyList_New(0);
2421 if (list == NULL)
2422 return -1;
2423 }
2424 assert(PyList_Check(list));
2425 new = PyWeakref_NewRef((PyObject *)type, NULL);
2426 i = PyList_GET_SIZE(list);
2427 while (--i >= 0) {
2428 ref = PyList_GET_ITEM(list, i);
2429 assert(PyWeakref_CheckRef(ref));
2430 if (PyWeakref_GET_OBJECT(ref) == Py_None)
2431 return PyList_SetItem(list, i, new);
2432 }
2433 i = PyList_Append(list, new);
2434 Py_DECREF(new);
2435 return i;
2436}
2437
Tim Peters6d6c1a32001-08-02 04:15:00 +00002438
2439/* Generic wrappers for overloadable 'operators' such as __getitem__ */
2440
2441/* There's a wrapper *function* for each distinct function typedef used
2442 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
2443 wrapper *table* for each distinct operation (e.g. __len__, __add__).
2444 Most tables have only one entry; the tables for binary operators have two
2445 entries, one regular and one with reversed arguments. */
2446
2447static PyObject *
2448wrap_inquiry(PyObject *self, PyObject *args, void *wrapped)
2449{
2450 inquiry func = (inquiry)wrapped;
2451 int res;
2452
2453 if (!PyArg_ParseTuple(args, ""))
2454 return NULL;
2455 res = (*func)(self);
2456 if (res == -1 && PyErr_Occurred())
2457 return NULL;
2458 return PyInt_FromLong((long)res);
2459}
2460
Tim Peters6d6c1a32001-08-02 04:15:00 +00002461static PyObject *
2462wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
2463{
2464 binaryfunc func = (binaryfunc)wrapped;
2465 PyObject *other;
2466
2467 if (!PyArg_ParseTuple(args, "O", &other))
2468 return NULL;
2469 return (*func)(self, other);
2470}
2471
2472static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00002473wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
2474{
2475 binaryfunc func = (binaryfunc)wrapped;
2476 PyObject *other;
2477
2478 if (!PyArg_ParseTuple(args, "O", &other))
2479 return NULL;
2480 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002481 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00002482 Py_INCREF(Py_NotImplemented);
2483 return Py_NotImplemented;
2484 }
2485 return (*func)(self, other);
2486}
2487
2488static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00002489wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
2490{
2491 binaryfunc func = (binaryfunc)wrapped;
2492 PyObject *other;
2493
2494 if (!PyArg_ParseTuple(args, "O", &other))
2495 return NULL;
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00002496 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002497 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00002498 Py_INCREF(Py_NotImplemented);
2499 return Py_NotImplemented;
2500 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002501 return (*func)(other, self);
2502}
2503
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00002504static PyObject *
2505wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
2506{
2507 coercion func = (coercion)wrapped;
2508 PyObject *other, *res;
2509 int ok;
2510
2511 if (!PyArg_ParseTuple(args, "O", &other))
2512 return NULL;
2513 ok = func(&self, &other);
2514 if (ok < 0)
2515 return NULL;
2516 if (ok > 0) {
2517 Py_INCREF(Py_NotImplemented);
2518 return Py_NotImplemented;
2519 }
2520 res = PyTuple_New(2);
2521 if (res == NULL) {
2522 Py_DECREF(self);
2523 Py_DECREF(other);
2524 return NULL;
2525 }
2526 PyTuple_SET_ITEM(res, 0, self);
2527 PyTuple_SET_ITEM(res, 1, other);
2528 return res;
2529}
2530
Tim Peters6d6c1a32001-08-02 04:15:00 +00002531static PyObject *
2532wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
2533{
2534 ternaryfunc func = (ternaryfunc)wrapped;
2535 PyObject *other;
2536 PyObject *third = Py_None;
2537
2538 /* Note: This wrapper only works for __pow__() */
2539
2540 if (!PyArg_ParseTuple(args, "O|O", &other, &third))
2541 return NULL;
2542 return (*func)(self, other, third);
2543}
2544
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00002545static PyObject *
2546wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
2547{
2548 ternaryfunc func = (ternaryfunc)wrapped;
2549 PyObject *other;
2550 PyObject *third = Py_None;
2551
2552 /* Note: This wrapper only works for __pow__() */
2553
2554 if (!PyArg_ParseTuple(args, "O|O", &other, &third))
2555 return NULL;
2556 return (*func)(other, self, third);
2557}
2558
Tim Peters6d6c1a32001-08-02 04:15:00 +00002559static PyObject *
2560wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
2561{
2562 unaryfunc func = (unaryfunc)wrapped;
2563
2564 if (!PyArg_ParseTuple(args, ""))
2565 return NULL;
2566 return (*func)(self);
2567}
2568
Tim Peters6d6c1a32001-08-02 04:15:00 +00002569static PyObject *
2570wrap_intargfunc(PyObject *self, PyObject *args, void *wrapped)
2571{
2572 intargfunc func = (intargfunc)wrapped;
2573 int i;
2574
2575 if (!PyArg_ParseTuple(args, "i", &i))
2576 return NULL;
2577 return (*func)(self, i);
2578}
2579
Guido van Rossum5d815f32001-08-17 21:57:47 +00002580static int
2581getindex(PyObject *self, PyObject *arg)
2582{
2583 int i;
2584
2585 i = PyInt_AsLong(arg);
2586 if (i == -1 && PyErr_Occurred())
2587 return -1;
2588 if (i < 0) {
2589 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
2590 if (sq && sq->sq_length) {
2591 int n = (*sq->sq_length)(self);
2592 if (n < 0)
2593 return -1;
2594 i += n;
2595 }
2596 }
2597 return i;
2598}
2599
2600static PyObject *
2601wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
2602{
2603 intargfunc func = (intargfunc)wrapped;
2604 PyObject *arg;
2605 int i;
2606
Guido van Rossumf4593e02001-10-03 12:09:30 +00002607 if (PyTuple_GET_SIZE(args) == 1) {
2608 arg = PyTuple_GET_ITEM(args, 0);
2609 i = getindex(self, arg);
2610 if (i == -1 && PyErr_Occurred())
2611 return NULL;
2612 return (*func)(self, i);
2613 }
2614 PyArg_ParseTuple(args, "O", &arg);
2615 assert(PyErr_Occurred());
2616 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00002617}
2618
Tim Peters6d6c1a32001-08-02 04:15:00 +00002619static PyObject *
2620wrap_intintargfunc(PyObject *self, PyObject *args, void *wrapped)
2621{
2622 intintargfunc func = (intintargfunc)wrapped;
2623 int i, j;
2624
2625 if (!PyArg_ParseTuple(args, "ii", &i, &j))
2626 return NULL;
2627 return (*func)(self, i, j);
2628}
2629
Tim Peters6d6c1a32001-08-02 04:15:00 +00002630static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00002631wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002632{
2633 intobjargproc func = (intobjargproc)wrapped;
2634 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00002635 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002636
Guido van Rossum5d815f32001-08-17 21:57:47 +00002637 if (!PyArg_ParseTuple(args, "OO", &arg, &value))
2638 return NULL;
2639 i = getindex(self, arg);
2640 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00002641 return NULL;
2642 res = (*func)(self, i, value);
2643 if (res == -1 && PyErr_Occurred())
2644 return NULL;
2645 Py_INCREF(Py_None);
2646 return Py_None;
2647}
2648
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00002649static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00002650wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00002651{
2652 intobjargproc func = (intobjargproc)wrapped;
2653 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00002654 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00002655
Guido van Rossum5d815f32001-08-17 21:57:47 +00002656 if (!PyArg_ParseTuple(args, "O", &arg))
2657 return NULL;
2658 i = getindex(self, arg);
2659 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00002660 return NULL;
2661 res = (*func)(self, i, NULL);
2662 if (res == -1 && PyErr_Occurred())
2663 return NULL;
2664 Py_INCREF(Py_None);
2665 return Py_None;
2666}
2667
Tim Peters6d6c1a32001-08-02 04:15:00 +00002668static PyObject *
2669wrap_intintobjargproc(PyObject *self, PyObject *args, void *wrapped)
2670{
2671 intintobjargproc func = (intintobjargproc)wrapped;
2672 int i, j, res;
2673 PyObject *value;
2674
2675 if (!PyArg_ParseTuple(args, "iiO", &i, &j, &value))
2676 return NULL;
2677 res = (*func)(self, i, j, value);
2678 if (res == -1 && PyErr_Occurred())
2679 return NULL;
2680 Py_INCREF(Py_None);
2681 return Py_None;
2682}
2683
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002684static PyObject *
2685wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
2686{
2687 intintobjargproc func = (intintobjargproc)wrapped;
2688 int i, j, res;
2689
2690 if (!PyArg_ParseTuple(args, "ii", &i, &j))
2691 return NULL;
2692 res = (*func)(self, i, j, NULL);
2693 if (res == -1 && PyErr_Occurred())
2694 return NULL;
2695 Py_INCREF(Py_None);
2696 return Py_None;
2697}
2698
Tim Peters6d6c1a32001-08-02 04:15:00 +00002699/* XXX objobjproc is a misnomer; should be objargpred */
2700static PyObject *
2701wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
2702{
2703 objobjproc func = (objobjproc)wrapped;
2704 int res;
2705 PyObject *value;
2706
2707 if (!PyArg_ParseTuple(args, "O", &value))
2708 return NULL;
2709 res = (*func)(self, value);
2710 if (res == -1 && PyErr_Occurred())
2711 return NULL;
2712 return PyInt_FromLong((long)res);
2713}
2714
Tim Peters6d6c1a32001-08-02 04:15:00 +00002715static PyObject *
2716wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
2717{
2718 objobjargproc func = (objobjargproc)wrapped;
2719 int res;
2720 PyObject *key, *value;
2721
2722 if (!PyArg_ParseTuple(args, "OO", &key, &value))
2723 return NULL;
2724 res = (*func)(self, key, value);
2725 if (res == -1 && PyErr_Occurred())
2726 return NULL;
2727 Py_INCREF(Py_None);
2728 return Py_None;
2729}
2730
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00002731static PyObject *
2732wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
2733{
2734 objobjargproc func = (objobjargproc)wrapped;
2735 int res;
2736 PyObject *key;
2737
2738 if (!PyArg_ParseTuple(args, "O", &key))
2739 return NULL;
2740 res = (*func)(self, key, NULL);
2741 if (res == -1 && PyErr_Occurred())
2742 return NULL;
2743 Py_INCREF(Py_None);
2744 return Py_None;
2745}
2746
Tim Peters6d6c1a32001-08-02 04:15:00 +00002747static PyObject *
2748wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
2749{
2750 cmpfunc func = (cmpfunc)wrapped;
2751 int res;
2752 PyObject *other;
2753
2754 if (!PyArg_ParseTuple(args, "O", &other))
2755 return NULL;
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00002756 if (other->ob_type->tp_compare != func &&
2757 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00002758 PyErr_Format(
2759 PyExc_TypeError,
2760 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
2761 self->ob_type->tp_name,
2762 self->ob_type->tp_name,
2763 other->ob_type->tp_name);
2764 return NULL;
2765 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002766 res = (*func)(self, other);
2767 if (PyErr_Occurred())
2768 return NULL;
2769 return PyInt_FromLong((long)res);
2770}
2771
Tim Peters6d6c1a32001-08-02 04:15:00 +00002772static PyObject *
2773wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
2774{
2775 setattrofunc func = (setattrofunc)wrapped;
2776 int res;
2777 PyObject *name, *value;
2778
2779 if (!PyArg_ParseTuple(args, "OO", &name, &value))
2780 return NULL;
2781 res = (*func)(self, name, value);
2782 if (res < 0)
2783 return NULL;
2784 Py_INCREF(Py_None);
2785 return Py_None;
2786}
2787
2788static PyObject *
2789wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
2790{
2791 setattrofunc func = (setattrofunc)wrapped;
2792 int res;
2793 PyObject *name;
2794
2795 if (!PyArg_ParseTuple(args, "O", &name))
2796 return NULL;
2797 res = (*func)(self, name, NULL);
2798 if (res < 0)
2799 return NULL;
2800 Py_INCREF(Py_None);
2801 return Py_None;
2802}
2803
Tim Peters6d6c1a32001-08-02 04:15:00 +00002804static PyObject *
2805wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
2806{
2807 hashfunc func = (hashfunc)wrapped;
2808 long res;
2809
2810 if (!PyArg_ParseTuple(args, ""))
2811 return NULL;
2812 res = (*func)(self);
2813 if (res == -1 && PyErr_Occurred())
2814 return NULL;
2815 return PyInt_FromLong(res);
2816}
2817
Tim Peters6d6c1a32001-08-02 04:15:00 +00002818static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00002819wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002820{
2821 ternaryfunc func = (ternaryfunc)wrapped;
2822
Guido van Rossumc8e56452001-10-22 00:43:43 +00002823 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002824}
2825
Tim Peters6d6c1a32001-08-02 04:15:00 +00002826static PyObject *
2827wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
2828{
2829 richcmpfunc func = (richcmpfunc)wrapped;
2830 PyObject *other;
2831
2832 if (!PyArg_ParseTuple(args, "O", &other))
2833 return NULL;
2834 return (*func)(self, other, op);
2835}
2836
2837#undef RICHCMP_WRAPPER
2838#define RICHCMP_WRAPPER(NAME, OP) \
2839static PyObject * \
2840richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
2841{ \
2842 return wrap_richcmpfunc(self, args, wrapped, OP); \
2843}
2844
Jack Jansen8e938b42001-08-08 15:29:49 +00002845RICHCMP_WRAPPER(lt, Py_LT)
2846RICHCMP_WRAPPER(le, Py_LE)
2847RICHCMP_WRAPPER(eq, Py_EQ)
2848RICHCMP_WRAPPER(ne, Py_NE)
2849RICHCMP_WRAPPER(gt, Py_GT)
2850RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002851
Tim Peters6d6c1a32001-08-02 04:15:00 +00002852static PyObject *
2853wrap_next(PyObject *self, PyObject *args, void *wrapped)
2854{
2855 unaryfunc func = (unaryfunc)wrapped;
2856 PyObject *res;
2857
2858 if (!PyArg_ParseTuple(args, ""))
2859 return NULL;
2860 res = (*func)(self);
2861 if (res == NULL && !PyErr_Occurred())
2862 PyErr_SetNone(PyExc_StopIteration);
2863 return res;
2864}
2865
Tim Peters6d6c1a32001-08-02 04:15:00 +00002866static PyObject *
2867wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
2868{
2869 descrgetfunc func = (descrgetfunc)wrapped;
2870 PyObject *obj;
2871 PyObject *type = NULL;
2872
2873 if (!PyArg_ParseTuple(args, "O|O", &obj, &type))
2874 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002875 return (*func)(self, obj, type);
2876}
2877
Tim Peters6d6c1a32001-08-02 04:15:00 +00002878static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002879wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002880{
2881 descrsetfunc func = (descrsetfunc)wrapped;
2882 PyObject *obj, *value;
2883 int ret;
2884
2885 if (!PyArg_ParseTuple(args, "OO", &obj, &value))
2886 return NULL;
2887 ret = (*func)(self, obj, value);
2888 if (ret < 0)
2889 return NULL;
2890 Py_INCREF(Py_None);
2891 return Py_None;
2892}
Guido van Rossum22b13872002-08-06 21:41:44 +00002893
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00002894static PyObject *
2895wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
2896{
2897 descrsetfunc func = (descrsetfunc)wrapped;
2898 PyObject *obj;
2899 int ret;
2900
2901 if (!PyArg_ParseTuple(args, "O", &obj))
2902 return NULL;
2903 ret = (*func)(self, obj, NULL);
2904 if (ret < 0)
2905 return NULL;
2906 Py_INCREF(Py_None);
2907 return Py_None;
2908}
Tim Peters6d6c1a32001-08-02 04:15:00 +00002909
Tim Peters6d6c1a32001-08-02 04:15:00 +00002910static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00002911wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002912{
2913 initproc func = (initproc)wrapped;
2914
Guido van Rossumc8e56452001-10-22 00:43:43 +00002915 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002916 return NULL;
2917 Py_INCREF(Py_None);
2918 return Py_None;
2919}
2920
Tim Peters6d6c1a32001-08-02 04:15:00 +00002921static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002922tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002923{
Barry Warsaw60f01882001-08-22 19:24:42 +00002924 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002925 PyObject *arg0, *res;
2926
2927 if (self == NULL || !PyType_Check(self))
2928 Py_FatalError("__new__() called with non-type 'self'");
2929 type = (PyTypeObject *)self;
2930 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00002931 PyErr_Format(PyExc_TypeError,
2932 "%s.__new__(): not enough arguments",
2933 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002934 return NULL;
2935 }
2936 arg0 = PyTuple_GET_ITEM(args, 0);
2937 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00002938 PyErr_Format(PyExc_TypeError,
2939 "%s.__new__(X): X is not a type object (%s)",
2940 type->tp_name,
2941 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002942 return NULL;
2943 }
2944 subtype = (PyTypeObject *)arg0;
2945 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00002946 PyErr_Format(PyExc_TypeError,
2947 "%s.__new__(%s): %s is not a subtype of %s",
2948 type->tp_name,
2949 subtype->tp_name,
2950 subtype->tp_name,
2951 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002952 return NULL;
2953 }
Barry Warsaw60f01882001-08-22 19:24:42 +00002954
2955 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00002956 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00002957 most derived base that's not a heap type is this type. */
2958 staticbase = subtype;
2959 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
2960 staticbase = staticbase->tp_base;
Guido van Rossuma8c60f42001-09-14 19:43:36 +00002961 if (staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00002962 PyErr_Format(PyExc_TypeError,
2963 "%s.__new__(%s) is not safe, use %s.__new__()",
2964 type->tp_name,
2965 subtype->tp_name,
2966 staticbase == NULL ? "?" : staticbase->tp_name);
2967 return NULL;
2968 }
2969
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002970 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
2971 if (args == NULL)
2972 return NULL;
2973 res = type->tp_new(subtype, args, kwds);
2974 Py_DECREF(args);
2975 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002976}
2977
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002978static struct PyMethodDef tp_new_methoddef[] = {
2979 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002980 PyDoc_STR("T.__new__(S, ...) -> "
2981 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002982 {0}
2983};
2984
2985static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002986add_tp_new_wrapper(PyTypeObject *type)
2987{
Guido van Rossumf040ede2001-08-07 16:40:56 +00002988 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002989
Guido van Rossum687ae002001-10-15 22:03:32 +00002990 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00002991 return 0;
2992 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002993 if (func == NULL)
2994 return -1;
Guido van Rossum687ae002001-10-15 22:03:32 +00002995 return PyDict_SetItemString(type->tp_dict, "__new__", func);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00002996}
2997
Guido van Rossumf040ede2001-08-07 16:40:56 +00002998/* Slot wrappers that call the corresponding __foo__ slot. See comments
2999 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003000
Guido van Rossumdc91b992001-08-08 22:26:22 +00003001#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003002static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003003FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003004{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00003005 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003006 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003007}
3008
Guido van Rossumdc91b992001-08-08 22:26:22 +00003009#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003010static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003011FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003012{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003013 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003014 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003015}
3016
Guido van Rossumdc91b992001-08-08 22:26:22 +00003017
3018#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003019static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003020FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003021{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003022 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00003023 int do_other = self->ob_type != other->ob_type && \
3024 other->ob_type->tp_as_number != NULL && \
3025 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003026 if (self->ob_type->tp_as_number != NULL && \
3027 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
3028 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00003029 if (do_other && \
3030 PyType_IsSubtype(other->ob_type, self->ob_type)) { \
3031 r = call_maybe( \
3032 other, ROPSTR, &rcache_str, "(O)", self); \
3033 if (r != Py_NotImplemented) \
3034 return r; \
3035 Py_DECREF(r); \
3036 do_other = 0; \
3037 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00003038 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00003039 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003040 if (r != Py_NotImplemented || \
3041 other->ob_type == self->ob_type) \
3042 return r; \
3043 Py_DECREF(r); \
3044 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00003045 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00003046 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00003047 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003048 } \
3049 Py_INCREF(Py_NotImplemented); \
3050 return Py_NotImplemented; \
3051}
3052
3053#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
3054 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
3055
3056#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
3057static PyObject * \
3058FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
3059{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003060 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003061 return call_method(self, OPSTR, &cache_str, \
3062 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003063}
3064
3065static int
3066slot_sq_length(PyObject *self)
3067{
Guido van Rossum2730b132001-08-28 18:22:14 +00003068 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00003069 PyObject *res = call_method(self, "__len__", &len_str, "()");
Guido van Rossum26111622001-10-01 16:42:49 +00003070 int len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003071
3072 if (res == NULL)
3073 return -1;
Guido van Rossum26111622001-10-01 16:42:49 +00003074 len = (int)PyInt_AsLong(res);
3075 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00003076 if (len == -1 && PyErr_Occurred())
3077 return -1;
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00003078 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00003079 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00003080 "__len__() should return >= 0");
3081 return -1;
3082 }
Guido van Rossum26111622001-10-01 16:42:49 +00003083 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003084}
3085
Guido van Rossumdc91b992001-08-08 22:26:22 +00003086SLOT1(slot_sq_concat, "__add__", PyObject *, "O")
3087SLOT1(slot_sq_repeat, "__mul__", int, "i")
Guido van Rossumf4593e02001-10-03 12:09:30 +00003088
3089/* Super-optimized version of slot_sq_item.
3090 Other slots could do the same... */
3091static PyObject *
3092slot_sq_item(PyObject *self, int i)
3093{
3094 static PyObject *getitem_str;
3095 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
3096 descrgetfunc f;
3097
3098 if (getitem_str == NULL) {
3099 getitem_str = PyString_InternFromString("__getitem__");
3100 if (getitem_str == NULL)
3101 return NULL;
3102 }
3103 func = _PyType_Lookup(self->ob_type, getitem_str);
3104 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00003105 if ((f = func->ob_type->tp_descr_get) == NULL)
3106 Py_INCREF(func);
3107 else
3108 func = f(func, self, (PyObject *)(self->ob_type));
3109 ival = PyInt_FromLong(i);
3110 if (ival != NULL) {
3111 args = PyTuple_New(1);
3112 if (args != NULL) {
3113 PyTuple_SET_ITEM(args, 0, ival);
3114 retval = PyObject_Call(func, args, NULL);
3115 Py_XDECREF(args);
3116 Py_XDECREF(func);
3117 return retval;
3118 }
3119 }
3120 }
3121 else {
3122 PyErr_SetObject(PyExc_AttributeError, getitem_str);
3123 }
3124 Py_XDECREF(args);
3125 Py_XDECREF(ival);
3126 Py_XDECREF(func);
3127 return NULL;
3128}
3129
Guido van Rossumdc91b992001-08-08 22:26:22 +00003130SLOT2(slot_sq_slice, "__getslice__", int, int, "ii")
Tim Peters6d6c1a32001-08-02 04:15:00 +00003131
3132static int
3133slot_sq_ass_item(PyObject *self, int index, PyObject *value)
3134{
3135 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00003136 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003137
3138 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00003139 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003140 "(i)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003141 else
Guido van Rossum2730b132001-08-28 18:22:14 +00003142 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003143 "(iO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003144 if (res == NULL)
3145 return -1;
3146 Py_DECREF(res);
3147 return 0;
3148}
3149
3150static int
3151slot_sq_ass_slice(PyObject *self, int i, int j, PyObject *value)
3152{
3153 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00003154 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003155
3156 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00003157 res = call_method(self, "__delslice__", &delslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003158 "(ii)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003159 else
Guido van Rossum2730b132001-08-28 18:22:14 +00003160 res = call_method(self, "__setslice__", &setslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003161 "(iiO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003162 if (res == NULL)
3163 return -1;
3164 Py_DECREF(res);
3165 return 0;
3166}
3167
3168static int
3169slot_sq_contains(PyObject *self, PyObject *value)
3170{
Guido van Rossumb8f63662001-08-15 23:57:02 +00003171 PyObject *func, *res, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00003172 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003173
Guido van Rossum55f20992001-10-01 17:18:22 +00003174 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003175
3176 if (func != NULL) {
3177 args = Py_BuildValue("(O)", value);
3178 if (args == NULL)
3179 res = NULL;
3180 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00003181 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003182 Py_DECREF(args);
3183 }
3184 Py_DECREF(func);
3185 if (res == NULL)
3186 return -1;
3187 return PyObject_IsTrue(res);
3188 }
Guido van Rossum55f20992001-10-01 17:18:22 +00003189 else if (PyErr_Occurred())
3190 return -1;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003191 else {
Tim Peters16a77ad2001-09-08 04:00:12 +00003192 return _PySequence_IterSearch(self, value,
3193 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003194 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003195}
3196
Guido van Rossumdc91b992001-08-08 22:26:22 +00003197SLOT1(slot_sq_inplace_concat, "__iadd__", PyObject *, "O")
3198SLOT1(slot_sq_inplace_repeat, "__imul__", int, "i")
Tim Peters6d6c1a32001-08-02 04:15:00 +00003199
3200#define slot_mp_length slot_sq_length
3201
Guido van Rossumdc91b992001-08-08 22:26:22 +00003202SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00003203
3204static int
3205slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
3206{
3207 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00003208 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003209
3210 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00003211 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003212 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003213 else
Guido van Rossum2730b132001-08-28 18:22:14 +00003214 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003215 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003216 if (res == NULL)
3217 return -1;
3218 Py_DECREF(res);
3219 return 0;
3220}
3221
Guido van Rossumdc91b992001-08-08 22:26:22 +00003222SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
3223SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
3224SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
3225SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
3226SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
3227SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
3228
Jeremy Hylton938ace62002-07-17 16:30:39 +00003229static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003230
3231SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
3232 nb_power, "__pow__", "__rpow__")
3233
3234static PyObject *
3235slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
3236{
Guido van Rossum2730b132001-08-28 18:22:14 +00003237 static PyObject *pow_str;
3238
Guido van Rossumdc91b992001-08-08 22:26:22 +00003239 if (modulus == Py_None)
3240 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00003241 /* Three-arg power doesn't use __rpow__. But ternary_op
3242 can call this when the second argument's type uses
3243 slot_nb_power, so check before calling self.__pow__. */
3244 if (self->ob_type->tp_as_number != NULL &&
3245 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
3246 return call_method(self, "__pow__", &pow_str,
3247 "(OO)", other, modulus);
3248 }
3249 Py_INCREF(Py_NotImplemented);
3250 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00003251}
3252
3253SLOT0(slot_nb_negative, "__neg__")
3254SLOT0(slot_nb_positive, "__pos__")
3255SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00003256
3257static int
3258slot_nb_nonzero(PyObject *self)
3259{
Guido van Rossum84b2bed2002-08-16 17:01:09 +00003260 PyObject *func, *res, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00003261 static PyObject *nonzero_str, *len_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003262
Guido van Rossum55f20992001-10-01 17:18:22 +00003263 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003264 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00003265 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00003266 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00003267 func = lookup_maybe(self, "__len__", &len_str);
3268 if (func == NULL) {
3269 if (PyErr_Occurred())
3270 return -1;
3271 else
3272 return 1;
3273 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00003274 }
Guido van Rossum84b2bed2002-08-16 17:01:09 +00003275 args = res = PyTuple_New(0);
3276 if (args != NULL) {
3277 res = PyObject_Call(func, args, NULL);
3278 Py_DECREF(args);
3279 }
Guido van Rossum55f20992001-10-01 17:18:22 +00003280 Py_DECREF(func);
3281 if (res == NULL)
3282 return -1;
3283 return PyObject_IsTrue(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003284}
3285
Guido van Rossumdc91b992001-08-08 22:26:22 +00003286SLOT0(slot_nb_invert, "__invert__")
3287SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
3288SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
3289SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
3290SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
3291SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003292
3293static int
3294slot_nb_coerce(PyObject **a, PyObject **b)
3295{
3296 static PyObject *coerce_str;
3297 PyObject *self = *a, *other = *b;
3298
3299 if (self->ob_type->tp_as_number != NULL &&
3300 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
3301 PyObject *r;
3302 r = call_maybe(
3303 self, "__coerce__", &coerce_str, "(O)", other);
3304 if (r == NULL)
3305 return -1;
3306 if (r == Py_NotImplemented) {
3307 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003308 }
Guido van Rossum55f20992001-10-01 17:18:22 +00003309 else {
3310 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
3311 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003312 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00003313 Py_DECREF(r);
3314 return -1;
3315 }
3316 *a = PyTuple_GET_ITEM(r, 0);
3317 Py_INCREF(*a);
3318 *b = PyTuple_GET_ITEM(r, 1);
3319 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003320 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00003321 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003322 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003323 }
3324 if (other->ob_type->tp_as_number != NULL &&
3325 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
3326 PyObject *r;
3327 r = call_maybe(
3328 other, "__coerce__", &coerce_str, "(O)", self);
3329 if (r == NULL)
3330 return -1;
3331 if (r == Py_NotImplemented) {
3332 Py_DECREF(r);
3333 return 1;
3334 }
3335 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
3336 PyErr_SetString(PyExc_TypeError,
3337 "__coerce__ didn't return a 2-tuple");
3338 Py_DECREF(r);
3339 return -1;
3340 }
3341 *a = PyTuple_GET_ITEM(r, 1);
3342 Py_INCREF(*a);
3343 *b = PyTuple_GET_ITEM(r, 0);
3344 Py_INCREF(*b);
3345 Py_DECREF(r);
3346 return 0;
3347 }
3348 return 1;
3349}
3350
Guido van Rossumdc91b992001-08-08 22:26:22 +00003351SLOT0(slot_nb_int, "__int__")
3352SLOT0(slot_nb_long, "__long__")
3353SLOT0(slot_nb_float, "__float__")
3354SLOT0(slot_nb_oct, "__oct__")
3355SLOT0(slot_nb_hex, "__hex__")
3356SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
3357SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
3358SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
3359SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
3360SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
3361SLOT2(slot_nb_inplace_power, "__ipow__", PyObject *, PyObject *, "OO")
3362SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
3363SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
3364SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
3365SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
3366SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
3367SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
3368 "__floordiv__", "__rfloordiv__")
3369SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
3370SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
3371SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00003372
3373static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00003374half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003375{
Guido van Rossumb8f63662001-08-15 23:57:02 +00003376 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00003377 static PyObject *cmp_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003378 int c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003379
Guido van Rossum60718732001-08-28 17:47:51 +00003380 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003381 if (func == NULL) {
3382 PyErr_Clear();
3383 }
3384 else {
3385 args = Py_BuildValue("(O)", other);
3386 if (args == NULL)
3387 res = NULL;
3388 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00003389 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003390 Py_DECREF(args);
3391 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00003392 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003393 if (res != Py_NotImplemented) {
3394 if (res == NULL)
3395 return -2;
3396 c = PyInt_AsLong(res);
3397 Py_DECREF(res);
3398 if (c == -1 && PyErr_Occurred())
3399 return -2;
3400 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
3401 }
3402 Py_DECREF(res);
3403 }
3404 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003405}
3406
Guido van Rossumab3b0342001-09-18 20:38:53 +00003407/* This slot is published for the benefit of try_3way_compare in object.c */
3408int
3409_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00003410{
3411 int c;
3412
Guido van Rossumab3b0342001-09-18 20:38:53 +00003413 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003414 c = half_compare(self, other);
3415 if (c <= 1)
3416 return c;
3417 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00003418 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003419 c = half_compare(other, self);
3420 if (c < -1)
3421 return -2;
3422 if (c <= 1)
3423 return -c;
3424 }
3425 return (void *)self < (void *)other ? -1 :
3426 (void *)self > (void *)other ? 1 : 0;
3427}
3428
3429static PyObject *
3430slot_tp_repr(PyObject *self)
3431{
3432 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00003433 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003434
Guido van Rossum60718732001-08-28 17:47:51 +00003435 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003436 if (func != NULL) {
3437 res = PyEval_CallObject(func, NULL);
3438 Py_DECREF(func);
3439 return res;
3440 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00003441 PyErr_Clear();
3442 return PyString_FromFormat("<%s object at %p>",
3443 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003444}
3445
3446static PyObject *
3447slot_tp_str(PyObject *self)
3448{
3449 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00003450 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003451
Guido van Rossum60718732001-08-28 17:47:51 +00003452 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003453 if (func != NULL) {
3454 res = PyEval_CallObject(func, NULL);
3455 Py_DECREF(func);
3456 return res;
3457 }
3458 else {
3459 PyErr_Clear();
3460 return slot_tp_repr(self);
3461 }
3462}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003463
3464static long
3465slot_tp_hash(PyObject *self)
3466{
Guido van Rossumb8f63662001-08-15 23:57:02 +00003467 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00003468 static PyObject *hash_str, *eq_str, *cmp_str;
3469
Tim Peters6d6c1a32001-08-02 04:15:00 +00003470 long h;
3471
Guido van Rossum60718732001-08-28 17:47:51 +00003472 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003473
3474 if (func != NULL) {
3475 res = PyEval_CallObject(func, NULL);
3476 Py_DECREF(func);
3477 if (res == NULL)
3478 return -1;
3479 h = PyInt_AsLong(res);
3480 }
3481 else {
3482 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00003483 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003484 if (func == NULL) {
3485 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00003486 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003487 }
3488 if (func != NULL) {
3489 Py_DECREF(func);
3490 PyErr_SetString(PyExc_TypeError, "unhashable type");
3491 return -1;
3492 }
3493 PyErr_Clear();
3494 h = _Py_HashPointer((void *)self);
3495 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003496 if (h == -1 && !PyErr_Occurred())
3497 h = -2;
3498 return h;
3499}
3500
3501static PyObject *
3502slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
3503{
Guido van Rossum60718732001-08-28 17:47:51 +00003504 static PyObject *call_str;
3505 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003506 PyObject *res;
3507
3508 if (meth == NULL)
3509 return NULL;
3510 res = PyObject_Call(meth, args, kwds);
3511 Py_DECREF(meth);
3512 return res;
3513}
3514
Guido van Rossum14a6f832001-10-17 13:59:09 +00003515/* There are two slot dispatch functions for tp_getattro.
3516
3517 - slot_tp_getattro() is used when __getattribute__ is overridden
3518 but no __getattr__ hook is present;
3519
3520 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
3521
Guido van Rossumc334df52002-04-04 23:44:47 +00003522 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
3523 detects the absence of __getattr__ and then installs the simpler slot if
3524 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00003525
Tim Peters6d6c1a32001-08-02 04:15:00 +00003526static PyObject *
3527slot_tp_getattro(PyObject *self, PyObject *name)
3528{
Guido van Rossum14a6f832001-10-17 13:59:09 +00003529 static PyObject *getattribute_str = NULL;
3530 return call_method(self, "__getattribute__", &getattribute_str,
3531 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003532}
3533
Guido van Rossum19c1cd52001-09-21 21:24:49 +00003534static PyObject *
3535slot_tp_getattr_hook(PyObject *self, PyObject *name)
3536{
3537 PyTypeObject *tp = self->ob_type;
3538 PyObject *getattr, *getattribute, *res;
3539 static PyObject *getattribute_str = NULL;
3540 static PyObject *getattr_str = NULL;
3541
3542 if (getattr_str == NULL) {
3543 getattr_str = PyString_InternFromString("__getattr__");
3544 if (getattr_str == NULL)
3545 return NULL;
3546 }
3547 if (getattribute_str == NULL) {
3548 getattribute_str =
3549 PyString_InternFromString("__getattribute__");
3550 if (getattribute_str == NULL)
3551 return NULL;
3552 }
3553 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00003554 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00003555 /* No __getattr__ hook: use a simpler dispatcher */
3556 tp->tp_getattro = slot_tp_getattro;
3557 return slot_tp_getattro(self, name);
3558 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00003559 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00003560 if (getattribute == NULL ||
3561 (getattribute->ob_type == &PyWrapperDescr_Type &&
3562 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
3563 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00003564 res = PyObject_GenericGetAttr(self, name);
3565 else
3566 res = PyObject_CallFunction(getattribute, "OO", self, name);
Guido van Rossum14a6f832001-10-17 13:59:09 +00003567 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00003568 PyErr_Clear();
3569 res = PyObject_CallFunction(getattr, "OO", self, name);
3570 }
3571 return res;
3572}
3573
Tim Peters6d6c1a32001-08-02 04:15:00 +00003574static int
3575slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
3576{
3577 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00003578 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003579
3580 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00003581 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003582 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003583 else
Guido van Rossum2730b132001-08-28 18:22:14 +00003584 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003585 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003586 if (res == NULL)
3587 return -1;
3588 Py_DECREF(res);
3589 return 0;
3590}
3591
3592/* Map rich comparison operators to their __xx__ namesakes */
3593static char *name_op[] = {
3594 "__lt__",
3595 "__le__",
3596 "__eq__",
3597 "__ne__",
3598 "__gt__",
3599 "__ge__",
3600};
3601
3602static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00003603half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003604{
Guido van Rossumb8f63662001-08-15 23:57:02 +00003605 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00003606 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00003607
Guido van Rossum60718732001-08-28 17:47:51 +00003608 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003609 if (func == NULL) {
3610 PyErr_Clear();
3611 Py_INCREF(Py_NotImplemented);
3612 return Py_NotImplemented;
3613 }
3614 args = Py_BuildValue("(O)", other);
3615 if (args == NULL)
3616 res = NULL;
3617 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00003618 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003619 Py_DECREF(args);
3620 }
3621 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003622 return res;
3623}
3624
Guido van Rossumb8f63662001-08-15 23:57:02 +00003625/* Map rich comparison operators to their swapped version, e.g. LT --> GT */
3626static int swapped_op[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
3627
3628static PyObject *
3629slot_tp_richcompare(PyObject *self, PyObject *other, int op)
3630{
3631 PyObject *res;
3632
3633 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
3634 res = half_richcompare(self, other, op);
3635 if (res != Py_NotImplemented)
3636 return res;
3637 Py_DECREF(res);
3638 }
3639 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
3640 res = half_richcompare(other, self, swapped_op[op]);
3641 if (res != Py_NotImplemented) {
3642 return res;
3643 }
3644 Py_DECREF(res);
3645 }
3646 Py_INCREF(Py_NotImplemented);
3647 return Py_NotImplemented;
3648}
3649
3650static PyObject *
3651slot_tp_iter(PyObject *self)
3652{
3653 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00003654 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003655
Guido van Rossum60718732001-08-28 17:47:51 +00003656 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003657 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00003658 PyObject *args;
3659 args = res = PyTuple_New(0);
3660 if (args != NULL) {
3661 res = PyObject_Call(func, args, NULL);
3662 Py_DECREF(args);
3663 }
3664 Py_DECREF(func);
3665 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003666 }
3667 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00003668 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003669 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00003670 PyErr_SetString(PyExc_TypeError,
3671 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00003672 return NULL;
3673 }
3674 Py_DECREF(func);
3675 return PySeqIter_New(self);
3676}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003677
3678static PyObject *
3679slot_tp_iternext(PyObject *self)
3680{
Guido van Rossum2730b132001-08-28 18:22:14 +00003681 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00003682 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00003683}
3684
Guido van Rossum1a493502001-08-17 16:47:50 +00003685static PyObject *
3686slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
3687{
3688 PyTypeObject *tp = self->ob_type;
3689 PyObject *get;
3690 static PyObject *get_str = NULL;
3691
3692 if (get_str == NULL) {
3693 get_str = PyString_InternFromString("__get__");
3694 if (get_str == NULL)
3695 return NULL;
3696 }
3697 get = _PyType_Lookup(tp, get_str);
3698 if (get == NULL) {
3699 /* Avoid further slowdowns */
3700 if (tp->tp_descr_get == slot_tp_descr_get)
3701 tp->tp_descr_get = NULL;
3702 Py_INCREF(self);
3703 return self;
3704 }
Guido van Rossum2c252392001-08-24 10:13:31 +00003705 if (obj == NULL)
3706 obj = Py_None;
3707 if (type == NULL)
3708 type = Py_None;
Guido van Rossum1a493502001-08-17 16:47:50 +00003709 return PyObject_CallFunction(get, "OOO", self, obj, type);
3710}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003711
3712static int
3713slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
3714{
Guido van Rossum2c252392001-08-24 10:13:31 +00003715 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00003716 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00003717
3718 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00003719 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003720 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00003721 else
Guido van Rossum2730b132001-08-28 18:22:14 +00003722 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00003723 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003724 if (res == NULL)
3725 return -1;
3726 Py_DECREF(res);
3727 return 0;
3728}
3729
3730static int
3731slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
3732{
Guido van Rossum60718732001-08-28 17:47:51 +00003733 static PyObject *init_str;
3734 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003735 PyObject *res;
3736
3737 if (meth == NULL)
3738 return -1;
3739 res = PyObject_Call(meth, args, kwds);
3740 Py_DECREF(meth);
3741 if (res == NULL)
3742 return -1;
3743 Py_DECREF(res);
3744 return 0;
3745}
3746
3747static PyObject *
3748slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
3749{
Guido van Rossum7bed2132002-08-08 21:57:53 +00003750 static PyObject *new_str;
3751 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003752 PyObject *newargs, *x;
3753 int i, n;
3754
Guido van Rossum7bed2132002-08-08 21:57:53 +00003755 if (new_str == NULL) {
3756 new_str = PyString_InternFromString("__new__");
3757 if (new_str == NULL)
3758 return NULL;
3759 }
3760 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003761 if (func == NULL)
3762 return NULL;
3763 assert(PyTuple_Check(args));
3764 n = PyTuple_GET_SIZE(args);
3765 newargs = PyTuple_New(n+1);
3766 if (newargs == NULL)
3767 return NULL;
3768 Py_INCREF(type);
3769 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
3770 for (i = 0; i < n; i++) {
3771 x = PyTuple_GET_ITEM(args, i);
3772 Py_INCREF(x);
3773 PyTuple_SET_ITEM(newargs, i+1, x);
3774 }
3775 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00003776 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003777 Py_DECREF(func);
3778 return x;
3779}
3780
Guido van Rossumfebd61d2002-08-08 20:55:20 +00003781static void
3782slot_tp_del(PyObject *self)
3783{
3784 static PyObject *del_str = NULL;
3785 PyObject *del, *res;
3786 PyObject *error_type, *error_value, *error_traceback;
3787
3788 /* Temporarily resurrect the object. */
3789 assert(self->ob_refcnt == 0);
3790 self->ob_refcnt = 1;
3791
3792 /* Save the current exception, if any. */
3793 PyErr_Fetch(&error_type, &error_value, &error_traceback);
3794
3795 /* Execute __del__ method, if any. */
3796 del = lookup_maybe(self, "__del__", &del_str);
3797 if (del != NULL) {
3798 res = PyEval_CallObject(del, NULL);
3799 if (res == NULL)
3800 PyErr_WriteUnraisable(del);
3801 else
3802 Py_DECREF(res);
3803 Py_DECREF(del);
3804 }
3805
3806 /* Restore the saved exception. */
3807 PyErr_Restore(error_type, error_value, error_traceback);
3808
3809 /* Undo the temporary resurrection; can't use DECREF here, it would
3810 * cause a recursive call.
3811 */
3812 assert(self->ob_refcnt > 0);
3813 if (--self->ob_refcnt == 0)
3814 return; /* this is the normal path out */
3815
3816 /* __del__ resurrected it! Make it look like the original Py_DECREF
3817 * never happened.
3818 */
3819 {
3820 int refcnt = self->ob_refcnt;
3821 _Py_NewReference(self);
3822 self->ob_refcnt = refcnt;
3823 }
3824 assert(!PyType_IS_GC(self->ob_type) ||
3825 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
3826 /* If Py_REF_DEBUG, the original decref dropped _Py_RefTotal, but
3827 * _Py_NewReference bumped it again, so that's a wash.
3828 * If Py_TRACE_REFS, _Py_NewReference re-added self to the object
3829 * chain, so no more to do there either.
3830 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
3831 * _Py_NewReference bumped tp_allocs: both of those need to be
3832 * undone.
3833 */
3834#ifdef COUNT_ALLOCS
3835 --self->ob_type->tp_frees;
3836 --self->ob_type->tp_allocs;
3837#endif
3838}
3839
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003840
3841/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
3842 functions. The offsets here are relative to the 'etype' structure, which
3843 incorporates the additional structures used for numbers, sequences and
3844 mappings. Note that multiple names may map to the same slot (e.g. __eq__,
3845 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00003846 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
3847 terminated with an all-zero entry. (This table is further initialized and
3848 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003849
Guido van Rossum6d204072001-10-21 00:44:31 +00003850typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003851
3852#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00003853#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003854#undef ETSLOT
3855#undef SQSLOT
3856#undef MPSLOT
3857#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00003858#undef UNSLOT
3859#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003860#undef BINSLOT
3861#undef RBINSLOT
3862
Guido van Rossum6d204072001-10-21 00:44:31 +00003863#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00003864 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
3865 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00003866#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
3867 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00003868 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00003869#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00003870 {NAME, offsetof(etype, SLOT), (void *)(FUNCTION), WRAPPER, \
3871 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00003872#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
3873 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
3874#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
3875 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
3876#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
3877 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
3878#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
3879 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
3880 "x." NAME "() <==> " DOC)
3881#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
3882 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
3883 "x." NAME "(y) <==> x" DOC "y")
3884#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
3885 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
3886 "x." NAME "(y) <==> x" DOC "y")
3887#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
3888 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
3889 "x." NAME "(y) <==> y" DOC "x")
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003890
3891static slotdef slotdefs[] = {
Guido van Rossum6d204072001-10-21 00:44:31 +00003892 SQSLOT("__len__", sq_length, slot_sq_length, wrap_inquiry,
3893 "x.__len__() <==> len(x)"),
3894 SQSLOT("__add__", sq_concat, slot_sq_concat, wrap_binaryfunc,
3895 "x.__add__(y) <==> x+y"),
3896 SQSLOT("__mul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
3897 "x.__mul__(n) <==> x*n"),
3898 SQSLOT("__rmul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
3899 "x.__rmul__(n) <==> n*x"),
3900 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
3901 "x.__getitem__(y) <==> x[y]"),
3902 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_intintargfunc,
3903 "x.__getslice__(i, j) <==> x[i:j]"),
3904 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
3905 "x.__setitem__(i, y) <==> x[i]=y"),
3906 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
3907 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003908 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Guido van Rossum6d204072001-10-21 00:44:31 +00003909 wrap_intintobjargproc,
3910 "x.__setslice__(i, j, y) <==> x[i:j]=y"),
3911 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
3912 "x.__delslice__(i, j) <==> del x[i:j]"),
3913 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
3914 "x.__contains__(y) <==> y in x"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003915 SQSLOT("__iadd__", sq_inplace_concat, slot_sq_inplace_concat,
Guido van Rossum6d204072001-10-21 00:44:31 +00003916 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003917 SQSLOT("__imul__", sq_inplace_repeat, slot_sq_inplace_repeat,
Guido van Rossum6d204072001-10-21 00:44:31 +00003918 wrap_intargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003919
Guido van Rossum6d204072001-10-21 00:44:31 +00003920 MPSLOT("__len__", mp_length, slot_mp_length, wrap_inquiry,
3921 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00003922 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00003923 wrap_binaryfunc,
3924 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003925 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00003926 wrap_objobjargproc,
3927 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003928 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00003929 wrap_delitem,
3930 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003931
Guido van Rossum6d204072001-10-21 00:44:31 +00003932 BINSLOT("__add__", nb_add, slot_nb_add,
3933 "+"),
3934 RBINSLOT("__radd__", nb_add, slot_nb_add,
3935 "+"),
3936 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
3937 "-"),
3938 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
3939 "-"),
3940 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
3941 "*"),
3942 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
3943 "*"),
3944 BINSLOT("__div__", nb_divide, slot_nb_divide,
3945 "/"),
3946 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
3947 "/"),
3948 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
3949 "%"),
3950 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
3951 "%"),
3952 BINSLOT("__divmod__", nb_divmod, slot_nb_divmod,
3953 "divmod(x, y)"),
3954 RBINSLOT("__rdivmod__", nb_divmod, slot_nb_divmod,
3955 "divmod(y, x)"),
3956 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
3957 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
3958 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
3959 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
3960 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
3961 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
3962 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
3963 "abs(x)"),
Guido van Rossumdfce3bf2002-03-10 14:11:16 +00003964 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquiry,
Guido van Rossum6d204072001-10-21 00:44:31 +00003965 "x != 0"),
3966 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
3967 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
3968 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
3969 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
3970 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
3971 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
3972 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
3973 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
3974 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
3975 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
3976 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
3977 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
3978 "x.__coerce__(y) <==> coerce(x, y)"),
3979 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
3980 "int(x)"),
3981 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
3982 "long(x)"),
3983 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
3984 "float(x)"),
3985 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
3986 "oct(x)"),
3987 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
3988 "hex(x)"),
3989 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
3990 wrap_binaryfunc, "+"),
3991 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
3992 wrap_binaryfunc, "-"),
3993 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
3994 wrap_binaryfunc, "*"),
3995 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
3996 wrap_binaryfunc, "/"),
3997 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
3998 wrap_binaryfunc, "%"),
3999 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
4000 wrap_ternaryfunc, "**"),
4001 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
4002 wrap_binaryfunc, "<<"),
4003 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
4004 wrap_binaryfunc, ">>"),
4005 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
4006 wrap_binaryfunc, "&"),
4007 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
4008 wrap_binaryfunc, "^"),
4009 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
4010 wrap_binaryfunc, "|"),
4011 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
4012 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
4013 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
4014 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
4015 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
4016 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
4017 IBSLOT("__itruediv__", nb_inplace_true_divide,
4018 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004019
Guido van Rossum6d204072001-10-21 00:44:31 +00004020 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
4021 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00004022 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00004023 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
4024 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00004025 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00004026 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
4027 "x.__cmp__(y) <==> cmp(x,y)"),
4028 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
4029 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00004030 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
4031 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004032 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00004033 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
4034 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
4035 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
4036 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
4037 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
4038 "x.__setattr__('name', value) <==> x.name = value"),
4039 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
4040 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
4041 "x.__delattr__('name') <==> del x.name"),
4042 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
4043 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
4044 "x.__lt__(y) <==> x<y"),
4045 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
4046 "x.__le__(y) <==> x<=y"),
4047 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
4048 "x.__eq__(y) <==> x==y"),
4049 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
4050 "x.__ne__(y) <==> x!=y"),
4051 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
4052 "x.__gt__(y) <==> x>y"),
4053 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
4054 "x.__ge__(y) <==> x>=y"),
4055 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
4056 "x.__iter__() <==> iter(x)"),
4057 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
4058 "x.next() -> the next value, or raise StopIteration"),
4059 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
4060 "descr.__get__(obj[, type]) -> value"),
4061 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
4062 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00004063 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
4064 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00004065 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00004066 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00004067 "see x.__class__.__doc__ for signature",
4068 PyWrapperFlag_KEYWORDS),
4069 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004070 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004071 {NULL}
4072};
4073
Guido van Rossumc334df52002-04-04 23:44:47 +00004074/* Given a type pointer and an offset gotten from a slotdef entry, return a
4075 pointer to the actual slot. This is not quite the same as simply adding
4076 the offset to the type pointer, since it takes care to indirect through the
4077 proper indirection pointer (as_buffer, etc.); it returns NULL if the
4078 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004079static void **
4080slotptr(PyTypeObject *type, int offset)
4081{
4082 char *ptr;
4083
Guido van Rossum09638c12002-06-13 19:17:46 +00004084 /* Note: this depends on the order of the members of etype! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004085 assert(offset >= 0);
4086 assert(offset < offsetof(etype, as_buffer));
Guido van Rossum09638c12002-06-13 19:17:46 +00004087 if (offset >= offsetof(etype, as_sequence)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004088 ptr = (void *)type->tp_as_sequence;
4089 offset -= offsetof(etype, as_sequence);
4090 }
Guido van Rossum09638c12002-06-13 19:17:46 +00004091 else if (offset >= offsetof(etype, as_mapping)) {
4092 ptr = (void *)type->tp_as_mapping;
4093 offset -= offsetof(etype, as_mapping);
4094 }
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004095 else if (offset >= offsetof(etype, as_number)) {
4096 ptr = (void *)type->tp_as_number;
4097 offset -= offsetof(etype, as_number);
4098 }
4099 else {
4100 ptr = (void *)type;
4101 }
4102 if (ptr != NULL)
4103 ptr += offset;
4104 return (void **)ptr;
4105}
Guido van Rossumf040ede2001-08-07 16:40:56 +00004106
Guido van Rossumc334df52002-04-04 23:44:47 +00004107/* Length of array of slotdef pointers used to store slots with the
4108 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
4109 the same __name__, for any __name__. Since that's a static property, it is
4110 appropriate to declare fixed-size arrays for this. */
4111#define MAX_EQUIV 10
4112
4113/* Return a slot pointer for a given name, but ONLY if the attribute has
4114 exactly one slot function. The name must be an interned string. */
4115static void **
4116resolve_slotdups(PyTypeObject *type, PyObject *name)
4117{
4118 /* XXX Maybe this could be optimized more -- but is it worth it? */
4119
4120 /* pname and ptrs act as a little cache */
4121 static PyObject *pname;
4122 static slotdef *ptrs[MAX_EQUIV];
4123 slotdef *p, **pp;
4124 void **res, **ptr;
4125
4126 if (pname != name) {
4127 /* Collect all slotdefs that match name into ptrs. */
4128 pname = name;
4129 pp = ptrs;
4130 for (p = slotdefs; p->name_strobj; p++) {
4131 if (p->name_strobj == name)
4132 *pp++ = p;
4133 }
4134 *pp = NULL;
4135 }
4136
4137 /* Look in all matching slots of the type; if exactly one of these has
4138 a filled-in slot, return its value. Otherwise return NULL. */
4139 res = NULL;
4140 for (pp = ptrs; *pp; pp++) {
4141 ptr = slotptr(type, (*pp)->offset);
4142 if (ptr == NULL || *ptr == NULL)
4143 continue;
4144 if (res != NULL)
4145 return NULL;
4146 res = ptr;
4147 }
4148 return res;
4149}
4150
4151/* Common code for update_these_slots() and fixup_slot_dispatchers(). This
4152 does some incredibly complex thinking and then sticks something into the
4153 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
4154 interests, and then stores a generic wrapper or a specific function into
4155 the slot.) Return a pointer to the next slotdef with a different offset,
4156 because that's convenient for fixup_slot_dispatchers(). */
4157static slotdef *
4158update_one_slot(PyTypeObject *type, slotdef *p)
4159{
4160 PyObject *descr;
4161 PyWrapperDescrObject *d;
4162 void *generic = NULL, *specific = NULL;
4163 int use_generic = 0;
4164 int offset = p->offset;
4165 void **ptr = slotptr(type, offset);
4166
4167 if (ptr == NULL) {
4168 do {
4169 ++p;
4170 } while (p->offset == offset);
4171 return p;
4172 }
4173 do {
4174 descr = _PyType_Lookup(type, p->name_strobj);
4175 if (descr == NULL)
4176 continue;
4177 if (descr->ob_type == &PyWrapperDescr_Type) {
4178 void **tptr = resolve_slotdups(type, p->name_strobj);
4179 if (tptr == NULL || tptr == ptr)
4180 generic = p->function;
4181 d = (PyWrapperDescrObject *)descr;
4182 if (d->d_base->wrapper == p->wrapper &&
4183 PyType_IsSubtype(type, d->d_type))
4184 {
4185 if (specific == NULL ||
4186 specific == d->d_wrapped)
4187 specific = d->d_wrapped;
4188 else
4189 use_generic = 1;
4190 }
4191 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00004192 else if (descr->ob_type == &PyCFunction_Type &&
4193 PyCFunction_GET_FUNCTION(descr) ==
4194 (PyCFunction)tp_new_wrapper &&
4195 strcmp(p->name, "__new__") == 0)
4196 {
4197 /* The __new__ wrapper is not a wrapper descriptor,
4198 so must be special-cased differently.
4199 If we don't do this, creating an instance will
4200 always use slot_tp_new which will look up
4201 __new__ in the MRO which will call tp_new_wrapper
4202 which will look through the base classes looking
4203 for a static base and call its tp_new (usually
4204 PyType_GenericNew), after performing various
4205 sanity checks and constructing a new argument
4206 list. Cut all that nonsense short -- this speeds
4207 up instance creation tremendously. */
4208 specific = type->tp_new;
4209 /* XXX I'm not 100% sure that there isn't a hole
4210 in this reasoning that requires additional
4211 sanity checks. I'll buy the first person to
4212 point out a bug in this reasoning a beer. */
4213 }
Guido van Rossumc334df52002-04-04 23:44:47 +00004214 else {
4215 use_generic = 1;
4216 generic = p->function;
4217 }
4218 } while ((++p)->offset == offset);
4219 if (specific && !use_generic)
4220 *ptr = specific;
4221 else
4222 *ptr = generic;
4223 return p;
4224}
4225
Guido van Rossum22b13872002-08-06 21:41:44 +00004226static int recurse_down_subclasses(PyTypeObject *type, slotdef **pp,
Jeremy Hylton938ace62002-07-17 16:30:39 +00004227 PyObject *name);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004228
Guido van Rossumc334df52002-04-04 23:44:47 +00004229/* In the type, update the slots whose slotdefs are gathered in the pp0 array,
4230 and then do the same for all this type's subtypes. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004231static int
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004232update_these_slots(PyTypeObject *type, slotdef **pp0, PyObject *name)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004233{
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004234 slotdef **pp;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004235
Guido van Rossumc334df52002-04-04 23:44:47 +00004236 for (pp = pp0; *pp; pp++)
4237 update_one_slot(type, *pp);
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004238 return recurse_down_subclasses(type, pp0, name);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004239}
4240
Guido van Rossumc334df52002-04-04 23:44:47 +00004241/* Update the slots whose slotdefs are gathered in the pp array in all (direct
4242 or indirect) subclasses of type. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004243static int
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004244recurse_down_subclasses(PyTypeObject *type, slotdef **pp, PyObject *name)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004245{
4246 PyTypeObject *subclass;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004247 PyObject *ref, *subclasses, *dict;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004248 int i, n;
4249
4250 subclasses = type->tp_subclasses;
4251 if (subclasses == NULL)
4252 return 0;
4253 assert(PyList_Check(subclasses));
4254 n = PyList_GET_SIZE(subclasses);
4255 for (i = 0; i < n; i++) {
4256 ref = PyList_GET_ITEM(subclasses, i);
4257 assert(PyWeakref_CheckRef(ref));
4258 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
Guido van Rossum59e6c532002-06-14 02:27:07 +00004259 assert(subclass != NULL);
4260 if ((PyObject *)subclass == Py_None)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004261 continue;
4262 assert(PyType_Check(subclass));
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004263 /* Avoid recursing down into unaffected classes */
4264 dict = subclass->tp_dict;
4265 if (dict != NULL && PyDict_Check(dict) &&
4266 PyDict_GetItem(dict, name) != NULL)
4267 continue;
4268 if (update_these_slots(subclass, pp, name) < 0)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004269 return -1;
4270 }
4271 return 0;
4272}
4273
Guido van Rossumc334df52002-04-04 23:44:47 +00004274/* Comparison function for qsort() to compare slotdefs by their offset, and
4275 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004276static int
4277slotdef_cmp(const void *aa, const void *bb)
4278{
4279 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
4280 int c = a->offset - b->offset;
4281 if (c != 0)
4282 return c;
4283 else
4284 return a - b;
4285}
4286
Guido van Rossumc334df52002-04-04 23:44:47 +00004287/* Initialize the slotdefs table by adding interned string objects for the
4288 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004289static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004290init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004291{
4292 slotdef *p;
4293 static int initialized = 0;
4294
4295 if (initialized)
4296 return;
4297 for (p = slotdefs; p->name; p++) {
4298 p->name_strobj = PyString_InternFromString(p->name);
4299 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00004300 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004301 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004302 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
4303 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004304 initialized = 1;
4305}
4306
Guido van Rossumc334df52002-04-04 23:44:47 +00004307/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004308static int
4309update_slot(PyTypeObject *type, PyObject *name)
4310{
Guido van Rossumc334df52002-04-04 23:44:47 +00004311 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004312 slotdef *p;
4313 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004314 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004315
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004316 init_slotdefs();
4317 pp = ptrs;
4318 for (p = slotdefs; p->name; p++) {
4319 /* XXX assume name is interned! */
4320 if (p->name_strobj == name)
4321 *pp++ = p;
4322 }
4323 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004324 for (pp = ptrs; *pp; pp++) {
4325 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004326 offset = p->offset;
4327 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004328 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004329 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004330 }
Guido van Rossumc334df52002-04-04 23:44:47 +00004331 if (ptrs[0] == NULL)
4332 return 0; /* Not an attribute that affects any slots */
Guido van Rossumb85a8b72001-10-16 17:00:48 +00004333 return update_these_slots(type, ptrs, name);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00004334}
4335
Guido van Rossumc334df52002-04-04 23:44:47 +00004336/* Store the proper functions in the slot dispatches at class (type)
4337 definition time, based upon which operations the class overrides in its
4338 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004339static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004340fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004341{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004342 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004343
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004344 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00004345 for (p = slotdefs; p->name; )
4346 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004347}
Guido van Rossum705f0f52001-08-24 16:47:00 +00004348
Guido van Rossum6d204072001-10-21 00:44:31 +00004349/* This function is called by PyType_Ready() to populate the type's
4350 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00004351 function slot (like tp_repr) that's defined in the type, one or more
4352 corresponding descriptors are added in the type's tp_dict dictionary
4353 under the appropriate name (like __repr__). Some function slots
4354 cause more than one descriptor to be added (for example, the nb_add
4355 slot adds both __add__ and __radd__ descriptors) and some function
4356 slots compete for the same descriptor (for example both sq_item and
4357 mp_subscript generate a __getitem__ descriptor).
4358
4359 In the latter case, the first slotdef entry encoutered wins. Since
4360 slotdef entries are sorted by the offset of the slot in the etype
4361 struct, this gives us some control over disambiguating between
4362 competing slots: the members of struct etype are listed from most
4363 general to least general, so the most general slot is preferred. In
4364 particular, because as_mapping comes before as_sequence, for a type
4365 that defines both mp_subscript and sq_item, mp_subscript wins.
4366
4367 This only adds new descriptors and doesn't overwrite entries in
4368 tp_dict that were previously defined. The descriptors contain a
4369 reference to the C function they must call, so that it's safe if they
4370 are copied into a subtype's __dict__ and the subtype has a different
4371 C function in its slot -- calling the method defined by the
4372 descriptor will call the C function that was used to create it,
4373 rather than the C function present in the slot when it is called.
4374 (This is important because a subtype may have a C function in the
4375 slot that calls the method from the dictionary, and we want to avoid
4376 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00004377
4378static int
4379add_operators(PyTypeObject *type)
4380{
4381 PyObject *dict = type->tp_dict;
4382 slotdef *p;
4383 PyObject *descr;
4384 void **ptr;
4385
4386 init_slotdefs();
4387 for (p = slotdefs; p->name; p++) {
4388 if (p->wrapper == NULL)
4389 continue;
4390 ptr = slotptr(type, p->offset);
4391 if (!ptr || !*ptr)
4392 continue;
4393 if (PyDict_GetItem(dict, p->name_strobj))
4394 continue;
4395 descr = PyDescr_NewWrapper(type, p, *ptr);
4396 if (descr == NULL)
4397 return -1;
4398 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
4399 return -1;
4400 Py_DECREF(descr);
4401 }
4402 if (type->tp_new != NULL) {
4403 if (add_tp_new_wrapper(type) < 0)
4404 return -1;
4405 }
4406 return 0;
4407}
4408
Guido van Rossum705f0f52001-08-24 16:47:00 +00004409
4410/* Cooperative 'super' */
4411
4412typedef struct {
4413 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00004414 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00004415 PyObject *obj;
4416} superobject;
4417
Guido van Rossum6f799372001-09-20 20:46:19 +00004418static PyMemberDef super_members[] = {
4419 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
4420 "the class invoking super()"},
4421 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
4422 "the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004423 {0}
4424};
4425
Guido van Rossum705f0f52001-08-24 16:47:00 +00004426static void
4427super_dealloc(PyObject *self)
4428{
4429 superobject *su = (superobject *)self;
4430
Guido van Rossum048eb752001-10-02 21:24:57 +00004431 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00004432 Py_XDECREF(su->obj);
4433 Py_XDECREF(su->type);
4434 self->ob_type->tp_free(self);
4435}
4436
4437static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004438super_repr(PyObject *self)
4439{
4440 superobject *su = (superobject *)self;
4441
4442 if (su->obj)
4443 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00004444 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004445 su->type ? su->type->tp_name : "NULL",
4446 su->obj->ob_type->tp_name);
4447 else
4448 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00004449 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004450 su->type ? su->type->tp_name : "NULL");
4451}
4452
4453static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00004454super_getattro(PyObject *self, PyObject *name)
4455{
4456 superobject *su = (superobject *)self;
4457
4458 if (su->obj != NULL) {
Tim Petersa91e9642001-11-14 23:32:33 +00004459 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00004460 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00004461 descrgetfunc f;
4462 int i, n;
4463
Guido van Rossum155db9a2002-04-02 17:53:47 +00004464 starttype = su->obj->ob_type;
4465 mro = starttype->tp_mro;
4466
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004467 if (mro == NULL)
4468 n = 0;
4469 else {
4470 assert(PyTuple_Check(mro));
4471 n = PyTuple_GET_SIZE(mro);
4472 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00004473 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00004474 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00004475 break;
4476 }
Guido van Rossume705ef12001-08-29 15:47:06 +00004477 if (i >= n && PyType_Check(su->obj)) {
Guido van Rossum155db9a2002-04-02 17:53:47 +00004478 starttype = (PyTypeObject *)(su->obj);
4479 mro = starttype->tp_mro;
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004480 if (mro == NULL)
4481 n = 0;
4482 else {
4483 assert(PyTuple_Check(mro));
4484 n = PyTuple_GET_SIZE(mro);
4485 }
Guido van Rossume705ef12001-08-29 15:47:06 +00004486 for (i = 0; i < n; i++) {
4487 if ((PyObject *)(su->type) ==
4488 PyTuple_GET_ITEM(mro, i))
4489 break;
4490 }
Guido van Rossume705ef12001-08-29 15:47:06 +00004491 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00004492 i++;
4493 res = NULL;
4494 for (; i < n; i++) {
4495 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00004496 if (PyType_Check(tmp))
4497 dict = ((PyTypeObject *)tmp)->tp_dict;
4498 else if (PyClass_Check(tmp))
4499 dict = ((PyClassObject *)tmp)->cl_dict;
4500 else
4501 continue;
4502 res = PyDict_GetItem(dict, name);
Guido van Rossum5b443c62001-12-03 15:38:28 +00004503 if (res != NULL && !PyDescr_IsData(res)) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00004504 Py_INCREF(res);
4505 f = res->ob_type->tp_descr_get;
4506 if (f != NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004507 tmp = f(res, su->obj,
4508 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00004509 Py_DECREF(res);
4510 res = tmp;
4511 }
4512 return res;
4513 }
4514 }
4515 }
4516 return PyObject_GenericGetAttr(self, name);
4517}
4518
Guido van Rossum5b443c62001-12-03 15:38:28 +00004519static int
4520supercheck(PyTypeObject *type, PyObject *obj)
4521{
4522 if (!PyType_IsSubtype(obj->ob_type, type) &&
4523 !(PyType_Check(obj) &&
4524 PyType_IsSubtype((PyTypeObject *)obj, type))) {
4525 PyErr_SetString(PyExc_TypeError,
4526 "super(type, obj): "
4527 "obj must be an instance or subtype of type");
4528 return -1;
4529 }
4530 else
4531 return 0;
4532}
4533
Guido van Rossum705f0f52001-08-24 16:47:00 +00004534static PyObject *
4535super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4536{
4537 superobject *su = (superobject *)self;
4538 superobject *new;
4539
4540 if (obj == NULL || obj == Py_None || su->obj != NULL) {
4541 /* Not binding to an object, or already bound */
4542 Py_INCREF(self);
4543 return self;
4544 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00004545 if (su->ob_type != &PySuper_Type)
4546 /* If su is an instance of a subclass of super,
4547 call its type */
4548 return PyObject_CallFunction((PyObject *)su->ob_type,
4549 "OO", su->type, obj);
4550 else {
4551 /* Inline the common case */
4552 if (supercheck(su->type, obj) < 0)
4553 return NULL;
4554 new = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
4555 NULL, NULL);
4556 if (new == NULL)
4557 return NULL;
4558 Py_INCREF(su->type);
4559 Py_INCREF(obj);
4560 new->type = su->type;
4561 new->obj = obj;
4562 return (PyObject *)new;
4563 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00004564}
4565
4566static int
4567super_init(PyObject *self, PyObject *args, PyObject *kwds)
4568{
4569 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00004570 PyTypeObject *type;
4571 PyObject *obj = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00004572
4573 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
4574 return -1;
4575 if (obj == Py_None)
4576 obj = NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00004577 if (obj != NULL && supercheck(type, obj) < 0)
Guido van Rossum705f0f52001-08-24 16:47:00 +00004578 return -1;
Guido van Rossum705f0f52001-08-24 16:47:00 +00004579 Py_INCREF(type);
4580 Py_XINCREF(obj);
4581 su->type = type;
4582 su->obj = obj;
4583 return 0;
4584}
4585
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004586PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00004587"super(type) -> unbound super object\n"
4588"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00004589"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00004590"Typical use to call a cooperative superclass method:\n"
4591"class C(B):\n"
4592" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004593" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00004594
Guido van Rossum048eb752001-10-02 21:24:57 +00004595static int
4596super_traverse(PyObject *self, visitproc visit, void *arg)
4597{
4598 superobject *su = (superobject *)self;
4599 int err;
4600
4601#define VISIT(SLOT) \
4602 if (SLOT) { \
4603 err = visit((PyObject *)(SLOT), arg); \
4604 if (err) \
4605 return err; \
4606 }
4607
4608 VISIT(su->obj);
4609 VISIT(su->type);
4610
4611#undef VISIT
4612
4613 return 0;
4614}
4615
Guido van Rossum705f0f52001-08-24 16:47:00 +00004616PyTypeObject PySuper_Type = {
4617 PyObject_HEAD_INIT(&PyType_Type)
4618 0, /* ob_size */
4619 "super", /* tp_name */
4620 sizeof(superobject), /* tp_basicsize */
4621 0, /* tp_itemsize */
4622 /* methods */
4623 super_dealloc, /* tp_dealloc */
4624 0, /* tp_print */
4625 0, /* tp_getattr */
4626 0, /* tp_setattr */
4627 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004628 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00004629 0, /* tp_as_number */
4630 0, /* tp_as_sequence */
4631 0, /* tp_as_mapping */
4632 0, /* tp_hash */
4633 0, /* tp_call */
4634 0, /* tp_str */
4635 super_getattro, /* tp_getattro */
4636 0, /* tp_setattro */
4637 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00004638 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
4639 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00004640 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00004641 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00004642 0, /* tp_clear */
4643 0, /* tp_richcompare */
4644 0, /* tp_weaklistoffset */
4645 0, /* tp_iter */
4646 0, /* tp_iternext */
4647 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00004648 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00004649 0, /* tp_getset */
4650 0, /* tp_base */
4651 0, /* tp_dict */
4652 super_descr_get, /* tp_descr_get */
4653 0, /* tp_descr_set */
4654 0, /* tp_dictoffset */
4655 super_init, /* tp_init */
4656 PyType_GenericAlloc, /* tp_alloc */
4657 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00004658 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00004659};