blob: 43f04694f9a52c49d9b217c451699f61c376194b [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{
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000024 const char *s;
Guido van Rossumc3542212001-08-16 09:18:56 +000025
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
Georg Brandlc255c7b2006-02-20 22:27:28 +000029 Py_INCREF(et->ht_name);
30 return et->ht_name;
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000031 }
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
Georg Brandlc255c7b2006-02-20 22:27:28 +000074 Py_DECREF(et->ht_name);
75 et->ht_name = value;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000076
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;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000148 Py_ssize_t 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{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000187 Py_ssize_t i;
188 int r = 0;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000189 PyObject *ob, *temp;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000190 PyTypeObject *new_base, *old_base;
191 PyObject *old_bases, *old_mro;
192
193 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
194 PyErr_Format(PyExc_TypeError,
195 "can't set %s.__bases__", type->tp_name);
196 return -1;
197 }
198 if (!value) {
199 PyErr_Format(PyExc_TypeError,
200 "can't delete %s.__bases__", type->tp_name);
201 return -1;
202 }
203 if (!PyTuple_Check(value)) {
204 PyErr_Format(PyExc_TypeError,
205 "can only assign tuple to %s.__bases__, not %s",
206 type->tp_name, value->ob_type->tp_name);
207 return -1;
208 }
Guido van Rossum3bbc0ee2002-12-13 17:49:38 +0000209 if (PyTuple_GET_SIZE(value) == 0) {
210 PyErr_Format(PyExc_TypeError,
211 "can only assign non-empty tuple to %s.__bases__, not ()",
212 type->tp_name);
213 return -1;
214 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000215 for (i = 0; i < PyTuple_GET_SIZE(value); i++) {
216 ob = PyTuple_GET_ITEM(value, i);
217 if (!PyClass_Check(ob) && !PyType_Check(ob)) {
218 PyErr_Format(
219 PyExc_TypeError,
220 "%s.__bases__ must be tuple of old- or new-style classes, not '%s'",
221 type->tp_name, ob->ob_type->tp_name);
222 return -1;
223 }
Michael W. Hudsoncaf17be2002-11-27 10:24:44 +0000224 if (PyType_Check(ob)) {
225 if (PyType_IsSubtype((PyTypeObject*)ob, type)) {
226 PyErr_SetString(PyExc_TypeError,
227 "a __bases__ item causes an inheritance cycle");
228 return -1;
229 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000230 }
231 }
232
233 new_base = best_base(value);
234
235 if (!new_base) {
236 return -1;
237 }
238
239 if (!compatible_for_assignment(type->tp_base, new_base, "__bases__"))
240 return -1;
241
242 Py_INCREF(new_base);
243 Py_INCREF(value);
244
245 old_bases = type->tp_bases;
246 old_base = type->tp_base;
247 old_mro = type->tp_mro;
248
249 type->tp_bases = value;
250 type->tp_base = new_base;
251
252 if (mro_internal(type) < 0) {
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000253 goto bail;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000254 }
255
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000256 temp = PyList_New(0);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000257 if (!temp)
258 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000259
260 r = mro_subclasses(type, temp);
261
262 if (r < 0) {
263 for (i = 0; i < PyList_Size(temp); i++) {
264 PyTypeObject* cls;
265 PyObject* mro;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000266 PyArg_UnpackTuple(PyList_GET_ITEM(temp, i),
267 "", 2, 2, &cls, &mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000268 Py_DECREF(cls->tp_mro);
269 cls->tp_mro = mro;
270 Py_INCREF(cls->tp_mro);
271 }
272 Py_DECREF(temp);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000273 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000274 }
275
276 Py_DECREF(temp);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000277
278 /* any base that was in __bases__ but now isn't, we
Raymond Hettingera8285862002-12-14 17:17:56 +0000279 need to remove |type| from its tp_subclasses.
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000280 conversely, any class now in __bases__ that wasn't
Raymond Hettingera8285862002-12-14 17:17:56 +0000281 needs to have |type| added to its subclasses. */
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000282
283 /* for now, sod that: just remove from all old_bases,
284 add to all new_bases */
285
286 for (i = PyTuple_GET_SIZE(old_bases) - 1; i >= 0; i--) {
287 ob = PyTuple_GET_ITEM(old_bases, i);
288 if (PyType_Check(ob)) {
289 remove_subclass(
290 (PyTypeObject*)ob, type);
291 }
292 }
293
294 for (i = PyTuple_GET_SIZE(value) - 1; i >= 0; i--) {
295 ob = PyTuple_GET_ITEM(value, i);
296 if (PyType_Check(ob)) {
297 if (add_subclass((PyTypeObject*)ob, type) < 0)
298 r = -1;
299 }
300 }
301
302 update_all_slots(type);
303
304 Py_DECREF(old_bases);
305 Py_DECREF(old_base);
306 Py_DECREF(old_mro);
307
308 return r;
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000309
310 bail:
Michael W. Hudsone723e452003-08-07 14:58:10 +0000311 Py_DECREF(type->tp_bases);
312 Py_DECREF(type->tp_base);
313 if (type->tp_mro != old_mro) {
314 Py_DECREF(type->tp_mro);
315 }
316
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000317 type->tp_bases = old_bases;
318 type->tp_base = old_base;
319 type->tp_mro = old_mro;
Tim Petersea7f75d2002-12-07 21:39:16 +0000320
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000321 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000322}
323
324static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000325type_dict(PyTypeObject *type, void *context)
326{
327 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000328 Py_INCREF(Py_None);
329 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000330 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000331 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000332}
333
Tim Peters24008312002-03-17 18:56:20 +0000334static PyObject *
335type_get_doc(PyTypeObject *type, void *context)
336{
337 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000338 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Tim Peters24008312002-03-17 18:56:20 +0000339 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000340 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000341 if (result == NULL) {
342 result = Py_None;
343 Py_INCREF(result);
344 }
345 else if (result->ob_type->tp_descr_get) {
Tim Peters2b858972002-04-18 04:12:28 +0000346 result = result->ob_type->tp_descr_get(result, NULL,
347 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000348 }
349 else {
350 Py_INCREF(result);
351 }
Tim Peters24008312002-03-17 18:56:20 +0000352 return result;
353}
354
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000355static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000356 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
357 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000358 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000359 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000360 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000361 {0}
362};
363
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000364static int
365type_compare(PyObject *v, PyObject *w)
366{
367 /* This is called with type objects only. So we
368 can just compare the addresses. */
369 Py_uintptr_t vv = (Py_uintptr_t)v;
370 Py_uintptr_t ww = (Py_uintptr_t)w;
371 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
372}
373
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000374static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000375type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000376{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000377 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000378 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000379
380 mod = type_module(type, NULL);
381 if (mod == NULL)
382 PyErr_Clear();
383 else if (!PyString_Check(mod)) {
384 Py_DECREF(mod);
385 mod = NULL;
386 }
387 name = type_name(type, NULL);
388 if (name == NULL)
389 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000390
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000391 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
392 kind = "class";
393 else
394 kind = "type";
395
Barry Warsaw7ce36942001-08-24 18:34:26 +0000396 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000397 rtn = PyString_FromFormat("<%s '%s.%s'>",
398 kind,
Barry Warsaw7ce36942001-08-24 18:34:26 +0000399 PyString_AS_STRING(mod),
400 PyString_AS_STRING(name));
401 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000402 else
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000403 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000404
Guido van Rossumc3542212001-08-16 09:18:56 +0000405 Py_XDECREF(mod);
406 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000407 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000408}
409
Tim Peters6d6c1a32001-08-02 04:15:00 +0000410static PyObject *
411type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
412{
413 PyObject *obj;
414
415 if (type->tp_new == NULL) {
416 PyErr_Format(PyExc_TypeError,
417 "cannot create '%.100s' instances",
418 type->tp_name);
419 return NULL;
420 }
421
Tim Peters3f996e72001-09-13 19:18:27 +0000422 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000423 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000424 /* Ugly exception: when the call was type(something),
425 don't call tp_init on the result. */
426 if (type == &PyType_Type &&
427 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
428 (kwds == NULL ||
429 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
430 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000431 /* If the returned object is not an instance of type,
432 it won't be initialized. */
433 if (!PyType_IsSubtype(obj->ob_type, type))
434 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000435 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000436 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
437 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000438 type->tp_init(obj, args, kwds) < 0) {
439 Py_DECREF(obj);
440 obj = NULL;
441 }
442 }
443 return obj;
444}
445
446PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000447PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000448{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000449 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000450 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
451 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000452
453 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000454 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000455 else
Anthony Baxtera6286212006-04-11 07:42:36 +0000456 obj = (PyObject *)PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000457
Neil Schemenauerc806c882001-08-29 23:54:54 +0000458 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000459 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000460
Neil Schemenauerc806c882001-08-29 23:54:54 +0000461 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000462
Tim Peters6d6c1a32001-08-02 04:15:00 +0000463 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
464 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000465
Tim Peters6d6c1a32001-08-02 04:15:00 +0000466 if (type->tp_itemsize == 0)
467 PyObject_INIT(obj, type);
468 else
469 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000470
Tim Peters6d6c1a32001-08-02 04:15:00 +0000471 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000472 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000473 return obj;
474}
475
476PyObject *
477PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
478{
479 return type->tp_alloc(type, 0);
480}
481
Guido van Rossum9475a232001-10-05 20:51:39 +0000482/* Helpers for subtyping */
483
484static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000485traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
486{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000487 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000488 PyMemberDef *mp;
489
490 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000491 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000492 for (i = 0; i < n; i++, mp++) {
493 if (mp->type == T_OBJECT_EX) {
494 char *addr = (char *)self + mp->offset;
495 PyObject *obj = *(PyObject **)addr;
496 if (obj != NULL) {
497 int err = visit(obj, arg);
498 if (err)
499 return err;
500 }
501 }
502 }
503 return 0;
504}
505
506static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000507subtype_traverse(PyObject *self, visitproc visit, void *arg)
508{
509 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000510 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000511
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000512 /* Find the nearest base with a different tp_traverse,
513 and traverse slots while we're at it */
Guido van Rossum9475a232001-10-05 20:51:39 +0000514 type = self->ob_type;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000515 base = type;
516 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
517 if (base->ob_size) {
518 int err = traverse_slots(base, self, visit, arg);
519 if (err)
520 return err;
521 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000522 base = base->tp_base;
523 assert(base);
524 }
525
526 if (type->tp_dictoffset != base->tp_dictoffset) {
527 PyObject **dictptr = _PyObject_GetDictPtr(self);
Thomas Woutersc6e55062006-04-15 21:47:09 +0000528 if (dictptr && *dictptr)
529 Py_VISIT(*dictptr);
Guido van Rossum9475a232001-10-05 20:51:39 +0000530 }
531
Thomas Woutersc6e55062006-04-15 21:47:09 +0000532 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
Guido van Rossuma3862092002-06-10 15:24:42 +0000533 /* For a heaptype, the instances count as references
534 to the type. Traverse the type so the collector
535 can find cycles involving this link. */
Thomas Woutersc6e55062006-04-15 21:47:09 +0000536 Py_VISIT(type);
Guido van Rossuma3862092002-06-10 15:24:42 +0000537
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000538 if (basetraverse)
539 return basetraverse(self, visit, arg);
540 return 0;
541}
542
543static void
544clear_slots(PyTypeObject *type, PyObject *self)
545{
Martin v. Löwis18e16552006-02-15 17:27:45 +0000546 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000547 PyMemberDef *mp;
548
549 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000550 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000551 for (i = 0; i < n; i++, mp++) {
552 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
553 char *addr = (char *)self + mp->offset;
554 PyObject *obj = *(PyObject **)addr;
555 if (obj != NULL) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000556 *(PyObject **)addr = NULL;
Thomas Woutersedf17d82006-04-15 17:28:34 +0000557 Py_DECREF(obj);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000558 }
559 }
560 }
561}
562
563static int
564subtype_clear(PyObject *self)
565{
566 PyTypeObject *type, *base;
567 inquiry baseclear;
568
569 /* Find the nearest base with a different tp_clear
570 and clear slots while we're at it */
571 type = self->ob_type;
572 base = type;
573 while ((baseclear = base->tp_clear) == subtype_clear) {
574 if (base->ob_size)
575 clear_slots(base, self);
576 base = base->tp_base;
577 assert(base);
578 }
579
Guido van Rossuma3862092002-06-10 15:24:42 +0000580 /* There's no need to clear the instance dict (if any);
581 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000582
583 if (baseclear)
584 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000585 return 0;
586}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000587
588static void
589subtype_dealloc(PyObject *self)
590{
Guido van Rossum14227b42001-12-06 02:35:58 +0000591 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000592 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000593
Guido van Rossum22b13872002-08-06 21:41:44 +0000594 /* Extract the type; we expect it to be a heap type */
595 type = self->ob_type;
596 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000597
Guido van Rossum22b13872002-08-06 21:41:44 +0000598 /* Test whether the type has GC exactly once */
599
600 if (!PyType_IS_GC(type)) {
601 /* It's really rare to find a dynamic type that doesn't have
602 GC; it can only happen when deriving from 'object' and not
603 adding any slots or instance variables. This allows
604 certain simplifications: there's no need to call
605 clear_slots(), or DECREF the dict, or clear weakrefs. */
606
607 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000608 if (type->tp_del) {
609 type->tp_del(self);
610 if (self->ob_refcnt > 0)
611 return;
612 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000613
614 /* Find the nearest base with a different tp_dealloc */
615 base = type;
616 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
617 assert(base->ob_size == 0);
618 base = base->tp_base;
619 assert(base);
620 }
621
622 /* Call the base tp_dealloc() */
623 assert(basedealloc);
624 basedealloc(self);
625
626 /* Can't reference self beyond this point */
627 Py_DECREF(type);
628
629 /* Done */
630 return;
631 }
632
633 /* We get here only if the type has GC */
634
635 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000636 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000637 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000638 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000639 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000640 --_PyTrash_delete_nesting;
Tim Petersf7f9e992003-11-13 21:59:32 +0000641 /* DO NOT restore GC tracking at this point. weakref callbacks
642 * (if any, and whether directly here or indirectly in something we
643 * call) may trigger GC, and if self is tracked at that point, it
644 * will look like trash to GC and GC will try to delete self again.
Tim Petersadd09b42003-11-12 20:43:28 +0000645 */
Guido van Rossum22b13872002-08-06 21:41:44 +0000646
Guido van Rossum59195fd2003-06-13 20:54:40 +0000647 /* Find the nearest base with a different tp_dealloc */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000648 base = type;
649 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000650 base = base->tp_base;
651 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000652 }
653
Guido van Rossum1987c662003-05-29 14:29:23 +0000654 /* If we added a weaklist, we clear it. Do this *before* calling
Guido van Rossum59195fd2003-06-13 20:54:40 +0000655 the finalizer (__del__), clearing slots, or clearing the instance
656 dict. */
657
Guido van Rossum1987c662003-05-29 14:29:23 +0000658 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
659 PyObject_ClearWeakRefs(self);
660
661 /* Maybe call finalizer; exit early if resurrected */
662 if (type->tp_del) {
Tim Petersf7f9e992003-11-13 21:59:32 +0000663 _PyObject_GC_TRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000664 type->tp_del(self);
665 if (self->ob_refcnt > 0)
Tim Petersf7f9e992003-11-13 21:59:32 +0000666 goto endlabel; /* resurrected */
667 else
668 _PyObject_GC_UNTRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000669 }
670
Guido van Rossum59195fd2003-06-13 20:54:40 +0000671 /* Clear slots up to the nearest base with a different tp_dealloc */
672 base = type;
673 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
674 if (base->ob_size)
675 clear_slots(base, self);
676 base = base->tp_base;
677 assert(base);
678 }
679
Tim Peters6d6c1a32001-08-02 04:15:00 +0000680 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000681 if (type->tp_dictoffset && !base->tp_dictoffset) {
682 PyObject **dictptr = _PyObject_GetDictPtr(self);
683 if (dictptr != NULL) {
684 PyObject *dict = *dictptr;
685 if (dict != NULL) {
686 Py_DECREF(dict);
687 *dictptr = NULL;
688 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000689 }
690 }
691
Tim Peters0bd743c2003-11-13 22:50:00 +0000692 /* Call the base tp_dealloc(); first retrack self if
693 * basedealloc knows about gc.
694 */
695 if (PyType_IS_GC(base))
696 _PyObject_GC_TRACK(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000697 assert(basedealloc);
698 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000699
700 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000701 Py_DECREF(type);
702
Guido van Rossum0906e072002-08-07 20:42:09 +0000703 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000704 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000705 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000706 --_PyTrash_delete_nesting;
707
708 /* Explanation of the weirdness around the trashcan macros:
709
710 Q. What do the trashcan macros do?
711
712 A. Read the comment titled "Trashcan mechanism" in object.h.
713 For one, this explains why there must be a call to GC-untrack
714 before the trashcan begin macro. Without understanding the
715 trashcan code, the answers to the following questions don't make
716 sense.
717
718 Q. Why do we GC-untrack before the trashcan and then immediately
719 GC-track again afterward?
720
721 A. In the case that the base class is GC-aware, the base class
722 probably GC-untracks the object. If it does that using the
723 UNTRACK macro, this will crash when the object is already
724 untracked. Because we don't know what the base class does, the
725 only safe thing is to make sure the object is tracked when we
726 call the base class dealloc. But... The trashcan begin macro
727 requires that the object is *untracked* before it is called. So
728 the dance becomes:
729
730 GC untrack
731 trashcan begin
732 GC track
733
Tim Petersf7f9e992003-11-13 21:59:32 +0000734 Q. Why did the last question say "immediately GC-track again"?
735 It's nowhere near immediately.
736
737 A. Because the code *used* to re-track immediately. Bad Idea.
738 self has a refcount of 0, and if gc ever gets its hands on it
739 (which can happen if any weakref callback gets invoked), it
740 looks like trash to gc too, and gc also tries to delete self
741 then. But we're already deleting self. Double dealloction is
742 a subtle disaster.
743
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000744 Q. Why the bizarre (net-zero) manipulation of
745 _PyTrash_delete_nesting around the trashcan macros?
746
747 A. Some base classes (e.g. list) also use the trashcan mechanism.
748 The following scenario used to be possible:
749
750 - suppose the trashcan level is one below the trashcan limit
751
752 - subtype_dealloc() is called
753
754 - the trashcan limit is not yet reached, so the trashcan level
755 is incremented and the code between trashcan begin and end is
756 executed
757
758 - this destroys much of the object's contents, including its
759 slots and __dict__
760
761 - basedealloc() is called; this is really list_dealloc(), or
762 some other type which also uses the trashcan macros
763
764 - the trashcan limit is now reached, so the object is put on the
765 trashcan's to-be-deleted-later list
766
767 - basedealloc() returns
768
769 - subtype_dealloc() decrefs the object's type
770
771 - subtype_dealloc() returns
772
773 - later, the trashcan code starts deleting the objects from its
774 to-be-deleted-later list
775
776 - subtype_dealloc() is called *AGAIN* for the same object
777
778 - at the very least (if the destroyed slots and __dict__ don't
779 cause problems) the object's type gets decref'ed a second
780 time, which is *BAD*!!!
781
782 The remedy is to make sure that if the code between trashcan
783 begin and end in subtype_dealloc() is called, the code between
784 trashcan begin and end in basedealloc() will also be called.
785 This is done by decrementing the level after passing into the
786 trashcan block, and incrementing it just before leaving the
787 block.
788
789 But now it's possible that a chain of objects consisting solely
790 of objects whose deallocator is subtype_dealloc() will defeat
791 the trashcan mechanism completely: the decremented level means
792 that the effective level never reaches the limit. Therefore, we
793 *increment* the level *before* entering the trashcan block, and
794 matchingly decrement it after leaving. This means the trashcan
795 code will trigger a little early, but that's no big deal.
796
797 Q. Are there any live examples of code in need of all this
798 complexity?
799
800 A. Yes. See SF bug 668433 for code that crashed (when Python was
801 compiled in debug mode) before the trashcan level manipulations
802 were added. For more discussion, see SF patches 581742, 575073
803 and bug 574207.
804 */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000805}
806
Jeremy Hylton938ace62002-07-17 16:30:39 +0000807static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000808
Tim Peters6d6c1a32001-08-02 04:15:00 +0000809/* type test with subclassing support */
810
811int
812PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
813{
814 PyObject *mro;
815
Guido van Rossum9478d072001-09-07 18:52:13 +0000816 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
817 return b == a || b == &PyBaseObject_Type;
818
Tim Peters6d6c1a32001-08-02 04:15:00 +0000819 mro = a->tp_mro;
820 if (mro != NULL) {
821 /* Deal with multiple inheritance without recursion
822 by walking the MRO tuple */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000823 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000824 assert(PyTuple_Check(mro));
825 n = PyTuple_GET_SIZE(mro);
826 for (i = 0; i < n; i++) {
827 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
828 return 1;
829 }
830 return 0;
831 }
832 else {
833 /* a is not completely initilized yet; follow tp_base */
834 do {
835 if (a == b)
836 return 1;
837 a = a->tp_base;
838 } while (a != NULL);
839 return b == &PyBaseObject_Type;
840 }
841}
842
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000843/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +0000844 without looking in the instance dictionary
845 (so we can't use PyObject_GetAttr) but still binding
846 it to the instance. The arguments are the object,
847 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000848 static variable used to cache the interned Python string.
849
850 Two variants:
851
852 - lookup_maybe() returns NULL without raising an exception
853 when the _PyType_Lookup() call fails;
854
855 - lookup_method() always raises an exception upon errors.
856*/
Guido van Rossum60718732001-08-28 17:47:51 +0000857
858static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000859lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +0000860{
861 PyObject *res;
862
863 if (*attrobj == NULL) {
864 *attrobj = PyString_InternFromString(attrstr);
865 if (*attrobj == NULL)
866 return NULL;
867 }
868 res = _PyType_Lookup(self->ob_type, *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000869 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +0000870 descrgetfunc f;
871 if ((f = res->ob_type->tp_descr_get) == NULL)
872 Py_INCREF(res);
873 else
874 res = f(res, self, (PyObject *)(self->ob_type));
875 }
876 return res;
877}
878
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000879static PyObject *
880lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
881{
882 PyObject *res = lookup_maybe(self, attrstr, attrobj);
883 if (res == NULL && !PyErr_Occurred())
884 PyErr_SetObject(PyExc_AttributeError, *attrobj);
885 return res;
886}
887
Guido van Rossum2730b132001-08-28 18:22:14 +0000888/* A variation of PyObject_CallMethod that uses lookup_method()
889 instead of PyObject_GetAttrString(). This uses the same convention
890 as lookup_method to cache the interned name string object. */
891
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000892static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +0000893call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
894{
895 va_list va;
896 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +0000897 va_start(va, format);
898
Guido van Rossumda21c012001-10-03 00:50:18 +0000899 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000900 if (func == NULL) {
901 va_end(va);
902 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +0000903 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000904 return NULL;
905 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000906
907 if (format && *format)
908 args = Py_VaBuildValue(format, va);
909 else
910 args = PyTuple_New(0);
911
912 va_end(va);
913
914 if (args == NULL)
915 return NULL;
916
917 assert(PyTuple_Check(args));
918 retval = PyObject_Call(func, args, NULL);
919
920 Py_DECREF(args);
921 Py_DECREF(func);
922
923 return retval;
924}
925
926/* Clone of call_method() that returns NotImplemented when the lookup fails. */
927
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000928static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000929call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
930{
931 va_list va;
932 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000933 va_start(va, format);
934
Guido van Rossumda21c012001-10-03 00:50:18 +0000935 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +0000936 if (func == NULL) {
937 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000938 if (!PyErr_Occurred()) {
939 Py_INCREF(Py_NotImplemented);
940 return Py_NotImplemented;
941 }
Guido van Rossum717ce002001-09-14 16:58:08 +0000942 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +0000943 }
944
945 if (format && *format)
946 args = Py_VaBuildValue(format, va);
947 else
948 args = PyTuple_New(0);
949
950 va_end(va);
951
Guido van Rossum717ce002001-09-14 16:58:08 +0000952 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +0000953 return NULL;
954
Guido van Rossum717ce002001-09-14 16:58:08 +0000955 assert(PyTuple_Check(args));
956 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +0000957
958 Py_DECREF(args);
959 Py_DECREF(func);
960
961 return retval;
962}
963
Tim Petersa91e9642001-11-14 23:32:33 +0000964static int
965fill_classic_mro(PyObject *mro, PyObject *cls)
966{
967 PyObject *bases, *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000968 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +0000969
970 assert(PyList_Check(mro));
971 assert(PyClass_Check(cls));
972 i = PySequence_Contains(mro, cls);
973 if (i < 0)
974 return -1;
975 if (!i) {
976 if (PyList_Append(mro, cls) < 0)
977 return -1;
978 }
979 bases = ((PyClassObject *)cls)->cl_bases;
980 assert(bases && PyTuple_Check(bases));
981 n = PyTuple_GET_SIZE(bases);
982 for (i = 0; i < n; i++) {
983 base = PyTuple_GET_ITEM(bases, i);
984 if (fill_classic_mro(mro, base) < 0)
985 return -1;
986 }
987 return 0;
988}
989
990static PyObject *
991classic_mro(PyObject *cls)
992{
993 PyObject *mro;
994
995 assert(PyClass_Check(cls));
996 mro = PyList_New(0);
997 if (mro != NULL) {
998 if (fill_classic_mro(mro, cls) == 0)
999 return mro;
1000 Py_DECREF(mro);
1001 }
1002 return NULL;
1003}
1004
Tim Petersea7f75d2002-12-07 21:39:16 +00001005/*
Guido van Rossum1f121312002-11-14 19:49:16 +00001006 Method resolution order algorithm C3 described in
1007 "A Monotonic Superclass Linearization for Dylan",
1008 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +00001009 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +00001010 (OOPSLA 1996)
1011
Guido van Rossum98f33732002-11-25 21:36:54 +00001012 Some notes about the rules implied by C3:
1013
Tim Petersea7f75d2002-12-07 21:39:16 +00001014 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +00001015 It isn't legal to repeat a class in a list of base classes.
1016
1017 The next three properties are the 3 constraints in "C3".
1018
Tim Petersea7f75d2002-12-07 21:39:16 +00001019 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +00001020 If A precedes B in C's MRO, then A will precede B in the MRO of all
1021 subclasses of C.
1022
1023 Monotonicity.
1024 The MRO of a class must be an extension without reordering of the
1025 MRO of each of its superclasses.
1026
1027 Extended Precedence Graph (EPG).
1028 Linearization is consistent if there is a path in the EPG from
1029 each class to all its successors in the linearization. See
1030 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001031 */
1032
Tim Petersea7f75d2002-12-07 21:39:16 +00001033static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001034tail_contains(PyObject *list, int whence, PyObject *o) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001035 Py_ssize_t j, size;
Guido van Rossum1f121312002-11-14 19:49:16 +00001036 size = PyList_GET_SIZE(list);
1037
1038 for (j = whence+1; j < size; j++) {
1039 if (PyList_GET_ITEM(list, j) == o)
1040 return 1;
1041 }
1042 return 0;
1043}
1044
Guido van Rossum98f33732002-11-25 21:36:54 +00001045static PyObject *
1046class_name(PyObject *cls)
1047{
1048 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1049 if (name == NULL) {
1050 PyErr_Clear();
1051 Py_XDECREF(name);
1052 name = PyObject_Repr(cls);
1053 }
1054 if (name == NULL)
1055 return NULL;
1056 if (!PyString_Check(name)) {
1057 Py_DECREF(name);
1058 return NULL;
1059 }
1060 return name;
1061}
1062
1063static int
1064check_duplicates(PyObject *list)
1065{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001066 Py_ssize_t i, j, n;
Guido van Rossum98f33732002-11-25 21:36:54 +00001067 /* Let's use a quadratic time algorithm,
1068 assuming that the bases lists is short.
1069 */
1070 n = PyList_GET_SIZE(list);
1071 for (i = 0; i < n; i++) {
1072 PyObject *o = PyList_GET_ITEM(list, i);
1073 for (j = i + 1; j < n; j++) {
1074 if (PyList_GET_ITEM(list, j) == o) {
1075 o = class_name(o);
1076 PyErr_Format(PyExc_TypeError,
1077 "duplicate base class %s",
1078 o ? PyString_AS_STRING(o) : "?");
1079 Py_XDECREF(o);
1080 return -1;
1081 }
1082 }
1083 }
1084 return 0;
1085}
1086
1087/* Raise a TypeError for an MRO order disagreement.
1088
1089 It's hard to produce a good error message. In the absence of better
1090 insight into error reporting, report the classes that were candidates
1091 to be put next into the MRO. There is some conflict between the
1092 order in which they should be put in the MRO, but it's hard to
1093 diagnose what constraint can't be satisfied.
1094*/
1095
1096static void
1097set_mro_error(PyObject *to_merge, int *remain)
1098{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001099 Py_ssize_t i, n, off, to_merge_size;
Guido van Rossum98f33732002-11-25 21:36:54 +00001100 char buf[1000];
1101 PyObject *k, *v;
1102 PyObject *set = PyDict_New();
Georg Brandl5c170fd2006-03-17 19:03:25 +00001103 if (!set) return;
Guido van Rossum98f33732002-11-25 21:36:54 +00001104
1105 to_merge_size = PyList_GET_SIZE(to_merge);
1106 for (i = 0; i < to_merge_size; i++) {
1107 PyObject *L = PyList_GET_ITEM(to_merge, i);
1108 if (remain[i] < PyList_GET_SIZE(L)) {
1109 PyObject *c = PyList_GET_ITEM(L, remain[i]);
Georg Brandl5c170fd2006-03-17 19:03:25 +00001110 if (PyDict_SetItem(set, c, Py_None) < 0) {
1111 Py_DECREF(set);
Guido van Rossum98f33732002-11-25 21:36:54 +00001112 return;
Georg Brandl5c170fd2006-03-17 19:03:25 +00001113 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001114 }
1115 }
1116 n = PyDict_Size(set);
1117
Raymond Hettingerf394df42003-04-06 19:13:41 +00001118 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1119consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001120 i = 0;
1121 while (PyDict_Next(set, &i, &k, &v) && off < sizeof(buf)) {
1122 PyObject *name = class_name(k);
1123 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
1124 name ? PyString_AS_STRING(name) : "?");
1125 Py_XDECREF(name);
1126 if (--n && off+1 < sizeof(buf)) {
1127 buf[off++] = ',';
1128 buf[off] = '\0';
1129 }
1130 }
1131 PyErr_SetString(PyExc_TypeError, buf);
1132 Py_DECREF(set);
1133}
1134
Tim Petersea7f75d2002-12-07 21:39:16 +00001135static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001136pmerge(PyObject *acc, PyObject* to_merge) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001137 Py_ssize_t i, j, to_merge_size, empty_cnt;
Guido van Rossum1f121312002-11-14 19:49:16 +00001138 int *remain;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001139 int ok;
Tim Petersea7f75d2002-12-07 21:39:16 +00001140
Guido van Rossum1f121312002-11-14 19:49:16 +00001141 to_merge_size = PyList_GET_SIZE(to_merge);
1142
Guido van Rossum98f33732002-11-25 21:36:54 +00001143 /* remain stores an index into each sublist of to_merge.
1144 remain[i] is the index of the next base in to_merge[i]
1145 that is not included in acc.
1146 */
Anthony Baxtera6286212006-04-11 07:42:36 +00001147 remain = (int *)PyMem_MALLOC(SIZEOF_INT*to_merge_size);
Guido van Rossum1f121312002-11-14 19:49:16 +00001148 if (remain == NULL)
1149 return -1;
1150 for (i = 0; i < to_merge_size; i++)
1151 remain[i] = 0;
1152
1153 again:
1154 empty_cnt = 0;
1155 for (i = 0; i < to_merge_size; i++) {
1156 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001157
Guido van Rossum1f121312002-11-14 19:49:16 +00001158 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1159
1160 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1161 empty_cnt++;
1162 continue;
1163 }
1164
Guido van Rossum98f33732002-11-25 21:36:54 +00001165 /* Choose next candidate for MRO.
1166
1167 The input sequences alone can determine the choice.
1168 If not, choose the class which appears in the MRO
1169 of the earliest direct superclass of the new class.
1170 */
1171
Guido van Rossum1f121312002-11-14 19:49:16 +00001172 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1173 for (j = 0; j < to_merge_size; j++) {
1174 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001175 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001176 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001177 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001178 }
1179 ok = PyList_Append(acc, candidate);
1180 if (ok < 0) {
1181 PyMem_Free(remain);
1182 return -1;
1183 }
1184 for (j = 0; j < to_merge_size; j++) {
1185 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001186 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1187 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001188 remain[j]++;
1189 }
1190 }
1191 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001192 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001193 }
1194
Guido van Rossum98f33732002-11-25 21:36:54 +00001195 if (empty_cnt == to_merge_size) {
1196 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001197 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001198 }
1199 set_mro_error(to_merge, remain);
1200 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001201 return -1;
1202}
1203
Tim Peters6d6c1a32001-08-02 04:15:00 +00001204static PyObject *
1205mro_implementation(PyTypeObject *type)
1206{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001207 Py_ssize_t i, n;
1208 int ok;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001209 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001210 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001211
Guido van Rossum63517572002-06-18 16:44:57 +00001212 if(type->tp_dict == NULL) {
1213 if(PyType_Ready(type) < 0)
1214 return NULL;
1215 }
1216
Guido van Rossum98f33732002-11-25 21:36:54 +00001217 /* Find a superclass linearization that honors the constraints
1218 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001219 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001220
1221 to_merge is a list of lists, where each list is a superclass
1222 linearization implied by a base class. The last element of
1223 to_merge is the declared list of bases.
1224 */
1225
Tim Peters6d6c1a32001-08-02 04:15:00 +00001226 bases = type->tp_bases;
1227 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001228
1229 to_merge = PyList_New(n+1);
1230 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001231 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001232
Tim Peters6d6c1a32001-08-02 04:15:00 +00001233 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001234 PyObject *base = PyTuple_GET_ITEM(bases, i);
1235 PyObject *parentMRO;
1236 if (PyType_Check(base))
1237 parentMRO = PySequence_List(
1238 ((PyTypeObject*)base)->tp_mro);
1239 else
1240 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001241 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001242 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001243 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001244 }
1245
1246 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001247 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001248
1249 bases_aslist = PySequence_List(bases);
1250 if (bases_aslist == NULL) {
1251 Py_DECREF(to_merge);
1252 return NULL;
1253 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001254 /* This is just a basic sanity check. */
1255 if (check_duplicates(bases_aslist) < 0) {
1256 Py_DECREF(to_merge);
1257 Py_DECREF(bases_aslist);
1258 return NULL;
1259 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001260 PyList_SET_ITEM(to_merge, n, bases_aslist);
1261
1262 result = Py_BuildValue("[O]", (PyObject *)type);
1263 if (result == NULL) {
1264 Py_DECREF(to_merge);
1265 return NULL;
1266 }
1267
1268 ok = pmerge(result, to_merge);
1269 Py_DECREF(to_merge);
1270 if (ok < 0) {
1271 Py_DECREF(result);
1272 return NULL;
1273 }
1274
Tim Peters6d6c1a32001-08-02 04:15:00 +00001275 return result;
1276}
1277
1278static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001279mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001280{
1281 PyTypeObject *type = (PyTypeObject *)self;
1282
Tim Peters6d6c1a32001-08-02 04:15:00 +00001283 return mro_implementation(type);
1284}
1285
1286static int
1287mro_internal(PyTypeObject *type)
1288{
1289 PyObject *mro, *result, *tuple;
Armin Rigo037d1e02005-12-29 17:07:39 +00001290 int checkit = 0;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001291
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;
Armin Rigo037d1e02005-12-29 17:07:39 +00001297 checkit = 1;
Guido van Rossum60718732001-08-28 17:47:51 +00001298 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001299 if (mro == NULL)
1300 return -1;
1301 result = PyObject_CallObject(mro, NULL);
1302 Py_DECREF(mro);
1303 }
1304 if (result == NULL)
1305 return -1;
1306 tuple = PySequence_Tuple(result);
1307 Py_DECREF(result);
Armin Rigo037d1e02005-12-29 17:07:39 +00001308 if (tuple == NULL)
1309 return -1;
1310 if (checkit) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001311 Py_ssize_t i, len;
Armin Rigo037d1e02005-12-29 17:07:39 +00001312 PyObject *cls;
1313 PyTypeObject *solid;
1314
1315 solid = solid_base(type);
1316
1317 len = PyTuple_GET_SIZE(tuple);
1318
1319 for (i = 0; i < len; i++) {
1320 PyTypeObject *t;
1321 cls = PyTuple_GET_ITEM(tuple, i);
1322 if (PyClass_Check(cls))
1323 continue;
1324 else if (!PyType_Check(cls)) {
1325 PyErr_Format(PyExc_TypeError,
1326 "mro() returned a non-class ('%.500s')",
1327 cls->ob_type->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001328 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001329 return -1;
1330 }
1331 t = (PyTypeObject*)cls;
1332 if (!PyType_IsSubtype(solid, solid_base(t))) {
1333 PyErr_Format(PyExc_TypeError,
1334 "mro() returned base with unsuitable layout ('%.500s')",
1335 t->tp_name);
Neal Norwitz50bf51a2006-01-02 02:46:54 +00001336 Py_DECREF(tuple);
Armin Rigo037d1e02005-12-29 17:07:39 +00001337 return -1;
1338 }
1339 }
1340 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001341 type->tp_mro = tuple;
1342 return 0;
1343}
1344
1345
1346/* Calculate the best base amongst multiple base classes.
1347 This is the first one that's on the path to the "solid base". */
1348
1349static PyTypeObject *
1350best_base(PyObject *bases)
1351{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001352 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001353 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001354 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001355
1356 assert(PyTuple_Check(bases));
1357 n = PyTuple_GET_SIZE(bases);
1358 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001359 base = NULL;
1360 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001361 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001362 base_proto = PyTuple_GET_ITEM(bases, i);
1363 if (PyClass_Check(base_proto))
1364 continue;
1365 if (!PyType_Check(base_proto)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001366 PyErr_SetString(
1367 PyExc_TypeError,
1368 "bases must be types");
1369 return NULL;
1370 }
Tim Petersa91e9642001-11-14 23:32:33 +00001371 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001372 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001373 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001374 return NULL;
1375 }
1376 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001377 if (winner == NULL) {
1378 winner = candidate;
1379 base = base_i;
1380 }
1381 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001382 ;
1383 else if (PyType_IsSubtype(candidate, winner)) {
1384 winner = candidate;
1385 base = base_i;
1386 }
1387 else {
1388 PyErr_SetString(
1389 PyExc_TypeError,
1390 "multiple bases have "
1391 "instance lay-out conflict");
1392 return NULL;
1393 }
1394 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001395 if (base == NULL)
1396 PyErr_SetString(PyExc_TypeError,
1397 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001398 return base;
1399}
1400
1401static int
1402extra_ivars(PyTypeObject *type, PyTypeObject *base)
1403{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001404 size_t t_size = type->tp_basicsize;
1405 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001406
Guido van Rossum9676b222001-08-17 20:32:36 +00001407 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001408 if (type->tp_itemsize || base->tp_itemsize) {
1409 /* If itemsize is involved, stricter rules */
1410 return t_size != b_size ||
1411 type->tp_itemsize != base->tp_itemsize;
1412 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001413 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
1414 type->tp_weaklistoffset + sizeof(PyObject *) == t_size)
1415 t_size -= sizeof(PyObject *);
1416 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
1417 type->tp_dictoffset + sizeof(PyObject *) == t_size)
1418 t_size -= sizeof(PyObject *);
1419
1420 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001421}
1422
1423static PyTypeObject *
1424solid_base(PyTypeObject *type)
1425{
1426 PyTypeObject *base;
1427
1428 if (type->tp_base)
1429 base = solid_base(type->tp_base);
1430 else
1431 base = &PyBaseObject_Type;
1432 if (extra_ivars(type, base))
1433 return type;
1434 else
1435 return base;
1436}
1437
Jeremy Hylton938ace62002-07-17 16:30:39 +00001438static void object_dealloc(PyObject *);
1439static int object_init(PyObject *, PyObject *, PyObject *);
1440static int update_slot(PyTypeObject *, PyObject *);
1441static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001442
1443static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001444subtype_dict(PyObject *obj, void *context)
1445{
1446 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1447 PyObject *dict;
1448
1449 if (dictptr == NULL) {
1450 PyErr_SetString(PyExc_AttributeError,
1451 "This object has no __dict__");
1452 return NULL;
1453 }
1454 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001455 if (dict == NULL)
1456 *dictptr = dict = PyDict_New();
1457 Py_XINCREF(dict);
1458 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001459}
1460
Guido van Rossum6661be32001-10-26 04:26:12 +00001461static int
1462subtype_setdict(PyObject *obj, PyObject *value, void *context)
1463{
1464 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1465 PyObject *dict;
1466
1467 if (dictptr == NULL) {
1468 PyErr_SetString(PyExc_AttributeError,
1469 "This object has no __dict__");
1470 return -1;
1471 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001472 if (value != NULL && !PyDict_Check(value)) {
Guido van Rossum6661be32001-10-26 04:26:12 +00001473 PyErr_SetString(PyExc_TypeError,
1474 "__dict__ must be set to a dictionary");
1475 return -1;
1476 }
1477 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001478 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001479 *dictptr = value;
1480 Py_XDECREF(dict);
1481 return 0;
1482}
1483
Guido van Rossumad47da02002-08-12 19:05:44 +00001484static PyObject *
1485subtype_getweakref(PyObject *obj, void *context)
1486{
1487 PyObject **weaklistptr;
1488 PyObject *result;
1489
1490 if (obj->ob_type->tp_weaklistoffset == 0) {
1491 PyErr_SetString(PyExc_AttributeError,
1492 "This object has no __weaklist__");
1493 return NULL;
1494 }
1495 assert(obj->ob_type->tp_weaklistoffset > 0);
1496 assert(obj->ob_type->tp_weaklistoffset + sizeof(PyObject *) <=
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001497 (size_t)(obj->ob_type->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001498 weaklistptr = (PyObject **)
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001499 ((char *)obj + obj->ob_type->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001500 if (*weaklistptr == NULL)
1501 result = Py_None;
1502 else
1503 result = *weaklistptr;
1504 Py_INCREF(result);
1505 return result;
1506}
1507
Guido van Rossum373c7412003-01-07 13:41:37 +00001508/* Three variants on the subtype_getsets list. */
1509
1510static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001511 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001512 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001513 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001514 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001515 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001516};
1517
Guido van Rossum373c7412003-01-07 13:41:37 +00001518static PyGetSetDef subtype_getsets_dict_only[] = {
1519 {"__dict__", subtype_dict, subtype_setdict,
1520 PyDoc_STR("dictionary for instance variables (if defined)")},
1521 {0}
1522};
1523
1524static PyGetSetDef subtype_getsets_weakref_only[] = {
1525 {"__weakref__", subtype_getweakref, NULL,
1526 PyDoc_STR("list of weak references to the object (if defined)")},
1527 {0}
1528};
1529
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001530static int
1531valid_identifier(PyObject *s)
1532{
Guido van Rossum03013a02002-07-16 14:30:28 +00001533 unsigned char *p;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001534 Py_ssize_t i, n;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001535
1536 if (!PyString_Check(s)) {
1537 PyErr_SetString(PyExc_TypeError,
1538 "__slots__ must be strings");
1539 return 0;
1540 }
Guido van Rossum03013a02002-07-16 14:30:28 +00001541 p = (unsigned char *) PyString_AS_STRING(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001542 n = PyString_GET_SIZE(s);
1543 /* We must reject an empty name. As a hack, we bump the
1544 length to 1 so that the loop will balk on the trailing \0. */
1545 if (n == 0)
1546 n = 1;
1547 for (i = 0; i < n; i++, p++) {
1548 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1549 PyErr_SetString(PyExc_TypeError,
1550 "__slots__ must be identifiers");
1551 return 0;
1552 }
1553 }
1554 return 1;
1555}
1556
Martin v. Löwisd919a592002-10-14 21:07:28 +00001557#ifdef Py_USING_UNICODE
1558/* Replace Unicode objects in slots. */
1559
1560static PyObject *
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001561_unicode_to_string(PyObject *slots, Py_ssize_t nslots)
Martin v. Löwisd919a592002-10-14 21:07:28 +00001562{
1563 PyObject *tmp = slots;
1564 PyObject *o, *o1;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00001565 Py_ssize_t i;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001566 ssizessizeargfunc copy = slots->ob_type->tp_as_sequence->sq_slice;
Martin v. Löwisd919a592002-10-14 21:07:28 +00001567 for (i = 0; i < nslots; i++) {
1568 if (PyUnicode_Check(o = PyTuple_GET_ITEM(tmp, i))) {
1569 if (tmp == slots) {
1570 tmp = copy(slots, 0, PyTuple_GET_SIZE(slots));
1571 if (tmp == NULL)
1572 return NULL;
1573 }
1574 o1 = _PyUnicode_AsDefaultEncodedString
1575 (o, NULL);
1576 if (o1 == NULL) {
1577 Py_DECREF(tmp);
1578 return 0;
1579 }
1580 Py_INCREF(o1);
1581 Py_DECREF(o);
1582 PyTuple_SET_ITEM(tmp, i, o1);
1583 }
1584 }
1585 return tmp;
1586}
1587#endif
1588
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001589static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001590type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1591{
1592 PyObject *name, *bases, *dict;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001593 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001594 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001595 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001596 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00001597 PyMemberDef *mp;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001598 Py_ssize_t i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00001599 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001600
Tim Peters3abca122001-10-27 19:37:48 +00001601 assert(args != NULL && PyTuple_Check(args));
1602 assert(kwds == NULL || PyDict_Check(kwds));
1603
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001604 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00001605 {
Martin v. Löwis18e16552006-02-15 17:27:45 +00001606 const Py_ssize_t nargs = PyTuple_GET_SIZE(args);
1607 const Py_ssize_t nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
Tim Peters3abca122001-10-27 19:37:48 +00001608
1609 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
1610 PyObject *x = PyTuple_GET_ITEM(args, 0);
1611 Py_INCREF(x->ob_type);
1612 return (PyObject *) x->ob_type;
1613 }
1614
1615 /* SF bug 475327 -- if that didn't trigger, we need 3
1616 arguments. but PyArg_ParseTupleAndKeywords below may give
1617 a msg saying type() needs exactly 3. */
1618 if (nargs + nkwds != 3) {
1619 PyErr_SetString(PyExc_TypeError,
1620 "type() takes 1 or 3 arguments");
1621 return NULL;
1622 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001623 }
1624
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001625 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001626 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
1627 &name,
1628 &PyTuple_Type, &bases,
1629 &PyDict_Type, &dict))
1630 return NULL;
1631
1632 /* Determine the proper metatype to deal with this,
1633 and check for metatype conflicts while we're at it.
1634 Note that if some other metatype wins to contract,
1635 it's possible that its instances are not types. */
1636 nbases = PyTuple_GET_SIZE(bases);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001637 winner = metatype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001638 for (i = 0; i < nbases; i++) {
1639 tmp = PyTuple_GET_ITEM(bases, i);
1640 tmptype = tmp->ob_type;
Tim Petersa91e9642001-11-14 23:32:33 +00001641 if (tmptype == &PyClass_Type)
1642 continue; /* Special case classic classes */
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001643 if (PyType_IsSubtype(winner, tmptype))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001644 continue;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001645 if (PyType_IsSubtype(tmptype, winner)) {
1646 winner = tmptype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001647 continue;
1648 }
1649 PyErr_SetString(PyExc_TypeError,
Guido van Rossum636688d2003-04-23 12:07:22 +00001650 "metaclass conflict: "
1651 "the metaclass of a derived class "
1652 "must be a (non-strict) subclass "
1653 "of the metaclasses of all its bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001654 return NULL;
1655 }
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001656 if (winner != metatype) {
1657 if (winner->tp_new != type_new) /* Pass it to the winner */
1658 return winner->tp_new(winner, args, kwds);
1659 metatype = winner;
1660 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001661
1662 /* Adjust for empty tuple bases */
1663 if (nbases == 0) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001664 bases = PyTuple_Pack(1, &PyBaseObject_Type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001665 if (bases == NULL)
1666 return NULL;
1667 nbases = 1;
1668 }
1669 else
1670 Py_INCREF(bases);
1671
1672 /* XXX From here until type is allocated, "return NULL" leaks bases! */
1673
1674 /* Calculate best base, and check that all bases are type objects */
1675 base = best_base(bases);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001676 if (base == NULL) {
1677 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001678 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001679 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001680 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
1681 PyErr_Format(PyExc_TypeError,
1682 "type '%.100s' is not an acceptable base type",
1683 base->tp_name);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001684 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001685 return NULL;
1686 }
1687
Tim Peters6d6c1a32001-08-02 04:15:00 +00001688 /* Check for a __slots__ sequence variable in dict, and count it */
1689 slots = PyDict_GetItemString(dict, "__slots__");
1690 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00001691 add_dict = 0;
1692 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00001693 may_add_dict = base->tp_dictoffset == 0;
1694 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
1695 if (slots == NULL) {
1696 if (may_add_dict) {
1697 add_dict++;
1698 }
1699 if (may_add_weak) {
1700 add_weak++;
1701 }
1702 }
1703 else {
1704 /* Have slots */
1705
Tim Peters6d6c1a32001-08-02 04:15:00 +00001706 /* Make it into a tuple */
1707 if (PyString_Check(slots))
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001708 slots = PyTuple_Pack(1, slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001709 else
1710 slots = PySequence_Tuple(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001711 if (slots == NULL) {
1712 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001713 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001714 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001715 assert(PyTuple_Check(slots));
1716
1717 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001718 nslots = PyTuple_GET_SIZE(slots);
Jeremy Hylton1c7a0ea2003-07-16 16:08:23 +00001719 if (nslots > 0 && base->tp_itemsize != 0) {
Guido van Rossumc4141872001-08-30 04:43:35 +00001720 PyErr_Format(PyExc_TypeError,
1721 "nonempty __slots__ "
1722 "not supported for subtype of '%s'",
1723 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00001724 bad_slots:
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001725 Py_DECREF(bases);
Guido van Rossumad47da02002-08-12 19:05:44 +00001726 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001727 return NULL;
1728 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001729
Martin v. Löwisd919a592002-10-14 21:07:28 +00001730#ifdef Py_USING_UNICODE
1731 tmp = _unicode_to_string(slots, nslots);
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00001732 if (tmp != slots) {
1733 Py_DECREF(slots);
1734 slots = tmp;
1735 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00001736 if (!tmp)
1737 return NULL;
1738#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00001739 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001740 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001741 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
1742 char *s;
1743 if (!valid_identifier(tmp))
1744 goto bad_slots;
1745 assert(PyString_Check(tmp));
1746 s = PyString_AS_STRING(tmp);
1747 if (strcmp(s, "__dict__") == 0) {
1748 if (!may_add_dict || add_dict) {
1749 PyErr_SetString(PyExc_TypeError,
1750 "__dict__ slot disallowed: "
1751 "we already got one");
1752 goto bad_slots;
1753 }
1754 add_dict++;
1755 }
1756 if (strcmp(s, "__weakref__") == 0) {
1757 if (!may_add_weak || add_weak) {
1758 PyErr_SetString(PyExc_TypeError,
1759 "__weakref__ slot disallowed: "
1760 "either we already got one, "
1761 "or __itemsize__ != 0");
1762 goto bad_slots;
1763 }
1764 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001765 }
1766 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001767
Guido van Rossumad47da02002-08-12 19:05:44 +00001768 /* Copy slots into yet another tuple, demangling names */
1769 newslots = PyTuple_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001770 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00001771 goto bad_slots;
1772 for (i = j = 0; i < nslots; i++) {
1773 char *s;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001774 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001775 s = PyString_AS_STRING(tmp);
1776 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1777 (add_weak && strcmp(s, "__weakref__") == 0))
1778 continue;
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001779 tmp =_Py_Mangle(name, tmp);
1780 if (!tmp)
1781 goto bad_slots;
Guido van Rossumad47da02002-08-12 19:05:44 +00001782 PyTuple_SET_ITEM(newslots, j, tmp);
1783 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001784 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001785 assert(j == nslots - add_dict - add_weak);
1786 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001787 Py_DECREF(slots);
1788 slots = newslots;
1789
Guido van Rossumad47da02002-08-12 19:05:44 +00001790 /* Secondary bases may provide weakrefs or dict */
1791 if (nbases > 1 &&
1792 ((may_add_dict && !add_dict) ||
1793 (may_add_weak && !add_weak))) {
1794 for (i = 0; i < nbases; i++) {
1795 tmp = PyTuple_GET_ITEM(bases, i);
1796 if (tmp == (PyObject *)base)
1797 continue; /* Skip primary base */
1798 if (PyClass_Check(tmp)) {
1799 /* Classic base class provides both */
1800 if (may_add_dict && !add_dict)
1801 add_dict++;
1802 if (may_add_weak && !add_weak)
1803 add_weak++;
1804 break;
1805 }
1806 assert(PyType_Check(tmp));
1807 tmptype = (PyTypeObject *)tmp;
1808 if (may_add_dict && !add_dict &&
1809 tmptype->tp_dictoffset != 0)
1810 add_dict++;
1811 if (may_add_weak && !add_weak &&
1812 tmptype->tp_weaklistoffset != 0)
1813 add_weak++;
1814 if (may_add_dict && !add_dict)
1815 continue;
1816 if (may_add_weak && !add_weak)
1817 continue;
1818 /* Nothing more to check */
1819 break;
1820 }
1821 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001822 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001823
1824 /* XXX From here until type is safely allocated,
1825 "return NULL" may leak slots! */
1826
1827 /* Allocate the type object */
1828 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001829 if (type == NULL) {
1830 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001831 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001832 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001833 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001834
1835 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001836 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001837 Py_INCREF(name);
Georg Brandlc255c7b2006-02-20 22:27:28 +00001838 et->ht_name = name;
1839 et->ht_slots = slots;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001840
Guido van Rossumdc91b992001-08-08 22:26:22 +00001841 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001842 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1843 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001844 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1845 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001846
1847 /* It's a new-style number unless it specifically inherits any
1848 old-style numeric behavior */
1849 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1850 (base->tp_as_number == NULL))
1851 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1852
1853 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001854 type->tp_as_number = &et->as_number;
1855 type->tp_as_sequence = &et->as_sequence;
1856 type->tp_as_mapping = &et->as_mapping;
1857 type->tp_as_buffer = &et->as_buffer;
1858 type->tp_name = PyString_AS_STRING(name);
1859
1860 /* Set tp_base and tp_bases */
1861 type->tp_bases = bases;
1862 Py_INCREF(base);
1863 type->tp_base = base;
1864
Guido van Rossum687ae002001-10-15 22:03:32 +00001865 /* Initialize tp_dict from passed-in dict */
1866 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001867 if (dict == NULL) {
1868 Py_DECREF(type);
1869 return NULL;
1870 }
1871
Guido van Rossumc3542212001-08-16 09:18:56 +00001872 /* Set __module__ in the dict */
1873 if (PyDict_GetItemString(dict, "__module__") == NULL) {
1874 tmp = PyEval_GetGlobals();
1875 if (tmp != NULL) {
1876 tmp = PyDict_GetItemString(tmp, "__name__");
1877 if (tmp != NULL) {
1878 if (PyDict_SetItemString(dict, "__module__",
1879 tmp) < 0)
1880 return NULL;
1881 }
1882 }
1883 }
1884
Tim Peters2f93e282001-10-04 05:27:00 +00001885 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00001886 and is a string. The __doc__ accessor will first look for tp_doc;
1887 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00001888 */
1889 {
1890 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
1891 if (doc != NULL && PyString_Check(doc)) {
1892 const size_t n = (size_t)PyString_GET_SIZE(doc);
Anthony Baxtera6286212006-04-11 07:42:36 +00001893 char *tp_doc = (char *)PyObject_MALLOC(n+1);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001894 if (tp_doc == NULL) {
Tim Peters2f93e282001-10-04 05:27:00 +00001895 Py_DECREF(type);
1896 return NULL;
1897 }
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001898 memcpy(tp_doc, PyString_AS_STRING(doc), n+1);
1899 type->tp_doc = tp_doc;
Tim Peters2f93e282001-10-04 05:27:00 +00001900 }
1901 }
1902
Tim Peters6d6c1a32001-08-02 04:15:00 +00001903 /* Special-case __new__: if it's a plain function,
1904 make it a static function */
1905 tmp = PyDict_GetItemString(dict, "__new__");
1906 if (tmp != NULL && PyFunction_Check(tmp)) {
1907 tmp = PyStaticMethod_New(tmp);
1908 if (tmp == NULL) {
1909 Py_DECREF(type);
1910 return NULL;
1911 }
1912 PyDict_SetItemString(dict, "__new__", tmp);
1913 Py_DECREF(tmp);
1914 }
1915
1916 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001917 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00001918 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001919 if (slots != NULL) {
1920 for (i = 0; i < nslots; i++, mp++) {
1921 mp->name = PyString_AS_STRING(
1922 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00001923 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001924 mp->offset = slotoffset;
Guido van Rossum9676b222001-08-17 20:32:36 +00001925 if (base->tp_weaklistoffset == 0 &&
Guido van Rossum64b206c2001-12-04 17:13:22 +00001926 strcmp(mp->name, "__weakref__") == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001927 add_weak++;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001928 mp->type = T_OBJECT;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001929 mp->flags = READONLY;
Guido van Rossum9676b222001-08-17 20:32:36 +00001930 type->tp_weaklistoffset = slotoffset;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001931 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001932 slotoffset += sizeof(PyObject *);
1933 }
1934 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001935 if (add_dict) {
1936 if (base->tp_itemsize)
1937 type->tp_dictoffset = -(long)sizeof(PyObject *);
1938 else
1939 type->tp_dictoffset = slotoffset;
1940 slotoffset += sizeof(PyObject *);
1941 }
1942 if (add_weak) {
1943 assert(!base->tp_itemsize);
1944 type->tp_weaklistoffset = slotoffset;
1945 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001946 }
1947 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001948 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001949 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00001950
1951 if (type->tp_weaklistoffset && type->tp_dictoffset)
1952 type->tp_getset = subtype_getsets_full;
1953 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
1954 type->tp_getset = subtype_getsets_weakref_only;
1955 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
1956 type->tp_getset = subtype_getsets_dict_only;
1957 else
1958 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001959
1960 /* Special case some slots */
1961 if (type->tp_dictoffset != 0 || nslots > 0) {
1962 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
1963 type->tp_getattro = PyObject_GenericGetAttr;
1964 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
1965 type->tp_setattro = PyObject_GenericSetAttr;
1966 }
1967 type->tp_dealloc = subtype_dealloc;
1968
Guido van Rossum9475a232001-10-05 20:51:39 +00001969 /* Enable GC unless there are really no instance variables possible */
1970 if (!(type->tp_basicsize == sizeof(PyObject) &&
1971 type->tp_itemsize == 0))
1972 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
1973
Tim Peters6d6c1a32001-08-02 04:15:00 +00001974 /* Always override allocation strategy to use regular heap */
1975 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00001976 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001977 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00001978 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001979 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00001980 }
1981 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001982 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001983
1984 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001985 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001986 Py_DECREF(type);
1987 return NULL;
1988 }
1989
Guido van Rossum7b9144b2001-10-09 19:39:46 +00001990 /* Put the proper slots in place */
1991 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00001992
Tim Peters6d6c1a32001-08-02 04:15:00 +00001993 return (PyObject *)type;
1994}
1995
1996/* Internal API to look for a name through the MRO.
1997 This returns a borrowed reference, and doesn't set an exception! */
1998PyObject *
1999_PyType_Lookup(PyTypeObject *type, PyObject *name)
2000{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002001 Py_ssize_t i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00002002 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002003
Guido van Rossum687ae002001-10-15 22:03:32 +00002004 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002005 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00002006
2007 /* If mro is NULL, the type is either not yet initialized
2008 by PyType_Ready(), or already cleared by type_clear().
2009 Either way the safest thing to do is to return NULL. */
2010 if (mro == NULL)
2011 return NULL;
2012
Tim Peters6d6c1a32001-08-02 04:15:00 +00002013 assert(PyTuple_Check(mro));
2014 n = PyTuple_GET_SIZE(mro);
2015 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00002016 base = PyTuple_GET_ITEM(mro, i);
2017 if (PyClass_Check(base))
2018 dict = ((PyClassObject *)base)->cl_dict;
2019 else {
2020 assert(PyType_Check(base));
2021 dict = ((PyTypeObject *)base)->tp_dict;
2022 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002023 assert(dict && PyDict_Check(dict));
2024 res = PyDict_GetItem(dict, name);
2025 if (res != NULL)
2026 return res;
2027 }
2028 return NULL;
2029}
2030
2031/* This is similar to PyObject_GenericGetAttr(),
2032 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
2033static PyObject *
2034type_getattro(PyTypeObject *type, PyObject *name)
2035{
2036 PyTypeObject *metatype = type->ob_type;
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002037 PyObject *meta_attribute, *attribute;
2038 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002039
2040 /* Initialize this type (we'll assume the metatype is initialized) */
2041 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002042 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002043 return NULL;
2044 }
2045
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002046 /* No readable descriptor found yet */
2047 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002048
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002049 /* Look for the attribute in the metatype */
2050 meta_attribute = _PyType_Lookup(metatype, name);
2051
2052 if (meta_attribute != NULL) {
2053 meta_get = meta_attribute->ob_type->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002054
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002055 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2056 /* Data descriptors implement tp_descr_set to intercept
2057 * writes. Assume the attribute is not overridden in
2058 * type's tp_dict (and bases): call the descriptor now.
2059 */
2060 return meta_get(meta_attribute, (PyObject *)type,
2061 (PyObject *)metatype);
2062 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002063 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002064 }
2065
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002066 /* No data descriptor found on metatype. Look in tp_dict of this
2067 * type and its bases */
2068 attribute = _PyType_Lookup(type, name);
2069 if (attribute != NULL) {
2070 /* Implement descriptor functionality, if any */
2071 descrgetfunc local_get = attribute->ob_type->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002072
2073 Py_XDECREF(meta_attribute);
2074
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002075 if (local_get != NULL) {
2076 /* NULL 2nd argument indicates the descriptor was
2077 * found on the target object itself (or a base) */
2078 return local_get(attribute, (PyObject *)NULL,
2079 (PyObject *)type);
2080 }
Tim Peters34592512002-07-11 06:23:50 +00002081
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002082 Py_INCREF(attribute);
2083 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002084 }
2085
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002086 /* No attribute found in local __dict__ (or bases): use the
2087 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002088 if (meta_get != NULL) {
2089 PyObject *res;
2090 res = meta_get(meta_attribute, (PyObject *)type,
2091 (PyObject *)metatype);
2092 Py_DECREF(meta_attribute);
2093 return res;
2094 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002095
2096 /* If an ordinary attribute was found on the metatype, return it now */
2097 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002098 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002099 }
2100
2101 /* Give up */
2102 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002103 "type object '%.50s' has no attribute '%.400s'",
2104 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002105 return NULL;
2106}
2107
2108static int
2109type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2110{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002111 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2112 PyErr_Format(
2113 PyExc_TypeError,
2114 "can't set attributes of built-in/extension type '%s'",
2115 type->tp_name);
2116 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002117 }
Guido van Rossum8d24ee92003-03-24 23:49:49 +00002118 /* XXX Example of how I expect this to be used...
2119 if (update_subclasses(type, name, invalidate_cache, NULL) < 0)
2120 return -1;
2121 */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002122 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2123 return -1;
2124 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002125}
2126
2127static void
2128type_dealloc(PyTypeObject *type)
2129{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002130 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002131
2132 /* Assert this is a heap-allocated type object */
2133 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002134 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002135 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002136 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002137 Py_XDECREF(type->tp_base);
2138 Py_XDECREF(type->tp_dict);
2139 Py_XDECREF(type->tp_bases);
2140 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002141 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002142 Py_XDECREF(type->tp_subclasses);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002143 /* A type's tp_doc is heap allocated, unlike the tp_doc slots
2144 * of most other objects. It's okay to cast it to char *.
2145 */
2146 PyObject_Free((char *)type->tp_doc);
Georg Brandlc255c7b2006-02-20 22:27:28 +00002147 Py_XDECREF(et->ht_name);
2148 Py_XDECREF(et->ht_slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002149 type->ob_type->tp_free((PyObject *)type);
2150}
2151
Guido van Rossum1c450732001-10-08 15:18:27 +00002152static PyObject *
2153type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2154{
2155 PyObject *list, *raw, *ref;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002156 Py_ssize_t i, n;
Guido van Rossum1c450732001-10-08 15:18:27 +00002157
2158 list = PyList_New(0);
2159 if (list == NULL)
2160 return NULL;
2161 raw = type->tp_subclasses;
2162 if (raw == NULL)
2163 return list;
2164 assert(PyList_Check(raw));
2165 n = PyList_GET_SIZE(raw);
2166 for (i = 0; i < n; i++) {
2167 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002168 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002169 ref = PyWeakref_GET_OBJECT(ref);
2170 if (ref != Py_None) {
2171 if (PyList_Append(list, ref) < 0) {
2172 Py_DECREF(list);
2173 return NULL;
2174 }
2175 }
2176 }
2177 return list;
2178}
2179
Tim Peters6d6c1a32001-08-02 04:15:00 +00002180static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002181 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002182 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002183 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002184 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002185 {0}
2186};
2187
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002188PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002189"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002190"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002191
Guido van Rossum048eb752001-10-02 21:24:57 +00002192static int
2193type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2194{
Guido van Rossuma3862092002-06-10 15:24:42 +00002195 /* Because of type_is_gc(), the collector only calls this
2196 for heaptypes. */
2197 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002198
Thomas Woutersc6e55062006-04-15 21:47:09 +00002199 Py_VISIT(type->tp_dict);
2200 Py_VISIT(type->tp_cache);
2201 Py_VISIT(type->tp_mro);
2202 Py_VISIT(type->tp_bases);
2203 Py_VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002204
2205 /* There's no need to visit type->tp_subclasses or
Georg Brandlc255c7b2006-02-20 22:27:28 +00002206 ((PyHeapTypeObject *)type)->ht_slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002207 in cycles; tp_subclasses is a list of weak references,
2208 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002209
Guido van Rossum048eb752001-10-02 21:24:57 +00002210 return 0;
2211}
2212
2213static int
2214type_clear(PyTypeObject *type)
2215{
Guido van Rossum048eb752001-10-02 21:24:57 +00002216 PyObject *tmp;
2217
Guido van Rossuma3862092002-06-10 15:24:42 +00002218 /* Because of type_is_gc(), the collector only calls this
2219 for heaptypes. */
2220 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002221
Guido van Rossuma3862092002-06-10 15:24:42 +00002222 /* The only field we need to clear is tp_mro, which is part of a
2223 hard cycle (its first element is the class itself) that won't
2224 be broken otherwise (it's a tuple and tuples don't have a
2225 tp_clear handler). None of the other fields need to be
2226 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002227
Guido van Rossuma3862092002-06-10 15:24:42 +00002228 tp_dict:
2229 It is a dict, so the collector will call its tp_clear.
2230
2231 tp_cache:
2232 Not used; if it were, it would be a dict.
2233
2234 tp_bases, tp_base:
2235 If these are involved in a cycle, there must be at least
2236 one other, mutable object in the cycle, e.g. a base
2237 class's dict; the cycle will be broken that way.
2238
2239 tp_subclasses:
2240 A list of weak references can't be part of a cycle; and
2241 lists have their own tp_clear.
2242
Guido van Rossume5c691a2003-03-07 15:13:17 +00002243 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002244 A tuple of strings can't be part of a cycle.
2245 */
2246
Thomas Woutersedf17d82006-04-15 17:28:34 +00002247 Py_CLEAR(type->tp_mro);
Guido van Rossum048eb752001-10-02 21:24:57 +00002248
2249 return 0;
2250}
2251
2252static int
2253type_is_gc(PyTypeObject *type)
2254{
2255 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2256}
2257
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002258PyTypeObject PyType_Type = {
2259 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002260 0, /* ob_size */
2261 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002262 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002263 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002264 (destructor)type_dealloc, /* tp_dealloc */
2265 0, /* tp_print */
2266 0, /* tp_getattr */
2267 0, /* tp_setattr */
2268 type_compare, /* tp_compare */
2269 (reprfunc)type_repr, /* tp_repr */
2270 0, /* tp_as_number */
2271 0, /* tp_as_sequence */
2272 0, /* tp_as_mapping */
2273 (hashfunc)_Py_HashPointer, /* tp_hash */
2274 (ternaryfunc)type_call, /* tp_call */
2275 0, /* tp_str */
2276 (getattrofunc)type_getattro, /* tp_getattro */
2277 (setattrofunc)type_setattro, /* tp_setattro */
2278 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002279 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
2280 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002281 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002282 (traverseproc)type_traverse, /* tp_traverse */
2283 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002284 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002285 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002286 0, /* tp_iter */
2287 0, /* tp_iternext */
2288 type_methods, /* tp_methods */
2289 type_members, /* tp_members */
2290 type_getsets, /* tp_getset */
2291 0, /* tp_base */
2292 0, /* tp_dict */
2293 0, /* tp_descr_get */
2294 0, /* tp_descr_set */
2295 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
2296 0, /* tp_init */
2297 0, /* tp_alloc */
2298 type_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002299 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002300 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002301};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002302
2303
2304/* The base type of all types (eventually)... except itself. */
2305
2306static int
2307object_init(PyObject *self, PyObject *args, PyObject *kwds)
2308{
2309 return 0;
2310}
2311
Guido van Rossum298e4212003-02-13 16:30:16 +00002312/* If we don't have a tp_new for a new-style class, new will use this one.
2313 Therefore this should take no arguments/keywords. However, this new may
2314 also be inherited by objects that define a tp_init but no tp_new. These
2315 objects WILL pass argumets to tp_new, because it gets the same args as
2316 tp_init. So only allow arguments if we aren't using the default init, in
2317 which case we expect init to handle argument parsing. */
2318static PyObject *
2319object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2320{
2321 if (type->tp_init == object_init && (PyTuple_GET_SIZE(args) ||
2322 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds)))) {
2323 PyErr_SetString(PyExc_TypeError,
2324 "default __new__ takes no parameters");
2325 return NULL;
2326 }
2327 return type->tp_alloc(type, 0);
2328}
2329
Tim Peters6d6c1a32001-08-02 04:15:00 +00002330static void
2331object_dealloc(PyObject *self)
2332{
2333 self->ob_type->tp_free(self);
2334}
2335
Guido van Rossum8e248182001-08-12 05:17:56 +00002336static PyObject *
2337object_repr(PyObject *self)
2338{
Guido van Rossum76e69632001-08-16 18:52:43 +00002339 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002340 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002341
Guido van Rossum76e69632001-08-16 18:52:43 +00002342 type = self->ob_type;
2343 mod = type_module(type, NULL);
2344 if (mod == NULL)
2345 PyErr_Clear();
2346 else if (!PyString_Check(mod)) {
2347 Py_DECREF(mod);
2348 mod = NULL;
2349 }
2350 name = type_name(type, NULL);
2351 if (name == NULL)
2352 return NULL;
2353 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002354 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002355 PyString_AS_STRING(mod),
2356 PyString_AS_STRING(name),
2357 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002358 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002359 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002360 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002361 Py_XDECREF(mod);
2362 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002363 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002364}
2365
Guido van Rossumb8f63662001-08-15 23:57:02 +00002366static PyObject *
2367object_str(PyObject *self)
2368{
2369 unaryfunc f;
2370
2371 f = self->ob_type->tp_repr;
2372 if (f == NULL)
2373 f = object_repr;
2374 return f(self);
2375}
2376
Guido van Rossum8e248182001-08-12 05:17:56 +00002377static long
2378object_hash(PyObject *self)
2379{
2380 return _Py_HashPointer(self);
2381}
Guido van Rossum8e248182001-08-12 05:17:56 +00002382
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002383static PyObject *
2384object_get_class(PyObject *self, void *closure)
2385{
2386 Py_INCREF(self->ob_type);
2387 return (PyObject *)(self->ob_type);
2388}
2389
2390static int
2391equiv_structs(PyTypeObject *a, PyTypeObject *b)
2392{
2393 return a == b ||
2394 (a != NULL &&
2395 b != NULL &&
2396 a->tp_basicsize == b->tp_basicsize &&
2397 a->tp_itemsize == b->tp_itemsize &&
2398 a->tp_dictoffset == b->tp_dictoffset &&
2399 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2400 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2401 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2402}
2403
2404static int
2405same_slots_added(PyTypeObject *a, PyTypeObject *b)
2406{
2407 PyTypeObject *base = a->tp_base;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002408 Py_ssize_t size;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002409
2410 if (base != b->tp_base)
2411 return 0;
2412 if (equiv_structs(a, base) && equiv_structs(b, base))
2413 return 1;
2414 size = base->tp_basicsize;
2415 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2416 size += sizeof(PyObject *);
2417 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2418 size += sizeof(PyObject *);
2419 return size == a->tp_basicsize && size == b->tp_basicsize;
2420}
2421
2422static int
Anthony Baxtera6286212006-04-11 07:42:36 +00002423compatible_for_assignment(PyTypeObject* oldto, PyTypeObject* newto, char* attr)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002424{
2425 PyTypeObject *newbase, *oldbase;
2426
Anthony Baxtera6286212006-04-11 07:42:36 +00002427 if (newto->tp_dealloc != oldto->tp_dealloc ||
2428 newto->tp_free != oldto->tp_free)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002429 {
2430 PyErr_Format(PyExc_TypeError,
2431 "%s assignment: "
2432 "'%s' deallocator differs from '%s'",
2433 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002434 newto->tp_name,
2435 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002436 return 0;
2437 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002438 newbase = newto;
2439 oldbase = oldto;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002440 while (equiv_structs(newbase, newbase->tp_base))
2441 newbase = newbase->tp_base;
2442 while (equiv_structs(oldbase, oldbase->tp_base))
2443 oldbase = oldbase->tp_base;
2444 if (newbase != oldbase &&
2445 (newbase->tp_base != oldbase->tp_base ||
2446 !same_slots_added(newbase, oldbase))) {
2447 PyErr_Format(PyExc_TypeError,
2448 "%s assignment: "
2449 "'%s' object layout differs from '%s'",
2450 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002451 newto->tp_name,
2452 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002453 return 0;
2454 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002455
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002456 return 1;
2457}
2458
2459static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002460object_set_class(PyObject *self, PyObject *value, void *closure)
2461{
Anthony Baxtera6286212006-04-11 07:42:36 +00002462 PyTypeObject *oldto = self->ob_type;
2463 PyTypeObject *newto;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002464
Guido van Rossumb6b89422002-04-15 01:03:30 +00002465 if (value == NULL) {
2466 PyErr_SetString(PyExc_TypeError,
2467 "can't delete __class__ attribute");
2468 return -1;
2469 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002470 if (!PyType_Check(value)) {
2471 PyErr_Format(PyExc_TypeError,
2472 "__class__ must be set to new-style class, not '%s' object",
2473 value->ob_type->tp_name);
2474 return -1;
2475 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002476 newto = (PyTypeObject *)value;
2477 if (!(newto->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2478 !(oldto->tp_flags & Py_TPFLAGS_HEAPTYPE))
Guido van Rossum40af8892002-08-10 05:42:07 +00002479 {
2480 PyErr_Format(PyExc_TypeError,
2481 "__class__ assignment: only for heap types");
2482 return -1;
2483 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002484 if (compatible_for_assignment(newto, oldto, "__class__")) {
2485 Py_INCREF(newto);
2486 self->ob_type = newto;
2487 Py_DECREF(oldto);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002488 return 0;
2489 }
2490 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002491 return -1;
2492 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002493}
2494
2495static PyGetSetDef object_getsets[] = {
2496 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002497 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002498 {0}
2499};
2500
Guido van Rossumc53f0092003-02-18 22:05:12 +00002501
Guido van Rossum036f9992003-02-21 22:02:54 +00002502/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2503 We fall back to helpers in copy_reg for:
2504 - pickle protocols < 2
2505 - calculating the list of slot names (done only once per class)
2506 - the __newobj__ function (which is used as a token but never called)
2507*/
2508
2509static PyObject *
2510import_copy_reg(void)
2511{
2512 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002513
2514 if (!copy_reg_str) {
2515 copy_reg_str = PyString_InternFromString("copy_reg");
2516 if (copy_reg_str == NULL)
2517 return NULL;
2518 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002519
2520 return PyImport_Import(copy_reg_str);
2521}
2522
2523static PyObject *
2524slotnames(PyObject *cls)
2525{
2526 PyObject *clsdict;
2527 PyObject *copy_reg;
2528 PyObject *slotnames;
2529
2530 if (!PyType_Check(cls)) {
2531 Py_INCREF(Py_None);
2532 return Py_None;
2533 }
2534
2535 clsdict = ((PyTypeObject *)cls)->tp_dict;
2536 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
Armin Rigoec862b92005-09-24 22:58:41 +00002537 if (slotnames != NULL && PyList_Check(slotnames)) {
Guido van Rossum036f9992003-02-21 22:02:54 +00002538 Py_INCREF(slotnames);
2539 return slotnames;
2540 }
2541
2542 copy_reg = import_copy_reg();
2543 if (copy_reg == NULL)
2544 return NULL;
2545
2546 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2547 Py_DECREF(copy_reg);
2548 if (slotnames != NULL &&
2549 slotnames != Py_None &&
2550 !PyList_Check(slotnames))
2551 {
2552 PyErr_SetString(PyExc_TypeError,
2553 "copy_reg._slotnames didn't return a list or None");
2554 Py_DECREF(slotnames);
2555 slotnames = NULL;
2556 }
2557
2558 return slotnames;
2559}
2560
2561static PyObject *
2562reduce_2(PyObject *obj)
2563{
2564 PyObject *cls, *getnewargs;
2565 PyObject *args = NULL, *args2 = NULL;
2566 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2567 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2568 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002569 Py_ssize_t i, n;
Guido van Rossum036f9992003-02-21 22:02:54 +00002570
2571 cls = PyObject_GetAttrString(obj, "__class__");
2572 if (cls == NULL)
2573 return NULL;
2574
2575 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2576 if (getnewargs != NULL) {
2577 args = PyObject_CallObject(getnewargs, NULL);
2578 Py_DECREF(getnewargs);
2579 if (args != NULL && !PyTuple_Check(args)) {
2580 PyErr_SetString(PyExc_TypeError,
2581 "__getnewargs__ should return a tuple");
2582 goto end;
2583 }
2584 }
2585 else {
2586 PyErr_Clear();
2587 args = PyTuple_New(0);
2588 }
2589 if (args == NULL)
2590 goto end;
2591
2592 getstate = PyObject_GetAttrString(obj, "__getstate__");
2593 if (getstate != NULL) {
2594 state = PyObject_CallObject(getstate, NULL);
2595 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00002596 if (state == NULL)
2597 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00002598 }
2599 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00002600 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00002601 state = PyObject_GetAttrString(obj, "__dict__");
2602 if (state == NULL) {
2603 PyErr_Clear();
2604 state = Py_None;
2605 Py_INCREF(state);
2606 }
2607 names = slotnames(cls);
2608 if (names == NULL)
2609 goto end;
2610 if (names != Py_None) {
2611 assert(PyList_Check(names));
2612 slots = PyDict_New();
2613 if (slots == NULL)
2614 goto end;
2615 n = 0;
2616 /* Can't pre-compute the list size; the list
2617 is stored on the class so accessible to other
2618 threads, which may be run by DECREF */
2619 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2620 PyObject *name, *value;
2621 name = PyList_GET_ITEM(names, i);
2622 value = PyObject_GetAttr(obj, name);
2623 if (value == NULL)
2624 PyErr_Clear();
2625 else {
2626 int err = PyDict_SetItem(slots, name,
2627 value);
2628 Py_DECREF(value);
2629 if (err)
2630 goto end;
2631 n++;
2632 }
2633 }
2634 if (n) {
2635 state = Py_BuildValue("(NO)", state, slots);
2636 if (state == NULL)
2637 goto end;
2638 }
2639 }
2640 }
2641
2642 if (!PyList_Check(obj)) {
2643 listitems = Py_None;
2644 Py_INCREF(listitems);
2645 }
2646 else {
2647 listitems = PyObject_GetIter(obj);
2648 if (listitems == NULL)
2649 goto end;
2650 }
2651
2652 if (!PyDict_Check(obj)) {
2653 dictitems = Py_None;
2654 Py_INCREF(dictitems);
2655 }
2656 else {
2657 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2658 if (dictitems == NULL)
2659 goto end;
2660 }
2661
2662 copy_reg = import_copy_reg();
2663 if (copy_reg == NULL)
2664 goto end;
2665 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2666 if (newobj == NULL)
2667 goto end;
2668
2669 n = PyTuple_GET_SIZE(args);
2670 args2 = PyTuple_New(n+1);
2671 if (args2 == NULL)
2672 goto end;
2673 PyTuple_SET_ITEM(args2, 0, cls);
2674 cls = NULL;
2675 for (i = 0; i < n; i++) {
2676 PyObject *v = PyTuple_GET_ITEM(args, i);
2677 Py_INCREF(v);
2678 PyTuple_SET_ITEM(args2, i+1, v);
2679 }
2680
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002681 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00002682
2683 end:
2684 Py_XDECREF(cls);
2685 Py_XDECREF(args);
2686 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002687 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002688 Py_XDECREF(state);
2689 Py_XDECREF(names);
2690 Py_XDECREF(listitems);
2691 Py_XDECREF(dictitems);
2692 Py_XDECREF(copy_reg);
2693 Py_XDECREF(newobj);
2694 return res;
2695}
2696
2697static PyObject *
2698object_reduce_ex(PyObject *self, PyObject *args)
2699{
2700 /* Call copy_reg._reduce_ex(self, proto) */
2701 PyObject *reduce, *copy_reg, *res;
2702 int proto = 0;
2703
2704 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2705 return NULL;
2706
2707 reduce = PyObject_GetAttrString(self, "__reduce__");
2708 if (reduce == NULL)
2709 PyErr_Clear();
2710 else {
2711 PyObject *cls, *clsreduce, *objreduce;
2712 int override;
2713 cls = PyObject_GetAttrString(self, "__class__");
2714 if (cls == NULL) {
2715 Py_DECREF(reduce);
2716 return NULL;
2717 }
2718 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2719 Py_DECREF(cls);
2720 if (clsreduce == NULL) {
2721 Py_DECREF(reduce);
2722 return NULL;
2723 }
2724 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2725 "__reduce__");
2726 override = (clsreduce != objreduce);
2727 Py_DECREF(clsreduce);
2728 if (override) {
2729 res = PyObject_CallObject(reduce, NULL);
2730 Py_DECREF(reduce);
2731 return res;
2732 }
2733 else
2734 Py_DECREF(reduce);
2735 }
2736
2737 if (proto >= 2)
2738 return reduce_2(self);
2739
2740 copy_reg = import_copy_reg();
Guido van Rossum3926a632001-09-25 16:25:58 +00002741 if (!copy_reg)
2742 return NULL;
Guido van Rossum036f9992003-02-21 22:02:54 +00002743
Guido van Rossumc53f0092003-02-18 22:05:12 +00002744 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00002745 Py_DECREF(copy_reg);
Guido van Rossum036f9992003-02-21 22:02:54 +00002746
Guido van Rossum3926a632001-09-25 16:25:58 +00002747 return res;
2748}
2749
2750static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00002751 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
2752 PyDoc_STR("helper for pickle")},
2753 {"__reduce__", object_reduce_ex, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002754 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00002755 {0}
2756};
2757
Guido van Rossum036f9992003-02-21 22:02:54 +00002758
Tim Peters6d6c1a32001-08-02 04:15:00 +00002759PyTypeObject PyBaseObject_Type = {
2760 PyObject_HEAD_INIT(&PyType_Type)
2761 0, /* ob_size */
2762 "object", /* tp_name */
2763 sizeof(PyObject), /* tp_basicsize */
2764 0, /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00002765 object_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002766 0, /* tp_print */
2767 0, /* tp_getattr */
2768 0, /* tp_setattr */
2769 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002770 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002771 0, /* tp_as_number */
2772 0, /* tp_as_sequence */
2773 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002774 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002775 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002776 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002777 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002778 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002779 0, /* tp_as_buffer */
2780 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002781 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002782 0, /* tp_traverse */
2783 0, /* tp_clear */
2784 0, /* tp_richcompare */
2785 0, /* tp_weaklistoffset */
2786 0, /* tp_iter */
2787 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00002788 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002789 0, /* tp_members */
2790 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002791 0, /* tp_base */
2792 0, /* tp_dict */
2793 0, /* tp_descr_get */
2794 0, /* tp_descr_set */
2795 0, /* tp_dictoffset */
2796 object_init, /* tp_init */
2797 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00002798 object_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002799 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002800};
2801
2802
2803/* Initialize the __dict__ in a type object */
2804
2805static int
2806add_methods(PyTypeObject *type, PyMethodDef *meth)
2807{
Guido van Rossum687ae002001-10-15 22:03:32 +00002808 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002809
2810 for (; meth->ml_name != NULL; meth++) {
2811 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002812 if (PyDict_GetItemString(dict, meth->ml_name) &&
2813 !(meth->ml_flags & METH_COEXIST))
2814 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002815 if (meth->ml_flags & METH_CLASS) {
2816 if (meth->ml_flags & METH_STATIC) {
2817 PyErr_SetString(PyExc_ValueError,
2818 "method cannot be both class and static");
2819 return -1;
2820 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002821 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002822 }
2823 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002824 PyObject *cfunc = PyCFunction_New(meth, NULL);
2825 if (cfunc == NULL)
2826 return -1;
2827 descr = PyStaticMethod_New(cfunc);
2828 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002829 }
2830 else {
2831 descr = PyDescr_NewMethod(type, meth);
2832 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002833 if (descr == NULL)
2834 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002835 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002836 return -1;
2837 Py_DECREF(descr);
2838 }
2839 return 0;
2840}
2841
2842static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002843add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002844{
Guido van Rossum687ae002001-10-15 22:03:32 +00002845 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002846
2847 for (; memb->name != NULL; memb++) {
2848 PyObject *descr;
2849 if (PyDict_GetItemString(dict, memb->name))
2850 continue;
2851 descr = PyDescr_NewMember(type, memb);
2852 if (descr == NULL)
2853 return -1;
2854 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2855 return -1;
2856 Py_DECREF(descr);
2857 }
2858 return 0;
2859}
2860
2861static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002862add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002863{
Guido van Rossum687ae002001-10-15 22:03:32 +00002864 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002865
2866 for (; gsp->name != NULL; gsp++) {
2867 PyObject *descr;
2868 if (PyDict_GetItemString(dict, gsp->name))
2869 continue;
2870 descr = PyDescr_NewGetSet(type, gsp);
2871
2872 if (descr == NULL)
2873 return -1;
2874 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2875 return -1;
2876 Py_DECREF(descr);
2877 }
2878 return 0;
2879}
2880
Guido van Rossum13d52f02001-08-10 21:24:08 +00002881static void
2882inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002883{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002884 Py_ssize_t oldsize, newsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002885
Guido van Rossum13d52f02001-08-10 21:24:08 +00002886 /* Special flag magic */
2887 if (!type->tp_as_buffer && base->tp_as_buffer) {
2888 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2889 type->tp_flags |=
2890 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2891 }
2892 if (!type->tp_as_sequence && base->tp_as_sequence) {
2893 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2894 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2895 }
2896 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2897 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2898 if ((!type->tp_as_number && base->tp_as_number) ||
2899 (!type->tp_as_sequence && base->tp_as_sequence)) {
2900 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2901 if (!type->tp_as_number && !type->tp_as_sequence) {
2902 type->tp_flags |= base->tp_flags &
2903 Py_TPFLAGS_HAVE_INPLACEOPS;
2904 }
2905 }
2906 /* Wow */
2907 }
2908 if (!type->tp_as_number && base->tp_as_number) {
2909 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2910 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2911 }
2912
2913 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002914 oldsize = base->tp_basicsize;
2915 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2916 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2917 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002918 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2919 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002920 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002921 if (type->tp_traverse == NULL)
2922 type->tp_traverse = base->tp_traverse;
2923 if (type->tp_clear == NULL)
2924 type->tp_clear = base->tp_clear;
2925 }
2926 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002927 /* The condition below could use some explanation.
2928 It appears that tp_new is not inherited for static types
2929 whose base class is 'object'; this seems to be a precaution
2930 so that old extension types don't suddenly become
2931 callable (object.__new__ wouldn't insure the invariants
2932 that the extension type's own factory function ensures).
2933 Heap types, of course, are under our control, so they do
2934 inherit tp_new; static extension types that specify some
2935 other built-in type as the default are considered
2936 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002937 if (base != &PyBaseObject_Type ||
2938 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2939 if (type->tp_new == NULL)
2940 type->tp_new = base->tp_new;
2941 }
2942 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002943 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002944
2945 /* Copy other non-function slots */
2946
2947#undef COPYVAL
2948#define COPYVAL(SLOT) \
2949 if (type->SLOT == 0) type->SLOT = base->SLOT
2950
2951 COPYVAL(tp_itemsize);
2952 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2953 COPYVAL(tp_weaklistoffset);
2954 }
2955 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2956 COPYVAL(tp_dictoffset);
2957 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002958}
2959
2960static void
2961inherit_slots(PyTypeObject *type, PyTypeObject *base)
2962{
2963 PyTypeObject *basebase;
2964
2965#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002966#undef COPYSLOT
2967#undef COPYNUM
2968#undef COPYSEQ
2969#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002970#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002971
2972#define SLOTDEFINED(SLOT) \
2973 (base->SLOT != 0 && \
2974 (basebase == NULL || base->SLOT != basebase->SLOT))
2975
Tim Peters6d6c1a32001-08-02 04:15:00 +00002976#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002977 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002978
2979#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2980#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2981#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002982#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002983
Guido van Rossum13d52f02001-08-10 21:24:08 +00002984 /* This won't inherit indirect slots (from tp_as_number etc.)
2985 if type doesn't provide the space. */
2986
2987 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2988 basebase = base->tp_base;
2989 if (basebase->tp_as_number == NULL)
2990 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002991 COPYNUM(nb_add);
2992 COPYNUM(nb_subtract);
2993 COPYNUM(nb_multiply);
2994 COPYNUM(nb_divide);
2995 COPYNUM(nb_remainder);
2996 COPYNUM(nb_divmod);
2997 COPYNUM(nb_power);
2998 COPYNUM(nb_negative);
2999 COPYNUM(nb_positive);
3000 COPYNUM(nb_absolute);
3001 COPYNUM(nb_nonzero);
3002 COPYNUM(nb_invert);
3003 COPYNUM(nb_lshift);
3004 COPYNUM(nb_rshift);
3005 COPYNUM(nb_and);
3006 COPYNUM(nb_xor);
3007 COPYNUM(nb_or);
3008 COPYNUM(nb_coerce);
3009 COPYNUM(nb_int);
3010 COPYNUM(nb_long);
3011 COPYNUM(nb_float);
3012 COPYNUM(nb_oct);
3013 COPYNUM(nb_hex);
3014 COPYNUM(nb_inplace_add);
3015 COPYNUM(nb_inplace_subtract);
3016 COPYNUM(nb_inplace_multiply);
3017 COPYNUM(nb_inplace_divide);
3018 COPYNUM(nb_inplace_remainder);
3019 COPYNUM(nb_inplace_power);
3020 COPYNUM(nb_inplace_lshift);
3021 COPYNUM(nb_inplace_rshift);
3022 COPYNUM(nb_inplace_and);
3023 COPYNUM(nb_inplace_xor);
3024 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003025 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3026 COPYNUM(nb_true_divide);
3027 COPYNUM(nb_floor_divide);
3028 COPYNUM(nb_inplace_true_divide);
3029 COPYNUM(nb_inplace_floor_divide);
3030 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00003031 if (base->tp_flags & Py_TPFLAGS_HAVE_INDEX) {
3032 COPYNUM(nb_index);
3033 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003034 }
3035
Guido van Rossum13d52f02001-08-10 21:24:08 +00003036 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3037 basebase = base->tp_base;
3038 if (basebase->tp_as_sequence == NULL)
3039 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003040 COPYSEQ(sq_length);
3041 COPYSEQ(sq_concat);
3042 COPYSEQ(sq_repeat);
3043 COPYSEQ(sq_item);
3044 COPYSEQ(sq_slice);
3045 COPYSEQ(sq_ass_item);
3046 COPYSEQ(sq_ass_slice);
3047 COPYSEQ(sq_contains);
3048 COPYSEQ(sq_inplace_concat);
3049 COPYSEQ(sq_inplace_repeat);
3050 }
3051
Guido van Rossum13d52f02001-08-10 21:24:08 +00003052 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3053 basebase = base->tp_base;
3054 if (basebase->tp_as_mapping == NULL)
3055 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003056 COPYMAP(mp_length);
3057 COPYMAP(mp_subscript);
3058 COPYMAP(mp_ass_subscript);
3059 }
3060
Tim Petersfc57ccb2001-10-12 02:38:24 +00003061 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3062 basebase = base->tp_base;
3063 if (basebase->tp_as_buffer == NULL)
3064 basebase = NULL;
3065 COPYBUF(bf_getreadbuffer);
3066 COPYBUF(bf_getwritebuffer);
3067 COPYBUF(bf_getsegcount);
3068 COPYBUF(bf_getcharbuffer);
3069 }
3070
Guido van Rossum13d52f02001-08-10 21:24:08 +00003071 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003072
Tim Peters6d6c1a32001-08-02 04:15:00 +00003073 COPYSLOT(tp_dealloc);
3074 COPYSLOT(tp_print);
3075 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3076 type->tp_getattr = base->tp_getattr;
3077 type->tp_getattro = base->tp_getattro;
3078 }
3079 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3080 type->tp_setattr = base->tp_setattr;
3081 type->tp_setattro = base->tp_setattro;
3082 }
3083 /* tp_compare see tp_richcompare */
3084 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003085 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003086 COPYSLOT(tp_call);
3087 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003088 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003089 if (type->tp_compare == NULL &&
3090 type->tp_richcompare == NULL &&
3091 type->tp_hash == NULL)
3092 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003093 type->tp_compare = base->tp_compare;
3094 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003095 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003096 }
3097 }
3098 else {
3099 COPYSLOT(tp_compare);
3100 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003101 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3102 COPYSLOT(tp_iter);
3103 COPYSLOT(tp_iternext);
3104 }
3105 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3106 COPYSLOT(tp_descr_get);
3107 COPYSLOT(tp_descr_set);
3108 COPYSLOT(tp_dictoffset);
3109 COPYSLOT(tp_init);
3110 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003111 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003112 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3113 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3114 /* They agree about gc. */
3115 COPYSLOT(tp_free);
3116 }
3117 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3118 type->tp_free == NULL &&
3119 base->tp_free == _PyObject_Del) {
3120 /* A bit of magic to plug in the correct default
3121 * tp_free function when a derived class adds gc,
3122 * didn't define tp_free, and the base uses the
3123 * default non-gc tp_free.
3124 */
3125 type->tp_free = PyObject_GC_Del;
3126 }
3127 /* else they didn't agree about gc, and there isn't something
3128 * obvious to be done -- the type is on its own.
3129 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003130 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003131}
3132
Jeremy Hylton938ace62002-07-17 16:30:39 +00003133static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003134
Tim Peters6d6c1a32001-08-02 04:15:00 +00003135int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003136PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003137{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003138 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003139 PyTypeObject *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003140 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003141
Guido van Rossumcab05802002-06-10 15:29:03 +00003142 if (type->tp_flags & Py_TPFLAGS_READY) {
3143 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003144 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003145 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003146 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003147
3148 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003149
Tim Peters36eb4df2003-03-23 03:33:13 +00003150#ifdef Py_TRACE_REFS
3151 /* PyType_Ready is the closest thing we have to a choke point
3152 * for type objects, so is the best place I can think of to try
3153 * to get type objects into the doubly-linked list of all objects.
3154 * Still, not all type objects go thru PyType_Ready.
3155 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003156 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003157#endif
3158
Tim Peters6d6c1a32001-08-02 04:15:00 +00003159 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3160 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003161 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003162 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003163 Py_INCREF(base);
3164 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003165
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003166 /* Now the only way base can still be NULL is if type is
3167 * &PyBaseObject_Type.
3168 */
3169
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003170 /* Initialize the base class */
3171 if (base && base->tp_dict == NULL) {
3172 if (PyType_Ready(base) < 0)
3173 goto error;
3174 }
3175
Guido van Rossum0986d822002-04-08 01:38:42 +00003176 /* Initialize ob_type if NULL. This means extensions that want to be
3177 compilable separately on Windows can call PyType_Ready() instead of
3178 initializing the ob_type field of their type objects. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003179 /* The test for base != NULL is really unnecessary, since base is only
3180 NULL when type is &PyBaseObject_Type, and we know its ob_type is
3181 not NULL (it's initialized to &PyType_Type). But coverity doesn't
3182 know that. */
3183 if (type->ob_type == NULL && base != NULL)
Guido van Rossum0986d822002-04-08 01:38:42 +00003184 type->ob_type = base->ob_type;
3185
Tim Peters6d6c1a32001-08-02 04:15:00 +00003186 /* Initialize tp_bases */
3187 bases = type->tp_bases;
3188 if (bases == NULL) {
3189 if (base == NULL)
3190 bases = PyTuple_New(0);
3191 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003192 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003193 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003194 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003195 type->tp_bases = bases;
3196 }
3197
Guido van Rossum687ae002001-10-15 22:03:32 +00003198 /* Initialize tp_dict */
3199 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003200 if (dict == NULL) {
3201 dict = PyDict_New();
3202 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003203 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003204 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003205 }
3206
Guido van Rossum687ae002001-10-15 22:03:32 +00003207 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003208 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003209 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003210 if (type->tp_methods != NULL) {
3211 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003212 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003213 }
3214 if (type->tp_members != NULL) {
3215 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003216 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003217 }
3218 if (type->tp_getset != NULL) {
3219 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003220 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003221 }
3222
Tim Peters6d6c1a32001-08-02 04:15:00 +00003223 /* Calculate method resolution order */
3224 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003225 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003226 }
3227
Guido van Rossum13d52f02001-08-10 21:24:08 +00003228 /* Inherit special flags from dominant base */
3229 if (type->tp_base != NULL)
3230 inherit_special(type, type->tp_base);
3231
Tim Peters6d6c1a32001-08-02 04:15:00 +00003232 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003233 bases = type->tp_mro;
3234 assert(bases != NULL);
3235 assert(PyTuple_Check(bases));
3236 n = PyTuple_GET_SIZE(bases);
3237 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003238 PyObject *b = PyTuple_GET_ITEM(bases, i);
3239 if (PyType_Check(b))
3240 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003241 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003242
Tim Peters3cfe7542003-05-21 21:29:48 +00003243 /* Sanity check for tp_free. */
3244 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3245 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
3246 /* This base class needs to call tp_free, but doesn't have
3247 * one, or its tp_free is for non-gc'ed objects.
3248 */
3249 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3250 "gc and is a base type but has inappropriate "
3251 "tp_free slot",
3252 type->tp_name);
3253 goto error;
3254 }
3255
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003256 /* if the type dictionary doesn't contain a __doc__, set it from
3257 the tp_doc slot.
3258 */
3259 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3260 if (type->tp_doc != NULL) {
3261 PyObject *doc = PyString_FromString(type->tp_doc);
3262 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3263 Py_DECREF(doc);
3264 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003265 PyDict_SetItemString(type->tp_dict,
3266 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003267 }
3268 }
3269
Guido van Rossum13d52f02001-08-10 21:24:08 +00003270 /* Some more special stuff */
3271 base = type->tp_base;
3272 if (base != NULL) {
3273 if (type->tp_as_number == NULL)
3274 type->tp_as_number = base->tp_as_number;
3275 if (type->tp_as_sequence == NULL)
3276 type->tp_as_sequence = base->tp_as_sequence;
3277 if (type->tp_as_mapping == NULL)
3278 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003279 if (type->tp_as_buffer == NULL)
3280 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003281 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003282
Guido van Rossum1c450732001-10-08 15:18:27 +00003283 /* Link into each base class's list of subclasses */
3284 bases = type->tp_bases;
3285 n = PyTuple_GET_SIZE(bases);
3286 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003287 PyObject *b = PyTuple_GET_ITEM(bases, i);
3288 if (PyType_Check(b) &&
3289 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003290 goto error;
3291 }
3292
Guido van Rossum13d52f02001-08-10 21:24:08 +00003293 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003294 assert(type->tp_dict != NULL);
3295 type->tp_flags =
3296 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003297 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003298
3299 error:
3300 type->tp_flags &= ~Py_TPFLAGS_READYING;
3301 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003302}
3303
Guido van Rossum1c450732001-10-08 15:18:27 +00003304static int
3305add_subclass(PyTypeObject *base, PyTypeObject *type)
3306{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003307 Py_ssize_t i;
3308 int result;
Anthony Baxtera6286212006-04-11 07:42:36 +00003309 PyObject *list, *ref, *newobj;
Guido van Rossum1c450732001-10-08 15:18:27 +00003310
3311 list = base->tp_subclasses;
3312 if (list == NULL) {
3313 base->tp_subclasses = list = PyList_New(0);
3314 if (list == NULL)
3315 return -1;
3316 }
3317 assert(PyList_Check(list));
Anthony Baxtera6286212006-04-11 07:42:36 +00003318 newobj = PyWeakref_NewRef((PyObject *)type, NULL);
Guido van Rossum1c450732001-10-08 15:18:27 +00003319 i = PyList_GET_SIZE(list);
3320 while (--i >= 0) {
3321 ref = PyList_GET_ITEM(list, i);
3322 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003323 if (PyWeakref_GET_OBJECT(ref) == Py_None)
Anthony Baxtera6286212006-04-11 07:42:36 +00003324 return PyList_SetItem(list, i, newobj);
Guido van Rossum1c450732001-10-08 15:18:27 +00003325 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003326 result = PyList_Append(list, newobj);
3327 Py_DECREF(newobj);
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003328 return result;
Guido van Rossum1c450732001-10-08 15:18:27 +00003329}
3330
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003331static void
3332remove_subclass(PyTypeObject *base, PyTypeObject *type)
3333{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003334 Py_ssize_t i;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003335 PyObject *list, *ref;
3336
3337 list = base->tp_subclasses;
3338 if (list == NULL) {
3339 return;
3340 }
3341 assert(PyList_Check(list));
3342 i = PyList_GET_SIZE(list);
3343 while (--i >= 0) {
3344 ref = PyList_GET_ITEM(list, i);
3345 assert(PyWeakref_CheckRef(ref));
3346 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3347 /* this can't fail, right? */
3348 PySequence_DelItem(list, i);
3349 return;
3350 }
3351 }
3352}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003353
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003354static int
3355check_num_args(PyObject *ob, int n)
3356{
3357 if (!PyTuple_CheckExact(ob)) {
3358 PyErr_SetString(PyExc_SystemError,
3359 "PyArg_UnpackTuple() argument list is not a tuple");
3360 return 0;
3361 }
3362 if (n == PyTuple_GET_SIZE(ob))
3363 return 1;
3364 PyErr_Format(
3365 PyExc_TypeError,
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00003366 "expected %d arguments, got %zd", n, PyTuple_GET_SIZE(ob));
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003367 return 0;
3368}
3369
Tim Peters6d6c1a32001-08-02 04:15:00 +00003370/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3371
3372/* There's a wrapper *function* for each distinct function typedef used
3373 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
3374 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3375 Most tables have only one entry; the tables for binary operators have two
3376 entries, one regular and one with reversed arguments. */
3377
3378static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003379wrap_lenfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003380{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003381 lenfunc func = (lenfunc)wrapped;
3382 Py_ssize_t res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003383
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003384 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003385 return NULL;
3386 res = (*func)(self);
3387 if (res == -1 && PyErr_Occurred())
3388 return NULL;
3389 return PyInt_FromLong((long)res);
3390}
3391
Tim Peters6d6c1a32001-08-02 04:15:00 +00003392static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003393wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3394{
3395 inquiry func = (inquiry)wrapped;
3396 int res;
3397
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003398 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003399 return NULL;
3400 res = (*func)(self);
3401 if (res == -1 && PyErr_Occurred())
3402 return NULL;
3403 return PyBool_FromLong((long)res);
3404}
3405
3406static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003407wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3408{
3409 binaryfunc func = (binaryfunc)wrapped;
3410 PyObject *other;
3411
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003412 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003413 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003414 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003415 return (*func)(self, other);
3416}
3417
3418static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003419wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3420{
3421 binaryfunc func = (binaryfunc)wrapped;
3422 PyObject *other;
3423
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003424 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003425 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003426 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003427 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003428 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003429 Py_INCREF(Py_NotImplemented);
3430 return Py_NotImplemented;
3431 }
3432 return (*func)(self, other);
3433}
3434
3435static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003436wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3437{
3438 binaryfunc func = (binaryfunc)wrapped;
3439 PyObject *other;
3440
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003441 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003442 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003443 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003444 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003445 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003446 Py_INCREF(Py_NotImplemented);
3447 return Py_NotImplemented;
3448 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003449 return (*func)(other, self);
3450}
3451
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003452static PyObject *
3453wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3454{
3455 coercion func = (coercion)wrapped;
3456 PyObject *other, *res;
3457 int ok;
3458
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003459 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003460 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003461 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003462 ok = func(&self, &other);
3463 if (ok < 0)
3464 return NULL;
3465 if (ok > 0) {
3466 Py_INCREF(Py_NotImplemented);
3467 return Py_NotImplemented;
3468 }
3469 res = PyTuple_New(2);
3470 if (res == NULL) {
3471 Py_DECREF(self);
3472 Py_DECREF(other);
3473 return NULL;
3474 }
3475 PyTuple_SET_ITEM(res, 0, self);
3476 PyTuple_SET_ITEM(res, 1, other);
3477 return res;
3478}
3479
Tim Peters6d6c1a32001-08-02 04:15:00 +00003480static PyObject *
3481wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3482{
3483 ternaryfunc func = (ternaryfunc)wrapped;
3484 PyObject *other;
3485 PyObject *third = Py_None;
3486
3487 /* Note: This wrapper only works for __pow__() */
3488
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003489 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003490 return NULL;
3491 return (*func)(self, other, third);
3492}
3493
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003494static PyObject *
3495wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3496{
3497 ternaryfunc func = (ternaryfunc)wrapped;
3498 PyObject *other;
3499 PyObject *third = Py_None;
3500
3501 /* Note: This wrapper only works for __pow__() */
3502
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003503 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003504 return NULL;
3505 return (*func)(other, self, third);
3506}
3507
Tim Peters6d6c1a32001-08-02 04:15:00 +00003508static PyObject *
3509wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3510{
3511 unaryfunc func = (unaryfunc)wrapped;
3512
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003513 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003514 return NULL;
3515 return (*func)(self);
3516}
3517
Tim Peters6d6c1a32001-08-02 04:15:00 +00003518static PyObject *
Armin Rigo314861c2006-03-30 14:04:02 +00003519wrap_indexargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003520{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003521 ssizeargfunc func = (ssizeargfunc)wrapped;
Armin Rigo314861c2006-03-30 14:04:02 +00003522 PyObject* o;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003523 Py_ssize_t i;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003524
Armin Rigo314861c2006-03-30 14:04:02 +00003525 if (!PyArg_UnpackTuple(args, "", 1, 1, &o))
3526 return NULL;
3527 i = PyNumber_Index(o);
3528 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003529 return NULL;
3530 return (*func)(self, i);
3531}
3532
Martin v. Löwis18e16552006-02-15 17:27:45 +00003533static Py_ssize_t
Guido van Rossum5d815f32001-08-17 21:57:47 +00003534getindex(PyObject *self, PyObject *arg)
3535{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003536 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003537
Armin Rigo314861c2006-03-30 14:04:02 +00003538 i = PyNumber_Index(arg);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003539 if (i == -1 && PyErr_Occurred())
3540 return -1;
3541 if (i < 0) {
3542 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3543 if (sq && sq->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00003544 Py_ssize_t n = (*sq->sq_length)(self);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003545 if (n < 0)
3546 return -1;
3547 i += n;
3548 }
3549 }
3550 return i;
3551}
3552
3553static PyObject *
3554wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3555{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003556 ssizeargfunc func = (ssizeargfunc)wrapped;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003557 PyObject *arg;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003558 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003559
Guido van Rossumf4593e02001-10-03 12:09:30 +00003560 if (PyTuple_GET_SIZE(args) == 1) {
3561 arg = PyTuple_GET_ITEM(args, 0);
3562 i = getindex(self, arg);
3563 if (i == -1 && PyErr_Occurred())
3564 return NULL;
3565 return (*func)(self, i);
3566 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003567 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003568 assert(PyErr_Occurred());
3569 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003570}
3571
Tim Peters6d6c1a32001-08-02 04:15:00 +00003572static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003573wrap_ssizessizeargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003574{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003575 ssizessizeargfunc func = (ssizessizeargfunc)wrapped;
3576 Py_ssize_t i, j;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003577
Martin v. Löwis18e16552006-02-15 17:27:45 +00003578 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003579 return NULL;
3580 return (*func)(self, i, j);
3581}
3582
Tim Peters6d6c1a32001-08-02 04:15:00 +00003583static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003584wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003585{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003586 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3587 Py_ssize_t i;
3588 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003589 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003590
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003591 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003592 return NULL;
3593 i = getindex(self, arg);
3594 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003595 return NULL;
3596 res = (*func)(self, i, value);
3597 if (res == -1 && PyErr_Occurred())
3598 return NULL;
3599 Py_INCREF(Py_None);
3600 return Py_None;
3601}
3602
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003603static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003604wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003605{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003606 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3607 Py_ssize_t i;
3608 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003609 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003610
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003611 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003612 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003613 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003614 i = getindex(self, arg);
3615 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003616 return NULL;
3617 res = (*func)(self, i, NULL);
3618 if (res == -1 && PyErr_Occurred())
3619 return NULL;
3620 Py_INCREF(Py_None);
3621 return Py_None;
3622}
3623
Tim Peters6d6c1a32001-08-02 04:15:00 +00003624static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003625wrap_ssizessizeobjargproc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003626{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003627 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3628 Py_ssize_t i, j;
3629 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003630 PyObject *value;
3631
Martin v. Löwis18e16552006-02-15 17:27:45 +00003632 if (!PyArg_ParseTuple(args, "nnO", &i, &j, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003633 return NULL;
3634 res = (*func)(self, i, j, value);
3635 if (res == -1 && PyErr_Occurred())
3636 return NULL;
3637 Py_INCREF(Py_None);
3638 return Py_None;
3639}
3640
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003641static PyObject *
3642wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3643{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003644 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3645 Py_ssize_t i, j;
3646 int res;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003647
Martin v. Löwis18e16552006-02-15 17:27:45 +00003648 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003649 return NULL;
3650 res = (*func)(self, i, j, NULL);
3651 if (res == -1 && PyErr_Occurred())
3652 return NULL;
3653 Py_INCREF(Py_None);
3654 return Py_None;
3655}
3656
Tim Peters6d6c1a32001-08-02 04:15:00 +00003657/* XXX objobjproc is a misnomer; should be objargpred */
3658static PyObject *
3659wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3660{
3661 objobjproc func = (objobjproc)wrapped;
3662 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003663 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003664
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003665 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003666 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003667 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003668 res = (*func)(self, value);
3669 if (res == -1 && PyErr_Occurred())
3670 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003671 else
3672 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003673}
3674
Tim Peters6d6c1a32001-08-02 04:15:00 +00003675static PyObject *
3676wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3677{
3678 objobjargproc func = (objobjargproc)wrapped;
3679 int res;
3680 PyObject *key, *value;
3681
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003682 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003683 return NULL;
3684 res = (*func)(self, key, value);
3685 if (res == -1 && PyErr_Occurred())
3686 return NULL;
3687 Py_INCREF(Py_None);
3688 return Py_None;
3689}
3690
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003691static PyObject *
3692wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3693{
3694 objobjargproc func = (objobjargproc)wrapped;
3695 int res;
3696 PyObject *key;
3697
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003698 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003699 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003700 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003701 res = (*func)(self, key, NULL);
3702 if (res == -1 && PyErr_Occurred())
3703 return NULL;
3704 Py_INCREF(Py_None);
3705 return Py_None;
3706}
3707
Tim Peters6d6c1a32001-08-02 04:15:00 +00003708static PyObject *
3709wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3710{
3711 cmpfunc func = (cmpfunc)wrapped;
3712 int res;
3713 PyObject *other;
3714
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003715 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003716 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003717 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003718 if (other->ob_type->tp_compare != func &&
3719 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003720 PyErr_Format(
3721 PyExc_TypeError,
3722 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3723 self->ob_type->tp_name,
3724 self->ob_type->tp_name,
3725 other->ob_type->tp_name);
3726 return NULL;
3727 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003728 res = (*func)(self, other);
3729 if (PyErr_Occurred())
3730 return NULL;
3731 return PyInt_FromLong((long)res);
3732}
3733
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003734/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003735 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003736static int
3737hackcheck(PyObject *self, setattrofunc func, char *what)
3738{
3739 PyTypeObject *type = self->ob_type;
3740 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3741 type = type->tp_base;
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003742 /* If type is NULL now, this is a really weird type.
3743 In the same of backwards compatibility (?), just shut up. */
3744 if (type && type->tp_setattro != func) {
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003745 PyErr_Format(PyExc_TypeError,
3746 "can't apply this %s to %s object",
3747 what,
3748 type->tp_name);
3749 return 0;
3750 }
3751 return 1;
3752}
3753
Tim Peters6d6c1a32001-08-02 04:15:00 +00003754static PyObject *
3755wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3756{
3757 setattrofunc func = (setattrofunc)wrapped;
3758 int res;
3759 PyObject *name, *value;
3760
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003761 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003762 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003763 if (!hackcheck(self, func, "__setattr__"))
3764 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003765 res = (*func)(self, name, value);
3766 if (res < 0)
3767 return NULL;
3768 Py_INCREF(Py_None);
3769 return Py_None;
3770}
3771
3772static PyObject *
3773wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3774{
3775 setattrofunc func = (setattrofunc)wrapped;
3776 int res;
3777 PyObject *name;
3778
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003779 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003780 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003781 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003782 if (!hackcheck(self, func, "__delattr__"))
3783 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003784 res = (*func)(self, name, NULL);
3785 if (res < 0)
3786 return NULL;
3787 Py_INCREF(Py_None);
3788 return Py_None;
3789}
3790
Tim Peters6d6c1a32001-08-02 04:15:00 +00003791static PyObject *
3792wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3793{
3794 hashfunc func = (hashfunc)wrapped;
3795 long res;
3796
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003797 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003798 return NULL;
3799 res = (*func)(self);
3800 if (res == -1 && PyErr_Occurred())
3801 return NULL;
3802 return PyInt_FromLong(res);
3803}
3804
Tim Peters6d6c1a32001-08-02 04:15:00 +00003805static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003806wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003807{
3808 ternaryfunc func = (ternaryfunc)wrapped;
3809
Guido van Rossumc8e56452001-10-22 00:43:43 +00003810 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003811}
3812
Tim Peters6d6c1a32001-08-02 04:15:00 +00003813static PyObject *
3814wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3815{
3816 richcmpfunc func = (richcmpfunc)wrapped;
3817 PyObject *other;
3818
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003819 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003820 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003821 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003822 return (*func)(self, other, op);
3823}
3824
3825#undef RICHCMP_WRAPPER
3826#define RICHCMP_WRAPPER(NAME, OP) \
3827static PyObject * \
3828richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3829{ \
3830 return wrap_richcmpfunc(self, args, wrapped, OP); \
3831}
3832
Jack Jansen8e938b42001-08-08 15:29:49 +00003833RICHCMP_WRAPPER(lt, Py_LT)
3834RICHCMP_WRAPPER(le, Py_LE)
3835RICHCMP_WRAPPER(eq, Py_EQ)
3836RICHCMP_WRAPPER(ne, Py_NE)
3837RICHCMP_WRAPPER(gt, Py_GT)
3838RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003839
Tim Peters6d6c1a32001-08-02 04:15:00 +00003840static PyObject *
3841wrap_next(PyObject *self, PyObject *args, void *wrapped)
3842{
3843 unaryfunc func = (unaryfunc)wrapped;
3844 PyObject *res;
3845
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003846 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003847 return NULL;
3848 res = (*func)(self);
3849 if (res == NULL && !PyErr_Occurred())
3850 PyErr_SetNone(PyExc_StopIteration);
3851 return res;
3852}
3853
Tim Peters6d6c1a32001-08-02 04:15:00 +00003854static PyObject *
3855wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3856{
3857 descrgetfunc func = (descrgetfunc)wrapped;
3858 PyObject *obj;
3859 PyObject *type = NULL;
3860
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003861 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003862 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003863 if (obj == Py_None)
3864 obj = NULL;
3865 if (type == Py_None)
3866 type = NULL;
3867 if (type == NULL &&obj == NULL) {
3868 PyErr_SetString(PyExc_TypeError,
3869 "__get__(None, None) is invalid");
3870 return NULL;
3871 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003872 return (*func)(self, obj, type);
3873}
3874
Tim Peters6d6c1a32001-08-02 04:15:00 +00003875static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003876wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003877{
3878 descrsetfunc func = (descrsetfunc)wrapped;
3879 PyObject *obj, *value;
3880 int ret;
3881
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003882 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003883 return NULL;
3884 ret = (*func)(self, obj, value);
3885 if (ret < 0)
3886 return NULL;
3887 Py_INCREF(Py_None);
3888 return Py_None;
3889}
Guido van Rossum22b13872002-08-06 21:41:44 +00003890
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003891static PyObject *
3892wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3893{
3894 descrsetfunc func = (descrsetfunc)wrapped;
3895 PyObject *obj;
3896 int ret;
3897
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003898 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003899 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003900 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003901 ret = (*func)(self, obj, NULL);
3902 if (ret < 0)
3903 return NULL;
3904 Py_INCREF(Py_None);
3905 return Py_None;
3906}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003907
Tim Peters6d6c1a32001-08-02 04:15:00 +00003908static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003909wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003910{
3911 initproc func = (initproc)wrapped;
3912
Guido van Rossumc8e56452001-10-22 00:43:43 +00003913 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003914 return NULL;
3915 Py_INCREF(Py_None);
3916 return Py_None;
3917}
3918
Tim Peters6d6c1a32001-08-02 04:15:00 +00003919static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003920tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003921{
Barry Warsaw60f01882001-08-22 19:24:42 +00003922 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003923 PyObject *arg0, *res;
3924
3925 if (self == NULL || !PyType_Check(self))
3926 Py_FatalError("__new__() called with non-type 'self'");
3927 type = (PyTypeObject *)self;
3928 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003929 PyErr_Format(PyExc_TypeError,
3930 "%s.__new__(): not enough arguments",
3931 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003932 return NULL;
3933 }
3934 arg0 = PyTuple_GET_ITEM(args, 0);
3935 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003936 PyErr_Format(PyExc_TypeError,
3937 "%s.__new__(X): X is not a type object (%s)",
3938 type->tp_name,
3939 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003940 return NULL;
3941 }
3942 subtype = (PyTypeObject *)arg0;
3943 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003944 PyErr_Format(PyExc_TypeError,
3945 "%s.__new__(%s): %s is not a subtype of %s",
3946 type->tp_name,
3947 subtype->tp_name,
3948 subtype->tp_name,
3949 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003950 return NULL;
3951 }
Barry Warsaw60f01882001-08-22 19:24:42 +00003952
3953 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00003954 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00003955 most derived base that's not a heap type is this type. */
3956 staticbase = subtype;
3957 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
3958 staticbase = staticbase->tp_base;
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003959 /* If staticbase is NULL now, it is a really weird type.
3960 In the same of backwards compatibility (?), just shut up. */
3961 if (staticbase && staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003962 PyErr_Format(PyExc_TypeError,
3963 "%s.__new__(%s) is not safe, use %s.__new__()",
3964 type->tp_name,
3965 subtype->tp_name,
3966 staticbase == NULL ? "?" : staticbase->tp_name);
3967 return NULL;
3968 }
3969
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003970 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
3971 if (args == NULL)
3972 return NULL;
3973 res = type->tp_new(subtype, args, kwds);
3974 Py_DECREF(args);
3975 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003976}
3977
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003978static struct PyMethodDef tp_new_methoddef[] = {
3979 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003980 PyDoc_STR("T.__new__(S, ...) -> "
3981 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003982 {0}
3983};
3984
3985static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003986add_tp_new_wrapper(PyTypeObject *type)
3987{
Guido van Rossumf040ede2001-08-07 16:40:56 +00003988 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003989
Guido van Rossum687ae002001-10-15 22:03:32 +00003990 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00003991 return 0;
3992 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003993 if (func == NULL)
3994 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00003995 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00003996 Py_DECREF(func);
3997 return -1;
3998 }
3999 Py_DECREF(func);
4000 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00004001}
4002
Guido van Rossumf040ede2001-08-07 16:40:56 +00004003/* Slot wrappers that call the corresponding __foo__ slot. See comments
4004 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004005
Guido van Rossumdc91b992001-08-08 22:26:22 +00004006#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004007static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004008FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004009{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00004010 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004011 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004012}
4013
Guido van Rossumdc91b992001-08-08 22:26:22 +00004014#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004015static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004016FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004017{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004018 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004019 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004020}
4021
Guido van Rossumcd118802003-01-06 22:57:47 +00004022/* Boolean helper for SLOT1BINFULL().
4023 right.__class__ is a nontrivial subclass of left.__class__. */
4024static int
4025method_is_overloaded(PyObject *left, PyObject *right, char *name)
4026{
4027 PyObject *a, *b;
4028 int ok;
4029
4030 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
4031 if (b == NULL) {
4032 PyErr_Clear();
4033 /* If right doesn't have it, it's not overloaded */
4034 return 0;
4035 }
4036
4037 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
4038 if (a == NULL) {
4039 PyErr_Clear();
4040 Py_DECREF(b);
4041 /* If right has it but left doesn't, it's overloaded */
4042 return 1;
4043 }
4044
4045 ok = PyObject_RichCompareBool(a, b, Py_NE);
4046 Py_DECREF(a);
4047 Py_DECREF(b);
4048 if (ok < 0) {
4049 PyErr_Clear();
4050 return 0;
4051 }
4052
4053 return ok;
4054}
4055
Guido van Rossumdc91b992001-08-08 22:26:22 +00004056
4057#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004058static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004059FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004060{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004061 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004062 int do_other = self->ob_type != other->ob_type && \
4063 other->ob_type->tp_as_number != NULL && \
4064 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004065 if (self->ob_type->tp_as_number != NULL && \
4066 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
4067 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004068 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004069 PyType_IsSubtype(other->ob_type, self->ob_type) && \
4070 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004071 r = call_maybe( \
4072 other, ROPSTR, &rcache_str, "(O)", self); \
4073 if (r != Py_NotImplemented) \
4074 return r; \
4075 Py_DECREF(r); \
4076 do_other = 0; \
4077 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004078 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004079 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004080 if (r != Py_NotImplemented || \
4081 other->ob_type == self->ob_type) \
4082 return r; \
4083 Py_DECREF(r); \
4084 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004085 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004086 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004087 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004088 } \
4089 Py_INCREF(Py_NotImplemented); \
4090 return Py_NotImplemented; \
4091}
4092
4093#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4094 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4095
4096#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4097static PyObject * \
4098FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4099{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004100 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004101 return call_method(self, OPSTR, &cache_str, \
4102 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004103}
4104
Martin v. Löwis18e16552006-02-15 17:27:45 +00004105static Py_ssize_t
Tim Peters6d6c1a32001-08-02 04:15:00 +00004106slot_sq_length(PyObject *self)
4107{
Guido van Rossum2730b132001-08-28 18:22:14 +00004108 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004109 PyObject *res = call_method(self, "__len__", &len_str, "()");
Martin v. Löwis18e16552006-02-15 17:27:45 +00004110 Py_ssize_t temp;
4111 Py_ssize_t len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004112
4113 if (res == NULL)
4114 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004115 temp = PyInt_AsSsize_t(res);
Guido van Rossum630db602005-09-20 18:49:54 +00004116 len = (int)temp;
Guido van Rossum26111622001-10-01 16:42:49 +00004117 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00004118 if (len == -1 && PyErr_Occurred())
4119 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004120#if SIZEOF_SIZE_T < SIZEOF_LONG
4121 /* Overflow check -- range of PyInt is more than C ssize_t */
Guido van Rossum630db602005-09-20 18:49:54 +00004122 if (len != temp) {
4123 PyErr_SetString(PyExc_OverflowError,
4124 "__len__() should return 0 <= outcome < 2**31");
4125 return -1;
4126 }
4127#endif
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004128 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00004129 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004130 "__len__() should return >= 0");
4131 return -1;
4132 }
Guido van Rossum26111622001-10-01 16:42:49 +00004133 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004134}
4135
Guido van Rossumf4593e02001-10-03 12:09:30 +00004136/* Super-optimized version of slot_sq_item.
4137 Other slots could do the same... */
4138static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004139slot_sq_item(PyObject *self, Py_ssize_t i)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004140{
4141 static PyObject *getitem_str;
4142 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4143 descrgetfunc f;
4144
4145 if (getitem_str == NULL) {
4146 getitem_str = PyString_InternFromString("__getitem__");
4147 if (getitem_str == NULL)
4148 return NULL;
4149 }
4150 func = _PyType_Lookup(self->ob_type, getitem_str);
4151 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004152 if ((f = func->ob_type->tp_descr_get) == NULL)
4153 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004154 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004155 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004156 if (func == NULL) {
4157 return NULL;
4158 }
4159 }
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004160 ival = PyInt_FromSsize_t(i);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004161 if (ival != NULL) {
4162 args = PyTuple_New(1);
4163 if (args != NULL) {
4164 PyTuple_SET_ITEM(args, 0, ival);
4165 retval = PyObject_Call(func, args, NULL);
4166 Py_XDECREF(args);
4167 Py_XDECREF(func);
4168 return retval;
4169 }
4170 }
4171 }
4172 else {
4173 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4174 }
4175 Py_XDECREF(args);
4176 Py_XDECREF(ival);
4177 Py_XDECREF(func);
4178 return NULL;
4179}
4180
Martin v. Löwis18e16552006-02-15 17:27:45 +00004181SLOT2(slot_sq_slice, "__getslice__", Py_ssize_t, Py_ssize_t, "nn")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004182
4183static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004184slot_sq_ass_item(PyObject *self, Py_ssize_t index, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004185{
4186 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004187 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004188
4189 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004190 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004191 "(i)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004192 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004193 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004194 "(iO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004195 if (res == NULL)
4196 return -1;
4197 Py_DECREF(res);
4198 return 0;
4199}
4200
4201static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004202slot_sq_ass_slice(PyObject *self, Py_ssize_t i, Py_ssize_t j, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004203{
4204 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004205 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004206
4207 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004208 res = call_method(self, "__delslice__", &delslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004209 "(ii)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004210 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004211 res = call_method(self, "__setslice__", &setslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004212 "(iiO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004213 if (res == NULL)
4214 return -1;
4215 Py_DECREF(res);
4216 return 0;
4217}
4218
4219static int
4220slot_sq_contains(PyObject *self, PyObject *value)
4221{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004222 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004223 int result = -1;
4224
Guido van Rossum60718732001-08-28 17:47:51 +00004225 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004226
Guido van Rossum55f20992001-10-01 17:18:22 +00004227 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004228 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004229 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004230 if (args == NULL)
4231 res = NULL;
4232 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004233 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004234 Py_DECREF(args);
4235 }
4236 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004237 if (res != NULL) {
4238 result = PyObject_IsTrue(res);
4239 Py_DECREF(res);
4240 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004241 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004242 else if (! PyErr_Occurred()) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004243 /* Possible results: -1 and 1 */
4244 result = (int)_PySequence_IterSearch(self, value,
Tim Petersbf9b2442003-03-23 05:35:36 +00004245 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004246 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004247 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004248}
4249
Tim Peters6d6c1a32001-08-02 04:15:00 +00004250#define slot_mp_length slot_sq_length
4251
Guido van Rossumdc91b992001-08-08 22:26:22 +00004252SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004253
4254static int
4255slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4256{
4257 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004258 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004259
4260 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004261 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004262 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004263 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004264 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004265 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004266 if (res == NULL)
4267 return -1;
4268 Py_DECREF(res);
4269 return 0;
4270}
4271
Guido van Rossumdc91b992001-08-08 22:26:22 +00004272SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4273SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4274SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4275SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4276SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4277SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4278
Jeremy Hylton938ace62002-07-17 16:30:39 +00004279static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004280
4281SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4282 nb_power, "__pow__", "__rpow__")
4283
4284static PyObject *
4285slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4286{
Guido van Rossum2730b132001-08-28 18:22:14 +00004287 static PyObject *pow_str;
4288
Guido van Rossumdc91b992001-08-08 22:26:22 +00004289 if (modulus == Py_None)
4290 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004291 /* Three-arg power doesn't use __rpow__. But ternary_op
4292 can call this when the second argument's type uses
4293 slot_nb_power, so check before calling self.__pow__. */
4294 if (self->ob_type->tp_as_number != NULL &&
4295 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4296 return call_method(self, "__pow__", &pow_str,
4297 "(OO)", other, modulus);
4298 }
4299 Py_INCREF(Py_NotImplemented);
4300 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004301}
4302
4303SLOT0(slot_nb_negative, "__neg__")
4304SLOT0(slot_nb_positive, "__pos__")
4305SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004306
4307static int
4308slot_nb_nonzero(PyObject *self)
4309{
Tim Petersea7f75d2002-12-07 21:39:16 +00004310 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004311 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004312 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004313
Guido van Rossum55f20992001-10-01 17:18:22 +00004314 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004315 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004316 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004317 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004318 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004319 if (func == NULL)
4320 return PyErr_Occurred() ? -1 : 1;
4321 }
4322 args = PyTuple_New(0);
4323 if (args != NULL) {
4324 PyObject *temp = PyObject_Call(func, args, NULL);
4325 Py_DECREF(args);
4326 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004327 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004328 result = PyObject_IsTrue(temp);
4329 else {
4330 PyErr_Format(PyExc_TypeError,
4331 "__nonzero__ should return "
4332 "bool or int, returned %s",
4333 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004334 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004335 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004336 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004337 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004338 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004339 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004340 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004341}
4342
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004343
4344static Py_ssize_t
4345slot_nb_index(PyObject *self)
4346{
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004347 static PyObject *index_str;
Armin Rigo314861c2006-03-30 14:04:02 +00004348 PyObject *temp = call_method(self, "__index__", &index_str, "()");
4349 Py_ssize_t result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004350
Armin Rigo314861c2006-03-30 14:04:02 +00004351 if (temp == NULL)
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004352 return -1;
Armin Rigo314861c2006-03-30 14:04:02 +00004353 if (PyInt_CheckExact(temp) || PyLong_CheckExact(temp)) {
4354 result = temp->ob_type->tp_as_number->nb_index(temp);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004355 }
Armin Rigo314861c2006-03-30 14:04:02 +00004356 else {
4357 PyErr_SetString(PyExc_TypeError,
4358 "__index__ must return an int or a long");
4359 result = -1;
4360 }
4361 Py_DECREF(temp);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004362 return result;
4363}
4364
4365
Guido van Rossumdc91b992001-08-08 22:26:22 +00004366SLOT0(slot_nb_invert, "__invert__")
4367SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4368SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4369SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4370SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4371SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004372
4373static int
4374slot_nb_coerce(PyObject **a, PyObject **b)
4375{
4376 static PyObject *coerce_str;
4377 PyObject *self = *a, *other = *b;
4378
4379 if (self->ob_type->tp_as_number != NULL &&
4380 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4381 PyObject *r;
4382 r = call_maybe(
4383 self, "__coerce__", &coerce_str, "(O)", other);
4384 if (r == NULL)
4385 return -1;
4386 if (r == Py_NotImplemented) {
4387 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004388 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004389 else {
4390 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4391 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004392 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004393 Py_DECREF(r);
4394 return -1;
4395 }
4396 *a = PyTuple_GET_ITEM(r, 0);
4397 Py_INCREF(*a);
4398 *b = PyTuple_GET_ITEM(r, 1);
4399 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004400 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004401 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004402 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004403 }
4404 if (other->ob_type->tp_as_number != NULL &&
4405 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4406 PyObject *r;
4407 r = call_maybe(
4408 other, "__coerce__", &coerce_str, "(O)", self);
4409 if (r == NULL)
4410 return -1;
4411 if (r == Py_NotImplemented) {
4412 Py_DECREF(r);
4413 return 1;
4414 }
4415 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4416 PyErr_SetString(PyExc_TypeError,
4417 "__coerce__ didn't return a 2-tuple");
4418 Py_DECREF(r);
4419 return -1;
4420 }
4421 *a = PyTuple_GET_ITEM(r, 1);
4422 Py_INCREF(*a);
4423 *b = PyTuple_GET_ITEM(r, 0);
4424 Py_INCREF(*b);
4425 Py_DECREF(r);
4426 return 0;
4427 }
4428 return 1;
4429}
4430
Guido van Rossumdc91b992001-08-08 22:26:22 +00004431SLOT0(slot_nb_int, "__int__")
4432SLOT0(slot_nb_long, "__long__")
4433SLOT0(slot_nb_float, "__float__")
4434SLOT0(slot_nb_oct, "__oct__")
4435SLOT0(slot_nb_hex, "__hex__")
4436SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4437SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4438SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4439SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4440SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004441SLOT1(slot_nb_inplace_power, "__ipow__", PyObject *, "O")
Guido van Rossumdc91b992001-08-08 22:26:22 +00004442SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4443SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4444SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4445SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4446SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4447SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4448 "__floordiv__", "__rfloordiv__")
4449SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4450SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4451SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004452
4453static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004454half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004455{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004456 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004457 static PyObject *cmp_str;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004458 Py_ssize_t c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004459
Guido van Rossum60718732001-08-28 17:47:51 +00004460 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004461 if (func == NULL) {
4462 PyErr_Clear();
4463 }
4464 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004465 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004466 if (args == NULL)
4467 res = NULL;
4468 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004469 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004470 Py_DECREF(args);
4471 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004472 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004473 if (res != Py_NotImplemented) {
4474 if (res == NULL)
4475 return -2;
4476 c = PyInt_AsLong(res);
4477 Py_DECREF(res);
4478 if (c == -1 && PyErr_Occurred())
4479 return -2;
4480 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4481 }
4482 Py_DECREF(res);
4483 }
4484 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004485}
4486
Guido van Rossumab3b0342001-09-18 20:38:53 +00004487/* This slot is published for the benefit of try_3way_compare in object.c */
4488int
4489_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004490{
4491 int c;
4492
Guido van Rossumab3b0342001-09-18 20:38:53 +00004493 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004494 c = half_compare(self, other);
4495 if (c <= 1)
4496 return c;
4497 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004498 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004499 c = half_compare(other, self);
4500 if (c < -1)
4501 return -2;
4502 if (c <= 1)
4503 return -c;
4504 }
4505 return (void *)self < (void *)other ? -1 :
4506 (void *)self > (void *)other ? 1 : 0;
4507}
4508
4509static PyObject *
4510slot_tp_repr(PyObject *self)
4511{
4512 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004513 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004514
Guido van Rossum60718732001-08-28 17:47:51 +00004515 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004516 if (func != NULL) {
4517 res = PyEval_CallObject(func, NULL);
4518 Py_DECREF(func);
4519 return res;
4520 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004521 PyErr_Clear();
4522 return PyString_FromFormat("<%s object at %p>",
4523 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004524}
4525
4526static PyObject *
4527slot_tp_str(PyObject *self)
4528{
4529 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004530 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004531
Guido van Rossum60718732001-08-28 17:47:51 +00004532 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004533 if (func != NULL) {
4534 res = PyEval_CallObject(func, NULL);
4535 Py_DECREF(func);
4536 return res;
4537 }
4538 else {
4539 PyErr_Clear();
4540 return slot_tp_repr(self);
4541 }
4542}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004543
4544static long
4545slot_tp_hash(PyObject *self)
4546{
Tim Peters61ce0a92002-12-06 23:38:02 +00004547 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004548 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004549 long h;
4550
Guido van Rossum60718732001-08-28 17:47:51 +00004551 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004552
4553 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004554 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004555 Py_DECREF(func);
4556 if (res == NULL)
4557 return -1;
4558 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004559 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004560 }
4561 else {
4562 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004563 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004564 if (func == NULL) {
4565 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004566 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004567 }
4568 if (func != NULL) {
4569 Py_DECREF(func);
4570 PyErr_SetString(PyExc_TypeError, "unhashable type");
4571 return -1;
4572 }
4573 PyErr_Clear();
4574 h = _Py_HashPointer((void *)self);
4575 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004576 if (h == -1 && !PyErr_Occurred())
4577 h = -2;
4578 return h;
4579}
4580
4581static PyObject *
4582slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4583{
Guido van Rossum60718732001-08-28 17:47:51 +00004584 static PyObject *call_str;
4585 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004586 PyObject *res;
4587
4588 if (meth == NULL)
4589 return NULL;
4590 res = PyObject_Call(meth, args, kwds);
4591 Py_DECREF(meth);
4592 return res;
4593}
4594
Guido van Rossum14a6f832001-10-17 13:59:09 +00004595/* There are two slot dispatch functions for tp_getattro.
4596
4597 - slot_tp_getattro() is used when __getattribute__ is overridden
4598 but no __getattr__ hook is present;
4599
4600 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4601
Guido van Rossumc334df52002-04-04 23:44:47 +00004602 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4603 detects the absence of __getattr__ and then installs the simpler slot if
4604 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004605
Tim Peters6d6c1a32001-08-02 04:15:00 +00004606static PyObject *
4607slot_tp_getattro(PyObject *self, PyObject *name)
4608{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004609 static PyObject *getattribute_str = NULL;
4610 return call_method(self, "__getattribute__", &getattribute_str,
4611 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004612}
4613
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004614static PyObject *
4615slot_tp_getattr_hook(PyObject *self, PyObject *name)
4616{
4617 PyTypeObject *tp = self->ob_type;
4618 PyObject *getattr, *getattribute, *res;
4619 static PyObject *getattribute_str = NULL;
4620 static PyObject *getattr_str = NULL;
4621
4622 if (getattr_str == NULL) {
4623 getattr_str = PyString_InternFromString("__getattr__");
4624 if (getattr_str == NULL)
4625 return NULL;
4626 }
4627 if (getattribute_str == NULL) {
4628 getattribute_str =
4629 PyString_InternFromString("__getattribute__");
4630 if (getattribute_str == NULL)
4631 return NULL;
4632 }
4633 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004634 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004635 /* No __getattr__ hook: use a simpler dispatcher */
4636 tp->tp_getattro = slot_tp_getattro;
4637 return slot_tp_getattro(self, name);
4638 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004639 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004640 if (getattribute == NULL ||
4641 (getattribute->ob_type == &PyWrapperDescr_Type &&
4642 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4643 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004644 res = PyObject_GenericGetAttr(self, name);
4645 else
4646 res = PyObject_CallFunction(getattribute, "OO", self, name);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004647 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004648 PyErr_Clear();
4649 res = PyObject_CallFunction(getattr, "OO", self, name);
4650 }
4651 return res;
4652}
4653
Tim Peters6d6c1a32001-08-02 04:15:00 +00004654static int
4655slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4656{
4657 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004658 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004659
4660 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004661 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004662 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004663 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004664 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004665 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004666 if (res == NULL)
4667 return -1;
4668 Py_DECREF(res);
4669 return 0;
4670}
4671
4672/* Map rich comparison operators to their __xx__ namesakes */
4673static char *name_op[] = {
4674 "__lt__",
4675 "__le__",
4676 "__eq__",
4677 "__ne__",
4678 "__gt__",
4679 "__ge__",
4680};
4681
4682static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004683half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004684{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004685 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004686 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004687
Guido van Rossum60718732001-08-28 17:47:51 +00004688 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004689 if (func == NULL) {
4690 PyErr_Clear();
4691 Py_INCREF(Py_NotImplemented);
4692 return Py_NotImplemented;
4693 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004694 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004695 if (args == NULL)
4696 res = NULL;
4697 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004698 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004699 Py_DECREF(args);
4700 }
4701 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004702 return res;
4703}
4704
Guido van Rossumb8f63662001-08-15 23:57:02 +00004705static PyObject *
4706slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4707{
4708 PyObject *res;
4709
4710 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4711 res = half_richcompare(self, other, op);
4712 if (res != Py_NotImplemented)
4713 return res;
4714 Py_DECREF(res);
4715 }
4716 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00004717 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004718 if (res != Py_NotImplemented) {
4719 return res;
4720 }
4721 Py_DECREF(res);
4722 }
4723 Py_INCREF(Py_NotImplemented);
4724 return Py_NotImplemented;
4725}
4726
4727static PyObject *
4728slot_tp_iter(PyObject *self)
4729{
4730 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004731 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004732
Guido van Rossum60718732001-08-28 17:47:51 +00004733 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004734 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004735 PyObject *args;
4736 args = res = PyTuple_New(0);
4737 if (args != NULL) {
4738 res = PyObject_Call(func, args, NULL);
4739 Py_DECREF(args);
4740 }
4741 Py_DECREF(func);
4742 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004743 }
4744 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004745 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004746 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004747 PyErr_SetString(PyExc_TypeError,
4748 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00004749 return NULL;
4750 }
4751 Py_DECREF(func);
4752 return PySeqIter_New(self);
4753}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004754
4755static PyObject *
4756slot_tp_iternext(PyObject *self)
4757{
Guido van Rossum2730b132001-08-28 18:22:14 +00004758 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004759 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004760}
4761
Guido van Rossum1a493502001-08-17 16:47:50 +00004762static PyObject *
4763slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4764{
4765 PyTypeObject *tp = self->ob_type;
4766 PyObject *get;
4767 static PyObject *get_str = NULL;
4768
4769 if (get_str == NULL) {
4770 get_str = PyString_InternFromString("__get__");
4771 if (get_str == NULL)
4772 return NULL;
4773 }
4774 get = _PyType_Lookup(tp, get_str);
4775 if (get == NULL) {
4776 /* Avoid further slowdowns */
4777 if (tp->tp_descr_get == slot_tp_descr_get)
4778 tp->tp_descr_get = NULL;
4779 Py_INCREF(self);
4780 return self;
4781 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004782 if (obj == NULL)
4783 obj = Py_None;
4784 if (type == NULL)
4785 type = Py_None;
Guido van Rossum1a493502001-08-17 16:47:50 +00004786 return PyObject_CallFunction(get, "OOO", self, obj, type);
4787}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004788
4789static int
4790slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4791{
Guido van Rossum2c252392001-08-24 10:13:31 +00004792 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004793 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004794
4795 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004796 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004797 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004798 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004799 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004800 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004801 if (res == NULL)
4802 return -1;
4803 Py_DECREF(res);
4804 return 0;
4805}
4806
4807static int
4808slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4809{
Guido van Rossum60718732001-08-28 17:47:51 +00004810 static PyObject *init_str;
4811 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004812 PyObject *res;
4813
4814 if (meth == NULL)
4815 return -1;
4816 res = PyObject_Call(meth, args, kwds);
4817 Py_DECREF(meth);
4818 if (res == NULL)
4819 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00004820 if (res != Py_None) {
4821 PyErr_SetString(PyExc_TypeError,
4822 "__init__() should return None");
4823 Py_DECREF(res);
4824 return -1;
4825 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004826 Py_DECREF(res);
4827 return 0;
4828}
4829
4830static PyObject *
4831slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4832{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004833 static PyObject *new_str;
4834 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004835 PyObject *newargs, *x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004836 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004837
Guido van Rossum7bed2132002-08-08 21:57:53 +00004838 if (new_str == NULL) {
4839 new_str = PyString_InternFromString("__new__");
4840 if (new_str == NULL)
4841 return NULL;
4842 }
4843 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004844 if (func == NULL)
4845 return NULL;
4846 assert(PyTuple_Check(args));
4847 n = PyTuple_GET_SIZE(args);
4848 newargs = PyTuple_New(n+1);
4849 if (newargs == NULL)
4850 return NULL;
4851 Py_INCREF(type);
4852 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4853 for (i = 0; i < n; i++) {
4854 x = PyTuple_GET_ITEM(args, i);
4855 Py_INCREF(x);
4856 PyTuple_SET_ITEM(newargs, i+1, x);
4857 }
4858 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004859 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004860 Py_DECREF(func);
4861 return x;
4862}
4863
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004864static void
4865slot_tp_del(PyObject *self)
4866{
4867 static PyObject *del_str = NULL;
4868 PyObject *del, *res;
4869 PyObject *error_type, *error_value, *error_traceback;
4870
4871 /* Temporarily resurrect the object. */
4872 assert(self->ob_refcnt == 0);
4873 self->ob_refcnt = 1;
4874
4875 /* Save the current exception, if any. */
4876 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4877
4878 /* Execute __del__ method, if any. */
4879 del = lookup_maybe(self, "__del__", &del_str);
4880 if (del != NULL) {
4881 res = PyEval_CallObject(del, NULL);
4882 if (res == NULL)
4883 PyErr_WriteUnraisable(del);
4884 else
4885 Py_DECREF(res);
4886 Py_DECREF(del);
4887 }
4888
4889 /* Restore the saved exception. */
4890 PyErr_Restore(error_type, error_value, error_traceback);
4891
4892 /* Undo the temporary resurrection; can't use DECREF here, it would
4893 * cause a recursive call.
4894 */
4895 assert(self->ob_refcnt > 0);
4896 if (--self->ob_refcnt == 0)
4897 return; /* this is the normal path out */
4898
4899 /* __del__ resurrected it! Make it look like the original Py_DECREF
4900 * never happened.
4901 */
4902 {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004903 Py_ssize_t refcnt = self->ob_refcnt;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004904 _Py_NewReference(self);
4905 self->ob_refcnt = refcnt;
4906 }
4907 assert(!PyType_IS_GC(self->ob_type) ||
4908 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00004909 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
4910 * we need to undo that. */
4911 _Py_DEC_REFTOTAL;
4912 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
4913 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004914 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
4915 * _Py_NewReference bumped tp_allocs: both of those need to be
4916 * undone.
4917 */
4918#ifdef COUNT_ALLOCS
4919 --self->ob_type->tp_frees;
4920 --self->ob_type->tp_allocs;
4921#endif
4922}
4923
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004924
4925/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00004926 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00004927 structure, which incorporates the additional structures used for numbers,
4928 sequences and mappings.
4929 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004930 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00004931 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
4932 terminated with an all-zero entry. (This table is further initialized and
4933 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004934
Guido van Rossum6d204072001-10-21 00:44:31 +00004935typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004936
4937#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00004938#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004939#undef ETSLOT
4940#undef SQSLOT
4941#undef MPSLOT
4942#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00004943#undef UNSLOT
4944#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004945#undef BINSLOT
4946#undef RBINSLOT
4947
Guido van Rossum6d204072001-10-21 00:44:31 +00004948#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004949 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
4950 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00004951#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
4952 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004953 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00004954#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00004955 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004956 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00004957#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4958 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
4959#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4960 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
4961#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4962 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
4963#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4964 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4965 "x." NAME "() <==> " DOC)
4966#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4967 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4968 "x." NAME "(y) <==> x" DOC "y")
4969#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
4970 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4971 "x." NAME "(y) <==> x" DOC "y")
4972#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
4973 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4974 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00004975#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4976 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4977 "x." NAME "(y) <==> " DOC)
4978#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4979 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4980 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004981
4982static slotdef slotdefs[] = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00004983 SQSLOT("__len__", sq_length, slot_sq_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00004984 "x.__len__() <==> len(x)"),
Armin Rigofd163f92005-12-29 15:59:19 +00004985 /* Heap types defining __add__/__mul__ have sq_concat/sq_repeat == NULL.
4986 The logic in abstract.c always falls back to nb_add/nb_multiply in
4987 this case. Defining both the nb_* and the sq_* slots to call the
4988 user-defined methods has unexpected side-effects, as shown by
4989 test_descr.notimplemented() */
4990 SQSLOT("__add__", sq_concat, NULL, wrap_binaryfunc,
4991 "x.__add__(y) <==> x+y"),
Armin Rigo314861c2006-03-30 14:04:02 +00004992 SQSLOT("__mul__", sq_repeat, NULL, wrap_indexargfunc,
Armin Rigofd163f92005-12-29 15:59:19 +00004993 "x.__mul__(n) <==> x*n"),
Armin Rigo314861c2006-03-30 14:04:02 +00004994 SQSLOT("__rmul__", sq_repeat, NULL, wrap_indexargfunc,
Armin Rigofd163f92005-12-29 15:59:19 +00004995 "x.__rmul__(n) <==> n*x"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004996 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
4997 "x.__getitem__(y) <==> x[y]"),
Martin v. Löwis18e16552006-02-15 17:27:45 +00004998 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_ssizessizeargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00004999 "x.__getslice__(i, j) <==> x[i:j]\n\
5000 \n\
5001 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005002 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005003 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005004 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005005 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005006 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Martin v. Löwis18e16552006-02-15 17:27:45 +00005007 wrap_ssizessizeobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00005008 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
5009 \n\
5010 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005011 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00005012 "x.__delslice__(i, j) <==> del x[i:j]\n\
5013 \n\
5014 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005015 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
5016 "x.__contains__(y) <==> y in x"),
Armin Rigofd163f92005-12-29 15:59:19 +00005017 SQSLOT("__iadd__", sq_inplace_concat, NULL,
5018 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
5019 SQSLOT("__imul__", sq_inplace_repeat, NULL,
Armin Rigo314861c2006-03-30 14:04:02 +00005020 wrap_indexargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005021
Martin v. Löwis18e16552006-02-15 17:27:45 +00005022 MPSLOT("__len__", mp_length, slot_mp_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005023 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00005024 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005025 wrap_binaryfunc,
5026 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005027 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005028 wrap_objobjargproc,
5029 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005030 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005031 wrap_delitem,
5032 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005033
Guido van Rossum6d204072001-10-21 00:44:31 +00005034 BINSLOT("__add__", nb_add, slot_nb_add,
5035 "+"),
5036 RBINSLOT("__radd__", nb_add, slot_nb_add,
5037 "+"),
5038 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
5039 "-"),
5040 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
5041 "-"),
5042 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
5043 "*"),
5044 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
5045 "*"),
5046 BINSLOT("__div__", nb_divide, slot_nb_divide,
5047 "/"),
5048 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
5049 "/"),
5050 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
5051 "%"),
5052 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
5053 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00005054 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005055 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00005056 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005057 "divmod(y, x)"),
5058 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
5059 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
5060 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
5061 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
5062 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
5063 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
5064 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
5065 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00005066 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00005067 "x != 0"),
5068 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5069 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5070 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5071 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5072 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5073 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5074 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5075 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5076 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5077 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5078 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5079 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5080 "x.__coerce__(y) <==> coerce(x, y)"),
5081 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5082 "int(x)"),
5083 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5084 "long(x)"),
5085 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5086 "float(x)"),
5087 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5088 "oct(x)"),
5089 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5090 "hex(x)"),
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005091 NBSLOT("__index__", nb_index, slot_nb_index, wrap_lenfunc,
5092 "x[y:z] <==> x[y.__index__():z.__index__()]"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005093 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5094 wrap_binaryfunc, "+"),
5095 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5096 wrap_binaryfunc, "-"),
5097 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5098 wrap_binaryfunc, "*"),
5099 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5100 wrap_binaryfunc, "/"),
5101 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5102 wrap_binaryfunc, "%"),
5103 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005104 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005105 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5106 wrap_binaryfunc, "<<"),
5107 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5108 wrap_binaryfunc, ">>"),
5109 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5110 wrap_binaryfunc, "&"),
5111 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5112 wrap_binaryfunc, "^"),
5113 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5114 wrap_binaryfunc, "|"),
5115 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5116 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5117 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5118 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5119 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5120 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5121 IBSLOT("__itruediv__", nb_inplace_true_divide,
5122 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005123
Guido van Rossum6d204072001-10-21 00:44:31 +00005124 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5125 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005126 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005127 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5128 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005129 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005130 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5131 "x.__cmp__(y) <==> cmp(x,y)"),
5132 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5133 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005134 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5135 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005136 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005137 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5138 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5139 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5140 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5141 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5142 "x.__setattr__('name', value) <==> x.name = value"),
5143 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5144 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5145 "x.__delattr__('name') <==> del x.name"),
5146 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5147 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5148 "x.__lt__(y) <==> x<y"),
5149 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5150 "x.__le__(y) <==> x<=y"),
5151 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5152 "x.__eq__(y) <==> x==y"),
5153 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5154 "x.__ne__(y) <==> x!=y"),
5155 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5156 "x.__gt__(y) <==> x>y"),
5157 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5158 "x.__ge__(y) <==> x>=y"),
5159 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5160 "x.__iter__() <==> iter(x)"),
5161 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5162 "x.next() -> the next value, or raise StopIteration"),
5163 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5164 "descr.__get__(obj[, type]) -> value"),
5165 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5166 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005167 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5168 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005169 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005170 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005171 "see x.__class__.__doc__ for signature",
5172 PyWrapperFlag_KEYWORDS),
5173 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005174 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005175 {NULL}
5176};
5177
Guido van Rossumc334df52002-04-04 23:44:47 +00005178/* Given a type pointer and an offset gotten from a slotdef entry, return a
5179 pointer to the actual slot. This is not quite the same as simply adding
5180 the offset to the type pointer, since it takes care to indirect through the
5181 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5182 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005183static void **
Martin v. Löwis18e16552006-02-15 17:27:45 +00005184slotptr(PyTypeObject *type, int ioffset)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005185{
5186 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005187 long offset = ioffset;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005188
Guido van Rossume5c691a2003-03-07 15:13:17 +00005189 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005190 assert(offset >= 0);
Guido van Rossume5c691a2003-03-07 15:13:17 +00005191 assert(offset < offsetof(PyHeapTypeObject, as_buffer));
5192 if (offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005193 ptr = (char *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005194 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005195 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005196 else if (offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005197 ptr = (char *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005198 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005199 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005200 else if (offset >= offsetof(PyHeapTypeObject, as_number)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005201 ptr = (char *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005202 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005203 }
5204 else {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005205 ptr = (char *)type;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005206 }
5207 if (ptr != NULL)
5208 ptr += offset;
5209 return (void **)ptr;
5210}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005211
Guido van Rossumc334df52002-04-04 23:44:47 +00005212/* Length of array of slotdef pointers used to store slots with the
5213 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5214 the same __name__, for any __name__. Since that's a static property, it is
5215 appropriate to declare fixed-size arrays for this. */
5216#define MAX_EQUIV 10
5217
5218/* Return a slot pointer for a given name, but ONLY if the attribute has
5219 exactly one slot function. The name must be an interned string. */
5220static void **
5221resolve_slotdups(PyTypeObject *type, PyObject *name)
5222{
5223 /* XXX Maybe this could be optimized more -- but is it worth it? */
5224
5225 /* pname and ptrs act as a little cache */
5226 static PyObject *pname;
5227 static slotdef *ptrs[MAX_EQUIV];
5228 slotdef *p, **pp;
5229 void **res, **ptr;
5230
5231 if (pname != name) {
5232 /* Collect all slotdefs that match name into ptrs. */
5233 pname = name;
5234 pp = ptrs;
5235 for (p = slotdefs; p->name_strobj; p++) {
5236 if (p->name_strobj == name)
5237 *pp++ = p;
5238 }
5239 *pp = NULL;
5240 }
5241
5242 /* Look in all matching slots of the type; if exactly one of these has
5243 a filled-in slot, return its value. Otherwise return NULL. */
5244 res = NULL;
5245 for (pp = ptrs; *pp; pp++) {
5246 ptr = slotptr(type, (*pp)->offset);
5247 if (ptr == NULL || *ptr == NULL)
5248 continue;
5249 if (res != NULL)
5250 return NULL;
5251 res = ptr;
5252 }
5253 return res;
5254}
5255
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005256/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005257 does some incredibly complex thinking and then sticks something into the
5258 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5259 interests, and then stores a generic wrapper or a specific function into
5260 the slot.) Return a pointer to the next slotdef with a different offset,
5261 because that's convenient for fixup_slot_dispatchers(). */
5262static slotdef *
5263update_one_slot(PyTypeObject *type, slotdef *p)
5264{
5265 PyObject *descr;
5266 PyWrapperDescrObject *d;
5267 void *generic = NULL, *specific = NULL;
5268 int use_generic = 0;
5269 int offset = p->offset;
5270 void **ptr = slotptr(type, offset);
5271
5272 if (ptr == NULL) {
5273 do {
5274 ++p;
5275 } while (p->offset == offset);
5276 return p;
5277 }
5278 do {
5279 descr = _PyType_Lookup(type, p->name_strobj);
5280 if (descr == NULL)
5281 continue;
5282 if (descr->ob_type == &PyWrapperDescr_Type) {
5283 void **tptr = resolve_slotdups(type, p->name_strobj);
5284 if (tptr == NULL || tptr == ptr)
5285 generic = p->function;
5286 d = (PyWrapperDescrObject *)descr;
5287 if (d->d_base->wrapper == p->wrapper &&
5288 PyType_IsSubtype(type, d->d_type))
5289 {
5290 if (specific == NULL ||
5291 specific == d->d_wrapped)
5292 specific = d->d_wrapped;
5293 else
5294 use_generic = 1;
5295 }
5296 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005297 else if (descr->ob_type == &PyCFunction_Type &&
5298 PyCFunction_GET_FUNCTION(descr) ==
5299 (PyCFunction)tp_new_wrapper &&
5300 strcmp(p->name, "__new__") == 0)
5301 {
5302 /* The __new__ wrapper is not a wrapper descriptor,
5303 so must be special-cased differently.
5304 If we don't do this, creating an instance will
5305 always use slot_tp_new which will look up
5306 __new__ in the MRO which will call tp_new_wrapper
5307 which will look through the base classes looking
5308 for a static base and call its tp_new (usually
5309 PyType_GenericNew), after performing various
5310 sanity checks and constructing a new argument
5311 list. Cut all that nonsense short -- this speeds
5312 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005313 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005314 /* XXX I'm not 100% sure that there isn't a hole
5315 in this reasoning that requires additional
5316 sanity checks. I'll buy the first person to
5317 point out a bug in this reasoning a beer. */
5318 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005319 else {
5320 use_generic = 1;
5321 generic = p->function;
5322 }
5323 } while ((++p)->offset == offset);
5324 if (specific && !use_generic)
5325 *ptr = specific;
5326 else
5327 *ptr = generic;
5328 return p;
5329}
5330
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005331/* In the type, update the slots whose slotdefs are gathered in the pp array.
5332 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005333static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005334update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005335{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005336 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005337
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005338 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005339 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005340 return 0;
5341}
5342
Guido van Rossumc334df52002-04-04 23:44:47 +00005343/* Comparison function for qsort() to compare slotdefs by their offset, and
5344 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005345static int
5346slotdef_cmp(const void *aa, const void *bb)
5347{
5348 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5349 int c = a->offset - b->offset;
5350 if (c != 0)
5351 return c;
5352 else
Martin v. Löwis18e16552006-02-15 17:27:45 +00005353 /* Cannot use a-b, as this gives off_t,
5354 which may lose precision when converted to int. */
5355 return (a > b) ? 1 : (a < b) ? -1 : 0;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005356}
5357
Guido van Rossumc334df52002-04-04 23:44:47 +00005358/* Initialize the slotdefs table by adding interned string objects for the
5359 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005360static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005361init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005362{
5363 slotdef *p;
5364 static int initialized = 0;
5365
5366 if (initialized)
5367 return;
5368 for (p = slotdefs; p->name; p++) {
5369 p->name_strobj = PyString_InternFromString(p->name);
5370 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005371 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005372 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005373 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5374 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005375 initialized = 1;
5376}
5377
Guido van Rossumc334df52002-04-04 23:44:47 +00005378/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005379static int
5380update_slot(PyTypeObject *type, PyObject *name)
5381{
Guido van Rossumc334df52002-04-04 23:44:47 +00005382 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005383 slotdef *p;
5384 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005385 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005386
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005387 init_slotdefs();
5388 pp = ptrs;
5389 for (p = slotdefs; p->name; p++) {
5390 /* XXX assume name is interned! */
5391 if (p->name_strobj == name)
5392 *pp++ = p;
5393 }
5394 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005395 for (pp = ptrs; *pp; pp++) {
5396 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005397 offset = p->offset;
5398 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005399 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005400 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005401 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005402 if (ptrs[0] == NULL)
5403 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005404 return update_subclasses(type, name,
5405 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005406}
5407
Guido van Rossumc334df52002-04-04 23:44:47 +00005408/* Store the proper functions in the slot dispatches at class (type)
5409 definition time, based upon which operations the class overrides in its
5410 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005411static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005412fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005413{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005414 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005415
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005416 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005417 for (p = slotdefs; p->name; )
5418 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005419}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005420
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005421static void
5422update_all_slots(PyTypeObject* type)
5423{
5424 slotdef *p;
5425
5426 init_slotdefs();
5427 for (p = slotdefs; p->name; p++) {
5428 /* update_slot returns int but can't actually fail */
5429 update_slot(type, p->name_strobj);
5430 }
5431}
5432
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005433/* recurse_down_subclasses() and update_subclasses() are mutually
5434 recursive functions to call a callback for all subclasses,
5435 but refraining from recursing into subclasses that define 'name'. */
5436
5437static int
5438update_subclasses(PyTypeObject *type, PyObject *name,
5439 update_callback callback, void *data)
5440{
5441 if (callback(type, data) < 0)
5442 return -1;
5443 return recurse_down_subclasses(type, name, callback, data);
5444}
5445
5446static int
5447recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5448 update_callback callback, void *data)
5449{
5450 PyTypeObject *subclass;
5451 PyObject *ref, *subclasses, *dict;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005452 Py_ssize_t i, n;
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005453
5454 subclasses = type->tp_subclasses;
5455 if (subclasses == NULL)
5456 return 0;
5457 assert(PyList_Check(subclasses));
5458 n = PyList_GET_SIZE(subclasses);
5459 for (i = 0; i < n; i++) {
5460 ref = PyList_GET_ITEM(subclasses, i);
5461 assert(PyWeakref_CheckRef(ref));
5462 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5463 assert(subclass != NULL);
5464 if ((PyObject *)subclass == Py_None)
5465 continue;
5466 assert(PyType_Check(subclass));
5467 /* Avoid recursing down into unaffected classes */
5468 dict = subclass->tp_dict;
5469 if (dict != NULL && PyDict_Check(dict) &&
5470 PyDict_GetItem(dict, name) != NULL)
5471 continue;
5472 if (update_subclasses(subclass, name, callback, data) < 0)
5473 return -1;
5474 }
5475 return 0;
5476}
5477
Guido van Rossum6d204072001-10-21 00:44:31 +00005478/* This function is called by PyType_Ready() to populate the type's
5479 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005480 function slot (like tp_repr) that's defined in the type, one or more
5481 corresponding descriptors are added in the type's tp_dict dictionary
5482 under the appropriate name (like __repr__). Some function slots
5483 cause more than one descriptor to be added (for example, the nb_add
5484 slot adds both __add__ and __radd__ descriptors) and some function
5485 slots compete for the same descriptor (for example both sq_item and
5486 mp_subscript generate a __getitem__ descriptor).
5487
5488 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005489 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005490 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005491 between competing slots: the members of PyHeapTypeObject are listed
5492 from most general to least general, so the most general slot is
5493 preferred. In particular, because as_mapping comes before as_sequence,
5494 for a type that defines both mp_subscript and sq_item, mp_subscript
5495 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005496
5497 This only adds new descriptors and doesn't overwrite entries in
5498 tp_dict that were previously defined. The descriptors contain a
5499 reference to the C function they must call, so that it's safe if they
5500 are copied into a subtype's __dict__ and the subtype has a different
5501 C function in its slot -- calling the method defined by the
5502 descriptor will call the C function that was used to create it,
5503 rather than the C function present in the slot when it is called.
5504 (This is important because a subtype may have a C function in the
5505 slot that calls the method from the dictionary, and we want to avoid
5506 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005507
5508static int
5509add_operators(PyTypeObject *type)
5510{
5511 PyObject *dict = type->tp_dict;
5512 slotdef *p;
5513 PyObject *descr;
5514 void **ptr;
5515
5516 init_slotdefs();
5517 for (p = slotdefs; p->name; p++) {
5518 if (p->wrapper == NULL)
5519 continue;
5520 ptr = slotptr(type, p->offset);
5521 if (!ptr || !*ptr)
5522 continue;
5523 if (PyDict_GetItem(dict, p->name_strobj))
5524 continue;
5525 descr = PyDescr_NewWrapper(type, p, *ptr);
5526 if (descr == NULL)
5527 return -1;
5528 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5529 return -1;
5530 Py_DECREF(descr);
5531 }
5532 if (type->tp_new != NULL) {
5533 if (add_tp_new_wrapper(type) < 0)
5534 return -1;
5535 }
5536 return 0;
5537}
5538
Guido van Rossum705f0f52001-08-24 16:47:00 +00005539
5540/* Cooperative 'super' */
5541
5542typedef struct {
5543 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005544 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005545 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005546 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005547} superobject;
5548
Guido van Rossum6f799372001-09-20 20:46:19 +00005549static PyMemberDef super_members[] = {
5550 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5551 "the class invoking super()"},
5552 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5553 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005554 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005555 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005556 {0}
5557};
5558
Guido van Rossum705f0f52001-08-24 16:47:00 +00005559static void
5560super_dealloc(PyObject *self)
5561{
5562 superobject *su = (superobject *)self;
5563
Guido van Rossum048eb752001-10-02 21:24:57 +00005564 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005565 Py_XDECREF(su->obj);
5566 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005567 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005568 self->ob_type->tp_free(self);
5569}
5570
5571static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005572super_repr(PyObject *self)
5573{
5574 superobject *su = (superobject *)self;
5575
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005576 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005577 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005578 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005579 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005580 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005581 else
5582 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005583 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005584 su->type ? su->type->tp_name : "NULL");
5585}
5586
5587static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005588super_getattro(PyObject *self, PyObject *name)
5589{
5590 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005591 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005592
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005593 if (!skip) {
5594 /* We want __class__ to return the class of the super object
5595 (i.e. super, or a subclass), not the class of su->obj. */
5596 skip = (PyString_Check(name) &&
5597 PyString_GET_SIZE(name) == 9 &&
5598 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5599 }
5600
5601 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005602 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005603 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005604 descrgetfunc f;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005605 Py_ssize_t i, n;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005606
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005607 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005608 mro = starttype->tp_mro;
5609
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005610 if (mro == NULL)
5611 n = 0;
5612 else {
5613 assert(PyTuple_Check(mro));
5614 n = PyTuple_GET_SIZE(mro);
5615 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005616 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005617 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005618 break;
5619 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005620 i++;
5621 res = NULL;
5622 for (; i < n; i++) {
5623 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005624 if (PyType_Check(tmp))
5625 dict = ((PyTypeObject *)tmp)->tp_dict;
5626 else if (PyClass_Check(tmp))
5627 dict = ((PyClassObject *)tmp)->cl_dict;
5628 else
5629 continue;
5630 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005631 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005632 Py_INCREF(res);
5633 f = res->ob_type->tp_descr_get;
5634 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005635 tmp = f(res,
5636 /* Only pass 'obj' param if
5637 this is instance-mode super
5638 (See SF ID #743627)
5639 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00005640 (su->obj == (PyObject *)
5641 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005642 ? (PyObject *)NULL
5643 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00005644 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005645 Py_DECREF(res);
5646 res = tmp;
5647 }
5648 return res;
5649 }
5650 }
5651 }
5652 return PyObject_GenericGetAttr(self, name);
5653}
5654
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005655static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005656supercheck(PyTypeObject *type, PyObject *obj)
5657{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005658 /* Check that a super() call makes sense. Return a type object.
5659
5660 obj can be a new-style class, or an instance of one:
5661
5662 - If it is a class, it must be a subclass of 'type'. This case is
5663 used for class methods; the return value is obj.
5664
5665 - If it is an instance, it must be an instance of 'type'. This is
5666 the normal case; the return value is obj.__class__.
5667
5668 But... when obj is an instance, we want to allow for the case where
5669 obj->ob_type is not a subclass of type, but obj.__class__ is!
5670 This will allow using super() with a proxy for obj.
5671 */
5672
Guido van Rossum8e80a722003-02-18 19:22:22 +00005673 /* Check for first bullet above (special case) */
5674 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5675 Py_INCREF(obj);
5676 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005677 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005678
5679 /* Normal case */
5680 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005681 Py_INCREF(obj->ob_type);
5682 return obj->ob_type;
5683 }
5684 else {
5685 /* Try the slow way */
5686 static PyObject *class_str = NULL;
5687 PyObject *class_attr;
5688
5689 if (class_str == NULL) {
5690 class_str = PyString_FromString("__class__");
5691 if (class_str == NULL)
5692 return NULL;
5693 }
5694
5695 class_attr = PyObject_GetAttr(obj, class_str);
5696
5697 if (class_attr != NULL &&
5698 PyType_Check(class_attr) &&
5699 (PyTypeObject *)class_attr != obj->ob_type)
5700 {
5701 int ok = PyType_IsSubtype(
5702 (PyTypeObject *)class_attr, type);
5703 if (ok)
5704 return (PyTypeObject *)class_attr;
5705 }
5706
5707 if (class_attr == NULL)
5708 PyErr_Clear();
5709 else
5710 Py_DECREF(class_attr);
5711 }
5712
Tim Peters97e5ff52003-02-18 19:32:50 +00005713 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005714 "super(type, obj): "
5715 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005716 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005717}
5718
Guido van Rossum705f0f52001-08-24 16:47:00 +00005719static PyObject *
5720super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5721{
5722 superobject *su = (superobject *)self;
Anthony Baxtera6286212006-04-11 07:42:36 +00005723 superobject *newobj;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005724
5725 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5726 /* Not binding to an object, or already bound */
5727 Py_INCREF(self);
5728 return self;
5729 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005730 if (su->ob_type != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00005731 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005732 call its type */
5733 return PyObject_CallFunction((PyObject *)su->ob_type,
5734 "OO", su->type, obj);
5735 else {
5736 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005737 PyTypeObject *obj_type = supercheck(su->type, obj);
5738 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005739 return NULL;
Anthony Baxtera6286212006-04-11 07:42:36 +00005740 newobj = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005741 NULL, NULL);
Anthony Baxtera6286212006-04-11 07:42:36 +00005742 if (newobj == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005743 return NULL;
5744 Py_INCREF(su->type);
5745 Py_INCREF(obj);
Anthony Baxtera6286212006-04-11 07:42:36 +00005746 newobj->type = su->type;
5747 newobj->obj = obj;
5748 newobj->obj_type = obj_type;
5749 return (PyObject *)newobj;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005750 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005751}
5752
5753static int
5754super_init(PyObject *self, PyObject *args, PyObject *kwds)
5755{
5756 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005757 PyTypeObject *type;
5758 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005759 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005760
5761 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5762 return -1;
5763 if (obj == Py_None)
5764 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005765 if (obj != NULL) {
5766 obj_type = supercheck(type, obj);
5767 if (obj_type == NULL)
5768 return -1;
5769 Py_INCREF(obj);
5770 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005771 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005772 su->type = type;
5773 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005774 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005775 return 0;
5776}
5777
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005778PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005779"super(type) -> unbound super object\n"
5780"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005781"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005782"Typical use to call a cooperative superclass method:\n"
5783"class C(B):\n"
5784" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005785" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005786
Guido van Rossum048eb752001-10-02 21:24:57 +00005787static int
5788super_traverse(PyObject *self, visitproc visit, void *arg)
5789{
5790 superobject *su = (superobject *)self;
Guido van Rossum048eb752001-10-02 21:24:57 +00005791
Thomas Woutersc6e55062006-04-15 21:47:09 +00005792 Py_VISIT(su->obj);
5793 Py_VISIT(su->type);
5794 Py_VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005795
5796 return 0;
5797}
5798
Guido van Rossum705f0f52001-08-24 16:47:00 +00005799PyTypeObject PySuper_Type = {
5800 PyObject_HEAD_INIT(&PyType_Type)
5801 0, /* ob_size */
5802 "super", /* tp_name */
5803 sizeof(superobject), /* tp_basicsize */
5804 0, /* tp_itemsize */
5805 /* methods */
5806 super_dealloc, /* tp_dealloc */
5807 0, /* tp_print */
5808 0, /* tp_getattr */
5809 0, /* tp_setattr */
5810 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005811 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005812 0, /* tp_as_number */
5813 0, /* tp_as_sequence */
5814 0, /* tp_as_mapping */
5815 0, /* tp_hash */
5816 0, /* tp_call */
5817 0, /* tp_str */
5818 super_getattro, /* tp_getattro */
5819 0, /* tp_setattro */
5820 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005821 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5822 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005823 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00005824 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005825 0, /* tp_clear */
5826 0, /* tp_richcompare */
5827 0, /* tp_weaklistoffset */
5828 0, /* tp_iter */
5829 0, /* tp_iternext */
5830 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005831 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005832 0, /* tp_getset */
5833 0, /* tp_base */
5834 0, /* tp_dict */
5835 super_descr_get, /* tp_descr_get */
5836 0, /* tp_descr_set */
5837 0, /* tp_dictoffset */
5838 super_init, /* tp_init */
5839 PyType_GenericAlloc, /* tp_alloc */
5840 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00005841 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005842};