blob: e4eadb89a7652f77376d4ce25548175078ea461d [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* Type object implementation */
2
Guido van Rossumc0b618a1997-05-02 03:12:38 +00003#include "Python.h"
Tim Peters6d6c1a32001-08-02 04:15:00 +00004#include "structmember.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00005
Guido van Rossum9923ffe2002-06-04 19:52:53 +00006#include <ctype.h>
7
Guido van Rossum6f799372001-09-20 20:46:19 +00008static PyMemberDef type_members[] = {
Tim Peters6d6c1a32001-08-02 04:15:00 +00009 {"__basicsize__", T_INT, offsetof(PyTypeObject,tp_basicsize),READONLY},
10 {"__itemsize__", T_INT, offsetof(PyTypeObject, tp_itemsize), READONLY},
11 {"__flags__", T_LONG, offsetof(PyTypeObject, tp_flags), READONLY},
Guido van Rossum9676b222001-08-17 20:32:36 +000012 {"__weakrefoffset__", T_LONG,
Tim Peters6d6c1a32001-08-02 04:15:00 +000013 offsetof(PyTypeObject, tp_weaklistoffset), READONLY},
14 {"__base__", T_OBJECT, offsetof(PyTypeObject, tp_base), READONLY},
15 {"__dictoffset__", T_LONG,
16 offsetof(PyTypeObject, tp_dictoffset), READONLY},
Tim Peters6d6c1a32001-08-02 04:15:00 +000017 {"__mro__", T_OBJECT, offsetof(PyTypeObject, tp_mro), READONLY},
18 {0}
19};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Guido van Rossumc0b618a1997-05-02 03:12:38 +000021static PyObject *
Guido van Rossumc3542212001-08-16 09:18:56 +000022type_name(PyTypeObject *type, void *context)
23{
24 char *s;
25
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000026 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
Guido van Rossume5c691a2003-03-07 15:13:17 +000027 PyHeapTypeObject* et = (PyHeapTypeObject*)type;
Tim Petersea7f75d2002-12-07 21:39:16 +000028
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000029 Py_INCREF(et->name);
30 return et->name;
31 }
32 else {
33 s = strrchr(type->tp_name, '.');
34 if (s == NULL)
35 s = type->tp_name;
36 else
37 s++;
38 return PyString_FromString(s);
39 }
Guido van Rossumc3542212001-08-16 09:18:56 +000040}
41
Michael W. Hudson98bbc492002-11-26 14:47:27 +000042static int
43type_set_name(PyTypeObject *type, PyObject *value, void *context)
44{
Guido van Rossume5c691a2003-03-07 15:13:17 +000045 PyHeapTypeObject* et;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000046
47 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
48 PyErr_Format(PyExc_TypeError,
49 "can't set %s.__name__", type->tp_name);
50 return -1;
51 }
52 if (!value) {
53 PyErr_Format(PyExc_TypeError,
54 "can't delete %s.__name__", type->tp_name);
55 return -1;
56 }
57 if (!PyString_Check(value)) {
58 PyErr_Format(PyExc_TypeError,
59 "can only assign string to %s.__name__, not '%s'",
60 type->tp_name, value->ob_type->tp_name);
61 return -1;
62 }
Tim Petersea7f75d2002-12-07 21:39:16 +000063 if (strlen(PyString_AS_STRING(value))
Michael W. Hudson98bbc492002-11-26 14:47:27 +000064 != (size_t)PyString_GET_SIZE(value)) {
65 PyErr_Format(PyExc_ValueError,
66 "__name__ must not contain null bytes");
67 return -1;
68 }
69
Guido van Rossume5c691a2003-03-07 15:13:17 +000070 et = (PyHeapTypeObject*)type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +000071
72 Py_INCREF(value);
73
74 Py_DECREF(et->name);
75 et->name = value;
76
77 type->tp_name = PyString_AS_STRING(value);
78
79 return 0;
80}
81
Guido van Rossumc3542212001-08-16 09:18:56 +000082static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +000083type_module(PyTypeObject *type, void *context)
Guido van Rossum29ca26e1995-01-07 11:58:15 +000084{
Guido van Rossumc3542212001-08-16 09:18:56 +000085 PyObject *mod;
86 char *s;
87
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000088 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
89 mod = PyDict_GetItemString(type->tp_dict, "__module__");
90 Py_XINCREF(mod);
Guido van Rossumc3542212001-08-16 09:18:56 +000091 return mod;
92 }
Michael W. Hudsonade8c8b2002-11-27 16:29:26 +000093 else {
94 s = strrchr(type->tp_name, '.');
95 if (s != NULL)
96 return PyString_FromStringAndSize(
97 type->tp_name, (int)(s - type->tp_name));
98 return PyString_FromString("__builtin__");
99 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000100}
101
Guido van Rossum3926a632001-09-25 16:25:58 +0000102static int
103type_set_module(PyTypeObject *type, PyObject *value, void *context)
104{
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000105 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
Guido van Rossum3926a632001-09-25 16:25:58 +0000106 PyErr_Format(PyExc_TypeError,
107 "can't set %s.__module__", type->tp_name);
108 return -1;
109 }
110 if (!value) {
111 PyErr_Format(PyExc_TypeError,
112 "can't delete %s.__module__", type->tp_name);
113 return -1;
114 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000115
Guido van Rossum3926a632001-09-25 16:25:58 +0000116 return PyDict_SetItemString(type->tp_dict, "__module__", value);
117}
118
Tim Peters6d6c1a32001-08-02 04:15:00 +0000119static PyObject *
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000120type_get_bases(PyTypeObject *type, void *context)
121{
122 Py_INCREF(type->tp_bases);
123 return type->tp_bases;
124}
125
126static PyTypeObject *best_base(PyObject *);
127static int mro_internal(PyTypeObject *);
128static int compatible_for_assignment(PyTypeObject *, PyTypeObject *, char *);
129static int add_subclass(PyTypeObject*, PyTypeObject*);
130static void remove_subclass(PyTypeObject *, PyTypeObject *);
131static void update_all_slots(PyTypeObject *);
132
Guido van Rossum8d24ee92003-03-24 23:49:49 +0000133typedef int (*update_callback)(PyTypeObject *, void *);
134static int update_subclasses(PyTypeObject *type, PyObject *name,
135 update_callback callback, void *data);
136static int recurse_down_subclasses(PyTypeObject *type, PyObject *name,
137 update_callback callback, void *data);
138
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000139static int
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000140mro_subclasses(PyTypeObject *type, PyObject* temp)
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000141{
142 PyTypeObject *subclass;
143 PyObject *ref, *subclasses, *old_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000144 int i, n;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000145
146 subclasses = type->tp_subclasses;
147 if (subclasses == NULL)
148 return 0;
149 assert(PyList_Check(subclasses));
150 n = PyList_GET_SIZE(subclasses);
151 for (i = 0; i < n; i++) {
152 ref = PyList_GET_ITEM(subclasses, i);
153 assert(PyWeakref_CheckRef(ref));
154 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
155 assert(subclass != NULL);
156 if ((PyObject *)subclass == Py_None)
157 continue;
158 assert(PyType_Check(subclass));
159 old_mro = subclass->tp_mro;
160 if (mro_internal(subclass) < 0) {
161 subclass->tp_mro = old_mro;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000162 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000163 }
164 else {
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000165 PyObject* tuple;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000166 tuple = PyTuple_Pack(2, subclass, old_mro);
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000167 Py_DECREF(old_mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000168 if (!tuple)
169 return -1;
170 if (PyList_Append(temp, tuple) < 0)
171 return -1;
Guido van Rossum19a02ba2003-04-15 22:09:45 +0000172 Py_DECREF(tuple);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000173 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000174 if (mro_subclasses(subclass, temp) < 0)
175 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000176 }
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000177 return 0;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000178}
179
180static int
181type_set_bases(PyTypeObject *type, PyObject *value, void *context)
182{
183 int i, r = 0;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000184 PyObject *ob, *temp;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000185 PyTypeObject *new_base, *old_base;
186 PyObject *old_bases, *old_mro;
187
188 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
189 PyErr_Format(PyExc_TypeError,
190 "can't set %s.__bases__", type->tp_name);
191 return -1;
192 }
193 if (!value) {
194 PyErr_Format(PyExc_TypeError,
195 "can't delete %s.__bases__", type->tp_name);
196 return -1;
197 }
198 if (!PyTuple_Check(value)) {
199 PyErr_Format(PyExc_TypeError,
200 "can only assign tuple to %s.__bases__, not %s",
201 type->tp_name, value->ob_type->tp_name);
202 return -1;
203 }
Guido van Rossum3bbc0ee2002-12-13 17:49:38 +0000204 if (PyTuple_GET_SIZE(value) == 0) {
205 PyErr_Format(PyExc_TypeError,
206 "can only assign non-empty tuple to %s.__bases__, not ()",
207 type->tp_name);
208 return -1;
209 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000210 for (i = 0; i < PyTuple_GET_SIZE(value); i++) {
211 ob = PyTuple_GET_ITEM(value, i);
212 if (!PyClass_Check(ob) && !PyType_Check(ob)) {
213 PyErr_Format(
214 PyExc_TypeError,
215 "%s.__bases__ must be tuple of old- or new-style classes, not '%s'",
216 type->tp_name, ob->ob_type->tp_name);
217 return -1;
218 }
Michael W. Hudsoncaf17be2002-11-27 10:24:44 +0000219 if (PyType_Check(ob)) {
220 if (PyType_IsSubtype((PyTypeObject*)ob, type)) {
221 PyErr_SetString(PyExc_TypeError,
222 "a __bases__ item causes an inheritance cycle");
223 return -1;
224 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000225 }
226 }
227
228 new_base = best_base(value);
229
230 if (!new_base) {
231 return -1;
232 }
233
234 if (!compatible_for_assignment(type->tp_base, new_base, "__bases__"))
235 return -1;
236
237 Py_INCREF(new_base);
238 Py_INCREF(value);
239
240 old_bases = type->tp_bases;
241 old_base = type->tp_base;
242 old_mro = type->tp_mro;
243
244 type->tp_bases = value;
245 type->tp_base = new_base;
246
247 if (mro_internal(type) < 0) {
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000248 goto bail;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000249 }
250
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000251 temp = PyList_New(0);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000252 if (!temp)
253 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000254
255 r = mro_subclasses(type, temp);
256
257 if (r < 0) {
258 for (i = 0; i < PyList_Size(temp); i++) {
259 PyTypeObject* cls;
260 PyObject* mro;
Raymond Hettinger8ae46892003-10-12 19:09:37 +0000261 PyArg_UnpackTuple(PyList_GET_ITEM(temp, i),
262 "", 2, 2, &cls, &mro);
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000263 Py_DECREF(cls->tp_mro);
264 cls->tp_mro = mro;
265 Py_INCREF(cls->tp_mro);
266 }
267 Py_DECREF(temp);
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000268 goto bail;
Michael W. Hudson586da8f2002-11-27 15:20:19 +0000269 }
270
271 Py_DECREF(temp);
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000272
273 /* any base that was in __bases__ but now isn't, we
Raymond Hettingera8285862002-12-14 17:17:56 +0000274 need to remove |type| from its tp_subclasses.
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000275 conversely, any class now in __bases__ that wasn't
Raymond Hettingera8285862002-12-14 17:17:56 +0000276 needs to have |type| added to its subclasses. */
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000277
278 /* for now, sod that: just remove from all old_bases,
279 add to all new_bases */
280
281 for (i = PyTuple_GET_SIZE(old_bases) - 1; i >= 0; i--) {
282 ob = PyTuple_GET_ITEM(old_bases, i);
283 if (PyType_Check(ob)) {
284 remove_subclass(
285 (PyTypeObject*)ob, type);
286 }
287 }
288
289 for (i = PyTuple_GET_SIZE(value) - 1; i >= 0; i--) {
290 ob = PyTuple_GET_ITEM(value, i);
291 if (PyType_Check(ob)) {
292 if (add_subclass((PyTypeObject*)ob, type) < 0)
293 r = -1;
294 }
295 }
296
297 update_all_slots(type);
298
299 Py_DECREF(old_bases);
300 Py_DECREF(old_base);
301 Py_DECREF(old_mro);
302
303 return r;
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000304
305 bail:
Michael W. Hudsone723e452003-08-07 14:58:10 +0000306 Py_DECREF(type->tp_bases);
307 Py_DECREF(type->tp_base);
308 if (type->tp_mro != old_mro) {
309 Py_DECREF(type->tp_mro);
310 }
311
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000312 type->tp_bases = old_bases;
313 type->tp_base = old_base;
314 type->tp_mro = old_mro;
Tim Petersea7f75d2002-12-07 21:39:16 +0000315
Michael W. Hudson7e7c00d2002-11-27 15:40:09 +0000316 return -1;
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000317}
318
319static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000320type_dict(PyTypeObject *type, void *context)
321{
322 if (type->tp_dict == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000323 Py_INCREF(Py_None);
324 return Py_None;
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000325 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000326 return PyDictProxy_New(type->tp_dict);
Guido van Rossum29ca26e1995-01-07 11:58:15 +0000327}
328
Tim Peters24008312002-03-17 18:56:20 +0000329static PyObject *
330type_get_doc(PyTypeObject *type, void *context)
331{
332 PyObject *result;
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000333 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE) && type->tp_doc != NULL)
Tim Peters24008312002-03-17 18:56:20 +0000334 return PyString_FromString(type->tp_doc);
Tim Peters24008312002-03-17 18:56:20 +0000335 result = PyDict_GetItemString(type->tp_dict, "__doc__");
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000336 if (result == NULL) {
337 result = Py_None;
338 Py_INCREF(result);
339 }
340 else if (result->ob_type->tp_descr_get) {
Tim Peters2b858972002-04-18 04:12:28 +0000341 result = result->ob_type->tp_descr_get(result, NULL,
342 (PyObject *)type);
Guido van Rossum6ca7d412002-04-18 00:22:00 +0000343 }
344 else {
345 Py_INCREF(result);
346 }
Tim Peters24008312002-03-17 18:56:20 +0000347 return result;
348}
349
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000350static PyGetSetDef type_getsets[] = {
Michael W. Hudson98bbc492002-11-26 14:47:27 +0000351 {"__name__", (getter)type_name, (setter)type_set_name, NULL},
352 {"__bases__", (getter)type_get_bases, (setter)type_set_bases, NULL},
Guido van Rossum3926a632001-09-25 16:25:58 +0000353 {"__module__", (getter)type_module, (setter)type_set_module, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000354 {"__dict__", (getter)type_dict, NULL, NULL},
Tim Peters24008312002-03-17 18:56:20 +0000355 {"__doc__", (getter)type_get_doc, NULL, NULL},
Tim Peters6d6c1a32001-08-02 04:15:00 +0000356 {0}
357};
358
Martin v. Löwis0163d6d2001-06-09 07:34:05 +0000359static int
360type_compare(PyObject *v, PyObject *w)
361{
362 /* This is called with type objects only. So we
363 can just compare the addresses. */
364 Py_uintptr_t vv = (Py_uintptr_t)v;
365 Py_uintptr_t ww = (Py_uintptr_t)w;
366 return (vv < ww) ? -1 : (vv > ww) ? 1 : 0;
367}
368
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000369static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +0000370type_repr(PyTypeObject *type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000371{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000372 PyObject *mod, *name, *rtn;
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000373 char *kind;
Guido van Rossumc3542212001-08-16 09:18:56 +0000374
375 mod = type_module(type, NULL);
376 if (mod == NULL)
377 PyErr_Clear();
378 else if (!PyString_Check(mod)) {
379 Py_DECREF(mod);
380 mod = NULL;
381 }
382 name = type_name(type, NULL);
383 if (name == NULL)
384 return NULL;
Barry Warsaw7ce36942001-08-24 18:34:26 +0000385
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000386 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
387 kind = "class";
388 else
389 kind = "type";
390
Barry Warsaw7ce36942001-08-24 18:34:26 +0000391 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__")) {
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000392 rtn = PyString_FromFormat("<%s '%s.%s'>",
393 kind,
Barry Warsaw7ce36942001-08-24 18:34:26 +0000394 PyString_AS_STRING(mod),
395 PyString_AS_STRING(name));
396 }
Guido van Rossumc3542212001-08-16 09:18:56 +0000397 else
Guido van Rossuma4cb7882001-09-25 03:56:29 +0000398 rtn = PyString_FromFormat("<%s '%s'>", kind, type->tp_name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000399
Guido van Rossumc3542212001-08-16 09:18:56 +0000400 Py_XDECREF(mod);
401 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +0000402 return rtn;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000403}
404
Tim Peters6d6c1a32001-08-02 04:15:00 +0000405static PyObject *
406type_call(PyTypeObject *type, PyObject *args, PyObject *kwds)
407{
408 PyObject *obj;
409
410 if (type->tp_new == NULL) {
411 PyErr_Format(PyExc_TypeError,
412 "cannot create '%.100s' instances",
413 type->tp_name);
414 return NULL;
415 }
416
Tim Peters3f996e72001-09-13 19:18:27 +0000417 obj = type->tp_new(type, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000418 if (obj != NULL) {
Guido van Rossumf76de622001-10-18 15:49:21 +0000419 /* Ugly exception: when the call was type(something),
420 don't call tp_init on the result. */
421 if (type == &PyType_Type &&
422 PyTuple_Check(args) && PyTuple_GET_SIZE(args) == 1 &&
423 (kwds == NULL ||
424 (PyDict_Check(kwds) && PyDict_Size(kwds) == 0)))
425 return obj;
Guido van Rossum8ace1ab2002-04-06 01:05:01 +0000426 /* If the returned object is not an instance of type,
427 it won't be initialized. */
428 if (!PyType_IsSubtype(obj->ob_type, type))
429 return obj;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000430 type = obj->ob_type;
Jeremy Hylton719841e2002-07-16 19:39:38 +0000431 if (PyType_HasFeature(type, Py_TPFLAGS_HAVE_CLASS) &&
432 type->tp_init != NULL &&
Tim Peters6d6c1a32001-08-02 04:15:00 +0000433 type->tp_init(obj, args, kwds) < 0) {
434 Py_DECREF(obj);
435 obj = NULL;
436 }
437 }
438 return obj;
439}
440
441PyObject *
442PyType_GenericAlloc(PyTypeObject *type, int nitems)
443{
Tim Peters6d6c1a32001-08-02 04:15:00 +0000444 PyObject *obj;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000445 const size_t size = _PyObject_VAR_SIZE(type, nitems+1);
446 /* note that we need to add one, for the sentinel */
Tim Peters406fe3b2001-10-06 19:04:01 +0000447
448 if (PyType_IS_GC(type))
Neil Schemenauer09a2ae52002-04-12 03:06:53 +0000449 obj = _PyObject_GC_Malloc(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000450 else
Neil Schemenauerc806c882001-08-29 23:54:54 +0000451 obj = PyObject_MALLOC(size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000452
Neil Schemenauerc806c882001-08-29 23:54:54 +0000453 if (obj == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +0000454 return PyErr_NoMemory();
Tim Peters406fe3b2001-10-06 19:04:01 +0000455
Neil Schemenauerc806c882001-08-29 23:54:54 +0000456 memset(obj, '\0', size);
Tim Peters406fe3b2001-10-06 19:04:01 +0000457
Tim Peters6d6c1a32001-08-02 04:15:00 +0000458 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE)
459 Py_INCREF(type);
Tim Peters406fe3b2001-10-06 19:04:01 +0000460
Tim Peters6d6c1a32001-08-02 04:15:00 +0000461 if (type->tp_itemsize == 0)
462 PyObject_INIT(obj, type);
463 else
464 (void) PyObject_INIT_VAR((PyVarObject *)obj, type, nitems);
Tim Peters406fe3b2001-10-06 19:04:01 +0000465
Tim Peters6d6c1a32001-08-02 04:15:00 +0000466 if (PyType_IS_GC(type))
Neil Schemenauerc806c882001-08-29 23:54:54 +0000467 _PyObject_GC_TRACK(obj);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000468 return obj;
469}
470
471PyObject *
472PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
473{
474 return type->tp_alloc(type, 0);
475}
476
Guido van Rossum9475a232001-10-05 20:51:39 +0000477/* Helpers for subtyping */
478
479static int
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000480traverse_slots(PyTypeObject *type, PyObject *self, visitproc visit, void *arg)
481{
482 int i, n;
483 PyMemberDef *mp;
484
485 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000486 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000487 for (i = 0; i < n; i++, mp++) {
488 if (mp->type == T_OBJECT_EX) {
489 char *addr = (char *)self + mp->offset;
490 PyObject *obj = *(PyObject **)addr;
491 if (obj != NULL) {
492 int err = visit(obj, arg);
493 if (err)
494 return err;
495 }
496 }
497 }
498 return 0;
499}
500
501static int
Guido van Rossum9475a232001-10-05 20:51:39 +0000502subtype_traverse(PyObject *self, visitproc visit, void *arg)
503{
504 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000505 traverseproc basetraverse;
Guido van Rossum9475a232001-10-05 20:51:39 +0000506
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000507 /* Find the nearest base with a different tp_traverse,
508 and traverse slots while we're at it */
Guido van Rossum9475a232001-10-05 20:51:39 +0000509 type = self->ob_type;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000510 base = type;
511 while ((basetraverse = base->tp_traverse) == subtype_traverse) {
512 if (base->ob_size) {
513 int err = traverse_slots(base, self, visit, arg);
514 if (err)
515 return err;
516 }
Guido van Rossum9475a232001-10-05 20:51:39 +0000517 base = base->tp_base;
518 assert(base);
519 }
520
521 if (type->tp_dictoffset != base->tp_dictoffset) {
522 PyObject **dictptr = _PyObject_GetDictPtr(self);
523 if (dictptr && *dictptr) {
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000524 int err = visit(*dictptr, arg);
Guido van Rossum9475a232001-10-05 20:51:39 +0000525 if (err)
526 return err;
527 }
528 }
529
Guido van Rossuma3862092002-06-10 15:24:42 +0000530 if (type->tp_flags & Py_TPFLAGS_HEAPTYPE) {
531 /* For a heaptype, the instances count as references
532 to the type. Traverse the type so the collector
533 can find cycles involving this link. */
534 int err = visit((PyObject *)type, arg);
535 if (err)
536 return err;
537 }
538
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000539 if (basetraverse)
540 return basetraverse(self, visit, arg);
541 return 0;
542}
543
544static void
545clear_slots(PyTypeObject *type, PyObject *self)
546{
547 int i, n;
548 PyMemberDef *mp;
549
550 n = type->ob_size;
Guido van Rossume5c691a2003-03-07 15:13:17 +0000551 mp = PyHeapType_GET_MEMBERS((PyHeapTypeObject *)type);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000552 for (i = 0; i < n; i++, mp++) {
553 if (mp->type == T_OBJECT_EX && !(mp->flags & READONLY)) {
554 char *addr = (char *)self + mp->offset;
555 PyObject *obj = *(PyObject **)addr;
556 if (obj != NULL) {
557 Py_DECREF(obj);
558 *(PyObject **)addr = NULL;
559 }
560 }
561 }
562}
563
564static int
565subtype_clear(PyObject *self)
566{
567 PyTypeObject *type, *base;
568 inquiry baseclear;
569
570 /* Find the nearest base with a different tp_clear
571 and clear slots while we're at it */
572 type = self->ob_type;
573 base = type;
574 while ((baseclear = base->tp_clear) == subtype_clear) {
575 if (base->ob_size)
576 clear_slots(base, self);
577 base = base->tp_base;
578 assert(base);
579 }
580
Guido van Rossuma3862092002-06-10 15:24:42 +0000581 /* There's no need to clear the instance dict (if any);
582 the collector will call its tp_clear handler. */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000583
584 if (baseclear)
585 return baseclear(self);
Guido van Rossum9475a232001-10-05 20:51:39 +0000586 return 0;
587}
Tim Peters6d6c1a32001-08-02 04:15:00 +0000588
589static void
590subtype_dealloc(PyObject *self)
591{
Guido van Rossum14227b42001-12-06 02:35:58 +0000592 PyTypeObject *type, *base;
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000593 destructor basedealloc;
Tim Peters6d6c1a32001-08-02 04:15:00 +0000594
Guido van Rossum22b13872002-08-06 21:41:44 +0000595 /* Extract the type; we expect it to be a heap type */
596 type = self->ob_type;
597 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000598
Guido van Rossum22b13872002-08-06 21:41:44 +0000599 /* Test whether the type has GC exactly once */
600
601 if (!PyType_IS_GC(type)) {
602 /* It's really rare to find a dynamic type that doesn't have
603 GC; it can only happen when deriving from 'object' and not
604 adding any slots or instance variables. This allows
605 certain simplifications: there's no need to call
606 clear_slots(), or DECREF the dict, or clear weakrefs. */
607
608 /* Maybe call finalizer; exit early if resurrected */
Guido van Rossumfebd61d2002-08-08 20:55:20 +0000609 if (type->tp_del) {
610 type->tp_del(self);
611 if (self->ob_refcnt > 0)
612 return;
613 }
Guido van Rossum22b13872002-08-06 21:41:44 +0000614
615 /* Find the nearest base with a different tp_dealloc */
616 base = type;
617 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
618 assert(base->ob_size == 0);
619 base = base->tp_base;
620 assert(base);
621 }
622
623 /* Call the base tp_dealloc() */
624 assert(basedealloc);
625 basedealloc(self);
626
627 /* Can't reference self beyond this point */
628 Py_DECREF(type);
629
630 /* Done */
631 return;
632 }
633
634 /* We get here only if the type has GC */
635
636 /* UnTrack and re-Track around the trashcan macro, alas */
Andrew M. Kuchlingc9172d32003-02-06 15:22:49 +0000637 /* See explanation at end of function for full disclosure */
Guido van Rossum0906e072002-08-07 20:42:09 +0000638 PyObject_GC_UnTrack(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000639 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000640 Py_TRASHCAN_SAFE_BEGIN(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000641 --_PyTrash_delete_nesting;
Tim Petersf7f9e992003-11-13 21:59:32 +0000642 /* DO NOT restore GC tracking at this point. weakref callbacks
643 * (if any, and whether directly here or indirectly in something we
644 * call) may trigger GC, and if self is tracked at that point, it
645 * will look like trash to GC and GC will try to delete self again.
Tim Petersadd09b42003-11-12 20:43:28 +0000646 */
Guido van Rossum22b13872002-08-06 21:41:44 +0000647
Guido van Rossum59195fd2003-06-13 20:54:40 +0000648 /* Find the nearest base with a different tp_dealloc */
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000649 base = type;
650 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
Tim Peters6d6c1a32001-08-02 04:15:00 +0000651 base = base->tp_base;
652 assert(base);
Guido van Rossum14227b42001-12-06 02:35:58 +0000653 }
654
Guido van Rossum1987c662003-05-29 14:29:23 +0000655 /* If we added a weaklist, we clear it. Do this *before* calling
Guido van Rossum59195fd2003-06-13 20:54:40 +0000656 the finalizer (__del__), clearing slots, or clearing the instance
657 dict. */
658
Guido van Rossum1987c662003-05-29 14:29:23 +0000659 if (type->tp_weaklistoffset && !base->tp_weaklistoffset)
660 PyObject_ClearWeakRefs(self);
661
662 /* Maybe call finalizer; exit early if resurrected */
663 if (type->tp_del) {
Tim Petersf7f9e992003-11-13 21:59:32 +0000664 _PyObject_GC_TRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000665 type->tp_del(self);
666 if (self->ob_refcnt > 0)
Tim Petersf7f9e992003-11-13 21:59:32 +0000667 goto endlabel; /* resurrected */
668 else
669 _PyObject_GC_UNTRACK(self);
Guido van Rossum1987c662003-05-29 14:29:23 +0000670 }
671
Guido van Rossum59195fd2003-06-13 20:54:40 +0000672 /* Clear slots up to the nearest base with a different tp_dealloc */
673 base = type;
674 while ((basedealloc = base->tp_dealloc) == subtype_dealloc) {
675 if (base->ob_size)
676 clear_slots(base, self);
677 base = base->tp_base;
678 assert(base);
679 }
680
Tim Peters6d6c1a32001-08-02 04:15:00 +0000681 /* If we added a dict, DECREF it */
Guido van Rossum6fb3fde2001-08-30 20:00:07 +0000682 if (type->tp_dictoffset && !base->tp_dictoffset) {
683 PyObject **dictptr = _PyObject_GetDictPtr(self);
684 if (dictptr != NULL) {
685 PyObject *dict = *dictptr;
686 if (dict != NULL) {
687 Py_DECREF(dict);
688 *dictptr = NULL;
689 }
Tim Peters6d6c1a32001-08-02 04:15:00 +0000690 }
691 }
692
Tim Peters0bd743c2003-11-13 22:50:00 +0000693 /* Call the base tp_dealloc(); first retrack self if
694 * basedealloc knows about gc.
695 */
696 if (PyType_IS_GC(base))
697 _PyObject_GC_TRACK(self);
Guido van Rossum9923ffe2002-06-04 19:52:53 +0000698 assert(basedealloc);
699 basedealloc(self);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000700
701 /* Can't reference self beyond this point */
Guido van Rossum22b13872002-08-06 21:41:44 +0000702 Py_DECREF(type);
703
Guido van Rossum0906e072002-08-07 20:42:09 +0000704 endlabel:
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000705 ++_PyTrash_delete_nesting;
Guido van Rossum22b13872002-08-06 21:41:44 +0000706 Py_TRASHCAN_SAFE_END(self);
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000707 --_PyTrash_delete_nesting;
708
709 /* Explanation of the weirdness around the trashcan macros:
710
711 Q. What do the trashcan macros do?
712
713 A. Read the comment titled "Trashcan mechanism" in object.h.
714 For one, this explains why there must be a call to GC-untrack
715 before the trashcan begin macro. Without understanding the
716 trashcan code, the answers to the following questions don't make
717 sense.
718
719 Q. Why do we GC-untrack before the trashcan and then immediately
720 GC-track again afterward?
721
722 A. In the case that the base class is GC-aware, the base class
723 probably GC-untracks the object. If it does that using the
724 UNTRACK macro, this will crash when the object is already
725 untracked. Because we don't know what the base class does, the
726 only safe thing is to make sure the object is tracked when we
727 call the base class dealloc. But... The trashcan begin macro
728 requires that the object is *untracked* before it is called. So
729 the dance becomes:
730
731 GC untrack
732 trashcan begin
733 GC track
734
Tim Petersf7f9e992003-11-13 21:59:32 +0000735 Q. Why did the last question say "immediately GC-track again"?
736 It's nowhere near immediately.
737
738 A. Because the code *used* to re-track immediately. Bad Idea.
739 self has a refcount of 0, and if gc ever gets its hands on it
740 (which can happen if any weakref callback gets invoked), it
741 looks like trash to gc too, and gc also tries to delete self
742 then. But we're already deleting self. Double dealloction is
743 a subtle disaster.
744
Guido van Rossumce8bcd82003-02-05 22:39:45 +0000745 Q. Why the bizarre (net-zero) manipulation of
746 _PyTrash_delete_nesting around the trashcan macros?
747
748 A. Some base classes (e.g. list) also use the trashcan mechanism.
749 The following scenario used to be possible:
750
751 - suppose the trashcan level is one below the trashcan limit
752
753 - subtype_dealloc() is called
754
755 - the trashcan limit is not yet reached, so the trashcan level
756 is incremented and the code between trashcan begin and end is
757 executed
758
759 - this destroys much of the object's contents, including its
760 slots and __dict__
761
762 - basedealloc() is called; this is really list_dealloc(), or
763 some other type which also uses the trashcan macros
764
765 - the trashcan limit is now reached, so the object is put on the
766 trashcan's to-be-deleted-later list
767
768 - basedealloc() returns
769
770 - subtype_dealloc() decrefs the object's type
771
772 - subtype_dealloc() returns
773
774 - later, the trashcan code starts deleting the objects from its
775 to-be-deleted-later list
776
777 - subtype_dealloc() is called *AGAIN* for the same object
778
779 - at the very least (if the destroyed slots and __dict__ don't
780 cause problems) the object's type gets decref'ed a second
781 time, which is *BAD*!!!
782
783 The remedy is to make sure that if the code between trashcan
784 begin and end in subtype_dealloc() is called, the code between
785 trashcan begin and end in basedealloc() will also be called.
786 This is done by decrementing the level after passing into the
787 trashcan block, and incrementing it just before leaving the
788 block.
789
790 But now it's possible that a chain of objects consisting solely
791 of objects whose deallocator is subtype_dealloc() will defeat
792 the trashcan mechanism completely: the decremented level means
793 that the effective level never reaches the limit. Therefore, we
794 *increment* the level *before* entering the trashcan block, and
795 matchingly decrement it after leaving. This means the trashcan
796 code will trigger a little early, but that's no big deal.
797
798 Q. Are there any live examples of code in need of all this
799 complexity?
800
801 A. Yes. See SF bug 668433 for code that crashed (when Python was
802 compiled in debug mode) before the trashcan level manipulations
803 were added. For more discussion, see SF patches 581742, 575073
804 and bug 574207.
805 */
Tim Peters6d6c1a32001-08-02 04:15:00 +0000806}
807
Jeremy Hylton938ace62002-07-17 16:30:39 +0000808static PyTypeObject *solid_base(PyTypeObject *type);
Tim Peters6d6c1a32001-08-02 04:15:00 +0000809
Tim Peters6d6c1a32001-08-02 04:15:00 +0000810/* type test with subclassing support */
811
812int
813PyType_IsSubtype(PyTypeObject *a, PyTypeObject *b)
814{
815 PyObject *mro;
816
Guido van Rossum9478d072001-09-07 18:52:13 +0000817 if (!(a->tp_flags & Py_TPFLAGS_HAVE_CLASS))
818 return b == a || b == &PyBaseObject_Type;
819
Tim Peters6d6c1a32001-08-02 04:15:00 +0000820 mro = a->tp_mro;
821 if (mro != NULL) {
822 /* Deal with multiple inheritance without recursion
823 by walking the MRO tuple */
824 int i, n;
825 assert(PyTuple_Check(mro));
826 n = PyTuple_GET_SIZE(mro);
827 for (i = 0; i < n; i++) {
828 if (PyTuple_GET_ITEM(mro, i) == (PyObject *)b)
829 return 1;
830 }
831 return 0;
832 }
833 else {
834 /* a is not completely initilized yet; follow tp_base */
835 do {
836 if (a == b)
837 return 1;
838 a = a->tp_base;
839 } while (a != NULL);
840 return b == &PyBaseObject_Type;
841 }
842}
843
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000844/* Internal routines to do a method lookup in the type
Guido van Rossum60718732001-08-28 17:47:51 +0000845 without looking in the instance dictionary
846 (so we can't use PyObject_GetAttr) but still binding
847 it to the instance. The arguments are the object,
848 the method name as a C string, and the address of a
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000849 static variable used to cache the interned Python string.
850
851 Two variants:
852
853 - lookup_maybe() returns NULL without raising an exception
854 when the _PyType_Lookup() call fails;
855
856 - lookup_method() always raises an exception upon errors.
857*/
Guido van Rossum60718732001-08-28 17:47:51 +0000858
859static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000860lookup_maybe(PyObject *self, char *attrstr, PyObject **attrobj)
Guido van Rossum60718732001-08-28 17:47:51 +0000861{
862 PyObject *res;
863
864 if (*attrobj == NULL) {
865 *attrobj = PyString_InternFromString(attrstr);
866 if (*attrobj == NULL)
867 return NULL;
868 }
869 res = _PyType_Lookup(self->ob_type, *attrobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000870 if (res != NULL) {
Guido van Rossum60718732001-08-28 17:47:51 +0000871 descrgetfunc f;
872 if ((f = res->ob_type->tp_descr_get) == NULL)
873 Py_INCREF(res);
874 else
875 res = f(res, self, (PyObject *)(self->ob_type));
876 }
877 return res;
878}
879
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000880static PyObject *
881lookup_method(PyObject *self, char *attrstr, PyObject **attrobj)
882{
883 PyObject *res = lookup_maybe(self, attrstr, attrobj);
884 if (res == NULL && !PyErr_Occurred())
885 PyErr_SetObject(PyExc_AttributeError, *attrobj);
886 return res;
887}
888
Guido van Rossum2730b132001-08-28 18:22:14 +0000889/* A variation of PyObject_CallMethod that uses lookup_method()
890 instead of PyObject_GetAttrString(). This uses the same convention
891 as lookup_method to cache the interned name string object. */
892
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000893static PyObject *
Guido van Rossum2730b132001-08-28 18:22:14 +0000894call_method(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
895{
896 va_list va;
897 PyObject *args, *func = 0, *retval;
Guido van Rossum2730b132001-08-28 18:22:14 +0000898 va_start(va, format);
899
Guido van Rossumda21c012001-10-03 00:50:18 +0000900 func = lookup_maybe(o, name, nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000901 if (func == NULL) {
902 va_end(va);
903 if (!PyErr_Occurred())
Guido van Rossumda21c012001-10-03 00:50:18 +0000904 PyErr_SetObject(PyExc_AttributeError, *nameobj);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000905 return NULL;
906 }
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000907
908 if (format && *format)
909 args = Py_VaBuildValue(format, va);
910 else
911 args = PyTuple_New(0);
912
913 va_end(va);
914
915 if (args == NULL)
916 return NULL;
917
918 assert(PyTuple_Check(args));
919 retval = PyObject_Call(func, args, NULL);
920
921 Py_DECREF(args);
922 Py_DECREF(func);
923
924 return retval;
925}
926
927/* Clone of call_method() that returns NotImplemented when the lookup fails. */
928
Neil Schemenauerf23473f2001-10-21 22:28:58 +0000929static PyObject *
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000930call_maybe(PyObject *o, char *name, PyObject **nameobj, char *format, ...)
931{
932 va_list va;
933 PyObject *args, *func = 0, *retval;
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000934 va_start(va, format);
935
Guido van Rossumda21c012001-10-03 00:50:18 +0000936 func = lookup_maybe(o, name, nameobj);
Guido van Rossum2730b132001-08-28 18:22:14 +0000937 if (func == NULL) {
938 va_end(va);
Guido van Rossumf21c6be2001-09-14 17:51:50 +0000939 if (!PyErr_Occurred()) {
940 Py_INCREF(Py_NotImplemented);
941 return Py_NotImplemented;
942 }
Guido van Rossum717ce002001-09-14 16:58:08 +0000943 return NULL;
Guido van Rossum2730b132001-08-28 18:22:14 +0000944 }
945
946 if (format && *format)
947 args = Py_VaBuildValue(format, va);
948 else
949 args = PyTuple_New(0);
950
951 va_end(va);
952
Guido van Rossum717ce002001-09-14 16:58:08 +0000953 if (args == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +0000954 return NULL;
955
Guido van Rossum717ce002001-09-14 16:58:08 +0000956 assert(PyTuple_Check(args));
957 retval = PyObject_Call(func, args, NULL);
Guido van Rossum2730b132001-08-28 18:22:14 +0000958
959 Py_DECREF(args);
960 Py_DECREF(func);
961
962 return retval;
963}
964
Tim Petersa91e9642001-11-14 23:32:33 +0000965static int
966fill_classic_mro(PyObject *mro, PyObject *cls)
967{
968 PyObject *bases, *base;
969 int i, n;
970
971 assert(PyList_Check(mro));
972 assert(PyClass_Check(cls));
973 i = PySequence_Contains(mro, cls);
974 if (i < 0)
975 return -1;
976 if (!i) {
977 if (PyList_Append(mro, cls) < 0)
978 return -1;
979 }
980 bases = ((PyClassObject *)cls)->cl_bases;
981 assert(bases && PyTuple_Check(bases));
982 n = PyTuple_GET_SIZE(bases);
983 for (i = 0; i < n; i++) {
984 base = PyTuple_GET_ITEM(bases, i);
985 if (fill_classic_mro(mro, base) < 0)
986 return -1;
987 }
988 return 0;
989}
990
991static PyObject *
992classic_mro(PyObject *cls)
993{
994 PyObject *mro;
995
996 assert(PyClass_Check(cls));
997 mro = PyList_New(0);
998 if (mro != NULL) {
999 if (fill_classic_mro(mro, cls) == 0)
1000 return mro;
1001 Py_DECREF(mro);
1002 }
1003 return NULL;
1004}
1005
Tim Petersea7f75d2002-12-07 21:39:16 +00001006/*
Guido van Rossum1f121312002-11-14 19:49:16 +00001007 Method resolution order algorithm C3 described in
1008 "A Monotonic Superclass Linearization for Dylan",
1009 by Kim Barrett, Bob Cassel, Paul Haahr,
Tim Petersea7f75d2002-12-07 21:39:16 +00001010 David A. Moon, Keith Playford, and P. Tucker Withington.
Guido van Rossum1f121312002-11-14 19:49:16 +00001011 (OOPSLA 1996)
1012
Guido van Rossum98f33732002-11-25 21:36:54 +00001013 Some notes about the rules implied by C3:
1014
Tim Petersea7f75d2002-12-07 21:39:16 +00001015 No duplicate bases.
Guido van Rossum98f33732002-11-25 21:36:54 +00001016 It isn't legal to repeat a class in a list of base classes.
1017
1018 The next three properties are the 3 constraints in "C3".
1019
Tim Petersea7f75d2002-12-07 21:39:16 +00001020 Local precendece order.
Guido van Rossum98f33732002-11-25 21:36:54 +00001021 If A precedes B in C's MRO, then A will precede B in the MRO of all
1022 subclasses of C.
1023
1024 Monotonicity.
1025 The MRO of a class must be an extension without reordering of the
1026 MRO of each of its superclasses.
1027
1028 Extended Precedence Graph (EPG).
1029 Linearization is consistent if there is a path in the EPG from
1030 each class to all its successors in the linearization. See
1031 the paper for definition of EPG.
Guido van Rossum1f121312002-11-14 19:49:16 +00001032 */
1033
Tim Petersea7f75d2002-12-07 21:39:16 +00001034static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001035tail_contains(PyObject *list, int whence, PyObject *o) {
1036 int j, size;
1037 size = PyList_GET_SIZE(list);
1038
1039 for (j = whence+1; j < size; j++) {
1040 if (PyList_GET_ITEM(list, j) == o)
1041 return 1;
1042 }
1043 return 0;
1044}
1045
Guido van Rossum98f33732002-11-25 21:36:54 +00001046static PyObject *
1047class_name(PyObject *cls)
1048{
1049 PyObject *name = PyObject_GetAttrString(cls, "__name__");
1050 if (name == NULL) {
1051 PyErr_Clear();
1052 Py_XDECREF(name);
1053 name = PyObject_Repr(cls);
1054 }
1055 if (name == NULL)
1056 return NULL;
1057 if (!PyString_Check(name)) {
1058 Py_DECREF(name);
1059 return NULL;
1060 }
1061 return name;
1062}
1063
1064static int
1065check_duplicates(PyObject *list)
1066{
1067 int i, j, n;
1068 /* Let's use a quadratic time algorithm,
1069 assuming that the bases lists is short.
1070 */
1071 n = PyList_GET_SIZE(list);
1072 for (i = 0; i < n; i++) {
1073 PyObject *o = PyList_GET_ITEM(list, i);
1074 for (j = i + 1; j < n; j++) {
1075 if (PyList_GET_ITEM(list, j) == o) {
1076 o = class_name(o);
1077 PyErr_Format(PyExc_TypeError,
1078 "duplicate base class %s",
1079 o ? PyString_AS_STRING(o) : "?");
1080 Py_XDECREF(o);
1081 return -1;
1082 }
1083 }
1084 }
1085 return 0;
1086}
1087
1088/* Raise a TypeError for an MRO order disagreement.
1089
1090 It's hard to produce a good error message. In the absence of better
1091 insight into error reporting, report the classes that were candidates
1092 to be put next into the MRO. There is some conflict between the
1093 order in which they should be put in the MRO, but it's hard to
1094 diagnose what constraint can't be satisfied.
1095*/
1096
1097static void
1098set_mro_error(PyObject *to_merge, int *remain)
1099{
1100 int i, n, off, to_merge_size;
1101 char buf[1000];
1102 PyObject *k, *v;
1103 PyObject *set = PyDict_New();
1104
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]);
1110 if (PyDict_SetItem(set, c, Py_None) < 0)
1111 return;
1112 }
1113 }
1114 n = PyDict_Size(set);
1115
Raymond Hettingerf394df42003-04-06 19:13:41 +00001116 off = PyOS_snprintf(buf, sizeof(buf), "Cannot create a \
1117consistent method resolution\norder (MRO) for bases");
Guido van Rossum98f33732002-11-25 21:36:54 +00001118 i = 0;
1119 while (PyDict_Next(set, &i, &k, &v) && off < sizeof(buf)) {
1120 PyObject *name = class_name(k);
1121 off += PyOS_snprintf(buf + off, sizeof(buf) - off, " %s",
1122 name ? PyString_AS_STRING(name) : "?");
1123 Py_XDECREF(name);
1124 if (--n && off+1 < sizeof(buf)) {
1125 buf[off++] = ',';
1126 buf[off] = '\0';
1127 }
1128 }
1129 PyErr_SetString(PyExc_TypeError, buf);
1130 Py_DECREF(set);
1131}
1132
Tim Petersea7f75d2002-12-07 21:39:16 +00001133static int
Guido van Rossum1f121312002-11-14 19:49:16 +00001134pmerge(PyObject *acc, PyObject* to_merge) {
1135 int i, j, to_merge_size;
1136 int *remain;
1137 int ok, empty_cnt;
Tim Petersea7f75d2002-12-07 21:39:16 +00001138
Guido van Rossum1f121312002-11-14 19:49:16 +00001139 to_merge_size = PyList_GET_SIZE(to_merge);
1140
Guido van Rossum98f33732002-11-25 21:36:54 +00001141 /* remain stores an index into each sublist of to_merge.
1142 remain[i] is the index of the next base in to_merge[i]
1143 that is not included in acc.
1144 */
Guido van Rossum1f121312002-11-14 19:49:16 +00001145 remain = PyMem_MALLOC(SIZEOF_INT*to_merge_size);
1146 if (remain == NULL)
1147 return -1;
1148 for (i = 0; i < to_merge_size; i++)
1149 remain[i] = 0;
1150
1151 again:
1152 empty_cnt = 0;
1153 for (i = 0; i < to_merge_size; i++) {
1154 PyObject *candidate;
Tim Petersea7f75d2002-12-07 21:39:16 +00001155
Guido van Rossum1f121312002-11-14 19:49:16 +00001156 PyObject *cur_list = PyList_GET_ITEM(to_merge, i);
1157
1158 if (remain[i] >= PyList_GET_SIZE(cur_list)) {
1159 empty_cnt++;
1160 continue;
1161 }
1162
Guido van Rossum98f33732002-11-25 21:36:54 +00001163 /* Choose next candidate for MRO.
1164
1165 The input sequences alone can determine the choice.
1166 If not, choose the class which appears in the MRO
1167 of the earliest direct superclass of the new class.
1168 */
1169
Guido van Rossum1f121312002-11-14 19:49:16 +00001170 candidate = PyList_GET_ITEM(cur_list, remain[i]);
1171 for (j = 0; j < to_merge_size; j++) {
1172 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum98f33732002-11-25 21:36:54 +00001173 if (tail_contains(j_lst, remain[j], candidate)) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001174 goto skip; /* continue outer loop */
Guido van Rossum98f33732002-11-25 21:36:54 +00001175 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001176 }
1177 ok = PyList_Append(acc, candidate);
1178 if (ok < 0) {
1179 PyMem_Free(remain);
1180 return -1;
1181 }
1182 for (j = 0; j < to_merge_size; j++) {
1183 PyObject *j_lst = PyList_GET_ITEM(to_merge, j);
Guido van Rossum768158c2002-12-31 16:33:01 +00001184 if (remain[j] < PyList_GET_SIZE(j_lst) &&
1185 PyList_GET_ITEM(j_lst, remain[j]) == candidate) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001186 remain[j]++;
1187 }
1188 }
1189 goto again;
Tim Peters9a6b8d82002-11-14 23:22:33 +00001190 skip: ;
Guido van Rossum1f121312002-11-14 19:49:16 +00001191 }
1192
Guido van Rossum98f33732002-11-25 21:36:54 +00001193 if (empty_cnt == to_merge_size) {
1194 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001195 return 0;
Guido van Rossum98f33732002-11-25 21:36:54 +00001196 }
1197 set_mro_error(to_merge, remain);
1198 PyMem_FREE(remain);
Guido van Rossum1f121312002-11-14 19:49:16 +00001199 return -1;
1200}
1201
Tim Peters6d6c1a32001-08-02 04:15:00 +00001202static PyObject *
1203mro_implementation(PyTypeObject *type)
1204{
1205 int i, n, ok;
1206 PyObject *bases, *result;
Guido van Rossum1f121312002-11-14 19:49:16 +00001207 PyObject *to_merge, *bases_aslist;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001208
Guido van Rossum63517572002-06-18 16:44:57 +00001209 if(type->tp_dict == NULL) {
1210 if(PyType_Ready(type) < 0)
1211 return NULL;
1212 }
1213
Guido van Rossum98f33732002-11-25 21:36:54 +00001214 /* Find a superclass linearization that honors the constraints
1215 of the explicit lists of bases and the constraints implied by
Tim Petersea7f75d2002-12-07 21:39:16 +00001216 each base class.
Guido van Rossum98f33732002-11-25 21:36:54 +00001217
1218 to_merge is a list of lists, where each list is a superclass
1219 linearization implied by a base class. The last element of
1220 to_merge is the declared list of bases.
1221 */
1222
Tim Peters6d6c1a32001-08-02 04:15:00 +00001223 bases = type->tp_bases;
1224 n = PyTuple_GET_SIZE(bases);
Guido van Rossum1f121312002-11-14 19:49:16 +00001225
1226 to_merge = PyList_New(n+1);
1227 if (to_merge == NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001228 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001229
Tim Peters6d6c1a32001-08-02 04:15:00 +00001230 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001231 PyObject *base = PyTuple_GET_ITEM(bases, i);
1232 PyObject *parentMRO;
1233 if (PyType_Check(base))
1234 parentMRO = PySequence_List(
1235 ((PyTypeObject*)base)->tp_mro);
1236 else
1237 parentMRO = classic_mro(base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001238 if (parentMRO == NULL) {
Guido van Rossum1f121312002-11-14 19:49:16 +00001239 Py_DECREF(to_merge);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001240 return NULL;
Guido van Rossum1f121312002-11-14 19:49:16 +00001241 }
1242
1243 PyList_SET_ITEM(to_merge, i, parentMRO);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001244 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001245
1246 bases_aslist = PySequence_List(bases);
1247 if (bases_aslist == NULL) {
1248 Py_DECREF(to_merge);
1249 return NULL;
1250 }
Guido van Rossum98f33732002-11-25 21:36:54 +00001251 /* This is just a basic sanity check. */
1252 if (check_duplicates(bases_aslist) < 0) {
1253 Py_DECREF(to_merge);
1254 Py_DECREF(bases_aslist);
1255 return NULL;
1256 }
Guido van Rossum1f121312002-11-14 19:49:16 +00001257 PyList_SET_ITEM(to_merge, n, bases_aslist);
1258
1259 result = Py_BuildValue("[O]", (PyObject *)type);
1260 if (result == NULL) {
1261 Py_DECREF(to_merge);
1262 return NULL;
1263 }
1264
1265 ok = pmerge(result, to_merge);
1266 Py_DECREF(to_merge);
1267 if (ok < 0) {
1268 Py_DECREF(result);
1269 return NULL;
1270 }
1271
Tim Peters6d6c1a32001-08-02 04:15:00 +00001272 return result;
1273}
1274
1275static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001276mro_external(PyObject *self)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001277{
1278 PyTypeObject *type = (PyTypeObject *)self;
1279
Tim Peters6d6c1a32001-08-02 04:15:00 +00001280 return mro_implementation(type);
1281}
1282
1283static int
1284mro_internal(PyTypeObject *type)
1285{
1286 PyObject *mro, *result, *tuple;
1287
1288 if (type->ob_type == &PyType_Type) {
1289 result = mro_implementation(type);
1290 }
1291 else {
Guido van Rossum60718732001-08-28 17:47:51 +00001292 static PyObject *mro_str;
1293 mro = lookup_method((PyObject *)type, "mro", &mro_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001294 if (mro == NULL)
1295 return -1;
1296 result = PyObject_CallObject(mro, NULL);
1297 Py_DECREF(mro);
1298 }
1299 if (result == NULL)
1300 return -1;
1301 tuple = PySequence_Tuple(result);
1302 Py_DECREF(result);
1303 type->tp_mro = tuple;
1304 return 0;
1305}
1306
1307
1308/* Calculate the best base amongst multiple base classes.
1309 This is the first one that's on the path to the "solid base". */
1310
1311static PyTypeObject *
1312best_base(PyObject *bases)
1313{
1314 int i, n;
1315 PyTypeObject *base, *winner, *candidate, *base_i;
Tim Petersa91e9642001-11-14 23:32:33 +00001316 PyObject *base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001317
1318 assert(PyTuple_Check(bases));
1319 n = PyTuple_GET_SIZE(bases);
1320 assert(n > 0);
Tim Petersa91e9642001-11-14 23:32:33 +00001321 base = NULL;
1322 winner = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001323 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001324 base_proto = PyTuple_GET_ITEM(bases, i);
1325 if (PyClass_Check(base_proto))
1326 continue;
1327 if (!PyType_Check(base_proto)) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001328 PyErr_SetString(
1329 PyExc_TypeError,
1330 "bases must be types");
1331 return NULL;
1332 }
Tim Petersa91e9642001-11-14 23:32:33 +00001333 base_i = (PyTypeObject *)base_proto;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001334 if (base_i->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001335 if (PyType_Ready(base_i) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00001336 return NULL;
1337 }
1338 candidate = solid_base(base_i);
Tim Petersa91e9642001-11-14 23:32:33 +00001339 if (winner == NULL) {
1340 winner = candidate;
1341 base = base_i;
1342 }
1343 else if (PyType_IsSubtype(winner, candidate))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001344 ;
1345 else if (PyType_IsSubtype(candidate, winner)) {
1346 winner = candidate;
1347 base = base_i;
1348 }
1349 else {
1350 PyErr_SetString(
1351 PyExc_TypeError,
1352 "multiple bases have "
1353 "instance lay-out conflict");
1354 return NULL;
1355 }
1356 }
Guido van Rossume54616c2001-12-14 04:19:56 +00001357 if (base == NULL)
1358 PyErr_SetString(PyExc_TypeError,
1359 "a new-style class can't have only classic bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001360 return base;
1361}
1362
1363static int
1364extra_ivars(PyTypeObject *type, PyTypeObject *base)
1365{
Neil Schemenauerc806c882001-08-29 23:54:54 +00001366 size_t t_size = type->tp_basicsize;
1367 size_t b_size = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001368
Guido van Rossum9676b222001-08-17 20:32:36 +00001369 assert(t_size >= b_size); /* Else type smaller than base! */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001370 if (type->tp_itemsize || base->tp_itemsize) {
1371 /* If itemsize is involved, stricter rules */
1372 return t_size != b_size ||
1373 type->tp_itemsize != base->tp_itemsize;
1374 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001375 if (type->tp_weaklistoffset && base->tp_weaklistoffset == 0 &&
1376 type->tp_weaklistoffset + sizeof(PyObject *) == t_size)
1377 t_size -= sizeof(PyObject *);
1378 if (type->tp_dictoffset && base->tp_dictoffset == 0 &&
1379 type->tp_dictoffset + sizeof(PyObject *) == t_size)
1380 t_size -= sizeof(PyObject *);
1381
1382 return t_size != b_size;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001383}
1384
1385static PyTypeObject *
1386solid_base(PyTypeObject *type)
1387{
1388 PyTypeObject *base;
1389
1390 if (type->tp_base)
1391 base = solid_base(type->tp_base);
1392 else
1393 base = &PyBaseObject_Type;
1394 if (extra_ivars(type, base))
1395 return type;
1396 else
1397 return base;
1398}
1399
Jeremy Hylton938ace62002-07-17 16:30:39 +00001400static void object_dealloc(PyObject *);
1401static int object_init(PyObject *, PyObject *, PyObject *);
1402static int update_slot(PyTypeObject *, PyObject *);
1403static void fixup_slot_dispatchers(PyTypeObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001404
1405static PyObject *
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001406subtype_dict(PyObject *obj, void *context)
1407{
1408 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1409 PyObject *dict;
1410
1411 if (dictptr == NULL) {
1412 PyErr_SetString(PyExc_AttributeError,
1413 "This object has no __dict__");
1414 return NULL;
1415 }
1416 dict = *dictptr;
Guido van Rossum3926a632001-09-25 16:25:58 +00001417 if (dict == NULL)
1418 *dictptr = dict = PyDict_New();
1419 Py_XINCREF(dict);
1420 return dict;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001421}
1422
Guido van Rossum6661be32001-10-26 04:26:12 +00001423static int
1424subtype_setdict(PyObject *obj, PyObject *value, void *context)
1425{
1426 PyObject **dictptr = _PyObject_GetDictPtr(obj);
1427 PyObject *dict;
1428
1429 if (dictptr == NULL) {
1430 PyErr_SetString(PyExc_AttributeError,
1431 "This object has no __dict__");
1432 return -1;
1433 }
Guido van Rossumd331cb52001-12-05 19:46:42 +00001434 if (value != NULL && !PyDict_Check(value)) {
Guido van Rossum6661be32001-10-26 04:26:12 +00001435 PyErr_SetString(PyExc_TypeError,
1436 "__dict__ must be set to a dictionary");
1437 return -1;
1438 }
1439 dict = *dictptr;
Guido van Rossumd331cb52001-12-05 19:46:42 +00001440 Py_XINCREF(value);
Guido van Rossum6661be32001-10-26 04:26:12 +00001441 *dictptr = value;
1442 Py_XDECREF(dict);
1443 return 0;
1444}
1445
Guido van Rossumad47da02002-08-12 19:05:44 +00001446static PyObject *
1447subtype_getweakref(PyObject *obj, void *context)
1448{
1449 PyObject **weaklistptr;
1450 PyObject *result;
1451
1452 if (obj->ob_type->tp_weaklistoffset == 0) {
1453 PyErr_SetString(PyExc_AttributeError,
1454 "This object has no __weaklist__");
1455 return NULL;
1456 }
1457 assert(obj->ob_type->tp_weaklistoffset > 0);
1458 assert(obj->ob_type->tp_weaklistoffset + sizeof(PyObject *) <=
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001459 (size_t)(obj->ob_type->tp_basicsize));
Guido van Rossumad47da02002-08-12 19:05:44 +00001460 weaklistptr = (PyObject **)
Guido van Rossum3747a0f2002-08-12 19:25:08 +00001461 ((char *)obj + obj->ob_type->tp_weaklistoffset);
Guido van Rossumad47da02002-08-12 19:05:44 +00001462 if (*weaklistptr == NULL)
1463 result = Py_None;
1464 else
1465 result = *weaklistptr;
1466 Py_INCREF(result);
1467 return result;
1468}
1469
Guido van Rossum373c7412003-01-07 13:41:37 +00001470/* Three variants on the subtype_getsets list. */
1471
1472static PyGetSetDef subtype_getsets_full[] = {
Guido van Rossumad47da02002-08-12 19:05:44 +00001473 {"__dict__", subtype_dict, subtype_setdict,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001474 PyDoc_STR("dictionary for instance variables (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001475 {"__weakref__", subtype_getweakref, NULL,
Neal Norwitz858e34f2002-08-13 17:18:45 +00001476 PyDoc_STR("list of weak references to the object (if defined)")},
Guido van Rossumad47da02002-08-12 19:05:44 +00001477 {0}
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001478};
1479
Guido van Rossum373c7412003-01-07 13:41:37 +00001480static PyGetSetDef subtype_getsets_dict_only[] = {
1481 {"__dict__", subtype_dict, subtype_setdict,
1482 PyDoc_STR("dictionary for instance variables (if defined)")},
1483 {0}
1484};
1485
1486static PyGetSetDef subtype_getsets_weakref_only[] = {
1487 {"__weakref__", subtype_getweakref, NULL,
1488 PyDoc_STR("list of weak references to the object (if defined)")},
1489 {0}
1490};
1491
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001492static int
1493valid_identifier(PyObject *s)
1494{
Guido van Rossum03013a02002-07-16 14:30:28 +00001495 unsigned char *p;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001496 int i, n;
1497
1498 if (!PyString_Check(s)) {
1499 PyErr_SetString(PyExc_TypeError,
1500 "__slots__ must be strings");
1501 return 0;
1502 }
Guido van Rossum03013a02002-07-16 14:30:28 +00001503 p = (unsigned char *) PyString_AS_STRING(s);
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001504 n = PyString_GET_SIZE(s);
1505 /* We must reject an empty name. As a hack, we bump the
1506 length to 1 so that the loop will balk on the trailing \0. */
1507 if (n == 0)
1508 n = 1;
1509 for (i = 0; i < n; i++, p++) {
1510 if (!(i == 0 ? isalpha(*p) : isalnum(*p)) && *p != '_') {
1511 PyErr_SetString(PyExc_TypeError,
1512 "__slots__ must be identifiers");
1513 return 0;
1514 }
1515 }
1516 return 1;
1517}
1518
Martin v. Löwisd919a592002-10-14 21:07:28 +00001519#ifdef Py_USING_UNICODE
1520/* Replace Unicode objects in slots. */
1521
1522static PyObject *
1523_unicode_to_string(PyObject *slots, int nslots)
1524{
1525 PyObject *tmp = slots;
1526 PyObject *o, *o1;
1527 int i;
1528 intintargfunc copy = slots->ob_type->tp_as_sequence->sq_slice;
1529 for (i = 0; i < nslots; i++) {
1530 if (PyUnicode_Check(o = PyTuple_GET_ITEM(tmp, i))) {
1531 if (tmp == slots) {
1532 tmp = copy(slots, 0, PyTuple_GET_SIZE(slots));
1533 if (tmp == NULL)
1534 return NULL;
1535 }
1536 o1 = _PyUnicode_AsDefaultEncodedString
1537 (o, NULL);
1538 if (o1 == NULL) {
1539 Py_DECREF(tmp);
1540 return 0;
1541 }
1542 Py_INCREF(o1);
1543 Py_DECREF(o);
1544 PyTuple_SET_ITEM(tmp, i, o1);
1545 }
1546 }
1547 return tmp;
1548}
1549#endif
1550
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001551static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001552type_new(PyTypeObject *metatype, PyObject *args, PyObject *kwds)
1553{
1554 PyObject *name, *bases, *dict;
1555 static char *kwlist[] = {"name", "bases", "dict", 0};
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001556 PyObject *slots, *tmp, *newslots;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001557 PyTypeObject *type, *base, *tmptype, *winner;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001558 PyHeapTypeObject *et;
Guido van Rossum6f799372001-09-20 20:46:19 +00001559 PyMemberDef *mp;
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00001560 int i, nbases, nslots, slotoffset, add_dict, add_weak;
Guido van Rossumad47da02002-08-12 19:05:44 +00001561 int j, may_add_dict, may_add_weak;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001562
Tim Peters3abca122001-10-27 19:37:48 +00001563 assert(args != NULL && PyTuple_Check(args));
1564 assert(kwds == NULL || PyDict_Check(kwds));
1565
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001566 /* Special case: type(x) should return x->ob_type */
Tim Peters3abca122001-10-27 19:37:48 +00001567 {
1568 const int nargs = PyTuple_GET_SIZE(args);
1569 const int nkwds = kwds == NULL ? 0 : PyDict_Size(kwds);
1570
1571 if (PyType_CheckExact(metatype) && nargs == 1 && nkwds == 0) {
1572 PyObject *x = PyTuple_GET_ITEM(args, 0);
1573 Py_INCREF(x->ob_type);
1574 return (PyObject *) x->ob_type;
1575 }
1576
1577 /* SF bug 475327 -- if that didn't trigger, we need 3
1578 arguments. but PyArg_ParseTupleAndKeywords below may give
1579 a msg saying type() needs exactly 3. */
1580 if (nargs + nkwds != 3) {
1581 PyErr_SetString(PyExc_TypeError,
1582 "type() takes 1 or 3 arguments");
1583 return NULL;
1584 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001585 }
1586
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001587 /* Check arguments: (name, bases, dict) */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001588 if (!PyArg_ParseTupleAndKeywords(args, kwds, "SO!O!:type", kwlist,
1589 &name,
1590 &PyTuple_Type, &bases,
1591 &PyDict_Type, &dict))
1592 return NULL;
1593
1594 /* Determine the proper metatype to deal with this,
1595 and check for metatype conflicts while we're at it.
1596 Note that if some other metatype wins to contract,
1597 it's possible that its instances are not types. */
1598 nbases = PyTuple_GET_SIZE(bases);
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001599 winner = metatype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001600 for (i = 0; i < nbases; i++) {
1601 tmp = PyTuple_GET_ITEM(bases, i);
1602 tmptype = tmp->ob_type;
Tim Petersa91e9642001-11-14 23:32:33 +00001603 if (tmptype == &PyClass_Type)
1604 continue; /* Special case classic classes */
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001605 if (PyType_IsSubtype(winner, tmptype))
Tim Peters6d6c1a32001-08-02 04:15:00 +00001606 continue;
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001607 if (PyType_IsSubtype(tmptype, winner)) {
1608 winner = tmptype;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001609 continue;
1610 }
1611 PyErr_SetString(PyExc_TypeError,
Guido van Rossum636688d2003-04-23 12:07:22 +00001612 "metaclass conflict: "
1613 "the metaclass of a derived class "
1614 "must be a (non-strict) subclass "
1615 "of the metaclasses of all its bases");
Tim Peters6d6c1a32001-08-02 04:15:00 +00001616 return NULL;
1617 }
Guido van Rossum8d32c8b2001-08-17 11:18:38 +00001618 if (winner != metatype) {
1619 if (winner->tp_new != type_new) /* Pass it to the winner */
1620 return winner->tp_new(winner, args, kwds);
1621 metatype = winner;
1622 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001623
1624 /* Adjust for empty tuple bases */
1625 if (nbases == 0) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001626 bases = PyTuple_Pack(1, &PyBaseObject_Type);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001627 if (bases == NULL)
1628 return NULL;
1629 nbases = 1;
1630 }
1631 else
1632 Py_INCREF(bases);
1633
1634 /* XXX From here until type is allocated, "return NULL" leaks bases! */
1635
1636 /* Calculate best base, and check that all bases are type objects */
1637 base = best_base(bases);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001638 if (base == NULL) {
1639 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001640 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001641 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001642 if (!PyType_HasFeature(base, Py_TPFLAGS_BASETYPE)) {
1643 PyErr_Format(PyExc_TypeError,
1644 "type '%.100s' is not an acceptable base type",
1645 base->tp_name);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001646 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001647 return NULL;
1648 }
1649
Tim Peters6d6c1a32001-08-02 04:15:00 +00001650 /* Check for a __slots__ sequence variable in dict, and count it */
1651 slots = PyDict_GetItemString(dict, "__slots__");
1652 nslots = 0;
Guido van Rossum9676b222001-08-17 20:32:36 +00001653 add_dict = 0;
1654 add_weak = 0;
Guido van Rossumad47da02002-08-12 19:05:44 +00001655 may_add_dict = base->tp_dictoffset == 0;
1656 may_add_weak = base->tp_weaklistoffset == 0 && base->tp_itemsize == 0;
1657 if (slots == NULL) {
1658 if (may_add_dict) {
1659 add_dict++;
1660 }
1661 if (may_add_weak) {
1662 add_weak++;
1663 }
1664 }
1665 else {
1666 /* Have slots */
1667
Tim Peters6d6c1a32001-08-02 04:15:00 +00001668 /* Make it into a tuple */
1669 if (PyString_Check(slots))
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001670 slots = PyTuple_Pack(1, slots);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001671 else
1672 slots = PySequence_Tuple(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001673 if (slots == NULL) {
1674 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001675 return NULL;
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001676 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001677 assert(PyTuple_Check(slots));
1678
1679 /* Are slots allowed? */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001680 nslots = PyTuple_GET_SIZE(slots);
Jeremy Hylton1c7a0ea2003-07-16 16:08:23 +00001681 if (nslots > 0 && base->tp_itemsize != 0) {
Guido van Rossumc4141872001-08-30 04:43:35 +00001682 PyErr_Format(PyExc_TypeError,
1683 "nonempty __slots__ "
1684 "not supported for subtype of '%s'",
1685 base->tp_name);
Guido van Rossumad47da02002-08-12 19:05:44 +00001686 bad_slots:
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001687 Py_DECREF(bases);
Guido van Rossumad47da02002-08-12 19:05:44 +00001688 Py_DECREF(slots);
Guido van Rossumc4141872001-08-30 04:43:35 +00001689 return NULL;
1690 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001691
Martin v. Löwisd919a592002-10-14 21:07:28 +00001692#ifdef Py_USING_UNICODE
1693 tmp = _unicode_to_string(slots, nslots);
Martin v. Löwis13b1a5c2002-10-14 21:11:34 +00001694 if (tmp != slots) {
1695 Py_DECREF(slots);
1696 slots = tmp;
1697 }
Martin v. Löwisd919a592002-10-14 21:07:28 +00001698 if (!tmp)
1699 return NULL;
1700#endif
Guido van Rossumad47da02002-08-12 19:05:44 +00001701 /* Check for valid slot names and two special cases */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001702 for (i = 0; i < nslots; i++) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001703 PyObject *tmp = PyTuple_GET_ITEM(slots, i);
1704 char *s;
1705 if (!valid_identifier(tmp))
1706 goto bad_slots;
1707 assert(PyString_Check(tmp));
1708 s = PyString_AS_STRING(tmp);
1709 if (strcmp(s, "__dict__") == 0) {
1710 if (!may_add_dict || add_dict) {
1711 PyErr_SetString(PyExc_TypeError,
1712 "__dict__ slot disallowed: "
1713 "we already got one");
1714 goto bad_slots;
1715 }
1716 add_dict++;
1717 }
1718 if (strcmp(s, "__weakref__") == 0) {
1719 if (!may_add_weak || add_weak) {
1720 PyErr_SetString(PyExc_TypeError,
1721 "__weakref__ slot disallowed: "
1722 "either we already got one, "
1723 "or __itemsize__ != 0");
1724 goto bad_slots;
1725 }
1726 add_weak++;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001727 }
1728 }
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001729
Guido van Rossumad47da02002-08-12 19:05:44 +00001730 /* Copy slots into yet another tuple, demangling names */
1731 newslots = PyTuple_New(nslots - add_dict - add_weak);
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001732 if (newslots == NULL)
Guido van Rossumad47da02002-08-12 19:05:44 +00001733 goto bad_slots;
1734 for (i = j = 0; i < nslots; i++) {
1735 char *s;
Guido van Rossum8e829202002-08-16 03:47:49 +00001736 char buffer[256];
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001737 tmp = PyTuple_GET_ITEM(slots, i);
Guido van Rossumad47da02002-08-12 19:05:44 +00001738 s = PyString_AS_STRING(tmp);
1739 if ((add_dict && strcmp(s, "__dict__") == 0) ||
1740 (add_weak && strcmp(s, "__weakref__") == 0))
1741 continue;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001742 if (_Py_Mangle(PyString_AS_STRING(name),
Guido van Rossumad47da02002-08-12 19:05:44 +00001743 PyString_AS_STRING(tmp),
1744 buffer, sizeof(buffer)))
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001745 {
1746 tmp = PyString_FromString(buffer);
1747 } else {
1748 Py_INCREF(tmp);
1749 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001750 PyTuple_SET_ITEM(newslots, j, tmp);
1751 j++;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001752 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001753 assert(j == nslots - add_dict - add_weak);
1754 nslots = j;
Raymond Hettinger0ae0c072002-06-20 22:23:15 +00001755 Py_DECREF(slots);
1756 slots = newslots;
1757
Guido van Rossumad47da02002-08-12 19:05:44 +00001758 /* Secondary bases may provide weakrefs or dict */
1759 if (nbases > 1 &&
1760 ((may_add_dict && !add_dict) ||
1761 (may_add_weak && !add_weak))) {
1762 for (i = 0; i < nbases; i++) {
1763 tmp = PyTuple_GET_ITEM(bases, i);
1764 if (tmp == (PyObject *)base)
1765 continue; /* Skip primary base */
1766 if (PyClass_Check(tmp)) {
1767 /* Classic base class provides both */
1768 if (may_add_dict && !add_dict)
1769 add_dict++;
1770 if (may_add_weak && !add_weak)
1771 add_weak++;
1772 break;
1773 }
1774 assert(PyType_Check(tmp));
1775 tmptype = (PyTypeObject *)tmp;
1776 if (may_add_dict && !add_dict &&
1777 tmptype->tp_dictoffset != 0)
1778 add_dict++;
1779 if (may_add_weak && !add_weak &&
1780 tmptype->tp_weaklistoffset != 0)
1781 add_weak++;
1782 if (may_add_dict && !add_dict)
1783 continue;
1784 if (may_add_weak && !add_weak)
1785 continue;
1786 /* Nothing more to check */
1787 break;
1788 }
1789 }
Guido van Rossum9676b222001-08-17 20:32:36 +00001790 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001791
1792 /* XXX From here until type is safely allocated,
1793 "return NULL" may leak slots! */
1794
1795 /* Allocate the type object */
1796 type = (PyTypeObject *)metatype->tp_alloc(metatype, nslots);
Guido van Rossumad47da02002-08-12 19:05:44 +00001797 if (type == NULL) {
1798 Py_XDECREF(slots);
Michael W. Hudsona6a277d2003-08-08 13:57:22 +00001799 Py_DECREF(bases);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001800 return NULL;
Guido van Rossumad47da02002-08-12 19:05:44 +00001801 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001802
1803 /* Keep name and slots alive in the extended type object */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001804 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001805 Py_INCREF(name);
1806 et->name = name;
1807 et->slots = slots;
1808
Guido van Rossumdc91b992001-08-08 22:26:22 +00001809 /* Initialize tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001810 type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE |
1811 Py_TPFLAGS_BASETYPE;
Guido van Rossum048eb752001-10-02 21:24:57 +00001812 if (base->tp_flags & Py_TPFLAGS_HAVE_GC)
1813 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossumdc91b992001-08-08 22:26:22 +00001814
1815 /* It's a new-style number unless it specifically inherits any
1816 old-style numeric behavior */
1817 if ((base->tp_flags & Py_TPFLAGS_CHECKTYPES) ||
1818 (base->tp_as_number == NULL))
1819 type->tp_flags |= Py_TPFLAGS_CHECKTYPES;
1820
1821 /* Initialize essential fields */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001822 type->tp_as_number = &et->as_number;
1823 type->tp_as_sequence = &et->as_sequence;
1824 type->tp_as_mapping = &et->as_mapping;
1825 type->tp_as_buffer = &et->as_buffer;
1826 type->tp_name = PyString_AS_STRING(name);
1827
1828 /* Set tp_base and tp_bases */
1829 type->tp_bases = bases;
1830 Py_INCREF(base);
1831 type->tp_base = base;
1832
Guido van Rossum687ae002001-10-15 22:03:32 +00001833 /* Initialize tp_dict from passed-in dict */
1834 type->tp_dict = dict = PyDict_Copy(dict);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001835 if (dict == NULL) {
1836 Py_DECREF(type);
1837 return NULL;
1838 }
1839
Guido van Rossumc3542212001-08-16 09:18:56 +00001840 /* Set __module__ in the dict */
1841 if (PyDict_GetItemString(dict, "__module__") == NULL) {
1842 tmp = PyEval_GetGlobals();
1843 if (tmp != NULL) {
1844 tmp = PyDict_GetItemString(tmp, "__name__");
1845 if (tmp != NULL) {
1846 if (PyDict_SetItemString(dict, "__module__",
1847 tmp) < 0)
1848 return NULL;
1849 }
1850 }
1851 }
1852
Tim Peters2f93e282001-10-04 05:27:00 +00001853 /* Set tp_doc to a copy of dict['__doc__'], if the latter is there
Tim Peters24008312002-03-17 18:56:20 +00001854 and is a string. The __doc__ accessor will first look for tp_doc;
1855 if that fails, it will still look into __dict__.
Tim Peters2f93e282001-10-04 05:27:00 +00001856 */
1857 {
1858 PyObject *doc = PyDict_GetItemString(dict, "__doc__");
1859 if (doc != NULL && PyString_Check(doc)) {
1860 const size_t n = (size_t)PyString_GET_SIZE(doc);
Tim Peters59f809d2001-10-04 05:43:02 +00001861 type->tp_doc = (char *)PyObject_MALLOC(n+1);
Tim Peters2f93e282001-10-04 05:27:00 +00001862 if (type->tp_doc == NULL) {
1863 Py_DECREF(type);
1864 return NULL;
1865 }
1866 memcpy(type->tp_doc, PyString_AS_STRING(doc), n+1);
1867 }
1868 }
1869
Tim Peters6d6c1a32001-08-02 04:15:00 +00001870 /* Special-case __new__: if it's a plain function,
1871 make it a static function */
1872 tmp = PyDict_GetItemString(dict, "__new__");
1873 if (tmp != NULL && PyFunction_Check(tmp)) {
1874 tmp = PyStaticMethod_New(tmp);
1875 if (tmp == NULL) {
1876 Py_DECREF(type);
1877 return NULL;
1878 }
1879 PyDict_SetItemString(dict, "__new__", tmp);
1880 Py_DECREF(tmp);
1881 }
1882
1883 /* Add descriptors for custom slots from __slots__, or for __dict__ */
Guido van Rossume5c691a2003-03-07 15:13:17 +00001884 mp = PyHeapType_GET_MEMBERS(et);
Neil Schemenauerc806c882001-08-29 23:54:54 +00001885 slotoffset = base->tp_basicsize;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001886 if (slots != NULL) {
1887 for (i = 0; i < nslots; i++, mp++) {
1888 mp->name = PyString_AS_STRING(
1889 PyTuple_GET_ITEM(slots, i));
Guido van Rossum64b206c2001-12-04 17:13:22 +00001890 mp->type = T_OBJECT_EX;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001891 mp->offset = slotoffset;
Guido van Rossum9676b222001-08-17 20:32:36 +00001892 if (base->tp_weaklistoffset == 0 &&
Guido van Rossum64b206c2001-12-04 17:13:22 +00001893 strcmp(mp->name, "__weakref__") == 0) {
Guido van Rossumad47da02002-08-12 19:05:44 +00001894 add_weak++;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001895 mp->type = T_OBJECT;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001896 mp->flags = READONLY;
Guido van Rossum9676b222001-08-17 20:32:36 +00001897 type->tp_weaklistoffset = slotoffset;
Guido van Rossum64b206c2001-12-04 17:13:22 +00001898 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001899 slotoffset += sizeof(PyObject *);
1900 }
1901 }
Guido van Rossumad47da02002-08-12 19:05:44 +00001902 if (add_dict) {
1903 if (base->tp_itemsize)
1904 type->tp_dictoffset = -(long)sizeof(PyObject *);
1905 else
1906 type->tp_dictoffset = slotoffset;
1907 slotoffset += sizeof(PyObject *);
1908 }
1909 if (add_weak) {
1910 assert(!base->tp_itemsize);
1911 type->tp_weaklistoffset = slotoffset;
1912 slotoffset += sizeof(PyObject *);
Tim Peters6d6c1a32001-08-02 04:15:00 +00001913 }
1914 type->tp_basicsize = slotoffset;
Guido van Rossum6fb3fde2001-08-30 20:00:07 +00001915 type->tp_itemsize = base->tp_itemsize;
Guido van Rossume5c691a2003-03-07 15:13:17 +00001916 type->tp_members = PyHeapType_GET_MEMBERS(et);
Guido van Rossum373c7412003-01-07 13:41:37 +00001917
1918 if (type->tp_weaklistoffset && type->tp_dictoffset)
1919 type->tp_getset = subtype_getsets_full;
1920 else if (type->tp_weaklistoffset && !type->tp_dictoffset)
1921 type->tp_getset = subtype_getsets_weakref_only;
1922 else if (!type->tp_weaklistoffset && type->tp_dictoffset)
1923 type->tp_getset = subtype_getsets_dict_only;
1924 else
1925 type->tp_getset = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001926
1927 /* Special case some slots */
1928 if (type->tp_dictoffset != 0 || nslots > 0) {
1929 if (base->tp_getattr == NULL && base->tp_getattro == NULL)
1930 type->tp_getattro = PyObject_GenericGetAttr;
1931 if (base->tp_setattr == NULL && base->tp_setattro == NULL)
1932 type->tp_setattro = PyObject_GenericSetAttr;
1933 }
1934 type->tp_dealloc = subtype_dealloc;
1935
Guido van Rossum9475a232001-10-05 20:51:39 +00001936 /* Enable GC unless there are really no instance variables possible */
1937 if (!(type->tp_basicsize == sizeof(PyObject) &&
1938 type->tp_itemsize == 0))
1939 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
1940
Tim Peters6d6c1a32001-08-02 04:15:00 +00001941 /* Always override allocation strategy to use regular heap */
1942 type->tp_alloc = PyType_GenericAlloc;
Guido van Rossum048eb752001-10-02 21:24:57 +00001943 if (type->tp_flags & Py_TPFLAGS_HAVE_GC) {
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001944 type->tp_free = PyObject_GC_Del;
Guido van Rossum9475a232001-10-05 20:51:39 +00001945 type->tp_traverse = subtype_traverse;
Guido van Rossum9923ffe2002-06-04 19:52:53 +00001946 type->tp_clear = subtype_clear;
Guido van Rossum048eb752001-10-02 21:24:57 +00001947 }
1948 else
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00001949 type->tp_free = PyObject_Del;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001950
1951 /* Initialize the rest */
Guido van Rossum528b7eb2001-08-07 17:24:28 +00001952 if (PyType_Ready(type) < 0) {
Tim Peters6d6c1a32001-08-02 04:15:00 +00001953 Py_DECREF(type);
1954 return NULL;
1955 }
1956
Guido van Rossum7b9144b2001-10-09 19:39:46 +00001957 /* Put the proper slots in place */
1958 fixup_slot_dispatchers(type);
Guido van Rossumf040ede2001-08-07 16:40:56 +00001959
Tim Peters6d6c1a32001-08-02 04:15:00 +00001960 return (PyObject *)type;
1961}
1962
1963/* Internal API to look for a name through the MRO.
1964 This returns a borrowed reference, and doesn't set an exception! */
1965PyObject *
1966_PyType_Lookup(PyTypeObject *type, PyObject *name)
1967{
1968 int i, n;
Tim Petersa91e9642001-11-14 23:32:33 +00001969 PyObject *mro, *res, *base, *dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00001970
Guido van Rossum687ae002001-10-15 22:03:32 +00001971 /* Look in tp_dict of types in MRO */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001972 mro = type->tp_mro;
Guido van Rossum23094982002-06-10 14:30:43 +00001973
1974 /* If mro is NULL, the type is either not yet initialized
1975 by PyType_Ready(), or already cleared by type_clear().
1976 Either way the safest thing to do is to return NULL. */
1977 if (mro == NULL)
1978 return NULL;
1979
Tim Peters6d6c1a32001-08-02 04:15:00 +00001980 assert(PyTuple_Check(mro));
1981 n = PyTuple_GET_SIZE(mro);
1982 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00001983 base = PyTuple_GET_ITEM(mro, i);
1984 if (PyClass_Check(base))
1985 dict = ((PyClassObject *)base)->cl_dict;
1986 else {
1987 assert(PyType_Check(base));
1988 dict = ((PyTypeObject *)base)->tp_dict;
1989 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00001990 assert(dict && PyDict_Check(dict));
1991 res = PyDict_GetItem(dict, name);
1992 if (res != NULL)
1993 return res;
1994 }
1995 return NULL;
1996}
1997
1998/* This is similar to PyObject_GenericGetAttr(),
1999 but uses _PyType_Lookup() instead of just looking in type->tp_dict. */
2000static PyObject *
2001type_getattro(PyTypeObject *type, PyObject *name)
2002{
2003 PyTypeObject *metatype = type->ob_type;
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002004 PyObject *meta_attribute, *attribute;
2005 descrgetfunc meta_get;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002006
2007 /* Initialize this type (we'll assume the metatype is initialized) */
2008 if (type->tp_dict == NULL) {
Guido van Rossum528b7eb2001-08-07 17:24:28 +00002009 if (PyType_Ready(type) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002010 return NULL;
2011 }
2012
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002013 /* No readable descriptor found yet */
2014 meta_get = NULL;
Tim Peters34592512002-07-11 06:23:50 +00002015
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002016 /* Look for the attribute in the metatype */
2017 meta_attribute = _PyType_Lookup(metatype, name);
2018
2019 if (meta_attribute != NULL) {
2020 meta_get = meta_attribute->ob_type->tp_descr_get;
Tim Peters34592512002-07-11 06:23:50 +00002021
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002022 if (meta_get != NULL && PyDescr_IsData(meta_attribute)) {
2023 /* Data descriptors implement tp_descr_set to intercept
2024 * writes. Assume the attribute is not overridden in
2025 * type's tp_dict (and bases): call the descriptor now.
2026 */
2027 return meta_get(meta_attribute, (PyObject *)type,
2028 (PyObject *)metatype);
2029 }
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002030 Py_INCREF(meta_attribute);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002031 }
2032
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002033 /* No data descriptor found on metatype. Look in tp_dict of this
2034 * type and its bases */
2035 attribute = _PyType_Lookup(type, name);
2036 if (attribute != NULL) {
2037 /* Implement descriptor functionality, if any */
2038 descrgetfunc local_get = attribute->ob_type->tp_descr_get;
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002039
2040 Py_XDECREF(meta_attribute);
2041
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002042 if (local_get != NULL) {
2043 /* NULL 2nd argument indicates the descriptor was
2044 * found on the target object itself (or a base) */
2045 return local_get(attribute, (PyObject *)NULL,
2046 (PyObject *)type);
2047 }
Tim Peters34592512002-07-11 06:23:50 +00002048
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002049 Py_INCREF(attribute);
2050 return attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002051 }
2052
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002053 /* No attribute found in local __dict__ (or bases): use the
2054 * descriptor from the metatype, if any */
Michael W. Hudsonb2c7de42003-08-15 13:07:47 +00002055 if (meta_get != NULL) {
2056 PyObject *res;
2057 res = meta_get(meta_attribute, (PyObject *)type,
2058 (PyObject *)metatype);
2059 Py_DECREF(meta_attribute);
2060 return res;
2061 }
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002062
2063 /* If an ordinary attribute was found on the metatype, return it now */
2064 if (meta_attribute != NULL) {
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002065 return meta_attribute;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002066 }
2067
2068 /* Give up */
2069 PyErr_Format(PyExc_AttributeError,
Guido van Rossumbfc2e5e2002-04-04 17:50:54 +00002070 "type object '%.50s' has no attribute '%.400s'",
2071 type->tp_name, PyString_AS_STRING(name));
Tim Peters6d6c1a32001-08-02 04:15:00 +00002072 return NULL;
2073}
2074
2075static int
2076type_setattro(PyTypeObject *type, PyObject *name, PyObject *value)
2077{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002078 if (!(type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2079 PyErr_Format(
2080 PyExc_TypeError,
2081 "can't set attributes of built-in/extension type '%s'",
2082 type->tp_name);
2083 return -1;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00002084 }
Guido van Rossum8d24ee92003-03-24 23:49:49 +00002085 /* XXX Example of how I expect this to be used...
2086 if (update_subclasses(type, name, invalidate_cache, NULL) < 0)
2087 return -1;
2088 */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00002089 if (PyObject_GenericSetAttr((PyObject *)type, name, value) < 0)
2090 return -1;
2091 return update_slot(type, name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002092}
2093
2094static void
2095type_dealloc(PyTypeObject *type)
2096{
Guido van Rossume5c691a2003-03-07 15:13:17 +00002097 PyHeapTypeObject *et;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002098
2099 /* Assert this is a heap-allocated type object */
2100 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002101 _PyObject_GC_UNTRACK(type);
Guido van Rossum1c450732001-10-08 15:18:27 +00002102 PyObject_ClearWeakRefs((PyObject *)type);
Guido van Rossume5c691a2003-03-07 15:13:17 +00002103 et = (PyHeapTypeObject *)type;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002104 Py_XDECREF(type->tp_base);
2105 Py_XDECREF(type->tp_dict);
2106 Py_XDECREF(type->tp_bases);
2107 Py_XDECREF(type->tp_mro);
Guido van Rossum687ae002001-10-15 22:03:32 +00002108 Py_XDECREF(type->tp_cache);
Guido van Rossum1c450732001-10-08 15:18:27 +00002109 Py_XDECREF(type->tp_subclasses);
Neal Norwitzcee5ca02002-07-30 00:42:06 +00002110 PyObject_Free(type->tp_doc);
Tim Peters6d6c1a32001-08-02 04:15:00 +00002111 Py_XDECREF(et->name);
2112 Py_XDECREF(et->slots);
2113 type->ob_type->tp_free((PyObject *)type);
2114}
2115
Guido van Rossum1c450732001-10-08 15:18:27 +00002116static PyObject *
2117type_subclasses(PyTypeObject *type, PyObject *args_ignored)
2118{
2119 PyObject *list, *raw, *ref;
2120 int i, n;
2121
2122 list = PyList_New(0);
2123 if (list == NULL)
2124 return NULL;
2125 raw = type->tp_subclasses;
2126 if (raw == NULL)
2127 return list;
2128 assert(PyList_Check(raw));
2129 n = PyList_GET_SIZE(raw);
2130 for (i = 0; i < n; i++) {
2131 ref = PyList_GET_ITEM(raw, i);
Tim Peters44383382001-10-08 16:49:26 +00002132 assert(PyWeakref_CheckRef(ref));
Guido van Rossum1c450732001-10-08 15:18:27 +00002133 ref = PyWeakref_GET_OBJECT(ref);
2134 if (ref != Py_None) {
2135 if (PyList_Append(list, ref) < 0) {
2136 Py_DECREF(list);
2137 return NULL;
2138 }
2139 }
2140 }
2141 return list;
2142}
2143
Tim Peters6d6c1a32001-08-02 04:15:00 +00002144static PyMethodDef type_methods[] = {
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00002145 {"mro", (PyCFunction)mro_external, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002146 PyDoc_STR("mro() -> list\nreturn a type's method resolution order")},
Guido van Rossum1c450732001-10-08 15:18:27 +00002147 {"__subclasses__", (PyCFunction)type_subclasses, METH_NOARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002148 PyDoc_STR("__subclasses__() -> list of immediate subclasses")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002149 {0}
2150};
2151
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002152PyDoc_STRVAR(type_doc,
Tim Peters6d6c1a32001-08-02 04:15:00 +00002153"type(object) -> the object's type\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002154"type(name, bases, dict) -> a new type");
Tim Peters6d6c1a32001-08-02 04:15:00 +00002155
Guido van Rossum048eb752001-10-02 21:24:57 +00002156static int
2157type_traverse(PyTypeObject *type, visitproc visit, void *arg)
2158{
Guido van Rossum048eb752001-10-02 21:24:57 +00002159 int err;
2160
Guido van Rossuma3862092002-06-10 15:24:42 +00002161 /* Because of type_is_gc(), the collector only calls this
2162 for heaptypes. */
2163 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002164
2165#define VISIT(SLOT) \
2166 if (SLOT) { \
2167 err = visit((PyObject *)(SLOT), arg); \
2168 if (err) \
2169 return err; \
2170 }
2171
2172 VISIT(type->tp_dict);
Guido van Rossum687ae002001-10-15 22:03:32 +00002173 VISIT(type->tp_cache);
Guido van Rossum048eb752001-10-02 21:24:57 +00002174 VISIT(type->tp_mro);
2175 VISIT(type->tp_bases);
2176 VISIT(type->tp_base);
Guido van Rossuma3862092002-06-10 15:24:42 +00002177
2178 /* There's no need to visit type->tp_subclasses or
Guido van Rossume5c691a2003-03-07 15:13:17 +00002179 ((PyHeapTypeObject *)type)->slots, because they can't be involved
Guido van Rossuma3862092002-06-10 15:24:42 +00002180 in cycles; tp_subclasses is a list of weak references,
2181 and slots is a tuple of strings. */
Guido van Rossum048eb752001-10-02 21:24:57 +00002182
2183#undef VISIT
2184
2185 return 0;
2186}
2187
2188static int
2189type_clear(PyTypeObject *type)
2190{
Guido van Rossum048eb752001-10-02 21:24:57 +00002191 PyObject *tmp;
2192
Guido van Rossuma3862092002-06-10 15:24:42 +00002193 /* Because of type_is_gc(), the collector only calls this
2194 for heaptypes. */
2195 assert(type->tp_flags & Py_TPFLAGS_HEAPTYPE);
Guido van Rossum048eb752001-10-02 21:24:57 +00002196
2197#define CLEAR(SLOT) \
2198 if (SLOT) { \
2199 tmp = (PyObject *)(SLOT); \
2200 SLOT = NULL; \
2201 Py_DECREF(tmp); \
2202 }
2203
Guido van Rossuma3862092002-06-10 15:24:42 +00002204 /* The only field we need to clear is tp_mro, which is part of a
2205 hard cycle (its first element is the class itself) that won't
2206 be broken otherwise (it's a tuple and tuples don't have a
2207 tp_clear handler). None of the other fields need to be
2208 cleared, and here's why:
Guido van Rossum048eb752001-10-02 21:24:57 +00002209
Guido van Rossuma3862092002-06-10 15:24:42 +00002210 tp_dict:
2211 It is a dict, so the collector will call its tp_clear.
2212
2213 tp_cache:
2214 Not used; if it were, it would be a dict.
2215
2216 tp_bases, tp_base:
2217 If these are involved in a cycle, there must be at least
2218 one other, mutable object in the cycle, e.g. a base
2219 class's dict; the cycle will be broken that way.
2220
2221 tp_subclasses:
2222 A list of weak references can't be part of a cycle; and
2223 lists have their own tp_clear.
2224
Guido van Rossume5c691a2003-03-07 15:13:17 +00002225 slots (in PyHeapTypeObject):
Guido van Rossuma3862092002-06-10 15:24:42 +00002226 A tuple of strings can't be part of a cycle.
2227 */
2228
2229 CLEAR(type->tp_mro);
Tim Peters2f93e282001-10-04 05:27:00 +00002230
Guido van Rossum048eb752001-10-02 21:24:57 +00002231#undef CLEAR
2232
2233 return 0;
2234}
2235
2236static int
2237type_is_gc(PyTypeObject *type)
2238{
2239 return type->tp_flags & Py_TPFLAGS_HEAPTYPE;
2240}
2241
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002242PyTypeObject PyType_Type = {
2243 PyObject_HEAD_INIT(&PyType_Type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002244 0, /* ob_size */
2245 "type", /* tp_name */
Guido van Rossume5c691a2003-03-07 15:13:17 +00002246 sizeof(PyHeapTypeObject), /* tp_basicsize */
Guido van Rossum6f799372001-09-20 20:46:19 +00002247 sizeof(PyMemberDef), /* tp_itemsize */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002248 (destructor)type_dealloc, /* tp_dealloc */
2249 0, /* tp_print */
2250 0, /* tp_getattr */
2251 0, /* tp_setattr */
2252 type_compare, /* tp_compare */
2253 (reprfunc)type_repr, /* tp_repr */
2254 0, /* tp_as_number */
2255 0, /* tp_as_sequence */
2256 0, /* tp_as_mapping */
2257 (hashfunc)_Py_HashPointer, /* tp_hash */
2258 (ternaryfunc)type_call, /* tp_call */
2259 0, /* tp_str */
2260 (getattrofunc)type_getattro, /* tp_getattro */
2261 (setattrofunc)type_setattro, /* tp_setattro */
2262 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00002263 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
2264 Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002265 type_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00002266 (traverseproc)type_traverse, /* tp_traverse */
2267 (inquiry)type_clear, /* tp_clear */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002268 0, /* tp_richcompare */
Guido van Rossum1c450732001-10-08 15:18:27 +00002269 offsetof(PyTypeObject, tp_weaklist), /* tp_weaklistoffset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002270 0, /* tp_iter */
2271 0, /* tp_iternext */
2272 type_methods, /* tp_methods */
2273 type_members, /* tp_members */
2274 type_getsets, /* tp_getset */
2275 0, /* tp_base */
2276 0, /* tp_dict */
2277 0, /* tp_descr_get */
2278 0, /* tp_descr_set */
2279 offsetof(PyTypeObject, tp_dict), /* tp_dictoffset */
2280 0, /* tp_init */
2281 0, /* tp_alloc */
2282 type_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002283 PyObject_GC_Del, /* tp_free */
Guido van Rossum048eb752001-10-02 21:24:57 +00002284 (inquiry)type_is_gc, /* tp_is_gc */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002285};
Tim Peters6d6c1a32001-08-02 04:15:00 +00002286
2287
2288/* The base type of all types (eventually)... except itself. */
2289
2290static int
2291object_init(PyObject *self, PyObject *args, PyObject *kwds)
2292{
2293 return 0;
2294}
2295
Guido van Rossum298e4212003-02-13 16:30:16 +00002296/* If we don't have a tp_new for a new-style class, new will use this one.
2297 Therefore this should take no arguments/keywords. However, this new may
2298 also be inherited by objects that define a tp_init but no tp_new. These
2299 objects WILL pass argumets to tp_new, because it gets the same args as
2300 tp_init. So only allow arguments if we aren't using the default init, in
2301 which case we expect init to handle argument parsing. */
2302static PyObject *
2303object_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
2304{
2305 if (type->tp_init == object_init && (PyTuple_GET_SIZE(args) ||
2306 (kwds && PyDict_Check(kwds) && PyDict_Size(kwds)))) {
2307 PyErr_SetString(PyExc_TypeError,
2308 "default __new__ takes no parameters");
2309 return NULL;
2310 }
2311 return type->tp_alloc(type, 0);
2312}
2313
Tim Peters6d6c1a32001-08-02 04:15:00 +00002314static void
2315object_dealloc(PyObject *self)
2316{
2317 self->ob_type->tp_free(self);
2318}
2319
Guido van Rossum8e248182001-08-12 05:17:56 +00002320static PyObject *
2321object_repr(PyObject *self)
2322{
Guido van Rossum76e69632001-08-16 18:52:43 +00002323 PyTypeObject *type;
Barry Warsaw7ce36942001-08-24 18:34:26 +00002324 PyObject *mod, *name, *rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002325
Guido van Rossum76e69632001-08-16 18:52:43 +00002326 type = self->ob_type;
2327 mod = type_module(type, NULL);
2328 if (mod == NULL)
2329 PyErr_Clear();
2330 else if (!PyString_Check(mod)) {
2331 Py_DECREF(mod);
2332 mod = NULL;
2333 }
2334 name = type_name(type, NULL);
2335 if (name == NULL)
2336 return NULL;
2337 if (mod != NULL && strcmp(PyString_AS_STRING(mod), "__builtin__"))
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002338 rtn = PyString_FromFormat("<%s.%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002339 PyString_AS_STRING(mod),
2340 PyString_AS_STRING(name),
2341 self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002342 else
Guido van Rossumff0e6d62001-09-24 16:03:59 +00002343 rtn = PyString_FromFormat("<%s object at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +00002344 type->tp_name, self);
Guido van Rossum76e69632001-08-16 18:52:43 +00002345 Py_XDECREF(mod);
2346 Py_DECREF(name);
Barry Warsaw7ce36942001-08-24 18:34:26 +00002347 return rtn;
Guido van Rossum8e248182001-08-12 05:17:56 +00002348}
2349
Guido van Rossumb8f63662001-08-15 23:57:02 +00002350static PyObject *
2351object_str(PyObject *self)
2352{
2353 unaryfunc f;
2354
2355 f = self->ob_type->tp_repr;
2356 if (f == NULL)
2357 f = object_repr;
2358 return f(self);
2359}
2360
Guido van Rossum8e248182001-08-12 05:17:56 +00002361static long
2362object_hash(PyObject *self)
2363{
2364 return _Py_HashPointer(self);
2365}
Guido van Rossum8e248182001-08-12 05:17:56 +00002366
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002367static PyObject *
2368object_get_class(PyObject *self, void *closure)
2369{
2370 Py_INCREF(self->ob_type);
2371 return (PyObject *)(self->ob_type);
2372}
2373
2374static int
2375equiv_structs(PyTypeObject *a, PyTypeObject *b)
2376{
2377 return a == b ||
2378 (a != NULL &&
2379 b != NULL &&
2380 a->tp_basicsize == b->tp_basicsize &&
2381 a->tp_itemsize == b->tp_itemsize &&
2382 a->tp_dictoffset == b->tp_dictoffset &&
2383 a->tp_weaklistoffset == b->tp_weaklistoffset &&
2384 ((a->tp_flags & Py_TPFLAGS_HAVE_GC) ==
2385 (b->tp_flags & Py_TPFLAGS_HAVE_GC)));
2386}
2387
2388static int
2389same_slots_added(PyTypeObject *a, PyTypeObject *b)
2390{
2391 PyTypeObject *base = a->tp_base;
2392 int size;
2393
2394 if (base != b->tp_base)
2395 return 0;
2396 if (equiv_structs(a, base) && equiv_structs(b, base))
2397 return 1;
2398 size = base->tp_basicsize;
2399 if (a->tp_dictoffset == size && b->tp_dictoffset == size)
2400 size += sizeof(PyObject *);
2401 if (a->tp_weaklistoffset == size && b->tp_weaklistoffset == size)
2402 size += sizeof(PyObject *);
2403 return size == a->tp_basicsize && size == b->tp_basicsize;
2404}
2405
2406static int
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002407compatible_for_assignment(PyTypeObject* old, PyTypeObject* new, char* attr)
2408{
2409 PyTypeObject *newbase, *oldbase;
2410
2411 if (new->tp_dealloc != old->tp_dealloc ||
2412 new->tp_free != old->tp_free)
2413 {
2414 PyErr_Format(PyExc_TypeError,
2415 "%s assignment: "
2416 "'%s' deallocator differs from '%s'",
2417 attr,
2418 new->tp_name,
2419 old->tp_name);
2420 return 0;
2421 }
2422 newbase = new;
2423 oldbase = old;
2424 while (equiv_structs(newbase, newbase->tp_base))
2425 newbase = newbase->tp_base;
2426 while (equiv_structs(oldbase, oldbase->tp_base))
2427 oldbase = oldbase->tp_base;
2428 if (newbase != oldbase &&
2429 (newbase->tp_base != oldbase->tp_base ||
2430 !same_slots_added(newbase, oldbase))) {
2431 PyErr_Format(PyExc_TypeError,
2432 "%s assignment: "
2433 "'%s' object layout differs from '%s'",
2434 attr,
2435 new->tp_name,
2436 old->tp_name);
2437 return 0;
2438 }
Tim Petersea7f75d2002-12-07 21:39:16 +00002439
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002440 return 1;
2441}
2442
2443static int
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002444object_set_class(PyObject *self, PyObject *value, void *closure)
2445{
2446 PyTypeObject *old = self->ob_type;
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002447 PyTypeObject *new;
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002448
Guido van Rossumb6b89422002-04-15 01:03:30 +00002449 if (value == NULL) {
2450 PyErr_SetString(PyExc_TypeError,
2451 "can't delete __class__ attribute");
2452 return -1;
2453 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002454 if (!PyType_Check(value)) {
2455 PyErr_Format(PyExc_TypeError,
2456 "__class__ must be set to new-style class, not '%s' object",
2457 value->ob_type->tp_name);
2458 return -1;
2459 }
2460 new = (PyTypeObject *)value;
Guido van Rossum40af8892002-08-10 05:42:07 +00002461 if (!(new->tp_flags & Py_TPFLAGS_HEAPTYPE) ||
2462 !(old->tp_flags & Py_TPFLAGS_HEAPTYPE))
2463 {
2464 PyErr_Format(PyExc_TypeError,
2465 "__class__ assignment: only for heap types");
2466 return -1;
2467 }
Michael W. Hudson98bbc492002-11-26 14:47:27 +00002468 if (compatible_for_assignment(new, old, "__class__")) {
2469 Py_INCREF(new);
2470 self->ob_type = new;
2471 Py_DECREF(old);
2472 return 0;
2473 }
2474 else {
Guido van Rossum9ee4b942002-05-24 18:47:47 +00002475 return -1;
2476 }
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002477}
2478
2479static PyGetSetDef object_getsets[] = {
2480 {"__class__", object_get_class, object_set_class,
Neal Norwitz858e34f2002-08-13 17:18:45 +00002481 PyDoc_STR("the object's class")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00002482 {0}
2483};
2484
Guido van Rossumc53f0092003-02-18 22:05:12 +00002485
Guido van Rossum036f9992003-02-21 22:02:54 +00002486/* Stuff to implement __reduce_ex__ for pickle protocols >= 2.
2487 We fall back to helpers in copy_reg for:
2488 - pickle protocols < 2
2489 - calculating the list of slot names (done only once per class)
2490 - the __newobj__ function (which is used as a token but never called)
2491*/
2492
2493static PyObject *
2494import_copy_reg(void)
2495{
2496 static PyObject *copy_reg_str;
Guido van Rossum3926a632001-09-25 16:25:58 +00002497
2498 if (!copy_reg_str) {
2499 copy_reg_str = PyString_InternFromString("copy_reg");
2500 if (copy_reg_str == NULL)
2501 return NULL;
2502 }
Guido van Rossum036f9992003-02-21 22:02:54 +00002503
2504 return PyImport_Import(copy_reg_str);
2505}
2506
2507static PyObject *
2508slotnames(PyObject *cls)
2509{
2510 PyObject *clsdict;
2511 PyObject *copy_reg;
2512 PyObject *slotnames;
2513
2514 if (!PyType_Check(cls)) {
2515 Py_INCREF(Py_None);
2516 return Py_None;
2517 }
2518
2519 clsdict = ((PyTypeObject *)cls)->tp_dict;
2520 slotnames = PyDict_GetItemString(clsdict, "__slotnames__");
2521 if (slotnames != NULL) {
2522 Py_INCREF(slotnames);
2523 return slotnames;
2524 }
2525
2526 copy_reg = import_copy_reg();
2527 if (copy_reg == NULL)
2528 return NULL;
2529
2530 slotnames = PyObject_CallMethod(copy_reg, "_slotnames", "O", cls);
2531 Py_DECREF(copy_reg);
2532 if (slotnames != NULL &&
2533 slotnames != Py_None &&
2534 !PyList_Check(slotnames))
2535 {
2536 PyErr_SetString(PyExc_TypeError,
2537 "copy_reg._slotnames didn't return a list or None");
2538 Py_DECREF(slotnames);
2539 slotnames = NULL;
2540 }
2541
2542 return slotnames;
2543}
2544
2545static PyObject *
2546reduce_2(PyObject *obj)
2547{
2548 PyObject *cls, *getnewargs;
2549 PyObject *args = NULL, *args2 = NULL;
2550 PyObject *getstate = NULL, *state = NULL, *names = NULL;
2551 PyObject *slots = NULL, *listitems = NULL, *dictitems = NULL;
2552 PyObject *copy_reg = NULL, *newobj = NULL, *res = NULL;
2553 int i, n;
2554
2555 cls = PyObject_GetAttrString(obj, "__class__");
2556 if (cls == NULL)
2557 return NULL;
2558
2559 getnewargs = PyObject_GetAttrString(obj, "__getnewargs__");
2560 if (getnewargs != NULL) {
2561 args = PyObject_CallObject(getnewargs, NULL);
2562 Py_DECREF(getnewargs);
2563 if (args != NULL && !PyTuple_Check(args)) {
2564 PyErr_SetString(PyExc_TypeError,
2565 "__getnewargs__ should return a tuple");
2566 goto end;
2567 }
2568 }
2569 else {
2570 PyErr_Clear();
2571 args = PyTuple_New(0);
2572 }
2573 if (args == NULL)
2574 goto end;
2575
2576 getstate = PyObject_GetAttrString(obj, "__getstate__");
2577 if (getstate != NULL) {
2578 state = PyObject_CallObject(getstate, NULL);
2579 Py_DECREF(getstate);
Neal Norwitze2fdc612003-06-08 13:19:58 +00002580 if (state == NULL)
2581 goto end;
Guido van Rossum036f9992003-02-21 22:02:54 +00002582 }
2583 else {
2584 state = PyObject_GetAttrString(obj, "__dict__");
2585 if (state == NULL) {
2586 PyErr_Clear();
2587 state = Py_None;
2588 Py_INCREF(state);
2589 }
2590 names = slotnames(cls);
2591 if (names == NULL)
2592 goto end;
2593 if (names != Py_None) {
2594 assert(PyList_Check(names));
2595 slots = PyDict_New();
2596 if (slots == NULL)
2597 goto end;
2598 n = 0;
2599 /* Can't pre-compute the list size; the list
2600 is stored on the class so accessible to other
2601 threads, which may be run by DECREF */
2602 for (i = 0; i < PyList_GET_SIZE(names); i++) {
2603 PyObject *name, *value;
2604 name = PyList_GET_ITEM(names, i);
2605 value = PyObject_GetAttr(obj, name);
2606 if (value == NULL)
2607 PyErr_Clear();
2608 else {
2609 int err = PyDict_SetItem(slots, name,
2610 value);
2611 Py_DECREF(value);
2612 if (err)
2613 goto end;
2614 n++;
2615 }
2616 }
2617 if (n) {
2618 state = Py_BuildValue("(NO)", state, slots);
2619 if (state == NULL)
2620 goto end;
2621 }
2622 }
2623 }
2624
2625 if (!PyList_Check(obj)) {
2626 listitems = Py_None;
2627 Py_INCREF(listitems);
2628 }
2629 else {
2630 listitems = PyObject_GetIter(obj);
2631 if (listitems == NULL)
2632 goto end;
2633 }
2634
2635 if (!PyDict_Check(obj)) {
2636 dictitems = Py_None;
2637 Py_INCREF(dictitems);
2638 }
2639 else {
2640 dictitems = PyObject_CallMethod(obj, "iteritems", "");
2641 if (dictitems == NULL)
2642 goto end;
2643 }
2644
2645 copy_reg = import_copy_reg();
2646 if (copy_reg == NULL)
2647 goto end;
2648 newobj = PyObject_GetAttrString(copy_reg, "__newobj__");
2649 if (newobj == NULL)
2650 goto end;
2651
2652 n = PyTuple_GET_SIZE(args);
2653 args2 = PyTuple_New(n+1);
2654 if (args2 == NULL)
2655 goto end;
2656 PyTuple_SET_ITEM(args2, 0, cls);
2657 cls = NULL;
2658 for (i = 0; i < n; i++) {
2659 PyObject *v = PyTuple_GET_ITEM(args, i);
2660 Py_INCREF(v);
2661 PyTuple_SET_ITEM(args2, i+1, v);
2662 }
2663
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002664 res = PyTuple_Pack(5, newobj, args2, state, listitems, dictitems);
Guido van Rossum036f9992003-02-21 22:02:54 +00002665
2666 end:
2667 Py_XDECREF(cls);
2668 Py_XDECREF(args);
2669 Py_XDECREF(args2);
Jeremy Hyltond06483c2003-04-09 21:01:42 +00002670 Py_XDECREF(slots);
Guido van Rossum036f9992003-02-21 22:02:54 +00002671 Py_XDECREF(state);
2672 Py_XDECREF(names);
2673 Py_XDECREF(listitems);
2674 Py_XDECREF(dictitems);
2675 Py_XDECREF(copy_reg);
2676 Py_XDECREF(newobj);
2677 return res;
2678}
2679
2680static PyObject *
2681object_reduce_ex(PyObject *self, PyObject *args)
2682{
2683 /* Call copy_reg._reduce_ex(self, proto) */
2684 PyObject *reduce, *copy_reg, *res;
2685 int proto = 0;
2686
2687 if (!PyArg_ParseTuple(args, "|i:__reduce_ex__", &proto))
2688 return NULL;
2689
2690 reduce = PyObject_GetAttrString(self, "__reduce__");
2691 if (reduce == NULL)
2692 PyErr_Clear();
2693 else {
2694 PyObject *cls, *clsreduce, *objreduce;
2695 int override;
2696 cls = PyObject_GetAttrString(self, "__class__");
2697 if (cls == NULL) {
2698 Py_DECREF(reduce);
2699 return NULL;
2700 }
2701 clsreduce = PyObject_GetAttrString(cls, "__reduce__");
2702 Py_DECREF(cls);
2703 if (clsreduce == NULL) {
2704 Py_DECREF(reduce);
2705 return NULL;
2706 }
2707 objreduce = PyDict_GetItemString(PyBaseObject_Type.tp_dict,
2708 "__reduce__");
2709 override = (clsreduce != objreduce);
2710 Py_DECREF(clsreduce);
2711 if (override) {
2712 res = PyObject_CallObject(reduce, NULL);
2713 Py_DECREF(reduce);
2714 return res;
2715 }
2716 else
2717 Py_DECREF(reduce);
2718 }
2719
2720 if (proto >= 2)
2721 return reduce_2(self);
2722
2723 copy_reg = import_copy_reg();
Guido van Rossum3926a632001-09-25 16:25:58 +00002724 if (!copy_reg)
2725 return NULL;
Guido van Rossum036f9992003-02-21 22:02:54 +00002726
Guido van Rossumc53f0092003-02-18 22:05:12 +00002727 res = PyEval_CallMethod(copy_reg, "_reduce_ex", "(Oi)", self, proto);
Guido van Rossum3926a632001-09-25 16:25:58 +00002728 Py_DECREF(copy_reg);
Guido van Rossum036f9992003-02-21 22:02:54 +00002729
Guido van Rossum3926a632001-09-25 16:25:58 +00002730 return res;
2731}
2732
2733static PyMethodDef object_methods[] = {
Guido van Rossumc53f0092003-02-18 22:05:12 +00002734 {"__reduce_ex__", object_reduce_ex, METH_VARARGS,
2735 PyDoc_STR("helper for pickle")},
2736 {"__reduce__", object_reduce_ex, METH_VARARGS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002737 PyDoc_STR("helper for pickle")},
Guido van Rossum3926a632001-09-25 16:25:58 +00002738 {0}
2739};
2740
Guido van Rossum036f9992003-02-21 22:02:54 +00002741
Tim Peters6d6c1a32001-08-02 04:15:00 +00002742PyTypeObject PyBaseObject_Type = {
2743 PyObject_HEAD_INIT(&PyType_Type)
2744 0, /* ob_size */
2745 "object", /* tp_name */
2746 sizeof(PyObject), /* tp_basicsize */
2747 0, /* tp_itemsize */
2748 (destructor)object_dealloc, /* tp_dealloc */
2749 0, /* tp_print */
2750 0, /* tp_getattr */
2751 0, /* tp_setattr */
2752 0, /* tp_compare */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002753 object_repr, /* tp_repr */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002754 0, /* tp_as_number */
2755 0, /* tp_as_sequence */
2756 0, /* tp_as_mapping */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002757 object_hash, /* tp_hash */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002758 0, /* tp_call */
Guido van Rossumb8f63662001-08-15 23:57:02 +00002759 object_str, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002760 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002761 PyObject_GenericSetAttr, /* tp_setattro */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002762 0, /* tp_as_buffer */
2763 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Neal Norwitz5dc2a372002-08-13 22:19:13 +00002764 PyDoc_STR("The most base type"), /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002765 0, /* tp_traverse */
2766 0, /* tp_clear */
2767 0, /* tp_richcompare */
2768 0, /* tp_weaklistoffset */
2769 0, /* tp_iter */
2770 0, /* tp_iternext */
Guido van Rossum3926a632001-09-25 16:25:58 +00002771 object_methods, /* tp_methods */
Guido van Rossum5c294fb2001-09-25 03:43:42 +00002772 0, /* tp_members */
2773 object_getsets, /* tp_getset */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002774 0, /* tp_base */
2775 0, /* tp_dict */
2776 0, /* tp_descr_get */
2777 0, /* tp_descr_set */
2778 0, /* tp_dictoffset */
2779 object_init, /* tp_init */
2780 PyType_GenericAlloc, /* tp_alloc */
Guido van Rossum298e4212003-02-13 16:30:16 +00002781 object_new, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00002782 PyObject_Del, /* tp_free */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002783};
2784
2785
2786/* Initialize the __dict__ in a type object */
2787
2788static int
2789add_methods(PyTypeObject *type, PyMethodDef *meth)
2790{
Guido van Rossum687ae002001-10-15 22:03:32 +00002791 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002792
2793 for (; meth->ml_name != NULL; meth++) {
2794 PyObject *descr;
2795 if (PyDict_GetItemString(dict, meth->ml_name))
2796 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002797 if (meth->ml_flags & METH_CLASS) {
2798 if (meth->ml_flags & METH_STATIC) {
2799 PyErr_SetString(PyExc_ValueError,
2800 "method cannot be both class and static");
2801 return -1;
2802 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002803 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002804 }
2805 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002806 PyObject *cfunc = PyCFunction_New(meth, NULL);
2807 if (cfunc == NULL)
2808 return -1;
2809 descr = PyStaticMethod_New(cfunc);
2810 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002811 }
2812 else {
2813 descr = PyDescr_NewMethod(type, meth);
2814 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002815 if (descr == NULL)
2816 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002817 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002818 return -1;
2819 Py_DECREF(descr);
2820 }
2821 return 0;
2822}
2823
2824static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002825add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002826{
Guido van Rossum687ae002001-10-15 22:03:32 +00002827 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002828
2829 for (; memb->name != NULL; memb++) {
2830 PyObject *descr;
2831 if (PyDict_GetItemString(dict, memb->name))
2832 continue;
2833 descr = PyDescr_NewMember(type, memb);
2834 if (descr == NULL)
2835 return -1;
2836 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2837 return -1;
2838 Py_DECREF(descr);
2839 }
2840 return 0;
2841}
2842
2843static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002844add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002845{
Guido van Rossum687ae002001-10-15 22:03:32 +00002846 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002847
2848 for (; gsp->name != NULL; gsp++) {
2849 PyObject *descr;
2850 if (PyDict_GetItemString(dict, gsp->name))
2851 continue;
2852 descr = PyDescr_NewGetSet(type, gsp);
2853
2854 if (descr == NULL)
2855 return -1;
2856 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2857 return -1;
2858 Py_DECREF(descr);
2859 }
2860 return 0;
2861}
2862
Guido van Rossum13d52f02001-08-10 21:24:08 +00002863static void
2864inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002865{
2866 int oldsize, newsize;
2867
Guido van Rossum13d52f02001-08-10 21:24:08 +00002868 /* Special flag magic */
2869 if (!type->tp_as_buffer && base->tp_as_buffer) {
2870 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2871 type->tp_flags |=
2872 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2873 }
2874 if (!type->tp_as_sequence && base->tp_as_sequence) {
2875 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2876 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2877 }
2878 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2879 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2880 if ((!type->tp_as_number && base->tp_as_number) ||
2881 (!type->tp_as_sequence && base->tp_as_sequence)) {
2882 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2883 if (!type->tp_as_number && !type->tp_as_sequence) {
2884 type->tp_flags |= base->tp_flags &
2885 Py_TPFLAGS_HAVE_INPLACEOPS;
2886 }
2887 }
2888 /* Wow */
2889 }
2890 if (!type->tp_as_number && base->tp_as_number) {
2891 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2892 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2893 }
2894
2895 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002896 oldsize = base->tp_basicsize;
2897 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2898 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2899 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002900 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2901 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002902 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002903 if (type->tp_traverse == NULL)
2904 type->tp_traverse = base->tp_traverse;
2905 if (type->tp_clear == NULL)
2906 type->tp_clear = base->tp_clear;
2907 }
2908 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002909 /* The condition below could use some explanation.
2910 It appears that tp_new is not inherited for static types
2911 whose base class is 'object'; this seems to be a precaution
2912 so that old extension types don't suddenly become
2913 callable (object.__new__ wouldn't insure the invariants
2914 that the extension type's own factory function ensures).
2915 Heap types, of course, are under our control, so they do
2916 inherit tp_new; static extension types that specify some
2917 other built-in type as the default are considered
2918 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002919 if (base != &PyBaseObject_Type ||
2920 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2921 if (type->tp_new == NULL)
2922 type->tp_new = base->tp_new;
2923 }
2924 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002925 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002926
2927 /* Copy other non-function slots */
2928
2929#undef COPYVAL
2930#define COPYVAL(SLOT) \
2931 if (type->SLOT == 0) type->SLOT = base->SLOT
2932
2933 COPYVAL(tp_itemsize);
2934 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2935 COPYVAL(tp_weaklistoffset);
2936 }
2937 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2938 COPYVAL(tp_dictoffset);
2939 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002940}
2941
2942static void
2943inherit_slots(PyTypeObject *type, PyTypeObject *base)
2944{
2945 PyTypeObject *basebase;
2946
2947#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002948#undef COPYSLOT
2949#undef COPYNUM
2950#undef COPYSEQ
2951#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002952#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002953
2954#define SLOTDEFINED(SLOT) \
2955 (base->SLOT != 0 && \
2956 (basebase == NULL || base->SLOT != basebase->SLOT))
2957
Tim Peters6d6c1a32001-08-02 04:15:00 +00002958#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002959 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002960
2961#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2962#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2963#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002964#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002965
Guido van Rossum13d52f02001-08-10 21:24:08 +00002966 /* This won't inherit indirect slots (from tp_as_number etc.)
2967 if type doesn't provide the space. */
2968
2969 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2970 basebase = base->tp_base;
2971 if (basebase->tp_as_number == NULL)
2972 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002973 COPYNUM(nb_add);
2974 COPYNUM(nb_subtract);
2975 COPYNUM(nb_multiply);
2976 COPYNUM(nb_divide);
2977 COPYNUM(nb_remainder);
2978 COPYNUM(nb_divmod);
2979 COPYNUM(nb_power);
2980 COPYNUM(nb_negative);
2981 COPYNUM(nb_positive);
2982 COPYNUM(nb_absolute);
2983 COPYNUM(nb_nonzero);
2984 COPYNUM(nb_invert);
2985 COPYNUM(nb_lshift);
2986 COPYNUM(nb_rshift);
2987 COPYNUM(nb_and);
2988 COPYNUM(nb_xor);
2989 COPYNUM(nb_or);
2990 COPYNUM(nb_coerce);
2991 COPYNUM(nb_int);
2992 COPYNUM(nb_long);
2993 COPYNUM(nb_float);
2994 COPYNUM(nb_oct);
2995 COPYNUM(nb_hex);
2996 COPYNUM(nb_inplace_add);
2997 COPYNUM(nb_inplace_subtract);
2998 COPYNUM(nb_inplace_multiply);
2999 COPYNUM(nb_inplace_divide);
3000 COPYNUM(nb_inplace_remainder);
3001 COPYNUM(nb_inplace_power);
3002 COPYNUM(nb_inplace_lshift);
3003 COPYNUM(nb_inplace_rshift);
3004 COPYNUM(nb_inplace_and);
3005 COPYNUM(nb_inplace_xor);
3006 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003007 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3008 COPYNUM(nb_true_divide);
3009 COPYNUM(nb_floor_divide);
3010 COPYNUM(nb_inplace_true_divide);
3011 COPYNUM(nb_inplace_floor_divide);
3012 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003013 }
3014
Guido van Rossum13d52f02001-08-10 21:24:08 +00003015 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3016 basebase = base->tp_base;
3017 if (basebase->tp_as_sequence == NULL)
3018 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003019 COPYSEQ(sq_length);
3020 COPYSEQ(sq_concat);
3021 COPYSEQ(sq_repeat);
3022 COPYSEQ(sq_item);
3023 COPYSEQ(sq_slice);
3024 COPYSEQ(sq_ass_item);
3025 COPYSEQ(sq_ass_slice);
3026 COPYSEQ(sq_contains);
3027 COPYSEQ(sq_inplace_concat);
3028 COPYSEQ(sq_inplace_repeat);
3029 }
3030
Guido van Rossum13d52f02001-08-10 21:24:08 +00003031 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3032 basebase = base->tp_base;
3033 if (basebase->tp_as_mapping == NULL)
3034 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003035 COPYMAP(mp_length);
3036 COPYMAP(mp_subscript);
3037 COPYMAP(mp_ass_subscript);
3038 }
3039
Tim Petersfc57ccb2001-10-12 02:38:24 +00003040 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3041 basebase = base->tp_base;
3042 if (basebase->tp_as_buffer == NULL)
3043 basebase = NULL;
3044 COPYBUF(bf_getreadbuffer);
3045 COPYBUF(bf_getwritebuffer);
3046 COPYBUF(bf_getsegcount);
3047 COPYBUF(bf_getcharbuffer);
3048 }
3049
Guido van Rossum13d52f02001-08-10 21:24:08 +00003050 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003051
Tim Peters6d6c1a32001-08-02 04:15:00 +00003052 COPYSLOT(tp_dealloc);
3053 COPYSLOT(tp_print);
3054 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3055 type->tp_getattr = base->tp_getattr;
3056 type->tp_getattro = base->tp_getattro;
3057 }
3058 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3059 type->tp_setattr = base->tp_setattr;
3060 type->tp_setattro = base->tp_setattro;
3061 }
3062 /* tp_compare see tp_richcompare */
3063 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003064 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003065 COPYSLOT(tp_call);
3066 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003067 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003068 if (type->tp_compare == NULL &&
3069 type->tp_richcompare == NULL &&
3070 type->tp_hash == NULL)
3071 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003072 type->tp_compare = base->tp_compare;
3073 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003074 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003075 }
3076 }
3077 else {
3078 COPYSLOT(tp_compare);
3079 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003080 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3081 COPYSLOT(tp_iter);
3082 COPYSLOT(tp_iternext);
3083 }
3084 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3085 COPYSLOT(tp_descr_get);
3086 COPYSLOT(tp_descr_set);
3087 COPYSLOT(tp_dictoffset);
3088 COPYSLOT(tp_init);
3089 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003090 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003091 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3092 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3093 /* They agree about gc. */
3094 COPYSLOT(tp_free);
3095 }
3096 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3097 type->tp_free == NULL &&
3098 base->tp_free == _PyObject_Del) {
3099 /* A bit of magic to plug in the correct default
3100 * tp_free function when a derived class adds gc,
3101 * didn't define tp_free, and the base uses the
3102 * default non-gc tp_free.
3103 */
3104 type->tp_free = PyObject_GC_Del;
3105 }
3106 /* else they didn't agree about gc, and there isn't something
3107 * obvious to be done -- the type is on its own.
3108 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003109 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003110}
3111
Jeremy Hylton938ace62002-07-17 16:30:39 +00003112static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003113
Tim Peters6d6c1a32001-08-02 04:15:00 +00003114int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003115PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003116{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003117 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003118 PyTypeObject *base;
3119 int i, n;
3120
Guido van Rossumcab05802002-06-10 15:29:03 +00003121 if (type->tp_flags & Py_TPFLAGS_READY) {
3122 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003123 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003124 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003125 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003126
3127 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003128
Tim Peters36eb4df2003-03-23 03:33:13 +00003129#ifdef Py_TRACE_REFS
3130 /* PyType_Ready is the closest thing we have to a choke point
3131 * for type objects, so is the best place I can think of to try
3132 * to get type objects into the doubly-linked list of all objects.
3133 * Still, not all type objects go thru PyType_Ready.
3134 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003135 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003136#endif
3137
Tim Peters6d6c1a32001-08-02 04:15:00 +00003138 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3139 base = type->tp_base;
3140 if (base == NULL && type != &PyBaseObject_Type)
3141 base = type->tp_base = &PyBaseObject_Type;
3142
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003143 /* Initialize the base class */
3144 if (base && base->tp_dict == NULL) {
3145 if (PyType_Ready(base) < 0)
3146 goto error;
3147 }
3148
Guido van Rossum0986d822002-04-08 01:38:42 +00003149 /* Initialize ob_type if NULL. This means extensions that want to be
3150 compilable separately on Windows can call PyType_Ready() instead of
3151 initializing the ob_type field of their type objects. */
3152 if (type->ob_type == NULL)
3153 type->ob_type = base->ob_type;
3154
Tim Peters6d6c1a32001-08-02 04:15:00 +00003155 /* Initialize tp_bases */
3156 bases = type->tp_bases;
3157 if (bases == NULL) {
3158 if (base == NULL)
3159 bases = PyTuple_New(0);
3160 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003161 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003162 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003163 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003164 type->tp_bases = bases;
3165 }
3166
Guido van Rossum687ae002001-10-15 22:03:32 +00003167 /* Initialize tp_dict */
3168 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003169 if (dict == NULL) {
3170 dict = PyDict_New();
3171 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003172 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003173 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003174 }
3175
Guido van Rossum687ae002001-10-15 22:03:32 +00003176 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003177 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003178 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003179 if (type->tp_methods != NULL) {
3180 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003181 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003182 }
3183 if (type->tp_members != NULL) {
3184 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003185 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003186 }
3187 if (type->tp_getset != NULL) {
3188 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003189 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003190 }
3191
Tim Peters6d6c1a32001-08-02 04:15:00 +00003192 /* Calculate method resolution order */
3193 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003194 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003195 }
3196
Guido van Rossum13d52f02001-08-10 21:24:08 +00003197 /* Inherit special flags from dominant base */
3198 if (type->tp_base != NULL)
3199 inherit_special(type, type->tp_base);
3200
Tim Peters6d6c1a32001-08-02 04:15:00 +00003201 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003202 bases = type->tp_mro;
3203 assert(bases != NULL);
3204 assert(PyTuple_Check(bases));
3205 n = PyTuple_GET_SIZE(bases);
3206 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003207 PyObject *b = PyTuple_GET_ITEM(bases, i);
3208 if (PyType_Check(b))
3209 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003210 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003211
Tim Peters3cfe7542003-05-21 21:29:48 +00003212 /* Sanity check for tp_free. */
3213 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3214 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
3215 /* This base class needs to call tp_free, but doesn't have
3216 * one, or its tp_free is for non-gc'ed objects.
3217 */
3218 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3219 "gc and is a base type but has inappropriate "
3220 "tp_free slot",
3221 type->tp_name);
3222 goto error;
3223 }
3224
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003225 /* if the type dictionary doesn't contain a __doc__, set it from
3226 the tp_doc slot.
3227 */
3228 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3229 if (type->tp_doc != NULL) {
3230 PyObject *doc = PyString_FromString(type->tp_doc);
3231 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3232 Py_DECREF(doc);
3233 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003234 PyDict_SetItemString(type->tp_dict,
3235 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003236 }
3237 }
3238
Guido van Rossum13d52f02001-08-10 21:24:08 +00003239 /* Some more special stuff */
3240 base = type->tp_base;
3241 if (base != NULL) {
3242 if (type->tp_as_number == NULL)
3243 type->tp_as_number = base->tp_as_number;
3244 if (type->tp_as_sequence == NULL)
3245 type->tp_as_sequence = base->tp_as_sequence;
3246 if (type->tp_as_mapping == NULL)
3247 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003248 if (type->tp_as_buffer == NULL)
3249 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003250 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003251
Guido van Rossum1c450732001-10-08 15:18:27 +00003252 /* Link into each base class's list of subclasses */
3253 bases = type->tp_bases;
3254 n = PyTuple_GET_SIZE(bases);
3255 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003256 PyObject *b = PyTuple_GET_ITEM(bases, i);
3257 if (PyType_Check(b) &&
3258 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003259 goto error;
3260 }
3261
Guido van Rossum13d52f02001-08-10 21:24:08 +00003262 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003263 assert(type->tp_dict != NULL);
3264 type->tp_flags =
3265 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003266 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003267
3268 error:
3269 type->tp_flags &= ~Py_TPFLAGS_READYING;
3270 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003271}
3272
Guido van Rossum1c450732001-10-08 15:18:27 +00003273static int
3274add_subclass(PyTypeObject *base, PyTypeObject *type)
3275{
3276 int i;
3277 PyObject *list, *ref, *new;
3278
3279 list = base->tp_subclasses;
3280 if (list == NULL) {
3281 base->tp_subclasses = list = PyList_New(0);
3282 if (list == NULL)
3283 return -1;
3284 }
3285 assert(PyList_Check(list));
3286 new = PyWeakref_NewRef((PyObject *)type, NULL);
3287 i = PyList_GET_SIZE(list);
3288 while (--i >= 0) {
3289 ref = PyList_GET_ITEM(list, i);
3290 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003291 if (PyWeakref_GET_OBJECT(ref) == Py_None)
3292 return PyList_SetItem(list, i, new);
Guido van Rossum1c450732001-10-08 15:18:27 +00003293 }
3294 i = PyList_Append(list, new);
3295 Py_DECREF(new);
3296 return i;
3297}
3298
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003299static void
3300remove_subclass(PyTypeObject *base, PyTypeObject *type)
3301{
3302 int i;
3303 PyObject *list, *ref;
3304
3305 list = base->tp_subclasses;
3306 if (list == NULL) {
3307 return;
3308 }
3309 assert(PyList_Check(list));
3310 i = PyList_GET_SIZE(list);
3311 while (--i >= 0) {
3312 ref = PyList_GET_ITEM(list, i);
3313 assert(PyWeakref_CheckRef(ref));
3314 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3315 /* this can't fail, right? */
3316 PySequence_DelItem(list, i);
3317 return;
3318 }
3319 }
3320}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003321
3322/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3323
3324/* There's a wrapper *function* for each distinct function typedef used
3325 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
3326 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3327 Most tables have only one entry; the tables for binary operators have two
3328 entries, one regular and one with reversed arguments. */
3329
3330static PyObject *
3331wrap_inquiry(PyObject *self, PyObject *args, void *wrapped)
3332{
3333 inquiry func = (inquiry)wrapped;
3334 int res;
3335
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003336 if (!PyArg_UnpackTuple(args, "", 0, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003337 return NULL;
3338 res = (*func)(self);
3339 if (res == -1 && PyErr_Occurred())
3340 return NULL;
3341 return PyInt_FromLong((long)res);
3342}
3343
Tim Peters6d6c1a32001-08-02 04:15:00 +00003344static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003345wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3346{
3347 inquiry func = (inquiry)wrapped;
3348 int res;
3349
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003350 if (!PyArg_UnpackTuple(args, "", 0, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003351 return NULL;
3352 res = (*func)(self);
3353 if (res == -1 && PyErr_Occurred())
3354 return NULL;
3355 return PyBool_FromLong((long)res);
3356}
3357
3358static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003359wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3360{
3361 binaryfunc func = (binaryfunc)wrapped;
3362 PyObject *other;
3363
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003364 if (!PyArg_UnpackTuple(args, "", 1, 1, &other))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003365 return NULL;
3366 return (*func)(self, other);
3367}
3368
3369static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003370wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3371{
3372 binaryfunc func = (binaryfunc)wrapped;
3373 PyObject *other;
3374
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003375 if (!PyArg_UnpackTuple(args, "", 1, 1, &other))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003376 return NULL;
3377 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003378 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003379 Py_INCREF(Py_NotImplemented);
3380 return Py_NotImplemented;
3381 }
3382 return (*func)(self, other);
3383}
3384
3385static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003386wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3387{
3388 binaryfunc func = (binaryfunc)wrapped;
3389 PyObject *other;
3390
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003391 if (!PyArg_UnpackTuple(args, "", 1, 1, &other))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003392 return NULL;
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003393 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003394 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003395 Py_INCREF(Py_NotImplemented);
3396 return Py_NotImplemented;
3397 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003398 return (*func)(other, self);
3399}
3400
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003401static PyObject *
3402wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3403{
3404 coercion func = (coercion)wrapped;
3405 PyObject *other, *res;
3406 int ok;
3407
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003408 if (!PyArg_UnpackTuple(args, "", 1, 1, &other))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003409 return NULL;
3410 ok = func(&self, &other);
3411 if (ok < 0)
3412 return NULL;
3413 if (ok > 0) {
3414 Py_INCREF(Py_NotImplemented);
3415 return Py_NotImplemented;
3416 }
3417 res = PyTuple_New(2);
3418 if (res == NULL) {
3419 Py_DECREF(self);
3420 Py_DECREF(other);
3421 return NULL;
3422 }
3423 PyTuple_SET_ITEM(res, 0, self);
3424 PyTuple_SET_ITEM(res, 1, other);
3425 return res;
3426}
3427
Tim Peters6d6c1a32001-08-02 04:15:00 +00003428static PyObject *
3429wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3430{
3431 ternaryfunc func = (ternaryfunc)wrapped;
3432 PyObject *other;
3433 PyObject *third = Py_None;
3434
3435 /* Note: This wrapper only works for __pow__() */
3436
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003437 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003438 return NULL;
3439 return (*func)(self, other, third);
3440}
3441
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003442static PyObject *
3443wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3444{
3445 ternaryfunc func = (ternaryfunc)wrapped;
3446 PyObject *other;
3447 PyObject *third = Py_None;
3448
3449 /* Note: This wrapper only works for __pow__() */
3450
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003451 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003452 return NULL;
3453 return (*func)(other, self, third);
3454}
3455
Tim Peters6d6c1a32001-08-02 04:15:00 +00003456static PyObject *
3457wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3458{
3459 unaryfunc func = (unaryfunc)wrapped;
3460
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003461 if (!PyArg_UnpackTuple(args, "", 0, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003462 return NULL;
3463 return (*func)(self);
3464}
3465
Tim Peters6d6c1a32001-08-02 04:15:00 +00003466static PyObject *
3467wrap_intargfunc(PyObject *self, PyObject *args, void *wrapped)
3468{
3469 intargfunc func = (intargfunc)wrapped;
3470 int i;
3471
3472 if (!PyArg_ParseTuple(args, "i", &i))
3473 return NULL;
3474 return (*func)(self, i);
3475}
3476
Guido van Rossum5d815f32001-08-17 21:57:47 +00003477static int
3478getindex(PyObject *self, PyObject *arg)
3479{
3480 int i;
3481
3482 i = PyInt_AsLong(arg);
3483 if (i == -1 && PyErr_Occurred())
3484 return -1;
3485 if (i < 0) {
3486 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3487 if (sq && sq->sq_length) {
3488 int n = (*sq->sq_length)(self);
3489 if (n < 0)
3490 return -1;
3491 i += n;
3492 }
3493 }
3494 return i;
3495}
3496
3497static PyObject *
3498wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3499{
3500 intargfunc func = (intargfunc)wrapped;
3501 PyObject *arg;
3502 int i;
3503
Guido van Rossumf4593e02001-10-03 12:09:30 +00003504 if (PyTuple_GET_SIZE(args) == 1) {
3505 arg = PyTuple_GET_ITEM(args, 0);
3506 i = getindex(self, arg);
3507 if (i == -1 && PyErr_Occurred())
3508 return NULL;
3509 return (*func)(self, i);
3510 }
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003511 PyArg_UnpackTuple(args, "", 1, 1, &arg);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003512 assert(PyErr_Occurred());
3513 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003514}
3515
Tim Peters6d6c1a32001-08-02 04:15:00 +00003516static PyObject *
3517wrap_intintargfunc(PyObject *self, PyObject *args, void *wrapped)
3518{
3519 intintargfunc func = (intintargfunc)wrapped;
3520 int i, j;
3521
3522 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3523 return NULL;
3524 return (*func)(self, i, j);
3525}
3526
Tim Peters6d6c1a32001-08-02 04:15:00 +00003527static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003528wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003529{
3530 intobjargproc func = (intobjargproc)wrapped;
3531 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003532 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003533
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003534 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003535 return NULL;
3536 i = getindex(self, arg);
3537 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003538 return NULL;
3539 res = (*func)(self, i, value);
3540 if (res == -1 && PyErr_Occurred())
3541 return NULL;
3542 Py_INCREF(Py_None);
3543 return Py_None;
3544}
3545
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003546static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003547wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003548{
3549 intobjargproc func = (intobjargproc)wrapped;
3550 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003551 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003552
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003553 if (!PyArg_UnpackTuple(args, "", 1, 1, &arg))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003554 return NULL;
3555 i = getindex(self, arg);
3556 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003557 return NULL;
3558 res = (*func)(self, i, NULL);
3559 if (res == -1 && PyErr_Occurred())
3560 return NULL;
3561 Py_INCREF(Py_None);
3562 return Py_None;
3563}
3564
Tim Peters6d6c1a32001-08-02 04:15:00 +00003565static PyObject *
3566wrap_intintobjargproc(PyObject *self, PyObject *args, void *wrapped)
3567{
3568 intintobjargproc func = (intintobjargproc)wrapped;
3569 int i, j, res;
3570 PyObject *value;
3571
3572 if (!PyArg_ParseTuple(args, "iiO", &i, &j, &value))
3573 return NULL;
3574 res = (*func)(self, i, j, value);
3575 if (res == -1 && PyErr_Occurred())
3576 return NULL;
3577 Py_INCREF(Py_None);
3578 return Py_None;
3579}
3580
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003581static PyObject *
3582wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3583{
3584 intintobjargproc func = (intintobjargproc)wrapped;
3585 int i, j, res;
3586
3587 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3588 return NULL;
3589 res = (*func)(self, i, j, NULL);
3590 if (res == -1 && PyErr_Occurred())
3591 return NULL;
3592 Py_INCREF(Py_None);
3593 return Py_None;
3594}
3595
Tim Peters6d6c1a32001-08-02 04:15:00 +00003596/* XXX objobjproc is a misnomer; should be objargpred */
3597static PyObject *
3598wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3599{
3600 objobjproc func = (objobjproc)wrapped;
3601 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003602 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003603
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003604 if (!PyArg_UnpackTuple(args, "", 1, 1, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003605 return NULL;
3606 res = (*func)(self, value);
3607 if (res == -1 && PyErr_Occurred())
3608 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003609 else
3610 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003611}
3612
Tim Peters6d6c1a32001-08-02 04:15:00 +00003613static PyObject *
3614wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3615{
3616 objobjargproc func = (objobjargproc)wrapped;
3617 int res;
3618 PyObject *key, *value;
3619
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003620 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003621 return NULL;
3622 res = (*func)(self, key, value);
3623 if (res == -1 && PyErr_Occurred())
3624 return NULL;
3625 Py_INCREF(Py_None);
3626 return Py_None;
3627}
3628
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003629static PyObject *
3630wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3631{
3632 objobjargproc func = (objobjargproc)wrapped;
3633 int res;
3634 PyObject *key;
3635
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003636 if (!PyArg_UnpackTuple(args, "", 1, 1, &key))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003637 return NULL;
3638 res = (*func)(self, key, NULL);
3639 if (res == -1 && PyErr_Occurred())
3640 return NULL;
3641 Py_INCREF(Py_None);
3642 return Py_None;
3643}
3644
Tim Peters6d6c1a32001-08-02 04:15:00 +00003645static PyObject *
3646wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3647{
3648 cmpfunc func = (cmpfunc)wrapped;
3649 int res;
3650 PyObject *other;
3651
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003652 if (!PyArg_UnpackTuple(args, "", 1, 1, &other))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003653 return NULL;
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003654 if (other->ob_type->tp_compare != func &&
3655 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003656 PyErr_Format(
3657 PyExc_TypeError,
3658 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3659 self->ob_type->tp_name,
3660 self->ob_type->tp_name,
3661 other->ob_type->tp_name);
3662 return NULL;
3663 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003664 res = (*func)(self, other);
3665 if (PyErr_Occurred())
3666 return NULL;
3667 return PyInt_FromLong((long)res);
3668}
3669
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003670/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003671 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003672static int
3673hackcheck(PyObject *self, setattrofunc func, char *what)
3674{
3675 PyTypeObject *type = self->ob_type;
3676 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3677 type = type->tp_base;
3678 if (type->tp_setattro != func) {
3679 PyErr_Format(PyExc_TypeError,
3680 "can't apply this %s to %s object",
3681 what,
3682 type->tp_name);
3683 return 0;
3684 }
3685 return 1;
3686}
3687
Tim Peters6d6c1a32001-08-02 04:15:00 +00003688static PyObject *
3689wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3690{
3691 setattrofunc func = (setattrofunc)wrapped;
3692 int res;
3693 PyObject *name, *value;
3694
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003695 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003696 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003697 if (!hackcheck(self, func, "__setattr__"))
3698 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003699 res = (*func)(self, name, value);
3700 if (res < 0)
3701 return NULL;
3702 Py_INCREF(Py_None);
3703 return Py_None;
3704}
3705
3706static PyObject *
3707wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3708{
3709 setattrofunc func = (setattrofunc)wrapped;
3710 int res;
3711 PyObject *name;
3712
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003713 if (!PyArg_UnpackTuple(args, "", 1, 1, &name))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003714 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003715 if (!hackcheck(self, func, "__delattr__"))
3716 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003717 res = (*func)(self, name, NULL);
3718 if (res < 0)
3719 return NULL;
3720 Py_INCREF(Py_None);
3721 return Py_None;
3722}
3723
Tim Peters6d6c1a32001-08-02 04:15:00 +00003724static PyObject *
3725wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3726{
3727 hashfunc func = (hashfunc)wrapped;
3728 long res;
3729
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003730 if (!PyArg_UnpackTuple(args, "", 0, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003731 return NULL;
3732 res = (*func)(self);
3733 if (res == -1 && PyErr_Occurred())
3734 return NULL;
3735 return PyInt_FromLong(res);
3736}
3737
Tim Peters6d6c1a32001-08-02 04:15:00 +00003738static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003739wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003740{
3741 ternaryfunc func = (ternaryfunc)wrapped;
3742
Guido van Rossumc8e56452001-10-22 00:43:43 +00003743 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003744}
3745
Tim Peters6d6c1a32001-08-02 04:15:00 +00003746static PyObject *
3747wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3748{
3749 richcmpfunc func = (richcmpfunc)wrapped;
3750 PyObject *other;
3751
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003752 if (!PyArg_UnpackTuple(args, "", 1, 1, &other))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003753 return NULL;
3754 return (*func)(self, other, op);
3755}
3756
3757#undef RICHCMP_WRAPPER
3758#define RICHCMP_WRAPPER(NAME, OP) \
3759static PyObject * \
3760richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3761{ \
3762 return wrap_richcmpfunc(self, args, wrapped, OP); \
3763}
3764
Jack Jansen8e938b42001-08-08 15:29:49 +00003765RICHCMP_WRAPPER(lt, Py_LT)
3766RICHCMP_WRAPPER(le, Py_LE)
3767RICHCMP_WRAPPER(eq, Py_EQ)
3768RICHCMP_WRAPPER(ne, Py_NE)
3769RICHCMP_WRAPPER(gt, Py_GT)
3770RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003771
Tim Peters6d6c1a32001-08-02 04:15:00 +00003772static PyObject *
3773wrap_next(PyObject *self, PyObject *args, void *wrapped)
3774{
3775 unaryfunc func = (unaryfunc)wrapped;
3776 PyObject *res;
3777
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003778 if (!PyArg_UnpackTuple(args, "", 0, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003779 return NULL;
3780 res = (*func)(self);
3781 if (res == NULL && !PyErr_Occurred())
3782 PyErr_SetNone(PyExc_StopIteration);
3783 return res;
3784}
3785
Tim Peters6d6c1a32001-08-02 04:15:00 +00003786static PyObject *
3787wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3788{
3789 descrgetfunc func = (descrgetfunc)wrapped;
3790 PyObject *obj;
3791 PyObject *type = NULL;
3792
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003793 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003794 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003795 if (obj == Py_None)
3796 obj = NULL;
3797 if (type == Py_None)
3798 type = NULL;
3799 if (type == NULL &&obj == NULL) {
3800 PyErr_SetString(PyExc_TypeError,
3801 "__get__(None, None) is invalid");
3802 return NULL;
3803 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003804 return (*func)(self, obj, type);
3805}
3806
Tim Peters6d6c1a32001-08-02 04:15:00 +00003807static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003808wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003809{
3810 descrsetfunc func = (descrsetfunc)wrapped;
3811 PyObject *obj, *value;
3812 int ret;
3813
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003814 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003815 return NULL;
3816 ret = (*func)(self, obj, value);
3817 if (ret < 0)
3818 return NULL;
3819 Py_INCREF(Py_None);
3820 return Py_None;
3821}
Guido van Rossum22b13872002-08-06 21:41:44 +00003822
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003823static PyObject *
3824wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3825{
3826 descrsetfunc func = (descrsetfunc)wrapped;
3827 PyObject *obj;
3828 int ret;
3829
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003830 if (!PyArg_UnpackTuple(args, "", 1, 1, &obj))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003831 return NULL;
3832 ret = (*func)(self, obj, NULL);
3833 if (ret < 0)
3834 return NULL;
3835 Py_INCREF(Py_None);
3836 return Py_None;
3837}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003838
Tim Peters6d6c1a32001-08-02 04:15:00 +00003839static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003840wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003841{
3842 initproc func = (initproc)wrapped;
3843
Guido van Rossumc8e56452001-10-22 00:43:43 +00003844 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003845 return NULL;
3846 Py_INCREF(Py_None);
3847 return Py_None;
3848}
3849
Tim Peters6d6c1a32001-08-02 04:15:00 +00003850static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003851tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003852{
Barry Warsaw60f01882001-08-22 19:24:42 +00003853 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003854 PyObject *arg0, *res;
3855
3856 if (self == NULL || !PyType_Check(self))
3857 Py_FatalError("__new__() called with non-type 'self'");
3858 type = (PyTypeObject *)self;
3859 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003860 PyErr_Format(PyExc_TypeError,
3861 "%s.__new__(): not enough arguments",
3862 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003863 return NULL;
3864 }
3865 arg0 = PyTuple_GET_ITEM(args, 0);
3866 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003867 PyErr_Format(PyExc_TypeError,
3868 "%s.__new__(X): X is not a type object (%s)",
3869 type->tp_name,
3870 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003871 return NULL;
3872 }
3873 subtype = (PyTypeObject *)arg0;
3874 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003875 PyErr_Format(PyExc_TypeError,
3876 "%s.__new__(%s): %s is not a subtype of %s",
3877 type->tp_name,
3878 subtype->tp_name,
3879 subtype->tp_name,
3880 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003881 return NULL;
3882 }
Barry Warsaw60f01882001-08-22 19:24:42 +00003883
3884 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00003885 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00003886 most derived base that's not a heap type is this type. */
3887 staticbase = subtype;
3888 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
3889 staticbase = staticbase->tp_base;
Guido van Rossuma8c60f42001-09-14 19:43:36 +00003890 if (staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003891 PyErr_Format(PyExc_TypeError,
3892 "%s.__new__(%s) is not safe, use %s.__new__()",
3893 type->tp_name,
3894 subtype->tp_name,
3895 staticbase == NULL ? "?" : staticbase->tp_name);
3896 return NULL;
3897 }
3898
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003899 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
3900 if (args == NULL)
3901 return NULL;
3902 res = type->tp_new(subtype, args, kwds);
3903 Py_DECREF(args);
3904 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003905}
3906
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003907static struct PyMethodDef tp_new_methoddef[] = {
3908 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003909 PyDoc_STR("T.__new__(S, ...) -> "
3910 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003911 {0}
3912};
3913
3914static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003915add_tp_new_wrapper(PyTypeObject *type)
3916{
Guido van Rossumf040ede2001-08-07 16:40:56 +00003917 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003918
Guido van Rossum687ae002001-10-15 22:03:32 +00003919 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00003920 return 0;
3921 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003922 if (func == NULL)
3923 return -1;
Guido van Rossum687ae002001-10-15 22:03:32 +00003924 return PyDict_SetItemString(type->tp_dict, "__new__", func);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003925}
3926
Guido van Rossumf040ede2001-08-07 16:40:56 +00003927/* Slot wrappers that call the corresponding __foo__ slot. See comments
3928 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003929
Guido van Rossumdc91b992001-08-08 22:26:22 +00003930#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003931static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003932FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003933{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00003934 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003935 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003936}
3937
Guido van Rossumdc91b992001-08-08 22:26:22 +00003938#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003939static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003940FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003941{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003942 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003943 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003944}
3945
Guido van Rossumcd118802003-01-06 22:57:47 +00003946/* Boolean helper for SLOT1BINFULL().
3947 right.__class__ is a nontrivial subclass of left.__class__. */
3948static int
3949method_is_overloaded(PyObject *left, PyObject *right, char *name)
3950{
3951 PyObject *a, *b;
3952 int ok;
3953
3954 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
3955 if (b == NULL) {
3956 PyErr_Clear();
3957 /* If right doesn't have it, it's not overloaded */
3958 return 0;
3959 }
3960
3961 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
3962 if (a == NULL) {
3963 PyErr_Clear();
3964 Py_DECREF(b);
3965 /* If right has it but left doesn't, it's overloaded */
3966 return 1;
3967 }
3968
3969 ok = PyObject_RichCompareBool(a, b, Py_NE);
3970 Py_DECREF(a);
3971 Py_DECREF(b);
3972 if (ok < 0) {
3973 PyErr_Clear();
3974 return 0;
3975 }
3976
3977 return ok;
3978}
3979
Guido van Rossumdc91b992001-08-08 22:26:22 +00003980
3981#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003982static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003983FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003984{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003985 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00003986 int do_other = self->ob_type != other->ob_type && \
3987 other->ob_type->tp_as_number != NULL && \
3988 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003989 if (self->ob_type->tp_as_number != NULL && \
3990 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
3991 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00003992 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00003993 PyType_IsSubtype(other->ob_type, self->ob_type) && \
3994 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00003995 r = call_maybe( \
3996 other, ROPSTR, &rcache_str, "(O)", self); \
3997 if (r != Py_NotImplemented) \
3998 return r; \
3999 Py_DECREF(r); \
4000 do_other = 0; \
4001 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004002 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004003 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004004 if (r != Py_NotImplemented || \
4005 other->ob_type == self->ob_type) \
4006 return r; \
4007 Py_DECREF(r); \
4008 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004009 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004010 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004011 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004012 } \
4013 Py_INCREF(Py_NotImplemented); \
4014 return Py_NotImplemented; \
4015}
4016
4017#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4018 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4019
4020#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4021static PyObject * \
4022FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4023{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004024 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004025 return call_method(self, OPSTR, &cache_str, \
4026 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004027}
4028
4029static int
4030slot_sq_length(PyObject *self)
4031{
Guido van Rossum2730b132001-08-28 18:22:14 +00004032 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004033 PyObject *res = call_method(self, "__len__", &len_str, "()");
Guido van Rossum26111622001-10-01 16:42:49 +00004034 int len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004035
4036 if (res == NULL)
4037 return -1;
Guido van Rossum26111622001-10-01 16:42:49 +00004038 len = (int)PyInt_AsLong(res);
4039 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00004040 if (len == -1 && PyErr_Occurred())
4041 return -1;
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004042 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00004043 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004044 "__len__() should return >= 0");
4045 return -1;
4046 }
Guido van Rossum26111622001-10-01 16:42:49 +00004047 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004048}
4049
Guido van Rossumdc91b992001-08-08 22:26:22 +00004050SLOT1(slot_sq_concat, "__add__", PyObject *, "O")
4051SLOT1(slot_sq_repeat, "__mul__", int, "i")
Guido van Rossumf4593e02001-10-03 12:09:30 +00004052
4053/* Super-optimized version of slot_sq_item.
4054 Other slots could do the same... */
4055static PyObject *
4056slot_sq_item(PyObject *self, int i)
4057{
4058 static PyObject *getitem_str;
4059 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4060 descrgetfunc f;
4061
4062 if (getitem_str == NULL) {
4063 getitem_str = PyString_InternFromString("__getitem__");
4064 if (getitem_str == NULL)
4065 return NULL;
4066 }
4067 func = _PyType_Lookup(self->ob_type, getitem_str);
4068 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004069 if ((f = func->ob_type->tp_descr_get) == NULL)
4070 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004071 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004072 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004073 if (func == NULL) {
4074 return NULL;
4075 }
4076 }
Guido van Rossumf4593e02001-10-03 12:09:30 +00004077 ival = PyInt_FromLong(i);
4078 if (ival != NULL) {
4079 args = PyTuple_New(1);
4080 if (args != NULL) {
4081 PyTuple_SET_ITEM(args, 0, ival);
4082 retval = PyObject_Call(func, args, NULL);
4083 Py_XDECREF(args);
4084 Py_XDECREF(func);
4085 return retval;
4086 }
4087 }
4088 }
4089 else {
4090 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4091 }
4092 Py_XDECREF(args);
4093 Py_XDECREF(ival);
4094 Py_XDECREF(func);
4095 return NULL;
4096}
4097
Guido van Rossumdc91b992001-08-08 22:26:22 +00004098SLOT2(slot_sq_slice, "__getslice__", int, int, "ii")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004099
4100static int
4101slot_sq_ass_item(PyObject *self, int index, PyObject *value)
4102{
4103 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004104 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004105
4106 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004107 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004108 "(i)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004109 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004110 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004111 "(iO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004112 if (res == NULL)
4113 return -1;
4114 Py_DECREF(res);
4115 return 0;
4116}
4117
4118static int
4119slot_sq_ass_slice(PyObject *self, int i, int j, PyObject *value)
4120{
4121 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004122 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004123
4124 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004125 res = call_method(self, "__delslice__", &delslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004126 "(ii)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004127 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004128 res = call_method(self, "__setslice__", &setslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004129 "(iiO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004130 if (res == NULL)
4131 return -1;
4132 Py_DECREF(res);
4133 return 0;
4134}
4135
4136static int
4137slot_sq_contains(PyObject *self, PyObject *value)
4138{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004139 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004140 int result = -1;
4141
Guido van Rossum60718732001-08-28 17:47:51 +00004142 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004143
Guido van Rossum55f20992001-10-01 17:18:22 +00004144 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004145 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004146 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004147 if (args == NULL)
4148 res = NULL;
4149 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004150 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004151 Py_DECREF(args);
4152 }
4153 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004154 if (res != NULL) {
4155 result = PyObject_IsTrue(res);
4156 Py_DECREF(res);
4157 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004158 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004159 else if (! PyErr_Occurred()) {
4160 result = _PySequence_IterSearch(self, value,
4161 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004162 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004163 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004164}
4165
Guido van Rossumdc91b992001-08-08 22:26:22 +00004166SLOT1(slot_sq_inplace_concat, "__iadd__", PyObject *, "O")
4167SLOT1(slot_sq_inplace_repeat, "__imul__", int, "i")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004168
4169#define slot_mp_length slot_sq_length
4170
Guido van Rossumdc91b992001-08-08 22:26:22 +00004171SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004172
4173static int
4174slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4175{
4176 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004177 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004178
4179 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004180 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004181 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004182 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004183 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004184 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004185 if (res == NULL)
4186 return -1;
4187 Py_DECREF(res);
4188 return 0;
4189}
4190
Guido van Rossumdc91b992001-08-08 22:26:22 +00004191SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4192SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4193SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4194SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4195SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4196SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4197
Jeremy Hylton938ace62002-07-17 16:30:39 +00004198static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004199
4200SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4201 nb_power, "__pow__", "__rpow__")
4202
4203static PyObject *
4204slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4205{
Guido van Rossum2730b132001-08-28 18:22:14 +00004206 static PyObject *pow_str;
4207
Guido van Rossumdc91b992001-08-08 22:26:22 +00004208 if (modulus == Py_None)
4209 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004210 /* Three-arg power doesn't use __rpow__. But ternary_op
4211 can call this when the second argument's type uses
4212 slot_nb_power, so check before calling self.__pow__. */
4213 if (self->ob_type->tp_as_number != NULL &&
4214 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4215 return call_method(self, "__pow__", &pow_str,
4216 "(OO)", other, modulus);
4217 }
4218 Py_INCREF(Py_NotImplemented);
4219 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004220}
4221
4222SLOT0(slot_nb_negative, "__neg__")
4223SLOT0(slot_nb_positive, "__pos__")
4224SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004225
4226static int
4227slot_nb_nonzero(PyObject *self)
4228{
Tim Petersea7f75d2002-12-07 21:39:16 +00004229 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004230 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004231 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004232
Guido van Rossum55f20992001-10-01 17:18:22 +00004233 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004234 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004235 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004236 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004237 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004238 if (func == NULL)
4239 return PyErr_Occurred() ? -1 : 1;
4240 }
4241 args = PyTuple_New(0);
4242 if (args != NULL) {
4243 PyObject *temp = PyObject_Call(func, args, NULL);
4244 Py_DECREF(args);
4245 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004246 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004247 result = PyObject_IsTrue(temp);
4248 else {
4249 PyErr_Format(PyExc_TypeError,
4250 "__nonzero__ should return "
4251 "bool or int, returned %s",
4252 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004253 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004254 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004255 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004256 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004257 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004258 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004259 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004260}
4261
Guido van Rossumdc91b992001-08-08 22:26:22 +00004262SLOT0(slot_nb_invert, "__invert__")
4263SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4264SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4265SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4266SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4267SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004268
4269static int
4270slot_nb_coerce(PyObject **a, PyObject **b)
4271{
4272 static PyObject *coerce_str;
4273 PyObject *self = *a, *other = *b;
4274
4275 if (self->ob_type->tp_as_number != NULL &&
4276 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4277 PyObject *r;
4278 r = call_maybe(
4279 self, "__coerce__", &coerce_str, "(O)", other);
4280 if (r == NULL)
4281 return -1;
4282 if (r == Py_NotImplemented) {
4283 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004284 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004285 else {
4286 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4287 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004288 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004289 Py_DECREF(r);
4290 return -1;
4291 }
4292 *a = PyTuple_GET_ITEM(r, 0);
4293 Py_INCREF(*a);
4294 *b = PyTuple_GET_ITEM(r, 1);
4295 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004296 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004297 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004298 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004299 }
4300 if (other->ob_type->tp_as_number != NULL &&
4301 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4302 PyObject *r;
4303 r = call_maybe(
4304 other, "__coerce__", &coerce_str, "(O)", self);
4305 if (r == NULL)
4306 return -1;
4307 if (r == Py_NotImplemented) {
4308 Py_DECREF(r);
4309 return 1;
4310 }
4311 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4312 PyErr_SetString(PyExc_TypeError,
4313 "__coerce__ didn't return a 2-tuple");
4314 Py_DECREF(r);
4315 return -1;
4316 }
4317 *a = PyTuple_GET_ITEM(r, 1);
4318 Py_INCREF(*a);
4319 *b = PyTuple_GET_ITEM(r, 0);
4320 Py_INCREF(*b);
4321 Py_DECREF(r);
4322 return 0;
4323 }
4324 return 1;
4325}
4326
Guido van Rossumdc91b992001-08-08 22:26:22 +00004327SLOT0(slot_nb_int, "__int__")
4328SLOT0(slot_nb_long, "__long__")
4329SLOT0(slot_nb_float, "__float__")
4330SLOT0(slot_nb_oct, "__oct__")
4331SLOT0(slot_nb_hex, "__hex__")
4332SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4333SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4334SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4335SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4336SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004337SLOT1(slot_nb_inplace_power, "__ipow__", PyObject *, "O")
Guido van Rossumdc91b992001-08-08 22:26:22 +00004338SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4339SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4340SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4341SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4342SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4343SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4344 "__floordiv__", "__rfloordiv__")
4345SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4346SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4347SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004348
4349static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004350half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004351{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004352 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004353 static PyObject *cmp_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004354 int c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004355
Guido van Rossum60718732001-08-28 17:47:51 +00004356 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004357 if (func == NULL) {
4358 PyErr_Clear();
4359 }
4360 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004361 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004362 if (args == NULL)
4363 res = NULL;
4364 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004365 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004366 Py_DECREF(args);
4367 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004368 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004369 if (res != Py_NotImplemented) {
4370 if (res == NULL)
4371 return -2;
4372 c = PyInt_AsLong(res);
4373 Py_DECREF(res);
4374 if (c == -1 && PyErr_Occurred())
4375 return -2;
4376 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4377 }
4378 Py_DECREF(res);
4379 }
4380 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004381}
4382
Guido van Rossumab3b0342001-09-18 20:38:53 +00004383/* This slot is published for the benefit of try_3way_compare in object.c */
4384int
4385_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004386{
4387 int c;
4388
Guido van Rossumab3b0342001-09-18 20:38:53 +00004389 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004390 c = half_compare(self, other);
4391 if (c <= 1)
4392 return c;
4393 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004394 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004395 c = half_compare(other, self);
4396 if (c < -1)
4397 return -2;
4398 if (c <= 1)
4399 return -c;
4400 }
4401 return (void *)self < (void *)other ? -1 :
4402 (void *)self > (void *)other ? 1 : 0;
4403}
4404
4405static PyObject *
4406slot_tp_repr(PyObject *self)
4407{
4408 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004409 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004410
Guido van Rossum60718732001-08-28 17:47:51 +00004411 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004412 if (func != NULL) {
4413 res = PyEval_CallObject(func, NULL);
4414 Py_DECREF(func);
4415 return res;
4416 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004417 PyErr_Clear();
4418 return PyString_FromFormat("<%s object at %p>",
4419 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004420}
4421
4422static PyObject *
4423slot_tp_str(PyObject *self)
4424{
4425 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004426 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004427
Guido van Rossum60718732001-08-28 17:47:51 +00004428 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004429 if (func != NULL) {
4430 res = PyEval_CallObject(func, NULL);
4431 Py_DECREF(func);
4432 return res;
4433 }
4434 else {
4435 PyErr_Clear();
4436 return slot_tp_repr(self);
4437 }
4438}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004439
4440static long
4441slot_tp_hash(PyObject *self)
4442{
Tim Peters61ce0a92002-12-06 23:38:02 +00004443 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004444 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004445 long h;
4446
Guido van Rossum60718732001-08-28 17:47:51 +00004447 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004448
4449 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004450 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004451 Py_DECREF(func);
4452 if (res == NULL)
4453 return -1;
4454 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004455 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004456 }
4457 else {
4458 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004459 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004460 if (func == NULL) {
4461 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004462 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004463 }
4464 if (func != NULL) {
4465 Py_DECREF(func);
4466 PyErr_SetString(PyExc_TypeError, "unhashable type");
4467 return -1;
4468 }
4469 PyErr_Clear();
4470 h = _Py_HashPointer((void *)self);
4471 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004472 if (h == -1 && !PyErr_Occurred())
4473 h = -2;
4474 return h;
4475}
4476
4477static PyObject *
4478slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4479{
Guido van Rossum60718732001-08-28 17:47:51 +00004480 static PyObject *call_str;
4481 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004482 PyObject *res;
4483
4484 if (meth == NULL)
4485 return NULL;
4486 res = PyObject_Call(meth, args, kwds);
4487 Py_DECREF(meth);
4488 return res;
4489}
4490
Guido van Rossum14a6f832001-10-17 13:59:09 +00004491/* There are two slot dispatch functions for tp_getattro.
4492
4493 - slot_tp_getattro() is used when __getattribute__ is overridden
4494 but no __getattr__ hook is present;
4495
4496 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4497
Guido van Rossumc334df52002-04-04 23:44:47 +00004498 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4499 detects the absence of __getattr__ and then installs the simpler slot if
4500 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004501
Tim Peters6d6c1a32001-08-02 04:15:00 +00004502static PyObject *
4503slot_tp_getattro(PyObject *self, PyObject *name)
4504{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004505 static PyObject *getattribute_str = NULL;
4506 return call_method(self, "__getattribute__", &getattribute_str,
4507 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004508}
4509
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004510static PyObject *
4511slot_tp_getattr_hook(PyObject *self, PyObject *name)
4512{
4513 PyTypeObject *tp = self->ob_type;
4514 PyObject *getattr, *getattribute, *res;
4515 static PyObject *getattribute_str = NULL;
4516 static PyObject *getattr_str = NULL;
4517
4518 if (getattr_str == NULL) {
4519 getattr_str = PyString_InternFromString("__getattr__");
4520 if (getattr_str == NULL)
4521 return NULL;
4522 }
4523 if (getattribute_str == NULL) {
4524 getattribute_str =
4525 PyString_InternFromString("__getattribute__");
4526 if (getattribute_str == NULL)
4527 return NULL;
4528 }
4529 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004530 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004531 /* No __getattr__ hook: use a simpler dispatcher */
4532 tp->tp_getattro = slot_tp_getattro;
4533 return slot_tp_getattro(self, name);
4534 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004535 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004536 if (getattribute == NULL ||
4537 (getattribute->ob_type == &PyWrapperDescr_Type &&
4538 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4539 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004540 res = PyObject_GenericGetAttr(self, name);
4541 else
4542 res = PyObject_CallFunction(getattribute, "OO", self, name);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004543 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004544 PyErr_Clear();
4545 res = PyObject_CallFunction(getattr, "OO", self, name);
4546 }
4547 return res;
4548}
4549
Tim Peters6d6c1a32001-08-02 04:15:00 +00004550static int
4551slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4552{
4553 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004554 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004555
4556 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004557 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004558 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004559 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004560 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004561 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004562 if (res == NULL)
4563 return -1;
4564 Py_DECREF(res);
4565 return 0;
4566}
4567
4568/* Map rich comparison operators to their __xx__ namesakes */
4569static char *name_op[] = {
4570 "__lt__",
4571 "__le__",
4572 "__eq__",
4573 "__ne__",
4574 "__gt__",
4575 "__ge__",
4576};
4577
4578static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004579half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004580{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004581 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004582 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004583
Guido van Rossum60718732001-08-28 17:47:51 +00004584 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004585 if (func == NULL) {
4586 PyErr_Clear();
4587 Py_INCREF(Py_NotImplemented);
4588 return Py_NotImplemented;
4589 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004590 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004591 if (args == NULL)
4592 res = NULL;
4593 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004594 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004595 Py_DECREF(args);
4596 }
4597 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004598 return res;
4599}
4600
Guido van Rossumb8f63662001-08-15 23:57:02 +00004601/* Map rich comparison operators to their swapped version, e.g. LT --> GT */
4602static int swapped_op[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
4603
4604static PyObject *
4605slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4606{
4607 PyObject *res;
4608
4609 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4610 res = half_richcompare(self, other, op);
4611 if (res != Py_NotImplemented)
4612 return res;
4613 Py_DECREF(res);
4614 }
4615 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
4616 res = half_richcompare(other, self, swapped_op[op]);
4617 if (res != Py_NotImplemented) {
4618 return res;
4619 }
4620 Py_DECREF(res);
4621 }
4622 Py_INCREF(Py_NotImplemented);
4623 return Py_NotImplemented;
4624}
4625
4626static PyObject *
4627slot_tp_iter(PyObject *self)
4628{
4629 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004630 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004631
Guido van Rossum60718732001-08-28 17:47:51 +00004632 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004633 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004634 PyObject *args;
4635 args = res = PyTuple_New(0);
4636 if (args != NULL) {
4637 res = PyObject_Call(func, args, NULL);
4638 Py_DECREF(args);
4639 }
4640 Py_DECREF(func);
4641 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004642 }
4643 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004644 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004645 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004646 PyErr_SetString(PyExc_TypeError,
4647 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00004648 return NULL;
4649 }
4650 Py_DECREF(func);
4651 return PySeqIter_New(self);
4652}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004653
4654static PyObject *
4655slot_tp_iternext(PyObject *self)
4656{
Guido van Rossum2730b132001-08-28 18:22:14 +00004657 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004658 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004659}
4660
Guido van Rossum1a493502001-08-17 16:47:50 +00004661static PyObject *
4662slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4663{
4664 PyTypeObject *tp = self->ob_type;
4665 PyObject *get;
4666 static PyObject *get_str = NULL;
4667
4668 if (get_str == NULL) {
4669 get_str = PyString_InternFromString("__get__");
4670 if (get_str == NULL)
4671 return NULL;
4672 }
4673 get = _PyType_Lookup(tp, get_str);
4674 if (get == NULL) {
4675 /* Avoid further slowdowns */
4676 if (tp->tp_descr_get == slot_tp_descr_get)
4677 tp->tp_descr_get = NULL;
4678 Py_INCREF(self);
4679 return self;
4680 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004681 if (obj == NULL)
4682 obj = Py_None;
4683 if (type == NULL)
4684 type = Py_None;
Guido van Rossum1a493502001-08-17 16:47:50 +00004685 return PyObject_CallFunction(get, "OOO", self, obj, type);
4686}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004687
4688static int
4689slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4690{
Guido van Rossum2c252392001-08-24 10:13:31 +00004691 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004692 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004693
4694 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004695 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004696 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004697 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004698 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004699 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004700 if (res == NULL)
4701 return -1;
4702 Py_DECREF(res);
4703 return 0;
4704}
4705
4706static int
4707slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4708{
Guido van Rossum60718732001-08-28 17:47:51 +00004709 static PyObject *init_str;
4710 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004711 PyObject *res;
4712
4713 if (meth == NULL)
4714 return -1;
4715 res = PyObject_Call(meth, args, kwds);
4716 Py_DECREF(meth);
4717 if (res == NULL)
4718 return -1;
4719 Py_DECREF(res);
4720 return 0;
4721}
4722
4723static PyObject *
4724slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4725{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004726 static PyObject *new_str;
4727 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004728 PyObject *newargs, *x;
4729 int i, n;
4730
Guido van Rossum7bed2132002-08-08 21:57:53 +00004731 if (new_str == NULL) {
4732 new_str = PyString_InternFromString("__new__");
4733 if (new_str == NULL)
4734 return NULL;
4735 }
4736 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004737 if (func == NULL)
4738 return NULL;
4739 assert(PyTuple_Check(args));
4740 n = PyTuple_GET_SIZE(args);
4741 newargs = PyTuple_New(n+1);
4742 if (newargs == NULL)
4743 return NULL;
4744 Py_INCREF(type);
4745 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4746 for (i = 0; i < n; i++) {
4747 x = PyTuple_GET_ITEM(args, i);
4748 Py_INCREF(x);
4749 PyTuple_SET_ITEM(newargs, i+1, x);
4750 }
4751 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004752 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004753 Py_DECREF(func);
4754 return x;
4755}
4756
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004757static void
4758slot_tp_del(PyObject *self)
4759{
4760 static PyObject *del_str = NULL;
4761 PyObject *del, *res;
4762 PyObject *error_type, *error_value, *error_traceback;
4763
4764 /* Temporarily resurrect the object. */
4765 assert(self->ob_refcnt == 0);
4766 self->ob_refcnt = 1;
4767
4768 /* Save the current exception, if any. */
4769 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4770
4771 /* Execute __del__ method, if any. */
4772 del = lookup_maybe(self, "__del__", &del_str);
4773 if (del != NULL) {
4774 res = PyEval_CallObject(del, NULL);
4775 if (res == NULL)
4776 PyErr_WriteUnraisable(del);
4777 else
4778 Py_DECREF(res);
4779 Py_DECREF(del);
4780 }
4781
4782 /* Restore the saved exception. */
4783 PyErr_Restore(error_type, error_value, error_traceback);
4784
4785 /* Undo the temporary resurrection; can't use DECREF here, it would
4786 * cause a recursive call.
4787 */
4788 assert(self->ob_refcnt > 0);
4789 if (--self->ob_refcnt == 0)
4790 return; /* this is the normal path out */
4791
4792 /* __del__ resurrected it! Make it look like the original Py_DECREF
4793 * never happened.
4794 */
4795 {
4796 int refcnt = self->ob_refcnt;
4797 _Py_NewReference(self);
4798 self->ob_refcnt = refcnt;
4799 }
4800 assert(!PyType_IS_GC(self->ob_type) ||
4801 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
4802 /* If Py_REF_DEBUG, the original decref dropped _Py_RefTotal, but
4803 * _Py_NewReference bumped it again, so that's a wash.
4804 * If Py_TRACE_REFS, _Py_NewReference re-added self to the object
4805 * chain, so no more to do there either.
4806 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
4807 * _Py_NewReference bumped tp_allocs: both of those need to be
4808 * undone.
4809 */
4810#ifdef COUNT_ALLOCS
4811 --self->ob_type->tp_frees;
4812 --self->ob_type->tp_allocs;
4813#endif
4814}
4815
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004816
4817/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00004818 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00004819 structure, which incorporates the additional structures used for numbers,
4820 sequences and mappings.
4821 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004822 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00004823 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
4824 terminated with an all-zero entry. (This table is further initialized and
4825 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004826
Guido van Rossum6d204072001-10-21 00:44:31 +00004827typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004828
4829#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00004830#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004831#undef ETSLOT
4832#undef SQSLOT
4833#undef MPSLOT
4834#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00004835#undef UNSLOT
4836#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004837#undef BINSLOT
4838#undef RBINSLOT
4839
Guido van Rossum6d204072001-10-21 00:44:31 +00004840#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004841 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
4842 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00004843#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
4844 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004845 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00004846#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00004847 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004848 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00004849#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4850 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
4851#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4852 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
4853#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4854 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
4855#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4856 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4857 "x." NAME "() <==> " DOC)
4858#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4859 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4860 "x." NAME "(y) <==> x" DOC "y")
4861#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
4862 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4863 "x." NAME "(y) <==> x" DOC "y")
4864#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
4865 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4866 "x." NAME "(y) <==> y" DOC "x")
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004867
4868static slotdef slotdefs[] = {
Guido van Rossum6d204072001-10-21 00:44:31 +00004869 SQSLOT("__len__", sq_length, slot_sq_length, wrap_inquiry,
4870 "x.__len__() <==> len(x)"),
4871 SQSLOT("__add__", sq_concat, slot_sq_concat, wrap_binaryfunc,
4872 "x.__add__(y) <==> x+y"),
4873 SQSLOT("__mul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4874 "x.__mul__(n) <==> x*n"),
4875 SQSLOT("__rmul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4876 "x.__rmul__(n) <==> n*x"),
4877 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
4878 "x.__getitem__(y) <==> x[y]"),
4879 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_intintargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00004880 "x.__getslice__(i, j) <==> x[i:j]\n\
4881 \n\
4882 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004883 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004884 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004885 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004886 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004887 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Guido van Rossum6d204072001-10-21 00:44:31 +00004888 wrap_intintobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00004889 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
4890 \n\
4891 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004892 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00004893 "x.__delslice__(i, j) <==> del x[i:j]\n\
4894 \n\
4895 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004896 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
4897 "x.__contains__(y) <==> y in x"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004898 SQSLOT("__iadd__", sq_inplace_concat, slot_sq_inplace_concat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004899 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004900 SQSLOT("__imul__", sq_inplace_repeat, slot_sq_inplace_repeat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004901 wrap_intargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004902
Guido van Rossum6d204072001-10-21 00:44:31 +00004903 MPSLOT("__len__", mp_length, slot_mp_length, wrap_inquiry,
4904 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00004905 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004906 wrap_binaryfunc,
4907 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004908 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004909 wrap_objobjargproc,
4910 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004911 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004912 wrap_delitem,
4913 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004914
Guido van Rossum6d204072001-10-21 00:44:31 +00004915 BINSLOT("__add__", nb_add, slot_nb_add,
4916 "+"),
4917 RBINSLOT("__radd__", nb_add, slot_nb_add,
4918 "+"),
4919 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
4920 "-"),
4921 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
4922 "-"),
4923 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
4924 "*"),
4925 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
4926 "*"),
4927 BINSLOT("__div__", nb_divide, slot_nb_divide,
4928 "/"),
4929 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
4930 "/"),
4931 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
4932 "%"),
4933 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
4934 "%"),
4935 BINSLOT("__divmod__", nb_divmod, slot_nb_divmod,
4936 "divmod(x, y)"),
4937 RBINSLOT("__rdivmod__", nb_divmod, slot_nb_divmod,
4938 "divmod(y, x)"),
4939 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
4940 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
4941 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
4942 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
4943 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
4944 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
4945 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
4946 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00004947 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00004948 "x != 0"),
4949 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
4950 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
4951 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
4952 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
4953 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
4954 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
4955 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
4956 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
4957 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
4958 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
4959 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
4960 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
4961 "x.__coerce__(y) <==> coerce(x, y)"),
4962 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
4963 "int(x)"),
4964 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
4965 "long(x)"),
4966 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
4967 "float(x)"),
4968 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
4969 "oct(x)"),
4970 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
4971 "hex(x)"),
4972 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
4973 wrap_binaryfunc, "+"),
4974 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
4975 wrap_binaryfunc, "-"),
4976 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
4977 wrap_binaryfunc, "*"),
4978 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
4979 wrap_binaryfunc, "/"),
4980 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
4981 wrap_binaryfunc, "%"),
4982 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004983 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004984 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
4985 wrap_binaryfunc, "<<"),
4986 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
4987 wrap_binaryfunc, ">>"),
4988 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
4989 wrap_binaryfunc, "&"),
4990 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
4991 wrap_binaryfunc, "^"),
4992 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
4993 wrap_binaryfunc, "|"),
4994 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
4995 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
4996 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
4997 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
4998 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
4999 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5000 IBSLOT("__itruediv__", nb_inplace_true_divide,
5001 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005002
Guido van Rossum6d204072001-10-21 00:44:31 +00005003 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5004 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005005 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005006 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5007 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005008 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005009 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5010 "x.__cmp__(y) <==> cmp(x,y)"),
5011 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5012 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005013 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5014 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005015 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005016 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5017 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5018 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5019 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5020 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5021 "x.__setattr__('name', value) <==> x.name = value"),
5022 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5023 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5024 "x.__delattr__('name') <==> del x.name"),
5025 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5026 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5027 "x.__lt__(y) <==> x<y"),
5028 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5029 "x.__le__(y) <==> x<=y"),
5030 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5031 "x.__eq__(y) <==> x==y"),
5032 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5033 "x.__ne__(y) <==> x!=y"),
5034 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5035 "x.__gt__(y) <==> x>y"),
5036 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5037 "x.__ge__(y) <==> x>=y"),
5038 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5039 "x.__iter__() <==> iter(x)"),
5040 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5041 "x.next() -> the next value, or raise StopIteration"),
5042 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5043 "descr.__get__(obj[, type]) -> value"),
5044 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5045 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005046 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5047 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005048 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005049 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005050 "see x.__class__.__doc__ for signature",
5051 PyWrapperFlag_KEYWORDS),
5052 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005053 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005054 {NULL}
5055};
5056
Guido van Rossumc334df52002-04-04 23:44:47 +00005057/* Given a type pointer and an offset gotten from a slotdef entry, return a
5058 pointer to the actual slot. This is not quite the same as simply adding
5059 the offset to the type pointer, since it takes care to indirect through the
5060 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5061 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005062static void **
5063slotptr(PyTypeObject *type, int offset)
5064{
5065 char *ptr;
5066
Guido van Rossume5c691a2003-03-07 15:13:17 +00005067 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005068 assert(offset >= 0);
Guido van Rossume5c691a2003-03-07 15:13:17 +00005069 assert(offset < offsetof(PyHeapTypeObject, as_buffer));
5070 if (offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005071 ptr = (void *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005072 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005073 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005074 else if (offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Guido van Rossum09638c12002-06-13 19:17:46 +00005075 ptr = (void *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005076 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005077 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005078 else if (offset >= offsetof(PyHeapTypeObject, as_number)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005079 ptr = (void *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005080 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005081 }
5082 else {
5083 ptr = (void *)type;
5084 }
5085 if (ptr != NULL)
5086 ptr += offset;
5087 return (void **)ptr;
5088}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005089
Guido van Rossumc334df52002-04-04 23:44:47 +00005090/* Length of array of slotdef pointers used to store slots with the
5091 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5092 the same __name__, for any __name__. Since that's a static property, it is
5093 appropriate to declare fixed-size arrays for this. */
5094#define MAX_EQUIV 10
5095
5096/* Return a slot pointer for a given name, but ONLY if the attribute has
5097 exactly one slot function. The name must be an interned string. */
5098static void **
5099resolve_slotdups(PyTypeObject *type, PyObject *name)
5100{
5101 /* XXX Maybe this could be optimized more -- but is it worth it? */
5102
5103 /* pname and ptrs act as a little cache */
5104 static PyObject *pname;
5105 static slotdef *ptrs[MAX_EQUIV];
5106 slotdef *p, **pp;
5107 void **res, **ptr;
5108
5109 if (pname != name) {
5110 /* Collect all slotdefs that match name into ptrs. */
5111 pname = name;
5112 pp = ptrs;
5113 for (p = slotdefs; p->name_strobj; p++) {
5114 if (p->name_strobj == name)
5115 *pp++ = p;
5116 }
5117 *pp = NULL;
5118 }
5119
5120 /* Look in all matching slots of the type; if exactly one of these has
5121 a filled-in slot, return its value. Otherwise return NULL. */
5122 res = NULL;
5123 for (pp = ptrs; *pp; pp++) {
5124 ptr = slotptr(type, (*pp)->offset);
5125 if (ptr == NULL || *ptr == NULL)
5126 continue;
5127 if (res != NULL)
5128 return NULL;
5129 res = ptr;
5130 }
5131 return res;
5132}
5133
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005134/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005135 does some incredibly complex thinking and then sticks something into the
5136 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5137 interests, and then stores a generic wrapper or a specific function into
5138 the slot.) Return a pointer to the next slotdef with a different offset,
5139 because that's convenient for fixup_slot_dispatchers(). */
5140static slotdef *
5141update_one_slot(PyTypeObject *type, slotdef *p)
5142{
5143 PyObject *descr;
5144 PyWrapperDescrObject *d;
5145 void *generic = NULL, *specific = NULL;
5146 int use_generic = 0;
5147 int offset = p->offset;
5148 void **ptr = slotptr(type, offset);
5149
5150 if (ptr == NULL) {
5151 do {
5152 ++p;
5153 } while (p->offset == offset);
5154 return p;
5155 }
5156 do {
5157 descr = _PyType_Lookup(type, p->name_strobj);
5158 if (descr == NULL)
5159 continue;
5160 if (descr->ob_type == &PyWrapperDescr_Type) {
5161 void **tptr = resolve_slotdups(type, p->name_strobj);
5162 if (tptr == NULL || tptr == ptr)
5163 generic = p->function;
5164 d = (PyWrapperDescrObject *)descr;
5165 if (d->d_base->wrapper == p->wrapper &&
5166 PyType_IsSubtype(type, d->d_type))
5167 {
5168 if (specific == NULL ||
5169 specific == d->d_wrapped)
5170 specific = d->d_wrapped;
5171 else
5172 use_generic = 1;
5173 }
5174 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005175 else if (descr->ob_type == &PyCFunction_Type &&
5176 PyCFunction_GET_FUNCTION(descr) ==
5177 (PyCFunction)tp_new_wrapper &&
5178 strcmp(p->name, "__new__") == 0)
5179 {
5180 /* The __new__ wrapper is not a wrapper descriptor,
5181 so must be special-cased differently.
5182 If we don't do this, creating an instance will
5183 always use slot_tp_new which will look up
5184 __new__ in the MRO which will call tp_new_wrapper
5185 which will look through the base classes looking
5186 for a static base and call its tp_new (usually
5187 PyType_GenericNew), after performing various
5188 sanity checks and constructing a new argument
5189 list. Cut all that nonsense short -- this speeds
5190 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005191 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005192 /* XXX I'm not 100% sure that there isn't a hole
5193 in this reasoning that requires additional
5194 sanity checks. I'll buy the first person to
5195 point out a bug in this reasoning a beer. */
5196 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005197 else {
5198 use_generic = 1;
5199 generic = p->function;
5200 }
5201 } while ((++p)->offset == offset);
5202 if (specific && !use_generic)
5203 *ptr = specific;
5204 else
5205 *ptr = generic;
5206 return p;
5207}
5208
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005209/* In the type, update the slots whose slotdefs are gathered in the pp array.
5210 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005211static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005212update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005213{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005214 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005215
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005216 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005217 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005218 return 0;
5219}
5220
Guido van Rossumc334df52002-04-04 23:44:47 +00005221/* Comparison function for qsort() to compare slotdefs by their offset, and
5222 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005223static int
5224slotdef_cmp(const void *aa, const void *bb)
5225{
5226 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5227 int c = a->offset - b->offset;
5228 if (c != 0)
5229 return c;
5230 else
5231 return a - b;
5232}
5233
Guido van Rossumc334df52002-04-04 23:44:47 +00005234/* Initialize the slotdefs table by adding interned string objects for the
5235 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005236static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005237init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005238{
5239 slotdef *p;
5240 static int initialized = 0;
5241
5242 if (initialized)
5243 return;
5244 for (p = slotdefs; p->name; p++) {
5245 p->name_strobj = PyString_InternFromString(p->name);
5246 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005247 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005248 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005249 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5250 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005251 initialized = 1;
5252}
5253
Guido van Rossumc334df52002-04-04 23:44:47 +00005254/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005255static int
5256update_slot(PyTypeObject *type, PyObject *name)
5257{
Guido van Rossumc334df52002-04-04 23:44:47 +00005258 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005259 slotdef *p;
5260 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005261 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005262
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005263 init_slotdefs();
5264 pp = ptrs;
5265 for (p = slotdefs; p->name; p++) {
5266 /* XXX assume name is interned! */
5267 if (p->name_strobj == name)
5268 *pp++ = p;
5269 }
5270 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005271 for (pp = ptrs; *pp; pp++) {
5272 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005273 offset = p->offset;
5274 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005275 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005276 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005277 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005278 if (ptrs[0] == NULL)
5279 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005280 return update_subclasses(type, name,
5281 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005282}
5283
Guido van Rossumc334df52002-04-04 23:44:47 +00005284/* Store the proper functions in the slot dispatches at class (type)
5285 definition time, based upon which operations the class overrides in its
5286 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005287static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005288fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005289{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005290 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005291
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005292 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005293 for (p = slotdefs; p->name; )
5294 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005295}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005296
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005297static void
5298update_all_slots(PyTypeObject* type)
5299{
5300 slotdef *p;
5301
5302 init_slotdefs();
5303 for (p = slotdefs; p->name; p++) {
5304 /* update_slot returns int but can't actually fail */
5305 update_slot(type, p->name_strobj);
5306 }
5307}
5308
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005309/* recurse_down_subclasses() and update_subclasses() are mutually
5310 recursive functions to call a callback for all subclasses,
5311 but refraining from recursing into subclasses that define 'name'. */
5312
5313static int
5314update_subclasses(PyTypeObject *type, PyObject *name,
5315 update_callback callback, void *data)
5316{
5317 if (callback(type, data) < 0)
5318 return -1;
5319 return recurse_down_subclasses(type, name, callback, data);
5320}
5321
5322static int
5323recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5324 update_callback callback, void *data)
5325{
5326 PyTypeObject *subclass;
5327 PyObject *ref, *subclasses, *dict;
5328 int i, n;
5329
5330 subclasses = type->tp_subclasses;
5331 if (subclasses == NULL)
5332 return 0;
5333 assert(PyList_Check(subclasses));
5334 n = PyList_GET_SIZE(subclasses);
5335 for (i = 0; i < n; i++) {
5336 ref = PyList_GET_ITEM(subclasses, i);
5337 assert(PyWeakref_CheckRef(ref));
5338 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5339 assert(subclass != NULL);
5340 if ((PyObject *)subclass == Py_None)
5341 continue;
5342 assert(PyType_Check(subclass));
5343 /* Avoid recursing down into unaffected classes */
5344 dict = subclass->tp_dict;
5345 if (dict != NULL && PyDict_Check(dict) &&
5346 PyDict_GetItem(dict, name) != NULL)
5347 continue;
5348 if (update_subclasses(subclass, name, callback, data) < 0)
5349 return -1;
5350 }
5351 return 0;
5352}
5353
Guido van Rossum6d204072001-10-21 00:44:31 +00005354/* This function is called by PyType_Ready() to populate the type's
5355 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005356 function slot (like tp_repr) that's defined in the type, one or more
5357 corresponding descriptors are added in the type's tp_dict dictionary
5358 under the appropriate name (like __repr__). Some function slots
5359 cause more than one descriptor to be added (for example, the nb_add
5360 slot adds both __add__ and __radd__ descriptors) and some function
5361 slots compete for the same descriptor (for example both sq_item and
5362 mp_subscript generate a __getitem__ descriptor).
5363
5364 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005365 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005366 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005367 between competing slots: the members of PyHeapTypeObject are listed
5368 from most general to least general, so the most general slot is
5369 preferred. In particular, because as_mapping comes before as_sequence,
5370 for a type that defines both mp_subscript and sq_item, mp_subscript
5371 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005372
5373 This only adds new descriptors and doesn't overwrite entries in
5374 tp_dict that were previously defined. The descriptors contain a
5375 reference to the C function they must call, so that it's safe if they
5376 are copied into a subtype's __dict__ and the subtype has a different
5377 C function in its slot -- calling the method defined by the
5378 descriptor will call the C function that was used to create it,
5379 rather than the C function present in the slot when it is called.
5380 (This is important because a subtype may have a C function in the
5381 slot that calls the method from the dictionary, and we want to avoid
5382 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005383
5384static int
5385add_operators(PyTypeObject *type)
5386{
5387 PyObject *dict = type->tp_dict;
5388 slotdef *p;
5389 PyObject *descr;
5390 void **ptr;
5391
5392 init_slotdefs();
5393 for (p = slotdefs; p->name; p++) {
5394 if (p->wrapper == NULL)
5395 continue;
5396 ptr = slotptr(type, p->offset);
5397 if (!ptr || !*ptr)
5398 continue;
5399 if (PyDict_GetItem(dict, p->name_strobj))
5400 continue;
5401 descr = PyDescr_NewWrapper(type, p, *ptr);
5402 if (descr == NULL)
5403 return -1;
5404 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5405 return -1;
5406 Py_DECREF(descr);
5407 }
5408 if (type->tp_new != NULL) {
5409 if (add_tp_new_wrapper(type) < 0)
5410 return -1;
5411 }
5412 return 0;
5413}
5414
Guido van Rossum705f0f52001-08-24 16:47:00 +00005415
5416/* Cooperative 'super' */
5417
5418typedef struct {
5419 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005420 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005421 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005422 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005423} superobject;
5424
Guido van Rossum6f799372001-09-20 20:46:19 +00005425static PyMemberDef super_members[] = {
5426 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5427 "the class invoking super()"},
5428 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5429 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005430 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005431 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005432 {0}
5433};
5434
Guido van Rossum705f0f52001-08-24 16:47:00 +00005435static void
5436super_dealloc(PyObject *self)
5437{
5438 superobject *su = (superobject *)self;
5439
Guido van Rossum048eb752001-10-02 21:24:57 +00005440 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005441 Py_XDECREF(su->obj);
5442 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005443 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005444 self->ob_type->tp_free(self);
5445}
5446
5447static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005448super_repr(PyObject *self)
5449{
5450 superobject *su = (superobject *)self;
5451
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005452 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005453 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005454 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005455 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005456 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005457 else
5458 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005459 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005460 su->type ? su->type->tp_name : "NULL");
5461}
5462
5463static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005464super_getattro(PyObject *self, PyObject *name)
5465{
5466 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005467 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005468
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005469 if (!skip) {
5470 /* We want __class__ to return the class of the super object
5471 (i.e. super, or a subclass), not the class of su->obj. */
5472 skip = (PyString_Check(name) &&
5473 PyString_GET_SIZE(name) == 9 &&
5474 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5475 }
5476
5477 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005478 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005479 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005480 descrgetfunc f;
5481 int i, n;
5482
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005483 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005484 mro = starttype->tp_mro;
5485
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005486 if (mro == NULL)
5487 n = 0;
5488 else {
5489 assert(PyTuple_Check(mro));
5490 n = PyTuple_GET_SIZE(mro);
5491 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005492 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005493 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005494 break;
5495 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005496 i++;
5497 res = NULL;
5498 for (; i < n; i++) {
5499 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005500 if (PyType_Check(tmp))
5501 dict = ((PyTypeObject *)tmp)->tp_dict;
5502 else if (PyClass_Check(tmp))
5503 dict = ((PyClassObject *)tmp)->cl_dict;
5504 else
5505 continue;
5506 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005507 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005508 Py_INCREF(res);
5509 f = res->ob_type->tp_descr_get;
5510 if (f != NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00005511 tmp = f(res, su->obj,
5512 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005513 Py_DECREF(res);
5514 res = tmp;
5515 }
5516 return res;
5517 }
5518 }
5519 }
5520 return PyObject_GenericGetAttr(self, name);
5521}
5522
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005523static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005524supercheck(PyTypeObject *type, PyObject *obj)
5525{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005526 /* Check that a super() call makes sense. Return a type object.
5527
5528 obj can be a new-style class, or an instance of one:
5529
5530 - If it is a class, it must be a subclass of 'type'. This case is
5531 used for class methods; the return value is obj.
5532
5533 - If it is an instance, it must be an instance of 'type'. This is
5534 the normal case; the return value is obj.__class__.
5535
5536 But... when obj is an instance, we want to allow for the case where
5537 obj->ob_type is not a subclass of type, but obj.__class__ is!
5538 This will allow using super() with a proxy for obj.
5539 */
5540
Guido van Rossum8e80a722003-02-18 19:22:22 +00005541 /* Check for first bullet above (special case) */
5542 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5543 Py_INCREF(obj);
5544 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005545 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005546
5547 /* Normal case */
5548 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005549 Py_INCREF(obj->ob_type);
5550 return obj->ob_type;
5551 }
5552 else {
5553 /* Try the slow way */
5554 static PyObject *class_str = NULL;
5555 PyObject *class_attr;
5556
5557 if (class_str == NULL) {
5558 class_str = PyString_FromString("__class__");
5559 if (class_str == NULL)
5560 return NULL;
5561 }
5562
5563 class_attr = PyObject_GetAttr(obj, class_str);
5564
5565 if (class_attr != NULL &&
5566 PyType_Check(class_attr) &&
5567 (PyTypeObject *)class_attr != obj->ob_type)
5568 {
5569 int ok = PyType_IsSubtype(
5570 (PyTypeObject *)class_attr, type);
5571 if (ok)
5572 return (PyTypeObject *)class_attr;
5573 }
5574
5575 if (class_attr == NULL)
5576 PyErr_Clear();
5577 else
5578 Py_DECREF(class_attr);
5579 }
5580
Tim Peters97e5ff52003-02-18 19:32:50 +00005581 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005582 "super(type, obj): "
5583 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005584 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005585}
5586
Guido van Rossum705f0f52001-08-24 16:47:00 +00005587static PyObject *
5588super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5589{
5590 superobject *su = (superobject *)self;
5591 superobject *new;
5592
5593 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5594 /* Not binding to an object, or already bound */
5595 Py_INCREF(self);
5596 return self;
5597 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005598 if (su->ob_type != &PySuper_Type)
Brett Cannon10147f72003-06-11 20:50:33 +00005599 /* If su is not an instance of a subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005600 call its type */
5601 return PyObject_CallFunction((PyObject *)su->ob_type,
5602 "OO", su->type, obj);
5603 else {
5604 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005605 PyTypeObject *obj_type = supercheck(su->type, obj);
5606 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005607 return NULL;
5608 new = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
5609 NULL, NULL);
5610 if (new == NULL)
5611 return NULL;
5612 Py_INCREF(su->type);
5613 Py_INCREF(obj);
5614 new->type = su->type;
5615 new->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005616 new->obj_type = obj_type;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005617 return (PyObject *)new;
5618 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005619}
5620
5621static int
5622super_init(PyObject *self, PyObject *args, PyObject *kwds)
5623{
5624 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005625 PyTypeObject *type;
5626 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005627 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005628
5629 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5630 return -1;
5631 if (obj == Py_None)
5632 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005633 if (obj != NULL) {
5634 obj_type = supercheck(type, obj);
5635 if (obj_type == NULL)
5636 return -1;
5637 Py_INCREF(obj);
5638 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005639 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005640 su->type = type;
5641 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005642 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005643 return 0;
5644}
5645
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005646PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005647"super(type) -> unbound super object\n"
5648"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005649"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005650"Typical use to call a cooperative superclass method:\n"
5651"class C(B):\n"
5652" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005653" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005654
Guido van Rossum048eb752001-10-02 21:24:57 +00005655static int
5656super_traverse(PyObject *self, visitproc visit, void *arg)
5657{
5658 superobject *su = (superobject *)self;
5659 int err;
5660
5661#define VISIT(SLOT) \
5662 if (SLOT) { \
5663 err = visit((PyObject *)(SLOT), arg); \
5664 if (err) \
5665 return err; \
5666 }
5667
5668 VISIT(su->obj);
5669 VISIT(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005670 VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005671
5672#undef VISIT
5673
5674 return 0;
5675}
5676
Guido van Rossum705f0f52001-08-24 16:47:00 +00005677PyTypeObject PySuper_Type = {
5678 PyObject_HEAD_INIT(&PyType_Type)
5679 0, /* ob_size */
5680 "super", /* tp_name */
5681 sizeof(superobject), /* tp_basicsize */
5682 0, /* tp_itemsize */
5683 /* methods */
5684 super_dealloc, /* tp_dealloc */
5685 0, /* tp_print */
5686 0, /* tp_getattr */
5687 0, /* tp_setattr */
5688 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005689 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005690 0, /* tp_as_number */
5691 0, /* tp_as_sequence */
5692 0, /* tp_as_mapping */
5693 0, /* tp_hash */
5694 0, /* tp_call */
5695 0, /* tp_str */
5696 super_getattro, /* tp_getattro */
5697 0, /* tp_setattro */
5698 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005699 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5700 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005701 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00005702 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005703 0, /* tp_clear */
5704 0, /* tp_richcompare */
5705 0, /* tp_weaklistoffset */
5706 0, /* tp_iter */
5707 0, /* tp_iternext */
5708 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005709 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005710 0, /* tp_getset */
5711 0, /* tp_base */
5712 0, /* tp_dict */
5713 super_descr_get, /* tp_descr_get */
5714 0, /* tp_descr_set */
5715 0, /* tp_dictoffset */
5716 super_init, /* tp_init */
5717 PyType_GenericAlloc, /* tp_alloc */
5718 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00005719 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005720};