blob: d9146d8e375083d8668aeeff4f8218ad34bdffc4 [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;
Guido van Rossum8e829202002-08-16 03:47:49 +00001740 char buffer[256];
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001741 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001742 s = PyString_AS_STRING(tmp);
1743 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1744 (add_weak && strcmp(s, "__weakref__") == 0))
1745 continue;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001746 if (_Py_Mangle(PyString_AS_STRING(name),
Guido van Rossumad47da02002-08-12 19:05:44 +00001747 PyString_AS_STRING(tmp),
1748 buffer, sizeof(buffer)))
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001749 {
1750 tmp = PyString_FromString(buffer);
1751 } else {
1752 Py_INCREF(tmp);
1753 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001754 PyTuple_SET_ITEM(newslots, j, tmp);
1755 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001756 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001757 assert(j == nslots - add_dict - add_weak);
1758 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001759 Py_DECREF(slots);
1760 slots = newslots;
1761
Guido van Rossumad47da02002-08-12 19:05:44 +00001762 /* Secondary bases may provide weakrefs or dict */
1763 if (nbases > 1 &&
1764 ((may_add_dict && !add_dict) ||
1765 (may_add_weak && !add_weak))) {
1766 for (i = 0; i < nbases; i++) {
1767 tmp = PyTuple_GET_ITEM(bases, i);
1768 if (tmp == (PyObject *)base)
1769 continue; /* Skip primary base */
1770 if (PyClass_Check(tmp)) {
1771 /* Classic base class provides both */
1772 if (may_add_dict && !add_dict)
1773 add_dict++;
1774 if (may_add_weak && !add_weak)
1775 add_weak++;
1776 break;
1777 }
1778 assert(PyType_Check(tmp));
1779 tmptype = (PyTypeObject *)tmp;
1780 if (may_add_dict && !add_dict &&
1781 tmptype->tp_dictoffset != 0)
1782 add_dict++;
1783 if (may_add_weak && !add_weak &&
1784 tmptype->tp_weaklistoffset != 0)
1785 add_weak++;
1786 if (may_add_dict && !add_dict)
1787 continue;
1788 if (may_add_weak && !add_weak)
1789 continue;
1790 /* Nothing more to check */
1791 break;
1792 }
1793 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001794 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001795
1796 /* XXX From here until type is safely allocated,
1797 "return NULL" may leak slots! */
1798
1799 /* Allocate the type object */
1800 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001801 if (type == NULL) {
1802 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001803 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001804 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001805 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001806
1807 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001808 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001809 Py_INCREF(name);
1810 et->name = name;
1811 et->slots = slots;
1812
Guido van Rossumdc91b992001-08-08 22:26:22 +00001813 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001814 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1815 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001816 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1817 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001818
1819 /* It's a new-style number unless it specifically inherits any
1820 old-style numeric behavior */
1821 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1822 (base->tp_as_number == NULL))
1823 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1824
1825 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001826 type->tp_as_number = &et->as_number;
1827 type->tp_as_sequence = &et->as_sequence;
1828 type->tp_as_mapping = &et->as_mapping;
1829 type->tp_as_buffer = &et->as_buffer;
1830 type->tp_name = PyString_AS_STRING(name);
1831
1832 /* Set tp_base and tp_bases */
1833 type->tp_bases = bases;
1834 Py_INCREF(base);
1835 type->tp_base = base;
1836
Guido van Rossum687ae002001-10-15 22:03:32 +00001837 /* Initialize tp_dict from passed-in dict */
1838 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001839 if (dict == NULL) {
1840 Py_DECREF(type);
1841 return NULL;
1842 }
1843
Guido van Rossumc3542212001-08-16 09:18:56 +00001844 /* Set __module__ in the dict */
1845 if (PyDict_GetItemString(dict, "__module__") == NULL) {
1846 tmp = PyEval_GetGlobals();
1847 if (tmp != NULL) {
1848 tmp = PyDict_GetItemString(tmp, "__name__");
1849 if (tmp != NULL) {
1850 if (PyDict_SetItemString(dict, "__module__",
1851 tmp) < 0)
1852 return NULL;
1853 }
1854 }
1855 }
1856
Tim Peters2f93e282001-10-04 05:27:00 +00001857 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00001858 and is a string. The __doc__ accessor will first look for tp_doc;
1859 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00001860 */
1861 {
1862 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
1863 if (doc != NULL && PyString_Check(doc)) {
1864 const size_t n = (size_t)PyString_GET_SIZE(doc);
Tim Peters59f809d2001-10-04 05:43:02 +00001865 type->tp_doc = (char *)PyObject_MALLOC(n+1);
Tim Peters2f93e282001-10-04 05:27:00 +00001866 if (type->tp_doc == NULL) {
1867 Py_DECREF(type);
1868 return NULL;
1869 }
1870 memcpy(type->tp_doc, PyString_AS_STRING(doc), n+1);
1871 }
1872 }
1873
Tim Peters6d6c1a32001-08-02 04:15:00 +00001874 /* Special-case __new__: if it's a plain function,
1875 make it a static function */
1876 tmp = PyDict_GetItemString(dict, "__new__");
1877 if (tmp != NULL && PyFunction_Check(tmp)) {
1878 tmp = PyStaticMethod_New(tmp);
1879 if (tmp == NULL) {
1880 Py_DECREF(type);
1881 return NULL;
1882 }
1883 PyDict_SetItemString(dict, "__new__", tmp);
1884 Py_DECREF(tmp);
1885 }
1886
1887 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001888 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00001889 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001890 if (slots != NULL) {
1891 for (i = 0; i < nslots; i++, mp++) {
1892 mp->name = PyString_AS_STRING(
1893 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00001894 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001895 mp->offset = slotoffset;
Guido van Rossum9676b222001-08-17 20:32:36 +00001896 if (base->tp_weaklistoffset == 0 &&
Guido van Rossum64b206c2001-12-04 17:13:22 +00001897 strcmp(mp->name, "__weakref__") == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001898 add_weak++;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001899 mp->type = T_OBJECT;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001900 mp->flags = READONLY;
Guido van Rossum9676b222001-08-17 20:32:36 +00001901 type->tp_weaklistoffset = slotoffset;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001902 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001903 slotoffset += sizeof(PyObject *);
1904 }
1905 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001906 if (add_dict) {
1907 if (base->tp_itemsize)
1908 type->tp_dictoffset = -(long)sizeof(PyObject *);
1909 else
1910 type->tp_dictoffset = slotoffset;
1911 slotoffset += sizeof(PyObject *);
1912 }
1913 if (add_weak) {
1914 assert(!base->tp_itemsize);
1915 type->tp_weaklistoffset = slotoffset;
1916 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001917 }
1918 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001919 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001920 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00001921
1922 if (type->tp_weaklistoffset && type->tp_dictoffset)
1923 type->tp_getset = subtype_getsets_full;
1924 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
1925 type->tp_getset = subtype_getsets_weakref_only;
1926 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
1927 type->tp_getset = subtype_getsets_dict_only;
1928 else
1929 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001930
1931 /* Special case some slots */
1932 if (type->tp_dictoffset != 0 || nslots > 0) {
1933 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
1934 type->tp_getattro = PyObject_GenericGetAttr;
1935 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
1936 type->tp_setattro = PyObject_GenericSetAttr;
1937 }
1938 type->tp_dealloc = subtype_dealloc;
1939
Guido van Rossum9475a232001-10-05 20:51:39 +00001940 /* Enable GC unless there are really no instance variables possible */
1941 if (!(type->tp_basicsize == sizeof(PyObject) &&
1942 type->tp_itemsize == 0))
1943 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
1944
Tim Peters6d6c1a32001-08-02 04:15:00 +00001945 /* Always override allocation strategy to use regular heap */
1946 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00001947 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001948 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00001949 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001950 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00001951 }
1952 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001953 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001954
1955 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001956 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001957 Py_DECREF(type);
1958 return NULL;
1959 }
1960
Guido van Rossum7b9144b2001-10-09 19:39:46 +00001961 /* Put the proper slots in place */
1962 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00001963
Tim Peters6d6c1a32001-08-02 04:15:00 +00001964 return (PyObject *)type;
1965}
1966
1967/* Internal API to look for a name through the MRO.
1968 This returns a borrowed reference, and doesn't set an exception! */
1969PyObject *
1970_PyType_Lookup(PyTypeObject *type, PyObject *name)
1971{
1972 int i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00001973 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001974
Guido van Rossum687ae002001-10-15 22:03:32 +00001975 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001976 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00001977
1978 /* If mro is NULL, the type is either not yet initialized
1979 by PyType_Ready(), or already cleared by type_clear().
1980 Either way the safest thing to do is to return NULL. */
1981 if (mro == NULL)
1982 return NULL;
1983
Tim Peters6d6c1a32001-08-02 04:15:00 +00001984 assert(PyTuple_Check(mro));
1985 n = PyTuple_GET_SIZE(mro);
1986 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001987 base = PyTuple_GET_ITEM(mro, i);
1988 if (PyClass_Check(base))
1989 dict = ((PyClassObject *)base)->cl_dict;
1990 else {
1991 assert(PyType_Check(base));
1992 dict = ((PyTypeObject *)base)->tp_dict;
1993 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001994 assert(dict && PyDict_Check(dict));
1995 res = PyDict_GetItem(dict, name);
1996 if (res != NULL)
1997 return res;
1998 }
1999 return NULL;
2000}
2001
2002/* This is similar to PyObject_GenericGetAttr(),
2003 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
2004static PyObject *
2005type_getattro(PyTypeObject *type, PyObject *name)
2006{
2007 PyTypeObject *metatype = type->ob_type;
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002008 PyObject *meta_attribute, *attribute;
2009 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002010
2011 /* Initialize this type (we'll assume the metatype is initialized) */
2012 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002013 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002014 return NULL;
2015 }
2016
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002017 /* No readable descriptor found yet */
2018 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002019
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002020 /* Look for the attribute in the metatype */
2021 meta_attribute = _PyType_Lookup(metatype, name);
2022
2023 if (meta_attribute != NULL) {
2024 meta_get = meta_attribute->ob_type->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002025
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002026 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2027 /* Data descriptors implement tp_descr_set to intercept
2028 * writes. Assume the attribute is not overridden in
2029 * type's tp_dict (and bases): call the descriptor now.
2030 */
2031 return meta_get(meta_attribute, (PyObject *)type,
2032 (PyObject *)metatype);
2033 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002034 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002035 }
2036
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002037 /* No data descriptor found on metatype. Look in tp_dict of this
2038 * type and its bases */
2039 attribute = _PyType_Lookup(type, name);
2040 if (attribute != NULL) {
2041 /* Implement descriptor functionality, if any */
2042 descrgetfunc local_get = attribute->ob_type->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002043
2044 Py_XDECREF(meta_attribute);
2045
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002046 if (local_get != NULL) {
2047 /* NULL 2nd argument indicates the descriptor was
2048 * found on the target object itself (or a base) */
2049 return local_get(attribute, (PyObject *)NULL,
2050 (PyObject *)type);
2051 }
Tim Peters34592512002-07-11 06:23:50 +00002052
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002053 Py_INCREF(attribute);
2054 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002055 }
2056
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002057 /* No attribute found in local __dict__ (or bases): use the
2058 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002059 if (meta_get != NULL) {
2060 PyObject *res;
2061 res = meta_get(meta_attribute, (PyObject *)type,
2062 (PyObject *)metatype);
2063 Py_DECREF(meta_attribute);
2064 return res;
2065 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002066
2067 /* If an ordinary attribute was found on the metatype, return it now */
2068 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002069 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002070 }
2071
2072 /* Give up */
2073 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002074 "type object '%.50s' has no attribute '%.400s'",
2075 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002076 return NULL;
2077}
2078
2079static int
2080type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2081{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002082 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2083 PyErr_Format(
2084 PyExc_TypeError,
2085 "can't set attributes of built-in/extension type '%s'",
2086 type->tp_name);
2087 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002088 }
Guido van Rossum8d24ee92003-03-24 23:49:49 +00002089 /* XXX Example of how I expect this to be used...
2090 if (update_subclasses(type, name, invalidate_cache, NULL) < 0)
2091 return -1;
2092 */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002093 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2094 return -1;
2095 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002096}
2097
2098static void
2099type_dealloc(PyTypeObject *type)
2100{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002101 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002102
2103 /* Assert this is a heap-allocated type object */
2104 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002105 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002106 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002107 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002108 Py_XDECREF(type->tp_base);
2109 Py_XDECREF(type->tp_dict);
2110 Py_XDECREF(type->tp_bases);
2111 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002112 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002113 Py_XDECREF(type->tp_subclasses);
Neal Norwitzcee5ca02002-07-30 00:42:06 +00002114 PyObject_Free(type->tp_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002115 Py_XDECREF(et->name);
2116 Py_XDECREF(et->slots);
2117 type->ob_type->tp_free((PyObject *)type);
2118}
2119
Guido van Rossum1c450732001-10-08 15:18:27 +00002120static PyObject *
2121type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2122{
2123 PyObject *list, *raw, *ref;
2124 int i, n;
2125
2126 list = PyList_New(0);
2127 if (list == NULL)
2128 return NULL;
2129 raw = type->tp_subclasses;
2130 if (raw == NULL)
2131 return list;
2132 assert(PyList_Check(raw));
2133 n = PyList_GET_SIZE(raw);
2134 for (i = 0; i < n; i++) {
2135 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002136 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002137 ref = PyWeakref_GET_OBJECT(ref);
2138 if (ref != Py_None) {
2139 if (PyList_Append(list, ref) < 0) {
2140 Py_DECREF(list);
2141 return NULL;
2142 }
2143 }
2144 }
2145 return list;
2146}
2147
Tim Peters6d6c1a32001-08-02 04:15:00 +00002148static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002149 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002150 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002151 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002152 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002153 {0}
2154};
2155
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002156PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002157"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002158"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002159
Guido van Rossum048eb752001-10-02 21:24:57 +00002160static int
2161type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2162{
Guido van Rossum048eb752001-10-02 21:24:57 +00002163 int err;
2164
Guido van Rossuma3862092002-06-10 15:24:42 +00002165 /* Because of type_is_gc(), the collector only calls this
2166 for heaptypes. */
2167 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002168
2169#define VISIT(SLOT) \
2170 if (SLOT) { \
2171 err = visit((PyObject *)(SLOT), arg); \
2172 if (err) \
2173 return err; \
2174 }
2175
2176 VISIT(type->tp_dict);
Guido van Rossum687ae002001-10-15 22:03:32 +00002177 VISIT(type->tp_cache);
Guido van Rossum048eb752001-10-02 21:24:57 +00002178 VISIT(type->tp_mro);
2179 VISIT(type->tp_bases);
2180 VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002181
2182 /* There's no need to visit type->tp_subclasses or
Guido van Rossume5c691a2003-03-07 15:13:17 +00002183 ((PyHeapTypeObject *)type)->slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002184 in cycles; tp_subclasses is a list of weak references,
2185 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002186
2187#undef VISIT
2188
2189 return 0;
2190}
2191
2192static int
2193type_clear(PyTypeObject *type)
2194{
Guido van Rossum048eb752001-10-02 21:24:57 +00002195 PyObject *tmp;
2196
Guido van Rossuma3862092002-06-10 15:24:42 +00002197 /* Because of type_is_gc(), the collector only calls this
2198 for heaptypes. */
2199 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002200
2201#define CLEAR(SLOT) \
2202 if (SLOT) { \
2203 tmp = (PyObject *)(SLOT); \
2204 SLOT = NULL; \
2205 Py_DECREF(tmp); \
2206 }
2207
Guido van Rossuma3862092002-06-10 15:24:42 +00002208 /* The only field we need to clear is tp_mro, which is part of a
2209 hard cycle (its first element is the class itself) that won't
2210 be broken otherwise (it's a tuple and tuples don't have a
2211 tp_clear handler). None of the other fields need to be
2212 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002213
Guido van Rossuma3862092002-06-10 15:24:42 +00002214 tp_dict:
2215 It is a dict, so the collector will call its tp_clear.
2216
2217 tp_cache:
2218 Not used; if it were, it would be a dict.
2219
2220 tp_bases, tp_base:
2221 If these are involved in a cycle, there must be at least
2222 one other, mutable object in the cycle, e.g. a base
2223 class's dict; the cycle will be broken that way.
2224
2225 tp_subclasses:
2226 A list of weak references can't be part of a cycle; and
2227 lists have their own tp_clear.
2228
Guido van Rossume5c691a2003-03-07 15:13:17 +00002229 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002230 A tuple of strings can't be part of a cycle.
2231 */
2232
2233 CLEAR(type->tp_mro);
Tim Peters2f93e282001-10-04 05:27:00 +00002234
Guido van Rossum048eb752001-10-02 21:24:57 +00002235#undef CLEAR
2236
2237 return 0;
2238}
2239
2240static int
2241type_is_gc(PyTypeObject *type)
2242{
2243 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2244}
2245
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002246PyTypeObject PyType_Type = {
2247 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002248 0, /* ob_size */
2249 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002250 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002251 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002252 (destructor)type_dealloc, /* tp_dealloc */
2253 0, /* tp_print */
2254 0, /* tp_getattr */
2255 0, /* tp_setattr */
2256 type_compare, /* tp_compare */
2257 (reprfunc)type_repr, /* tp_repr */
2258 0, /* tp_as_number */
2259 0, /* tp_as_sequence */
2260 0, /* tp_as_mapping */
2261 (hashfunc)_Py_HashPointer, /* tp_hash */
2262 (ternaryfunc)type_call, /* tp_call */
2263 0, /* tp_str */
2264 (getattrofunc)type_getattro, /* tp_getattro */
2265 (setattrofunc)type_setattro, /* tp_setattro */
2266 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002267 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
2268 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002269 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002270 (traverseproc)type_traverse, /* tp_traverse */
2271 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002272 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002273 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002274 0, /* tp_iter */
2275 0, /* tp_iternext */
2276 type_methods, /* tp_methods */
2277 type_members, /* tp_members */
2278 type_getsets, /* tp_getset */
2279 0, /* tp_base */
2280 0, /* tp_dict */
2281 0, /* tp_descr_get */
2282 0, /* tp_descr_set */
2283 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
2284 0, /* tp_init */
2285 0, /* tp_alloc */
2286 type_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002287 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002288 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002289};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002290
2291
2292/* The base type of all types (eventually)... except itself. */
2293
2294static int
2295object_init(PyObject *self, PyObject *args, PyObject *kwds)
2296{
2297 return 0;
2298}
2299
Guido van Rossum298e4212003-02-13 16:30:16 +00002300/* If we don't have a tp_new for a new-style class, new will use this one.
2301 Therefore this should take no arguments/keywords. However, this new may
2302 also be inherited by objects that define a tp_init but no tp_new. These
2303 objects WILL pass argumets to tp_new, because it gets the same args as
2304 tp_init. So only allow arguments if we aren't using the default init, in
2305 which case we expect init to handle argument parsing. */
2306static PyObject *
2307object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2308{
2309 if (type->tp_init == object_init && (PyTuple_GET_SIZE(args) ||
2310 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds)))) {
2311 PyErr_SetString(PyExc_TypeError,
2312 "default __new__ takes no parameters");
2313 return NULL;
2314 }
2315 return type->tp_alloc(type, 0);
2316}
2317
Tim Peters6d6c1a32001-08-02 04:15:00 +00002318static void
2319object_dealloc(PyObject *self)
2320{
2321 self->ob_type->tp_free(self);
2322}
2323
Guido van Rossum8e248182001-08-12 05:17:56 +00002324static PyObject *
2325object_repr(PyObject *self)
2326{
Guido van Rossum76e69632001-08-16 18:52:43 +00002327 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002328 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002329
Guido van Rossum76e69632001-08-16 18:52:43 +00002330 type = self->ob_type;
2331 mod = type_module(type, NULL);
2332 if (mod == NULL)
2333 PyErr_Clear();
2334 else if (!PyString_Check(mod)) {
2335 Py_DECREF(mod);
2336 mod = NULL;
2337 }
2338 name = type_name(type, NULL);
2339 if (name == NULL)
2340 return NULL;
2341 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002342 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002343 PyString_AS_STRING(mod),
2344 PyString_AS_STRING(name),
2345 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002346 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002347 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002348 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002349 Py_XDECREF(mod);
2350 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002351 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002352}
2353
Guido van Rossumb8f63662001-08-15 23:57:02 +00002354static PyObject *
2355object_str(PyObject *self)
2356{
2357 unaryfunc f;
2358
2359 f = self->ob_type->tp_repr;
2360 if (f == NULL)
2361 f = object_repr;
2362 return f(self);
2363}
2364
Guido van Rossum8e248182001-08-12 05:17:56 +00002365static long
2366object_hash(PyObject *self)
2367{
2368 return _Py_HashPointer(self);
2369}
Guido van Rossum8e248182001-08-12 05:17:56 +00002370
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002371static PyObject *
2372object_get_class(PyObject *self, void *closure)
2373{
2374 Py_INCREF(self->ob_type);
2375 return (PyObject *)(self->ob_type);
2376}
2377
2378static int
2379equiv_structs(PyTypeObject *a, PyTypeObject *b)
2380{
2381 return a == b ||
2382 (a != NULL &&
2383 b != NULL &&
2384 a->tp_basicsize == b->tp_basicsize &&
2385 a->tp_itemsize == b->tp_itemsize &&
2386 a->tp_dictoffset == b->tp_dictoffset &&
2387 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2388 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2389 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2390}
2391
2392static int
2393same_slots_added(PyTypeObject *a, PyTypeObject *b)
2394{
2395 PyTypeObject *base = a->tp_base;
2396 int size;
2397
2398 if (base != b->tp_base)
2399 return 0;
2400 if (equiv_structs(a, base) && equiv_structs(b, base))
2401 return 1;
2402 size = base->tp_basicsize;
2403 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2404 size += sizeof(PyObject *);
2405 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2406 size += sizeof(PyObject *);
2407 return size == a->tp_basicsize && size == b->tp_basicsize;
2408}
2409
2410static int
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002411compatible_for_assignment(PyTypeObject* old, PyTypeObject* new, char* attr)
2412{
2413 PyTypeObject *newbase, *oldbase;
2414
2415 if (new->tp_dealloc != old->tp_dealloc ||
2416 new->tp_free != old->tp_free)
2417 {
2418 PyErr_Format(PyExc_TypeError,
2419 "%s assignment: "
2420 "'%s' deallocator differs from '%s'",
2421 attr,
2422 new->tp_name,
2423 old->tp_name);
2424 return 0;
2425 }
2426 newbase = new;
2427 oldbase = old;
2428 while (equiv_structs(newbase, newbase->tp_base))
2429 newbase = newbase->tp_base;
2430 while (equiv_structs(oldbase, oldbase->tp_base))
2431 oldbase = oldbase->tp_base;
2432 if (newbase != oldbase &&
2433 (newbase->tp_base != oldbase->tp_base ||
2434 !same_slots_added(newbase, oldbase))) {
2435 PyErr_Format(PyExc_TypeError,
2436 "%s assignment: "
2437 "'%s' object layout differs from '%s'",
2438 attr,
2439 new->tp_name,
2440 old->tp_name);
2441 return 0;
2442 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002443
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002444 return 1;
2445}
2446
2447static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002448object_set_class(PyObject *self, PyObject *value, void *closure)
2449{
2450 PyTypeObject *old = self->ob_type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002451 PyTypeObject *new;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002452
Guido van Rossumb6b89422002-04-15 01:03:30 +00002453 if (value == NULL) {
2454 PyErr_SetString(PyExc_TypeError,
2455 "can't delete __class__ attribute");
2456 return -1;
2457 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002458 if (!PyType_Check(value)) {
2459 PyErr_Format(PyExc_TypeError,
2460 "__class__ must be set to new-style class, not '%s' object",
2461 value->ob_type->tp_name);
2462 return -1;
2463 }
2464 new = (PyTypeObject *)value;
Guido van Rossum40af8892002-08-10 05:42:07 +00002465 if (!(new->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2466 !(old->tp_flags & Py_TPFLAGS_HEAPTYPE))
2467 {
2468 PyErr_Format(PyExc_TypeError,
2469 "__class__ assignment: only for heap types");
2470 return -1;
2471 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002472 if (compatible_for_assignment(new, old, "__class__")) {
2473 Py_INCREF(new);
2474 self->ob_type = new;
2475 Py_DECREF(old);
2476 return 0;
2477 }
2478 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002479 return -1;
2480 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002481}
2482
2483static PyGetSetDef object_getsets[] = {
2484 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002485 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002486 {0}
2487};
2488
Guido van Rossumc53f0092003-02-18 22:05:12 +00002489
Guido van Rossum036f9992003-02-21 22:02:54 +00002490/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2491 We fall back to helpers in copy_reg for:
2492 - pickle protocols < 2
2493 - calculating the list of slot names (done only once per class)
2494 - the __newobj__ function (which is used as a token but never called)
2495*/
2496
2497static PyObject *
2498import_copy_reg(void)
2499{
2500 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002501
2502 if (!copy_reg_str) {
2503 copy_reg_str = PyString_InternFromString("copy_reg");
2504 if (copy_reg_str == NULL)
2505 return NULL;
2506 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002507
2508 return PyImport_Import(copy_reg_str);
2509}
2510
2511static PyObject *
2512slotnames(PyObject *cls)
2513{
2514 PyObject *clsdict;
2515 PyObject *copy_reg;
2516 PyObject *slotnames;
2517
2518 if (!PyType_Check(cls)) {
2519 Py_INCREF(Py_None);
2520 return Py_None;
2521 }
2522
2523 clsdict = ((PyTypeObject *)cls)->tp_dict;
2524 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
2525 if (slotnames != NULL) {
2526 Py_INCREF(slotnames);
2527 return slotnames;
2528 }
2529
2530 copy_reg = import_copy_reg();
2531 if (copy_reg == NULL)
2532 return NULL;
2533
2534 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2535 Py_DECREF(copy_reg);
2536 if (slotnames != NULL &&
2537 slotnames != Py_None &&
2538 !PyList_Check(slotnames))
2539 {
2540 PyErr_SetString(PyExc_TypeError,
2541 "copy_reg._slotnames didn't return a list or None");
2542 Py_DECREF(slotnames);
2543 slotnames = NULL;
2544 }
2545
2546 return slotnames;
2547}
2548
2549static PyObject *
2550reduce_2(PyObject *obj)
2551{
2552 PyObject *cls, *getnewargs;
2553 PyObject *args = NULL, *args2 = NULL;
2554 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2555 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2556 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
2557 int i, n;
2558
2559 cls = PyObject_GetAttrString(obj, "__class__");
2560 if (cls == NULL)
2561 return NULL;
2562
2563 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2564 if (getnewargs != NULL) {
2565 args = PyObject_CallObject(getnewargs, NULL);
2566 Py_DECREF(getnewargs);
2567 if (args != NULL && !PyTuple_Check(args)) {
2568 PyErr_SetString(PyExc_TypeError,
2569 "__getnewargs__ should return a tuple");
2570 goto end;
2571 }
2572 }
2573 else {
2574 PyErr_Clear();
2575 args = PyTuple_New(0);
2576 }
2577 if (args == NULL)
2578 goto end;
2579
2580 getstate = PyObject_GetAttrString(obj, "__getstate__");
2581 if (getstate != NULL) {
2582 state = PyObject_CallObject(getstate, NULL);
2583 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00002584 if (state == NULL)
2585 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00002586 }
2587 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00002588 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00002589 state = PyObject_GetAttrString(obj, "__dict__");
2590 if (state == NULL) {
2591 PyErr_Clear();
2592 state = Py_None;
2593 Py_INCREF(state);
2594 }
2595 names = slotnames(cls);
2596 if (names == NULL)
2597 goto end;
2598 if (names != Py_None) {
2599 assert(PyList_Check(names));
2600 slots = PyDict_New();
2601 if (slots == NULL)
2602 goto end;
2603 n = 0;
2604 /* Can't pre-compute the list size; the list
2605 is stored on the class so accessible to other
2606 threads, which may be run by DECREF */
2607 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2608 PyObject *name, *value;
2609 name = PyList_GET_ITEM(names, i);
2610 value = PyObject_GetAttr(obj, name);
2611 if (value == NULL)
2612 PyErr_Clear();
2613 else {
2614 int err = PyDict_SetItem(slots, name,
2615 value);
2616 Py_DECREF(value);
2617 if (err)
2618 goto end;
2619 n++;
2620 }
2621 }
2622 if (n) {
2623 state = Py_BuildValue("(NO)", state, slots);
2624 if (state == NULL)
2625 goto end;
2626 }
2627 }
2628 }
2629
2630 if (!PyList_Check(obj)) {
2631 listitems = Py_None;
2632 Py_INCREF(listitems);
2633 }
2634 else {
2635 listitems = PyObject_GetIter(obj);
2636 if (listitems == NULL)
2637 goto end;
2638 }
2639
2640 if (!PyDict_Check(obj)) {
2641 dictitems = Py_None;
2642 Py_INCREF(dictitems);
2643 }
2644 else {
2645 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2646 if (dictitems == NULL)
2647 goto end;
2648 }
2649
2650 copy_reg = import_copy_reg();
2651 if (copy_reg == NULL)
2652 goto end;
2653 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2654 if (newobj == NULL)
2655 goto end;
2656
2657 n = PyTuple_GET_SIZE(args);
2658 args2 = PyTuple_New(n+1);
2659 if (args2 == NULL)
2660 goto end;
2661 PyTuple_SET_ITEM(args2, 0, cls);
2662 cls = NULL;
2663 for (i = 0; i < n; i++) {
2664 PyObject *v = PyTuple_GET_ITEM(args, i);
2665 Py_INCREF(v);
2666 PyTuple_SET_ITEM(args2, i+1, v);
2667 }
2668
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002669 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00002670
2671 end:
2672 Py_XDECREF(cls);
2673 Py_XDECREF(args);
2674 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002675 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002676 Py_XDECREF(state);
2677 Py_XDECREF(names);
2678 Py_XDECREF(listitems);
2679 Py_XDECREF(dictitems);
2680 Py_XDECREF(copy_reg);
2681 Py_XDECREF(newobj);
2682 return res;
2683}
2684
2685static PyObject *
2686object_reduce_ex(PyObject *self, PyObject *args)
2687{
2688 /* Call copy_reg._reduce_ex(self, proto) */
2689 PyObject *reduce, *copy_reg, *res;
2690 int proto = 0;
2691
2692 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2693 return NULL;
2694
2695 reduce = PyObject_GetAttrString(self, "__reduce__");
2696 if (reduce == NULL)
2697 PyErr_Clear();
2698 else {
2699 PyObject *cls, *clsreduce, *objreduce;
2700 int override;
2701 cls = PyObject_GetAttrString(self, "__class__");
2702 if (cls == NULL) {
2703 Py_DECREF(reduce);
2704 return NULL;
2705 }
2706 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2707 Py_DECREF(cls);
2708 if (clsreduce == NULL) {
2709 Py_DECREF(reduce);
2710 return NULL;
2711 }
2712 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2713 "__reduce__");
2714 override = (clsreduce != objreduce);
2715 Py_DECREF(clsreduce);
2716 if (override) {
2717 res = PyObject_CallObject(reduce, NULL);
2718 Py_DECREF(reduce);
2719 return res;
2720 }
2721 else
2722 Py_DECREF(reduce);
2723 }
2724
2725 if (proto >= 2)
2726 return reduce_2(self);
2727
2728 copy_reg = import_copy_reg();
Guido van Rossum3926a632001-09-25 16:25:58 +00002729 if (!copy_reg)
2730 return NULL;
Guido van Rossum036f9992003-02-21 22:02:54 +00002731
Guido van Rossumc53f0092003-02-18 22:05:12 +00002732 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00002733 Py_DECREF(copy_reg);
Guido van Rossum036f9992003-02-21 22:02:54 +00002734
Guido van Rossum3926a632001-09-25 16:25:58 +00002735 return res;
2736}
2737
2738static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00002739 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
2740 PyDoc_STR("helper for pickle")},
2741 {"__reduce__", object_reduce_ex, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002742 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00002743 {0}
2744};
2745
Guido van Rossum036f9992003-02-21 22:02:54 +00002746
Tim Peters6d6c1a32001-08-02 04:15:00 +00002747PyTypeObject PyBaseObject_Type = {
2748 PyObject_HEAD_INIT(&PyType_Type)
2749 0, /* ob_size */
2750 "object", /* tp_name */
2751 sizeof(PyObject), /* tp_basicsize */
2752 0, /* tp_itemsize */
2753 (destructor)object_dealloc, /* tp_dealloc */
2754 0, /* tp_print */
2755 0, /* tp_getattr */
2756 0, /* tp_setattr */
2757 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002758 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002759 0, /* tp_as_number */
2760 0, /* tp_as_sequence */
2761 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002762 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002763 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002764 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002765 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002766 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002767 0, /* tp_as_buffer */
2768 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002769 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002770 0, /* tp_traverse */
2771 0, /* tp_clear */
2772 0, /* tp_richcompare */
2773 0, /* tp_weaklistoffset */
2774 0, /* tp_iter */
2775 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00002776 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002777 0, /* tp_members */
2778 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002779 0, /* tp_base */
2780 0, /* tp_dict */
2781 0, /* tp_descr_get */
2782 0, /* tp_descr_set */
2783 0, /* tp_dictoffset */
2784 object_init, /* tp_init */
2785 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00002786 object_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002787 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002788};
2789
2790
2791/* Initialize the __dict__ in a type object */
2792
2793static int
2794add_methods(PyTypeObject *type, PyMethodDef *meth)
2795{
Guido van Rossum687ae002001-10-15 22:03:32 +00002796 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002797
2798 for (; meth->ml_name != NULL; meth++) {
2799 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002800 if (PyDict_GetItemString(dict, meth->ml_name) &&
2801 !(meth->ml_flags & METH_COEXIST))
2802 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002803 if (meth->ml_flags & METH_CLASS) {
2804 if (meth->ml_flags & METH_STATIC) {
2805 PyErr_SetString(PyExc_ValueError,
2806 "method cannot be both class and static");
2807 return -1;
2808 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002809 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002810 }
2811 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002812 PyObject *cfunc = PyCFunction_New(meth, NULL);
2813 if (cfunc == NULL)
2814 return -1;
2815 descr = PyStaticMethod_New(cfunc);
2816 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002817 }
2818 else {
2819 descr = PyDescr_NewMethod(type, meth);
2820 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002821 if (descr == NULL)
2822 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002823 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002824 return -1;
2825 Py_DECREF(descr);
2826 }
2827 return 0;
2828}
2829
2830static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002831add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002832{
Guido van Rossum687ae002001-10-15 22:03:32 +00002833 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002834
2835 for (; memb->name != NULL; memb++) {
2836 PyObject *descr;
2837 if (PyDict_GetItemString(dict, memb->name))
2838 continue;
2839 descr = PyDescr_NewMember(type, memb);
2840 if (descr == NULL)
2841 return -1;
2842 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2843 return -1;
2844 Py_DECREF(descr);
2845 }
2846 return 0;
2847}
2848
2849static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002850add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002851{
Guido van Rossum687ae002001-10-15 22:03:32 +00002852 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002853
2854 for (; gsp->name != NULL; gsp++) {
2855 PyObject *descr;
2856 if (PyDict_GetItemString(dict, gsp->name))
2857 continue;
2858 descr = PyDescr_NewGetSet(type, gsp);
2859
2860 if (descr == NULL)
2861 return -1;
2862 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2863 return -1;
2864 Py_DECREF(descr);
2865 }
2866 return 0;
2867}
2868
Guido van Rossum13d52f02001-08-10 21:24:08 +00002869static void
2870inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002871{
2872 int oldsize, newsize;
2873
Guido van Rossum13d52f02001-08-10 21:24:08 +00002874 /* Special flag magic */
2875 if (!type->tp_as_buffer && base->tp_as_buffer) {
2876 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2877 type->tp_flags |=
2878 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2879 }
2880 if (!type->tp_as_sequence && base->tp_as_sequence) {
2881 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2882 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2883 }
2884 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2885 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2886 if ((!type->tp_as_number && base->tp_as_number) ||
2887 (!type->tp_as_sequence && base->tp_as_sequence)) {
2888 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2889 if (!type->tp_as_number && !type->tp_as_sequence) {
2890 type->tp_flags |= base->tp_flags &
2891 Py_TPFLAGS_HAVE_INPLACEOPS;
2892 }
2893 }
2894 /* Wow */
2895 }
2896 if (!type->tp_as_number && base->tp_as_number) {
2897 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2898 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2899 }
2900
2901 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002902 oldsize = base->tp_basicsize;
2903 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2904 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2905 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002906 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2907 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002908 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002909 if (type->tp_traverse == NULL)
2910 type->tp_traverse = base->tp_traverse;
2911 if (type->tp_clear == NULL)
2912 type->tp_clear = base->tp_clear;
2913 }
2914 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002915 /* The condition below could use some explanation.
2916 It appears that tp_new is not inherited for static types
2917 whose base class is 'object'; this seems to be a precaution
2918 so that old extension types don't suddenly become
2919 callable (object.__new__ wouldn't insure the invariants
2920 that the extension type's own factory function ensures).
2921 Heap types, of course, are under our control, so they do
2922 inherit tp_new; static extension types that specify some
2923 other built-in type as the default are considered
2924 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002925 if (base != &PyBaseObject_Type ||
2926 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2927 if (type->tp_new == NULL)
2928 type->tp_new = base->tp_new;
2929 }
2930 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002931 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002932
2933 /* Copy other non-function slots */
2934
2935#undef COPYVAL
2936#define COPYVAL(SLOT) \
2937 if (type->SLOT == 0) type->SLOT = base->SLOT
2938
2939 COPYVAL(tp_itemsize);
2940 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2941 COPYVAL(tp_weaklistoffset);
2942 }
2943 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2944 COPYVAL(tp_dictoffset);
2945 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002946}
2947
2948static void
2949inherit_slots(PyTypeObject *type, PyTypeObject *base)
2950{
2951 PyTypeObject *basebase;
2952
2953#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002954#undef COPYSLOT
2955#undef COPYNUM
2956#undef COPYSEQ
2957#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002958#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002959
2960#define SLOTDEFINED(SLOT) \
2961 (base->SLOT != 0 && \
2962 (basebase == NULL || base->SLOT != basebase->SLOT))
2963
Tim Peters6d6c1a32001-08-02 04:15:00 +00002964#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002965 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002966
2967#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2968#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2969#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002970#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002971
Guido van Rossum13d52f02001-08-10 21:24:08 +00002972 /* This won't inherit indirect slots (from tp_as_number etc.)
2973 if type doesn't provide the space. */
2974
2975 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2976 basebase = base->tp_base;
2977 if (basebase->tp_as_number == NULL)
2978 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002979 COPYNUM(nb_add);
2980 COPYNUM(nb_subtract);
2981 COPYNUM(nb_multiply);
2982 COPYNUM(nb_divide);
2983 COPYNUM(nb_remainder);
2984 COPYNUM(nb_divmod);
2985 COPYNUM(nb_power);
2986 COPYNUM(nb_negative);
2987 COPYNUM(nb_positive);
2988 COPYNUM(nb_absolute);
2989 COPYNUM(nb_nonzero);
2990 COPYNUM(nb_invert);
2991 COPYNUM(nb_lshift);
2992 COPYNUM(nb_rshift);
2993 COPYNUM(nb_and);
2994 COPYNUM(nb_xor);
2995 COPYNUM(nb_or);
2996 COPYNUM(nb_coerce);
2997 COPYNUM(nb_int);
2998 COPYNUM(nb_long);
2999 COPYNUM(nb_float);
3000 COPYNUM(nb_oct);
3001 COPYNUM(nb_hex);
3002 COPYNUM(nb_inplace_add);
3003 COPYNUM(nb_inplace_subtract);
3004 COPYNUM(nb_inplace_multiply);
3005 COPYNUM(nb_inplace_divide);
3006 COPYNUM(nb_inplace_remainder);
3007 COPYNUM(nb_inplace_power);
3008 COPYNUM(nb_inplace_lshift);
3009 COPYNUM(nb_inplace_rshift);
3010 COPYNUM(nb_inplace_and);
3011 COPYNUM(nb_inplace_xor);
3012 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003013 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3014 COPYNUM(nb_true_divide);
3015 COPYNUM(nb_floor_divide);
3016 COPYNUM(nb_inplace_true_divide);
3017 COPYNUM(nb_inplace_floor_divide);
3018 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003019 }
3020
Guido van Rossum13d52f02001-08-10 21:24:08 +00003021 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3022 basebase = base->tp_base;
3023 if (basebase->tp_as_sequence == NULL)
3024 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003025 COPYSEQ(sq_length);
3026 COPYSEQ(sq_concat);
3027 COPYSEQ(sq_repeat);
3028 COPYSEQ(sq_item);
3029 COPYSEQ(sq_slice);
3030 COPYSEQ(sq_ass_item);
3031 COPYSEQ(sq_ass_slice);
3032 COPYSEQ(sq_contains);
3033 COPYSEQ(sq_inplace_concat);
3034 COPYSEQ(sq_inplace_repeat);
3035 }
3036
Guido van Rossum13d52f02001-08-10 21:24:08 +00003037 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3038 basebase = base->tp_base;
3039 if (basebase->tp_as_mapping == NULL)
3040 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003041 COPYMAP(mp_length);
3042 COPYMAP(mp_subscript);
3043 COPYMAP(mp_ass_subscript);
3044 }
3045
Tim Petersfc57ccb2001-10-12 02:38:24 +00003046 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3047 basebase = base->tp_base;
3048 if (basebase->tp_as_buffer == NULL)
3049 basebase = NULL;
3050 COPYBUF(bf_getreadbuffer);
3051 COPYBUF(bf_getwritebuffer);
3052 COPYBUF(bf_getsegcount);
3053 COPYBUF(bf_getcharbuffer);
3054 }
3055
Guido van Rossum13d52f02001-08-10 21:24:08 +00003056 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003057
Tim Peters6d6c1a32001-08-02 04:15:00 +00003058 COPYSLOT(tp_dealloc);
3059 COPYSLOT(tp_print);
3060 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3061 type->tp_getattr = base->tp_getattr;
3062 type->tp_getattro = base->tp_getattro;
3063 }
3064 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3065 type->tp_setattr = base->tp_setattr;
3066 type->tp_setattro = base->tp_setattro;
3067 }
3068 /* tp_compare see tp_richcompare */
3069 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003070 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003071 COPYSLOT(tp_call);
3072 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003073 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003074 if (type->tp_compare == NULL &&
3075 type->tp_richcompare == NULL &&
3076 type->tp_hash == NULL)
3077 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003078 type->tp_compare = base->tp_compare;
3079 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003080 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003081 }
3082 }
3083 else {
3084 COPYSLOT(tp_compare);
3085 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003086 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3087 COPYSLOT(tp_iter);
3088 COPYSLOT(tp_iternext);
3089 }
3090 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3091 COPYSLOT(tp_descr_get);
3092 COPYSLOT(tp_descr_set);
3093 COPYSLOT(tp_dictoffset);
3094 COPYSLOT(tp_init);
3095 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003096 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003097 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3098 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3099 /* They agree about gc. */
3100 COPYSLOT(tp_free);
3101 }
3102 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3103 type->tp_free == NULL &&
3104 base->tp_free == _PyObject_Del) {
3105 /* A bit of magic to plug in the correct default
3106 * tp_free function when a derived class adds gc,
3107 * didn't define tp_free, and the base uses the
3108 * default non-gc tp_free.
3109 */
3110 type->tp_free = PyObject_GC_Del;
3111 }
3112 /* else they didn't agree about gc, and there isn't something
3113 * obvious to be done -- the type is on its own.
3114 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003115 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003116}
3117
Jeremy Hylton938ace62002-07-17 16:30:39 +00003118static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003119
Tim Peters6d6c1a32001-08-02 04:15:00 +00003120int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003121PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003122{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003123 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003124 PyTypeObject *base;
3125 int i, n;
3126
Guido van Rossumcab05802002-06-10 15:29:03 +00003127 if (type->tp_flags & Py_TPFLAGS_READY) {
3128 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003129 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003130 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003131 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003132
3133 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003134
Tim Peters36eb4df2003-03-23 03:33:13 +00003135#ifdef Py_TRACE_REFS
3136 /* PyType_Ready is the closest thing we have to a choke point
3137 * for type objects, so is the best place I can think of to try
3138 * to get type objects into the doubly-linked list of all objects.
3139 * Still, not all type objects go thru PyType_Ready.
3140 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003141 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003142#endif
3143
Tim Peters6d6c1a32001-08-02 04:15:00 +00003144 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3145 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003146 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003147 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003148 Py_INCREF(base);
3149 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003150
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003151 /* Initialize the base class */
3152 if (base && base->tp_dict == NULL) {
3153 if (PyType_Ready(base) < 0)
3154 goto error;
3155 }
3156
Guido van Rossum0986d822002-04-08 01:38:42 +00003157 /* Initialize ob_type if NULL. This means extensions that want to be
3158 compilable separately on Windows can call PyType_Ready() instead of
3159 initializing the ob_type field of their type objects. */
3160 if (type->ob_type == NULL)
3161 type->ob_type = base->ob_type;
3162
Tim Peters6d6c1a32001-08-02 04:15:00 +00003163 /* Initialize tp_bases */
3164 bases = type->tp_bases;
3165 if (bases == NULL) {
3166 if (base == NULL)
3167 bases = PyTuple_New(0);
3168 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003169 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003170 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003171 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003172 type->tp_bases = bases;
3173 }
3174
Guido van Rossum687ae002001-10-15 22:03:32 +00003175 /* Initialize tp_dict */
3176 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003177 if (dict == NULL) {
3178 dict = PyDict_New();
3179 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003180 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003181 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003182 }
3183
Guido van Rossum687ae002001-10-15 22:03:32 +00003184 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003185 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003186 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003187 if (type->tp_methods != NULL) {
3188 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003189 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003190 }
3191 if (type->tp_members != NULL) {
3192 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003193 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003194 }
3195 if (type->tp_getset != NULL) {
3196 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003197 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003198 }
3199
Tim Peters6d6c1a32001-08-02 04:15:00 +00003200 /* Calculate method resolution order */
3201 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003202 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003203 }
3204
Guido van Rossum13d52f02001-08-10 21:24:08 +00003205 /* Inherit special flags from dominant base */
3206 if (type->tp_base != NULL)
3207 inherit_special(type, type->tp_base);
3208
Tim Peters6d6c1a32001-08-02 04:15:00 +00003209 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003210 bases = type->tp_mro;
3211 assert(bases != NULL);
3212 assert(PyTuple_Check(bases));
3213 n = PyTuple_GET_SIZE(bases);
3214 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003215 PyObject *b = PyTuple_GET_ITEM(bases, i);
3216 if (PyType_Check(b))
3217 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003218 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003219
Tim Peters3cfe7542003-05-21 21:29:48 +00003220 /* Sanity check for tp_free. */
3221 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3222 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
3223 /* This base class needs to call tp_free, but doesn't have
3224 * one, or its tp_free is for non-gc'ed objects.
3225 */
3226 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3227 "gc and is a base type but has inappropriate "
3228 "tp_free slot",
3229 type->tp_name);
3230 goto error;
3231 }
3232
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003233 /* if the type dictionary doesn't contain a __doc__, set it from
3234 the tp_doc slot.
3235 */
3236 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3237 if (type->tp_doc != NULL) {
3238 PyObject *doc = PyString_FromString(type->tp_doc);
3239 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3240 Py_DECREF(doc);
3241 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003242 PyDict_SetItemString(type->tp_dict,
3243 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003244 }
3245 }
3246
Guido van Rossum13d52f02001-08-10 21:24:08 +00003247 /* Some more special stuff */
3248 base = type->tp_base;
3249 if (base != NULL) {
3250 if (type->tp_as_number == NULL)
3251 type->tp_as_number = base->tp_as_number;
3252 if (type->tp_as_sequence == NULL)
3253 type->tp_as_sequence = base->tp_as_sequence;
3254 if (type->tp_as_mapping == NULL)
3255 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003256 if (type->tp_as_buffer == NULL)
3257 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003258 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003259
Guido van Rossum1c450732001-10-08 15:18:27 +00003260 /* Link into each base class's list of subclasses */
3261 bases = type->tp_bases;
3262 n = PyTuple_GET_SIZE(bases);
3263 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003264 PyObject *b = PyTuple_GET_ITEM(bases, i);
3265 if (PyType_Check(b) &&
3266 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003267 goto error;
3268 }
3269
Guido van Rossum13d52f02001-08-10 21:24:08 +00003270 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003271 assert(type->tp_dict != NULL);
3272 type->tp_flags =
3273 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003274 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003275
3276 error:
3277 type->tp_flags &= ~Py_TPFLAGS_READYING;
3278 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003279}
3280
Guido van Rossum1c450732001-10-08 15:18:27 +00003281static int
3282add_subclass(PyTypeObject *base, PyTypeObject *type)
3283{
3284 int i;
3285 PyObject *list, *ref, *new;
3286
3287 list = base->tp_subclasses;
3288 if (list == NULL) {
3289 base->tp_subclasses = list = PyList_New(0);
3290 if (list == NULL)
3291 return -1;
3292 }
3293 assert(PyList_Check(list));
3294 new = PyWeakref_NewRef((PyObject *)type, NULL);
3295 i = PyList_GET_SIZE(list);
3296 while (--i >= 0) {
3297 ref = PyList_GET_ITEM(list, i);
3298 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003299 if (PyWeakref_GET_OBJECT(ref) == Py_None)
3300 return PyList_SetItem(list, i, new);
Guido van Rossum1c450732001-10-08 15:18:27 +00003301 }
3302 i = PyList_Append(list, new);
3303 Py_DECREF(new);
3304 return i;
3305}
3306
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003307static void
3308remove_subclass(PyTypeObject *base, PyTypeObject *type)
3309{
3310 int i;
3311 PyObject *list, *ref;
3312
3313 list = base->tp_subclasses;
3314 if (list == NULL) {
3315 return;
3316 }
3317 assert(PyList_Check(list));
3318 i = PyList_GET_SIZE(list);
3319 while (--i >= 0) {
3320 ref = PyList_GET_ITEM(list, i);
3321 assert(PyWeakref_CheckRef(ref));
3322 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3323 /* this can't fail, right? */
3324 PySequence_DelItem(list, i);
3325 return;
3326 }
3327 }
3328}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003329
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003330static int
3331check_num_args(PyObject *ob, int n)
3332{
3333 if (!PyTuple_CheckExact(ob)) {
3334 PyErr_SetString(PyExc_SystemError,
3335 "PyArg_UnpackTuple() argument list is not a tuple");
3336 return 0;
3337 }
3338 if (n == PyTuple_GET_SIZE(ob))
3339 return 1;
3340 PyErr_Format(
3341 PyExc_TypeError,
3342 "expected %d arguments, got %d", n, PyTuple_GET_SIZE(ob));
3343 return 0;
3344}
3345
Tim Peters6d6c1a32001-08-02 04:15:00 +00003346/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3347
3348/* There's a wrapper *function* for each distinct function typedef used
3349 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
3350 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3351 Most tables have only one entry; the tables for binary operators have two
3352 entries, one regular and one with reversed arguments. */
3353
3354static PyObject *
3355wrap_inquiry(PyObject *self, PyObject *args, void *wrapped)
3356{
3357 inquiry func = (inquiry)wrapped;
3358 int res;
3359
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003360 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003361 return NULL;
3362 res = (*func)(self);
3363 if (res == -1 && PyErr_Occurred())
3364 return NULL;
3365 return PyInt_FromLong((long)res);
3366}
3367
Tim Peters6d6c1a32001-08-02 04:15:00 +00003368static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003369wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3370{
3371 inquiry func = (inquiry)wrapped;
3372 int res;
3373
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003374 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003375 return NULL;
3376 res = (*func)(self);
3377 if (res == -1 && PyErr_Occurred())
3378 return NULL;
3379 return PyBool_FromLong((long)res);
3380}
3381
3382static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003383wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3384{
3385 binaryfunc func = (binaryfunc)wrapped;
3386 PyObject *other;
3387
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003388 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003389 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003390 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003391 return (*func)(self, other);
3392}
3393
3394static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003395wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3396{
3397 binaryfunc func = (binaryfunc)wrapped;
3398 PyObject *other;
3399
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003400 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003401 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003402 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003403 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003404 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003405 Py_INCREF(Py_NotImplemented);
3406 return Py_NotImplemented;
3407 }
3408 return (*func)(self, other);
3409}
3410
3411static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003412wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3413{
3414 binaryfunc func = (binaryfunc)wrapped;
3415 PyObject *other;
3416
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003417 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003418 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003419 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003420 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003421 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003422 Py_INCREF(Py_NotImplemented);
3423 return Py_NotImplemented;
3424 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003425 return (*func)(other, self);
3426}
3427
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003428static PyObject *
3429wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3430{
3431 coercion func = (coercion)wrapped;
3432 PyObject *other, *res;
3433 int ok;
3434
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003435 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003436 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003437 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003438 ok = func(&self, &other);
3439 if (ok < 0)
3440 return NULL;
3441 if (ok > 0) {
3442 Py_INCREF(Py_NotImplemented);
3443 return Py_NotImplemented;
3444 }
3445 res = PyTuple_New(2);
3446 if (res == NULL) {
3447 Py_DECREF(self);
3448 Py_DECREF(other);
3449 return NULL;
3450 }
3451 PyTuple_SET_ITEM(res, 0, self);
3452 PyTuple_SET_ITEM(res, 1, other);
3453 return res;
3454}
3455
Tim Peters6d6c1a32001-08-02 04:15:00 +00003456static PyObject *
3457wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3458{
3459 ternaryfunc func = (ternaryfunc)wrapped;
3460 PyObject *other;
3461 PyObject *third = Py_None;
3462
3463 /* Note: This wrapper only works for __pow__() */
3464
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003465 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003466 return NULL;
3467 return (*func)(self, other, third);
3468}
3469
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003470static PyObject *
3471wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3472{
3473 ternaryfunc func = (ternaryfunc)wrapped;
3474 PyObject *other;
3475 PyObject *third = Py_None;
3476
3477 /* Note: This wrapper only works for __pow__() */
3478
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003479 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003480 return NULL;
3481 return (*func)(other, self, third);
3482}
3483
Tim Peters6d6c1a32001-08-02 04:15:00 +00003484static PyObject *
3485wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3486{
3487 unaryfunc func = (unaryfunc)wrapped;
3488
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003489 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003490 return NULL;
3491 return (*func)(self);
3492}
3493
Tim Peters6d6c1a32001-08-02 04:15:00 +00003494static PyObject *
3495wrap_intargfunc(PyObject *self, PyObject *args, void *wrapped)
3496{
3497 intargfunc func = (intargfunc)wrapped;
3498 int i;
3499
3500 if (!PyArg_ParseTuple(args, "i", &i))
3501 return NULL;
3502 return (*func)(self, i);
3503}
3504
Guido van Rossum5d815f32001-08-17 21:57:47 +00003505static int
3506getindex(PyObject *self, PyObject *arg)
3507{
3508 int i;
3509
3510 i = PyInt_AsLong(arg);
3511 if (i == -1 && PyErr_Occurred())
3512 return -1;
3513 if (i < 0) {
3514 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3515 if (sq && sq->sq_length) {
3516 int n = (*sq->sq_length)(self);
3517 if (n < 0)
3518 return -1;
3519 i += n;
3520 }
3521 }
3522 return i;
3523}
3524
3525static PyObject *
3526wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3527{
3528 intargfunc func = (intargfunc)wrapped;
3529 PyObject *arg;
3530 int i;
3531
Guido van Rossumf4593e02001-10-03 12:09:30 +00003532 if (PyTuple_GET_SIZE(args) == 1) {
3533 arg = PyTuple_GET_ITEM(args, 0);
3534 i = getindex(self, arg);
3535 if (i == -1 && PyErr_Occurred())
3536 return NULL;
3537 return (*func)(self, i);
3538 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003539 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003540 assert(PyErr_Occurred());
3541 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003542}
3543
Tim Peters6d6c1a32001-08-02 04:15:00 +00003544static PyObject *
3545wrap_intintargfunc(PyObject *self, PyObject *args, void *wrapped)
3546{
3547 intintargfunc func = (intintargfunc)wrapped;
3548 int i, j;
3549
3550 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3551 return NULL;
3552 return (*func)(self, i, j);
3553}
3554
Tim Peters6d6c1a32001-08-02 04:15:00 +00003555static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003556wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003557{
3558 intobjargproc func = (intobjargproc)wrapped;
3559 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003560 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003561
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003562 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003563 return NULL;
3564 i = getindex(self, arg);
3565 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003566 return NULL;
3567 res = (*func)(self, i, value);
3568 if (res == -1 && PyErr_Occurred())
3569 return NULL;
3570 Py_INCREF(Py_None);
3571 return Py_None;
3572}
3573
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003574static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003575wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003576{
3577 intobjargproc func = (intobjargproc)wrapped;
3578 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003579 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003580
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003581 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003582 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003583 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003584 i = getindex(self, arg);
3585 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003586 return NULL;
3587 res = (*func)(self, i, NULL);
3588 if (res == -1 && PyErr_Occurred())
3589 return NULL;
3590 Py_INCREF(Py_None);
3591 return Py_None;
3592}
3593
Tim Peters6d6c1a32001-08-02 04:15:00 +00003594static PyObject *
3595wrap_intintobjargproc(PyObject *self, PyObject *args, void *wrapped)
3596{
3597 intintobjargproc func = (intintobjargproc)wrapped;
3598 int i, j, res;
3599 PyObject *value;
3600
3601 if (!PyArg_ParseTuple(args, "iiO", &i, &j, &value))
3602 return NULL;
3603 res = (*func)(self, i, j, value);
3604 if (res == -1 && PyErr_Occurred())
3605 return NULL;
3606 Py_INCREF(Py_None);
3607 return Py_None;
3608}
3609
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003610static PyObject *
3611wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3612{
3613 intintobjargproc func = (intintobjargproc)wrapped;
3614 int i, j, res;
3615
3616 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3617 return NULL;
3618 res = (*func)(self, i, j, NULL);
3619 if (res == -1 && PyErr_Occurred())
3620 return NULL;
3621 Py_INCREF(Py_None);
3622 return Py_None;
3623}
3624
Tim Peters6d6c1a32001-08-02 04:15:00 +00003625/* XXX objobjproc is a misnomer; should be objargpred */
3626static PyObject *
3627wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3628{
3629 objobjproc func = (objobjproc)wrapped;
3630 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003631 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003632
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003633 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003634 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003635 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003636 res = (*func)(self, value);
3637 if (res == -1 && PyErr_Occurred())
3638 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003639 else
3640 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003641}
3642
Tim Peters6d6c1a32001-08-02 04:15:00 +00003643static PyObject *
3644wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3645{
3646 objobjargproc func = (objobjargproc)wrapped;
3647 int res;
3648 PyObject *key, *value;
3649
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003650 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003651 return NULL;
3652 res = (*func)(self, key, value);
3653 if (res == -1 && PyErr_Occurred())
3654 return NULL;
3655 Py_INCREF(Py_None);
3656 return Py_None;
3657}
3658
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003659static PyObject *
3660wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3661{
3662 objobjargproc func = (objobjargproc)wrapped;
3663 int res;
3664 PyObject *key;
3665
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003666 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003667 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003668 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003669 res = (*func)(self, key, NULL);
3670 if (res == -1 && PyErr_Occurred())
3671 return NULL;
3672 Py_INCREF(Py_None);
3673 return Py_None;
3674}
3675
Tim Peters6d6c1a32001-08-02 04:15:00 +00003676static PyObject *
3677wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3678{
3679 cmpfunc func = (cmpfunc)wrapped;
3680 int res;
3681 PyObject *other;
3682
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003683 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003684 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003685 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003686 if (other->ob_type->tp_compare != func &&
3687 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003688 PyErr_Format(
3689 PyExc_TypeError,
3690 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3691 self->ob_type->tp_name,
3692 self->ob_type->tp_name,
3693 other->ob_type->tp_name);
3694 return NULL;
3695 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003696 res = (*func)(self, other);
3697 if (PyErr_Occurred())
3698 return NULL;
3699 return PyInt_FromLong((long)res);
3700}
3701
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003702/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003703 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003704static int
3705hackcheck(PyObject *self, setattrofunc func, char *what)
3706{
3707 PyTypeObject *type = self->ob_type;
3708 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3709 type = type->tp_base;
3710 if (type->tp_setattro != func) {
3711 PyErr_Format(PyExc_TypeError,
3712 "can't apply this %s to %s object",
3713 what,
3714 type->tp_name);
3715 return 0;
3716 }
3717 return 1;
3718}
3719
Tim Peters6d6c1a32001-08-02 04:15:00 +00003720static PyObject *
3721wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3722{
3723 setattrofunc func = (setattrofunc)wrapped;
3724 int res;
3725 PyObject *name, *value;
3726
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003727 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003728 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003729 if (!hackcheck(self, func, "__setattr__"))
3730 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003731 res = (*func)(self, name, value);
3732 if (res < 0)
3733 return NULL;
3734 Py_INCREF(Py_None);
3735 return Py_None;
3736}
3737
3738static PyObject *
3739wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3740{
3741 setattrofunc func = (setattrofunc)wrapped;
3742 int res;
3743 PyObject *name;
3744
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003745 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003746 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003747 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003748 if (!hackcheck(self, func, "__delattr__"))
3749 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003750 res = (*func)(self, name, NULL);
3751 if (res < 0)
3752 return NULL;
3753 Py_INCREF(Py_None);
3754 return Py_None;
3755}
3756
Tim Peters6d6c1a32001-08-02 04:15:00 +00003757static PyObject *
3758wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3759{
3760 hashfunc func = (hashfunc)wrapped;
3761 long res;
3762
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003763 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003764 return NULL;
3765 res = (*func)(self);
3766 if (res == -1 && PyErr_Occurred())
3767 return NULL;
3768 return PyInt_FromLong(res);
3769}
3770
Tim Peters6d6c1a32001-08-02 04:15:00 +00003771static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003772wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003773{
3774 ternaryfunc func = (ternaryfunc)wrapped;
3775
Guido van Rossumc8e56452001-10-22 00:43:43 +00003776 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003777}
3778
Tim Peters6d6c1a32001-08-02 04:15:00 +00003779static PyObject *
3780wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3781{
3782 richcmpfunc func = (richcmpfunc)wrapped;
3783 PyObject *other;
3784
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003785 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003786 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003787 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003788 return (*func)(self, other, op);
3789}
3790
3791#undef RICHCMP_WRAPPER
3792#define RICHCMP_WRAPPER(NAME, OP) \
3793static PyObject * \
3794richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3795{ \
3796 return wrap_richcmpfunc(self, args, wrapped, OP); \
3797}
3798
Jack Jansen8e938b42001-08-08 15:29:49 +00003799RICHCMP_WRAPPER(lt, Py_LT)
3800RICHCMP_WRAPPER(le, Py_LE)
3801RICHCMP_WRAPPER(eq, Py_EQ)
3802RICHCMP_WRAPPER(ne, Py_NE)
3803RICHCMP_WRAPPER(gt, Py_GT)
3804RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003805
Tim Peters6d6c1a32001-08-02 04:15:00 +00003806static PyObject *
3807wrap_next(PyObject *self, PyObject *args, void *wrapped)
3808{
3809 unaryfunc func = (unaryfunc)wrapped;
3810 PyObject *res;
3811
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003812 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003813 return NULL;
3814 res = (*func)(self);
3815 if (res == NULL && !PyErr_Occurred())
3816 PyErr_SetNone(PyExc_StopIteration);
3817 return res;
3818}
3819
Tim Peters6d6c1a32001-08-02 04:15:00 +00003820static PyObject *
3821wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3822{
3823 descrgetfunc func = (descrgetfunc)wrapped;
3824 PyObject *obj;
3825 PyObject *type = NULL;
3826
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003827 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003828 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003829 if (obj == Py_None)
3830 obj = NULL;
3831 if (type == Py_None)
3832 type = NULL;
3833 if (type == NULL &&obj == NULL) {
3834 PyErr_SetString(PyExc_TypeError,
3835 "__get__(None, None) is invalid");
3836 return NULL;
3837 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003838 return (*func)(self, obj, type);
3839}
3840
Tim Peters6d6c1a32001-08-02 04:15:00 +00003841static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003842wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003843{
3844 descrsetfunc func = (descrsetfunc)wrapped;
3845 PyObject *obj, *value;
3846 int ret;
3847
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003848 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003849 return NULL;
3850 ret = (*func)(self, obj, value);
3851 if (ret < 0)
3852 return NULL;
3853 Py_INCREF(Py_None);
3854 return Py_None;
3855}
Guido van Rossum22b13872002-08-06 21:41:44 +00003856
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003857static PyObject *
3858wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3859{
3860 descrsetfunc func = (descrsetfunc)wrapped;
3861 PyObject *obj;
3862 int ret;
3863
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003864 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003865 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003866 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003867 ret = (*func)(self, obj, NULL);
3868 if (ret < 0)
3869 return NULL;
3870 Py_INCREF(Py_None);
3871 return Py_None;
3872}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003873
Tim Peters6d6c1a32001-08-02 04:15:00 +00003874static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003875wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003876{
3877 initproc func = (initproc)wrapped;
3878
Guido van Rossumc8e56452001-10-22 00:43:43 +00003879 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003880 return NULL;
3881 Py_INCREF(Py_None);
3882 return Py_None;
3883}
3884
Tim Peters6d6c1a32001-08-02 04:15:00 +00003885static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003886tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003887{
Barry Warsaw60f01882001-08-22 19:24:42 +00003888 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003889 PyObject *arg0, *res;
3890
3891 if (self == NULL || !PyType_Check(self))
3892 Py_FatalError("__new__() called with non-type 'self'");
3893 type = (PyTypeObject *)self;
3894 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003895 PyErr_Format(PyExc_TypeError,
3896 "%s.__new__(): not enough arguments",
3897 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003898 return NULL;
3899 }
3900 arg0 = PyTuple_GET_ITEM(args, 0);
3901 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003902 PyErr_Format(PyExc_TypeError,
3903 "%s.__new__(X): X is not a type object (%s)",
3904 type->tp_name,
3905 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003906 return NULL;
3907 }
3908 subtype = (PyTypeObject *)arg0;
3909 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003910 PyErr_Format(PyExc_TypeError,
3911 "%s.__new__(%s): %s is not a subtype of %s",
3912 type->tp_name,
3913 subtype->tp_name,
3914 subtype->tp_name,
3915 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003916 return NULL;
3917 }
Barry Warsaw60f01882001-08-22 19:24:42 +00003918
3919 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00003920 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00003921 most derived base that's not a heap type is this type. */
3922 staticbase = subtype;
3923 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
3924 staticbase = staticbase->tp_base;
Guido van Rossuma8c60f42001-09-14 19:43:36 +00003925 if (staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003926 PyErr_Format(PyExc_TypeError,
3927 "%s.__new__(%s) is not safe, use %s.__new__()",
3928 type->tp_name,
3929 subtype->tp_name,
3930 staticbase == NULL ? "?" : staticbase->tp_name);
3931 return NULL;
3932 }
3933
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003934 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
3935 if (args == NULL)
3936 return NULL;
3937 res = type->tp_new(subtype, args, kwds);
3938 Py_DECREF(args);
3939 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003940}
3941
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003942static struct PyMethodDef tp_new_methoddef[] = {
3943 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003944 PyDoc_STR("T.__new__(S, ...) -> "
3945 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003946 {0}
3947};
3948
3949static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003950add_tp_new_wrapper(PyTypeObject *type)
3951{
Guido van Rossumf040ede2001-08-07 16:40:56 +00003952 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003953
Guido van Rossum687ae002001-10-15 22:03:32 +00003954 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00003955 return 0;
3956 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003957 if (func == NULL)
3958 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00003959 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00003960 Py_DECREF(func);
3961 return -1;
3962 }
3963 Py_DECREF(func);
3964 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003965}
3966
Guido van Rossumf040ede2001-08-07 16:40:56 +00003967/* Slot wrappers that call the corresponding __foo__ slot. See comments
3968 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003969
Guido van Rossumdc91b992001-08-08 22:26:22 +00003970#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003971static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003972FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003973{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00003974 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003975 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003976}
3977
Guido van Rossumdc91b992001-08-08 22:26:22 +00003978#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003979static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003980FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003981{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003982 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003983 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003984}
3985
Guido van Rossumcd118802003-01-06 22:57:47 +00003986/* Boolean helper for SLOT1BINFULL().
3987 right.__class__ is a nontrivial subclass of left.__class__. */
3988static int
3989method_is_overloaded(PyObject *left, PyObject *right, char *name)
3990{
3991 PyObject *a, *b;
3992 int ok;
3993
3994 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
3995 if (b == NULL) {
3996 PyErr_Clear();
3997 /* If right doesn't have it, it's not overloaded */
3998 return 0;
3999 }
4000
4001 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
4002 if (a == NULL) {
4003 PyErr_Clear();
4004 Py_DECREF(b);
4005 /* If right has it but left doesn't, it's overloaded */
4006 return 1;
4007 }
4008
4009 ok = PyObject_RichCompareBool(a, b, Py_NE);
4010 Py_DECREF(a);
4011 Py_DECREF(b);
4012 if (ok < 0) {
4013 PyErr_Clear();
4014 return 0;
4015 }
4016
4017 return ok;
4018}
4019
Guido van Rossumdc91b992001-08-08 22:26:22 +00004020
4021#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004022static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004023FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004024{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004025 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004026 int do_other = self->ob_type != other->ob_type && \
4027 other->ob_type->tp_as_number != NULL && \
4028 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004029 if (self->ob_type->tp_as_number != NULL && \
4030 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
4031 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004032 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004033 PyType_IsSubtype(other->ob_type, self->ob_type) && \
4034 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004035 r = call_maybe( \
4036 other, ROPSTR, &rcache_str, "(O)", self); \
4037 if (r != Py_NotImplemented) \
4038 return r; \
4039 Py_DECREF(r); \
4040 do_other = 0; \
4041 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004042 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004043 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004044 if (r != Py_NotImplemented || \
4045 other->ob_type == self->ob_type) \
4046 return r; \
4047 Py_DECREF(r); \
4048 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004049 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004050 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004051 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004052 } \
4053 Py_INCREF(Py_NotImplemented); \
4054 return Py_NotImplemented; \
4055}
4056
4057#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4058 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4059
4060#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4061static PyObject * \
4062FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4063{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004064 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004065 return call_method(self, OPSTR, &cache_str, \
4066 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004067}
4068
4069static int
4070slot_sq_length(PyObject *self)
4071{
Guido van Rossum2730b132001-08-28 18:22:14 +00004072 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004073 PyObject *res = call_method(self, "__len__", &len_str, "()");
Guido van Rossum26111622001-10-01 16:42:49 +00004074 int len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004075
4076 if (res == NULL)
4077 return -1;
Guido van Rossum26111622001-10-01 16:42:49 +00004078 len = (int)PyInt_AsLong(res);
4079 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00004080 if (len == -1 && PyErr_Occurred())
4081 return -1;
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004082 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00004083 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004084 "__len__() should return >= 0");
4085 return -1;
4086 }
Guido van Rossum26111622001-10-01 16:42:49 +00004087 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004088}
4089
Guido van Rossumdc91b992001-08-08 22:26:22 +00004090SLOT1(slot_sq_concat, "__add__", PyObject *, "O")
4091SLOT1(slot_sq_repeat, "__mul__", int, "i")
Guido van Rossumf4593e02001-10-03 12:09:30 +00004092
4093/* Super-optimized version of slot_sq_item.
4094 Other slots could do the same... */
4095static PyObject *
4096slot_sq_item(PyObject *self, int i)
4097{
4098 static PyObject *getitem_str;
4099 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4100 descrgetfunc f;
4101
4102 if (getitem_str == NULL) {
4103 getitem_str = PyString_InternFromString("__getitem__");
4104 if (getitem_str == NULL)
4105 return NULL;
4106 }
4107 func = _PyType_Lookup(self->ob_type, getitem_str);
4108 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004109 if ((f = func->ob_type->tp_descr_get) == NULL)
4110 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004111 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004112 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004113 if (func == NULL) {
4114 return NULL;
4115 }
4116 }
Guido van Rossumf4593e02001-10-03 12:09:30 +00004117 ival = PyInt_FromLong(i);
4118 if (ival != NULL) {
4119 args = PyTuple_New(1);
4120 if (args != NULL) {
4121 PyTuple_SET_ITEM(args, 0, ival);
4122 retval = PyObject_Call(func, args, NULL);
4123 Py_XDECREF(args);
4124 Py_XDECREF(func);
4125 return retval;
4126 }
4127 }
4128 }
4129 else {
4130 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4131 }
4132 Py_XDECREF(args);
4133 Py_XDECREF(ival);
4134 Py_XDECREF(func);
4135 return NULL;
4136}
4137
Guido van Rossumdc91b992001-08-08 22:26:22 +00004138SLOT2(slot_sq_slice, "__getslice__", int, int, "ii")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004139
4140static int
4141slot_sq_ass_item(PyObject *self, int index, PyObject *value)
4142{
4143 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004144 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004145
4146 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004147 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004148 "(i)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004149 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004150 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004151 "(iO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004152 if (res == NULL)
4153 return -1;
4154 Py_DECREF(res);
4155 return 0;
4156}
4157
4158static int
4159slot_sq_ass_slice(PyObject *self, int i, int j, PyObject *value)
4160{
4161 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004162 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004163
4164 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004165 res = call_method(self, "__delslice__", &delslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004166 "(ii)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004167 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004168 res = call_method(self, "__setslice__", &setslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004169 "(iiO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004170 if (res == NULL)
4171 return -1;
4172 Py_DECREF(res);
4173 return 0;
4174}
4175
4176static int
4177slot_sq_contains(PyObject *self, PyObject *value)
4178{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004179 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004180 int result = -1;
4181
Guido van Rossum60718732001-08-28 17:47:51 +00004182 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004183
Guido van Rossum55f20992001-10-01 17:18:22 +00004184 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004185 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004186 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004187 if (args == NULL)
4188 res = NULL;
4189 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004190 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004191 Py_DECREF(args);
4192 }
4193 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004194 if (res != NULL) {
4195 result = PyObject_IsTrue(res);
4196 Py_DECREF(res);
4197 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004198 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004199 else if (! PyErr_Occurred()) {
4200 result = _PySequence_IterSearch(self, value,
4201 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004202 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004203 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004204}
4205
Guido van Rossumdc91b992001-08-08 22:26:22 +00004206SLOT1(slot_sq_inplace_concat, "__iadd__", PyObject *, "O")
4207SLOT1(slot_sq_inplace_repeat, "__imul__", int, "i")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004208
4209#define slot_mp_length slot_sq_length
4210
Guido van Rossumdc91b992001-08-08 22:26:22 +00004211SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004212
4213static int
4214slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4215{
4216 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004217 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004218
4219 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004220 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004221 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004222 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004223 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004224 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004225 if (res == NULL)
4226 return -1;
4227 Py_DECREF(res);
4228 return 0;
4229}
4230
Guido van Rossumdc91b992001-08-08 22:26:22 +00004231SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4232SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4233SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4234SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4235SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4236SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4237
Jeremy Hylton938ace62002-07-17 16:30:39 +00004238static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004239
4240SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4241 nb_power, "__pow__", "__rpow__")
4242
4243static PyObject *
4244slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4245{
Guido van Rossum2730b132001-08-28 18:22:14 +00004246 static PyObject *pow_str;
4247
Guido van Rossumdc91b992001-08-08 22:26:22 +00004248 if (modulus == Py_None)
4249 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004250 /* Three-arg power doesn't use __rpow__. But ternary_op
4251 can call this when the second argument's type uses
4252 slot_nb_power, so check before calling self.__pow__. */
4253 if (self->ob_type->tp_as_number != NULL &&
4254 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4255 return call_method(self, "__pow__", &pow_str,
4256 "(OO)", other, modulus);
4257 }
4258 Py_INCREF(Py_NotImplemented);
4259 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004260}
4261
4262SLOT0(slot_nb_negative, "__neg__")
4263SLOT0(slot_nb_positive, "__pos__")
4264SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004265
4266static int
4267slot_nb_nonzero(PyObject *self)
4268{
Tim Petersea7f75d2002-12-07 21:39:16 +00004269 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004270 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004271 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004272
Guido van Rossum55f20992001-10-01 17:18:22 +00004273 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004274 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004275 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004276 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004277 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004278 if (func == NULL)
4279 return PyErr_Occurred() ? -1 : 1;
4280 }
4281 args = PyTuple_New(0);
4282 if (args != NULL) {
4283 PyObject *temp = PyObject_Call(func, args, NULL);
4284 Py_DECREF(args);
4285 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004286 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004287 result = PyObject_IsTrue(temp);
4288 else {
4289 PyErr_Format(PyExc_TypeError,
4290 "__nonzero__ should return "
4291 "bool or int, returned %s",
4292 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004293 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004294 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004295 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004296 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004297 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004298 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004299 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004300}
4301
Guido van Rossumdc91b992001-08-08 22:26:22 +00004302SLOT0(slot_nb_invert, "__invert__")
4303SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4304SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4305SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4306SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4307SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004308
4309static int
4310slot_nb_coerce(PyObject **a, PyObject **b)
4311{
4312 static PyObject *coerce_str;
4313 PyObject *self = *a, *other = *b;
4314
4315 if (self->ob_type->tp_as_number != NULL &&
4316 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4317 PyObject *r;
4318 r = call_maybe(
4319 self, "__coerce__", &coerce_str, "(O)", other);
4320 if (r == NULL)
4321 return -1;
4322 if (r == Py_NotImplemented) {
4323 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004324 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004325 else {
4326 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4327 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004328 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004329 Py_DECREF(r);
4330 return -1;
4331 }
4332 *a = PyTuple_GET_ITEM(r, 0);
4333 Py_INCREF(*a);
4334 *b = PyTuple_GET_ITEM(r, 1);
4335 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004336 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004337 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004338 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004339 }
4340 if (other->ob_type->tp_as_number != NULL &&
4341 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4342 PyObject *r;
4343 r = call_maybe(
4344 other, "__coerce__", &coerce_str, "(O)", self);
4345 if (r == NULL)
4346 return -1;
4347 if (r == Py_NotImplemented) {
4348 Py_DECREF(r);
4349 return 1;
4350 }
4351 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4352 PyErr_SetString(PyExc_TypeError,
4353 "__coerce__ didn't return a 2-tuple");
4354 Py_DECREF(r);
4355 return -1;
4356 }
4357 *a = PyTuple_GET_ITEM(r, 1);
4358 Py_INCREF(*a);
4359 *b = PyTuple_GET_ITEM(r, 0);
4360 Py_INCREF(*b);
4361 Py_DECREF(r);
4362 return 0;
4363 }
4364 return 1;
4365}
4366
Guido van Rossumdc91b992001-08-08 22:26:22 +00004367SLOT0(slot_nb_int, "__int__")
4368SLOT0(slot_nb_long, "__long__")
4369SLOT0(slot_nb_float, "__float__")
4370SLOT0(slot_nb_oct, "__oct__")
4371SLOT0(slot_nb_hex, "__hex__")
4372SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4373SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4374SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4375SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4376SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004377SLOT1(slot_nb_inplace_power, "__ipow__", PyObject *, "O")
Guido van Rossumdc91b992001-08-08 22:26:22 +00004378SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4379SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4380SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4381SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4382SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4383SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4384 "__floordiv__", "__rfloordiv__")
4385SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4386SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4387SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004388
4389static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004390half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004391{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004392 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004393 static PyObject *cmp_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004394 int c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004395
Guido van Rossum60718732001-08-28 17:47:51 +00004396 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004397 if (func == NULL) {
4398 PyErr_Clear();
4399 }
4400 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004401 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004402 if (args == NULL)
4403 res = NULL;
4404 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004405 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004406 Py_DECREF(args);
4407 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004408 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004409 if (res != Py_NotImplemented) {
4410 if (res == NULL)
4411 return -2;
4412 c = PyInt_AsLong(res);
4413 Py_DECREF(res);
4414 if (c == -1 && PyErr_Occurred())
4415 return -2;
4416 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4417 }
4418 Py_DECREF(res);
4419 }
4420 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004421}
4422
Guido van Rossumab3b0342001-09-18 20:38:53 +00004423/* This slot is published for the benefit of try_3way_compare in object.c */
4424int
4425_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004426{
4427 int c;
4428
Guido van Rossumab3b0342001-09-18 20:38:53 +00004429 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004430 c = half_compare(self, other);
4431 if (c <= 1)
4432 return c;
4433 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004434 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004435 c = half_compare(other, self);
4436 if (c < -1)
4437 return -2;
4438 if (c <= 1)
4439 return -c;
4440 }
4441 return (void *)self < (void *)other ? -1 :
4442 (void *)self > (void *)other ? 1 : 0;
4443}
4444
4445static PyObject *
4446slot_tp_repr(PyObject *self)
4447{
4448 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004449 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004450
Guido van Rossum60718732001-08-28 17:47:51 +00004451 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004452 if (func != NULL) {
4453 res = PyEval_CallObject(func, NULL);
4454 Py_DECREF(func);
4455 return res;
4456 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004457 PyErr_Clear();
4458 return PyString_FromFormat("<%s object at %p>",
4459 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004460}
4461
4462static PyObject *
4463slot_tp_str(PyObject *self)
4464{
4465 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004466 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004467
Guido van Rossum60718732001-08-28 17:47:51 +00004468 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004469 if (func != NULL) {
4470 res = PyEval_CallObject(func, NULL);
4471 Py_DECREF(func);
4472 return res;
4473 }
4474 else {
4475 PyErr_Clear();
4476 return slot_tp_repr(self);
4477 }
4478}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004479
4480static long
4481slot_tp_hash(PyObject *self)
4482{
Tim Peters61ce0a92002-12-06 23:38:02 +00004483 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004484 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004485 long h;
4486
Guido van Rossum60718732001-08-28 17:47:51 +00004487 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004488
4489 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004490 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004491 Py_DECREF(func);
4492 if (res == NULL)
4493 return -1;
4494 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004495 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004496 }
4497 else {
4498 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004499 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004500 if (func == NULL) {
4501 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004502 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004503 }
4504 if (func != NULL) {
4505 Py_DECREF(func);
4506 PyErr_SetString(PyExc_TypeError, "unhashable type");
4507 return -1;
4508 }
4509 PyErr_Clear();
4510 h = _Py_HashPointer((void *)self);
4511 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004512 if (h == -1 && !PyErr_Occurred())
4513 h = -2;
4514 return h;
4515}
4516
4517static PyObject *
4518slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4519{
Guido van Rossum60718732001-08-28 17:47:51 +00004520 static PyObject *call_str;
4521 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004522 PyObject *res;
4523
4524 if (meth == NULL)
4525 return NULL;
4526 res = PyObject_Call(meth, args, kwds);
4527 Py_DECREF(meth);
4528 return res;
4529}
4530
Guido van Rossum14a6f832001-10-17 13:59:09 +00004531/* There are two slot dispatch functions for tp_getattro.
4532
4533 - slot_tp_getattro() is used when __getattribute__ is overridden
4534 but no __getattr__ hook is present;
4535
4536 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4537
Guido van Rossumc334df52002-04-04 23:44:47 +00004538 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4539 detects the absence of __getattr__ and then installs the simpler slot if
4540 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004541
Tim Peters6d6c1a32001-08-02 04:15:00 +00004542static PyObject *
4543slot_tp_getattro(PyObject *self, PyObject *name)
4544{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004545 static PyObject *getattribute_str = NULL;
4546 return call_method(self, "__getattribute__", &getattribute_str,
4547 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004548}
4549
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004550static PyObject *
4551slot_tp_getattr_hook(PyObject *self, PyObject *name)
4552{
4553 PyTypeObject *tp = self->ob_type;
4554 PyObject *getattr, *getattribute, *res;
4555 static PyObject *getattribute_str = NULL;
4556 static PyObject *getattr_str = NULL;
4557
4558 if (getattr_str == NULL) {
4559 getattr_str = PyString_InternFromString("__getattr__");
4560 if (getattr_str == NULL)
4561 return NULL;
4562 }
4563 if (getattribute_str == NULL) {
4564 getattribute_str =
4565 PyString_InternFromString("__getattribute__");
4566 if (getattribute_str == NULL)
4567 return NULL;
4568 }
4569 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004570 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004571 /* No __getattr__ hook: use a simpler dispatcher */
4572 tp->tp_getattro = slot_tp_getattro;
4573 return slot_tp_getattro(self, name);
4574 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004575 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004576 if (getattribute == NULL ||
4577 (getattribute->ob_type == &PyWrapperDescr_Type &&
4578 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4579 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004580 res = PyObject_GenericGetAttr(self, name);
4581 else
4582 res = PyObject_CallFunction(getattribute, "OO", self, name);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004583 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004584 PyErr_Clear();
4585 res = PyObject_CallFunction(getattr, "OO", self, name);
4586 }
4587 return res;
4588}
4589
Tim Peters6d6c1a32001-08-02 04:15:00 +00004590static int
4591slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4592{
4593 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004594 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004595
4596 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004597 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004598 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004599 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004600 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004601 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004602 if (res == NULL)
4603 return -1;
4604 Py_DECREF(res);
4605 return 0;
4606}
4607
4608/* Map rich comparison operators to their __xx__ namesakes */
4609static char *name_op[] = {
4610 "__lt__",
4611 "__le__",
4612 "__eq__",
4613 "__ne__",
4614 "__gt__",
4615 "__ge__",
4616};
4617
4618static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004619half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004620{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004621 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004622 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004623
Guido van Rossum60718732001-08-28 17:47:51 +00004624 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004625 if (func == NULL) {
4626 PyErr_Clear();
4627 Py_INCREF(Py_NotImplemented);
4628 return Py_NotImplemented;
4629 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004630 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004631 if (args == NULL)
4632 res = NULL;
4633 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004634 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004635 Py_DECREF(args);
4636 }
4637 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004638 return res;
4639}
4640
Guido van Rossumb8f63662001-08-15 23:57:02 +00004641static PyObject *
4642slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4643{
4644 PyObject *res;
4645
4646 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4647 res = half_richcompare(self, other, op);
4648 if (res != Py_NotImplemented)
4649 return res;
4650 Py_DECREF(res);
4651 }
4652 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00004653 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004654 if (res != Py_NotImplemented) {
4655 return res;
4656 }
4657 Py_DECREF(res);
4658 }
4659 Py_INCREF(Py_NotImplemented);
4660 return Py_NotImplemented;
4661}
4662
4663static PyObject *
4664slot_tp_iter(PyObject *self)
4665{
4666 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004667 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004668
Guido van Rossum60718732001-08-28 17:47:51 +00004669 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004670 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004671 PyObject *args;
4672 args = res = PyTuple_New(0);
4673 if (args != NULL) {
4674 res = PyObject_Call(func, args, NULL);
4675 Py_DECREF(args);
4676 }
4677 Py_DECREF(func);
4678 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004679 }
4680 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004681 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004682 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004683 PyErr_SetString(PyExc_TypeError,
4684 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00004685 return NULL;
4686 }
4687 Py_DECREF(func);
4688 return PySeqIter_New(self);
4689}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004690
4691static PyObject *
4692slot_tp_iternext(PyObject *self)
4693{
Guido van Rossum2730b132001-08-28 18:22:14 +00004694 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004695 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004696}
4697
Guido van Rossum1a493502001-08-17 16:47:50 +00004698static PyObject *
4699slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4700{
4701 PyTypeObject *tp = self->ob_type;
4702 PyObject *get;
4703 static PyObject *get_str = NULL;
4704
4705 if (get_str == NULL) {
4706 get_str = PyString_InternFromString("__get__");
4707 if (get_str == NULL)
4708 return NULL;
4709 }
4710 get = _PyType_Lookup(tp, get_str);
4711 if (get == NULL) {
4712 /* Avoid further slowdowns */
4713 if (tp->tp_descr_get == slot_tp_descr_get)
4714 tp->tp_descr_get = NULL;
4715 Py_INCREF(self);
4716 return self;
4717 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004718 if (obj == NULL)
4719 obj = Py_None;
4720 if (type == NULL)
4721 type = Py_None;
Guido van Rossum1a493502001-08-17 16:47:50 +00004722 return PyObject_CallFunction(get, "OOO", self, obj, type);
4723}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004724
4725static int
4726slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4727{
Guido van Rossum2c252392001-08-24 10:13:31 +00004728 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004729 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004730
4731 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004732 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004733 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004734 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004735 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004736 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004737 if (res == NULL)
4738 return -1;
4739 Py_DECREF(res);
4740 return 0;
4741}
4742
4743static int
4744slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4745{
Guido van Rossum60718732001-08-28 17:47:51 +00004746 static PyObject *init_str;
4747 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004748 PyObject *res;
4749
4750 if (meth == NULL)
4751 return -1;
4752 res = PyObject_Call(meth, args, kwds);
4753 Py_DECREF(meth);
4754 if (res == NULL)
4755 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00004756 if (res != Py_None) {
4757 PyErr_SetString(PyExc_TypeError,
4758 "__init__() should return None");
4759 Py_DECREF(res);
4760 return -1;
4761 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004762 Py_DECREF(res);
4763 return 0;
4764}
4765
4766static PyObject *
4767slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4768{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004769 static PyObject *new_str;
4770 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004771 PyObject *newargs, *x;
4772 int i, n;
4773
Guido van Rossum7bed2132002-08-08 21:57:53 +00004774 if (new_str == NULL) {
4775 new_str = PyString_InternFromString("__new__");
4776 if (new_str == NULL)
4777 return NULL;
4778 }
4779 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004780 if (func == NULL)
4781 return NULL;
4782 assert(PyTuple_Check(args));
4783 n = PyTuple_GET_SIZE(args);
4784 newargs = PyTuple_New(n+1);
4785 if (newargs == NULL)
4786 return NULL;
4787 Py_INCREF(type);
4788 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4789 for (i = 0; i < n; i++) {
4790 x = PyTuple_GET_ITEM(args, i);
4791 Py_INCREF(x);
4792 PyTuple_SET_ITEM(newargs, i+1, x);
4793 }
4794 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004795 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004796 Py_DECREF(func);
4797 return x;
4798}
4799
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004800static void
4801slot_tp_del(PyObject *self)
4802{
4803 static PyObject *del_str = NULL;
4804 PyObject *del, *res;
4805 PyObject *error_type, *error_value, *error_traceback;
4806
4807 /* Temporarily resurrect the object. */
4808 assert(self->ob_refcnt == 0);
4809 self->ob_refcnt = 1;
4810
4811 /* Save the current exception, if any. */
4812 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4813
4814 /* Execute __del__ method, if any. */
4815 del = lookup_maybe(self, "__del__", &del_str);
4816 if (del != NULL) {
4817 res = PyEval_CallObject(del, NULL);
4818 if (res == NULL)
4819 PyErr_WriteUnraisable(del);
4820 else
4821 Py_DECREF(res);
4822 Py_DECREF(del);
4823 }
4824
4825 /* Restore the saved exception. */
4826 PyErr_Restore(error_type, error_value, error_traceback);
4827
4828 /* Undo the temporary resurrection; can't use DECREF here, it would
4829 * cause a recursive call.
4830 */
4831 assert(self->ob_refcnt > 0);
4832 if (--self->ob_refcnt == 0)
4833 return; /* this is the normal path out */
4834
4835 /* __del__ resurrected it! Make it look like the original Py_DECREF
4836 * never happened.
4837 */
4838 {
4839 int refcnt = self->ob_refcnt;
4840 _Py_NewReference(self);
4841 self->ob_refcnt = refcnt;
4842 }
4843 assert(!PyType_IS_GC(self->ob_type) ||
4844 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00004845 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
4846 * we need to undo that. */
4847 _Py_DEC_REFTOTAL;
4848 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
4849 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004850 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
4851 * _Py_NewReference bumped tp_allocs: both of those need to be
4852 * undone.
4853 */
4854#ifdef COUNT_ALLOCS
4855 --self->ob_type->tp_frees;
4856 --self->ob_type->tp_allocs;
4857#endif
4858}
4859
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004860
4861/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00004862 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00004863 structure, which incorporates the additional structures used for numbers,
4864 sequences and mappings.
4865 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004866 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00004867 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
4868 terminated with an all-zero entry. (This table is further initialized and
4869 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004870
Guido van Rossum6d204072001-10-21 00:44:31 +00004871typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004872
4873#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00004874#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004875#undef ETSLOT
4876#undef SQSLOT
4877#undef MPSLOT
4878#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00004879#undef UNSLOT
4880#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004881#undef BINSLOT
4882#undef RBINSLOT
4883
Guido van Rossum6d204072001-10-21 00:44:31 +00004884#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004885 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
4886 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00004887#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
4888 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004889 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00004890#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00004891 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004892 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00004893#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4894 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
4895#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4896 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
4897#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4898 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
4899#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4900 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4901 "x." NAME "() <==> " DOC)
4902#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4903 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4904 "x." NAME "(y) <==> x" DOC "y")
4905#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
4906 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4907 "x." NAME "(y) <==> x" DOC "y")
4908#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
4909 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4910 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00004911#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4912 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4913 "x." NAME "(y) <==> " DOC)
4914#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4915 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4916 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004917
4918static slotdef slotdefs[] = {
Guido van Rossum6d204072001-10-21 00:44:31 +00004919 SQSLOT("__len__", sq_length, slot_sq_length, wrap_inquiry,
4920 "x.__len__() <==> len(x)"),
4921 SQSLOT("__add__", sq_concat, slot_sq_concat, wrap_binaryfunc,
4922 "x.__add__(y) <==> x+y"),
4923 SQSLOT("__mul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4924 "x.__mul__(n) <==> x*n"),
4925 SQSLOT("__rmul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4926 "x.__rmul__(n) <==> n*x"),
4927 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
4928 "x.__getitem__(y) <==> x[y]"),
4929 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_intintargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00004930 "x.__getslice__(i, j) <==> x[i:j]\n\
4931 \n\
4932 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004933 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004934 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004935 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004936 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004937 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Guido van Rossum6d204072001-10-21 00:44:31 +00004938 wrap_intintobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00004939 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
4940 \n\
4941 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004942 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00004943 "x.__delslice__(i, j) <==> del x[i:j]\n\
4944 \n\
4945 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004946 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
4947 "x.__contains__(y) <==> y in x"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004948 SQSLOT("__iadd__", sq_inplace_concat, slot_sq_inplace_concat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004949 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004950 SQSLOT("__imul__", sq_inplace_repeat, slot_sq_inplace_repeat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004951 wrap_intargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004952
Guido van Rossum6d204072001-10-21 00:44:31 +00004953 MPSLOT("__len__", mp_length, slot_mp_length, wrap_inquiry,
4954 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00004955 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004956 wrap_binaryfunc,
4957 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004958 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004959 wrap_objobjargproc,
4960 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004961 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004962 wrap_delitem,
4963 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004964
Guido van Rossum6d204072001-10-21 00:44:31 +00004965 BINSLOT("__add__", nb_add, slot_nb_add,
4966 "+"),
4967 RBINSLOT("__radd__", nb_add, slot_nb_add,
4968 "+"),
4969 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
4970 "-"),
4971 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
4972 "-"),
4973 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
4974 "*"),
4975 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
4976 "*"),
4977 BINSLOT("__div__", nb_divide, slot_nb_divide,
4978 "/"),
4979 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
4980 "/"),
4981 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
4982 "%"),
4983 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
4984 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00004985 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00004986 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00004987 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00004988 "divmod(y, x)"),
4989 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
4990 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
4991 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
4992 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
4993 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
4994 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
4995 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
4996 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00004997 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00004998 "x != 0"),
4999 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5000 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5001 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5002 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5003 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5004 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5005 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5006 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5007 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5008 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5009 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5010 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5011 "x.__coerce__(y) <==> coerce(x, y)"),
5012 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5013 "int(x)"),
5014 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5015 "long(x)"),
5016 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5017 "float(x)"),
5018 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5019 "oct(x)"),
5020 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5021 "hex(x)"),
5022 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5023 wrap_binaryfunc, "+"),
5024 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5025 wrap_binaryfunc, "-"),
5026 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5027 wrap_binaryfunc, "*"),
5028 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5029 wrap_binaryfunc, "/"),
5030 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5031 wrap_binaryfunc, "%"),
5032 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005033 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005034 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5035 wrap_binaryfunc, "<<"),
5036 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5037 wrap_binaryfunc, ">>"),
5038 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5039 wrap_binaryfunc, "&"),
5040 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5041 wrap_binaryfunc, "^"),
5042 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5043 wrap_binaryfunc, "|"),
5044 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5045 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5046 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5047 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5048 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5049 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5050 IBSLOT("__itruediv__", nb_inplace_true_divide,
5051 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005052
Guido van Rossum6d204072001-10-21 00:44:31 +00005053 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5054 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005055 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005056 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5057 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005058 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005059 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5060 "x.__cmp__(y) <==> cmp(x,y)"),
5061 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5062 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005063 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5064 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005065 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005066 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5067 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5068 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5069 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5070 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5071 "x.__setattr__('name', value) <==> x.name = value"),
5072 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5073 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5074 "x.__delattr__('name') <==> del x.name"),
5075 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5076 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5077 "x.__lt__(y) <==> x<y"),
5078 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5079 "x.__le__(y) <==> x<=y"),
5080 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5081 "x.__eq__(y) <==> x==y"),
5082 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5083 "x.__ne__(y) <==> x!=y"),
5084 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5085 "x.__gt__(y) <==> x>y"),
5086 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5087 "x.__ge__(y) <==> x>=y"),
5088 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5089 "x.__iter__() <==> iter(x)"),
5090 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5091 "x.next() -> the next value, or raise StopIteration"),
5092 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5093 "descr.__get__(obj[, type]) -> value"),
5094 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5095 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005096 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5097 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005098 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005099 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005100 "see x.__class__.__doc__ for signature",
5101 PyWrapperFlag_KEYWORDS),
5102 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005103 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005104 {NULL}
5105};
5106
Guido van Rossumc334df52002-04-04 23:44:47 +00005107/* Given a type pointer and an offset gotten from a slotdef entry, return a
5108 pointer to the actual slot. This is not quite the same as simply adding
5109 the offset to the type pointer, since it takes care to indirect through the
5110 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5111 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005112static void **
5113slotptr(PyTypeObject *type, int offset)
5114{
5115 char *ptr;
5116
Guido van Rossume5c691a2003-03-07 15:13:17 +00005117 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005118 assert(offset >= 0);
Guido van Rossume5c691a2003-03-07 15:13:17 +00005119 assert(offset < offsetof(PyHeapTypeObject, as_buffer));
5120 if (offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005121 ptr = (void *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005122 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005123 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005124 else if (offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Guido van Rossum09638c12002-06-13 19:17:46 +00005125 ptr = (void *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005126 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005127 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005128 else if (offset >= offsetof(PyHeapTypeObject, as_number)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005129 ptr = (void *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005130 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005131 }
5132 else {
5133 ptr = (void *)type;
5134 }
5135 if (ptr != NULL)
5136 ptr += offset;
5137 return (void **)ptr;
5138}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005139
Guido van Rossumc334df52002-04-04 23:44:47 +00005140/* Length of array of slotdef pointers used to store slots with the
5141 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5142 the same __name__, for any __name__. Since that's a static property, it is
5143 appropriate to declare fixed-size arrays for this. */
5144#define MAX_EQUIV 10
5145
5146/* Return a slot pointer for a given name, but ONLY if the attribute has
5147 exactly one slot function. The name must be an interned string. */
5148static void **
5149resolve_slotdups(PyTypeObject *type, PyObject *name)
5150{
5151 /* XXX Maybe this could be optimized more -- but is it worth it? */
5152
5153 /* pname and ptrs act as a little cache */
5154 static PyObject *pname;
5155 static slotdef *ptrs[MAX_EQUIV];
5156 slotdef *p, **pp;
5157 void **res, **ptr;
5158
5159 if (pname != name) {
5160 /* Collect all slotdefs that match name into ptrs. */
5161 pname = name;
5162 pp = ptrs;
5163 for (p = slotdefs; p->name_strobj; p++) {
5164 if (p->name_strobj == name)
5165 *pp++ = p;
5166 }
5167 *pp = NULL;
5168 }
5169
5170 /* Look in all matching slots of the type; if exactly one of these has
5171 a filled-in slot, return its value. Otherwise return NULL. */
5172 res = NULL;
5173 for (pp = ptrs; *pp; pp++) {
5174 ptr = slotptr(type, (*pp)->offset);
5175 if (ptr == NULL || *ptr == NULL)
5176 continue;
5177 if (res != NULL)
5178 return NULL;
5179 res = ptr;
5180 }
5181 return res;
5182}
5183
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005184/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005185 does some incredibly complex thinking and then sticks something into the
5186 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5187 interests, and then stores a generic wrapper or a specific function into
5188 the slot.) Return a pointer to the next slotdef with a different offset,
5189 because that's convenient for fixup_slot_dispatchers(). */
5190static slotdef *
5191update_one_slot(PyTypeObject *type, slotdef *p)
5192{
5193 PyObject *descr;
5194 PyWrapperDescrObject *d;
5195 void *generic = NULL, *specific = NULL;
5196 int use_generic = 0;
5197 int offset = p->offset;
5198 void **ptr = slotptr(type, offset);
5199
5200 if (ptr == NULL) {
5201 do {
5202 ++p;
5203 } while (p->offset == offset);
5204 return p;
5205 }
5206 do {
5207 descr = _PyType_Lookup(type, p->name_strobj);
5208 if (descr == NULL)
5209 continue;
5210 if (descr->ob_type == &PyWrapperDescr_Type) {
5211 void **tptr = resolve_slotdups(type, p->name_strobj);
5212 if (tptr == NULL || tptr == ptr)
5213 generic = p->function;
5214 d = (PyWrapperDescrObject *)descr;
5215 if (d->d_base->wrapper == p->wrapper &&
5216 PyType_IsSubtype(type, d->d_type))
5217 {
5218 if (specific == NULL ||
5219 specific == d->d_wrapped)
5220 specific = d->d_wrapped;
5221 else
5222 use_generic = 1;
5223 }
5224 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005225 else if (descr->ob_type == &PyCFunction_Type &&
5226 PyCFunction_GET_FUNCTION(descr) ==
5227 (PyCFunction)tp_new_wrapper &&
5228 strcmp(p->name, "__new__") == 0)
5229 {
5230 /* The __new__ wrapper is not a wrapper descriptor,
5231 so must be special-cased differently.
5232 If we don't do this, creating an instance will
5233 always use slot_tp_new which will look up
5234 __new__ in the MRO which will call tp_new_wrapper
5235 which will look through the base classes looking
5236 for a static base and call its tp_new (usually
5237 PyType_GenericNew), after performing various
5238 sanity checks and constructing a new argument
5239 list. Cut all that nonsense short -- this speeds
5240 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005241 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005242 /* XXX I'm not 100% sure that there isn't a hole
5243 in this reasoning that requires additional
5244 sanity checks. I'll buy the first person to
5245 point out a bug in this reasoning a beer. */
5246 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005247 else {
5248 use_generic = 1;
5249 generic = p->function;
5250 }
5251 } while ((++p)->offset == offset);
5252 if (specific && !use_generic)
5253 *ptr = specific;
5254 else
5255 *ptr = generic;
5256 return p;
5257}
5258
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005259/* In the type, update the slots whose slotdefs are gathered in the pp array.
5260 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005261static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005262update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005263{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005264 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005265
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005266 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005267 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005268 return 0;
5269}
5270
Guido van Rossumc334df52002-04-04 23:44:47 +00005271/* Comparison function for qsort() to compare slotdefs by their offset, and
5272 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005273static int
5274slotdef_cmp(const void *aa, const void *bb)
5275{
5276 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5277 int c = a->offset - b->offset;
5278 if (c != 0)
5279 return c;
5280 else
5281 return a - b;
5282}
5283
Guido van Rossumc334df52002-04-04 23:44:47 +00005284/* Initialize the slotdefs table by adding interned string objects for the
5285 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005286static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005287init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005288{
5289 slotdef *p;
5290 static int initialized = 0;
5291
5292 if (initialized)
5293 return;
5294 for (p = slotdefs; p->name; p++) {
5295 p->name_strobj = PyString_InternFromString(p->name);
5296 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005297 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005298 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005299 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5300 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005301 initialized = 1;
5302}
5303
Guido van Rossumc334df52002-04-04 23:44:47 +00005304/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005305static int
5306update_slot(PyTypeObject *type, PyObject *name)
5307{
Guido van Rossumc334df52002-04-04 23:44:47 +00005308 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005309 slotdef *p;
5310 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005311 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005312
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005313 init_slotdefs();
5314 pp = ptrs;
5315 for (p = slotdefs; p->name; p++) {
5316 /* XXX assume name is interned! */
5317 if (p->name_strobj == name)
5318 *pp++ = p;
5319 }
5320 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005321 for (pp = ptrs; *pp; pp++) {
5322 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005323 offset = p->offset;
5324 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005325 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005326 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005327 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005328 if (ptrs[0] == NULL)
5329 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005330 return update_subclasses(type, name,
5331 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005332}
5333
Guido van Rossumc334df52002-04-04 23:44:47 +00005334/* Store the proper functions in the slot dispatches at class (type)
5335 definition time, based upon which operations the class overrides in its
5336 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005337static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005338fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005339{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005340 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005341
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005342 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005343 for (p = slotdefs; p->name; )
5344 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005345}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005346
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005347static void
5348update_all_slots(PyTypeObject* type)
5349{
5350 slotdef *p;
5351
5352 init_slotdefs();
5353 for (p = slotdefs; p->name; p++) {
5354 /* update_slot returns int but can't actually fail */
5355 update_slot(type, p->name_strobj);
5356 }
5357}
5358
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005359/* recurse_down_subclasses() and update_subclasses() are mutually
5360 recursive functions to call a callback for all subclasses,
5361 but refraining from recursing into subclasses that define 'name'. */
5362
5363static int
5364update_subclasses(PyTypeObject *type, PyObject *name,
5365 update_callback callback, void *data)
5366{
5367 if (callback(type, data) < 0)
5368 return -1;
5369 return recurse_down_subclasses(type, name, callback, data);
5370}
5371
5372static int
5373recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5374 update_callback callback, void *data)
5375{
5376 PyTypeObject *subclass;
5377 PyObject *ref, *subclasses, *dict;
5378 int i, n;
5379
5380 subclasses = type->tp_subclasses;
5381 if (subclasses == NULL)
5382 return 0;
5383 assert(PyList_Check(subclasses));
5384 n = PyList_GET_SIZE(subclasses);
5385 for (i = 0; i < n; i++) {
5386 ref = PyList_GET_ITEM(subclasses, i);
5387 assert(PyWeakref_CheckRef(ref));
5388 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5389 assert(subclass != NULL);
5390 if ((PyObject *)subclass == Py_None)
5391 continue;
5392 assert(PyType_Check(subclass));
5393 /* Avoid recursing down into unaffected classes */
5394 dict = subclass->tp_dict;
5395 if (dict != NULL && PyDict_Check(dict) &&
5396 PyDict_GetItem(dict, name) != NULL)
5397 continue;
5398 if (update_subclasses(subclass, name, callback, data) < 0)
5399 return -1;
5400 }
5401 return 0;
5402}
5403
Guido van Rossum6d204072001-10-21 00:44:31 +00005404/* This function is called by PyType_Ready() to populate the type's
5405 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005406 function slot (like tp_repr) that's defined in the type, one or more
5407 corresponding descriptors are added in the type's tp_dict dictionary
5408 under the appropriate name (like __repr__). Some function slots
5409 cause more than one descriptor to be added (for example, the nb_add
5410 slot adds both __add__ and __radd__ descriptors) and some function
5411 slots compete for the same descriptor (for example both sq_item and
5412 mp_subscript generate a __getitem__ descriptor).
5413
5414 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005415 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005416 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005417 between competing slots: the members of PyHeapTypeObject are listed
5418 from most general to least general, so the most general slot is
5419 preferred. In particular, because as_mapping comes before as_sequence,
5420 for a type that defines both mp_subscript and sq_item, mp_subscript
5421 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005422
5423 This only adds new descriptors and doesn't overwrite entries in
5424 tp_dict that were previously defined. The descriptors contain a
5425 reference to the C function they must call, so that it's safe if they
5426 are copied into a subtype's __dict__ and the subtype has a different
5427 C function in its slot -- calling the method defined by the
5428 descriptor will call the C function that was used to create it,
5429 rather than the C function present in the slot when it is called.
5430 (This is important because a subtype may have a C function in the
5431 slot that calls the method from the dictionary, and we want to avoid
5432 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005433
5434static int
5435add_operators(PyTypeObject *type)
5436{
5437 PyObject *dict = type->tp_dict;
5438 slotdef *p;
5439 PyObject *descr;
5440 void **ptr;
5441
5442 init_slotdefs();
5443 for (p = slotdefs; p->name; p++) {
5444 if (p->wrapper == NULL)
5445 continue;
5446 ptr = slotptr(type, p->offset);
5447 if (!ptr || !*ptr)
5448 continue;
5449 if (PyDict_GetItem(dict, p->name_strobj))
5450 continue;
5451 descr = PyDescr_NewWrapper(type, p, *ptr);
5452 if (descr == NULL)
5453 return -1;
5454 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5455 return -1;
5456 Py_DECREF(descr);
5457 }
5458 if (type->tp_new != NULL) {
5459 if (add_tp_new_wrapper(type) < 0)
5460 return -1;
5461 }
5462 return 0;
5463}
5464
Guido van Rossum705f0f52001-08-24 16:47:00 +00005465
5466/* Cooperative 'super' */
5467
5468typedef struct {
5469 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005470 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005471 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005472 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005473} superobject;
5474
Guido van Rossum6f799372001-09-20 20:46:19 +00005475static PyMemberDef super_members[] = {
5476 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5477 "the class invoking super()"},
5478 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5479 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005480 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005481 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005482 {0}
5483};
5484
Guido van Rossum705f0f52001-08-24 16:47:00 +00005485static void
5486super_dealloc(PyObject *self)
5487{
5488 superobject *su = (superobject *)self;
5489
Guido van Rossum048eb752001-10-02 21:24:57 +00005490 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005491 Py_XDECREF(su->obj);
5492 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005493 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005494 self->ob_type->tp_free(self);
5495}
5496
5497static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005498super_repr(PyObject *self)
5499{
5500 superobject *su = (superobject *)self;
5501
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005502 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005503 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005504 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005505 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005506 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005507 else
5508 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005509 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005510 su->type ? su->type->tp_name : "NULL");
5511}
5512
5513static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005514super_getattro(PyObject *self, PyObject *name)
5515{
5516 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005517 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005518
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005519 if (!skip) {
5520 /* We want __class__ to return the class of the super object
5521 (i.e. super, or a subclass), not the class of su->obj. */
5522 skip = (PyString_Check(name) &&
5523 PyString_GET_SIZE(name) == 9 &&
5524 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5525 }
5526
5527 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005528 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005529 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005530 descrgetfunc f;
5531 int i, n;
5532
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005533 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005534 mro = starttype->tp_mro;
5535
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005536 if (mro == NULL)
5537 n = 0;
5538 else {
5539 assert(PyTuple_Check(mro));
5540 n = PyTuple_GET_SIZE(mro);
5541 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005542 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005543 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005544 break;
5545 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005546 i++;
5547 res = NULL;
5548 for (; i < n; i++) {
5549 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005550 if (PyType_Check(tmp))
5551 dict = ((PyTypeObject *)tmp)->tp_dict;
5552 else if (PyClass_Check(tmp))
5553 dict = ((PyClassObject *)tmp)->cl_dict;
5554 else
5555 continue;
5556 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005557 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005558 Py_INCREF(res);
5559 f = res->ob_type->tp_descr_get;
5560 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005561 tmp = f(res,
5562 /* Only pass 'obj' param if
5563 this is instance-mode super
5564 (See SF ID #743627)
5565 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00005566 (su->obj == (PyObject *)
5567 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005568 ? (PyObject *)NULL
5569 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00005570 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005571 Py_DECREF(res);
5572 res = tmp;
5573 }
5574 return res;
5575 }
5576 }
5577 }
5578 return PyObject_GenericGetAttr(self, name);
5579}
5580
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005581static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005582supercheck(PyTypeObject *type, PyObject *obj)
5583{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005584 /* Check that a super() call makes sense. Return a type object.
5585
5586 obj can be a new-style class, or an instance of one:
5587
5588 - If it is a class, it must be a subclass of 'type'. This case is
5589 used for class methods; the return value is obj.
5590
5591 - If it is an instance, it must be an instance of 'type'. This is
5592 the normal case; the return value is obj.__class__.
5593
5594 But... when obj is an instance, we want to allow for the case where
5595 obj->ob_type is not a subclass of type, but obj.__class__ is!
5596 This will allow using super() with a proxy for obj.
5597 */
5598
Guido van Rossum8e80a722003-02-18 19:22:22 +00005599 /* Check for first bullet above (special case) */
5600 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5601 Py_INCREF(obj);
5602 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005603 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005604
5605 /* Normal case */
5606 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005607 Py_INCREF(obj->ob_type);
5608 return obj->ob_type;
5609 }
5610 else {
5611 /* Try the slow way */
5612 static PyObject *class_str = NULL;
5613 PyObject *class_attr;
5614
5615 if (class_str == NULL) {
5616 class_str = PyString_FromString("__class__");
5617 if (class_str == NULL)
5618 return NULL;
5619 }
5620
5621 class_attr = PyObject_GetAttr(obj, class_str);
5622
5623 if (class_attr != NULL &&
5624 PyType_Check(class_attr) &&
5625 (PyTypeObject *)class_attr != obj->ob_type)
5626 {
5627 int ok = PyType_IsSubtype(
5628 (PyTypeObject *)class_attr, type);
5629 if (ok)
5630 return (PyTypeObject *)class_attr;
5631 }
5632
5633 if (class_attr == NULL)
5634 PyErr_Clear();
5635 else
5636 Py_DECREF(class_attr);
5637 }
5638
Tim Peters97e5ff52003-02-18 19:32:50 +00005639 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005640 "super(type, obj): "
5641 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005642 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005643}
5644
Guido van Rossum705f0f52001-08-24 16:47:00 +00005645static PyObject *
5646super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5647{
5648 superobject *su = (superobject *)self;
5649 superobject *new;
5650
5651 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5652 /* Not binding to an object, or already bound */
5653 Py_INCREF(self);
5654 return self;
5655 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005656 if (su->ob_type != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00005657 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005658 call its type */
5659 return PyObject_CallFunction((PyObject *)su->ob_type,
5660 "OO", su->type, obj);
5661 else {
5662 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005663 PyTypeObject *obj_type = supercheck(su->type, obj);
5664 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005665 return NULL;
5666 new = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
5667 NULL, NULL);
5668 if (new == NULL)
5669 return NULL;
5670 Py_INCREF(su->type);
5671 Py_INCREF(obj);
5672 new->type = su->type;
5673 new->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005674 new->obj_type = obj_type;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005675 return (PyObject *)new;
5676 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005677}
5678
5679static int
5680super_init(PyObject *self, PyObject *args, PyObject *kwds)
5681{
5682 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005683 PyTypeObject *type;
5684 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005685 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005686
5687 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5688 return -1;
5689 if (obj == Py_None)
5690 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005691 if (obj != NULL) {
5692 obj_type = supercheck(type, obj);
5693 if (obj_type == NULL)
5694 return -1;
5695 Py_INCREF(obj);
5696 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005697 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005698 su->type = type;
5699 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005700 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005701 return 0;
5702}
5703
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005704PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005705"super(type) -> unbound super object\n"
5706"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005707"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005708"Typical use to call a cooperative superclass method:\n"
5709"class C(B):\n"
5710" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005711" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005712
Guido van Rossum048eb752001-10-02 21:24:57 +00005713static int
5714super_traverse(PyObject *self, visitproc visit, void *arg)
5715{
5716 superobject *su = (superobject *)self;
5717 int err;
5718
5719#define VISIT(SLOT) \
5720 if (SLOT) { \
5721 err = visit((PyObject *)(SLOT), arg); \
5722 if (err) \
5723 return err; \
5724 }
5725
5726 VISIT(su->obj);
5727 VISIT(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005728 VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005729
5730#undef VISIT
5731
5732 return 0;
5733}
5734
Guido van Rossum705f0f52001-08-24 16:47:00 +00005735PyTypeObject PySuper_Type = {
5736 PyObject_HEAD_INIT(&PyType_Type)
5737 0, /* ob_size */
5738 "super", /* tp_name */
5739 sizeof(superobject), /* tp_basicsize */
5740 0, /* tp_itemsize */
5741 /* methods */
5742 super_dealloc, /* tp_dealloc */
5743 0, /* tp_print */
5744 0, /* tp_getattr */
5745 0, /* tp_setattr */
5746 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005747 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005748 0, /* tp_as_number */
5749 0, /* tp_as_sequence */
5750 0, /* tp_as_mapping */
5751 0, /* tp_hash */
5752 0, /* tp_call */
5753 0, /* tp_str */
5754 super_getattro, /* tp_getattro */
5755 0, /* tp_setattro */
5756 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005757 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5758 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005759 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00005760 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005761 0, /* tp_clear */
5762 0, /* tp_richcompare */
5763 0, /* tp_weaklistoffset */
5764 0, /* tp_iter */
5765 0, /* tp_iternext */
5766 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005767 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005768 0, /* tp_getset */
5769 0, /* tp_base */
5770 0, /* tp_dict */
5771 super_descr_get, /* tp_descr_get */
5772 0, /* tp_descr_set */
5773 0, /* tp_dictoffset */
5774 super_init, /* tp_init */
5775 PyType_GenericAlloc, /* tp_alloc */
5776 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00005777 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005778};