blob: 0881ab1f4cb617d86d8809e2b35c4bb078de2d5d [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;
Skip Montanaro429433b2006-04-18 00:35:43 +00001121 while (PyDict_Next(set, &i, &k, &v) && (size_t)off < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001122 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);
Skip Montanaro429433b2006-04-18 00:35:43 +00001126 if (--n && (size_t)(off+1) < sizeof(buf)) {
Guido van Rossum98f33732002-11-25 21:36:54 +00001127 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 Rossuma3862092002-06-10 15:24:42 +00002216 /* Because of type_is_gc(), the collector only calls this
2217 for heaptypes. */
2218 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002219
Guido van Rossuma3862092002-06-10 15:24:42 +00002220 /* The only field we need to clear is tp_mro, which is part of a
2221 hard cycle (its first element is the class itself) that won't
2222 be broken otherwise (it's a tuple and tuples don't have a
2223 tp_clear handler). None of the other fields need to be
2224 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002225
Guido van Rossuma3862092002-06-10 15:24:42 +00002226 tp_dict:
2227 It is a dict, so the collector will call its tp_clear.
2228
2229 tp_cache:
2230 Not used; if it were, it would be a dict.
2231
2232 tp_bases, tp_base:
2233 If these are involved in a cycle, there must be at least
2234 one other, mutable object in the cycle, e.g. a base
2235 class's dict; the cycle will be broken that way.
2236
2237 tp_subclasses:
2238 A list of weak references can't be part of a cycle; and
2239 lists have their own tp_clear.
2240
Guido van Rossume5c691a2003-03-07 15:13:17 +00002241 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002242 A tuple of strings can't be part of a cycle.
2243 */
2244
Thomas Woutersedf17d82006-04-15 17:28:34 +00002245 Py_CLEAR(type->tp_mro);
Guido van Rossum048eb752001-10-02 21:24:57 +00002246
2247 return 0;
2248}
2249
2250static int
2251type_is_gc(PyTypeObject *type)
2252{
2253 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2254}
2255
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002256PyTypeObject PyType_Type = {
2257 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002258 0, /* ob_size */
2259 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002260 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002261 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002262 (destructor)type_dealloc, /* tp_dealloc */
2263 0, /* tp_print */
2264 0, /* tp_getattr */
2265 0, /* tp_setattr */
2266 type_compare, /* tp_compare */
2267 (reprfunc)type_repr, /* tp_repr */
2268 0, /* tp_as_number */
2269 0, /* tp_as_sequence */
2270 0, /* tp_as_mapping */
2271 (hashfunc)_Py_HashPointer, /* tp_hash */
2272 (ternaryfunc)type_call, /* tp_call */
2273 0, /* tp_str */
2274 (getattrofunc)type_getattro, /* tp_getattro */
2275 (setattrofunc)type_setattro, /* tp_setattro */
2276 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002277 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
2278 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002279 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002280 (traverseproc)type_traverse, /* tp_traverse */
2281 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002282 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002283 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002284 0, /* tp_iter */
2285 0, /* tp_iternext */
2286 type_methods, /* tp_methods */
2287 type_members, /* tp_members */
2288 type_getsets, /* tp_getset */
2289 0, /* tp_base */
2290 0, /* tp_dict */
2291 0, /* tp_descr_get */
2292 0, /* tp_descr_set */
2293 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
2294 0, /* tp_init */
2295 0, /* tp_alloc */
2296 type_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002297 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002298 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002299};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002300
2301
2302/* The base type of all types (eventually)... except itself. */
2303
2304static int
2305object_init(PyObject *self, PyObject *args, PyObject *kwds)
2306{
2307 return 0;
2308}
2309
Guido van Rossum298e4212003-02-13 16:30:16 +00002310/* If we don't have a tp_new for a new-style class, new will use this one.
2311 Therefore this should take no arguments/keywords. However, this new may
2312 also be inherited by objects that define a tp_init but no tp_new. These
2313 objects WILL pass argumets to tp_new, because it gets the same args as
2314 tp_init. So only allow arguments if we aren't using the default init, in
2315 which case we expect init to handle argument parsing. */
2316static PyObject *
2317object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2318{
2319 if (type->tp_init == object_init && (PyTuple_GET_SIZE(args) ||
2320 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds)))) {
2321 PyErr_SetString(PyExc_TypeError,
2322 "default __new__ takes no parameters");
2323 return NULL;
2324 }
2325 return type->tp_alloc(type, 0);
2326}
2327
Tim Peters6d6c1a32001-08-02 04:15:00 +00002328static void
2329object_dealloc(PyObject *self)
2330{
2331 self->ob_type->tp_free(self);
2332}
2333
Guido van Rossum8e248182001-08-12 05:17:56 +00002334static PyObject *
2335object_repr(PyObject *self)
2336{
Guido van Rossum76e69632001-08-16 18:52:43 +00002337 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002338 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002339
Guido van Rossum76e69632001-08-16 18:52:43 +00002340 type = self->ob_type;
2341 mod = type_module(type, NULL);
2342 if (mod == NULL)
2343 PyErr_Clear();
2344 else if (!PyString_Check(mod)) {
2345 Py_DECREF(mod);
2346 mod = NULL;
2347 }
2348 name = type_name(type, NULL);
2349 if (name == NULL)
2350 return NULL;
2351 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002352 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002353 PyString_AS_STRING(mod),
2354 PyString_AS_STRING(name),
2355 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002356 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002357 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002358 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002359 Py_XDECREF(mod);
2360 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002361 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002362}
2363
Guido van Rossumb8f63662001-08-15 23:57:02 +00002364static PyObject *
2365object_str(PyObject *self)
2366{
2367 unaryfunc f;
2368
2369 f = self->ob_type->tp_repr;
2370 if (f == NULL)
2371 f = object_repr;
2372 return f(self);
2373}
2374
Guido van Rossum8e248182001-08-12 05:17:56 +00002375static long
2376object_hash(PyObject *self)
2377{
2378 return _Py_HashPointer(self);
2379}
Guido van Rossum8e248182001-08-12 05:17:56 +00002380
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002381static PyObject *
2382object_get_class(PyObject *self, void *closure)
2383{
2384 Py_INCREF(self->ob_type);
2385 return (PyObject *)(self->ob_type);
2386}
2387
2388static int
2389equiv_structs(PyTypeObject *a, PyTypeObject *b)
2390{
2391 return a == b ||
2392 (a != NULL &&
2393 b != NULL &&
2394 a->tp_basicsize == b->tp_basicsize &&
2395 a->tp_itemsize == b->tp_itemsize &&
2396 a->tp_dictoffset == b->tp_dictoffset &&
2397 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2398 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2399 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2400}
2401
2402static int
2403same_slots_added(PyTypeObject *a, PyTypeObject *b)
2404{
2405 PyTypeObject *base = a->tp_base;
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002406 Py_ssize_t size;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002407
2408 if (base != b->tp_base)
2409 return 0;
2410 if (equiv_structs(a, base) && equiv_structs(b, base))
2411 return 1;
2412 size = base->tp_basicsize;
2413 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2414 size += sizeof(PyObject *);
2415 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2416 size += sizeof(PyObject *);
2417 return size == a->tp_basicsize && size == b->tp_basicsize;
2418}
2419
2420static int
Anthony Baxtera6286212006-04-11 07:42:36 +00002421compatible_for_assignment(PyTypeObject* oldto, PyTypeObject* newto, char* attr)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002422{
2423 PyTypeObject *newbase, *oldbase;
2424
Anthony Baxtera6286212006-04-11 07:42:36 +00002425 if (newto->tp_dealloc != oldto->tp_dealloc ||
2426 newto->tp_free != oldto->tp_free)
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002427 {
2428 PyErr_Format(PyExc_TypeError,
2429 "%s assignment: "
2430 "'%s' deallocator differs from '%s'",
2431 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002432 newto->tp_name,
2433 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002434 return 0;
2435 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002436 newbase = newto;
2437 oldbase = oldto;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002438 while (equiv_structs(newbase, newbase->tp_base))
2439 newbase = newbase->tp_base;
2440 while (equiv_structs(oldbase, oldbase->tp_base))
2441 oldbase = oldbase->tp_base;
2442 if (newbase != oldbase &&
2443 (newbase->tp_base != oldbase->tp_base ||
2444 !same_slots_added(newbase, oldbase))) {
2445 PyErr_Format(PyExc_TypeError,
2446 "%s assignment: "
2447 "'%s' object layout differs from '%s'",
2448 attr,
Anthony Baxtera6286212006-04-11 07:42:36 +00002449 newto->tp_name,
2450 oldto->tp_name);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002451 return 0;
2452 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002453
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002454 return 1;
2455}
2456
2457static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002458object_set_class(PyObject *self, PyObject *value, void *closure)
2459{
Anthony Baxtera6286212006-04-11 07:42:36 +00002460 PyTypeObject *oldto = self->ob_type;
2461 PyTypeObject *newto;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002462
Guido van Rossumb6b89422002-04-15 01:03:30 +00002463 if (value == NULL) {
2464 PyErr_SetString(PyExc_TypeError,
2465 "can't delete __class__ attribute");
2466 return -1;
2467 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002468 if (!PyType_Check(value)) {
2469 PyErr_Format(PyExc_TypeError,
2470 "__class__ must be set to new-style class, not '%s' object",
2471 value->ob_type->tp_name);
2472 return -1;
2473 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002474 newto = (PyTypeObject *)value;
2475 if (!(newto->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2476 !(oldto->tp_flags & Py_TPFLAGS_HEAPTYPE))
Guido van Rossum40af8892002-08-10 05:42:07 +00002477 {
2478 PyErr_Format(PyExc_TypeError,
2479 "__class__ assignment: only for heap types");
2480 return -1;
2481 }
Anthony Baxtera6286212006-04-11 07:42:36 +00002482 if (compatible_for_assignment(newto, oldto, "__class__")) {
2483 Py_INCREF(newto);
2484 self->ob_type = newto;
2485 Py_DECREF(oldto);
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002486 return 0;
2487 }
2488 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002489 return -1;
2490 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002491}
2492
2493static PyGetSetDef object_getsets[] = {
2494 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002495 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002496 {0}
2497};
2498
Guido van Rossumc53f0092003-02-18 22:05:12 +00002499
Guido van Rossum036f9992003-02-21 22:02:54 +00002500/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2501 We fall back to helpers in copy_reg for:
2502 - pickle protocols < 2
2503 - calculating the list of slot names (done only once per class)
2504 - the __newobj__ function (which is used as a token but never called)
2505*/
2506
2507static PyObject *
2508import_copy_reg(void)
2509{
2510 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002511
2512 if (!copy_reg_str) {
2513 copy_reg_str = PyString_InternFromString("copy_reg");
2514 if (copy_reg_str == NULL)
2515 return NULL;
2516 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002517
2518 return PyImport_Import(copy_reg_str);
2519}
2520
2521static PyObject *
2522slotnames(PyObject *cls)
2523{
2524 PyObject *clsdict;
2525 PyObject *copy_reg;
2526 PyObject *slotnames;
2527
2528 if (!PyType_Check(cls)) {
2529 Py_INCREF(Py_None);
2530 return Py_None;
2531 }
2532
2533 clsdict = ((PyTypeObject *)cls)->tp_dict;
2534 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
Armin Rigoec862b92005-09-24 22:58:41 +00002535 if (slotnames != NULL && PyList_Check(slotnames)) {
Guido van Rossum036f9992003-02-21 22:02:54 +00002536 Py_INCREF(slotnames);
2537 return slotnames;
2538 }
2539
2540 copy_reg = import_copy_reg();
2541 if (copy_reg == NULL)
2542 return NULL;
2543
2544 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2545 Py_DECREF(copy_reg);
2546 if (slotnames != NULL &&
2547 slotnames != Py_None &&
2548 !PyList_Check(slotnames))
2549 {
2550 PyErr_SetString(PyExc_TypeError,
2551 "copy_reg._slotnames didn't return a list or None");
2552 Py_DECREF(slotnames);
2553 slotnames = NULL;
2554 }
2555
2556 return slotnames;
2557}
2558
2559static PyObject *
2560reduce_2(PyObject *obj)
2561{
2562 PyObject *cls, *getnewargs;
2563 PyObject *args = NULL, *args2 = NULL;
2564 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2565 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2566 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
Martin v. Löwis18e16552006-02-15 17:27:45 +00002567 Py_ssize_t i, n;
Guido van Rossum036f9992003-02-21 22:02:54 +00002568
2569 cls = PyObject_GetAttrString(obj, "__class__");
2570 if (cls == NULL)
2571 return NULL;
2572
2573 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2574 if (getnewargs != NULL) {
2575 args = PyObject_CallObject(getnewargs, NULL);
2576 Py_DECREF(getnewargs);
2577 if (args != NULL && !PyTuple_Check(args)) {
2578 PyErr_SetString(PyExc_TypeError,
2579 "__getnewargs__ should return a tuple");
2580 goto end;
2581 }
2582 }
2583 else {
2584 PyErr_Clear();
2585 args = PyTuple_New(0);
2586 }
2587 if (args == NULL)
2588 goto end;
2589
2590 getstate = PyObject_GetAttrString(obj, "__getstate__");
2591 if (getstate != NULL) {
2592 state = PyObject_CallObject(getstate, NULL);
2593 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00002594 if (state == NULL)
2595 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00002596 }
2597 else {
Jim Fulton8a1a5942004-02-08 04:21:26 +00002598 PyErr_Clear();
Guido van Rossum036f9992003-02-21 22:02:54 +00002599 state = PyObject_GetAttrString(obj, "__dict__");
2600 if (state == NULL) {
2601 PyErr_Clear();
2602 state = Py_None;
2603 Py_INCREF(state);
2604 }
2605 names = slotnames(cls);
2606 if (names == NULL)
2607 goto end;
2608 if (names != Py_None) {
2609 assert(PyList_Check(names));
2610 slots = PyDict_New();
2611 if (slots == NULL)
2612 goto end;
2613 n = 0;
2614 /* Can't pre-compute the list size; the list
2615 is stored on the class so accessible to other
2616 threads, which may be run by DECREF */
2617 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2618 PyObject *name, *value;
2619 name = PyList_GET_ITEM(names, i);
2620 value = PyObject_GetAttr(obj, name);
2621 if (value == NULL)
2622 PyErr_Clear();
2623 else {
2624 int err = PyDict_SetItem(slots, name,
2625 value);
2626 Py_DECREF(value);
2627 if (err)
2628 goto end;
2629 n++;
2630 }
2631 }
2632 if (n) {
2633 state = Py_BuildValue("(NO)", state, slots);
2634 if (state == NULL)
2635 goto end;
2636 }
2637 }
2638 }
2639
2640 if (!PyList_Check(obj)) {
2641 listitems = Py_None;
2642 Py_INCREF(listitems);
2643 }
2644 else {
2645 listitems = PyObject_GetIter(obj);
2646 if (listitems == NULL)
2647 goto end;
2648 }
2649
2650 if (!PyDict_Check(obj)) {
2651 dictitems = Py_None;
2652 Py_INCREF(dictitems);
2653 }
2654 else {
2655 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2656 if (dictitems == NULL)
2657 goto end;
2658 }
2659
2660 copy_reg = import_copy_reg();
2661 if (copy_reg == NULL)
2662 goto end;
2663 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2664 if (newobj == NULL)
2665 goto end;
2666
2667 n = PyTuple_GET_SIZE(args);
2668 args2 = PyTuple_New(n+1);
2669 if (args2 == NULL)
2670 goto end;
2671 PyTuple_SET_ITEM(args2, 0, cls);
2672 cls = NULL;
2673 for (i = 0; i < n; i++) {
2674 PyObject *v = PyTuple_GET_ITEM(args, i);
2675 Py_INCREF(v);
2676 PyTuple_SET_ITEM(args2, i+1, v);
2677 }
2678
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002679 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00002680
2681 end:
2682 Py_XDECREF(cls);
2683 Py_XDECREF(args);
2684 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002685 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002686 Py_XDECREF(state);
2687 Py_XDECREF(names);
2688 Py_XDECREF(listitems);
2689 Py_XDECREF(dictitems);
2690 Py_XDECREF(copy_reg);
2691 Py_XDECREF(newobj);
2692 return res;
2693}
2694
2695static PyObject *
2696object_reduce_ex(PyObject *self, PyObject *args)
2697{
2698 /* Call copy_reg._reduce_ex(self, proto) */
2699 PyObject *reduce, *copy_reg, *res;
2700 int proto = 0;
2701
2702 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2703 return NULL;
2704
2705 reduce = PyObject_GetAttrString(self, "__reduce__");
2706 if (reduce == NULL)
2707 PyErr_Clear();
2708 else {
2709 PyObject *cls, *clsreduce, *objreduce;
2710 int override;
2711 cls = PyObject_GetAttrString(self, "__class__");
2712 if (cls == NULL) {
2713 Py_DECREF(reduce);
2714 return NULL;
2715 }
2716 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2717 Py_DECREF(cls);
2718 if (clsreduce == NULL) {
2719 Py_DECREF(reduce);
2720 return NULL;
2721 }
2722 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2723 "__reduce__");
2724 override = (clsreduce != objreduce);
2725 Py_DECREF(clsreduce);
2726 if (override) {
2727 res = PyObject_CallObject(reduce, NULL);
2728 Py_DECREF(reduce);
2729 return res;
2730 }
2731 else
2732 Py_DECREF(reduce);
2733 }
2734
2735 if (proto >= 2)
2736 return reduce_2(self);
2737
2738 copy_reg = import_copy_reg();
Guido van Rossum3926a632001-09-25 16:25:58 +00002739 if (!copy_reg)
2740 return NULL;
Guido van Rossum036f9992003-02-21 22:02:54 +00002741
Guido van Rossumc53f0092003-02-18 22:05:12 +00002742 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00002743 Py_DECREF(copy_reg);
Guido van Rossum036f9992003-02-21 22:02:54 +00002744
Guido van Rossum3926a632001-09-25 16:25:58 +00002745 return res;
2746}
2747
2748static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00002749 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
2750 PyDoc_STR("helper for pickle")},
2751 {"__reduce__", object_reduce_ex, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002752 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00002753 {0}
2754};
2755
Guido van Rossum036f9992003-02-21 22:02:54 +00002756
Tim Peters6d6c1a32001-08-02 04:15:00 +00002757PyTypeObject PyBaseObject_Type = {
2758 PyObject_HEAD_INIT(&PyType_Type)
2759 0, /* ob_size */
2760 "object", /* tp_name */
2761 sizeof(PyObject), /* tp_basicsize */
2762 0, /* tp_itemsize */
Georg Brandl347b3002006-03-30 11:57:00 +00002763 object_dealloc, /* tp_dealloc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002764 0, /* tp_print */
2765 0, /* tp_getattr */
2766 0, /* tp_setattr */
2767 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002768 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002769 0, /* tp_as_number */
2770 0, /* tp_as_sequence */
2771 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002772 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002773 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002774 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002775 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002776 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002777 0, /* tp_as_buffer */
2778 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002779 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002780 0, /* tp_traverse */
2781 0, /* tp_clear */
2782 0, /* tp_richcompare */
2783 0, /* tp_weaklistoffset */
2784 0, /* tp_iter */
2785 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00002786 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002787 0, /* tp_members */
2788 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002789 0, /* tp_base */
2790 0, /* tp_dict */
2791 0, /* tp_descr_get */
2792 0, /* tp_descr_set */
2793 0, /* tp_dictoffset */
2794 object_init, /* tp_init */
2795 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00002796 object_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002797 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002798};
2799
2800
2801/* Initialize the __dict__ in a type object */
2802
2803static int
2804add_methods(PyTypeObject *type, PyMethodDef *meth)
2805{
Guido van Rossum687ae002001-10-15 22:03:32 +00002806 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002807
2808 for (; meth->ml_name != NULL; meth++) {
2809 PyObject *descr;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002810 if (PyDict_GetItemString(dict, meth->ml_name) &&
2811 !(meth->ml_flags & METH_COEXIST))
2812 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002813 if (meth->ml_flags & METH_CLASS) {
2814 if (meth->ml_flags & METH_STATIC) {
2815 PyErr_SetString(PyExc_ValueError,
2816 "method cannot be both class and static");
2817 return -1;
2818 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002819 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002820 }
2821 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002822 PyObject *cfunc = PyCFunction_New(meth, NULL);
2823 if (cfunc == NULL)
2824 return -1;
2825 descr = PyStaticMethod_New(cfunc);
2826 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002827 }
2828 else {
2829 descr = PyDescr_NewMethod(type, meth);
2830 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002831 if (descr == NULL)
2832 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002833 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002834 return -1;
2835 Py_DECREF(descr);
2836 }
2837 return 0;
2838}
2839
2840static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002841add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002842{
Guido van Rossum687ae002001-10-15 22:03:32 +00002843 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002844
2845 for (; memb->name != NULL; memb++) {
2846 PyObject *descr;
2847 if (PyDict_GetItemString(dict, memb->name))
2848 continue;
2849 descr = PyDescr_NewMember(type, memb);
2850 if (descr == NULL)
2851 return -1;
2852 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2853 return -1;
2854 Py_DECREF(descr);
2855 }
2856 return 0;
2857}
2858
2859static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002860add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002861{
Guido van Rossum687ae002001-10-15 22:03:32 +00002862 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002863
2864 for (; gsp->name != NULL; gsp++) {
2865 PyObject *descr;
2866 if (PyDict_GetItemString(dict, gsp->name))
2867 continue;
2868 descr = PyDescr_NewGetSet(type, gsp);
2869
2870 if (descr == NULL)
2871 return -1;
2872 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2873 return -1;
2874 Py_DECREF(descr);
2875 }
2876 return 0;
2877}
2878
Guido van Rossum13d52f02001-08-10 21:24:08 +00002879static void
2880inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002881{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00002882 Py_ssize_t oldsize, newsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002883
Guido van Rossum13d52f02001-08-10 21:24:08 +00002884 /* Special flag magic */
2885 if (!type->tp_as_buffer && base->tp_as_buffer) {
2886 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2887 type->tp_flags |=
2888 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2889 }
2890 if (!type->tp_as_sequence && base->tp_as_sequence) {
2891 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2892 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2893 }
2894 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2895 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2896 if ((!type->tp_as_number && base->tp_as_number) ||
2897 (!type->tp_as_sequence && base->tp_as_sequence)) {
2898 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2899 if (!type->tp_as_number && !type->tp_as_sequence) {
2900 type->tp_flags |= base->tp_flags &
2901 Py_TPFLAGS_HAVE_INPLACEOPS;
2902 }
2903 }
2904 /* Wow */
2905 }
2906 if (!type->tp_as_number && base->tp_as_number) {
2907 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2908 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2909 }
2910
2911 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002912 oldsize = base->tp_basicsize;
2913 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2914 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2915 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002916 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2917 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002918 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002919 if (type->tp_traverse == NULL)
2920 type->tp_traverse = base->tp_traverse;
2921 if (type->tp_clear == NULL)
2922 type->tp_clear = base->tp_clear;
2923 }
2924 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002925 /* The condition below could use some explanation.
2926 It appears that tp_new is not inherited for static types
2927 whose base class is 'object'; this seems to be a precaution
2928 so that old extension types don't suddenly become
2929 callable (object.__new__ wouldn't insure the invariants
2930 that the extension type's own factory function ensures).
2931 Heap types, of course, are under our control, so they do
2932 inherit tp_new; static extension types that specify some
2933 other built-in type as the default are considered
2934 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002935 if (base != &PyBaseObject_Type ||
2936 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2937 if (type->tp_new == NULL)
2938 type->tp_new = base->tp_new;
2939 }
2940 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002941 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002942
2943 /* Copy other non-function slots */
2944
2945#undef COPYVAL
2946#define COPYVAL(SLOT) \
2947 if (type->SLOT == 0) type->SLOT = base->SLOT
2948
2949 COPYVAL(tp_itemsize);
2950 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2951 COPYVAL(tp_weaklistoffset);
2952 }
2953 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2954 COPYVAL(tp_dictoffset);
2955 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002956}
2957
2958static void
2959inherit_slots(PyTypeObject *type, PyTypeObject *base)
2960{
2961 PyTypeObject *basebase;
2962
2963#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002964#undef COPYSLOT
2965#undef COPYNUM
2966#undef COPYSEQ
2967#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002968#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002969
2970#define SLOTDEFINED(SLOT) \
2971 (base->SLOT != 0 && \
2972 (basebase == NULL || base->SLOT != basebase->SLOT))
2973
Tim Peters6d6c1a32001-08-02 04:15:00 +00002974#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002975 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002976
2977#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2978#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2979#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002980#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002981
Guido van Rossum13d52f02001-08-10 21:24:08 +00002982 /* This won't inherit indirect slots (from tp_as_number etc.)
2983 if type doesn't provide the space. */
2984
2985 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2986 basebase = base->tp_base;
2987 if (basebase->tp_as_number == NULL)
2988 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002989 COPYNUM(nb_add);
2990 COPYNUM(nb_subtract);
2991 COPYNUM(nb_multiply);
2992 COPYNUM(nb_divide);
2993 COPYNUM(nb_remainder);
2994 COPYNUM(nb_divmod);
2995 COPYNUM(nb_power);
2996 COPYNUM(nb_negative);
2997 COPYNUM(nb_positive);
2998 COPYNUM(nb_absolute);
2999 COPYNUM(nb_nonzero);
3000 COPYNUM(nb_invert);
3001 COPYNUM(nb_lshift);
3002 COPYNUM(nb_rshift);
3003 COPYNUM(nb_and);
3004 COPYNUM(nb_xor);
3005 COPYNUM(nb_or);
3006 COPYNUM(nb_coerce);
3007 COPYNUM(nb_int);
3008 COPYNUM(nb_long);
3009 COPYNUM(nb_float);
3010 COPYNUM(nb_oct);
3011 COPYNUM(nb_hex);
3012 COPYNUM(nb_inplace_add);
3013 COPYNUM(nb_inplace_subtract);
3014 COPYNUM(nb_inplace_multiply);
3015 COPYNUM(nb_inplace_divide);
3016 COPYNUM(nb_inplace_remainder);
3017 COPYNUM(nb_inplace_power);
3018 COPYNUM(nb_inplace_lshift);
3019 COPYNUM(nb_inplace_rshift);
3020 COPYNUM(nb_inplace_and);
3021 COPYNUM(nb_inplace_xor);
3022 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003023 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3024 COPYNUM(nb_true_divide);
3025 COPYNUM(nb_floor_divide);
3026 COPYNUM(nb_inplace_true_divide);
3027 COPYNUM(nb_inplace_floor_divide);
3028 }
Guido van Rossum38fff8c2006-03-07 18:50:55 +00003029 if (base->tp_flags & Py_TPFLAGS_HAVE_INDEX) {
3030 COPYNUM(nb_index);
3031 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003032 }
3033
Guido van Rossum13d52f02001-08-10 21:24:08 +00003034 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3035 basebase = base->tp_base;
3036 if (basebase->tp_as_sequence == NULL)
3037 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003038 COPYSEQ(sq_length);
3039 COPYSEQ(sq_concat);
3040 COPYSEQ(sq_repeat);
3041 COPYSEQ(sq_item);
3042 COPYSEQ(sq_slice);
3043 COPYSEQ(sq_ass_item);
3044 COPYSEQ(sq_ass_slice);
3045 COPYSEQ(sq_contains);
3046 COPYSEQ(sq_inplace_concat);
3047 COPYSEQ(sq_inplace_repeat);
3048 }
3049
Guido van Rossum13d52f02001-08-10 21:24:08 +00003050 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3051 basebase = base->tp_base;
3052 if (basebase->tp_as_mapping == NULL)
3053 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003054 COPYMAP(mp_length);
3055 COPYMAP(mp_subscript);
3056 COPYMAP(mp_ass_subscript);
3057 }
3058
Tim Petersfc57ccb2001-10-12 02:38:24 +00003059 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3060 basebase = base->tp_base;
3061 if (basebase->tp_as_buffer == NULL)
3062 basebase = NULL;
3063 COPYBUF(bf_getreadbuffer);
3064 COPYBUF(bf_getwritebuffer);
3065 COPYBUF(bf_getsegcount);
3066 COPYBUF(bf_getcharbuffer);
3067 }
3068
Guido van Rossum13d52f02001-08-10 21:24:08 +00003069 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003070
Tim Peters6d6c1a32001-08-02 04:15:00 +00003071 COPYSLOT(tp_dealloc);
3072 COPYSLOT(tp_print);
3073 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3074 type->tp_getattr = base->tp_getattr;
3075 type->tp_getattro = base->tp_getattro;
3076 }
3077 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3078 type->tp_setattr = base->tp_setattr;
3079 type->tp_setattro = base->tp_setattro;
3080 }
3081 /* tp_compare see tp_richcompare */
3082 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003083 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003084 COPYSLOT(tp_call);
3085 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003086 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003087 if (type->tp_compare == NULL &&
3088 type->tp_richcompare == NULL &&
3089 type->tp_hash == NULL)
3090 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003091 type->tp_compare = base->tp_compare;
3092 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003093 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003094 }
3095 }
3096 else {
3097 COPYSLOT(tp_compare);
3098 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003099 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3100 COPYSLOT(tp_iter);
3101 COPYSLOT(tp_iternext);
3102 }
3103 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3104 COPYSLOT(tp_descr_get);
3105 COPYSLOT(tp_descr_set);
3106 COPYSLOT(tp_dictoffset);
3107 COPYSLOT(tp_init);
3108 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003109 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003110 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3111 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3112 /* They agree about gc. */
3113 COPYSLOT(tp_free);
3114 }
3115 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3116 type->tp_free == NULL &&
3117 base->tp_free == _PyObject_Del) {
3118 /* A bit of magic to plug in the correct default
3119 * tp_free function when a derived class adds gc,
3120 * didn't define tp_free, and the base uses the
3121 * default non-gc tp_free.
3122 */
3123 type->tp_free = PyObject_GC_Del;
3124 }
3125 /* else they didn't agree about gc, and there isn't something
3126 * obvious to be done -- the type is on its own.
3127 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003128 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003129}
3130
Jeremy Hylton938ace62002-07-17 16:30:39 +00003131static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003132
Tim Peters6d6c1a32001-08-02 04:15:00 +00003133int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003134PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003135{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003136 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003137 PyTypeObject *base;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003138 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003139
Guido van Rossumcab05802002-06-10 15:29:03 +00003140 if (type->tp_flags & Py_TPFLAGS_READY) {
3141 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003142 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003143 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003144 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003145
3146 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003147
Tim Peters36eb4df2003-03-23 03:33:13 +00003148#ifdef Py_TRACE_REFS
3149 /* PyType_Ready is the closest thing we have to a choke point
3150 * for type objects, so is the best place I can think of to try
3151 * to get type objects into the doubly-linked list of all objects.
3152 * Still, not all type objects go thru PyType_Ready.
3153 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003154 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003155#endif
3156
Tim Peters6d6c1a32001-08-02 04:15:00 +00003157 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3158 base = type->tp_base;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003159 if (base == NULL && type != &PyBaseObject_Type) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003160 base = type->tp_base = &PyBaseObject_Type;
Martin v. Löwisbf608752004-08-18 13:16:54 +00003161 Py_INCREF(base);
3162 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003163
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003164 /* Now the only way base can still be NULL is if type is
3165 * &PyBaseObject_Type.
3166 */
3167
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003168 /* Initialize the base class */
3169 if (base && base->tp_dict == NULL) {
3170 if (PyType_Ready(base) < 0)
3171 goto error;
3172 }
3173
Guido van Rossum0986d822002-04-08 01:38:42 +00003174 /* Initialize ob_type if NULL. This means extensions that want to be
3175 compilable separately on Windows can call PyType_Ready() instead of
3176 initializing the ob_type field of their type objects. */
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003177 /* The test for base != NULL is really unnecessary, since base is only
3178 NULL when type is &PyBaseObject_Type, and we know its ob_type is
3179 not NULL (it's initialized to &PyType_Type). But coverity doesn't
3180 know that. */
3181 if (type->ob_type == NULL && base != NULL)
Guido van Rossum0986d822002-04-08 01:38:42 +00003182 type->ob_type = base->ob_type;
3183
Tim Peters6d6c1a32001-08-02 04:15:00 +00003184 /* Initialize tp_bases */
3185 bases = type->tp_bases;
3186 if (bases == NULL) {
3187 if (base == NULL)
3188 bases = PyTuple_New(0);
3189 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003190 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003191 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003192 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003193 type->tp_bases = bases;
3194 }
3195
Guido van Rossum687ae002001-10-15 22:03:32 +00003196 /* Initialize tp_dict */
3197 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003198 if (dict == NULL) {
3199 dict = PyDict_New();
3200 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003201 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003202 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003203 }
3204
Guido van Rossum687ae002001-10-15 22:03:32 +00003205 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003206 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003207 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003208 if (type->tp_methods != NULL) {
3209 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003210 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003211 }
3212 if (type->tp_members != NULL) {
3213 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003214 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003215 }
3216 if (type->tp_getset != NULL) {
3217 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003218 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003219 }
3220
Tim Peters6d6c1a32001-08-02 04:15:00 +00003221 /* Calculate method resolution order */
3222 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003223 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003224 }
3225
Guido van Rossum13d52f02001-08-10 21:24:08 +00003226 /* Inherit special flags from dominant base */
3227 if (type->tp_base != NULL)
3228 inherit_special(type, type->tp_base);
3229
Tim Peters6d6c1a32001-08-02 04:15:00 +00003230 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003231 bases = type->tp_mro;
3232 assert(bases != NULL);
3233 assert(PyTuple_Check(bases));
3234 n = PyTuple_GET_SIZE(bases);
3235 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003236 PyObject *b = PyTuple_GET_ITEM(bases, i);
3237 if (PyType_Check(b))
3238 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003239 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003240
Tim Peters3cfe7542003-05-21 21:29:48 +00003241 /* Sanity check for tp_free. */
3242 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3243 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
3244 /* This base class needs to call tp_free, but doesn't have
3245 * one, or its tp_free is for non-gc'ed objects.
3246 */
3247 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3248 "gc and is a base type but has inappropriate "
3249 "tp_free slot",
3250 type->tp_name);
3251 goto error;
3252 }
3253
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003254 /* if the type dictionary doesn't contain a __doc__, set it from
3255 the tp_doc slot.
3256 */
3257 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3258 if (type->tp_doc != NULL) {
3259 PyObject *doc = PyString_FromString(type->tp_doc);
3260 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3261 Py_DECREF(doc);
3262 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003263 PyDict_SetItemString(type->tp_dict,
3264 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003265 }
3266 }
3267
Guido van Rossum13d52f02001-08-10 21:24:08 +00003268 /* Some more special stuff */
3269 base = type->tp_base;
3270 if (base != NULL) {
3271 if (type->tp_as_number == NULL)
3272 type->tp_as_number = base->tp_as_number;
3273 if (type->tp_as_sequence == NULL)
3274 type->tp_as_sequence = base->tp_as_sequence;
3275 if (type->tp_as_mapping == NULL)
3276 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003277 if (type->tp_as_buffer == NULL)
3278 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003279 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003280
Guido van Rossum1c450732001-10-08 15:18:27 +00003281 /* Link into each base class's list of subclasses */
3282 bases = type->tp_bases;
3283 n = PyTuple_GET_SIZE(bases);
3284 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003285 PyObject *b = PyTuple_GET_ITEM(bases, i);
3286 if (PyType_Check(b) &&
3287 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003288 goto error;
3289 }
3290
Guido van Rossum13d52f02001-08-10 21:24:08 +00003291 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003292 assert(type->tp_dict != NULL);
3293 type->tp_flags =
3294 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003295 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003296
3297 error:
3298 type->tp_flags &= ~Py_TPFLAGS_READYING;
3299 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003300}
3301
Guido van Rossum1c450732001-10-08 15:18:27 +00003302static int
3303add_subclass(PyTypeObject *base, PyTypeObject *type)
3304{
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003305 Py_ssize_t i;
3306 int result;
Anthony Baxtera6286212006-04-11 07:42:36 +00003307 PyObject *list, *ref, *newobj;
Guido van Rossum1c450732001-10-08 15:18:27 +00003308
3309 list = base->tp_subclasses;
3310 if (list == NULL) {
3311 base->tp_subclasses = list = PyList_New(0);
3312 if (list == NULL)
3313 return -1;
3314 }
3315 assert(PyList_Check(list));
Anthony Baxtera6286212006-04-11 07:42:36 +00003316 newobj = PyWeakref_NewRef((PyObject *)type, NULL);
Guido van Rossum1c450732001-10-08 15:18:27 +00003317 i = PyList_GET_SIZE(list);
3318 while (--i >= 0) {
3319 ref = PyList_GET_ITEM(list, i);
3320 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003321 if (PyWeakref_GET_OBJECT(ref) == Py_None)
Anthony Baxtera6286212006-04-11 07:42:36 +00003322 return PyList_SetItem(list, i, newobj);
Guido van Rossum1c450732001-10-08 15:18:27 +00003323 }
Anthony Baxtera6286212006-04-11 07:42:36 +00003324 result = PyList_Append(list, newobj);
3325 Py_DECREF(newobj);
Martin v. Löwiseb079f12006-02-16 14:32:27 +00003326 return result;
Guido van Rossum1c450732001-10-08 15:18:27 +00003327}
3328
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003329static void
3330remove_subclass(PyTypeObject *base, PyTypeObject *type)
3331{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003332 Py_ssize_t i;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003333 PyObject *list, *ref;
3334
3335 list = base->tp_subclasses;
3336 if (list == NULL) {
3337 return;
3338 }
3339 assert(PyList_Check(list));
3340 i = PyList_GET_SIZE(list);
3341 while (--i >= 0) {
3342 ref = PyList_GET_ITEM(list, i);
3343 assert(PyWeakref_CheckRef(ref));
3344 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3345 /* this can't fail, right? */
3346 PySequence_DelItem(list, i);
3347 return;
3348 }
3349 }
3350}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003351
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003352static int
3353check_num_args(PyObject *ob, int n)
3354{
3355 if (!PyTuple_CheckExact(ob)) {
3356 PyErr_SetString(PyExc_SystemError,
3357 "PyArg_UnpackTuple() argument list is not a tuple");
3358 return 0;
3359 }
3360 if (n == PyTuple_GET_SIZE(ob))
3361 return 1;
3362 PyErr_Format(
3363 PyExc_TypeError,
Martin v. Löwis2c95cc62006-02-16 06:54:25 +00003364 "expected %d arguments, got %zd", n, PyTuple_GET_SIZE(ob));
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003365 return 0;
3366}
3367
Tim Peters6d6c1a32001-08-02 04:15:00 +00003368/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3369
3370/* There's a wrapper *function* for each distinct function typedef used
3371 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
3372 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3373 Most tables have only one entry; the tables for binary operators have two
3374 entries, one regular and one with reversed arguments. */
3375
3376static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003377wrap_lenfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003378{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003379 lenfunc func = (lenfunc)wrapped;
3380 Py_ssize_t res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003381
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003382 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003383 return NULL;
3384 res = (*func)(self);
3385 if (res == -1 && PyErr_Occurred())
3386 return NULL;
3387 return PyInt_FromLong((long)res);
3388}
3389
Tim Peters6d6c1a32001-08-02 04:15:00 +00003390static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003391wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3392{
3393 inquiry func = (inquiry)wrapped;
3394 int res;
3395
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003396 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003397 return NULL;
3398 res = (*func)(self);
3399 if (res == -1 && PyErr_Occurred())
3400 return NULL;
3401 return PyBool_FromLong((long)res);
3402}
3403
3404static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003405wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3406{
3407 binaryfunc func = (binaryfunc)wrapped;
3408 PyObject *other;
3409
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003410 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003411 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003412 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003413 return (*func)(self, other);
3414}
3415
3416static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003417wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3418{
3419 binaryfunc func = (binaryfunc)wrapped;
3420 PyObject *other;
3421
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003422 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003423 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003424 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003425 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003426 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003427 Py_INCREF(Py_NotImplemented);
3428 return Py_NotImplemented;
3429 }
3430 return (*func)(self, other);
3431}
3432
3433static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003434wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3435{
3436 binaryfunc func = (binaryfunc)wrapped;
3437 PyObject *other;
3438
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003439 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003440 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003441 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003442 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003443 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003444 Py_INCREF(Py_NotImplemented);
3445 return Py_NotImplemented;
3446 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003447 return (*func)(other, self);
3448}
3449
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003450static PyObject *
3451wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3452{
3453 coercion func = (coercion)wrapped;
3454 PyObject *other, *res;
3455 int ok;
3456
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003457 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003458 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003459 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003460 ok = func(&self, &other);
3461 if (ok < 0)
3462 return NULL;
3463 if (ok > 0) {
3464 Py_INCREF(Py_NotImplemented);
3465 return Py_NotImplemented;
3466 }
3467 res = PyTuple_New(2);
3468 if (res == NULL) {
3469 Py_DECREF(self);
3470 Py_DECREF(other);
3471 return NULL;
3472 }
3473 PyTuple_SET_ITEM(res, 0, self);
3474 PyTuple_SET_ITEM(res, 1, other);
3475 return res;
3476}
3477
Tim Peters6d6c1a32001-08-02 04:15:00 +00003478static PyObject *
3479wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3480{
3481 ternaryfunc func = (ternaryfunc)wrapped;
3482 PyObject *other;
3483 PyObject *third = Py_None;
3484
3485 /* Note: This wrapper only works for __pow__() */
3486
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003487 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003488 return NULL;
3489 return (*func)(self, other, third);
3490}
3491
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003492static PyObject *
3493wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3494{
3495 ternaryfunc func = (ternaryfunc)wrapped;
3496 PyObject *other;
3497 PyObject *third = Py_None;
3498
3499 /* Note: This wrapper only works for __pow__() */
3500
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003501 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003502 return NULL;
3503 return (*func)(other, self, third);
3504}
3505
Tim Peters6d6c1a32001-08-02 04:15:00 +00003506static PyObject *
3507wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3508{
3509 unaryfunc func = (unaryfunc)wrapped;
3510
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003511 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003512 return NULL;
3513 return (*func)(self);
3514}
3515
Tim Peters6d6c1a32001-08-02 04:15:00 +00003516static PyObject *
Armin Rigo314861c2006-03-30 14:04:02 +00003517wrap_indexargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003518{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003519 ssizeargfunc func = (ssizeargfunc)wrapped;
Armin Rigo314861c2006-03-30 14:04:02 +00003520 PyObject* o;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003521 Py_ssize_t i;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003522
Armin Rigo314861c2006-03-30 14:04:02 +00003523 if (!PyArg_UnpackTuple(args, "", 1, 1, &o))
3524 return NULL;
3525 i = PyNumber_Index(o);
3526 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003527 return NULL;
3528 return (*func)(self, i);
3529}
3530
Martin v. Löwis18e16552006-02-15 17:27:45 +00003531static Py_ssize_t
Guido van Rossum5d815f32001-08-17 21:57:47 +00003532getindex(PyObject *self, PyObject *arg)
3533{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003534 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003535
Armin Rigo314861c2006-03-30 14:04:02 +00003536 i = PyNumber_Index(arg);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003537 if (i == -1 && PyErr_Occurred())
3538 return -1;
3539 if (i < 0) {
3540 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3541 if (sq && sq->sq_length) {
Martin v. Löwis18e16552006-02-15 17:27:45 +00003542 Py_ssize_t n = (*sq->sq_length)(self);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003543 if (n < 0)
3544 return -1;
3545 i += n;
3546 }
3547 }
3548 return i;
3549}
3550
3551static PyObject *
3552wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3553{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003554 ssizeargfunc func = (ssizeargfunc)wrapped;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003555 PyObject *arg;
Martin v. Löwis18e16552006-02-15 17:27:45 +00003556 Py_ssize_t i;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003557
Guido van Rossumf4593e02001-10-03 12:09:30 +00003558 if (PyTuple_GET_SIZE(args) == 1) {
3559 arg = PyTuple_GET_ITEM(args, 0);
3560 i = getindex(self, arg);
3561 if (i == -1 && PyErr_Occurred())
3562 return NULL;
3563 return (*func)(self, i);
3564 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003565 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003566 assert(PyErr_Occurred());
3567 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003568}
3569
Tim Peters6d6c1a32001-08-02 04:15:00 +00003570static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003571wrap_ssizessizeargfunc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003572{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003573 ssizessizeargfunc func = (ssizessizeargfunc)wrapped;
3574 Py_ssize_t i, j;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003575
Martin v. Löwis18e16552006-02-15 17:27:45 +00003576 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003577 return NULL;
3578 return (*func)(self, i, j);
3579}
3580
Tim Peters6d6c1a32001-08-02 04:15:00 +00003581static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003582wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003583{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003584 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3585 Py_ssize_t i;
3586 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003587 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003588
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003589 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003590 return NULL;
3591 i = getindex(self, arg);
3592 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003593 return NULL;
3594 res = (*func)(self, i, value);
3595 if (res == -1 && PyErr_Occurred())
3596 return NULL;
3597 Py_INCREF(Py_None);
3598 return Py_None;
3599}
3600
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003601static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003602wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003603{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003604 ssizeobjargproc func = (ssizeobjargproc)wrapped;
3605 Py_ssize_t i;
3606 int res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003607 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003608
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003609 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003610 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003611 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003612 i = getindex(self, arg);
3613 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003614 return NULL;
3615 res = (*func)(self, i, NULL);
3616 if (res == -1 && PyErr_Occurred())
3617 return NULL;
3618 Py_INCREF(Py_None);
3619 return Py_None;
3620}
3621
Tim Peters6d6c1a32001-08-02 04:15:00 +00003622static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00003623wrap_ssizessizeobjargproc(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003624{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003625 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3626 Py_ssize_t i, j;
3627 int res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003628 PyObject *value;
3629
Martin v. Löwis18e16552006-02-15 17:27:45 +00003630 if (!PyArg_ParseTuple(args, "nnO", &i, &j, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003631 return NULL;
3632 res = (*func)(self, i, j, value);
3633 if (res == -1 && PyErr_Occurred())
3634 return NULL;
3635 Py_INCREF(Py_None);
3636 return Py_None;
3637}
3638
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003639static PyObject *
3640wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3641{
Martin v. Löwis18e16552006-02-15 17:27:45 +00003642 ssizessizeobjargproc func = (ssizessizeobjargproc)wrapped;
3643 Py_ssize_t i, j;
3644 int res;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003645
Martin v. Löwis18e16552006-02-15 17:27:45 +00003646 if (!PyArg_ParseTuple(args, "nn", &i, &j))
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003647 return NULL;
3648 res = (*func)(self, i, j, NULL);
3649 if (res == -1 && PyErr_Occurred())
3650 return NULL;
3651 Py_INCREF(Py_None);
3652 return Py_None;
3653}
3654
Tim Peters6d6c1a32001-08-02 04:15:00 +00003655/* XXX objobjproc is a misnomer; should be objargpred */
3656static PyObject *
3657wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3658{
3659 objobjproc func = (objobjproc)wrapped;
3660 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003661 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003662
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003663 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003664 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003665 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003666 res = (*func)(self, value);
3667 if (res == -1 && PyErr_Occurred())
3668 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003669 else
3670 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003671}
3672
Tim Peters6d6c1a32001-08-02 04:15:00 +00003673static PyObject *
3674wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3675{
3676 objobjargproc func = (objobjargproc)wrapped;
3677 int res;
3678 PyObject *key, *value;
3679
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003680 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003681 return NULL;
3682 res = (*func)(self, key, value);
3683 if (res == -1 && PyErr_Occurred())
3684 return NULL;
3685 Py_INCREF(Py_None);
3686 return Py_None;
3687}
3688
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003689static PyObject *
3690wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3691{
3692 objobjargproc func = (objobjargproc)wrapped;
3693 int res;
3694 PyObject *key;
3695
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003696 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003697 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003698 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003699 res = (*func)(self, key, NULL);
3700 if (res == -1 && PyErr_Occurred())
3701 return NULL;
3702 Py_INCREF(Py_None);
3703 return Py_None;
3704}
3705
Tim Peters6d6c1a32001-08-02 04:15:00 +00003706static PyObject *
3707wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3708{
3709 cmpfunc func = (cmpfunc)wrapped;
3710 int res;
3711 PyObject *other;
3712
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003713 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003714 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003715 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003716 if (other->ob_type->tp_compare != func &&
3717 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003718 PyErr_Format(
3719 PyExc_TypeError,
3720 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3721 self->ob_type->tp_name,
3722 self->ob_type->tp_name,
3723 other->ob_type->tp_name);
3724 return NULL;
3725 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003726 res = (*func)(self, other);
3727 if (PyErr_Occurred())
3728 return NULL;
3729 return PyInt_FromLong((long)res);
3730}
3731
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003732/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003733 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003734static int
3735hackcheck(PyObject *self, setattrofunc func, char *what)
3736{
3737 PyTypeObject *type = self->ob_type;
3738 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3739 type = type->tp_base;
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003740 /* If type is NULL now, this is a really weird type.
3741 In the same of backwards compatibility (?), just shut up. */
3742 if (type && type->tp_setattro != func) {
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003743 PyErr_Format(PyExc_TypeError,
3744 "can't apply this %s to %s object",
3745 what,
3746 type->tp_name);
3747 return 0;
3748 }
3749 return 1;
3750}
3751
Tim Peters6d6c1a32001-08-02 04:15:00 +00003752static PyObject *
3753wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3754{
3755 setattrofunc func = (setattrofunc)wrapped;
3756 int res;
3757 PyObject *name, *value;
3758
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003759 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003760 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003761 if (!hackcheck(self, func, "__setattr__"))
3762 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003763 res = (*func)(self, name, value);
3764 if (res < 0)
3765 return NULL;
3766 Py_INCREF(Py_None);
3767 return Py_None;
3768}
3769
3770static PyObject *
3771wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3772{
3773 setattrofunc func = (setattrofunc)wrapped;
3774 int res;
3775 PyObject *name;
3776
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003777 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003778 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003779 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003780 if (!hackcheck(self, func, "__delattr__"))
3781 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003782 res = (*func)(self, name, NULL);
3783 if (res < 0)
3784 return NULL;
3785 Py_INCREF(Py_None);
3786 return Py_None;
3787}
3788
Tim Peters6d6c1a32001-08-02 04:15:00 +00003789static PyObject *
3790wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3791{
3792 hashfunc func = (hashfunc)wrapped;
3793 long res;
3794
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003795 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003796 return NULL;
3797 res = (*func)(self);
3798 if (res == -1 && PyErr_Occurred())
3799 return NULL;
3800 return PyInt_FromLong(res);
3801}
3802
Tim Peters6d6c1a32001-08-02 04:15:00 +00003803static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003804wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003805{
3806 ternaryfunc func = (ternaryfunc)wrapped;
3807
Guido van Rossumc8e56452001-10-22 00:43:43 +00003808 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003809}
3810
Tim Peters6d6c1a32001-08-02 04:15:00 +00003811static PyObject *
3812wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3813{
3814 richcmpfunc func = (richcmpfunc)wrapped;
3815 PyObject *other;
3816
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003817 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003818 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003819 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003820 return (*func)(self, other, op);
3821}
3822
3823#undef RICHCMP_WRAPPER
3824#define RICHCMP_WRAPPER(NAME, OP) \
3825static PyObject * \
3826richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3827{ \
3828 return wrap_richcmpfunc(self, args, wrapped, OP); \
3829}
3830
Jack Jansen8e938b42001-08-08 15:29:49 +00003831RICHCMP_WRAPPER(lt, Py_LT)
3832RICHCMP_WRAPPER(le, Py_LE)
3833RICHCMP_WRAPPER(eq, Py_EQ)
3834RICHCMP_WRAPPER(ne, Py_NE)
3835RICHCMP_WRAPPER(gt, Py_GT)
3836RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003837
Tim Peters6d6c1a32001-08-02 04:15:00 +00003838static PyObject *
3839wrap_next(PyObject *self, PyObject *args, void *wrapped)
3840{
3841 unaryfunc func = (unaryfunc)wrapped;
3842 PyObject *res;
3843
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003844 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003845 return NULL;
3846 res = (*func)(self);
3847 if (res == NULL && !PyErr_Occurred())
3848 PyErr_SetNone(PyExc_StopIteration);
3849 return res;
3850}
3851
Tim Peters6d6c1a32001-08-02 04:15:00 +00003852static PyObject *
3853wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3854{
3855 descrgetfunc func = (descrgetfunc)wrapped;
3856 PyObject *obj;
3857 PyObject *type = NULL;
3858
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003859 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003860 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003861 if (obj == Py_None)
3862 obj = NULL;
3863 if (type == Py_None)
3864 type = NULL;
3865 if (type == NULL &&obj == NULL) {
3866 PyErr_SetString(PyExc_TypeError,
3867 "__get__(None, None) is invalid");
3868 return NULL;
3869 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003870 return (*func)(self, obj, type);
3871}
3872
Tim Peters6d6c1a32001-08-02 04:15:00 +00003873static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003874wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003875{
3876 descrsetfunc func = (descrsetfunc)wrapped;
3877 PyObject *obj, *value;
3878 int ret;
3879
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003880 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003881 return NULL;
3882 ret = (*func)(self, obj, value);
3883 if (ret < 0)
3884 return NULL;
3885 Py_INCREF(Py_None);
3886 return Py_None;
3887}
Guido van Rossum22b13872002-08-06 21:41:44 +00003888
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003889static PyObject *
3890wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3891{
3892 descrsetfunc func = (descrsetfunc)wrapped;
3893 PyObject *obj;
3894 int ret;
3895
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003896 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003897 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003898 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003899 ret = (*func)(self, obj, NULL);
3900 if (ret < 0)
3901 return NULL;
3902 Py_INCREF(Py_None);
3903 return Py_None;
3904}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003905
Tim Peters6d6c1a32001-08-02 04:15:00 +00003906static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003907wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003908{
3909 initproc func = (initproc)wrapped;
3910
Guido van Rossumc8e56452001-10-22 00:43:43 +00003911 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003912 return NULL;
3913 Py_INCREF(Py_None);
3914 return Py_None;
3915}
3916
Tim Peters6d6c1a32001-08-02 04:15:00 +00003917static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003918tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003919{
Barry Warsaw60f01882001-08-22 19:24:42 +00003920 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003921 PyObject *arg0, *res;
3922
3923 if (self == NULL || !PyType_Check(self))
3924 Py_FatalError("__new__() called with non-type 'self'");
3925 type = (PyTypeObject *)self;
3926 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003927 PyErr_Format(PyExc_TypeError,
3928 "%s.__new__(): not enough arguments",
3929 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003930 return NULL;
3931 }
3932 arg0 = PyTuple_GET_ITEM(args, 0);
3933 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003934 PyErr_Format(PyExc_TypeError,
3935 "%s.__new__(X): X is not a type object (%s)",
3936 type->tp_name,
3937 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003938 return NULL;
3939 }
3940 subtype = (PyTypeObject *)arg0;
3941 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003942 PyErr_Format(PyExc_TypeError,
3943 "%s.__new__(%s): %s is not a subtype of %s",
3944 type->tp_name,
3945 subtype->tp_name,
3946 subtype->tp_name,
3947 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003948 return NULL;
3949 }
Barry Warsaw60f01882001-08-22 19:24:42 +00003950
3951 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00003952 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00003953 most derived base that's not a heap type is this type. */
3954 staticbase = subtype;
3955 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
3956 staticbase = staticbase->tp_base;
Guido van Rossum692cdbc2006-03-10 02:04:28 +00003957 /* If staticbase is NULL now, it is a really weird type.
3958 In the same of backwards compatibility (?), just shut up. */
3959 if (staticbase && staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003960 PyErr_Format(PyExc_TypeError,
3961 "%s.__new__(%s) is not safe, use %s.__new__()",
3962 type->tp_name,
3963 subtype->tp_name,
3964 staticbase == NULL ? "?" : staticbase->tp_name);
3965 return NULL;
3966 }
3967
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003968 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
3969 if (args == NULL)
3970 return NULL;
3971 res = type->tp_new(subtype, args, kwds);
3972 Py_DECREF(args);
3973 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003974}
3975
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003976static struct PyMethodDef tp_new_methoddef[] = {
3977 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003978 PyDoc_STR("T.__new__(S, ...) -> "
3979 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003980 {0}
3981};
3982
3983static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003984add_tp_new_wrapper(PyTypeObject *type)
3985{
Guido van Rossumf040ede2001-08-07 16:40:56 +00003986 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003987
Guido van Rossum687ae002001-10-15 22:03:32 +00003988 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00003989 return 0;
3990 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003991 if (func == NULL)
3992 return -1;
Raymond Hettinger8d726ee2004-06-25 22:24:35 +00003993 if (PyDict_SetItemString(type->tp_dict, "__new__", func)) {
Raymond Hettingerd56cbe52004-06-25 22:17:39 +00003994 Py_DECREF(func);
3995 return -1;
3996 }
3997 Py_DECREF(func);
3998 return 0;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003999}
4000
Guido van Rossumf040ede2001-08-07 16:40:56 +00004001/* Slot wrappers that call the corresponding __foo__ slot. See comments
4002 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00004003
Guido van Rossumdc91b992001-08-08 22:26:22 +00004004#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004005static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004006FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004007{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00004008 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004009 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004010}
4011
Guido van Rossumdc91b992001-08-08 22:26:22 +00004012#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004013static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004014FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004015{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004016 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004017 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004018}
4019
Guido van Rossumcd118802003-01-06 22:57:47 +00004020/* Boolean helper for SLOT1BINFULL().
4021 right.__class__ is a nontrivial subclass of left.__class__. */
4022static int
4023method_is_overloaded(PyObject *left, PyObject *right, char *name)
4024{
4025 PyObject *a, *b;
4026 int ok;
4027
4028 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
4029 if (b == NULL) {
4030 PyErr_Clear();
4031 /* If right doesn't have it, it's not overloaded */
4032 return 0;
4033 }
4034
4035 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
4036 if (a == NULL) {
4037 PyErr_Clear();
4038 Py_DECREF(b);
4039 /* If right has it but left doesn't, it's overloaded */
4040 return 1;
4041 }
4042
4043 ok = PyObject_RichCompareBool(a, b, Py_NE);
4044 Py_DECREF(a);
4045 Py_DECREF(b);
4046 if (ok < 0) {
4047 PyErr_Clear();
4048 return 0;
4049 }
4050
4051 return ok;
4052}
4053
Guido van Rossumdc91b992001-08-08 22:26:22 +00004054
4055#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004056static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004057FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004058{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004059 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004060 int do_other = self->ob_type != other->ob_type && \
4061 other->ob_type->tp_as_number != NULL && \
4062 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004063 if (self->ob_type->tp_as_number != NULL && \
4064 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
4065 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004066 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004067 PyType_IsSubtype(other->ob_type, self->ob_type) && \
4068 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004069 r = call_maybe( \
4070 other, ROPSTR, &rcache_str, "(O)", self); \
4071 if (r != Py_NotImplemented) \
4072 return r; \
4073 Py_DECREF(r); \
4074 do_other = 0; \
4075 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004076 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004077 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004078 if (r != Py_NotImplemented || \
4079 other->ob_type == self->ob_type) \
4080 return r; \
4081 Py_DECREF(r); \
4082 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004083 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004084 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004085 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004086 } \
4087 Py_INCREF(Py_NotImplemented); \
4088 return Py_NotImplemented; \
4089}
4090
4091#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4092 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4093
4094#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4095static PyObject * \
4096FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4097{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004098 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004099 return call_method(self, OPSTR, &cache_str, \
4100 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004101}
4102
Martin v. Löwis18e16552006-02-15 17:27:45 +00004103static Py_ssize_t
Tim Peters6d6c1a32001-08-02 04:15:00 +00004104slot_sq_length(PyObject *self)
4105{
Guido van Rossum2730b132001-08-28 18:22:14 +00004106 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004107 PyObject *res = call_method(self, "__len__", &len_str, "()");
Martin v. Löwis18e16552006-02-15 17:27:45 +00004108 Py_ssize_t temp;
4109 Py_ssize_t len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004110
4111 if (res == NULL)
4112 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004113 temp = PyInt_AsSsize_t(res);
Guido van Rossum630db602005-09-20 18:49:54 +00004114 len = (int)temp;
Guido van Rossum26111622001-10-01 16:42:49 +00004115 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00004116 if (len == -1 && PyErr_Occurred())
4117 return -1;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004118#if SIZEOF_SIZE_T < SIZEOF_LONG
4119 /* Overflow check -- range of PyInt is more than C ssize_t */
Guido van Rossum630db602005-09-20 18:49:54 +00004120 if (len != temp) {
4121 PyErr_SetString(PyExc_OverflowError,
4122 "__len__() should return 0 <= outcome < 2**31");
4123 return -1;
4124 }
4125#endif
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004126 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00004127 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004128 "__len__() should return >= 0");
4129 return -1;
4130 }
Guido van Rossum26111622001-10-01 16:42:49 +00004131 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004132}
4133
Guido van Rossumf4593e02001-10-03 12:09:30 +00004134/* Super-optimized version of slot_sq_item.
4135 Other slots could do the same... */
4136static PyObject *
Martin v. Löwis18e16552006-02-15 17:27:45 +00004137slot_sq_item(PyObject *self, Py_ssize_t i)
Guido van Rossumf4593e02001-10-03 12:09:30 +00004138{
4139 static PyObject *getitem_str;
4140 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4141 descrgetfunc f;
4142
4143 if (getitem_str == NULL) {
4144 getitem_str = PyString_InternFromString("__getitem__");
4145 if (getitem_str == NULL)
4146 return NULL;
4147 }
4148 func = _PyType_Lookup(self->ob_type, getitem_str);
4149 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004150 if ((f = func->ob_type->tp_descr_get) == NULL)
4151 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004152 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004153 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004154 if (func == NULL) {
4155 return NULL;
4156 }
4157 }
Martin v. Löwiseb079f12006-02-16 14:32:27 +00004158 ival = PyInt_FromSsize_t(i);
Guido van Rossumf4593e02001-10-03 12:09:30 +00004159 if (ival != NULL) {
4160 args = PyTuple_New(1);
4161 if (args != NULL) {
4162 PyTuple_SET_ITEM(args, 0, ival);
4163 retval = PyObject_Call(func, args, NULL);
4164 Py_XDECREF(args);
4165 Py_XDECREF(func);
4166 return retval;
4167 }
4168 }
4169 }
4170 else {
4171 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4172 }
4173 Py_XDECREF(args);
4174 Py_XDECREF(ival);
4175 Py_XDECREF(func);
4176 return NULL;
4177}
4178
Martin v. Löwis18e16552006-02-15 17:27:45 +00004179SLOT2(slot_sq_slice, "__getslice__", Py_ssize_t, Py_ssize_t, "nn")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004180
4181static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004182slot_sq_ass_item(PyObject *self, Py_ssize_t index, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004183{
4184 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004185 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004186
4187 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004188 res = call_method(self, "__delitem__", &delitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004189 "(n)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004190 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004191 res = call_method(self, "__setitem__", &setitem_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004192 "(nO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004193 if (res == NULL)
4194 return -1;
4195 Py_DECREF(res);
4196 return 0;
4197}
4198
4199static int
Martin v. Löwis18e16552006-02-15 17:27:45 +00004200slot_sq_ass_slice(PyObject *self, Py_ssize_t i, Py_ssize_t j, PyObject *value)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004201{
4202 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004203 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004204
4205 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004206 res = call_method(self, "__delslice__", &delslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004207 "(nn)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004208 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004209 res = call_method(self, "__setslice__", &setslice_str,
Thomas Wouters4e908102006-04-21 11:26:56 +00004210 "(nnO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004211 if (res == NULL)
4212 return -1;
4213 Py_DECREF(res);
4214 return 0;
4215}
4216
4217static int
4218slot_sq_contains(PyObject *self, PyObject *value)
4219{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004220 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004221 int result = -1;
4222
Guido van Rossum60718732001-08-28 17:47:51 +00004223 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004224
Guido van Rossum55f20992001-10-01 17:18:22 +00004225 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004226 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004227 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004228 if (args == NULL)
4229 res = NULL;
4230 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004231 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004232 Py_DECREF(args);
4233 }
4234 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004235 if (res != NULL) {
4236 result = PyObject_IsTrue(res);
4237 Py_DECREF(res);
4238 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004239 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004240 else if (! PyErr_Occurred()) {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004241 /* Possible results: -1 and 1 */
4242 result = (int)_PySequence_IterSearch(self, value,
Tim Petersbf9b2442003-03-23 05:35:36 +00004243 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004244 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004245 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004246}
4247
Tim Peters6d6c1a32001-08-02 04:15:00 +00004248#define slot_mp_length slot_sq_length
4249
Guido van Rossumdc91b992001-08-08 22:26:22 +00004250SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004251
4252static int
4253slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4254{
4255 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004256 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004257
4258 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004259 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004260 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004261 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004262 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004263 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004264 if (res == NULL)
4265 return -1;
4266 Py_DECREF(res);
4267 return 0;
4268}
4269
Guido van Rossumdc91b992001-08-08 22:26:22 +00004270SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4271SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4272SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4273SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4274SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4275SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4276
Jeremy Hylton938ace62002-07-17 16:30:39 +00004277static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004278
4279SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4280 nb_power, "__pow__", "__rpow__")
4281
4282static PyObject *
4283slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4284{
Guido van Rossum2730b132001-08-28 18:22:14 +00004285 static PyObject *pow_str;
4286
Guido van Rossumdc91b992001-08-08 22:26:22 +00004287 if (modulus == Py_None)
4288 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004289 /* Three-arg power doesn't use __rpow__. But ternary_op
4290 can call this when the second argument's type uses
4291 slot_nb_power, so check before calling self.__pow__. */
4292 if (self->ob_type->tp_as_number != NULL &&
4293 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4294 return call_method(self, "__pow__", &pow_str,
4295 "(OO)", other, modulus);
4296 }
4297 Py_INCREF(Py_NotImplemented);
4298 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004299}
4300
4301SLOT0(slot_nb_negative, "__neg__")
4302SLOT0(slot_nb_positive, "__pos__")
4303SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004304
4305static int
4306slot_nb_nonzero(PyObject *self)
4307{
Tim Petersea7f75d2002-12-07 21:39:16 +00004308 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004309 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004310 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004311
Guido van Rossum55f20992001-10-01 17:18:22 +00004312 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004313 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004314 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004315 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004316 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004317 if (func == NULL)
4318 return PyErr_Occurred() ? -1 : 1;
4319 }
4320 args = PyTuple_New(0);
4321 if (args != NULL) {
4322 PyObject *temp = PyObject_Call(func, args, NULL);
4323 Py_DECREF(args);
4324 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004325 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004326 result = PyObject_IsTrue(temp);
4327 else {
4328 PyErr_Format(PyExc_TypeError,
4329 "__nonzero__ should return "
4330 "bool or int, returned %s",
4331 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004332 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004333 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004334 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004335 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004336 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004337 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004338 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004339}
4340
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004341
4342static Py_ssize_t
4343slot_nb_index(PyObject *self)
4344{
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004345 static PyObject *index_str;
Armin Rigo314861c2006-03-30 14:04:02 +00004346 PyObject *temp = call_method(self, "__index__", &index_str, "()");
4347 Py_ssize_t result;
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004348
Armin Rigo314861c2006-03-30 14:04:02 +00004349 if (temp == NULL)
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004350 return -1;
Armin Rigo314861c2006-03-30 14:04:02 +00004351 if (PyInt_CheckExact(temp) || PyLong_CheckExact(temp)) {
4352 result = temp->ob_type->tp_as_number->nb_index(temp);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004353 }
Armin Rigo314861c2006-03-30 14:04:02 +00004354 else {
4355 PyErr_SetString(PyExc_TypeError,
4356 "__index__ must return an int or a long");
4357 result = -1;
4358 }
4359 Py_DECREF(temp);
Guido van Rossum38fff8c2006-03-07 18:50:55 +00004360 return result;
4361}
4362
4363
Guido van Rossumdc91b992001-08-08 22:26:22 +00004364SLOT0(slot_nb_invert, "__invert__")
4365SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4366SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4367SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4368SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4369SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004370
4371static int
4372slot_nb_coerce(PyObject **a, PyObject **b)
4373{
4374 static PyObject *coerce_str;
4375 PyObject *self = *a, *other = *b;
4376
4377 if (self->ob_type->tp_as_number != NULL &&
4378 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4379 PyObject *r;
4380 r = call_maybe(
4381 self, "__coerce__", &coerce_str, "(O)", other);
4382 if (r == NULL)
4383 return -1;
4384 if (r == Py_NotImplemented) {
4385 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004386 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004387 else {
4388 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4389 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004390 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004391 Py_DECREF(r);
4392 return -1;
4393 }
4394 *a = PyTuple_GET_ITEM(r, 0);
4395 Py_INCREF(*a);
4396 *b = PyTuple_GET_ITEM(r, 1);
4397 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004398 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004399 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004400 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004401 }
4402 if (other->ob_type->tp_as_number != NULL &&
4403 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4404 PyObject *r;
4405 r = call_maybe(
4406 other, "__coerce__", &coerce_str, "(O)", self);
4407 if (r == NULL)
4408 return -1;
4409 if (r == Py_NotImplemented) {
4410 Py_DECREF(r);
4411 return 1;
4412 }
4413 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4414 PyErr_SetString(PyExc_TypeError,
4415 "__coerce__ didn't return a 2-tuple");
4416 Py_DECREF(r);
4417 return -1;
4418 }
4419 *a = PyTuple_GET_ITEM(r, 1);
4420 Py_INCREF(*a);
4421 *b = PyTuple_GET_ITEM(r, 0);
4422 Py_INCREF(*b);
4423 Py_DECREF(r);
4424 return 0;
4425 }
4426 return 1;
4427}
4428
Guido van Rossumdc91b992001-08-08 22:26:22 +00004429SLOT0(slot_nb_int, "__int__")
4430SLOT0(slot_nb_long, "__long__")
4431SLOT0(slot_nb_float, "__float__")
4432SLOT0(slot_nb_oct, "__oct__")
4433SLOT0(slot_nb_hex, "__hex__")
4434SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4435SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4436SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4437SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4438SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004439SLOT1(slot_nb_inplace_power, "__ipow__", PyObject *, "O")
Guido van Rossumdc91b992001-08-08 22:26:22 +00004440SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4441SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4442SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4443SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4444SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4445SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4446 "__floordiv__", "__rfloordiv__")
4447SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4448SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4449SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004450
4451static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004452half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004453{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004454 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004455 static PyObject *cmp_str;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004456 Py_ssize_t c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004457
Guido van Rossum60718732001-08-28 17:47:51 +00004458 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004459 if (func == NULL) {
4460 PyErr_Clear();
4461 }
4462 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004463 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004464 if (args == NULL)
4465 res = NULL;
4466 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004467 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004468 Py_DECREF(args);
4469 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004470 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004471 if (res != Py_NotImplemented) {
4472 if (res == NULL)
4473 return -2;
4474 c = PyInt_AsLong(res);
4475 Py_DECREF(res);
4476 if (c == -1 && PyErr_Occurred())
4477 return -2;
4478 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4479 }
4480 Py_DECREF(res);
4481 }
4482 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004483}
4484
Guido van Rossumab3b0342001-09-18 20:38:53 +00004485/* This slot is published for the benefit of try_3way_compare in object.c */
4486int
4487_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004488{
4489 int c;
4490
Guido van Rossumab3b0342001-09-18 20:38:53 +00004491 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004492 c = half_compare(self, other);
4493 if (c <= 1)
4494 return c;
4495 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004496 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004497 c = half_compare(other, self);
4498 if (c < -1)
4499 return -2;
4500 if (c <= 1)
4501 return -c;
4502 }
4503 return (void *)self < (void *)other ? -1 :
4504 (void *)self > (void *)other ? 1 : 0;
4505}
4506
4507static PyObject *
4508slot_tp_repr(PyObject *self)
4509{
4510 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004511 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004512
Guido van Rossum60718732001-08-28 17:47:51 +00004513 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004514 if (func != NULL) {
4515 res = PyEval_CallObject(func, NULL);
4516 Py_DECREF(func);
4517 return res;
4518 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004519 PyErr_Clear();
4520 return PyString_FromFormat("<%s object at %p>",
4521 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004522}
4523
4524static PyObject *
4525slot_tp_str(PyObject *self)
4526{
4527 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004528 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004529
Guido van Rossum60718732001-08-28 17:47:51 +00004530 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004531 if (func != NULL) {
4532 res = PyEval_CallObject(func, NULL);
4533 Py_DECREF(func);
4534 return res;
4535 }
4536 else {
4537 PyErr_Clear();
4538 return slot_tp_repr(self);
4539 }
4540}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004541
4542static long
4543slot_tp_hash(PyObject *self)
4544{
Tim Peters61ce0a92002-12-06 23:38:02 +00004545 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004546 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004547 long h;
4548
Guido van Rossum60718732001-08-28 17:47:51 +00004549 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004550
4551 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004552 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004553 Py_DECREF(func);
4554 if (res == NULL)
4555 return -1;
4556 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004557 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004558 }
4559 else {
4560 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004561 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004562 if (func == NULL) {
4563 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004564 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004565 }
4566 if (func != NULL) {
4567 Py_DECREF(func);
4568 PyErr_SetString(PyExc_TypeError, "unhashable type");
4569 return -1;
4570 }
4571 PyErr_Clear();
4572 h = _Py_HashPointer((void *)self);
4573 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004574 if (h == -1 && !PyErr_Occurred())
4575 h = -2;
4576 return h;
4577}
4578
4579static PyObject *
4580slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4581{
Guido van Rossum60718732001-08-28 17:47:51 +00004582 static PyObject *call_str;
4583 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004584 PyObject *res;
4585
4586 if (meth == NULL)
4587 return NULL;
4588 res = PyObject_Call(meth, args, kwds);
4589 Py_DECREF(meth);
4590 return res;
4591}
4592
Guido van Rossum14a6f832001-10-17 13:59:09 +00004593/* There are two slot dispatch functions for tp_getattro.
4594
4595 - slot_tp_getattro() is used when __getattribute__ is overridden
4596 but no __getattr__ hook is present;
4597
4598 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4599
Guido van Rossumc334df52002-04-04 23:44:47 +00004600 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4601 detects the absence of __getattr__ and then installs the simpler slot if
4602 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004603
Tim Peters6d6c1a32001-08-02 04:15:00 +00004604static PyObject *
4605slot_tp_getattro(PyObject *self, PyObject *name)
4606{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004607 static PyObject *getattribute_str = NULL;
4608 return call_method(self, "__getattribute__", &getattribute_str,
4609 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004610}
4611
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004612static PyObject *
4613slot_tp_getattr_hook(PyObject *self, PyObject *name)
4614{
4615 PyTypeObject *tp = self->ob_type;
4616 PyObject *getattr, *getattribute, *res;
4617 static PyObject *getattribute_str = NULL;
4618 static PyObject *getattr_str = NULL;
4619
4620 if (getattr_str == NULL) {
4621 getattr_str = PyString_InternFromString("__getattr__");
4622 if (getattr_str == NULL)
4623 return NULL;
4624 }
4625 if (getattribute_str == NULL) {
4626 getattribute_str =
4627 PyString_InternFromString("__getattribute__");
4628 if (getattribute_str == NULL)
4629 return NULL;
4630 }
4631 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004632 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004633 /* No __getattr__ hook: use a simpler dispatcher */
4634 tp->tp_getattro = slot_tp_getattro;
4635 return slot_tp_getattro(self, name);
4636 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004637 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004638 if (getattribute == NULL ||
4639 (getattribute->ob_type == &PyWrapperDescr_Type &&
4640 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4641 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004642 res = PyObject_GenericGetAttr(self, name);
4643 else
Georg Brandl684fd0c2006-05-25 19:15:31 +00004644 res = PyObject_CallFunctionObjArgs(getattribute, self, name, NULL);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004645 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004646 PyErr_Clear();
Georg Brandl684fd0c2006-05-25 19:15:31 +00004647 res = PyObject_CallFunctionObjArgs(getattr, self, name, NULL);
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004648 }
4649 return res;
4650}
4651
Tim Peters6d6c1a32001-08-02 04:15:00 +00004652static int
4653slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4654{
4655 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004656 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004657
4658 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004659 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004660 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004661 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004662 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004663 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004664 if (res == NULL)
4665 return -1;
4666 Py_DECREF(res);
4667 return 0;
4668}
4669
4670/* Map rich comparison operators to their __xx__ namesakes */
4671static char *name_op[] = {
4672 "__lt__",
4673 "__le__",
4674 "__eq__",
4675 "__ne__",
4676 "__gt__",
4677 "__ge__",
4678};
4679
4680static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004681half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004682{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004683 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004684 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004685
Guido van Rossum60718732001-08-28 17:47:51 +00004686 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004687 if (func == NULL) {
4688 PyErr_Clear();
4689 Py_INCREF(Py_NotImplemented);
4690 return Py_NotImplemented;
4691 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004692 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004693 if (args == NULL)
4694 res = NULL;
4695 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004696 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004697 Py_DECREF(args);
4698 }
4699 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004700 return res;
4701}
4702
Guido van Rossumb8f63662001-08-15 23:57:02 +00004703static PyObject *
4704slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4705{
4706 PyObject *res;
4707
4708 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4709 res = half_richcompare(self, other, op);
4710 if (res != Py_NotImplemented)
4711 return res;
4712 Py_DECREF(res);
4713 }
4714 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
Tim Petersf4aca752004-09-23 02:39:37 +00004715 res = half_richcompare(other, self, _Py_SwappedOp[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004716 if (res != Py_NotImplemented) {
4717 return res;
4718 }
4719 Py_DECREF(res);
4720 }
4721 Py_INCREF(Py_NotImplemented);
4722 return Py_NotImplemented;
4723}
4724
4725static PyObject *
4726slot_tp_iter(PyObject *self)
4727{
4728 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004729 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004730
Guido van Rossum60718732001-08-28 17:47:51 +00004731 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004732 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004733 PyObject *args;
4734 args = res = PyTuple_New(0);
4735 if (args != NULL) {
4736 res = PyObject_Call(func, args, NULL);
4737 Py_DECREF(args);
4738 }
4739 Py_DECREF(func);
4740 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004741 }
4742 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004743 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004744 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004745 PyErr_SetString(PyExc_TypeError,
4746 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00004747 return NULL;
4748 }
4749 Py_DECREF(func);
4750 return PySeqIter_New(self);
4751}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004752
4753static PyObject *
4754slot_tp_iternext(PyObject *self)
4755{
Guido van Rossum2730b132001-08-28 18:22:14 +00004756 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004757 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004758}
4759
Guido van Rossum1a493502001-08-17 16:47:50 +00004760static PyObject *
4761slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4762{
4763 PyTypeObject *tp = self->ob_type;
4764 PyObject *get;
4765 static PyObject *get_str = NULL;
4766
4767 if (get_str == NULL) {
4768 get_str = PyString_InternFromString("__get__");
4769 if (get_str == NULL)
4770 return NULL;
4771 }
4772 get = _PyType_Lookup(tp, get_str);
4773 if (get == NULL) {
4774 /* Avoid further slowdowns */
4775 if (tp->tp_descr_get == slot_tp_descr_get)
4776 tp->tp_descr_get = NULL;
4777 Py_INCREF(self);
4778 return self;
4779 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004780 if (obj == NULL)
4781 obj = Py_None;
4782 if (type == NULL)
4783 type = Py_None;
Georg Brandl684fd0c2006-05-25 19:15:31 +00004784 return PyObject_CallFunctionObjArgs(get, self, obj, type, NULL);
Guido van Rossum1a493502001-08-17 16:47:50 +00004785}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004786
4787static int
4788slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4789{
Guido van Rossum2c252392001-08-24 10:13:31 +00004790 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004791 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004792
4793 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004794 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004795 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004796 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004797 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004798 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004799 if (res == NULL)
4800 return -1;
4801 Py_DECREF(res);
4802 return 0;
4803}
4804
4805static int
4806slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4807{
Guido van Rossum60718732001-08-28 17:47:51 +00004808 static PyObject *init_str;
4809 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004810 PyObject *res;
4811
4812 if (meth == NULL)
4813 return -1;
4814 res = PyObject_Call(meth, args, kwds);
4815 Py_DECREF(meth);
4816 if (res == NULL)
4817 return -1;
Raymond Hettingerb67cc802005-03-03 16:45:19 +00004818 if (res != Py_None) {
4819 PyErr_SetString(PyExc_TypeError,
4820 "__init__() should return None");
4821 Py_DECREF(res);
4822 return -1;
4823 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004824 Py_DECREF(res);
4825 return 0;
4826}
4827
4828static PyObject *
4829slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4830{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004831 static PyObject *new_str;
4832 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004833 PyObject *newargs, *x;
Martin v. Löwis18e16552006-02-15 17:27:45 +00004834 Py_ssize_t i, n;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004835
Guido van Rossum7bed2132002-08-08 21:57:53 +00004836 if (new_str == NULL) {
4837 new_str = PyString_InternFromString("__new__");
4838 if (new_str == NULL)
4839 return NULL;
4840 }
4841 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004842 if (func == NULL)
4843 return NULL;
4844 assert(PyTuple_Check(args));
4845 n = PyTuple_GET_SIZE(args);
4846 newargs = PyTuple_New(n+1);
4847 if (newargs == NULL)
4848 return NULL;
4849 Py_INCREF(type);
4850 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4851 for (i = 0; i < n; i++) {
4852 x = PyTuple_GET_ITEM(args, i);
4853 Py_INCREF(x);
4854 PyTuple_SET_ITEM(newargs, i+1, x);
4855 }
4856 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004857 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004858 Py_DECREF(func);
4859 return x;
4860}
4861
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004862static void
4863slot_tp_del(PyObject *self)
4864{
4865 static PyObject *del_str = NULL;
4866 PyObject *del, *res;
4867 PyObject *error_type, *error_value, *error_traceback;
4868
4869 /* Temporarily resurrect the object. */
4870 assert(self->ob_refcnt == 0);
4871 self->ob_refcnt = 1;
4872
4873 /* Save the current exception, if any. */
4874 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4875
4876 /* Execute __del__ method, if any. */
4877 del = lookup_maybe(self, "__del__", &del_str);
4878 if (del != NULL) {
4879 res = PyEval_CallObject(del, NULL);
4880 if (res == NULL)
4881 PyErr_WriteUnraisable(del);
4882 else
4883 Py_DECREF(res);
4884 Py_DECREF(del);
4885 }
4886
4887 /* Restore the saved exception. */
4888 PyErr_Restore(error_type, error_value, error_traceback);
4889
4890 /* Undo the temporary resurrection; can't use DECREF here, it would
4891 * cause a recursive call.
4892 */
4893 assert(self->ob_refcnt > 0);
4894 if (--self->ob_refcnt == 0)
4895 return; /* this is the normal path out */
4896
4897 /* __del__ resurrected it! Make it look like the original Py_DECREF
4898 * never happened.
4899 */
4900 {
Martin v. Löwis725507b2006-03-07 12:08:51 +00004901 Py_ssize_t refcnt = self->ob_refcnt;
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004902 _Py_NewReference(self);
4903 self->ob_refcnt = refcnt;
4904 }
4905 assert(!PyType_IS_GC(self->ob_type) ||
4906 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
Michael W. Hudson3f3b6682004-08-03 10:21:03 +00004907 /* If Py_REF_DEBUG, _Py_NewReference bumped _Py_RefTotal, so
4908 * we need to undo that. */
4909 _Py_DEC_REFTOTAL;
4910 /* If Py_TRACE_REFS, _Py_NewReference re-added self to the object
4911 * chain, so no more to do there.
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004912 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
4913 * _Py_NewReference bumped tp_allocs: both of those need to be
4914 * undone.
4915 */
4916#ifdef COUNT_ALLOCS
4917 --self->ob_type->tp_frees;
4918 --self->ob_type->tp_allocs;
4919#endif
4920}
4921
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004922
4923/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00004924 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00004925 structure, which incorporates the additional structures used for numbers,
4926 sequences and mappings.
4927 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004928 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00004929 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
4930 terminated with an all-zero entry. (This table is further initialized and
4931 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004932
Guido van Rossum6d204072001-10-21 00:44:31 +00004933typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004934
4935#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00004936#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004937#undef ETSLOT
4938#undef SQSLOT
4939#undef MPSLOT
4940#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00004941#undef UNSLOT
4942#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004943#undef BINSLOT
4944#undef RBINSLOT
4945
Guido van Rossum6d204072001-10-21 00:44:31 +00004946#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004947 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
4948 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00004949#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
4950 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004951 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00004952#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00004953 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004954 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00004955#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4956 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
4957#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4958 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
4959#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4960 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
4961#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4962 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4963 "x." NAME "() <==> " DOC)
4964#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4965 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4966 "x." NAME "(y) <==> x" DOC "y")
4967#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
4968 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4969 "x." NAME "(y) <==> x" DOC "y")
4970#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
4971 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4972 "x." NAME "(y) <==> y" DOC "x")
Anthony Baxter56616992005-06-03 14:12:21 +00004973#define BINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4974 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4975 "x." NAME "(y) <==> " DOC)
4976#define RBINSLOTNOTINFIX(NAME, SLOT, FUNCTION, DOC) \
4977 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4978 "x." NAME "(y) <==> " DOC)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004979
4980static slotdef slotdefs[] = {
Martin v. Löwis18e16552006-02-15 17:27:45 +00004981 SQSLOT("__len__", sq_length, slot_sq_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00004982 "x.__len__() <==> len(x)"),
Armin Rigofd163f92005-12-29 15:59:19 +00004983 /* Heap types defining __add__/__mul__ have sq_concat/sq_repeat == NULL.
4984 The logic in abstract.c always falls back to nb_add/nb_multiply in
4985 this case. Defining both the nb_* and the sq_* slots to call the
4986 user-defined methods has unexpected side-effects, as shown by
4987 test_descr.notimplemented() */
4988 SQSLOT("__add__", sq_concat, NULL, wrap_binaryfunc,
4989 "x.__add__(y) <==> x+y"),
Armin Rigo314861c2006-03-30 14:04:02 +00004990 SQSLOT("__mul__", sq_repeat, NULL, wrap_indexargfunc,
Armin Rigofd163f92005-12-29 15:59:19 +00004991 "x.__mul__(n) <==> x*n"),
Armin Rigo314861c2006-03-30 14:04:02 +00004992 SQSLOT("__rmul__", sq_repeat, NULL, wrap_indexargfunc,
Armin Rigofd163f92005-12-29 15:59:19 +00004993 "x.__rmul__(n) <==> n*x"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004994 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
4995 "x.__getitem__(y) <==> x[y]"),
Martin v. Löwis18e16552006-02-15 17:27:45 +00004996 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_ssizessizeargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00004997 "x.__getslice__(i, j) <==> x[i:j]\n\
4998 \n\
4999 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005000 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005001 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005002 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00005003 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005004 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Martin v. Löwis18e16552006-02-15 17:27:45 +00005005 wrap_ssizessizeobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00005006 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
5007 \n\
5008 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005009 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00005010 "x.__delslice__(i, j) <==> del x[i:j]\n\
5011 \n\
5012 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00005013 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
5014 "x.__contains__(y) <==> y in x"),
Armin Rigofd163f92005-12-29 15:59:19 +00005015 SQSLOT("__iadd__", sq_inplace_concat, NULL,
5016 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
5017 SQSLOT("__imul__", sq_inplace_repeat, NULL,
Armin Rigo314861c2006-03-30 14:04:02 +00005018 wrap_indexargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005019
Martin v. Löwis18e16552006-02-15 17:27:45 +00005020 MPSLOT("__len__", mp_length, slot_mp_length, wrap_lenfunc,
Guido van Rossum6d204072001-10-21 00:44:31 +00005021 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00005022 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005023 wrap_binaryfunc,
5024 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005025 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005026 wrap_objobjargproc,
5027 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005028 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00005029 wrap_delitem,
5030 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005031
Guido van Rossum6d204072001-10-21 00:44:31 +00005032 BINSLOT("__add__", nb_add, slot_nb_add,
5033 "+"),
5034 RBINSLOT("__radd__", nb_add, slot_nb_add,
5035 "+"),
5036 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
5037 "-"),
5038 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
5039 "-"),
5040 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
5041 "*"),
5042 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
5043 "*"),
5044 BINSLOT("__div__", nb_divide, slot_nb_divide,
5045 "/"),
5046 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
5047 "/"),
5048 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
5049 "%"),
5050 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
5051 "%"),
Anthony Baxter56616992005-06-03 14:12:21 +00005052 BINSLOTNOTINFIX("__divmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005053 "divmod(x, y)"),
Anthony Baxter56616992005-06-03 14:12:21 +00005054 RBINSLOTNOTINFIX("__rdivmod__", nb_divmod, slot_nb_divmod,
Guido van Rossum6d204072001-10-21 00:44:31 +00005055 "divmod(y, x)"),
5056 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
5057 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
5058 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
5059 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
5060 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
5061 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
5062 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
5063 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00005064 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00005065 "x != 0"),
5066 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
5067 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
5068 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
5069 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
5070 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
5071 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
5072 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
5073 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
5074 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
5075 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
5076 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
5077 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
5078 "x.__coerce__(y) <==> coerce(x, y)"),
5079 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
5080 "int(x)"),
5081 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
5082 "long(x)"),
5083 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
5084 "float(x)"),
5085 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
5086 "oct(x)"),
5087 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
5088 "hex(x)"),
Guido van Rossum38fff8c2006-03-07 18:50:55 +00005089 NBSLOT("__index__", nb_index, slot_nb_index, wrap_lenfunc,
5090 "x[y:z] <==> x[y.__index__():z.__index__()]"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005091 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5092 wrap_binaryfunc, "+"),
5093 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5094 wrap_binaryfunc, "-"),
5095 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5096 wrap_binaryfunc, "*"),
5097 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5098 wrap_binaryfunc, "/"),
5099 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5100 wrap_binaryfunc, "%"),
5101 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005102 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005103 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5104 wrap_binaryfunc, "<<"),
5105 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5106 wrap_binaryfunc, ">>"),
5107 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5108 wrap_binaryfunc, "&"),
5109 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5110 wrap_binaryfunc, "^"),
5111 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5112 wrap_binaryfunc, "|"),
5113 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5114 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5115 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5116 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5117 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5118 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5119 IBSLOT("__itruediv__", nb_inplace_true_divide,
5120 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005121
Guido van Rossum6d204072001-10-21 00:44:31 +00005122 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5123 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005124 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005125 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5126 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005127 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005128 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5129 "x.__cmp__(y) <==> cmp(x,y)"),
5130 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5131 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005132 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5133 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005134 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005135 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5136 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5137 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5138 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5139 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5140 "x.__setattr__('name', value) <==> x.name = value"),
5141 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5142 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5143 "x.__delattr__('name') <==> del x.name"),
5144 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5145 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5146 "x.__lt__(y) <==> x<y"),
5147 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5148 "x.__le__(y) <==> x<=y"),
5149 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5150 "x.__eq__(y) <==> x==y"),
5151 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5152 "x.__ne__(y) <==> x!=y"),
5153 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5154 "x.__gt__(y) <==> x>y"),
5155 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5156 "x.__ge__(y) <==> x>=y"),
5157 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5158 "x.__iter__() <==> iter(x)"),
5159 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5160 "x.next() -> the next value, or raise StopIteration"),
5161 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5162 "descr.__get__(obj[, type]) -> value"),
5163 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5164 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005165 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5166 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005167 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005168 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005169 "see x.__class__.__doc__ for signature",
5170 PyWrapperFlag_KEYWORDS),
5171 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005172 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005173 {NULL}
5174};
5175
Guido van Rossumc334df52002-04-04 23:44:47 +00005176/* Given a type pointer and an offset gotten from a slotdef entry, return a
5177 pointer to the actual slot. This is not quite the same as simply adding
5178 the offset to the type pointer, since it takes care to indirect through the
5179 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5180 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005181static void **
Martin v. Löwis18e16552006-02-15 17:27:45 +00005182slotptr(PyTypeObject *type, int ioffset)
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005183{
5184 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005185 long offset = ioffset;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005186
Guido van Rossume5c691a2003-03-07 15:13:17 +00005187 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005188 assert(offset >= 0);
Skip Montanaro429433b2006-04-18 00:35:43 +00005189 assert((size_t)offset < offsetof(PyHeapTypeObject, as_buffer));
5190 if ((size_t)offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005191 ptr = (char *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005192 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005193 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005194 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005195 ptr = (char *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005196 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005197 }
Skip Montanaro429433b2006-04-18 00:35:43 +00005198 else if ((size_t)offset >= offsetof(PyHeapTypeObject, as_number)) {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005199 ptr = (char *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005200 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005201 }
5202 else {
Martin v. Löwisee36d652006-04-11 09:08:02 +00005203 ptr = (char *)type;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005204 }
5205 if (ptr != NULL)
5206 ptr += offset;
5207 return (void **)ptr;
5208}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005209
Guido van Rossumc334df52002-04-04 23:44:47 +00005210/* Length of array of slotdef pointers used to store slots with the
5211 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5212 the same __name__, for any __name__. Since that's a static property, it is
5213 appropriate to declare fixed-size arrays for this. */
5214#define MAX_EQUIV 10
5215
5216/* Return a slot pointer for a given name, but ONLY if the attribute has
5217 exactly one slot function. The name must be an interned string. */
5218static void **
5219resolve_slotdups(PyTypeObject *type, PyObject *name)
5220{
5221 /* XXX Maybe this could be optimized more -- but is it worth it? */
5222
5223 /* pname and ptrs act as a little cache */
5224 static PyObject *pname;
5225 static slotdef *ptrs[MAX_EQUIV];
5226 slotdef *p, **pp;
5227 void **res, **ptr;
5228
5229 if (pname != name) {
5230 /* Collect all slotdefs that match name into ptrs. */
5231 pname = name;
5232 pp = ptrs;
5233 for (p = slotdefs; p->name_strobj; p++) {
5234 if (p->name_strobj == name)
5235 *pp++ = p;
5236 }
5237 *pp = NULL;
5238 }
5239
5240 /* Look in all matching slots of the type; if exactly one of these has
5241 a filled-in slot, return its value. Otherwise return NULL. */
5242 res = NULL;
5243 for (pp = ptrs; *pp; pp++) {
5244 ptr = slotptr(type, (*pp)->offset);
5245 if (ptr == NULL || *ptr == NULL)
5246 continue;
5247 if (res != NULL)
5248 return NULL;
5249 res = ptr;
5250 }
5251 return res;
5252}
5253
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005254/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005255 does some incredibly complex thinking and then sticks something into the
5256 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5257 interests, and then stores a generic wrapper or a specific function into
5258 the slot.) Return a pointer to the next slotdef with a different offset,
5259 because that's convenient for fixup_slot_dispatchers(). */
5260static slotdef *
5261update_one_slot(PyTypeObject *type, slotdef *p)
5262{
5263 PyObject *descr;
5264 PyWrapperDescrObject *d;
5265 void *generic = NULL, *specific = NULL;
5266 int use_generic = 0;
5267 int offset = p->offset;
5268 void **ptr = slotptr(type, offset);
5269
5270 if (ptr == NULL) {
5271 do {
5272 ++p;
5273 } while (p->offset == offset);
5274 return p;
5275 }
5276 do {
5277 descr = _PyType_Lookup(type, p->name_strobj);
5278 if (descr == NULL)
5279 continue;
5280 if (descr->ob_type == &PyWrapperDescr_Type) {
5281 void **tptr = resolve_slotdups(type, p->name_strobj);
5282 if (tptr == NULL || tptr == ptr)
5283 generic = p->function;
5284 d = (PyWrapperDescrObject *)descr;
5285 if (d->d_base->wrapper == p->wrapper &&
5286 PyType_IsSubtype(type, d->d_type))
5287 {
5288 if (specific == NULL ||
5289 specific == d->d_wrapped)
5290 specific = d->d_wrapped;
5291 else
5292 use_generic = 1;
5293 }
5294 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005295 else if (descr->ob_type == &PyCFunction_Type &&
5296 PyCFunction_GET_FUNCTION(descr) ==
5297 (PyCFunction)tp_new_wrapper &&
5298 strcmp(p->name, "__new__") == 0)
5299 {
5300 /* The __new__ wrapper is not a wrapper descriptor,
5301 so must be special-cased differently.
5302 If we don't do this, creating an instance will
5303 always use slot_tp_new which will look up
5304 __new__ in the MRO which will call tp_new_wrapper
5305 which will look through the base classes looking
5306 for a static base and call its tp_new (usually
5307 PyType_GenericNew), after performing various
5308 sanity checks and constructing a new argument
5309 list. Cut all that nonsense short -- this speeds
5310 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005311 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005312 /* XXX I'm not 100% sure that there isn't a hole
5313 in this reasoning that requires additional
5314 sanity checks. I'll buy the first person to
5315 point out a bug in this reasoning a beer. */
5316 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005317 else {
5318 use_generic = 1;
5319 generic = p->function;
5320 }
5321 } while ((++p)->offset == offset);
5322 if (specific && !use_generic)
5323 *ptr = specific;
5324 else
5325 *ptr = generic;
5326 return p;
5327}
5328
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005329/* In the type, update the slots whose slotdefs are gathered in the pp array.
5330 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005331static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005332update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005333{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005334 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005335
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005336 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005337 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005338 return 0;
5339}
5340
Guido van Rossumc334df52002-04-04 23:44:47 +00005341/* Comparison function for qsort() to compare slotdefs by their offset, and
5342 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005343static int
5344slotdef_cmp(const void *aa, const void *bb)
5345{
5346 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5347 int c = a->offset - b->offset;
5348 if (c != 0)
5349 return c;
5350 else
Martin v. Löwis18e16552006-02-15 17:27:45 +00005351 /* Cannot use a-b, as this gives off_t,
5352 which may lose precision when converted to int. */
5353 return (a > b) ? 1 : (a < b) ? -1 : 0;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005354}
5355
Guido van Rossumc334df52002-04-04 23:44:47 +00005356/* Initialize the slotdefs table by adding interned string objects for the
5357 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005358static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005359init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005360{
5361 slotdef *p;
5362 static int initialized = 0;
5363
5364 if (initialized)
5365 return;
5366 for (p = slotdefs; p->name; p++) {
5367 p->name_strobj = PyString_InternFromString(p->name);
5368 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005369 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005370 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005371 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5372 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005373 initialized = 1;
5374}
5375
Guido van Rossumc334df52002-04-04 23:44:47 +00005376/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005377static int
5378update_slot(PyTypeObject *type, PyObject *name)
5379{
Guido van Rossumc334df52002-04-04 23:44:47 +00005380 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005381 slotdef *p;
5382 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005383 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005384
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005385 init_slotdefs();
5386 pp = ptrs;
5387 for (p = slotdefs; p->name; p++) {
5388 /* XXX assume name is interned! */
5389 if (p->name_strobj == name)
5390 *pp++ = p;
5391 }
5392 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005393 for (pp = ptrs; *pp; pp++) {
5394 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005395 offset = p->offset;
5396 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005397 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005398 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005399 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005400 if (ptrs[0] == NULL)
5401 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005402 return update_subclasses(type, name,
5403 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005404}
5405
Guido van Rossumc334df52002-04-04 23:44:47 +00005406/* Store the proper functions in the slot dispatches at class (type)
5407 definition time, based upon which operations the class overrides in its
5408 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005409static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005410fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005411{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005412 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005413
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005414 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005415 for (p = slotdefs; p->name; )
5416 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005417}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005418
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005419static void
5420update_all_slots(PyTypeObject* type)
5421{
5422 slotdef *p;
5423
5424 init_slotdefs();
5425 for (p = slotdefs; p->name; p++) {
5426 /* update_slot returns int but can't actually fail */
5427 update_slot(type, p->name_strobj);
5428 }
5429}
5430
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005431/* recurse_down_subclasses() and update_subclasses() are mutually
5432 recursive functions to call a callback for all subclasses,
5433 but refraining from recursing into subclasses that define 'name'. */
5434
5435static int
5436update_subclasses(PyTypeObject *type, PyObject *name,
5437 update_callback callback, void *data)
5438{
5439 if (callback(type, data) < 0)
5440 return -1;
5441 return recurse_down_subclasses(type, name, callback, data);
5442}
5443
5444static int
5445recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5446 update_callback callback, void *data)
5447{
5448 PyTypeObject *subclass;
5449 PyObject *ref, *subclasses, *dict;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005450 Py_ssize_t i, n;
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005451
5452 subclasses = type->tp_subclasses;
5453 if (subclasses == NULL)
5454 return 0;
5455 assert(PyList_Check(subclasses));
5456 n = PyList_GET_SIZE(subclasses);
5457 for (i = 0; i < n; i++) {
5458 ref = PyList_GET_ITEM(subclasses, i);
5459 assert(PyWeakref_CheckRef(ref));
5460 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5461 assert(subclass != NULL);
5462 if ((PyObject *)subclass == Py_None)
5463 continue;
5464 assert(PyType_Check(subclass));
5465 /* Avoid recursing down into unaffected classes */
5466 dict = subclass->tp_dict;
5467 if (dict != NULL && PyDict_Check(dict) &&
5468 PyDict_GetItem(dict, name) != NULL)
5469 continue;
5470 if (update_subclasses(subclass, name, callback, data) < 0)
5471 return -1;
5472 }
5473 return 0;
5474}
5475
Guido van Rossum6d204072001-10-21 00:44:31 +00005476/* This function is called by PyType_Ready() to populate the type's
5477 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005478 function slot (like tp_repr) that's defined in the type, one or more
5479 corresponding descriptors are added in the type's tp_dict dictionary
5480 under the appropriate name (like __repr__). Some function slots
5481 cause more than one descriptor to be added (for example, the nb_add
5482 slot adds both __add__ and __radd__ descriptors) and some function
5483 slots compete for the same descriptor (for example both sq_item and
5484 mp_subscript generate a __getitem__ descriptor).
5485
5486 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005487 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005488 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005489 between competing slots: the members of PyHeapTypeObject are listed
5490 from most general to least general, so the most general slot is
5491 preferred. In particular, because as_mapping comes before as_sequence,
5492 for a type that defines both mp_subscript and sq_item, mp_subscript
5493 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005494
5495 This only adds new descriptors and doesn't overwrite entries in
5496 tp_dict that were previously defined. The descriptors contain a
5497 reference to the C function they must call, so that it's safe if they
5498 are copied into a subtype's __dict__ and the subtype has a different
5499 C function in its slot -- calling the method defined by the
5500 descriptor will call the C function that was used to create it,
5501 rather than the C function present in the slot when it is called.
5502 (This is important because a subtype may have a C function in the
5503 slot that calls the method from the dictionary, and we want to avoid
5504 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005505
5506static int
5507add_operators(PyTypeObject *type)
5508{
5509 PyObject *dict = type->tp_dict;
5510 slotdef *p;
5511 PyObject *descr;
5512 void **ptr;
5513
5514 init_slotdefs();
5515 for (p = slotdefs; p->name; p++) {
5516 if (p->wrapper == NULL)
5517 continue;
5518 ptr = slotptr(type, p->offset);
5519 if (!ptr || !*ptr)
5520 continue;
5521 if (PyDict_GetItem(dict, p->name_strobj))
5522 continue;
5523 descr = PyDescr_NewWrapper(type, p, *ptr);
5524 if (descr == NULL)
5525 return -1;
5526 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5527 return -1;
5528 Py_DECREF(descr);
5529 }
5530 if (type->tp_new != NULL) {
5531 if (add_tp_new_wrapper(type) < 0)
5532 return -1;
5533 }
5534 return 0;
5535}
5536
Guido van Rossum705f0f52001-08-24 16:47:00 +00005537
5538/* Cooperative 'super' */
5539
5540typedef struct {
5541 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005542 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005543 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005544 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005545} superobject;
5546
Guido van Rossum6f799372001-09-20 20:46:19 +00005547static PyMemberDef super_members[] = {
5548 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5549 "the class invoking super()"},
5550 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5551 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005552 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005553 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005554 {0}
5555};
5556
Guido van Rossum705f0f52001-08-24 16:47:00 +00005557static void
5558super_dealloc(PyObject *self)
5559{
5560 superobject *su = (superobject *)self;
5561
Guido van Rossum048eb752001-10-02 21:24:57 +00005562 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005563 Py_XDECREF(su->obj);
5564 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005565 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005566 self->ob_type->tp_free(self);
5567}
5568
5569static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005570super_repr(PyObject *self)
5571{
5572 superobject *su = (superobject *)self;
5573
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005574 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005575 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005576 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005577 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005578 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005579 else
5580 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005581 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005582 su->type ? su->type->tp_name : "NULL");
5583}
5584
5585static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005586super_getattro(PyObject *self, PyObject *name)
5587{
5588 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005589 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005590
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005591 if (!skip) {
5592 /* We want __class__ to return the class of the super object
5593 (i.e. super, or a subclass), not the class of su->obj. */
5594 skip = (PyString_Check(name) &&
5595 PyString_GET_SIZE(name) == 9 &&
5596 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5597 }
5598
5599 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005600 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005601 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005602 descrgetfunc f;
Martin v. Löwis18e16552006-02-15 17:27:45 +00005603 Py_ssize_t i, n;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005604
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005605 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005606 mro = starttype->tp_mro;
5607
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005608 if (mro == NULL)
5609 n = 0;
5610 else {
5611 assert(PyTuple_Check(mro));
5612 n = PyTuple_GET_SIZE(mro);
5613 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005614 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005615 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005616 break;
5617 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005618 i++;
5619 res = NULL;
5620 for (; i < n; i++) {
5621 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005622 if (PyType_Check(tmp))
5623 dict = ((PyTypeObject *)tmp)->tp_dict;
5624 else if (PyClass_Check(tmp))
5625 dict = ((PyClassObject *)tmp)->cl_dict;
5626 else
5627 continue;
5628 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005629 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005630 Py_INCREF(res);
5631 f = res->ob_type->tp_descr_get;
5632 if (f != NULL) {
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005633 tmp = f(res,
5634 /* Only pass 'obj' param if
5635 this is instance-mode super
5636 (See SF ID #743627)
5637 */
Hye-Shik Changff365c92004-03-25 16:37:03 +00005638 (su->obj == (PyObject *)
5639 su->obj_type
Phillip J. Eby91a968a2004-03-25 02:19:34 +00005640 ? (PyObject *)NULL
5641 : su->obj),
Guido van Rossumd4641072002-04-03 02:13:37 +00005642 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005643 Py_DECREF(res);
5644 res = tmp;
5645 }
5646 return res;
5647 }
5648 }
5649 }
5650 return PyObject_GenericGetAttr(self, name);
5651}
5652
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005653static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005654supercheck(PyTypeObject *type, PyObject *obj)
5655{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005656 /* Check that a super() call makes sense. Return a type object.
5657
5658 obj can be a new-style class, or an instance of one:
5659
5660 - If it is a class, it must be a subclass of 'type'. This case is
5661 used for class methods; the return value is obj.
5662
5663 - If it is an instance, it must be an instance of 'type'. This is
5664 the normal case; the return value is obj.__class__.
5665
5666 But... when obj is an instance, we want to allow for the case where
5667 obj->ob_type is not a subclass of type, but obj.__class__ is!
5668 This will allow using super() with a proxy for obj.
5669 */
5670
Guido van Rossum8e80a722003-02-18 19:22:22 +00005671 /* Check for first bullet above (special case) */
5672 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5673 Py_INCREF(obj);
5674 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005675 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005676
5677 /* Normal case */
5678 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005679 Py_INCREF(obj->ob_type);
5680 return obj->ob_type;
5681 }
5682 else {
5683 /* Try the slow way */
5684 static PyObject *class_str = NULL;
5685 PyObject *class_attr;
5686
5687 if (class_str == NULL) {
5688 class_str = PyString_FromString("__class__");
5689 if (class_str == NULL)
5690 return NULL;
5691 }
5692
5693 class_attr = PyObject_GetAttr(obj, class_str);
5694
5695 if (class_attr != NULL &&
5696 PyType_Check(class_attr) &&
5697 (PyTypeObject *)class_attr != obj->ob_type)
5698 {
5699 int ok = PyType_IsSubtype(
5700 (PyTypeObject *)class_attr, type);
5701 if (ok)
5702 return (PyTypeObject *)class_attr;
5703 }
5704
5705 if (class_attr == NULL)
5706 PyErr_Clear();
5707 else
5708 Py_DECREF(class_attr);
5709 }
5710
Tim Peters97e5ff52003-02-18 19:32:50 +00005711 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005712 "super(type, obj): "
5713 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005714 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005715}
5716
Guido van Rossum705f0f52001-08-24 16:47:00 +00005717static PyObject *
5718super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5719{
5720 superobject *su = (superobject *)self;
Anthony Baxtera6286212006-04-11 07:42:36 +00005721 superobject *newobj;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005722
5723 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5724 /* Not binding to an object, or already bound */
5725 Py_INCREF(self);
5726 return self;
5727 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005728 if (su->ob_type != &PySuper_Type)
Armin Rigo7726dc02005-05-15 15:32:08 +00005729 /* If su is an instance of a (strict) subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005730 call its type */
Georg Brandl684fd0c2006-05-25 19:15:31 +00005731 return PyObject_CallFunctionObjArgs((PyObject *)su->ob_type,
5732 su->type, obj, NULL);
Guido van Rossum5b443c62001-12-03 15:38:28 +00005733 else {
5734 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005735 PyTypeObject *obj_type = supercheck(su->type, obj);
5736 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005737 return NULL;
Anthony Baxtera6286212006-04-11 07:42:36 +00005738 newobj = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005739 NULL, NULL);
Anthony Baxtera6286212006-04-11 07:42:36 +00005740 if (newobj == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005741 return NULL;
5742 Py_INCREF(su->type);
5743 Py_INCREF(obj);
Anthony Baxtera6286212006-04-11 07:42:36 +00005744 newobj->type = su->type;
5745 newobj->obj = obj;
5746 newobj->obj_type = obj_type;
5747 return (PyObject *)newobj;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005748 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005749}
5750
5751static int
5752super_init(PyObject *self, PyObject *args, PyObject *kwds)
5753{
5754 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005755 PyTypeObject *type;
5756 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005757 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005758
5759 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5760 return -1;
5761 if (obj == Py_None)
5762 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005763 if (obj != NULL) {
5764 obj_type = supercheck(type, obj);
5765 if (obj_type == NULL)
5766 return -1;
5767 Py_INCREF(obj);
5768 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005769 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005770 su->type = type;
5771 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005772 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005773 return 0;
5774}
5775
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005776PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005777"super(type) -> unbound super object\n"
5778"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005779"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005780"Typical use to call a cooperative superclass method:\n"
5781"class C(B):\n"
5782" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005783" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005784
Guido van Rossum048eb752001-10-02 21:24:57 +00005785static int
5786super_traverse(PyObject *self, visitproc visit, void *arg)
5787{
5788 superobject *su = (superobject *)self;
Guido van Rossum048eb752001-10-02 21:24:57 +00005789
Thomas Woutersc6e55062006-04-15 21:47:09 +00005790 Py_VISIT(su->obj);
5791 Py_VISIT(su->type);
5792 Py_VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005793
5794 return 0;
5795}
5796
Guido van Rossum705f0f52001-08-24 16:47:00 +00005797PyTypeObject PySuper_Type = {
5798 PyObject_HEAD_INIT(&PyType_Type)
5799 0, /* ob_size */
5800 "super", /* tp_name */
5801 sizeof(superobject), /* tp_basicsize */
5802 0, /* tp_itemsize */
5803 /* methods */
5804 super_dealloc, /* tp_dealloc */
5805 0, /* tp_print */
5806 0, /* tp_getattr */
5807 0, /* tp_setattr */
5808 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005809 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005810 0, /* tp_as_number */
5811 0, /* tp_as_sequence */
5812 0, /* tp_as_mapping */
5813 0, /* tp_hash */
5814 0, /* tp_call */
5815 0, /* tp_str */
5816 super_getattro, /* tp_getattro */
5817 0, /* tp_setattro */
5818 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005819 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5820 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005821 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00005822 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005823 0, /* tp_clear */
5824 0, /* tp_richcompare */
5825 0, /* tp_weaklistoffset */
5826 0, /* tp_iter */
5827 0, /* tp_iternext */
5828 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005829 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005830 0, /* tp_getset */
5831 0, /* tp_base */
5832 0, /* tp_dict */
5833 super_descr_get, /* tp_descr_get */
5834 0, /* tp_descr_set */
5835 0, /* tp_dictoffset */
5836 super_init, /* tp_init */
5837 PyType_GenericAlloc, /* tp_alloc */
5838 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00005839 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005840};