blob: 591c62b4f43184e3cba91061f4902cbd4c7184ff [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
Guido van Rossum6f799372001-09-20 20:46:19 +00008static PyMemberDef type_members[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +00009 {"__basicsize__", T_INT, offsetof(PyTypeObject,tp_basicsize),READONLY},
10 {"__itemsize__", T_INT, offsetof(PyTypeObject, tp_itemsize), READONLY},
11 {"__flags__", T_LONG, offsetof(PyTypeObject, tp_flags), READONLY},
Guido van Rossum9676b222001-08-17 20:32:36 +000012 {"__weakrefoffset__", T_LONG,
Tim Peters6d6c1a32001-08-02 04:15:00 +000013 offsetof(PyTypeObject, tp_weaklistoffset), READONLY},
14 {"__base__", T_OBJECT, offsetof(PyTypeObject, tp_base), READONLY},
15 {"__dictoffset__", T_LONG,
16 offsetof(PyTypeObject, tp_dictoffset), READONLY},
Tim Peters6d6c1a32001-08-02 04:15:00 +000017 {"__mro__", T_OBJECT, offsetof(PyTypeObject, tp_mro), READONLY},
18 {0}
19};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Guido van Rossumc0b618a1997-05-02 03:12:38 +000021static PyObject *
Guido van Rossumc3542212001-08-16 09:18:56 +000022type_name(PyTypeObject *type, void *context)
23{
24 char *s;
25
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000026 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
Guido van Rossume5c691a2003-03-07 15:13:17 +000027 PyHeapTypeObject* et = (PyHeapTypeObject*)type;
Tim Petersea7f75d2002-12-07 21:39:16 +000028
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000029 Py_INCREF(et->name);
30 return et->name;
31 }
32 else {
33 s = strrchr(type->tp_name, '.');
34 if (s == NULL)
35 s = type->tp_name;
36 else
37 s++;
38 return PyString_FromString(s);
39 }
Guido van Rossumc3542212001-08-16 09:18:56 +000040}
41
Michael W. Hudson98bbc492002-11-26 14:47:27 +000042static int
43type_set_name(PyTypeObject *type, PyObject *value, void *context)
44{
Guido van Rossume5c691a2003-03-07 15:13:17 +000045 PyHeapTypeObject* et;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000046
47 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
48 PyErr_Format(PyExc_TypeError,
49 "can't set %s.__name__", type->tp_name);
50 return -1;
51 }
52 if (!value) {
53 PyErr_Format(PyExc_TypeError,
54 "can't delete %s.__name__", type->tp_name);
55 return -1;
56 }
57 if (!PyString_Check(value)) {
58 PyErr_Format(PyExc_TypeError,
59 "can only assign string to %s.__name__, not '%s'",
60 type->tp_name, value->ob_type->tp_name);
61 return -1;
62 }
Tim Petersea7f75d2002-12-07 21:39:16 +000063 if (strlen(PyString_AS_STRING(value))
Michael W. Hudson98bbc492002-11-26 14:47:27 +000064 != (size_t)PyString_GET_SIZE(value)) {
65 PyErr_Format(PyExc_ValueError,
66 "__name__ must not contain null bytes");
67 return -1;
68 }
69
Guido van Rossume5c691a2003-03-07 15:13:17 +000070 et = (PyHeapTypeObject*)type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000071
72 Py_INCREF(value);
73
74 Py_DECREF(et->name);
75 et->name = value;
76
77 type->tp_name = PyString_AS_STRING(value);
78
79 return 0;
80}
81
Guido van Rossumc3542212001-08-16 09:18:56 +000082static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000083type_module(PyTypeObject *type, void *context)
Guido van Rossum29ca26e1995-01-07 11:58:15 +000084{
Guido van Rossumc3542212001-08-16 09:18:56 +000085 PyObject *mod;
86 char *s;
87
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000088 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
89 mod = PyDict_GetItemString(type->tp_dict, "__module__");
Anthony Baxter3ecdb252004-06-11 14:41:18 +000090 if (!mod) {
91 PyErr_Format(PyExc_AttributeError, "__module__");
92 return 0;
93 }
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000094 Py_XINCREF(mod);
Guido van Rossumc3542212001-08-16 09:18:56 +000095 return mod;
96 }
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000097 else {
98 s = strrchr(type->tp_name, '.');
99 if (s != NULL)
100 return PyString_FromStringAndSize(
101 type->tp_name, (int)(s - type->tp_name));
102 return PyString_FromString("__builtin__");
103 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000104}
105
Guido van Rossum3926a632001-09-25 16:25:58 +0000106static int
107type_set_module(PyTypeObject *type, PyObject *value, void *context)
108{
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000109 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
Guido van Rossum3926a632001-09-25 16:25:58 +0000110 PyErr_Format(PyExc_TypeError,
111 "can't set %s.__module__", type->tp_name);
112 return -1;
113 }
114 if (!value) {
115 PyErr_Format(PyExc_TypeError,
116 "can't delete %s.__module__", type->tp_name);
117 return -1;
118 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000119
Guido van Rossum3926a632001-09-25 16:25:58 +0000120 return PyDict_SetItemString(type->tp_dict, "__module__", value);
121}
122
Tim Peters6d6c1a32001-08-02 04:15:00 +0000123static PyObject *
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000124type_get_bases(PyTypeObject *type, void *context)
125{
126 Py_INCREF(type->tp_bases);
127 return type->tp_bases;
128}
129
130static PyTypeObject *best_base(PyObject *);
131static int mro_internal(PyTypeObject *);
132static int compatible_for_assignment(PyTypeObject *, PyTypeObject *, char *);
133static int add_subclass(PyTypeObject*, PyTypeObject*);
134static void remove_subclass(PyTypeObject *, PyTypeObject *);
135static void update_all_slots(PyTypeObject *);
136
Guido van Rossum8d24ee92003-03-24 23:49:49 +0000137typedef int (*update_callback)(PyTypeObject *, void *);
138static int update_subclasses(PyTypeObject *type, PyObject *name,
139 update_callback callback, void *data);
140static int recurse_down_subclasses(PyTypeObject *type, PyObject *name,
141 update_callback callback, void *data);
142
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000143static int
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000144mro_subclasses(PyTypeObject *type, PyObject* temp)
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000145{
146 PyTypeObject *subclass;
147 PyObject *ref, *subclasses, *old_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000148 int i, n;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000149
150 subclasses = type->tp_subclasses;
151 if (subclasses == NULL)
152 return 0;
153 assert(PyList_Check(subclasses));
154 n = PyList_GET_SIZE(subclasses);
155 for (i = 0; i < n; i++) {
156 ref = PyList_GET_ITEM(subclasses, i);
157 assert(PyWeakref_CheckRef(ref));
158 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
159 assert(subclass != NULL);
160 if ((PyObject *)subclass == Py_None)
161 continue;
162 assert(PyType_Check(subclass));
163 old_mro = subclass->tp_mro;
164 if (mro_internal(subclass) < 0) {
165 subclass->tp_mro = old_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000166 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000167 }
168 else {
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000169 PyObject* tuple;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000170 tuple = PyTuple_Pack(2, subclass, old_mro);
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000171 Py_DECREF(old_mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000172 if (!tuple)
173 return -1;
174 if (PyList_Append(temp, tuple) < 0)
175 return -1;
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000176 Py_DECREF(tuple);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000177 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000178 if (mro_subclasses(subclass, temp) < 0)
179 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000180 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000181 return 0;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000182}
183
184static int
185type_set_bases(PyTypeObject *type, PyObject *value, void *context)
186{
187 int i, r = 0;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000188 PyObject *ob, *temp;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000189 PyTypeObject *new_base, *old_base;
190 PyObject *old_bases, *old_mro;
191
192 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
193 PyErr_Format(PyExc_TypeError,
194 "can't set %s.__bases__", type->tp_name);
195 return -1;
196 }
197 if (!value) {
198 PyErr_Format(PyExc_TypeError,
199 "can't delete %s.__bases__", type->tp_name);
200 return -1;
201 }
202 if (!PyTuple_Check(value)) {
203 PyErr_Format(PyExc_TypeError,
204 "can only assign tuple to %s.__bases__, not %s",
205 type->tp_name, value->ob_type->tp_name);
206 return -1;
207 }
Guido van Rossum3bbc0ee2002-12-13 17:49:38 +0000208 if (PyTuple_GET_SIZE(value) == 0) {
209 PyErr_Format(PyExc_TypeError,
210 "can only assign non-empty tuple to %s.__bases__, not ()",
211 type->tp_name);
212 return -1;
213 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000214 for (i = 0; i < PyTuple_GET_SIZE(value); i++) {
215 ob = PyTuple_GET_ITEM(value, i);
216 if (!PyClass_Check(ob) && !PyType_Check(ob)) {
217 PyErr_Format(
218 PyExc_TypeError,
219 "%s.__bases__ must be tuple of old- or new-style classes, not '%s'",
220 type->tp_name, ob->ob_type->tp_name);
221 return -1;
222 }
Michael W. Hudsoncaf17be2002-11-27 10:24:44 +0000223 if (PyType_Check(ob)) {
224 if (PyType_IsSubtype((PyTypeObject*)ob, type)) {
225 PyErr_SetString(PyExc_TypeError,
226 "a __bases__ item causes an inheritance cycle");
227 return -1;
228 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000229 }
230 }
231
232 new_base = best_base(value);
233
234 if (!new_base) {
235 return -1;
236 }
237
238 if (!compatible_for_assignment(type->tp_base, new_base, "__bases__"))
239 return -1;
240
241 Py_INCREF(new_base);
242 Py_INCREF(value);
243
244 old_bases = type->tp_bases;
245 old_base = type->tp_base;
246 old_mro = type->tp_mro;
247
248 type->tp_bases = value;
249 type->tp_base = new_base;
250
251 if (mro_internal(type) < 0) {
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000252 goto bail;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000253 }
254
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000255 temp = PyList_New(0);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000256 if (!temp)
257 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000258
259 r = mro_subclasses(type, temp);
260
261 if (r < 0) {
262 for (i = 0; i < PyList_Size(temp); i++) {
263 PyTypeObject* cls;
264 PyObject* mro;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000265 PyArg_UnpackTuple(PyList_GET_ITEM(temp, i),
266 "", 2, 2, &cls, &mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000267 Py_DECREF(cls->tp_mro);
268 cls->tp_mro = mro;
269 Py_INCREF(cls->tp_mro);
270 }
271 Py_DECREF(temp);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000272 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000273 }
274
275 Py_DECREF(temp);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000276
277 /* any base that was in __bases__ but now isn't, we
Raymond Hettingera8285862002-12-14 17:17:56 +0000278 need to remove |type| from its tp_subclasses.
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000279 conversely, any class now in __bases__ that wasn't
Raymond Hettingera8285862002-12-14 17:17:56 +0000280 needs to have |type| added to its subclasses. */
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000281
282 /* for now, sod that: just remove from all old_bases,
283 add to all new_bases */
284
285 for (i = PyTuple_GET_SIZE(old_bases) - 1; i >= 0; i--) {
286 ob = PyTuple_GET_ITEM(old_bases, i);
287 if (PyType_Check(ob)) {
288 remove_subclass(
289 (PyTypeObject*)ob, type);
290 }
291 }
292
293 for (i = PyTuple_GET_SIZE(value) - 1; i >= 0; i--) {
294 ob = PyTuple_GET_ITEM(value, i);
295 if (PyType_Check(ob)) {
296 if (add_subclass((PyTypeObject*)ob, type) < 0)
297 r = -1;
298 }
299 }
300
301 update_all_slots(type);
302
303 Py_DECREF(old_bases);
304 Py_DECREF(old_base);
305 Py_DECREF(old_mro);
306
307 return r;
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000308
309 bail:
Michael W. Hudsone723e452003-08-07 14:58:10 +0000310 Py_DECREF(type->tp_bases);
311 Py_DECREF(type->tp_base);
312 if (type->tp_mro != old_mro) {
313 Py_DECREF(type->tp_mro);
314 }
315
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000316 type->tp_bases = old_bases;
317 type->tp_base = old_base;
318 type->tp_mro = old_mro;
Tim Petersea7f75d2002-12-07 21:39:16 +0000319
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000320 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000321}
322
323static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000324type_dict(PyTypeObject *type, void *context)
325{
326 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000327 Py_INCREF(Py_None);
328 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000329 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000330 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000331}
332
Tim Peters24008312002-03-17 18:56:20 +0000333static PyObject *
334type_get_doc(PyTypeObject *type, void *context)
335{
336 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000337 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Tim Peters24008312002-03-17 18:56:20 +0000338 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000339 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000340 if (result == NULL) {
341 result = Py_None;
342 Py_INCREF(result);
343 }
344 else if (result->ob_type->tp_descr_get) {
Tim Peters2b858972002-04-18 04:12:28 +0000345 result = result->ob_type->tp_descr_get(result, NULL,
346 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000347 }
348 else {
349 Py_INCREF(result);
350 }
Tim Peters24008312002-03-17 18:56:20 +0000351 return result;
352}
353
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000354static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000355 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
356 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000357 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000358 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000359 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000360 {0}
361};
362
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000363static int
364type_compare(PyObject *v, PyObject *w)
365{
366 /* This is called with type objects only. So we
367 can just compare the addresses. */
368 Py_uintptr_t vv = (Py_uintptr_t)v;
369 Py_uintptr_t ww = (Py_uintptr_t)w;
370 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
371}
372
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000373static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000374type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000375{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000376 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000377 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000378
379 mod = type_module(type, NULL);
380 if (mod == NULL)
381 PyErr_Clear();
382 else if (!PyString_Check(mod)) {
383 Py_DECREF(mod);
384 mod = NULL;
385 }
386 name = type_name(type, NULL);
387 if (name == NULL)
388 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000389
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000390 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
391 kind = "class";
392 else
393 kind = "type";
394
Barry Warsaw7ce36942001-08-24 18:34:26 +0000395 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000396 rtn = PyString_FromFormat("<%s '%s.%s'>",
397 kind,
Barry Warsaw7ce36942001-08-24 18:34:26 +0000398 PyString_AS_STRING(mod),
399 PyString_AS_STRING(name));
400 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000401 else
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000402 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000403
Guido van Rossumc3542212001-08-16 09:18:56 +0000404 Py_XDECREF(mod);
405 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000406 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000407}
408
Tim Peters6d6c1a32001-08-02 04:15:00 +0000409static PyObject *
410type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
411{
412 PyObject *obj;
413
414 if (type->tp_new == NULL) {
415 PyErr_Format(PyExc_TypeError,
416 "cannot create '%.100s' instances",
417 type->tp_name);
418 return NULL;
419 }
420
Tim Peters3f996e72001-09-13 19:18:27 +0000421 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000422 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000423 /* Ugly exception: when the call was type(something),
424 don't call tp_init on the result. */
425 if (type == &PyType_Type &&
426 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
427 (kwds == NULL ||
428 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
429 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000430 /* If the returned object is not an instance of type,
431 it won't be initialized. */
432 if (!PyType_IsSubtype(obj->ob_type, type))
433 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000434 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000435 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
436 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000437 type->tp_init(obj, args, kwds) < 0) {
438 Py_DECREF(obj);
439 obj = NULL;
440 }
441 }
442 return obj;
443}
444
445PyObject *
446PyType_GenericAlloc(PyTypeObject *type, int nitems)
447{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000448 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000449 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
450 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000451
452 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000453 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000454 else
Neil Schemenauerc806c882001-08-29 23:54:54 +0000455 obj = PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000456
Neil Schemenauerc806c882001-08-29 23:54:54 +0000457 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000458 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000459
Neil Schemenauerc806c882001-08-29 23:54:54 +0000460 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000461
Tim Peters6d6c1a32001-08-02 04:15:00 +0000462 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
463 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000464
Tim Peters6d6c1a32001-08-02 04:15:00 +0000465 if (type->tp_itemsize == 0)
466 PyObject_INIT(obj, type);
467 else
468 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000469
Tim Peters6d6c1a32001-08-02 04:15:00 +0000470 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000471 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000472 return obj;
473}
474
475PyObject *
476PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
477{
478 return type->tp_alloc(type, 0);
479}
480
Guido van Rossum9475a232001-10-05 20:51:39 +0000481/* Helpers for subtyping */
482
483static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000484traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
485{
486 int i, n;
487 PyMemberDef *mp;
488
489 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000490 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000491 for (i = 0; i < n; i++, mp++) {
492 if (mp->type == T_OBJECT_EX) {
493 char *addr = (char *)self + mp->offset;
494 PyObject *obj = *(PyObject **)addr;
495 if (obj != NULL) {
496 int err = visit(obj, arg);
497 if (err)
498 return err;
499 }
500 }
501 }
502 return 0;
503}
504
505static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000506subtype_traverse(PyObject *self, visitproc visit, void *arg)
507{
508 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000509 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000510
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000511 /* Find the nearest base with a different tp_traverse,
512 and traverse slots while we're at it */
Guido van Rossum9475a232001-10-05 20:51:39 +0000513 type = self->ob_type;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000514 base = type;
515 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
516 if (base->ob_size) {
517 int err = traverse_slots(base, self, visit, arg);
518 if (err)
519 return err;
520 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000521 base = base->tp_base;
522 assert(base);
523 }
524
525 if (type->tp_dictoffset != base->tp_dictoffset) {
526 PyObject **dictptr = _PyObject_GetDictPtr(self);
527 if (dictptr && *dictptr) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000528 int err = visit(*dictptr, arg);
Guido van Rossum9475a232001-10-05 20:51:39 +0000529 if (err)
530 return err;
531 }
532 }
533
Guido van Rossuma3862092002-06-10 15:24:42 +0000534 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
535 /* For a heaptype, the instances count as references
536 to the type. Traverse the type so the collector
537 can find cycles involving this link. */
538 int err = visit((PyObject *)type, arg);
539 if (err)
540 return err;
541 }
542
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000543 if (basetraverse)
544 return basetraverse(self, visit, arg);
545 return 0;
546}
547
548static void
549clear_slots(PyTypeObject *type, PyObject *self)
550{
551 int i, n;
552 PyMemberDef *mp;
553
554 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000555 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000556 for (i = 0; i < n; i++, mp++) {
557 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
558 char *addr = (char *)self + mp->offset;
559 PyObject *obj = *(PyObject **)addr;
560 if (obj != NULL) {
561 Py_DECREF(obj);
562 *(PyObject **)addr = NULL;
563 }
564 }
565 }
566}
567
568static int
569subtype_clear(PyObject *self)
570{
571 PyTypeObject *type, *base;
572 inquiry baseclear;
573
574 /* Find the nearest base with a different tp_clear
575 and clear slots while we're at it */
576 type = self->ob_type;
577 base = type;
578 while ((baseclear = base->tp_clear) == subtype_clear) {
579 if (base->ob_size)
580 clear_slots(base, self);
581 base = base->tp_base;
582 assert(base);
583 }
584
Guido van Rossuma3862092002-06-10 15:24:42 +0000585 /* There's no need to clear the instance dict (if any);
586 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000587
588 if (baseclear)
589 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000590 return 0;
591}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000592
593static void
594subtype_dealloc(PyObject *self)
595{
Guido van Rossum14227b42001-12-06 02:35:58 +0000596 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000597 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000598
Guido van Rossum22b13872002-08-06 21:41:44 +0000599 /* Extract the type; we expect it to be a heap type */
600 type = self->ob_type;
601 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000602
Guido van Rossum22b13872002-08-06 21:41:44 +0000603 /* Test whether the type has GC exactly once */
604
605 if (!PyType_IS_GC(type)) {
606 /* It's really rare to find a dynamic type that doesn't have
607 GC; it can only happen when deriving from 'object' and not
608 adding any slots or instance variables. This allows
609 certain simplifications: there's no need to call
610 clear_slots(), or DECREF the dict, or clear weakrefs. */
611
612 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000613 if (type->tp_del) {
614 type->tp_del(self);
615 if (self->ob_refcnt > 0)
616 return;
617 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000618
619 /* Find the nearest base with a different tp_dealloc */
620 base = type;
621 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
622 assert(base->ob_size == 0);
623 base = base->tp_base;
624 assert(base);
625 }
626
627 /* Call the base tp_dealloc() */
628 assert(basedealloc);
629 basedealloc(self);
630
631 /* Can't reference self beyond this point */
632 Py_DECREF(type);
633
634 /* Done */
635 return;
636 }
637
638 /* We get here only if the type has GC */
639
640 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000641 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000642 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000643 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000644 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000645 --_PyTrash_delete_nesting;
Tim Petersf7f9e992003-11-13 21:59:32 +0000646 /* DO NOT restore GC tracking at this point. weakref callbacks
647 * (if any, and whether directly here or indirectly in something we
648 * call) may trigger GC, and if self is tracked at that point, it
649 * will look like trash to GC and GC will try to delete self again.
Tim Petersadd09b42003-11-12 20:43:28 +0000650 */
Guido van Rossum22b13872002-08-06 21:41:44 +0000651
Guido van Rossum59195fd2003-06-13 20:54:40 +0000652 /* Find the nearest base with a different tp_dealloc */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000653 base = type;
654 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000655 base = base->tp_base;
656 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000657 }
658
Guido van Rossum1987c662003-05-29 14:29:23 +0000659 /* If we added a weaklist, we clear it. Do this *before* calling
Guido van Rossum59195fd2003-06-13 20:54:40 +0000660 the finalizer (__del__), clearing slots, or clearing the instance
661 dict. */
662
Guido van Rossum1987c662003-05-29 14:29:23 +0000663 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
664 PyObject_ClearWeakRefs(self);
665
666 /* Maybe call finalizer; exit early if resurrected */
667 if (type->tp_del) {
Tim Petersf7f9e992003-11-13 21:59:32 +0000668 _PyObject_GC_TRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000669 type->tp_del(self);
670 if (self->ob_refcnt > 0)
Tim Petersf7f9e992003-11-13 21:59:32 +0000671 goto endlabel; /* resurrected */
672 else
673 _PyObject_GC_UNTRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000674 }
675
Guido van Rossum59195fd2003-06-13 20:54:40 +0000676 /* Clear slots up to the nearest base with a different tp_dealloc */
677 base = type;
678 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
679 if (base->ob_size)
680 clear_slots(base, self);
681 base = base->tp_base;
682 assert(base);
683 }
684
Tim Peters6d6c1a32001-08-02 04:15:00 +0000685 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000686 if (type->tp_dictoffset && !base->tp_dictoffset) {
687 PyObject **dictptr = _PyObject_GetDictPtr(self);
688 if (dictptr != NULL) {
689 PyObject *dict = *dictptr;
690 if (dict != NULL) {
691 Py_DECREF(dict);
692 *dictptr = NULL;
693 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000694 }
695 }
696
Tim Peters0bd743c2003-11-13 22:50:00 +0000697 /* Call the base tp_dealloc(); first retrack self if
698 * basedealloc knows about gc.
699 */
700 if (PyType_IS_GC(base))
701 _PyObject_GC_TRACK(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000702 assert(basedealloc);
703 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000704
705 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000706 Py_DECREF(type);
707
Guido van Rossum0906e072002-08-07 20:42:09 +0000708 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000709 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000710 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000711 --_PyTrash_delete_nesting;
712
713 /* Explanation of the weirdness around the trashcan macros:
714
715 Q. What do the trashcan macros do?
716
717 A. Read the comment titled "Trashcan mechanism" in object.h.
718 For one, this explains why there must be a call to GC-untrack
719 before the trashcan begin macro. Without understanding the
720 trashcan code, the answers to the following questions don't make
721 sense.
722
723 Q. Why do we GC-untrack before the trashcan and then immediately
724 GC-track again afterward?
725
726 A. In the case that the base class is GC-aware, the base class
727 probably GC-untracks the object. If it does that using the
728 UNTRACK macro, this will crash when the object is already
729 untracked. Because we don't know what the base class does, the
730 only safe thing is to make sure the object is tracked when we
731 call the base class dealloc. But... The trashcan begin macro
732 requires that the object is *untracked* before it is called. So
733 the dance becomes:
734
735 GC untrack
736 trashcan begin
737 GC track
738
Tim Petersf7f9e992003-11-13 21:59:32 +0000739 Q. Why did the last question say "immediately GC-track again"?
740 It's nowhere near immediately.
741
742 A. Because the code *used* to re-track immediately. Bad Idea.
743 self has a refcount of 0, and if gc ever gets its hands on it
744 (which can happen if any weakref callback gets invoked), it
745 looks like trash to gc too, and gc also tries to delete self
746 then. But we're already deleting self. Double dealloction is
747 a subtle disaster.
748
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000749 Q. Why the bizarre (net-zero) manipulation of
750 _PyTrash_delete_nesting around the trashcan macros?
751
752 A. Some base classes (e.g. list) also use the trashcan mechanism.
753 The following scenario used to be possible:
754
755 - suppose the trashcan level is one below the trashcan limit
756
757 - subtype_dealloc() is called
758
759 - the trashcan limit is not yet reached, so the trashcan level
760 is incremented and the code between trashcan begin and end is
761 executed
762
763 - this destroys much of the object's contents, including its
764 slots and __dict__
765
766 - basedealloc() is called; this is really list_dealloc(), or
767 some other type which also uses the trashcan macros
768
769 - the trashcan limit is now reached, so the object is put on the
770 trashcan's to-be-deleted-later list
771
772 - basedealloc() returns
773
774 - subtype_dealloc() decrefs the object's type
775
776 - subtype_dealloc() returns
777
778 - later, the trashcan code starts deleting the objects from its
779 to-be-deleted-later list
780
781 - subtype_dealloc() is called *AGAIN* for the same object
782
783 - at the very least (if the destroyed slots and __dict__ don't
784 cause problems) the object's type gets decref'ed a second
785 time, which is *BAD*!!!
786
787 The remedy is to make sure that if the code between trashcan
788 begin and end in subtype_dealloc() is called, the code between
789 trashcan begin and end in basedealloc() will also be called.
790 This is done by decrementing the level after passing into the
791 trashcan block, and incrementing it just before leaving the
792 block.
793
794 But now it's possible that a chain of objects consisting solely
795 of objects whose deallocator is subtype_dealloc() will defeat
796 the trashcan mechanism completely: the decremented level means
797 that the effective level never reaches the limit. Therefore, we
798 *increment* the level *before* entering the trashcan block, and
799 matchingly decrement it after leaving. This means the trashcan
800 code will trigger a little early, but that's no big deal.
801
802 Q. Are there any live examples of code in need of all this
803 complexity?
804
805 A. Yes. See SF bug 668433 for code that crashed (when Python was
806 compiled in debug mode) before the trashcan level manipulations
807 were added. For more discussion, see SF patches 581742, 575073
808 and bug 574207.
809 */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000810}
811
Jeremy Hylton938ace62002-07-17 16:30:39 +0000812static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000813
Tim Peters6d6c1a32001-08-02 04:15:00 +0000814/* type test with subclassing support */
815
816int
817PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
818{
819 PyObject *mro;
820
Guido van Rossum9478d072001-09-07 18:52:13 +0000821 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
822 return b == a || b == &PyBaseObject_Type;
823
Tim Peters6d6c1a32001-08-02 04:15:00 +0000824 mro = a->tp_mro;
825 if (mro != NULL) {
826 /* Deal with multiple inheritance without recursion
827 by walking the MRO tuple */
828 int i, n;
829 assert(PyTuple_Check(mro));
830 n = PyTuple_GET_SIZE(mro);
831 for (i = 0; i < n; i++) {
832 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
833 return 1;
834 }
835 return 0;
836 }
837 else {
838 /* a is not completely initilized yet; follow tp_base */
839 do {
840 if (a == b)
841 return 1;
842 a = a->tp_base;
843 } while (a != NULL);
844 return b == &PyBaseObject_Type;
845 }
846}
847
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000848/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +0000849 without looking in the instance dictionary
850 (so we can't use PyObject_GetAttr) but still binding
851 it to the instance. The arguments are the object,
852 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000853 static variable used to cache the interned Python string.
854
855 Two variants:
856
857 - lookup_maybe() returns NULL without raising an exception
858 when the _PyType_Lookup() call fails;
859
860 - lookup_method() always raises an exception upon errors.
861*/
Guido van Rossum60718732001-08-28 17:47:51 +0000862
863static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000864lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +0000865{
866 PyObject *res;
867
868 if (*attrobj == NULL) {
869 *attrobj = PyString_InternFromString(attrstr);
870 if (*attrobj == NULL)
871 return NULL;
872 }
873 res = _PyType_Lookup(self->ob_type, *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000874 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +0000875 descrgetfunc f;
876 if ((f = res->ob_type->tp_descr_get) == NULL)
877 Py_INCREF(res);
878 else
879 res = f(res, self, (PyObject *)(self->ob_type));
880 }
881 return res;
882}
883
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000884static PyObject *
885lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
886{
887 PyObject *res = lookup_maybe(self, attrstr, attrobj);
888 if (res == NULL && !PyErr_Occurred())
889 PyErr_SetObject(PyExc_AttributeError, *attrobj);
890 return res;
891}
892
Guido van Rossum2730b132001-08-28 18:22:14 +0000893/* A variation of PyObject_CallMethod that uses lookup_method()
894 instead of PyObject_GetAttrString(). This uses the same convention
895 as lookup_method to cache the interned name string object. */
896
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000897static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +0000898call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
899{
900 va_list va;
901 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +0000902 va_start(va, format);
903
Guido van Rossumda21c012001-10-03 00:50:18 +0000904 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000905 if (func == NULL) {
906 va_end(va);
907 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +0000908 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000909 return NULL;
910 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000911
912 if (format && *format)
913 args = Py_VaBuildValue(format, va);
914 else
915 args = PyTuple_New(0);
916
917 va_end(va);
918
919 if (args == NULL)
920 return NULL;
921
922 assert(PyTuple_Check(args));
923 retval = PyObject_Call(func, args, NULL);
924
925 Py_DECREF(args);
926 Py_DECREF(func);
927
928 return retval;
929}
930
931/* Clone of call_method() that returns NotImplemented when the lookup fails. */
932
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000933static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000934call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
935{
936 va_list va;
937 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000938 va_start(va, format);
939
Guido van Rossumda21c012001-10-03 00:50:18 +0000940 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +0000941 if (func == NULL) {
942 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000943 if (!PyErr_Occurred()) {
944 Py_INCREF(Py_NotImplemented);
945 return Py_NotImplemented;
946 }
Guido van Rossum717ce002001-09-14 16:58:08 +0000947 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +0000948 }
949
950 if (format && *format)
951 args = Py_VaBuildValue(format, va);
952 else
953 args = PyTuple_New(0);
954
955 va_end(va);
956
Guido van Rossum717ce002001-09-14 16:58:08 +0000957 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +0000958 return NULL;
959
Guido van Rossum717ce002001-09-14 16:58:08 +0000960 assert(PyTuple_Check(args));
961 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +0000962
963 Py_DECREF(args);
964 Py_DECREF(func);
965
966 return retval;
967}
968
Tim Petersa91e9642001-11-14 23:32:33 +0000969static int
970fill_classic_mro(PyObject *mro, PyObject *cls)
971{
972 PyObject *bases, *base;
973 int i, n;
974
975 assert(PyList_Check(mro));
976 assert(PyClass_Check(cls));
977 i = PySequence_Contains(mro, cls);
978 if (i < 0)
979 return -1;
980 if (!i) {
981 if (PyList_Append(mro, cls) < 0)
982 return -1;
983 }
984 bases = ((PyClassObject *)cls)->cl_bases;
985 assert(bases && PyTuple_Check(bases));
986 n = PyTuple_GET_SIZE(bases);
987 for (i = 0; i < n; i++) {
988 base = PyTuple_GET_ITEM(bases, i);
989 if (fill_classic_mro(mro, base) < 0)
990 return -1;
991 }
992 return 0;
993}
994
995static PyObject *
996classic_mro(PyObject *cls)
997{
998 PyObject *mro;
999
1000 assert(PyClass_Check(cls));
1001 mro = PyList_New(0);
1002 if (mro != NULL) {
1003 if (fill_classic_mro(mro, cls) == 0)
1004 return mro;
1005 Py_DECREF(mro);
1006 }
1007 return NULL;
1008}
1009
Tim Petersea7f75d2002-12-07 21:39:16 +00001010/*
Guido van Rossum1f121312002-11-14 19:49:16 +00001011 Method resolution order algorithm C3 described in
1012 "A Monotonic Superclass Linearization for Dylan",
1013 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +00001014 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +00001015 (OOPSLA 1996)
1016
Guido van Rossum98f33732002-11-25 21:36:54 +00001017 Some notes about the rules implied by C3:
1018
Tim Petersea7f75d2002-12-07 21:39:16 +00001019 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +00001020 It isn't legal to repeat a class in a list of base classes.
1021
1022 The next three properties are the 3 constraints in "C3".
1023
Tim Petersea7f75d2002-12-07 21:39:16 +00001024 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +00001025 If A precedes B in C's MRO, then A will precede B in the MRO of all
1026 subclasses of C.
1027
1028 Monotonicity.
1029 The MRO of a class must be an extension without reordering of the
1030 MRO of each of its superclasses.
1031
1032 Extended Precedence Graph (EPG).
1033 Linearization is consistent if there is a path in the EPG from
1034 each class to all its successors in the linearization. See
1035 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001036 */
1037
Tim Petersea7f75d2002-12-07 21:39:16 +00001038static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001039tail_contains(PyObject *list, int whence, PyObject *o) {
1040 int j, size;
1041 size = PyList_GET_SIZE(list);
1042
1043 for (j = whence+1; j < size; j++) {
1044 if (PyList_GET_ITEM(list, j) == o)
1045 return 1;
1046 }
1047 return 0;
1048}
1049
Guido van Rossum98f33732002-11-25 21:36:54 +00001050static PyObject *
1051class_name(PyObject *cls)
1052{
1053 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1054 if (name == NULL) {
1055 PyErr_Clear();
1056 Py_XDECREF(name);
1057 name = PyObject_Repr(cls);
1058 }
1059 if (name == NULL)
1060 return NULL;
1061 if (!PyString_Check(name)) {
1062 Py_DECREF(name);
1063 return NULL;
1064 }
1065 return name;
1066}
1067
1068static int
1069check_duplicates(PyObject *list)
1070{
1071 int i, j, n;
1072 /* Let's use a quadratic time algorithm,
1073 assuming that the bases lists is short.
1074 */
1075 n = PyList_GET_SIZE(list);
1076 for (i = 0; i < n; i++) {
1077 PyObject *o = PyList_GET_ITEM(list, i);
1078 for (j = i + 1; j < n; j++) {
1079 if (PyList_GET_ITEM(list, j) == o) {
1080 o = class_name(o);
1081 PyErr_Format(PyExc_TypeError,
1082 "duplicate base class %s",
1083 o ? PyString_AS_STRING(o) : "?");
1084 Py_XDECREF(o);
1085 return -1;
1086 }
1087 }
1088 }
1089 return 0;
1090}
1091
1092/* Raise a TypeError for an MRO order disagreement.
1093
1094 It's hard to produce a good error message. In the absence of better
1095 insight into error reporting, report the classes that were candidates
1096 to be put next into the MRO. There is some conflict between the
1097 order in which they should be put in the MRO, but it's hard to
1098 diagnose what constraint can't be satisfied.
1099*/
1100
1101static void
1102set_mro_error(PyObject *to_merge, int *remain)
1103{
1104 int i, n, off, to_merge_size;
1105 char buf[1000];
1106 PyObject *k, *v;
1107 PyObject *set = PyDict_New();
1108
1109 to_merge_size = PyList_GET_SIZE(to_merge);
1110 for (i = 0; i < to_merge_size; i++) {
1111 PyObject *L = PyList_GET_ITEM(to_merge, i);
1112 if (remain[i] < PyList_GET_SIZE(L)) {
1113 PyObject *c = PyList_GET_ITEM(L, remain[i]);
1114 if (PyDict_SetItem(set, c, Py_None) < 0)
1115 return;
1116 }
1117 }
1118 n = PyDict_Size(set);
1119
Raymond Hettingerf394df42003-04-06 19:13:41 +00001120 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1121consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001122 i = 0;
1123 while (PyDict_Next(set, &i, &k, &v) && off < sizeof(buf)) {
1124 PyObject *name = class_name(k);
1125 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
1126 name ? PyString_AS_STRING(name) : "?");
1127 Py_XDECREF(name);
1128 if (--n && off+1 < sizeof(buf)) {
1129 buf[off++] = ',';
1130 buf[off] = '\0';
1131 }
1132 }
1133 PyErr_SetString(PyExc_TypeError, buf);
1134 Py_DECREF(set);
1135}
1136
Tim Petersea7f75d2002-12-07 21:39:16 +00001137static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001138pmerge(PyObject *acc, PyObject* to_merge) {
1139 int i, j, to_merge_size;
1140 int *remain;
1141 int ok, empty_cnt;
Tim Petersea7f75d2002-12-07 21:39:16 +00001142
Guido van Rossum1f121312002-11-14 19:49:16 +00001143 to_merge_size = PyList_GET_SIZE(to_merge);
1144
Guido van Rossum98f33732002-11-25 21:36:54 +00001145 /* remain stores an index into each sublist of to_merge.
1146 remain[i] is the index of the next base in to_merge[i]
1147 that is not included in acc.
1148 */
Guido van Rossum1f121312002-11-14 19:49:16 +00001149 remain = PyMem_MALLOC(SIZEOF_INT*to_merge_size);
1150 if (remain == NULL)
1151 return -1;
1152 for (i = 0; i < to_merge_size; i++)
1153 remain[i] = 0;
1154
1155 again:
1156 empty_cnt = 0;
1157 for (i = 0; i < to_merge_size; i++) {
1158 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001159
Guido van Rossum1f121312002-11-14 19:49:16 +00001160 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1161
1162 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1163 empty_cnt++;
1164 continue;
1165 }
1166
Guido van Rossum98f33732002-11-25 21:36:54 +00001167 /* Choose next candidate for MRO.
1168
1169 The input sequences alone can determine the choice.
1170 If not, choose the class which appears in the MRO
1171 of the earliest direct superclass of the new class.
1172 */
1173
Guido van Rossum1f121312002-11-14 19:49:16 +00001174 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1175 for (j = 0; j < to_merge_size; j++) {
1176 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001177 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001178 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001179 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001180 }
1181 ok = PyList_Append(acc, candidate);
1182 if (ok < 0) {
1183 PyMem_Free(remain);
1184 return -1;
1185 }
1186 for (j = 0; j < to_merge_size; j++) {
1187 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001188 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1189 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001190 remain[j]++;
1191 }
1192 }
1193 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001194 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001195 }
1196
Guido van Rossum98f33732002-11-25 21:36:54 +00001197 if (empty_cnt == to_merge_size) {
1198 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001199 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001200 }
1201 set_mro_error(to_merge, remain);
1202 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001203 return -1;
1204}
1205
Tim Peters6d6c1a32001-08-02 04:15:00 +00001206static PyObject *
1207mro_implementation(PyTypeObject *type)
1208{
1209 int i, n, ok;
1210 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001211 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001212
Guido van Rossum63517572002-06-18 16:44:57 +00001213 if(type->tp_dict == NULL) {
1214 if(PyType_Ready(type) < 0)
1215 return NULL;
1216 }
1217
Guido van Rossum98f33732002-11-25 21:36:54 +00001218 /* Find a superclass linearization that honors the constraints
1219 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001220 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001221
1222 to_merge is a list of lists, where each list is a superclass
1223 linearization implied by a base class. The last element of
1224 to_merge is the declared list of bases.
1225 */
1226
Tim Peters6d6c1a32001-08-02 04:15:00 +00001227 bases = type->tp_bases;
1228 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001229
1230 to_merge = PyList_New(n+1);
1231 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001232 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001233
Tim Peters6d6c1a32001-08-02 04:15:00 +00001234 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001235 PyObject *base = PyTuple_GET_ITEM(bases, i);
1236 PyObject *parentMRO;
1237 if (PyType_Check(base))
1238 parentMRO = PySequence_List(
1239 ((PyTypeObject*)base)->tp_mro);
1240 else
1241 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001242 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001243 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001244 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001245 }
1246
1247 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001248 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001249
1250 bases_aslist = PySequence_List(bases);
1251 if (bases_aslist == NULL) {
1252 Py_DECREF(to_merge);
1253 return NULL;
1254 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001255 /* This is just a basic sanity check. */
1256 if (check_duplicates(bases_aslist) < 0) {
1257 Py_DECREF(to_merge);
1258 Py_DECREF(bases_aslist);
1259 return NULL;
1260 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001261 PyList_SET_ITEM(to_merge, n, bases_aslist);
1262
1263 result = Py_BuildValue("[O]", (PyObject *)type);
1264 if (result == NULL) {
1265 Py_DECREF(to_merge);
1266 return NULL;
1267 }
1268
1269 ok = pmerge(result, to_merge);
1270 Py_DECREF(to_merge);
1271 if (ok < 0) {
1272 Py_DECREF(result);
1273 return NULL;
1274 }
1275
Tim Peters6d6c1a32001-08-02 04:15:00 +00001276 return result;
1277}
1278
1279static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001280mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001281{
1282 PyTypeObject *type = (PyTypeObject *)self;
1283
Tim Peters6d6c1a32001-08-02 04:15:00 +00001284 return mro_implementation(type);
1285}
1286
1287static int
1288mro_internal(PyTypeObject *type)
1289{
1290 PyObject *mro, *result, *tuple;
1291
1292 if (type->ob_type == &PyType_Type) {
1293 result = mro_implementation(type);
1294 }
1295 else {
Guido van Rossum60718732001-08-28 17:47:51 +00001296 static PyObject *mro_str;
1297 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001298 if (mro == NULL)
1299 return -1;
1300 result = PyObject_CallObject(mro, NULL);
1301 Py_DECREF(mro);
1302 }
1303 if (result == NULL)
1304 return -1;
1305 tuple = PySequence_Tuple(result);
1306 Py_DECREF(result);
1307 type->tp_mro = tuple;
1308 return 0;
1309}
1310
1311
1312/* Calculate the best base amongst multiple base classes.
1313 This is the first one that's on the path to the "solid base". */
1314
1315static PyTypeObject *
1316best_base(PyObject *bases)
1317{
1318 int i, n;
1319 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001320 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001321
1322 assert(PyTuple_Check(bases));
1323 n = PyTuple_GET_SIZE(bases);
1324 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001325 base = NULL;
1326 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001327 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001328 base_proto = PyTuple_GET_ITEM(bases, i);
1329 if (PyClass_Check(base_proto))
1330 continue;
1331 if (!PyType_Check(base_proto)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001332 PyErr_SetString(
1333 PyExc_TypeError,
1334 "bases must be types");
1335 return NULL;
1336 }
Tim Petersa91e9642001-11-14 23:32:33 +00001337 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001338 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001339 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001340 return NULL;
1341 }
1342 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001343 if (winner == NULL) {
1344 winner = candidate;
1345 base = base_i;
1346 }
1347 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001348 ;
1349 else if (PyType_IsSubtype(candidate, winner)) {
1350 winner = candidate;
1351 base = base_i;
1352 }
1353 else {
1354 PyErr_SetString(
1355 PyExc_TypeError,
1356 "multiple bases have "
1357 "instance lay-out conflict");
1358 return NULL;
1359 }
1360 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001361 if (base == NULL)
1362 PyErr_SetString(PyExc_TypeError,
1363 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001364 return base;
1365}
1366
1367static int
1368extra_ivars(PyTypeObject *type, PyTypeObject *base)
1369{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001370 size_t t_size = type->tp_basicsize;
1371 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001372
Guido van Rossum9676b222001-08-17 20:32:36 +00001373 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001374 if (type->tp_itemsize || base->tp_itemsize) {
1375 /* If itemsize is involved, stricter rules */
1376 return t_size != b_size ||
1377 type->tp_itemsize != base->tp_itemsize;
1378 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001379 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
1380 type->tp_weaklistoffset + sizeof(PyObject *) == t_size)
1381 t_size -= sizeof(PyObject *);
1382 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
1383 type->tp_dictoffset + sizeof(PyObject *) == t_size)
1384 t_size -= sizeof(PyObject *);
1385
1386 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001387}
1388
1389static PyTypeObject *
1390solid_base(PyTypeObject *type)
1391{
1392 PyTypeObject *base;
1393
1394 if (type->tp_base)
1395 base = solid_base(type->tp_base);
1396 else
1397 base = &PyBaseObject_Type;
1398 if (extra_ivars(type, base))
1399 return type;
1400 else
1401 return base;
1402}
1403
Jeremy Hylton938ace62002-07-17 16:30:39 +00001404static void object_dealloc(PyObject *);
1405static int object_init(PyObject *, PyObject *, PyObject *);
1406static int update_slot(PyTypeObject *, PyObject *);
1407static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001408
1409static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001410subtype_dict(PyObject *obj, void *context)
1411{
1412 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1413 PyObject *dict;
1414
1415 if (dictptr == NULL) {
1416 PyErr_SetString(PyExc_AttributeError,
1417 "This object has no __dict__");
1418 return NULL;
1419 }
1420 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001421 if (dict == NULL)
1422 *dictptr = dict = PyDict_New();
1423 Py_XINCREF(dict);
1424 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001425}
1426
Guido van Rossum6661be32001-10-26 04:26:12 +00001427static int
1428subtype_setdict(PyObject *obj, PyObject *value, void *context)
1429{
1430 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1431 PyObject *dict;
1432
1433 if (dictptr == NULL) {
1434 PyErr_SetString(PyExc_AttributeError,
1435 "This object has no __dict__");
1436 return -1;
1437 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001438 if (value != NULL && !PyDict_Check(value)) {
Guido van Rossum6661be32001-10-26 04:26:12 +00001439 PyErr_SetString(PyExc_TypeError,
1440 "__dict__ must be set to a dictionary");
1441 return -1;
1442 }
1443 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001444 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001445 *dictptr = value;
1446 Py_XDECREF(dict);
1447 return 0;
1448}
1449
Guido van Rossumad47da02002-08-12 19:05:44 +00001450static PyObject *
1451subtype_getweakref(PyObject *obj, void *context)
1452{
1453 PyObject **weaklistptr;
1454 PyObject *result;
1455
1456 if (obj->ob_type->tp_weaklistoffset == 0) {
1457 PyErr_SetString(PyExc_AttributeError,
1458 "This object has no __weaklist__");
1459 return NULL;
1460 }
1461 assert(obj->ob_type->tp_weaklistoffset > 0);
1462 assert(obj->ob_type->tp_weaklistoffset + sizeof(PyObject *) <=
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001463 (size_t)(obj->ob_type->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001464 weaklistptr = (PyObject **)
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001465 ((char *)obj + obj->ob_type->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001466 if (*weaklistptr == NULL)
1467 result = Py_None;
1468 else
1469 result = *weaklistptr;
1470 Py_INCREF(result);
1471 return result;
1472}
1473
Guido van Rossum373c7412003-01-07 13:41:37 +00001474/* Three variants on the subtype_getsets list. */
1475
1476static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001477 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001478 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001479 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001480 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001481 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001482};
1483
Guido van Rossum373c7412003-01-07 13:41:37 +00001484static PyGetSetDef subtype_getsets_dict_only[] = {
1485 {"__dict__", subtype_dict, subtype_setdict,
1486 PyDoc_STR("dictionary for instance variables (if defined)")},
1487 {0}
1488};
1489
1490static PyGetSetDef subtype_getsets_weakref_only[] = {
1491 {"__weakref__", subtype_getweakref, NULL,
1492 PyDoc_STR("list of weak references to the object (if defined)")},
1493 {0}
1494};
1495
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001496static int
1497valid_identifier(PyObject *s)
1498{
Guido van Rossum03013a02002-07-16 14:30:28 +00001499 unsigned char *p;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001500 int i, n;
1501
1502 if (!PyString_Check(s)) {
1503 PyErr_SetString(PyExc_TypeError,
1504 "__slots__ must be strings");
1505 return 0;
1506 }
Guido van Rossum03013a02002-07-16 14:30:28 +00001507 p = (unsigned char *) PyString_AS_STRING(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001508 n = PyString_GET_SIZE(s);
1509 /* We must reject an empty name. As a hack, we bump the
1510 length to 1 so that the loop will balk on the trailing \0. */
1511 if (n == 0)
1512 n = 1;
1513 for (i = 0; i < n; i++, p++) {
1514 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1515 PyErr_SetString(PyExc_TypeError,
1516 "__slots__ must be identifiers");
1517 return 0;
1518 }
1519 }
1520 return 1;
1521}
1522
Martin v. Löwisd919a592002-10-14 21:07:28 +00001523#ifdef Py_USING_UNICODE
1524/* Replace Unicode objects in slots. */
1525
1526static PyObject *
1527_unicode_to_string(PyObject *slots, int nslots)
1528{
1529 PyObject *tmp = slots;
1530 PyObject *o, *o1;
1531 int i;
1532 intintargfunc copy = slots->ob_type->tp_as_sequence->sq_slice;
1533 for (i = 0; i < nslots; i++) {
1534 if (PyUnicode_Check(o = PyTuple_GET_ITEM(tmp, i))) {
1535 if (tmp == slots) {
1536 tmp = copy(slots, 0, PyTuple_GET_SIZE(slots));
1537 if (tmp == NULL)
1538 return NULL;
1539 }
1540 o1 = _PyUnicode_AsDefaultEncodedString
1541 (o, NULL);
1542 if (o1 == NULL) {
1543 Py_DECREF(tmp);
1544 return 0;
1545 }
1546 Py_INCREF(o1);
1547 Py_DECREF(o);
1548 PyTuple_SET_ITEM(tmp, i, o1);
1549 }
1550 }
1551 return tmp;
1552}
1553#endif
1554
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001555static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001556type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1557{
1558 PyObject *name, *bases, *dict;
1559 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001560 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001561 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001562 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00001563 PyMemberDef *mp;
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00001564 int i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00001565 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001566
Tim Peters3abca122001-10-27 19:37:48 +00001567 assert(args != NULL && PyTuple_Check(args));
1568 assert(kwds == NULL || PyDict_Check(kwds));
1569
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001570 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00001571 {
1572 const int nargs = PyTuple_GET_SIZE(args);
1573 const int nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
1574
1575 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
1576 PyObject *x = PyTuple_GET_ITEM(args, 0);
1577 Py_INCREF(x->ob_type);
1578 return (PyObject *) x->ob_type;
1579 }
1580
1581 /* SF bug 475327 -- if that didn't trigger, we need 3
1582 arguments. but PyArg_ParseTupleAndKeywords below may give
1583 a msg saying type() needs exactly 3. */
1584 if (nargs + nkwds != 3) {
1585 PyErr_SetString(PyExc_TypeError,
1586 "type() takes 1 or 3 arguments");
1587 return NULL;
1588 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001589 }
1590
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001591 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001592 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
1593 &name,
1594 &PyTuple_Type, &bases,
1595 &PyDict_Type, &dict))
1596 return NULL;
1597
1598 /* Determine the proper metatype to deal with this,
1599 and check for metatype conflicts while we're at it.
1600 Note that if some other metatype wins to contract,
1601 it's possible that its instances are not types. */
1602 nbases = PyTuple_GET_SIZE(bases);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001603 winner = metatype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001604 for (i = 0; i < nbases; i++) {
1605 tmp = PyTuple_GET_ITEM(bases, i);
1606 tmptype = tmp->ob_type;
Tim Petersa91e9642001-11-14 23:32:33 +00001607 if (tmptype == &PyClass_Type)
1608 continue; /* Special case classic classes */
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001609 if (PyType_IsSubtype(winner, tmptype))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001610 continue;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001611 if (PyType_IsSubtype(tmptype, winner)) {
1612 winner = tmptype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001613 continue;
1614 }
1615 PyErr_SetString(PyExc_TypeError,
Guido van Rossum636688d2003-04-23 12:07:22 +00001616 "metaclass conflict: "
1617 "the metaclass of a derived class "
1618 "must be a (non-strict) subclass "
1619 "of the metaclasses of all its bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001620 return NULL;
1621 }
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001622 if (winner != metatype) {
1623 if (winner->tp_new != type_new) /* Pass it to the winner */
1624 return winner->tp_new(winner, args, kwds);
1625 metatype = winner;
1626 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001627
1628 /* Adjust for empty tuple bases */
1629 if (nbases == 0) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001630 bases = PyTuple_Pack(1, &PyBaseObject_Type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001631 if (bases == NULL)
1632 return NULL;
1633 nbases = 1;
1634 }
1635 else
1636 Py_INCREF(bases);
1637
1638 /* XXX From here until type is allocated, "return NULL" leaks bases! */
1639
1640 /* Calculate best base, and check that all bases are type objects */
1641 base = best_base(bases);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001642 if (base == NULL) {
1643 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001644 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001645 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001646 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
1647 PyErr_Format(PyExc_TypeError,
1648 "type '%.100s' is not an acceptable base type",
1649 base->tp_name);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001650 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001651 return NULL;
1652 }
1653
Tim Peters6d6c1a32001-08-02 04:15:00 +00001654 /* Check for a __slots__ sequence variable in dict, and count it */
1655 slots = PyDict_GetItemString(dict, "__slots__");
1656 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00001657 add_dict = 0;
1658 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00001659 may_add_dict = base->tp_dictoffset == 0;
1660 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
1661 if (slots == NULL) {
1662 if (may_add_dict) {
1663 add_dict++;
1664 }
1665 if (may_add_weak) {
1666 add_weak++;
1667 }
1668 }
1669 else {
1670 /* Have slots */
1671
Tim Peters6d6c1a32001-08-02 04:15:00 +00001672 /* Make it into a tuple */
1673 if (PyString_Check(slots))
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001674 slots = PyTuple_Pack(1, slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001675 else
1676 slots = PySequence_Tuple(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001677 if (slots == NULL) {
1678 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001679 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001680 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001681 assert(PyTuple_Check(slots));
1682
1683 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001684 nslots = PyTuple_GET_SIZE(slots);
Jeremy Hylton1c7a0ea2003-07-16 16:08:23 +00001685 if (nslots > 0 && base->tp_itemsize != 0) {
Guido van Rossumc4141872001-08-30 04:43:35 +00001686 PyErr_Format(PyExc_TypeError,
1687 "nonempty __slots__ "
1688 "not supported for subtype of '%s'",
1689 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00001690 bad_slots:
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001691 Py_DECREF(bases);
Guido van Rossumad47da02002-08-12 19:05:44 +00001692 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001693 return NULL;
1694 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001695
Martin v. Löwisd919a592002-10-14 21:07:28 +00001696#ifdef Py_USING_UNICODE
1697 tmp = _unicode_to_string(slots, nslots);
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00001698 if (tmp != slots) {
1699 Py_DECREF(slots);
1700 slots = tmp;
1701 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00001702 if (!tmp)
1703 return NULL;
1704#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00001705 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001706 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001707 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
1708 char *s;
1709 if (!valid_identifier(tmp))
1710 goto bad_slots;
1711 assert(PyString_Check(tmp));
1712 s = PyString_AS_STRING(tmp);
1713 if (strcmp(s, "__dict__") == 0) {
1714 if (!may_add_dict || add_dict) {
1715 PyErr_SetString(PyExc_TypeError,
1716 "__dict__ slot disallowed: "
1717 "we already got one");
1718 goto bad_slots;
1719 }
1720 add_dict++;
1721 }
1722 if (strcmp(s, "__weakref__") == 0) {
1723 if (!may_add_weak || add_weak) {
1724 PyErr_SetString(PyExc_TypeError,
1725 "__weakref__ slot disallowed: "
1726 "either we already got one, "
1727 "or __itemsize__ != 0");
1728 goto bad_slots;
1729 }
1730 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001731 }
1732 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001733
Guido van Rossumad47da02002-08-12 19:05:44 +00001734 /* Copy slots into yet another tuple, demangling names */
1735 newslots = PyTuple_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001736 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00001737 goto bad_slots;
1738 for (i = j = 0; i < nslots; i++) {
1739 char *s;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001740 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001741 s = PyString_AS_STRING(tmp);
1742 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1743 (add_weak && strcmp(s, "__weakref__") == 0))
1744 continue;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001745 tmp =_Py_Mangle(name, tmp);
1746 if (!tmp)
1747 goto bad_slots;
Guido van Rossumad47da02002-08-12 19:05:44 +00001748 PyTuple_SET_ITEM(newslots, j, tmp);
1749 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001750 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001751 assert(j == nslots - add_dict - add_weak);
1752 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001753 Py_DECREF(slots);
1754 slots = newslots;
1755
Guido van Rossumad47da02002-08-12 19:05:44 +00001756 /* Secondary bases may provide weakrefs or dict */
1757 if (nbases > 1 &&
1758 ((may_add_dict && !add_dict) ||
1759 (may_add_weak && !add_weak))) {
1760 for (i = 0; i < nbases; i++) {
1761 tmp = PyTuple_GET_ITEM(bases, i);
1762 if (tmp == (PyObject *)base)
1763 continue; /* Skip primary base */
1764 if (PyClass_Check(tmp)) {
1765 /* Classic base class provides both */
1766 if (may_add_dict && !add_dict)
1767 add_dict++;
1768 if (may_add_weak && !add_weak)
1769 add_weak++;
1770 break;
1771 }
1772 assert(PyType_Check(tmp));
1773 tmptype = (PyTypeObject *)tmp;
1774 if (may_add_dict && !add_dict &&
1775 tmptype->tp_dictoffset != 0)
1776 add_dict++;
1777 if (may_add_weak && !add_weak &&
1778 tmptype->tp_weaklistoffset != 0)
1779 add_weak++;
1780 if (may_add_dict && !add_dict)
1781 continue;
1782 if (may_add_weak && !add_weak)
1783 continue;
1784 /* Nothing more to check */
1785 break;
1786 }
1787 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001788 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001789
1790 /* XXX From here until type is safely allocated,
1791 "return NULL" may leak slots! */
1792
1793 /* Allocate the type object */
1794 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001795 if (type == NULL) {
1796 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001797 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001798 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001799 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001800
1801 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001802 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001803 Py_INCREF(name);
1804 et->name = name;
1805 et->slots = slots;
1806
Guido van Rossumdc91b992001-08-08 22:26:22 +00001807 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001808 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1809 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001810 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1811 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001812
1813 /* It's a new-style number unless it specifically inherits any
1814 old-style numeric behavior */
1815 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1816 (base->tp_as_number == NULL))
1817 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1818
1819 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001820 type->tp_as_number = &et->as_number;
1821 type->tp_as_sequence = &et->as_sequence;
1822 type->tp_as_mapping = &et->as_mapping;
1823 type->tp_as_buffer = &et->as_buffer;
1824 type->tp_name = PyString_AS_STRING(name);
1825
1826 /* Set tp_base and tp_bases */
1827 type->tp_bases = bases;
1828 Py_INCREF(base);
1829 type->tp_base = base;
1830
Guido van Rossum687ae002001-10-15 22:03:32 +00001831 /* Initialize tp_dict from passed-in dict */
1832 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001833 if (dict == NULL) {
1834 Py_DECREF(type);
1835 return NULL;
1836 }
1837
Guido van Rossumc3542212001-08-16 09:18:56 +00001838 /* Set __module__ in the dict */
1839 if (PyDict_GetItemString(dict, "__module__") == NULL) {
1840 tmp = PyEval_GetGlobals();
1841 if (tmp != NULL) {
1842 tmp = PyDict_GetItemString(tmp, "__name__");
1843 if (tmp != NULL) {
1844 if (PyDict_SetItemString(dict, "__module__",
1845 tmp) < 0)
1846 return NULL;
1847 }
1848 }
1849 }
1850
Tim Peters2f93e282001-10-04 05:27:00 +00001851 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00001852 and is a string. The __doc__ accessor will first look for tp_doc;
1853 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00001854 */
1855 {
1856 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
1857 if (doc != NULL && PyString_Check(doc)) {
1858 const size_t n = (size_t)PyString_GET_SIZE(doc);
Tim Peters59f809d2001-10-04 05:43:02 +00001859 type->tp_doc = (char *)PyObject_MALLOC(n+1);
Tim Peters2f93e282001-10-04 05:27:00 +00001860 if (type->tp_doc == NULL) {
1861 Py_DECREF(type);
1862 return NULL;
1863 }
1864 memcpy(type->tp_doc, PyString_AS_STRING(doc), n+1);
1865 }
1866 }
1867
Tim Peters6d6c1a32001-08-02 04:15:00 +00001868 /* Special-case __new__: if it's a plain function,
1869 make it a static function */
1870 tmp = PyDict_GetItemString(dict, "__new__");
1871 if (tmp != NULL && PyFunction_Check(tmp)) {
1872 tmp = PyStaticMethod_New(tmp);
1873 if (tmp == NULL) {
1874 Py_DECREF(type);
1875 return NULL;
1876 }
1877 PyDict_SetItemString(dict, "__new__", tmp);
1878 Py_DECREF(tmp);
1879 }
1880
1881 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001882 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00001883 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001884 if (slots != NULL) {
1885 for (i = 0; i < nslots; i++, mp++) {
1886 mp->name = PyString_AS_STRING(
1887 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00001888 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001889 mp->offset = slotoffset;
Guido van Rossum9676b222001-08-17 20:32:36 +00001890 if (base->tp_weaklistoffset == 0 &&
Guido van Rossum64b206c2001-12-04 17:13:22 +00001891 strcmp(mp->name, "__weakref__") == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001892 add_weak++;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001893 mp->type = T_OBJECT;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001894 mp->flags = READONLY;
Guido van Rossum9676b222001-08-17 20:32:36 +00001895 type->tp_weaklistoffset = slotoffset;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001896 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001897 slotoffset += sizeof(PyObject *);
1898 }
1899 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001900 if (add_dict) {
1901 if (base->tp_itemsize)
1902 type->tp_dictoffset = -(long)sizeof(PyObject *);
1903 else
1904 type->tp_dictoffset = slotoffset;
1905 slotoffset += sizeof(PyObject *);
1906 }
1907 if (add_weak) {
1908 assert(!base->tp_itemsize);
1909 type->tp_weaklistoffset = slotoffset;
1910 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001911 }
1912 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001913 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001914 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00001915
1916 if (type->tp_weaklistoffset && type->tp_dictoffset)
1917 type->tp_getset = subtype_getsets_full;
1918 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
1919 type->tp_getset = subtype_getsets_weakref_only;
1920 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
1921 type->tp_getset = subtype_getsets_dict_only;
1922 else
1923 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001924
1925 /* Special case some slots */
1926 if (type->tp_dictoffset != 0 || nslots > 0) {
1927 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
1928 type->tp_getattro = PyObject_GenericGetAttr;
1929 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
1930 type->tp_setattro = PyObject_GenericSetAttr;
1931 }
1932 type->tp_dealloc = subtype_dealloc;
1933
Guido van Rossum9475a232001-10-05 20:51:39 +00001934 /* Enable GC unless there are really no instance variables possible */
1935 if (!(type->tp_basicsize == sizeof(PyObject) &&
1936 type->tp_itemsize == 0))
1937 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
1938
Tim Peters6d6c1a32001-08-02 04:15:00 +00001939 /* Always override allocation strategy to use regular heap */
1940 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00001941 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001942 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00001943 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001944 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00001945 }
1946 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001947 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001948
1949 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001950 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001951 Py_DECREF(type);
1952 return NULL;
1953 }
1954
Guido van Rossum7b9144b2001-10-09 19:39:46 +00001955 /* Put the proper slots in place */
1956 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00001957
Tim Peters6d6c1a32001-08-02 04:15:00 +00001958 return (PyObject *)type;
1959}
1960
1961/* Internal API to look for a name through the MRO.
1962 This returns a borrowed reference, and doesn't set an exception! */
1963PyObject *
1964_PyType_Lookup(PyTypeObject *type, PyObject *name)
1965{
1966 int i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00001967 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001968
Guido van Rossum687ae002001-10-15 22:03:32 +00001969 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001970 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00001971
1972 /* If mro is NULL, the type is either not yet initialized
1973 by PyType_Ready(), or already cleared by type_clear().
1974 Either way the safest thing to do is to return NULL. */
1975 if (mro == NULL)
1976 return NULL;
1977
Tim Peters6d6c1a32001-08-02 04:15:00 +00001978 assert(PyTuple_Check(mro));
1979 n = PyTuple_GET_SIZE(mro);
1980 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001981 base = PyTuple_GET_ITEM(mro, i);
1982 if (PyClass_Check(base))
1983 dict = ((PyClassObject *)base)->cl_dict;
1984 else {
1985 assert(PyType_Check(base));
1986 dict = ((PyTypeObject *)base)->tp_dict;
1987 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001988 assert(dict && PyDict_Check(dict));
1989 res = PyDict_GetItem(dict, name);
1990 if (res != NULL)
1991 return res;
1992 }
1993 return NULL;
1994}
1995
1996/* This is similar to PyObject_GenericGetAttr(),
1997 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
1998static PyObject *
1999type_getattro(PyTypeObject *type, PyObject *name)
2000{
2001 PyTypeObject *metatype = type->ob_type;
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002002 PyObject *meta_attribute, *attribute;
2003 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002004
2005 /* Initialize this type (we'll assume the metatype is initialized) */
2006 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002007 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002008 return NULL;
2009 }
2010
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002011 /* No readable descriptor found yet */
2012 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002013
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002014 /* Look for the attribute in the metatype */
2015 meta_attribute = _PyType_Lookup(metatype, name);
2016
2017 if (meta_attribute != NULL) {
2018 meta_get = meta_attribute->ob_type->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002019
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002020 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2021 /* Data descriptors implement tp_descr_set to intercept
2022 * writes. Assume the attribute is not overridden in
2023 * type's tp_dict (and bases): call the descriptor now.
2024 */
2025 return meta_get(meta_attribute, (PyObject *)type,
2026 (PyObject *)metatype);
2027 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002028 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002029 }
2030
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002031 /* No data descriptor found on metatype. Look in tp_dict of this
2032 * type and its bases */
2033 attribute = _PyType_Lookup(type, name);
2034 if (attribute != NULL) {
2035 /* Implement descriptor functionality, if any */
2036 descrgetfunc local_get = attribute->ob_type->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002037
2038 Py_XDECREF(meta_attribute);
2039
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002040 if (local_get != NULL) {
2041 /* NULL 2nd argument indicates the descriptor was
2042 * found on the target object itself (or a base) */
2043 return local_get(attribute, (PyObject *)NULL,
2044 (PyObject *)type);
2045 }
Tim Peters34592512002-07-11 06:23:50 +00002046
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002047 Py_INCREF(attribute);
2048 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002049 }
2050
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002051 /* No attribute found in local __dict__ (or bases): use the
2052 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002053 if (meta_get != NULL) {
2054 PyObject *res;
2055 res = meta_get(meta_attribute, (PyObject *)type,
2056 (PyObject *)metatype);
2057 Py_DECREF(meta_attribute);
2058 return res;
2059 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002060
2061 /* If an ordinary attribute was found on the metatype, return it now */
2062 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002063 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002064 }
2065
2066 /* Give up */
2067 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002068 "type object '%.50s' has no attribute '%.400s'",
2069 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002070 return NULL;
2071}
2072
2073static int
2074type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2075{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002076 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2077 PyErr_Format(
2078 PyExc_TypeError,
2079 "can't set attributes of built-in/extension type '%s'",
2080 type->tp_name);
2081 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002082 }
Guido van Rossum8d24ee92003-03-24 23:49:49 +00002083 /* XXX Example of how I expect this to be used...
2084 if (update_subclasses(type, name, invalidate_cache, NULL) < 0)
2085 return -1;
2086 */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002087 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2088 return -1;
2089 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002090}
2091
2092static void
2093type_dealloc(PyTypeObject *type)
2094{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002095 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002096
2097 /* Assert this is a heap-allocated type object */
2098 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002099 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002100 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002101 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002102 Py_XDECREF(type->tp_base);
2103 Py_XDECREF(type->tp_dict);
2104 Py_XDECREF(type->tp_bases);
2105 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002106 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002107 Py_XDECREF(type->tp_subclasses);
Neal Norwitzcee5ca02002-07-30 00:42:06 +00002108 PyObject_Free(type->tp_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002109 Py_XDECREF(et->name);
2110 Py_XDECREF(et->slots);
2111 type->ob_type->tp_free((PyObject *)type);
2112}
2113
Guido van Rossum1c450732001-10-08 15:18:27 +00002114static PyObject *
2115type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2116{
2117 PyObject *list, *raw, *ref;
2118 int i, n;
2119
2120 list = PyList_New(0);
2121 if (list == NULL)
2122 return NULL;
2123 raw = type->tp_subclasses;
2124 if (raw == NULL)
2125 return list;
2126 assert(PyList_Check(raw));
2127 n = PyList_GET_SIZE(raw);
2128 for (i = 0; i < n; i++) {
2129 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002130 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002131 ref = PyWeakref_GET_OBJECT(ref);
2132 if (ref != Py_None) {
2133 if (PyList_Append(list, ref) < 0) {
2134 Py_DECREF(list);
2135 return NULL;
2136 }
2137 }
2138 }
2139 return list;
2140}
2141
Tim Peters6d6c1a32001-08-02 04:15:00 +00002142static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002143 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002144 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002145 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002146 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002147 {0}
2148};
2149
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002150PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002151"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002152"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002153
Guido van Rossum048eb752001-10-02 21:24:57 +00002154static int
2155type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2156{
Guido van Rossum048eb752001-10-02 21:24:57 +00002157 int err;
2158
Guido van Rossuma3862092002-06-10 15:24:42 +00002159 /* Because of type_is_gc(), the collector only calls this
2160 for heaptypes. */
2161 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002162
2163#define VISIT(SLOT) \
2164 if (SLOT) { \
2165 err = visit((PyObject *)(SLOT), arg); \
2166 if (err) \
2167 return err; \
2168 }
2169
2170 VISIT(type->tp_dict);
Guido van Rossum687ae002001-10-15 22:03:32 +00002171 VISIT(type->tp_cache);
Guido van Rossum048eb752001-10-02 21:24:57 +00002172 VISIT(type->tp_mro);
2173 VISIT(type->tp_bases);
2174 VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002175
2176 /* There's no need to visit type->tp_subclasses or
Guido van Rossume5c691a2003-03-07 15:13:17 +00002177 ((PyHeapTypeObject *)type)->slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002178 in cycles; tp_subclasses is a list of weak references,
2179 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002180
2181#undef VISIT
2182
2183 return 0;
2184}
2185
2186static int
2187type_clear(PyTypeObject *type)
2188{
Guido van Rossum048eb752001-10-02 21:24:57 +00002189 PyObject *tmp;
2190
Guido van Rossuma3862092002-06-10 15:24:42 +00002191 /* Because of type_is_gc(), the collector only calls this
2192 for heaptypes. */
2193 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002194
2195#define CLEAR(SLOT) \
2196 if (SLOT) { \
2197 tmp = (PyObject *)(SLOT); \
2198 SLOT = NULL; \
2199 Py_DECREF(tmp); \
2200 }
2201
Guido van Rossuma3862092002-06-10 15:24:42 +00002202 /* The only field we need to clear is tp_mro, which is part of a
2203 hard cycle (its first element is the class itself) that won't
2204 be broken otherwise (it's a tuple and tuples don't have a
2205 tp_clear handler). None of the other fields need to be
2206 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002207
Guido van Rossuma3862092002-06-10 15:24:42 +00002208 tp_dict:
2209 It is a dict, so the collector will call its tp_clear.
2210
2211 tp_cache:
2212 Not used; if it were, it would be a dict.
2213
2214 tp_bases, tp_base:
2215 If these are involved in a cycle, there must be at least
2216 one other, mutable object in the cycle, e.g. a base
2217 class's dict; the cycle will be broken that way.
2218
2219 tp_subclasses:
2220 A list of weak references can't be part of a cycle; and
2221 lists have their own tp_clear.
2222
Guido van Rossume5c691a2003-03-07 15:13:17 +00002223 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002224 A tuple of strings can't be part of a cycle.
2225 */
2226
2227 CLEAR(type->tp_mro);
Tim Peters2f93e282001-10-04 05:27:00 +00002228
Guido van Rossum048eb752001-10-02 21:24:57 +00002229#undef CLEAR
2230
2231 return 0;
2232}
2233
2234static int
2235type_is_gc(PyTypeObject *type)
2236{
2237 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2238}
2239
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002240PyTypeObject PyType_Type = {
2241 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002242 0, /* ob_size */
2243 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002244 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002245 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002246 (destructor)type_dealloc, /* tp_dealloc */
2247 0, /* tp_print */
2248 0, /* tp_getattr */
2249 0, /* tp_setattr */
2250 type_compare, /* tp_compare */
2251 (reprfunc)type_repr, /* tp_repr */
2252 0, /* tp_as_number */
2253 0, /* tp_as_sequence */
2254 0, /* tp_as_mapping */
2255 (hashfunc)_Py_HashPointer, /* tp_hash */
2256 (ternaryfunc)type_call, /* tp_call */
2257 0, /* tp_str */
2258 (getattrofunc)type_getattro, /* tp_getattro */
2259 (setattrofunc)type_setattro, /* tp_setattro */
2260 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002261 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
2262 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002263 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002264 (traverseproc)type_traverse, /* tp_traverse */
2265 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002266 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002267 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002268 0, /* tp_iter */
2269 0, /* tp_iternext */
2270 type_methods, /* tp_methods */
2271 type_members, /* tp_members */
2272 type_getsets, /* tp_getset */
2273 0, /* tp_base */
2274 0, /* tp_dict */
2275 0, /* tp_descr_get */
2276 0, /* tp_descr_set */
2277 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
2278 0, /* tp_init */
2279 0, /* tp_alloc */
2280 type_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002281 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002282 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002283};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002284
2285
2286/* The base type of all types (eventually)... except itself. */
2287
2288static int
2289object_init(PyObject *self, PyObject *args, PyObject *kwds)
2290{
2291 return 0;
2292}
2293
Guido van Rossum298e4212003-02-13 16:30:16 +00002294/* If we don't have a tp_new for a new-style class, new will use this one.
2295 Therefore this should take no arguments/keywords. However, this new may
2296 also be inherited by objects that define a tp_init but no tp_new. These
2297 objects WILL pass argumets to tp_new, because it gets the same args as
2298 tp_init. So only allow arguments if we aren't using the default init, in
2299 which case we expect init to handle argument parsing. */
2300static PyObject *
2301object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2302{
2303 if (type->tp_init == object_init && (PyTuple_GET_SIZE(args) ||
2304 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds)))) {
2305 PyErr_SetString(PyExc_TypeError,
2306 "default __new__ takes no parameters");
2307 return NULL;
2308 }
2309 return type->tp_alloc(type, 0);
2310}
2311
Tim Peters6d6c1a32001-08-02 04:15:00 +00002312static void
2313object_dealloc(PyObject *self)
2314{
2315 self->ob_type->tp_free(self);
2316}
2317
Guido van Rossum8e248182001-08-12 05:17:56 +00002318static PyObject *
2319object_repr(PyObject *self)
2320{
Guido van Rossum76e69632001-08-16 18:52:43 +00002321 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002322 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002323
Guido van Rossum76e69632001-08-16 18:52:43 +00002324 type = self->ob_type;
2325 mod = type_module(type, NULL);
2326 if (mod == NULL)
2327 PyErr_Clear();
2328 else if (!PyString_Check(mod)) {
2329 Py_DECREF(mod);
2330 mod = NULL;
2331 }
2332 name = type_name(type, NULL);
2333 if (name == NULL)
2334 return NULL;
2335 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002336 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002337 PyString_AS_STRING(mod),
2338 PyString_AS_STRING(name),
2339 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002340 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002341 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002342 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002343 Py_XDECREF(mod);
2344 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002345 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002346}
2347
Guido van Rossumb8f63662001-08-15 23:57:02 +00002348static PyObject *
2349object_str(PyObject *self)
2350{
2351 unaryfunc f;
2352
2353 f = self->ob_type->tp_repr;
2354 if (f == NULL)
2355 f = object_repr;
2356 return f(self);
2357}
2358
Guido van Rossum8e248182001-08-12 05:17:56 +00002359static long
2360object_hash(PyObject *self)
2361{
2362 return _Py_HashPointer(self);
2363}
Guido van Rossum8e248182001-08-12 05:17:56 +00002364
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002365static PyObject *
2366object_get_class(PyObject *self, void *closure)
2367{
2368 Py_INCREF(self->ob_type);
2369 return (PyObject *)(self->ob_type);
2370}
2371
2372static int
2373equiv_structs(PyTypeObject *a, PyTypeObject *b)
2374{
2375 return a == b ||
2376 (a != NULL &&
2377 b != NULL &&
2378 a->tp_basicsize == b->tp_basicsize &&
2379 a->tp_itemsize == b->tp_itemsize &&
2380 a->tp_dictoffset == b->tp_dictoffset &&
2381 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2382 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2383 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2384}
2385
2386static int
2387same_slots_added(PyTypeObject *a, PyTypeObject *b)
2388{
2389 PyTypeObject *base = a->tp_base;
2390 int size;
2391
2392 if (base != b->tp_base)
2393 return 0;
2394 if (equiv_structs(a, base) && equiv_structs(b, base))
2395 return 1;
2396 size = base->tp_basicsize;
2397 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2398 size += sizeof(PyObject *);
2399 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2400 size += sizeof(PyObject *);
2401 return size == a->tp_basicsize && size == b->tp_basicsize;
2402}
2403
2404static int
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002405compatible_for_assignment(PyTypeObject* old, PyTypeObject* new, char* attr)
2406{
2407 PyTypeObject *newbase, *oldbase;
2408
2409 if (new->tp_dealloc != old->tp_dealloc ||
2410 new->tp_free != old->tp_free)
2411 {
2412 PyErr_Format(PyExc_TypeError,
2413 "%s assignment: "
2414 "'%s' deallocator differs from '%s'",
2415 attr,
2416 new->tp_name,
2417 old->tp_name);
2418 return 0;
2419 }
2420 newbase = new;
2421 oldbase = old;
2422 while (equiv_structs(newbase, newbase->tp_base))
2423 newbase = newbase->tp_base;
2424 while (equiv_structs(oldbase, oldbase->tp_base))
2425 oldbase = oldbase->tp_base;
2426 if (newbase != oldbase &&
2427 (newbase->tp_base != oldbase->tp_base ||
2428 !same_slots_added(newbase, oldbase))) {
2429 PyErr_Format(PyExc_TypeError,
2430 "%s assignment: "
2431 "'%s' object layout differs from '%s'",
2432 attr,
2433 new->tp_name,
2434 old->tp_name);
2435 return 0;
2436 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002437
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002438 return 1;
2439}
2440
2441static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002442object_set_class(PyObject *self, PyObject *value, void *closure)
2443{
2444 PyTypeObject *old = self->ob_type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002445 PyTypeObject *new;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002446
Guido van Rossumb6b89422002-04-15 01:03:30 +00002447 if (value == NULL) {
2448 PyErr_SetString(PyExc_TypeError,
2449 "can't delete __class__ attribute");
2450 return -1;
2451 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002452 if (!PyType_Check(value)) {
2453 PyErr_Format(PyExc_TypeError,
2454 "__class__ must be set to new-style class, not '%s' object",
2455 value->ob_type->tp_name);
2456 return -1;
2457 }
2458 new = (PyTypeObject *)value;
Guido van Rossum40af8892002-08-10 05:42:07 +00002459 if (!(new->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2460 !(old->tp_flags & Py_TPFLAGS_HEAPTYPE))
2461 {
2462 PyErr_Format(PyExc_TypeError,
2463 "__class__ assignment: only for heap types");
2464 return -1;
2465 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002466 if (compatible_for_assignment(new, old, "__class__")) {
2467 Py_INCREF(new);
2468 self->ob_type = new;
2469 Py_DECREF(old);
2470 return 0;
2471 }
2472 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002473 return -1;
2474 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002475}
2476
2477static PyGetSetDef object_getsets[] = {
2478 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002479 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002480 {0}
2481};
2482
Guido van Rossumc53f0092003-02-18 22:05:12 +00002483
Guido van Rossum036f9992003-02-21 22:02:54 +00002484/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2485 We fall back to helpers in copy_reg for:
2486 - pickle protocols < 2
2487 - calculating the list of slot names (done only once per class)
2488 - the __newobj__ function (which is used as a token but never called)
2489*/
2490
2491static PyObject *
2492import_copy_reg(void)
2493{
2494 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002495
2496 if (!copy_reg_str) {
2497 copy_reg_str = PyString_InternFromString("copy_reg");
2498 if (copy_reg_str == NULL)
2499 return NULL;
2500 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002501
2502 return PyImport_Import(copy_reg_str);
2503}
2504
2505static PyObject *
2506slotnames(PyObject *cls)
2507{
2508 PyObject *clsdict;
2509 PyObject *copy_reg;
2510 PyObject *slotnames;
2511
2512 if (!PyType_Check(cls)) {
2513 Py_INCREF(Py_None);
2514 return Py_None;
2515 }
2516
2517 clsdict = ((PyTypeObject *)cls)->tp_dict;
2518 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
Armin Rigoec862b92005-09-24 22:58:41 +00002519 if (slotnames != NULL && PyList_Check(slotnames)) {
Guido van Rossum036f9992003-02-21 22:02:54 +00002520 Py_INCREF(slotnames);
2521 return slotnames;
2522 }
2523
2524 copy_reg = import_copy_reg();
2525 if (copy_reg == NULL)
2526 return NULL;
2527
2528 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2529 Py_DECREF(copy_reg);
2530 if (slotnames != NULL &&
2531 slotnames != Py_None &&
2532 !PyList_Check(slotnames))
2533 {
2534 PyErr_SetString(PyExc_TypeError,
2535 "copy_reg._slotnames didn't return a list or None");
2536 Py_DECREF(slotnames);
2537 slotnames = NULL;
2538 }
2539
2540 return slotnames;
2541}
2542
2543static PyObject *
2544reduce_2(PyObject *obj)
2545{
2546 PyObject *cls, *getnewargs;
2547 PyObject *args = NULL, *args2 = NULL;
2548 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2549 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2550 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
2551 int i, n;
2552
2553 cls = PyObject_GetAttrString(obj, "__class__");
2554 if (cls == NULL)
2555 return NULL;
2556
2557 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2558 if (getnewargs != NULL) {
2559 args = PyObject_CallObject(getnewargs, NULL);
2560 Py_DECREF(getnewargs);
2561 if (args != NULL && !PyTuple_Check(args)) {
2562 PyErr_SetString(PyExc_TypeError,
2563 "__getnewargs__ should return a tuple");
2564 goto end;
2565 }
2566 }
2567 else {
2568 PyErr_Clear();
2569 args = PyTuple_New(0);
2570 }
2571 if (args == NULL)
2572 goto end;
2573
2574 getstate = PyObject_GetAttrString(obj, "__getstate__");
2575 if (getstate != NULL) {
2576 state = PyObject_CallObject(getstate, NULL);
2577 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00002578 if (state == NULL)
2579 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00002580 }
2581 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00002582 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00002583 state = PyObject_GetAttrString(obj, "__dict__");
2584 if (state == NULL) {
2585 PyErr_Clear();
2586 state = Py_None;
2587 Py_INCREF(state);
2588 }
2589 names = slotnames(cls);
2590 if (names == NULL)
2591 goto end;
2592 if (names != Py_None) {
2593 assert(PyList_Check(names));
2594 slots = PyDict_New();
2595 if (slots == NULL)
2596 goto end;
2597 n = 0;
2598 /* Can't pre-compute the list size; the list
2599 is stored on the class so accessible to other
2600 threads, which may be run by DECREF */
2601 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2602 PyObject *name, *value;
2603 name = PyList_GET_ITEM(names, i);
2604 value = PyObject_GetAttr(obj, name);
2605 if (value == NULL)
2606 PyErr_Clear();
2607 else {
2608 int err = PyDict_SetItem(slots, name,
2609 value);
2610 Py_DECREF(value);
2611 if (err)
2612 goto end;
2613 n++;
2614 }
2615 }
2616 if (n) {
2617 state = Py_BuildValue("(NO)", state, slots);
2618 if (state == NULL)
2619 goto end;
2620 }
2621 }
2622 }
2623
2624 if (!PyList_Check(obj)) {
2625 listitems = Py_None;
2626 Py_INCREF(listitems);
2627 }
2628 else {
2629 listitems = PyObject_GetIter(obj);
2630 if (listitems == NULL)
2631 goto end;
2632 }
2633
2634 if (!PyDict_Check(obj)) {
2635 dictitems = Py_None;
2636 Py_INCREF(dictitems);
2637 }
2638 else {
2639 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2640 if (dictitems == NULL)
2641 goto end;
2642 }
2643
2644 copy_reg = import_copy_reg();
2645 if (copy_reg == NULL)
2646 goto end;
2647 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2648 if (newobj == NULL)
2649 goto end;
2650
2651 n = PyTuple_GET_SIZE(args);
2652 args2 = PyTuple_New(n+1);
2653 if (args2 == NULL)
2654 goto end;
2655 PyTuple_SET_ITEM(args2, 0, cls);
2656 cls = NULL;
2657 for (i = 0; i < n; i++) {
2658 PyObject *v = PyTuple_GET_ITEM(args, i);
2659 Py_INCREF(v);
2660 PyTuple_SET_ITEM(args2, i+1, v);
2661 }
2662
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002663 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00002664
2665 end:
2666 Py_XDECREF(cls);
2667 Py_XDECREF(args);
2668 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002669 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002670 Py_XDECREF(state);
2671 Py_XDECREF(names);
2672 Py_XDECREF(listitems);
2673 Py_XDECREF(dictitems);
2674 Py_XDECREF(copy_reg);
2675 Py_XDECREF(newobj);
2676 return res;
2677}
2678
2679static PyObject *
2680object_reduce_ex(PyObject *self, PyObject *args)
2681{
2682 /* Call copy_reg._reduce_ex(self, proto) */
2683 PyObject *reduce, *copy_reg, *res;
2684 int proto = 0;
2685
2686 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2687 return NULL;
2688
2689 reduce = PyObject_GetAttrString(self, "__reduce__");
2690 if (reduce == NULL)
2691 PyErr_Clear();
2692 else {
2693 PyObject *cls, *clsreduce, *objreduce;
2694 int override;
2695 cls = PyObject_GetAttrString(self, "__class__");
2696 if (cls == NULL) {
2697 Py_DECREF(reduce);
2698 return NULL;
2699 }
2700 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2701 Py_DECREF(cls);
2702 if (clsreduce == NULL) {
2703 Py_DECREF(reduce);
2704 return NULL;
2705 }
2706 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2707 "__reduce__");
2708 override = (clsreduce != objreduce);
2709 Py_DECREF(clsreduce);
2710 if (override) {
2711 res = PyObject_CallObject(reduce, NULL);
2712 Py_DECREF(reduce);
2713 return res;
2714 }
2715 else
2716 Py_DECREF(reduce);
2717 }
2718
2719 if (proto >= 2)
2720 return reduce_2(self);
2721
2722 copy_reg = import_copy_reg();
Guido van Rossum3926a632001-09-25 16:25:58 +00002723 if (!copy_reg)
2724 return NULL;
Guido van Rossum036f9992003-02-21 22:02:54 +00002725
Guido van Rossumc53f0092003-02-18 22:05:12 +00002726 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00002727 Py_DECREF(copy_reg);
Guido van Rossum036f9992003-02-21 22:02:54 +00002728
Guido van Rossum3926a632001-09-25 16:25:58 +00002729 return res;
2730}
2731
2732static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00002733 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
2734 PyDoc_STR("helper for pickle")},
2735 {"__reduce__", object_reduce_ex, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002736 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00002737 {0}
2738};
2739
Guido van Rossum036f9992003-02-21 22:02:54 +00002740
Tim Peters6d6c1a32001-08-02 04:15:00 +00002741PyTypeObject PyBaseObject_Type = {
2742 PyObject_HEAD_INIT(&PyType_Type)
2743 0, /* ob_size */
2744 "object", /* tp_name */
2745 sizeof(PyObject), /* tp_basicsize */
2746 0, /* tp_itemsize */
2747 (destructor)object_dealloc, /* tp_dealloc */
2748 0, /* tp_print */
2749 0, /* tp_getattr */
2750 0, /* tp_setattr */
2751 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002752 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002753 0, /* tp_as_number */
2754 0, /* tp_as_sequence */
2755 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002756 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002757 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002758 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002759 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002760 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002761 0, /* tp_as_buffer */
2762 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002763 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002764 0, /* tp_traverse */
2765 0, /* tp_clear */
2766 0, /* tp_richcompare */
2767 0, /* tp_weaklistoffset */
2768 0, /* tp_iter */
2769 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00002770 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002771 0, /* tp_members */
2772 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002773 0, /* tp_base */
2774 0, /* tp_dict */
2775 0, /* tp_descr_get */
2776 0, /* tp_descr_set */
2777 0, /* tp_dictoffset */
2778 object_init, /* tp_init */
2779 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00002780 object_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002781 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002782};
2783
2784
2785/* Initialize the __dict__ in a type object */
2786
2787static int
2788add_methods(PyTypeObject *type, PyMethodDef *meth)
2789{
Guido van Rossum687ae002001-10-15 22:03:32 +00002790 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002791
2792 for (; meth->ml_name != NULL; meth++) {
2793 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002794 if (PyDict_GetItemString(dict, meth->ml_name) &&
2795 !(meth->ml_flags & METH_COEXIST))
2796 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002797 if (meth->ml_flags & METH_CLASS) {
2798 if (meth->ml_flags & METH_STATIC) {
2799 PyErr_SetString(PyExc_ValueError,
2800 "method cannot be both class and static");
2801 return -1;
2802 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002803 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002804 }
2805 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002806 PyObject *cfunc = PyCFunction_New(meth, NULL);
2807 if (cfunc == NULL)
2808 return -1;
2809 descr = PyStaticMethod_New(cfunc);
2810 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002811 }
2812 else {
2813 descr = PyDescr_NewMethod(type, meth);
2814 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002815 if (descr == NULL)
2816 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002817 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002818 return -1;
2819 Py_DECREF(descr);
2820 }
2821 return 0;
2822}
2823
2824static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002825add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002826{
Guido van Rossum687ae002001-10-15 22:03:32 +00002827 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002828
2829 for (; memb->name != NULL; memb++) {
2830 PyObject *descr;
2831 if (PyDict_GetItemString(dict, memb->name))
2832 continue;
2833 descr = PyDescr_NewMember(type, memb);
2834 if (descr == NULL)
2835 return -1;
2836 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2837 return -1;
2838 Py_DECREF(descr);
2839 }
2840 return 0;
2841}
2842
2843static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002844add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002845{
Guido van Rossum687ae002001-10-15 22:03:32 +00002846 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002847
2848 for (; gsp->name != NULL; gsp++) {
2849 PyObject *descr;
2850 if (PyDict_GetItemString(dict, gsp->name))
2851 continue;
2852 descr = PyDescr_NewGetSet(type, gsp);
2853
2854 if (descr == NULL)
2855 return -1;
2856 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2857 return -1;
2858 Py_DECREF(descr);
2859 }
2860 return 0;
2861}
2862
Guido van Rossum13d52f02001-08-10 21:24:08 +00002863static void
2864inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002865{
2866 int oldsize, newsize;
2867
Guido van Rossum13d52f02001-08-10 21:24:08 +00002868 /* Special flag magic */
2869 if (!type->tp_as_buffer && base->tp_as_buffer) {
2870 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2871 type->tp_flags |=
2872 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2873 }
2874 if (!type->tp_as_sequence && base->tp_as_sequence) {
2875 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2876 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2877 }
2878 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2879 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2880 if ((!type->tp_as_number && base->tp_as_number) ||
2881 (!type->tp_as_sequence && base->tp_as_sequence)) {
2882 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2883 if (!type->tp_as_number && !type->tp_as_sequence) {
2884 type->tp_flags |= base->tp_flags &
2885 Py_TPFLAGS_HAVE_INPLACEOPS;
2886 }
2887 }
2888 /* Wow */
2889 }
2890 if (!type->tp_as_number && base->tp_as_number) {
2891 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2892 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2893 }
2894
2895 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002896 oldsize = base->tp_basicsize;
2897 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2898 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2899 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002900 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2901 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002902 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002903 if (type->tp_traverse == NULL)
2904 type->tp_traverse = base->tp_traverse;
2905 if (type->tp_clear == NULL)
2906 type->tp_clear = base->tp_clear;
2907 }
2908 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002909 /* The condition below could use some explanation.
2910 It appears that tp_new is not inherited for static types
2911 whose base class is 'object'; this seems to be a precaution
2912 so that old extension types don't suddenly become
2913 callable (object.__new__ wouldn't insure the invariants
2914 that the extension type's own factory function ensures).
2915 Heap types, of course, are under our control, so they do
2916 inherit tp_new; static extension types that specify some
2917 other built-in type as the default are considered
2918 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002919 if (base != &PyBaseObject_Type ||
2920 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2921 if (type->tp_new == NULL)
2922 type->tp_new = base->tp_new;
2923 }
2924 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002925 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002926
2927 /* Copy other non-function slots */
2928
2929#undef COPYVAL
2930#define COPYVAL(SLOT) \
2931 if (type->SLOT == 0) type->SLOT = base->SLOT
2932
2933 COPYVAL(tp_itemsize);
2934 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2935 COPYVAL(tp_weaklistoffset);
2936 }
2937 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2938 COPYVAL(tp_dictoffset);
2939 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002940}
2941
2942static void
2943inherit_slots(PyTypeObject *type, PyTypeObject *base)
2944{
2945 PyTypeObject *basebase;
2946
2947#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002948#undef COPYSLOT
2949#undef COPYNUM
2950#undef COPYSEQ
2951#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002952#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002953
2954#define SLOTDEFINED(SLOT) \
2955 (base->SLOT != 0 && \
2956 (basebase == NULL || base->SLOT != basebase->SLOT))
2957
Tim Peters6d6c1a32001-08-02 04:15:00 +00002958#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002959 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002960
2961#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2962#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2963#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002964#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002965
Guido van Rossum13d52f02001-08-10 21:24:08 +00002966 /* This won't inherit indirect slots (from tp_as_number etc.)
2967 if type doesn't provide the space. */
2968
2969 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2970 basebase = base->tp_base;
2971 if (basebase->tp_as_number == NULL)
2972 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002973 COPYNUM(nb_add);
2974 COPYNUM(nb_subtract);
2975 COPYNUM(nb_multiply);
2976 COPYNUM(nb_divide);
2977 COPYNUM(nb_remainder);
2978 COPYNUM(nb_divmod);
2979 COPYNUM(nb_power);
2980 COPYNUM(nb_negative);
2981 COPYNUM(nb_positive);
2982 COPYNUM(nb_absolute);
2983 COPYNUM(nb_nonzero);
2984 COPYNUM(nb_invert);
2985 COPYNUM(nb_lshift);
2986 COPYNUM(nb_rshift);
2987 COPYNUM(nb_and);
2988 COPYNUM(nb_xor);
2989 COPYNUM(nb_or);
2990 COPYNUM(nb_coerce);
2991 COPYNUM(nb_int);
2992 COPYNUM(nb_long);
2993 COPYNUM(nb_float);
2994 COPYNUM(nb_oct);
2995 COPYNUM(nb_hex);
2996 COPYNUM(nb_inplace_add);
2997 COPYNUM(nb_inplace_subtract);
2998 COPYNUM(nb_inplace_multiply);
2999 COPYNUM(nb_inplace_divide);
3000 COPYNUM(nb_inplace_remainder);
3001 COPYNUM(nb_inplace_power);
3002 COPYNUM(nb_inplace_lshift);
3003 COPYNUM(nb_inplace_rshift);
3004 COPYNUM(nb_inplace_and);
3005 COPYNUM(nb_inplace_xor);
3006 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003007 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3008 COPYNUM(nb_true_divide);
3009 COPYNUM(nb_floor_divide);
3010 COPYNUM(nb_inplace_true_divide);
3011 COPYNUM(nb_inplace_floor_divide);
3012 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003013 }
3014
Guido van Rossum13d52f02001-08-10 21:24:08 +00003015 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3016 basebase = base->tp_base;
3017 if (basebase->tp_as_sequence == NULL)
3018 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003019 COPYSEQ(sq_length);
3020 COPYSEQ(sq_concat);
3021 COPYSEQ(sq_repeat);
3022 COPYSEQ(sq_item);
3023 COPYSEQ(sq_slice);
3024 COPYSEQ(sq_ass_item);
3025 COPYSEQ(sq_ass_slice);
3026 COPYSEQ(sq_contains);
3027 COPYSEQ(sq_inplace_concat);
3028 COPYSEQ(sq_inplace_repeat);
3029 }
3030
Guido van Rossum13d52f02001-08-10 21:24:08 +00003031 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3032 basebase = base->tp_base;
3033 if (basebase->tp_as_mapping == NULL)
3034 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003035 COPYMAP(mp_length);
3036 COPYMAP(mp_subscript);
3037 COPYMAP(mp_ass_subscript);
3038 }
3039
Tim Petersfc57ccb2001-10-12 02:38:24 +00003040 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3041 basebase = base->tp_base;
3042 if (basebase->tp_as_buffer == NULL)
3043 basebase = NULL;
3044 COPYBUF(bf_getreadbuffer);
3045 COPYBUF(bf_getwritebuffer);
3046 COPYBUF(bf_getsegcount);
3047 COPYBUF(bf_getcharbuffer);
3048 }
3049
Guido van Rossum13d52f02001-08-10 21:24:08 +00003050 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003051
Tim Peters6d6c1a32001-08-02 04:15:00 +00003052 COPYSLOT(tp_dealloc);
3053 COPYSLOT(tp_print);
3054 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3055 type->tp_getattr = base->tp_getattr;
3056 type->tp_getattro = base->tp_getattro;
3057 }
3058 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3059 type->tp_setattr = base->tp_setattr;
3060 type->tp_setattro = base->tp_setattro;
3061 }
3062 /* tp_compare see tp_richcompare */
3063 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003064 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003065 COPYSLOT(tp_call);
3066 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003067 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003068 if (type->tp_compare == NULL &&
3069 type->tp_richcompare == NULL &&
3070 type->tp_hash == NULL)
3071 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003072 type->tp_compare = base->tp_compare;
3073 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003074 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003075 }
3076 }
3077 else {
3078 COPYSLOT(tp_compare);
3079 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003080 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3081 COPYSLOT(tp_iter);
3082 COPYSLOT(tp_iternext);
3083 }
3084 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3085 COPYSLOT(tp_descr_get);
3086 COPYSLOT(tp_descr_set);
3087 COPYSLOT(tp_dictoffset);
3088 COPYSLOT(tp_init);
3089 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003090 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003091 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3092 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3093 /* They agree about gc. */
3094 COPYSLOT(tp_free);
3095 }
3096 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3097 type->tp_free == NULL &&
3098 base->tp_free == _PyObject_Del) {
3099 /* A bit of magic to plug in the correct default
3100 * tp_free function when a derived class adds gc,
3101 * didn't define tp_free, and the base uses the
3102 * default non-gc tp_free.
3103 */
3104 type->tp_free = PyObject_GC_Del;
3105 }
3106 /* else they didn't agree about gc, and there isn't something
3107 * obvious to be done -- the type is on its own.
3108 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003109 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003110}
3111
Jeremy Hylton938ace62002-07-17 16:30:39 +00003112static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003113
Tim Peters6d6c1a32001-08-02 04:15:00 +00003114int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003115PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003116{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003117 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003118 PyTypeObject *base;
3119 int i, n;
3120
Guido van Rossumcab05802002-06-10 15:29:03 +00003121 if (type->tp_flags & Py_TPFLAGS_READY) {
3122 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003123 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003124 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003125 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003126
3127 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003128
Tim Peters36eb4df2003-03-23 03:33:13 +00003129#ifdef Py_TRACE_REFS
3130 /* PyType_Ready is the closest thing we have to a choke point
3131 * for type objects, so is the best place I can think of to try
3132 * to get type objects into the doubly-linked list of all objects.
3133 * Still, not all type objects go thru PyType_Ready.
3134 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003135 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003136#endif
3137
Tim Peters6d6c1a32001-08-02 04:15:00 +00003138 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3139 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003140 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003141 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003142 Py_INCREF(base);
3143 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003144
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003145 /* Initialize the base class */
3146 if (base && base->tp_dict == NULL) {
3147 if (PyType_Ready(base) < 0)
3148 goto error;
3149 }
3150
Guido van Rossum0986d822002-04-08 01:38:42 +00003151 /* Initialize ob_type if NULL. This means extensions that want to be
3152 compilable separately on Windows can call PyType_Ready() instead of
3153 initializing the ob_type field of their type objects. */
3154 if (type->ob_type == NULL)
3155 type->ob_type = base->ob_type;
3156
Tim Peters6d6c1a32001-08-02 04:15:00 +00003157 /* Initialize tp_bases */
3158 bases = type->tp_bases;
3159 if (bases == NULL) {
3160 if (base == NULL)
3161 bases = PyTuple_New(0);
3162 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003163 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003164 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003165 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003166 type->tp_bases = bases;
3167 }
3168
Guido van Rossum687ae002001-10-15 22:03:32 +00003169 /* Initialize tp_dict */
3170 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003171 if (dict == NULL) {
3172 dict = PyDict_New();
3173 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003174 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003175 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003176 }
3177
Guido van Rossum687ae002001-10-15 22:03:32 +00003178 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003179 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003180 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003181 if (type->tp_methods != NULL) {
3182 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003183 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003184 }
3185 if (type->tp_members != NULL) {
3186 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003187 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003188 }
3189 if (type->tp_getset != NULL) {
3190 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003191 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003192 }
3193
Tim Peters6d6c1a32001-08-02 04:15:00 +00003194 /* Calculate method resolution order */
3195 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003196 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003197 }
3198
Guido van Rossum13d52f02001-08-10 21:24:08 +00003199 /* Inherit special flags from dominant base */
3200 if (type->tp_base != NULL)
3201 inherit_special(type, type->tp_base);
3202
Tim Peters6d6c1a32001-08-02 04:15:00 +00003203 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003204 bases = type->tp_mro;
3205 assert(bases != NULL);
3206 assert(PyTuple_Check(bases));
3207 n = PyTuple_GET_SIZE(bases);
3208 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003209 PyObject *b = PyTuple_GET_ITEM(bases, i);
3210 if (PyType_Check(b))
3211 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003212 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003213
Tim Peters3cfe7542003-05-21 21:29:48 +00003214 /* Sanity check for tp_free. */
3215 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3216 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
3217 /* This base class needs to call tp_free, but doesn't have
3218 * one, or its tp_free is for non-gc'ed objects.
3219 */
3220 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3221 "gc and is a base type but has inappropriate "
3222 "tp_free slot",
3223 type->tp_name);
3224 goto error;
3225 }
3226
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003227 /* if the type dictionary doesn't contain a __doc__, set it from
3228 the tp_doc slot.
3229 */
3230 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3231 if (type->tp_doc != NULL) {
3232 PyObject *doc = PyString_FromString(type->tp_doc);
3233 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3234 Py_DECREF(doc);
3235 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003236 PyDict_SetItemString(type->tp_dict,
3237 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003238 }
3239 }
3240
Guido van Rossum13d52f02001-08-10 21:24:08 +00003241 /* Some more special stuff */
3242 base = type->tp_base;
3243 if (base != NULL) {
3244 if (type->tp_as_number == NULL)
3245 type->tp_as_number = base->tp_as_number;
3246 if (type->tp_as_sequence == NULL)
3247 type->tp_as_sequence = base->tp_as_sequence;
3248 if (type->tp_as_mapping == NULL)
3249 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003250 if (type->tp_as_buffer == NULL)
3251 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003252 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003253
Guido van Rossum1c450732001-10-08 15:18:27 +00003254 /* Link into each base class's list of subclasses */
3255 bases = type->tp_bases;
3256 n = PyTuple_GET_SIZE(bases);
3257 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003258 PyObject *b = PyTuple_GET_ITEM(bases, i);
3259 if (PyType_Check(b) &&
3260 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003261 goto error;
3262 }
3263
Guido van Rossum13d52f02001-08-10 21:24:08 +00003264 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003265 assert(type->tp_dict != NULL);
3266 type->tp_flags =
3267 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003268 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003269
3270 error:
3271 type->tp_flags &= ~Py_TPFLAGS_READYING;
3272 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003273}
3274
Guido van Rossum1c450732001-10-08 15:18:27 +00003275static int
3276add_subclass(PyTypeObject *base, PyTypeObject *type)
3277{
3278 int i;
3279 PyObject *list, *ref, *new;
3280
3281 list = base->tp_subclasses;
3282 if (list == NULL) {
3283 base->tp_subclasses = list = PyList_New(0);
3284 if (list == NULL)
3285 return -1;
3286 }
3287 assert(PyList_Check(list));
3288 new = PyWeakref_NewRef((PyObject *)type, NULL);
3289 i = PyList_GET_SIZE(list);
3290 while (--i >= 0) {
3291 ref = PyList_GET_ITEM(list, i);
3292 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003293 if (PyWeakref_GET_OBJECT(ref) == Py_None)
3294 return PyList_SetItem(list, i, new);
Guido van Rossum1c450732001-10-08 15:18:27 +00003295 }
3296 i = PyList_Append(list, new);
3297 Py_DECREF(new);
3298 return i;
3299}
3300
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003301static void
3302remove_subclass(PyTypeObject *base, PyTypeObject *type)
3303{
3304 int i;
3305 PyObject *list, *ref;
3306
3307 list = base->tp_subclasses;
3308 if (list == NULL) {
3309 return;
3310 }
3311 assert(PyList_Check(list));
3312 i = PyList_GET_SIZE(list);
3313 while (--i >= 0) {
3314 ref = PyList_GET_ITEM(list, i);
3315 assert(PyWeakref_CheckRef(ref));
3316 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3317 /* this can't fail, right? */
3318 PySequence_DelItem(list, i);
3319 return;
3320 }
3321 }
3322}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003323
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003324static int
3325check_num_args(PyObject *ob, int n)
3326{
3327 if (!PyTuple_CheckExact(ob)) {
3328 PyErr_SetString(PyExc_SystemError,
3329 "PyArg_UnpackTuple() argument list is not a tuple");
3330 return 0;
3331 }
3332 if (n == PyTuple_GET_SIZE(ob))
3333 return 1;
3334 PyErr_Format(
3335 PyExc_TypeError,
3336 "expected %d arguments, got %d", n, PyTuple_GET_SIZE(ob));
3337 return 0;
3338}
3339
Tim Peters6d6c1a32001-08-02 04:15:00 +00003340/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3341
3342/* There's a wrapper *function* for each distinct function typedef used
3343 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
3344 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3345 Most tables have only one entry; the tables for binary operators have two
3346 entries, one regular and one with reversed arguments. */
3347
3348static PyObject *
3349wrap_inquiry(PyObject *self, PyObject *args, void *wrapped)
3350{
3351 inquiry func = (inquiry)wrapped;
3352 int res;
3353
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003354 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003355 return NULL;
3356 res = (*func)(self);
3357 if (res == -1 && PyErr_Occurred())
3358 return NULL;
3359 return PyInt_FromLong((long)res);
3360}
3361
Tim Peters6d6c1a32001-08-02 04:15:00 +00003362static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003363wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3364{
3365 inquiry func = (inquiry)wrapped;
3366 int res;
3367
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003368 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003369 return NULL;
3370 res = (*func)(self);
3371 if (res == -1 && PyErr_Occurred())
3372 return NULL;
3373 return PyBool_FromLong((long)res);
3374}
3375
3376static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003377wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3378{
3379 binaryfunc func = (binaryfunc)wrapped;
3380 PyObject *other;
3381
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003382 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003383 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003384 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003385 return (*func)(self, other);
3386}
3387
3388static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003389wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3390{
3391 binaryfunc func = (binaryfunc)wrapped;
3392 PyObject *other;
3393
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003394 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003395 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003396 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003397 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003398 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003399 Py_INCREF(Py_NotImplemented);
3400 return Py_NotImplemented;
3401 }
3402 return (*func)(self, other);
3403}
3404
3405static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003406wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3407{
3408 binaryfunc func = (binaryfunc)wrapped;
3409 PyObject *other;
3410
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003411 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003412 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003413 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003414 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003415 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003416 Py_INCREF(Py_NotImplemented);
3417 return Py_NotImplemented;
3418 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003419 return (*func)(other, self);
3420}
3421
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003422static PyObject *
3423wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3424{
3425 coercion func = (coercion)wrapped;
3426 PyObject *other, *res;
3427 int ok;
3428
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003429 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003430 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003431 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003432 ok = func(&self, &other);
3433 if (ok < 0)
3434 return NULL;
3435 if (ok > 0) {
3436 Py_INCREF(Py_NotImplemented);
3437 return Py_NotImplemented;
3438 }
3439 res = PyTuple_New(2);
3440 if (res == NULL) {
3441 Py_DECREF(self);
3442 Py_DECREF(other);
3443 return NULL;
3444 }
3445 PyTuple_SET_ITEM(res, 0, self);
3446 PyTuple_SET_ITEM(res, 1, other);
3447 return res;
3448}
3449
Tim Peters6d6c1a32001-08-02 04:15:00 +00003450static PyObject *
3451wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3452{
3453 ternaryfunc func = (ternaryfunc)wrapped;
3454 PyObject *other;
3455 PyObject *third = Py_None;
3456
3457 /* Note: This wrapper only works for __pow__() */
3458
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003459 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003460 return NULL;
3461 return (*func)(self, other, third);
3462}
3463
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003464static PyObject *
3465wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3466{
3467 ternaryfunc func = (ternaryfunc)wrapped;
3468 PyObject *other;
3469 PyObject *third = Py_None;
3470
3471 /* Note: This wrapper only works for __pow__() */
3472
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003473 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003474 return NULL;
3475 return (*func)(other, self, third);
3476}
3477
Tim Peters6d6c1a32001-08-02 04:15:00 +00003478static PyObject *
3479wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3480{
3481 unaryfunc func = (unaryfunc)wrapped;
3482
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003483 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003484 return NULL;
3485 return (*func)(self);
3486}
3487
Tim Peters6d6c1a32001-08-02 04:15:00 +00003488static PyObject *
3489wrap_intargfunc(PyObject *self, PyObject *args, void *wrapped)
3490{
3491 intargfunc func = (intargfunc)wrapped;
3492 int i;
3493
3494 if (!PyArg_ParseTuple(args, "i", &i))
3495 return NULL;
3496 return (*func)(self, i);
3497}
3498
Guido van Rossum5d815f32001-08-17 21:57:47 +00003499static int
3500getindex(PyObject *self, PyObject *arg)
3501{
3502 int i;
3503
3504 i = PyInt_AsLong(arg);
3505 if (i == -1 && PyErr_Occurred())
3506 return -1;
3507 if (i < 0) {
3508 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3509 if (sq && sq->sq_length) {
3510 int n = (*sq->sq_length)(self);
3511 if (n < 0)
3512 return -1;
3513 i += n;
3514 }
3515 }
3516 return i;
3517}
3518
3519static PyObject *
3520wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3521{
3522 intargfunc func = (intargfunc)wrapped;
3523 PyObject *arg;
3524 int i;
3525
Guido van Rossumf4593e02001-10-03 12:09:30 +00003526 if (PyTuple_GET_SIZE(args) == 1) {
3527 arg = PyTuple_GET_ITEM(args, 0);
3528 i = getindex(self, arg);
3529 if (i == -1 && PyErr_Occurred())
3530 return NULL;
3531 return (*func)(self, i);
3532 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003533 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003534 assert(PyErr_Occurred());
3535 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003536}
3537
Tim Peters6d6c1a32001-08-02 04:15:00 +00003538static PyObject *
3539wrap_intintargfunc(PyObject *self, PyObject *args, void *wrapped)
3540{
3541 intintargfunc func = (intintargfunc)wrapped;
3542 int i, j;
3543
3544 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3545 return NULL;
3546 return (*func)(self, i, j);
3547}
3548
Tim Peters6d6c1a32001-08-02 04:15:00 +00003549static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003550wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003551{
3552 intobjargproc func = (intobjargproc)wrapped;
3553 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003554 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003555
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003556 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003557 return NULL;
3558 i = getindex(self, arg);
3559 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003560 return NULL;
3561 res = (*func)(self, i, value);
3562 if (res == -1 && PyErr_Occurred())
3563 return NULL;
3564 Py_INCREF(Py_None);
3565 return Py_None;
3566}
3567
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003568static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003569wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003570{
3571 intobjargproc func = (intobjargproc)wrapped;
3572 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003573 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003574
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003575 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003576 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003577 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003578 i = getindex(self, arg);
3579 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003580 return NULL;
3581 res = (*func)(self, i, NULL);
3582 if (res == -1 && PyErr_Occurred())
3583 return NULL;
3584 Py_INCREF(Py_None);
3585 return Py_None;
3586}
3587
Tim Peters6d6c1a32001-08-02 04:15:00 +00003588static PyObject *
3589wrap_intintobjargproc(PyObject *self, PyObject *args, void *wrapped)
3590{
3591 intintobjargproc func = (intintobjargproc)wrapped;
3592 int i, j, res;
3593 PyObject *value;
3594
3595 if (!PyArg_ParseTuple(args, "iiO", &i, &j, &value))
3596 return NULL;
3597 res = (*func)(self, i, j, value);
3598 if (res == -1 && PyErr_Occurred())
3599 return NULL;
3600 Py_INCREF(Py_None);
3601 return Py_None;
3602}
3603
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003604static PyObject *
3605wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3606{
3607 intintobjargproc func = (intintobjargproc)wrapped;
3608 int i, j, res;
3609
3610 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3611 return NULL;
3612 res = (*func)(self, i, j, NULL);
3613 if (res == -1 && PyErr_Occurred())
3614 return NULL;
3615 Py_INCREF(Py_None);
3616 return Py_None;
3617}
3618
Tim Peters6d6c1a32001-08-02 04:15:00 +00003619/* XXX objobjproc is a misnomer; should be objargpred */
3620static PyObject *
3621wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3622{
3623 objobjproc func = (objobjproc)wrapped;
3624 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003625 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003626
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003627 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003628 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003629 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003630 res = (*func)(self, value);
3631 if (res == -1 && PyErr_Occurred())
3632 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003633 else
3634 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003635}
3636
Tim Peters6d6c1a32001-08-02 04:15:00 +00003637static PyObject *
3638wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3639{
3640 objobjargproc func = (objobjargproc)wrapped;
3641 int res;
3642 PyObject *key, *value;
3643
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003644 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003645 return NULL;
3646 res = (*func)(self, key, value);
3647 if (res == -1 && PyErr_Occurred())
3648 return NULL;
3649 Py_INCREF(Py_None);
3650 return Py_None;
3651}
3652
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003653static PyObject *
3654wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3655{
3656 objobjargproc func = (objobjargproc)wrapped;
3657 int res;
3658 PyObject *key;
3659
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003660 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003661 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003662 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003663 res = (*func)(self, key, NULL);
3664 if (res == -1 && PyErr_Occurred())
3665 return NULL;
3666 Py_INCREF(Py_None);
3667 return Py_None;
3668}
3669
Tim Peters6d6c1a32001-08-02 04:15:00 +00003670static PyObject *
3671wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3672{
3673 cmpfunc func = (cmpfunc)wrapped;
3674 int res;
3675 PyObject *other;
3676
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003677 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003678 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003679 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003680 if (other->ob_type->tp_compare != func &&
3681 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003682 PyErr_Format(
3683 PyExc_TypeError,
3684 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3685 self->ob_type->tp_name,
3686 self->ob_type->tp_name,
3687 other->ob_type->tp_name);
3688 return NULL;
3689 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003690 res = (*func)(self, other);
3691 if (PyErr_Occurred())
3692 return NULL;
3693 return PyInt_FromLong((long)res);
3694}
3695
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003696/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003697 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003698static int
3699hackcheck(PyObject *self, setattrofunc func, char *what)
3700{
3701 PyTypeObject *type = self->ob_type;
3702 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3703 type = type->tp_base;
3704 if (type->tp_setattro != func) {
3705 PyErr_Format(PyExc_TypeError,
3706 "can't apply this %s to %s object",
3707 what,
3708 type->tp_name);
3709 return 0;
3710 }
3711 return 1;
3712}
3713
Tim Peters6d6c1a32001-08-02 04:15:00 +00003714static PyObject *
3715wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3716{
3717 setattrofunc func = (setattrofunc)wrapped;
3718 int res;
3719 PyObject *name, *value;
3720
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003721 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003722 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003723 if (!hackcheck(self, func, "__setattr__"))
3724 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003725 res = (*func)(self, name, value);
3726 if (res < 0)
3727 return NULL;
3728 Py_INCREF(Py_None);
3729 return Py_None;
3730}
3731
3732static PyObject *
3733wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3734{
3735 setattrofunc func = (setattrofunc)wrapped;
3736 int res;
3737 PyObject *name;
3738
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003739 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003740 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003741 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003742 if (!hackcheck(self, func, "__delattr__"))
3743 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003744 res = (*func)(self, name, NULL);
3745 if (res < 0)
3746 return NULL;
3747 Py_INCREF(Py_None);
3748 return Py_None;
3749}
3750
Tim Peters6d6c1a32001-08-02 04:15:00 +00003751static PyObject *
3752wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3753{
3754 hashfunc func = (hashfunc)wrapped;
3755 long res;
3756
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003757 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003758 return NULL;
3759 res = (*func)(self);
3760 if (res == -1 && PyErr_Occurred())
3761 return NULL;
3762 return PyInt_FromLong(res);
3763}
3764
Tim Peters6d6c1a32001-08-02 04:15:00 +00003765static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003766wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003767{
3768 ternaryfunc func = (ternaryfunc)wrapped;
3769
Guido van Rossumc8e56452001-10-22 00:43:43 +00003770 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003771}
3772
Tim Peters6d6c1a32001-08-02 04:15:00 +00003773static PyObject *
3774wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3775{
3776 richcmpfunc func = (richcmpfunc)wrapped;
3777 PyObject *other;
3778
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003779 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003780 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003781 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003782 return (*func)(self, other, op);
3783}
3784
3785#undef RICHCMP_WRAPPER
3786#define RICHCMP_WRAPPER(NAME, OP) \
3787static PyObject * \
3788richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3789{ \
3790 return wrap_richcmpfunc(self, args, wrapped, OP); \
3791}
3792
Jack Jansen8e938b42001-08-08 15:29:49 +00003793RICHCMP_WRAPPER(lt, Py_LT)
3794RICHCMP_WRAPPER(le, Py_LE)
3795RICHCMP_WRAPPER(eq, Py_EQ)
3796RICHCMP_WRAPPER(ne, Py_NE)
3797RICHCMP_WRAPPER(gt, Py_GT)
3798RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003799
Tim Peters6d6c1a32001-08-02 04:15:00 +00003800static PyObject *
3801wrap_next(PyObject *self, PyObject *args, void *wrapped)
3802{
3803 unaryfunc func = (unaryfunc)wrapped;
3804 PyObject *res;
3805
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003806 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003807 return NULL;
3808 res = (*func)(self);
3809 if (res == NULL && !PyErr_Occurred())
3810 PyErr_SetNone(PyExc_StopIteration);
3811 return res;
3812}
3813
Tim Peters6d6c1a32001-08-02 04:15:00 +00003814static PyObject *
3815wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3816{
3817 descrgetfunc func = (descrgetfunc)wrapped;
3818 PyObject *obj;
3819 PyObject *type = NULL;
3820
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003821 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003822 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003823 if (obj == Py_None)
3824 obj = NULL;
3825 if (type == Py_None)
3826 type = NULL;
3827 if (type == NULL &&obj == NULL) {
3828 PyErr_SetString(PyExc_TypeError,
3829 "__get__(None, None) is invalid");
3830 return NULL;
3831 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003832 return (*func)(self, obj, type);
3833}
3834
Tim Peters6d6c1a32001-08-02 04:15:00 +00003835static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003836wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003837{
3838 descrsetfunc func = (descrsetfunc)wrapped;
3839 PyObject *obj, *value;
3840 int ret;
3841
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003842 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003843 return NULL;
3844 ret = (*func)(self, obj, value);
3845 if (ret < 0)
3846 return NULL;
3847 Py_INCREF(Py_None);
3848 return Py_None;
3849}
Guido van Rossum22b13872002-08-06 21:41:44 +00003850
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003851static PyObject *
3852wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3853{
3854 descrsetfunc func = (descrsetfunc)wrapped;
3855 PyObject *obj;
3856 int ret;
3857
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003858 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003859 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003860 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003861 ret = (*func)(self, obj, NULL);
3862 if (ret < 0)
3863 return NULL;
3864 Py_INCREF(Py_None);
3865 return Py_None;
3866}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003867
Tim Peters6d6c1a32001-08-02 04:15:00 +00003868static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003869wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003870{
3871 initproc func = (initproc)wrapped;
3872
Guido van Rossumc8e56452001-10-22 00:43:43 +00003873 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003874 return NULL;
3875 Py_INCREF(Py_None);
3876 return Py_None;
3877}
3878
Tim Peters6d6c1a32001-08-02 04:15:00 +00003879static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003880tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003881{
Barry Warsaw60f01882001-08-22 19:24:42 +00003882 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003883 PyObject *arg0, *res;
3884
3885 if (self == NULL || !PyType_Check(self))
3886 Py_FatalError("__new__() called with non-type 'self'");
3887 type = (PyTypeObject *)self;
3888 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003889 PyErr_Format(PyExc_TypeError,
3890 "%s.__new__(): not enough arguments",
3891 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003892 return NULL;
3893 }
3894 arg0 = PyTuple_GET_ITEM(args, 0);
3895 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003896 PyErr_Format(PyExc_TypeError,
3897 "%s.__new__(X): X is not a type object (%s)",
3898 type->tp_name,
3899 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003900 return NULL;
3901 }
3902 subtype = (PyTypeObject *)arg0;
3903 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003904 PyErr_Format(PyExc_TypeError,
3905 "%s.__new__(%s): %s is not a subtype of %s",
3906 type->tp_name,
3907 subtype->tp_name,
3908 subtype->tp_name,
3909 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003910 return NULL;
3911 }
Barry Warsaw60f01882001-08-22 19:24:42 +00003912
3913 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00003914 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00003915 most derived base that's not a heap type is this type. */
3916 staticbase = subtype;
3917 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
3918 staticbase = staticbase->tp_base;
Guido van Rossuma8c60f42001-09-14 19:43:36 +00003919 if (staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003920 PyErr_Format(PyExc_TypeError,
3921 "%s.__new__(%s) is not safe, use %s.__new__()",
3922 type->tp_name,
3923 subtype->tp_name,
3924 staticbase == NULL ? "?" : staticbase->tp_name);
3925 return NULL;
3926 }
3927
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003928 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
3929 if (args == NULL)
3930 return NULL;
3931 res = type->tp_new(subtype, args, kwds);
3932 Py_DECREF(args);
3933 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003934}
3935
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003936static struct PyMethodDef tp_new_methoddef[] = {
3937 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003938 PyDoc_STR("T.__new__(S, ...) -> "
3939 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003940 {0}
3941};
3942
3943static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003944add_tp_new_wrapper(PyTypeObject *type)
3945{
Guido van Rossumf040ede2001-08-07 16:40:56 +00003946 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003947
Guido van Rossum687ae002001-10-15 22:03:32 +00003948 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00003949 return 0;
3950 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003951 if (func == NULL)
3952 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00003953 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00003954 Py_DECREF(func);
3955 return -1;
3956 }
3957 Py_DECREF(func);
3958 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003959}
3960
Guido van Rossumf040ede2001-08-07 16:40:56 +00003961/* Slot wrappers that call the corresponding __foo__ slot. See comments
3962 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003963
Guido van Rossumdc91b992001-08-08 22:26:22 +00003964#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003965static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003966FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003967{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00003968 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003969 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003970}
3971
Guido van Rossumdc91b992001-08-08 22:26:22 +00003972#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003973static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003974FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003975{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003976 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003977 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003978}
3979
Guido van Rossumcd118802003-01-06 22:57:47 +00003980/* Boolean helper for SLOT1BINFULL().
3981 right.__class__ is a nontrivial subclass of left.__class__. */
3982static int
3983method_is_overloaded(PyObject *left, PyObject *right, char *name)
3984{
3985 PyObject *a, *b;
3986 int ok;
3987
3988 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
3989 if (b == NULL) {
3990 PyErr_Clear();
3991 /* If right doesn't have it, it's not overloaded */
3992 return 0;
3993 }
3994
3995 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
3996 if (a == NULL) {
3997 PyErr_Clear();
3998 Py_DECREF(b);
3999 /* If right has it but left doesn't, it's overloaded */
4000 return 1;
4001 }
4002
4003 ok = PyObject_RichCompareBool(a, b, Py_NE);
4004 Py_DECREF(a);
4005 Py_DECREF(b);
4006 if (ok < 0) {
4007 PyErr_Clear();
4008 return 0;
4009 }
4010
4011 return ok;
4012}
4013
Guido van Rossumdc91b992001-08-08 22:26:22 +00004014
4015#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004016static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004017FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004018{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004019 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004020 int do_other = self->ob_type != other->ob_type && \
4021 other->ob_type->tp_as_number != NULL && \
4022 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004023 if (self->ob_type->tp_as_number != NULL && \
4024 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
4025 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004026 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004027 PyType_IsSubtype(other->ob_type, self->ob_type) && \
4028 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004029 r = call_maybe( \
4030 other, ROPSTR, &rcache_str, "(O)", self); \
4031 if (r != Py_NotImplemented) \
4032 return r; \
4033 Py_DECREF(r); \
4034 do_other = 0; \
4035 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004036 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004037 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004038 if (r != Py_NotImplemented || \
4039 other->ob_type == self->ob_type) \
4040 return r; \
4041 Py_DECREF(r); \
4042 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004043 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004044 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004045 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004046 } \
4047 Py_INCREF(Py_NotImplemented); \
4048 return Py_NotImplemented; \
4049}
4050
4051#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4052 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4053
4054#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4055static PyObject * \
4056FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4057{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004058 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004059 return call_method(self, OPSTR, &cache_str, \
4060 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004061}
4062
4063static int
4064slot_sq_length(PyObject *self)
4065{
Guido van Rossum2730b132001-08-28 18:22:14 +00004066 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004067 PyObject *res = call_method(self, "__len__", &len_str, "()");
Guido van Rossum630db602005-09-20 18:49:54 +00004068 long temp;
Guido van Rossum26111622001-10-01 16:42:49 +00004069 int len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004070
4071 if (res == NULL)
4072 return -1;
Guido van Rossum630db602005-09-20 18:49:54 +00004073 temp = PyInt_AsLong(res);
4074 len = (int)temp;
Guido van Rossum26111622001-10-01 16:42:49 +00004075 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00004076 if (len == -1 && PyErr_Occurred())
4077 return -1;
Guido van Rossum630db602005-09-20 18:49:54 +00004078#if SIZEOF_INT < SIZEOF_LONG
4079 /* Overflow check -- range of PyInt is more than C int */
4080 if (len != temp) {
4081 PyErr_SetString(PyExc_OverflowError,
4082 "__len__() should return 0 <= outcome < 2**31");
4083 return -1;
4084 }
4085#endif
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004086 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00004087 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004088 "__len__() should return >= 0");
4089 return -1;
4090 }
Guido van Rossum26111622001-10-01 16:42:49 +00004091 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004092}
4093
Guido van Rossumdc91b992001-08-08 22:26:22 +00004094SLOT1(slot_sq_concat, "__add__", PyObject *, "O")
4095SLOT1(slot_sq_repeat, "__mul__", int, "i")
Guido van Rossumf4593e02001-10-03 12:09:30 +00004096
4097/* Super-optimized version of slot_sq_item.
4098 Other slots could do the same... */
4099static PyObject *
4100slot_sq_item(PyObject *self, int i)
4101{
4102 static PyObject *getitem_str;
4103 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4104 descrgetfunc f;
4105
4106 if (getitem_str == NULL) {
4107 getitem_str = PyString_InternFromString("__getitem__");
4108 if (getitem_str == NULL)
4109 return NULL;
4110 }
4111 func = _PyType_Lookup(self->ob_type, getitem_str);
4112 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004113 if ((f = func->ob_type->tp_descr_get) == NULL)
4114 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004115 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004116 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004117 if (func == NULL) {
4118 return NULL;
4119 }
4120 }
Guido van Rossumf4593e02001-10-03 12:09:30 +00004121 ival = PyInt_FromLong(i);
4122 if (ival != NULL) {
4123 args = PyTuple_New(1);
4124 if (args != NULL) {
4125 PyTuple_SET_ITEM(args, 0, ival);
4126 retval = PyObject_Call(func, args, NULL);
4127 Py_XDECREF(args);
4128 Py_XDECREF(func);
4129 return retval;
4130 }
4131 }
4132 }
4133 else {
4134 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4135 }
4136 Py_XDECREF(args);
4137 Py_XDECREF(ival);
4138 Py_XDECREF(func);
4139 return NULL;
4140}
4141
Guido van Rossumdc91b992001-08-08 22:26:22 +00004142SLOT2(slot_sq_slice, "__getslice__", int, int, "ii")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004143
4144static int
4145slot_sq_ass_item(PyObject *self, int index, PyObject *value)
4146{
4147 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004148 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004149
4150 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004151 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004152 "(i)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004153 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004154 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004155 "(iO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004156 if (res == NULL)
4157 return -1;
4158 Py_DECREF(res);
4159 return 0;
4160}
4161
4162static int
4163slot_sq_ass_slice(PyObject *self, int i, int j, PyObject *value)
4164{
4165 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004166 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004167
4168 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004169 res = call_method(self, "__delslice__", &delslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004170 "(ii)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004171 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004172 res = call_method(self, "__setslice__", &setslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004173 "(iiO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004174 if (res == NULL)
4175 return -1;
4176 Py_DECREF(res);
4177 return 0;
4178}
4179
4180static int
4181slot_sq_contains(PyObject *self, PyObject *value)
4182{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004183 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004184 int result = -1;
4185
Guido van Rossum60718732001-08-28 17:47:51 +00004186 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004187
Guido van Rossum55f20992001-10-01 17:18:22 +00004188 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004189 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004190 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004191 if (args == NULL)
4192 res = NULL;
4193 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004194 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004195 Py_DECREF(args);
4196 }
4197 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004198 if (res != NULL) {
4199 result = PyObject_IsTrue(res);
4200 Py_DECREF(res);
4201 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004202 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004203 else if (! PyErr_Occurred()) {
4204 result = _PySequence_IterSearch(self, value,
4205 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004206 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004207 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004208}
4209
Guido van Rossumdc91b992001-08-08 22:26:22 +00004210SLOT1(slot_sq_inplace_concat, "__iadd__", PyObject *, "O")
4211SLOT1(slot_sq_inplace_repeat, "__imul__", int, "i")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004212
4213#define slot_mp_length slot_sq_length
4214
Guido van Rossumdc91b992001-08-08 22:26:22 +00004215SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004216
4217static int
4218slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4219{
4220 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004221 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004222
4223 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004224 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004225 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004226 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004227 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004228 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004229 if (res == NULL)
4230 return -1;
4231 Py_DECREF(res);
4232 return 0;
4233}
4234
Guido van Rossumdc91b992001-08-08 22:26:22 +00004235SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4236SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4237SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4238SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4239SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4240SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4241
Jeremy Hylton938ace62002-07-17 16:30:39 +00004242static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004243
4244SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4245 nb_power, "__pow__", "__rpow__")
4246
4247static PyObject *
4248slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4249{
Guido van Rossum2730b132001-08-28 18:22:14 +00004250 static PyObject *pow_str;
4251
Guido van Rossumdc91b992001-08-08 22:26:22 +00004252 if (modulus == Py_None)
4253 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004254 /* Three-arg power doesn't use __rpow__. But ternary_op
4255 can call this when the second argument's type uses
4256 slot_nb_power, so check before calling self.__pow__. */
4257 if (self->ob_type->tp_as_number != NULL &&
4258 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4259 return call_method(self, "__pow__", &pow_str,
4260 "(OO)", other, modulus);
4261 }
4262 Py_INCREF(Py_NotImplemented);
4263 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004264}
4265
4266SLOT0(slot_nb_negative, "__neg__")
4267SLOT0(slot_nb_positive, "__pos__")
4268SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004269
4270static int
4271slot_nb_nonzero(PyObject *self)
4272{
Tim Petersea7f75d2002-12-07 21:39:16 +00004273 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004274 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004275 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004276
Guido van Rossum55f20992001-10-01 17:18:22 +00004277 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004278 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004279 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004280 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004281 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004282 if (func == NULL)
4283 return PyErr_Occurred() ? -1 : 1;
4284 }
4285 args = PyTuple_New(0);
4286 if (args != NULL) {
4287 PyObject *temp = PyObject_Call(func, args, NULL);
4288 Py_DECREF(args);
4289 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004290 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004291 result = PyObject_IsTrue(temp);
4292 else {
4293 PyErr_Format(PyExc_TypeError,
4294 "__nonzero__ should return "
4295 "bool or int, returned %s",
4296 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004297 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004298 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004299 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004300 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004301 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004302 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004303 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004304}
4305
Guido van Rossumdc91b992001-08-08 22:26:22 +00004306SLOT0(slot_nb_invert, "__invert__")
4307SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4308SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4309SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4310SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4311SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004312
4313static int
4314slot_nb_coerce(PyObject **a, PyObject **b)
4315{
4316 static PyObject *coerce_str;
4317 PyObject *self = *a, *other = *b;
4318
4319 if (self->ob_type->tp_as_number != NULL &&
4320 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4321 PyObject *r;
4322 r = call_maybe(
4323 self, "__coerce__", &coerce_str, "(O)", other);
4324 if (r == NULL)
4325 return -1;
4326 if (r == Py_NotImplemented) {
4327 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004328 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004329 else {
4330 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4331 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004332 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004333 Py_DECREF(r);
4334 return -1;
4335 }
4336 *a = PyTuple_GET_ITEM(r, 0);
4337 Py_INCREF(*a);
4338 *b = PyTuple_GET_ITEM(r, 1);
4339 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004340 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004341 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004342 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004343 }
4344 if (other->ob_type->tp_as_number != NULL &&
4345 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4346 PyObject *r;
4347 r = call_maybe(
4348 other, "__coerce__", &coerce_str, "(O)", self);
4349 if (r == NULL)
4350 return -1;
4351 if (r == Py_NotImplemented) {
4352 Py_DECREF(r);
4353 return 1;
4354 }
4355 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4356 PyErr_SetString(PyExc_TypeError,
4357 "__coerce__ didn't return a 2-tuple");
4358 Py_DECREF(r);
4359 return -1;
4360 }
4361 *a = PyTuple_GET_ITEM(r, 1);
4362 Py_INCREF(*a);
4363 *b = PyTuple_GET_ITEM(r, 0);
4364 Py_INCREF(*b);
4365 Py_DECREF(r);
4366 return 0;
4367 }
4368 return 1;
4369}
4370
Guido van Rossumdc91b992001-08-08 22:26:22 +00004371SLOT0(slot_nb_int, "__int__")
4372SLOT0(slot_nb_long, "__long__")
4373SLOT0(slot_nb_float, "__float__")
4374SLOT0(slot_nb_oct, "__oct__")
4375SLOT0(slot_nb_hex, "__hex__")
4376SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4377SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4378SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4379SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4380SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004381SLOT1(slot_nb_inplace_power, "__ipow__", PyObject *, "O")
Guido van Rossumdc91b992001-08-08 22:26:22 +00004382SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4383SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4384SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4385SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4386SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4387SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4388 "__floordiv__", "__rfloordiv__")
4389SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4390SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4391SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004392
4393static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004394half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004395{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004396 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004397 static PyObject *cmp_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004398 int c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004399
Guido van Rossum60718732001-08-28 17:47:51 +00004400 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004401 if (func == NULL) {
4402 PyErr_Clear();
4403 }
4404 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004405 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004406 if (args == NULL)
4407 res = NULL;
4408 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004409 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004410 Py_DECREF(args);
4411 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004412 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004413 if (res != Py_NotImplemented) {
4414 if (res == NULL)
4415 return -2;
4416 c = PyInt_AsLong(res);
4417 Py_DECREF(res);
4418 if (c == -1 && PyErr_Occurred())
4419 return -2;
4420 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4421 }
4422 Py_DECREF(res);
4423 }
4424 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004425}
4426
Guido van Rossumab3b0342001-09-18 20:38:53 +00004427/* This slot is published for the benefit of try_3way_compare in object.c */
4428int
4429_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004430{
4431 int c;
4432
Guido van Rossumab3b0342001-09-18 20:38:53 +00004433 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004434 c = half_compare(self, other);
4435 if (c <= 1)
4436 return c;
4437 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004438 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004439 c = half_compare(other, self);
4440 if (c < -1)
4441 return -2;
4442 if (c <= 1)
4443 return -c;
4444 }
4445 return (void *)self < (void *)other ? -1 :
4446 (void *)self > (void *)other ? 1 : 0;
4447}
4448
4449static PyObject *
4450slot_tp_repr(PyObject *self)
4451{
4452 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004453 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004454
Guido van Rossum60718732001-08-28 17:47:51 +00004455 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004456 if (func != NULL) {
4457 res = PyEval_CallObject(func, NULL);
4458 Py_DECREF(func);
4459 return res;
4460 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004461 PyErr_Clear();
4462 return PyString_FromFormat("<%s object at %p>",
4463 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004464}
4465
4466static PyObject *
4467slot_tp_str(PyObject *self)
4468{
4469 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004470 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004471
Guido van Rossum60718732001-08-28 17:47:51 +00004472 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004473 if (func != NULL) {
4474 res = PyEval_CallObject(func, NULL);
4475 Py_DECREF(func);
4476 return res;
4477 }
4478 else {
4479 PyErr_Clear();
4480 return slot_tp_repr(self);
4481 }
4482}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004483
4484static long
4485slot_tp_hash(PyObject *self)
4486{
Tim Peters61ce0a92002-12-06 23:38:02 +00004487 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004488 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004489 long h;
4490
Guido van Rossum60718732001-08-28 17:47:51 +00004491 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004492
4493 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004494 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004495 Py_DECREF(func);
4496 if (res == NULL)
4497 return -1;
4498 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004499 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004500 }
4501 else {
4502 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004503 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004504 if (func == NULL) {
4505 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004506 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004507 }
4508 if (func != NULL) {
4509 Py_DECREF(func);
4510 PyErr_SetString(PyExc_TypeError, "unhashable type");
4511 return -1;
4512 }
4513 PyErr_Clear();
4514 h = _Py_HashPointer((void *)self);
4515 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004516 if (h == -1 && !PyErr_Occurred())
4517 h = -2;
4518 return h;
4519}
4520
4521static PyObject *
4522slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4523{
Guido van Rossum60718732001-08-28 17:47:51 +00004524 static PyObject *call_str;
4525 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004526 PyObject *res;
4527
4528 if (meth == NULL)
4529 return NULL;
4530 res = PyObject_Call(meth, args, kwds);
4531 Py_DECREF(meth);
4532 return res;
4533}
4534
Guido van Rossum14a6f832001-10-17 13:59:09 +00004535/* There are two slot dispatch functions for tp_getattro.
4536
4537 - slot_tp_getattro() is used when __getattribute__ is overridden
4538 but no __getattr__ hook is present;
4539
4540 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4541
Guido van Rossumc334df52002-04-04 23:44:47 +00004542 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4543 detects the absence of __getattr__ and then installs the simpler slot if
4544 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004545
Tim Peters6d6c1a32001-08-02 04:15:00 +00004546static PyObject *
4547slot_tp_getattro(PyObject *self, PyObject *name)
4548{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004549 static PyObject *getattribute_str = NULL;
4550 return call_method(self, "__getattribute__", &getattribute_str,
4551 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004552}
4553
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004554static PyObject *
4555slot_tp_getattr_hook(PyObject *self, PyObject *name)
4556{
4557 PyTypeObject *tp = self->ob_type;
4558 PyObject *getattr, *getattribute, *res;
4559 static PyObject *getattribute_str = NULL;
4560 static PyObject *getattr_str = NULL;
4561
4562 if (getattr_str == NULL) {
4563 getattr_str = PyString_InternFromString("__getattr__");
4564 if (getattr_str == NULL)
4565 return NULL;
4566 }
4567 if (getattribute_str == NULL) {
4568 getattribute_str =
4569 PyString_InternFromString("__getattribute__");
4570 if (getattribute_str == NULL)
4571 return NULL;
4572 }
4573 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004574 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004575 /* No __getattr__ hook: use a simpler dispatcher */
4576 tp->tp_getattro = slot_tp_getattro;
4577 return slot_tp_getattro(self, name);
4578 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004579 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004580 if (getattribute == NULL ||
4581 (getattribute->ob_type == &PyWrapperDescr_Type &&
4582 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4583 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004584 res = PyObject_GenericGetAttr(self, name);
4585 else
4586 res = PyObject_CallFunction(getattribute, "OO", self, name);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004587 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004588 PyErr_Clear();
4589 res = PyObject_CallFunction(getattr, "OO", self, name);
4590 }
4591 return res;
4592}
4593
Tim Peters6d6c1a32001-08-02 04:15:00 +00004594static int
4595slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4596{
4597 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004598 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004599
4600 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004601 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004602 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004603 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004604 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004605 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004606 if (res == NULL)
4607 return -1;
4608 Py_DECREF(res);
4609 return 0;
4610}
4611
4612/* Map rich comparison operators to their __xx__ namesakes */
4613static char *name_op[] = {
4614 "__lt__",
4615 "__le__",
4616 "__eq__",
4617 "__ne__",
4618 "__gt__",
4619 "__ge__",
4620};
4621
4622static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004623half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004624{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004625 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004626 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004627
Guido van Rossum60718732001-08-28 17:47:51 +00004628 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004629 if (func == NULL) {
4630 PyErr_Clear();
4631 Py_INCREF(Py_NotImplemented);
4632 return Py_NotImplemented;
4633 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004634 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004635 if (args == NULL)
4636 res = NULL;
4637 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004638 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004639 Py_DECREF(args);
4640 }
4641 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004642 return res;
4643}
4644
Guido van Rossumb8f63662001-08-15 23:57:02 +00004645static PyObject *
4646slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4647{
4648 PyObject *res;
4649
4650 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4651 res = half_richcompare(self, other, op);
4652 if (res != Py_NotImplemented)
4653 return res;
4654 Py_DECREF(res);
4655 }
4656 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00004657 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004658 if (res != Py_NotImplemented) {
4659 return res;
4660 }
4661 Py_DECREF(res);
4662 }
4663 Py_INCREF(Py_NotImplemented);
4664 return Py_NotImplemented;
4665}
4666
4667static PyObject *
4668slot_tp_iter(PyObject *self)
4669{
4670 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004671 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004672
Guido van Rossum60718732001-08-28 17:47:51 +00004673 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004674 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004675 PyObject *args;
4676 args = res = PyTuple_New(0);
4677 if (args != NULL) {
4678 res = PyObject_Call(func, args, NULL);
4679 Py_DECREF(args);
4680 }
4681 Py_DECREF(func);
4682 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004683 }
4684 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004685 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004686 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004687 PyErr_SetString(PyExc_TypeError,
4688 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00004689 return NULL;
4690 }
4691 Py_DECREF(func);
4692 return PySeqIter_New(self);
4693}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004694
4695static PyObject *
4696slot_tp_iternext(PyObject *self)
4697{
Guido van Rossum2730b132001-08-28 18:22:14 +00004698 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004699 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004700}
4701
Guido van Rossum1a493502001-08-17 16:47:50 +00004702static PyObject *
4703slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4704{
4705 PyTypeObject *tp = self->ob_type;
4706 PyObject *get;
4707 static PyObject *get_str = NULL;
4708
4709 if (get_str == NULL) {
4710 get_str = PyString_InternFromString("__get__");
4711 if (get_str == NULL)
4712 return NULL;
4713 }
4714 get = _PyType_Lookup(tp, get_str);
4715 if (get == NULL) {
4716 /* Avoid further slowdowns */
4717 if (tp->tp_descr_get == slot_tp_descr_get)
4718 tp->tp_descr_get = NULL;
4719 Py_INCREF(self);
4720 return self;
4721 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004722 if (obj == NULL)
4723 obj = Py_None;
4724 if (type == NULL)
4725 type = Py_None;
Guido van Rossum1a493502001-08-17 16:47:50 +00004726 return PyObject_CallFunction(get, "OOO", self, obj, type);
4727}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004728
4729static int
4730slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4731{
Guido van Rossum2c252392001-08-24 10:13:31 +00004732 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004733 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004734
4735 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004736 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004737 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004738 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004739 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004740 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004741 if (res == NULL)
4742 return -1;
4743 Py_DECREF(res);
4744 return 0;
4745}
4746
4747static int
4748slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4749{
Guido van Rossum60718732001-08-28 17:47:51 +00004750 static PyObject *init_str;
4751 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004752 PyObject *res;
4753
4754 if (meth == NULL)
4755 return -1;
4756 res = PyObject_Call(meth, args, kwds);
4757 Py_DECREF(meth);
4758 if (res == NULL)
4759 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00004760 if (res != Py_None) {
4761 PyErr_SetString(PyExc_TypeError,
4762 "__init__() should return None");
4763 Py_DECREF(res);
4764 return -1;
4765 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004766 Py_DECREF(res);
4767 return 0;
4768}
4769
4770static PyObject *
4771slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4772{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004773 static PyObject *new_str;
4774 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004775 PyObject *newargs, *x;
4776 int i, n;
4777
Guido van Rossum7bed2132002-08-08 21:57:53 +00004778 if (new_str == NULL) {
4779 new_str = PyString_InternFromString("__new__");
4780 if (new_str == NULL)
4781 return NULL;
4782 }
4783 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004784 if (func == NULL)
4785 return NULL;
4786 assert(PyTuple_Check(args));
4787 n = PyTuple_GET_SIZE(args);
4788 newargs = PyTuple_New(n+1);
4789 if (newargs == NULL)
4790 return NULL;
4791 Py_INCREF(type);
4792 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4793 for (i = 0; i < n; i++) {
4794 x = PyTuple_GET_ITEM(args, i);
4795 Py_INCREF(x);
4796 PyTuple_SET_ITEM(newargs, i+1, x);
4797 }
4798 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004799 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004800 Py_DECREF(func);
4801 return x;
4802}
4803
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004804static void
4805slot_tp_del(PyObject *self)
4806{
4807 static PyObject *del_str = NULL;
4808 PyObject *del, *res;
4809 PyObject *error_type, *error_value, *error_traceback;
4810
4811 /* Temporarily resurrect the object. */
4812 assert(self->ob_refcnt == 0);
4813 self->ob_refcnt = 1;
4814
4815 /* Save the current exception, if any. */
4816 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4817
4818 /* Execute __del__ method, if any. */
4819 del = lookup_maybe(self, "__del__", &del_str);
4820 if (del != NULL) {
4821 res = PyEval_CallObject(del, NULL);
4822 if (res == NULL)
4823 PyErr_WriteUnraisable(del);
4824 else
4825 Py_DECREF(res);
4826 Py_DECREF(del);
4827 }
4828
4829 /* Restore the saved exception. */
4830 PyErr_Restore(error_type, error_value, error_traceback);
4831
4832 /* Undo the temporary resurrection; can't use DECREF here, it would
4833 * cause a recursive call.
4834 */
4835 assert(self->ob_refcnt > 0);
4836 if (--self->ob_refcnt == 0)
4837 return; /* this is the normal path out */
4838
4839 /* __del__ resurrected it! Make it look like the original Py_DECREF
4840 * never happened.
4841 */
4842 {
4843 int refcnt = self->ob_refcnt;
4844 _Py_NewReference(self);
4845 self->ob_refcnt = refcnt;
4846 }
4847 assert(!PyType_IS_GC(self->ob_type) ||
4848 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00004849 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
4850 * we need to undo that. */
4851 _Py_DEC_REFTOTAL;
4852 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
4853 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004854 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
4855 * _Py_NewReference bumped tp_allocs: both of those need to be
4856 * undone.
4857 */
4858#ifdef COUNT_ALLOCS
4859 --self->ob_type->tp_frees;
4860 --self->ob_type->tp_allocs;
4861#endif
4862}
4863
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004864
4865/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00004866 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00004867 structure, which incorporates the additional structures used for numbers,
4868 sequences and mappings.
4869 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004870 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00004871 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
4872 terminated with an all-zero entry. (This table is further initialized and
4873 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004874
Guido van Rossum6d204072001-10-21 00:44:31 +00004875typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004876
4877#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00004878#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004879#undef ETSLOT
4880#undef SQSLOT
4881#undef MPSLOT
4882#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00004883#undef UNSLOT
4884#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004885#undef BINSLOT
4886#undef RBINSLOT
4887
Guido van Rossum6d204072001-10-21 00:44:31 +00004888#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004889 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
4890 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00004891#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
4892 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004893 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00004894#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00004895 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004896 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00004897#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4898 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
4899#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4900 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
4901#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4902 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
4903#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4904 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4905 "x." NAME "() <==> " DOC)
4906#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4907 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4908 "x." NAME "(y) <==> x" DOC "y")
4909#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
4910 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4911 "x." NAME "(y) <==> x" DOC "y")
4912#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
4913 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4914 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00004915#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4916 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4917 "x." NAME "(y) <==> " DOC)
4918#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4919 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4920 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004921
4922static slotdef slotdefs[] = {
Guido van Rossum6d204072001-10-21 00:44:31 +00004923 SQSLOT("__len__", sq_length, slot_sq_length, wrap_inquiry,
4924 "x.__len__() <==> len(x)"),
4925 SQSLOT("__add__", sq_concat, slot_sq_concat, wrap_binaryfunc,
4926 "x.__add__(y) <==> x+y"),
4927 SQSLOT("__mul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4928 "x.__mul__(n) <==> x*n"),
4929 SQSLOT("__rmul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4930 "x.__rmul__(n) <==> n*x"),
4931 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
4932 "x.__getitem__(y) <==> x[y]"),
4933 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_intintargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00004934 "x.__getslice__(i, j) <==> x[i:j]\n\
4935 \n\
4936 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004937 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004938 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004939 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004940 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004941 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Guido van Rossum6d204072001-10-21 00:44:31 +00004942 wrap_intintobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00004943 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
4944 \n\
4945 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004946 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00004947 "x.__delslice__(i, j) <==> del x[i:j]\n\
4948 \n\
4949 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004950 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
4951 "x.__contains__(y) <==> y in x"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004952 SQSLOT("__iadd__", sq_inplace_concat, slot_sq_inplace_concat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004953 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004954 SQSLOT("__imul__", sq_inplace_repeat, slot_sq_inplace_repeat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004955 wrap_intargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004956
Guido van Rossum6d204072001-10-21 00:44:31 +00004957 MPSLOT("__len__", mp_length, slot_mp_length, wrap_inquiry,
4958 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00004959 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004960 wrap_binaryfunc,
4961 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004962 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004963 wrap_objobjargproc,
4964 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004965 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004966 wrap_delitem,
4967 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004968
Guido van Rossum6d204072001-10-21 00:44:31 +00004969 BINSLOT("__add__", nb_add, slot_nb_add,
4970 "+"),
4971 RBINSLOT("__radd__", nb_add, slot_nb_add,
4972 "+"),
4973 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
4974 "-"),
4975 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
4976 "-"),
4977 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
4978 "*"),
4979 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
4980 "*"),
4981 BINSLOT("__div__", nb_divide, slot_nb_divide,
4982 "/"),
4983 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
4984 "/"),
4985 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
4986 "%"),
4987 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
4988 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00004989 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00004990 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00004991 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00004992 "divmod(y, x)"),
4993 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
4994 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
4995 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
4996 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
4997 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
4998 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
4999 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
5000 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00005001 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00005002 "x != 0"),
5003 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5004 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5005 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5006 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5007 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5008 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5009 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5010 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5011 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5012 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5013 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5014 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5015 "x.__coerce__(y) <==> coerce(x, y)"),
5016 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5017 "int(x)"),
5018 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5019 "long(x)"),
5020 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5021 "float(x)"),
5022 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5023 "oct(x)"),
5024 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5025 "hex(x)"),
5026 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5027 wrap_binaryfunc, "+"),
5028 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5029 wrap_binaryfunc, "-"),
5030 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5031 wrap_binaryfunc, "*"),
5032 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5033 wrap_binaryfunc, "/"),
5034 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5035 wrap_binaryfunc, "%"),
5036 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005037 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005038 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5039 wrap_binaryfunc, "<<"),
5040 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5041 wrap_binaryfunc, ">>"),
5042 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5043 wrap_binaryfunc, "&"),
5044 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5045 wrap_binaryfunc, "^"),
5046 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5047 wrap_binaryfunc, "|"),
5048 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5049 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5050 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5051 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5052 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5053 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5054 IBSLOT("__itruediv__", nb_inplace_true_divide,
5055 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005056
Guido van Rossum6d204072001-10-21 00:44:31 +00005057 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5058 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005059 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005060 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5061 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005062 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005063 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5064 "x.__cmp__(y) <==> cmp(x,y)"),
5065 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5066 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005067 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5068 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005069 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005070 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5071 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5072 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5073 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5074 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5075 "x.__setattr__('name', value) <==> x.name = value"),
5076 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5077 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5078 "x.__delattr__('name') <==> del x.name"),
5079 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5080 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5081 "x.__lt__(y) <==> x<y"),
5082 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5083 "x.__le__(y) <==> x<=y"),
5084 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5085 "x.__eq__(y) <==> x==y"),
5086 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5087 "x.__ne__(y) <==> x!=y"),
5088 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5089 "x.__gt__(y) <==> x>y"),
5090 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5091 "x.__ge__(y) <==> x>=y"),
5092 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5093 "x.__iter__() <==> iter(x)"),
5094 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5095 "x.next() -> the next value, or raise StopIteration"),
5096 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5097 "descr.__get__(obj[, type]) -> value"),
5098 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5099 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005100 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5101 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005102 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005103 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005104 "see x.__class__.__doc__ for signature",
5105 PyWrapperFlag_KEYWORDS),
5106 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005107 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005108 {NULL}
5109};
5110
Guido van Rossumc334df52002-04-04 23:44:47 +00005111/* Given a type pointer and an offset gotten from a slotdef entry, return a
5112 pointer to the actual slot. This is not quite the same as simply adding
5113 the offset to the type pointer, since it takes care to indirect through the
5114 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5115 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005116static void **
5117slotptr(PyTypeObject *type, int offset)
5118{
5119 char *ptr;
5120
Guido van Rossume5c691a2003-03-07 15:13:17 +00005121 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005122 assert(offset >= 0);
Guido van Rossume5c691a2003-03-07 15:13:17 +00005123 assert(offset < offsetof(PyHeapTypeObject, as_buffer));
5124 if (offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005125 ptr = (void *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005126 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005127 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005128 else if (offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Guido van Rossum09638c12002-06-13 19:17:46 +00005129 ptr = (void *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005130 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005131 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005132 else if (offset >= offsetof(PyHeapTypeObject, as_number)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005133 ptr = (void *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005134 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005135 }
5136 else {
5137 ptr = (void *)type;
5138 }
5139 if (ptr != NULL)
5140 ptr += offset;
5141 return (void **)ptr;
5142}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005143
Guido van Rossumc334df52002-04-04 23:44:47 +00005144/* Length of array of slotdef pointers used to store slots with the
5145 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5146 the same __name__, for any __name__. Since that's a static property, it is
5147 appropriate to declare fixed-size arrays for this. */
5148#define MAX_EQUIV 10
5149
5150/* Return a slot pointer for a given name, but ONLY if the attribute has
5151 exactly one slot function. The name must be an interned string. */
5152static void **
5153resolve_slotdups(PyTypeObject *type, PyObject *name)
5154{
5155 /* XXX Maybe this could be optimized more -- but is it worth it? */
5156
5157 /* pname and ptrs act as a little cache */
5158 static PyObject *pname;
5159 static slotdef *ptrs[MAX_EQUIV];
5160 slotdef *p, **pp;
5161 void **res, **ptr;
5162
5163 if (pname != name) {
5164 /* Collect all slotdefs that match name into ptrs. */
5165 pname = name;
5166 pp = ptrs;
5167 for (p = slotdefs; p->name_strobj; p++) {
5168 if (p->name_strobj == name)
5169 *pp++ = p;
5170 }
5171 *pp = NULL;
5172 }
5173
5174 /* Look in all matching slots of the type; if exactly one of these has
5175 a filled-in slot, return its value. Otherwise return NULL. */
5176 res = NULL;
5177 for (pp = ptrs; *pp; pp++) {
5178 ptr = slotptr(type, (*pp)->offset);
5179 if (ptr == NULL || *ptr == NULL)
5180 continue;
5181 if (res != NULL)
5182 return NULL;
5183 res = ptr;
5184 }
5185 return res;
5186}
5187
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005188/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005189 does some incredibly complex thinking and then sticks something into the
5190 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5191 interests, and then stores a generic wrapper or a specific function into
5192 the slot.) Return a pointer to the next slotdef with a different offset,
5193 because that's convenient for fixup_slot_dispatchers(). */
5194static slotdef *
5195update_one_slot(PyTypeObject *type, slotdef *p)
5196{
5197 PyObject *descr;
5198 PyWrapperDescrObject *d;
5199 void *generic = NULL, *specific = NULL;
5200 int use_generic = 0;
5201 int offset = p->offset;
5202 void **ptr = slotptr(type, offset);
5203
5204 if (ptr == NULL) {
5205 do {
5206 ++p;
5207 } while (p->offset == offset);
5208 return p;
5209 }
5210 do {
5211 descr = _PyType_Lookup(type, p->name_strobj);
5212 if (descr == NULL)
5213 continue;
5214 if (descr->ob_type == &PyWrapperDescr_Type) {
5215 void **tptr = resolve_slotdups(type, p->name_strobj);
5216 if (tptr == NULL || tptr == ptr)
5217 generic = p->function;
5218 d = (PyWrapperDescrObject *)descr;
5219 if (d->d_base->wrapper == p->wrapper &&
5220 PyType_IsSubtype(type, d->d_type))
5221 {
5222 if (specific == NULL ||
5223 specific == d->d_wrapped)
5224 specific = d->d_wrapped;
5225 else
5226 use_generic = 1;
5227 }
5228 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005229 else if (descr->ob_type == &PyCFunction_Type &&
5230 PyCFunction_GET_FUNCTION(descr) ==
5231 (PyCFunction)tp_new_wrapper &&
5232 strcmp(p->name, "__new__") == 0)
5233 {
5234 /* The __new__ wrapper is not a wrapper descriptor,
5235 so must be special-cased differently.
5236 If we don't do this, creating an instance will
5237 always use slot_tp_new which will look up
5238 __new__ in the MRO which will call tp_new_wrapper
5239 which will look through the base classes looking
5240 for a static base and call its tp_new (usually
5241 PyType_GenericNew), after performing various
5242 sanity checks and constructing a new argument
5243 list. Cut all that nonsense short -- this speeds
5244 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005245 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005246 /* XXX I'm not 100% sure that there isn't a hole
5247 in this reasoning that requires additional
5248 sanity checks. I'll buy the first person to
5249 point out a bug in this reasoning a beer. */
5250 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005251 else {
5252 use_generic = 1;
5253 generic = p->function;
5254 }
5255 } while ((++p)->offset == offset);
5256 if (specific && !use_generic)
5257 *ptr = specific;
5258 else
5259 *ptr = generic;
5260 return p;
5261}
5262
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005263/* In the type, update the slots whose slotdefs are gathered in the pp array.
5264 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005265static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005266update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005267{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005268 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005269
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005270 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005271 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005272 return 0;
5273}
5274
Guido van Rossumc334df52002-04-04 23:44:47 +00005275/* Comparison function for qsort() to compare slotdefs by their offset, and
5276 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005277static int
5278slotdef_cmp(const void *aa, const void *bb)
5279{
5280 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5281 int c = a->offset - b->offset;
5282 if (c != 0)
5283 return c;
5284 else
5285 return a - b;
5286}
5287
Guido van Rossumc334df52002-04-04 23:44:47 +00005288/* Initialize the slotdefs table by adding interned string objects for the
5289 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005290static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005291init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005292{
5293 slotdef *p;
5294 static int initialized = 0;
5295
5296 if (initialized)
5297 return;
5298 for (p = slotdefs; p->name; p++) {
5299 p->name_strobj = PyString_InternFromString(p->name);
5300 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005301 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005302 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005303 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5304 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005305 initialized = 1;
5306}
5307
Guido van Rossumc334df52002-04-04 23:44:47 +00005308/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005309static int
5310update_slot(PyTypeObject *type, PyObject *name)
5311{
Guido van Rossumc334df52002-04-04 23:44:47 +00005312 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005313 slotdef *p;
5314 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005315 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005316
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005317 init_slotdefs();
5318 pp = ptrs;
5319 for (p = slotdefs; p->name; p++) {
5320 /* XXX assume name is interned! */
5321 if (p->name_strobj == name)
5322 *pp++ = p;
5323 }
5324 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005325 for (pp = ptrs; *pp; pp++) {
5326 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005327 offset = p->offset;
5328 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005329 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005330 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005331 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005332 if (ptrs[0] == NULL)
5333 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005334 return update_subclasses(type, name,
5335 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005336}
5337
Guido van Rossumc334df52002-04-04 23:44:47 +00005338/* Store the proper functions in the slot dispatches at class (type)
5339 definition time, based upon which operations the class overrides in its
5340 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005341static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005342fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005343{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005344 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005345
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005346 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005347 for (p = slotdefs; p->name; )
5348 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005349}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005350
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005351static void
5352update_all_slots(PyTypeObject* type)
5353{
5354 slotdef *p;
5355
5356 init_slotdefs();
5357 for (p = slotdefs; p->name; p++) {
5358 /* update_slot returns int but can't actually fail */
5359 update_slot(type, p->name_strobj);
5360 }
5361}
5362
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005363/* recurse_down_subclasses() and update_subclasses() are mutually
5364 recursive functions to call a callback for all subclasses,
5365 but refraining from recursing into subclasses that define 'name'. */
5366
5367static int
5368update_subclasses(PyTypeObject *type, PyObject *name,
5369 update_callback callback, void *data)
5370{
5371 if (callback(type, data) < 0)
5372 return -1;
5373 return recurse_down_subclasses(type, name, callback, data);
5374}
5375
5376static int
5377recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5378 update_callback callback, void *data)
5379{
5380 PyTypeObject *subclass;
5381 PyObject *ref, *subclasses, *dict;
5382 int i, n;
5383
5384 subclasses = type->tp_subclasses;
5385 if (subclasses == NULL)
5386 return 0;
5387 assert(PyList_Check(subclasses));
5388 n = PyList_GET_SIZE(subclasses);
5389 for (i = 0; i < n; i++) {
5390 ref = PyList_GET_ITEM(subclasses, i);
5391 assert(PyWeakref_CheckRef(ref));
5392 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5393 assert(subclass != NULL);
5394 if ((PyObject *)subclass == Py_None)
5395 continue;
5396 assert(PyType_Check(subclass));
5397 /* Avoid recursing down into unaffected classes */
5398 dict = subclass->tp_dict;
5399 if (dict != NULL && PyDict_Check(dict) &&
5400 PyDict_GetItem(dict, name) != NULL)
5401 continue;
5402 if (update_subclasses(subclass, name, callback, data) < 0)
5403 return -1;
5404 }
5405 return 0;
5406}
5407
Guido van Rossum6d204072001-10-21 00:44:31 +00005408/* This function is called by PyType_Ready() to populate the type's
5409 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005410 function slot (like tp_repr) that's defined in the type, one or more
5411 corresponding descriptors are added in the type's tp_dict dictionary
5412 under the appropriate name (like __repr__). Some function slots
5413 cause more than one descriptor to be added (for example, the nb_add
5414 slot adds both __add__ and __radd__ descriptors) and some function
5415 slots compete for the same descriptor (for example both sq_item and
5416 mp_subscript generate a __getitem__ descriptor).
5417
5418 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005419 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005420 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005421 between competing slots: the members of PyHeapTypeObject are listed
5422 from most general to least general, so the most general slot is
5423 preferred. In particular, because as_mapping comes before as_sequence,
5424 for a type that defines both mp_subscript and sq_item, mp_subscript
5425 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005426
5427 This only adds new descriptors and doesn't overwrite entries in
5428 tp_dict that were previously defined. The descriptors contain a
5429 reference to the C function they must call, so that it's safe if they
5430 are copied into a subtype's __dict__ and the subtype has a different
5431 C function in its slot -- calling the method defined by the
5432 descriptor will call the C function that was used to create it,
5433 rather than the C function present in the slot when it is called.
5434 (This is important because a subtype may have a C function in the
5435 slot that calls the method from the dictionary, and we want to avoid
5436 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005437
5438static int
5439add_operators(PyTypeObject *type)
5440{
5441 PyObject *dict = type->tp_dict;
5442 slotdef *p;
5443 PyObject *descr;
5444 void **ptr;
5445
5446 init_slotdefs();
5447 for (p = slotdefs; p->name; p++) {
5448 if (p->wrapper == NULL)
5449 continue;
5450 ptr = slotptr(type, p->offset);
5451 if (!ptr || !*ptr)
5452 continue;
5453 if (PyDict_GetItem(dict, p->name_strobj))
5454 continue;
5455 descr = PyDescr_NewWrapper(type, p, *ptr);
5456 if (descr == NULL)
5457 return -1;
5458 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5459 return -1;
5460 Py_DECREF(descr);
5461 }
5462 if (type->tp_new != NULL) {
5463 if (add_tp_new_wrapper(type) < 0)
5464 return -1;
5465 }
5466 return 0;
5467}
5468
Guido van Rossum705f0f52001-08-24 16:47:00 +00005469
5470/* Cooperative 'super' */
5471
5472typedef struct {
5473 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005474 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005475 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005476 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005477} superobject;
5478
Guido van Rossum6f799372001-09-20 20:46:19 +00005479static PyMemberDef super_members[] = {
5480 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5481 "the class invoking super()"},
5482 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5483 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005484 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005485 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005486 {0}
5487};
5488
Guido van Rossum705f0f52001-08-24 16:47:00 +00005489static void
5490super_dealloc(PyObject *self)
5491{
5492 superobject *su = (superobject *)self;
5493
Guido van Rossum048eb752001-10-02 21:24:57 +00005494 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005495 Py_XDECREF(su->obj);
5496 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005497 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005498 self->ob_type->tp_free(self);
5499}
5500
5501static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005502super_repr(PyObject *self)
5503{
5504 superobject *su = (superobject *)self;
5505
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005506 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005507 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005508 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005509 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005510 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005511 else
5512 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005513 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005514 su->type ? su->type->tp_name : "NULL");
5515}
5516
5517static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005518super_getattro(PyObject *self, PyObject *name)
5519{
5520 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005521 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005522
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005523 if (!skip) {
5524 /* We want __class__ to return the class of the super object
5525 (i.e. super, or a subclass), not the class of su->obj. */
5526 skip = (PyString_Check(name) &&
5527 PyString_GET_SIZE(name) == 9 &&
5528 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5529 }
5530
5531 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005532 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005533 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005534 descrgetfunc f;
5535 int i, n;
5536
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005537 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005538 mro = starttype->tp_mro;
5539
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005540 if (mro == NULL)
5541 n = 0;
5542 else {
5543 assert(PyTuple_Check(mro));
5544 n = PyTuple_GET_SIZE(mro);
5545 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005546 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005547 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005548 break;
5549 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005550 i++;
5551 res = NULL;
5552 for (; i < n; i++) {
5553 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005554 if (PyType_Check(tmp))
5555 dict = ((PyTypeObject *)tmp)->tp_dict;
5556 else if (PyClass_Check(tmp))
5557 dict = ((PyClassObject *)tmp)->cl_dict;
5558 else
5559 continue;
5560 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005561 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005562 Py_INCREF(res);
5563 f = res->ob_type->tp_descr_get;
5564 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005565 tmp = f(res,
5566 /* Only pass 'obj' param if
5567 this is instance-mode super
5568 (See SF ID #743627)
5569 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00005570 (su->obj == (PyObject *)
5571 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005572 ? (PyObject *)NULL
5573 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00005574 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005575 Py_DECREF(res);
5576 res = tmp;
5577 }
5578 return res;
5579 }
5580 }
5581 }
5582 return PyObject_GenericGetAttr(self, name);
5583}
5584
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005585static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005586supercheck(PyTypeObject *type, PyObject *obj)
5587{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005588 /* Check that a super() call makes sense. Return a type object.
5589
5590 obj can be a new-style class, or an instance of one:
5591
5592 - If it is a class, it must be a subclass of 'type'. This case is
5593 used for class methods; the return value is obj.
5594
5595 - If it is an instance, it must be an instance of 'type'. This is
5596 the normal case; the return value is obj.__class__.
5597
5598 But... when obj is an instance, we want to allow for the case where
5599 obj->ob_type is not a subclass of type, but obj.__class__ is!
5600 This will allow using super() with a proxy for obj.
5601 */
5602
Guido van Rossum8e80a722003-02-18 19:22:22 +00005603 /* Check for first bullet above (special case) */
5604 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5605 Py_INCREF(obj);
5606 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005607 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005608
5609 /* Normal case */
5610 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005611 Py_INCREF(obj->ob_type);
5612 return obj->ob_type;
5613 }
5614 else {
5615 /* Try the slow way */
5616 static PyObject *class_str = NULL;
5617 PyObject *class_attr;
5618
5619 if (class_str == NULL) {
5620 class_str = PyString_FromString("__class__");
5621 if (class_str == NULL)
5622 return NULL;
5623 }
5624
5625 class_attr = PyObject_GetAttr(obj, class_str);
5626
5627 if (class_attr != NULL &&
5628 PyType_Check(class_attr) &&
5629 (PyTypeObject *)class_attr != obj->ob_type)
5630 {
5631 int ok = PyType_IsSubtype(
5632 (PyTypeObject *)class_attr, type);
5633 if (ok)
5634 return (PyTypeObject *)class_attr;
5635 }
5636
5637 if (class_attr == NULL)
5638 PyErr_Clear();
5639 else
5640 Py_DECREF(class_attr);
5641 }
5642
Tim Peters97e5ff52003-02-18 19:32:50 +00005643 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005644 "super(type, obj): "
5645 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005646 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005647}
5648
Guido van Rossum705f0f52001-08-24 16:47:00 +00005649static PyObject *
5650super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5651{
5652 superobject *su = (superobject *)self;
5653 superobject *new;
5654
5655 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5656 /* Not binding to an object, or already bound */
5657 Py_INCREF(self);
5658 return self;
5659 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005660 if (su->ob_type != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00005661 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005662 call its type */
5663 return PyObject_CallFunction((PyObject *)su->ob_type,
5664 "OO", su->type, obj);
5665 else {
5666 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005667 PyTypeObject *obj_type = supercheck(su->type, obj);
5668 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005669 return NULL;
5670 new = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
5671 NULL, NULL);
5672 if (new == NULL)
5673 return NULL;
5674 Py_INCREF(su->type);
5675 Py_INCREF(obj);
5676 new->type = su->type;
5677 new->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005678 new->obj_type = obj_type;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005679 return (PyObject *)new;
5680 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005681}
5682
5683static int
5684super_init(PyObject *self, PyObject *args, PyObject *kwds)
5685{
5686 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005687 PyTypeObject *type;
5688 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005689 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005690
5691 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5692 return -1;
5693 if (obj == Py_None)
5694 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005695 if (obj != NULL) {
5696 obj_type = supercheck(type, obj);
5697 if (obj_type == NULL)
5698 return -1;
5699 Py_INCREF(obj);
5700 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005701 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005702 su->type = type;
5703 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005704 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005705 return 0;
5706}
5707
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005708PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005709"super(type) -> unbound super object\n"
5710"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005711"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005712"Typical use to call a cooperative superclass method:\n"
5713"class C(B):\n"
5714" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005715" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005716
Guido van Rossum048eb752001-10-02 21:24:57 +00005717static int
5718super_traverse(PyObject *self, visitproc visit, void *arg)
5719{
5720 superobject *su = (superobject *)self;
5721 int err;
5722
5723#define VISIT(SLOT) \
5724 if (SLOT) { \
5725 err = visit((PyObject *)(SLOT), arg); \
5726 if (err) \
5727 return err; \
5728 }
5729
5730 VISIT(su->obj);
5731 VISIT(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005732 VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005733
5734#undef VISIT
5735
5736 return 0;
5737}
5738
Guido van Rossum705f0f52001-08-24 16:47:00 +00005739PyTypeObject PySuper_Type = {
5740 PyObject_HEAD_INIT(&PyType_Type)
5741 0, /* ob_size */
5742 "super", /* tp_name */
5743 sizeof(superobject), /* tp_basicsize */
5744 0, /* tp_itemsize */
5745 /* methods */
5746 super_dealloc, /* tp_dealloc */
5747 0, /* tp_print */
5748 0, /* tp_getattr */
5749 0, /* tp_setattr */
5750 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005751 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005752 0, /* tp_as_number */
5753 0, /* tp_as_sequence */
5754 0, /* tp_as_mapping */
5755 0, /* tp_hash */
5756 0, /* tp_call */
5757 0, /* tp_str */
5758 super_getattro, /* tp_getattro */
5759 0, /* tp_setattro */
5760 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005761 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5762 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005763 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00005764 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005765 0, /* tp_clear */
5766 0, /* tp_richcompare */
5767 0, /* tp_weaklistoffset */
5768 0, /* tp_iter */
5769 0, /* tp_iternext */
5770 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005771 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005772 0, /* tp_getset */
5773 0, /* tp_base */
5774 0, /* tp_dict */
5775 super_descr_get, /* tp_descr_get */
5776 0, /* tp_descr_set */
5777 0, /* tp_dictoffset */
5778 super_init, /* tp_init */
5779 PyType_GenericAlloc, /* tp_alloc */
5780 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00005781 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005782};