blob: 6403103b834c465413b5ebe86c6d81d0798b77fa [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;
Raymond Hettinger8f5cdaa2003-12-13 11:26:12 +00002795 if (PyDict_GetItemString(dict, meth->ml_name) &&
2796 !(meth->ml_flags & METH_COEXIST))
2797 continue;
Fred Drake7bf97152002-03-28 05:33:33 +00002798 if (meth->ml_flags & METH_CLASS) {
2799 if (meth->ml_flags & METH_STATIC) {
2800 PyErr_SetString(PyExc_ValueError,
2801 "method cannot be both class and static");
2802 return -1;
2803 }
Tim Petersbca1cbc2002-12-09 22:56:13 +00002804 descr = PyDescr_NewClassMethod(type, meth);
Fred Drake7bf97152002-03-28 05:33:33 +00002805 }
2806 else if (meth->ml_flags & METH_STATIC) {
Guido van Rossum9af48ff2003-02-11 17:12:46 +00002807 PyObject *cfunc = PyCFunction_New(meth, NULL);
2808 if (cfunc == NULL)
2809 return -1;
2810 descr = PyStaticMethod_New(cfunc);
2811 Py_DECREF(cfunc);
Fred Drake7bf97152002-03-28 05:33:33 +00002812 }
2813 else {
2814 descr = PyDescr_NewMethod(type, meth);
2815 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00002816 if (descr == NULL)
2817 return -1;
Fred Drake7bf97152002-03-28 05:33:33 +00002818 if (PyDict_SetItemString(dict, meth->ml_name, descr) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002819 return -1;
2820 Py_DECREF(descr);
2821 }
2822 return 0;
2823}
2824
2825static int
Guido van Rossum6f799372001-09-20 20:46:19 +00002826add_members(PyTypeObject *type, PyMemberDef *memb)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002827{
Guido van Rossum687ae002001-10-15 22:03:32 +00002828 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002829
2830 for (; memb->name != NULL; memb++) {
2831 PyObject *descr;
2832 if (PyDict_GetItemString(dict, memb->name))
2833 continue;
2834 descr = PyDescr_NewMember(type, memb);
2835 if (descr == NULL)
2836 return -1;
2837 if (PyDict_SetItemString(dict, memb->name, descr) < 0)
2838 return -1;
2839 Py_DECREF(descr);
2840 }
2841 return 0;
2842}
2843
2844static int
Guido van Rossum32d34c82001-09-20 21:45:26 +00002845add_getset(PyTypeObject *type, PyGetSetDef *gsp)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002846{
Guido van Rossum687ae002001-10-15 22:03:32 +00002847 PyObject *dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002848
2849 for (; gsp->name != NULL; gsp++) {
2850 PyObject *descr;
2851 if (PyDict_GetItemString(dict, gsp->name))
2852 continue;
2853 descr = PyDescr_NewGetSet(type, gsp);
2854
2855 if (descr == NULL)
2856 return -1;
2857 if (PyDict_SetItemString(dict, gsp->name, descr) < 0)
2858 return -1;
2859 Py_DECREF(descr);
2860 }
2861 return 0;
2862}
2863
Guido van Rossum13d52f02001-08-10 21:24:08 +00002864static void
2865inherit_special(PyTypeObject *type, PyTypeObject *base)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002866{
2867 int oldsize, newsize;
2868
Guido van Rossum13d52f02001-08-10 21:24:08 +00002869 /* Special flag magic */
2870 if (!type->tp_as_buffer && base->tp_as_buffer) {
2871 type->tp_flags &= ~Py_TPFLAGS_HAVE_GETCHARBUFFER;
2872 type->tp_flags |=
2873 base->tp_flags & Py_TPFLAGS_HAVE_GETCHARBUFFER;
2874 }
2875 if (!type->tp_as_sequence && base->tp_as_sequence) {
2876 type->tp_flags &= ~Py_TPFLAGS_HAVE_SEQUENCE_IN;
2877 type->tp_flags |= base->tp_flags & Py_TPFLAGS_HAVE_SEQUENCE_IN;
2878 }
2879 if ((type->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS) !=
2880 (base->tp_flags & Py_TPFLAGS_HAVE_INPLACEOPS)) {
2881 if ((!type->tp_as_number && base->tp_as_number) ||
2882 (!type->tp_as_sequence && base->tp_as_sequence)) {
2883 type->tp_flags &= ~Py_TPFLAGS_HAVE_INPLACEOPS;
2884 if (!type->tp_as_number && !type->tp_as_sequence) {
2885 type->tp_flags |= base->tp_flags &
2886 Py_TPFLAGS_HAVE_INPLACEOPS;
2887 }
2888 }
2889 /* Wow */
2890 }
2891 if (!type->tp_as_number && base->tp_as_number) {
2892 type->tp_flags &= ~Py_TPFLAGS_CHECKTYPES;
2893 type->tp_flags |= base->tp_flags & Py_TPFLAGS_CHECKTYPES;
2894 }
2895
2896 /* Copying basicsize is connected to the GC flags */
Neil Schemenauerc806c882001-08-29 23:54:54 +00002897 oldsize = base->tp_basicsize;
2898 newsize = type->tp_basicsize ? type->tp_basicsize : oldsize;
2899 if (!(type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
2900 (base->tp_flags & Py_TPFLAGS_HAVE_GC) &&
Guido van Rossum13d52f02001-08-10 21:24:08 +00002901 (type->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE/*GC slots exist*/) &&
2902 (!type->tp_traverse && !type->tp_clear)) {
Neil Schemenauerc806c882001-08-29 23:54:54 +00002903 type->tp_flags |= Py_TPFLAGS_HAVE_GC;
Guido van Rossum13d52f02001-08-10 21:24:08 +00002904 if (type->tp_traverse == NULL)
2905 type->tp_traverse = base->tp_traverse;
2906 if (type->tp_clear == NULL)
2907 type->tp_clear = base->tp_clear;
2908 }
2909 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
Guido van Rossumf884b742001-12-17 17:14:22 +00002910 /* The condition below could use some explanation.
2911 It appears that tp_new is not inherited for static types
2912 whose base class is 'object'; this seems to be a precaution
2913 so that old extension types don't suddenly become
2914 callable (object.__new__ wouldn't insure the invariants
2915 that the extension type's own factory function ensures).
2916 Heap types, of course, are under our control, so they do
2917 inherit tp_new; static extension types that specify some
2918 other built-in type as the default are considered
2919 new-style-aware so they also inherit object.__new__. */
Guido van Rossum13d52f02001-08-10 21:24:08 +00002920 if (base != &PyBaseObject_Type ||
2921 (type->tp_flags & Py_TPFLAGS_HEAPTYPE)) {
2922 if (type->tp_new == NULL)
2923 type->tp_new = base->tp_new;
2924 }
2925 }
Neil Schemenauerc806c882001-08-29 23:54:54 +00002926 type->tp_basicsize = newsize;
Guido van Rossum4dd64ab2001-08-14 20:04:48 +00002927
2928 /* Copy other non-function slots */
2929
2930#undef COPYVAL
2931#define COPYVAL(SLOT) \
2932 if (type->SLOT == 0) type->SLOT = base->SLOT
2933
2934 COPYVAL(tp_itemsize);
2935 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_WEAKREFS) {
2936 COPYVAL(tp_weaklistoffset);
2937 }
2938 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
2939 COPYVAL(tp_dictoffset);
2940 }
Guido van Rossum13d52f02001-08-10 21:24:08 +00002941}
2942
2943static void
2944inherit_slots(PyTypeObject *type, PyTypeObject *base)
2945{
2946 PyTypeObject *basebase;
2947
2948#undef SLOTDEFINED
Tim Peters6d6c1a32001-08-02 04:15:00 +00002949#undef COPYSLOT
2950#undef COPYNUM
2951#undef COPYSEQ
2952#undef COPYMAP
Guido van Rossum5af588b2001-10-12 14:13:21 +00002953#undef COPYBUF
Guido van Rossum13d52f02001-08-10 21:24:08 +00002954
2955#define SLOTDEFINED(SLOT) \
2956 (base->SLOT != 0 && \
2957 (basebase == NULL || base->SLOT != basebase->SLOT))
2958
Tim Peters6d6c1a32001-08-02 04:15:00 +00002959#define COPYSLOT(SLOT) \
Guido van Rossum13d52f02001-08-10 21:24:08 +00002960 if (!type->SLOT && SLOTDEFINED(SLOT)) type->SLOT = base->SLOT
Tim Peters6d6c1a32001-08-02 04:15:00 +00002961
2962#define COPYNUM(SLOT) COPYSLOT(tp_as_number->SLOT)
2963#define COPYSEQ(SLOT) COPYSLOT(tp_as_sequence->SLOT)
2964#define COPYMAP(SLOT) COPYSLOT(tp_as_mapping->SLOT)
Tim Petersfc57ccb2001-10-12 02:38:24 +00002965#define COPYBUF(SLOT) COPYSLOT(tp_as_buffer->SLOT)
Tim Peters6d6c1a32001-08-02 04:15:00 +00002966
Guido van Rossum13d52f02001-08-10 21:24:08 +00002967 /* This won't inherit indirect slots (from tp_as_number etc.)
2968 if type doesn't provide the space. */
2969
2970 if (type->tp_as_number != NULL && base->tp_as_number != NULL) {
2971 basebase = base->tp_base;
2972 if (basebase->tp_as_number == NULL)
2973 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00002974 COPYNUM(nb_add);
2975 COPYNUM(nb_subtract);
2976 COPYNUM(nb_multiply);
2977 COPYNUM(nb_divide);
2978 COPYNUM(nb_remainder);
2979 COPYNUM(nb_divmod);
2980 COPYNUM(nb_power);
2981 COPYNUM(nb_negative);
2982 COPYNUM(nb_positive);
2983 COPYNUM(nb_absolute);
2984 COPYNUM(nb_nonzero);
2985 COPYNUM(nb_invert);
2986 COPYNUM(nb_lshift);
2987 COPYNUM(nb_rshift);
2988 COPYNUM(nb_and);
2989 COPYNUM(nb_xor);
2990 COPYNUM(nb_or);
2991 COPYNUM(nb_coerce);
2992 COPYNUM(nb_int);
2993 COPYNUM(nb_long);
2994 COPYNUM(nb_float);
2995 COPYNUM(nb_oct);
2996 COPYNUM(nb_hex);
2997 COPYNUM(nb_inplace_add);
2998 COPYNUM(nb_inplace_subtract);
2999 COPYNUM(nb_inplace_multiply);
3000 COPYNUM(nb_inplace_divide);
3001 COPYNUM(nb_inplace_remainder);
3002 COPYNUM(nb_inplace_power);
3003 COPYNUM(nb_inplace_lshift);
3004 COPYNUM(nb_inplace_rshift);
3005 COPYNUM(nb_inplace_and);
3006 COPYNUM(nb_inplace_xor);
3007 COPYNUM(nb_inplace_or);
Guido van Rossumdc91b992001-08-08 22:26:22 +00003008 if (base->tp_flags & Py_TPFLAGS_CHECKTYPES) {
3009 COPYNUM(nb_true_divide);
3010 COPYNUM(nb_floor_divide);
3011 COPYNUM(nb_inplace_true_divide);
3012 COPYNUM(nb_inplace_floor_divide);
3013 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003014 }
3015
Guido van Rossum13d52f02001-08-10 21:24:08 +00003016 if (type->tp_as_sequence != NULL && base->tp_as_sequence != NULL) {
3017 basebase = base->tp_base;
3018 if (basebase->tp_as_sequence == NULL)
3019 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003020 COPYSEQ(sq_length);
3021 COPYSEQ(sq_concat);
3022 COPYSEQ(sq_repeat);
3023 COPYSEQ(sq_item);
3024 COPYSEQ(sq_slice);
3025 COPYSEQ(sq_ass_item);
3026 COPYSEQ(sq_ass_slice);
3027 COPYSEQ(sq_contains);
3028 COPYSEQ(sq_inplace_concat);
3029 COPYSEQ(sq_inplace_repeat);
3030 }
3031
Guido van Rossum13d52f02001-08-10 21:24:08 +00003032 if (type->tp_as_mapping != NULL && base->tp_as_mapping != NULL) {
3033 basebase = base->tp_base;
3034 if (basebase->tp_as_mapping == NULL)
3035 basebase = NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003036 COPYMAP(mp_length);
3037 COPYMAP(mp_subscript);
3038 COPYMAP(mp_ass_subscript);
3039 }
3040
Tim Petersfc57ccb2001-10-12 02:38:24 +00003041 if (type->tp_as_buffer != NULL && base->tp_as_buffer != NULL) {
3042 basebase = base->tp_base;
3043 if (basebase->tp_as_buffer == NULL)
3044 basebase = NULL;
3045 COPYBUF(bf_getreadbuffer);
3046 COPYBUF(bf_getwritebuffer);
3047 COPYBUF(bf_getsegcount);
3048 COPYBUF(bf_getcharbuffer);
3049 }
3050
Guido van Rossum13d52f02001-08-10 21:24:08 +00003051 basebase = base->tp_base;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003052
Tim Peters6d6c1a32001-08-02 04:15:00 +00003053 COPYSLOT(tp_dealloc);
3054 COPYSLOT(tp_print);
3055 if (type->tp_getattr == NULL && type->tp_getattro == NULL) {
3056 type->tp_getattr = base->tp_getattr;
3057 type->tp_getattro = base->tp_getattro;
3058 }
3059 if (type->tp_setattr == NULL && type->tp_setattro == NULL) {
3060 type->tp_setattr = base->tp_setattr;
3061 type->tp_setattro = base->tp_setattro;
3062 }
3063 /* tp_compare see tp_richcompare */
3064 COPYSLOT(tp_repr);
Guido van Rossumb8f63662001-08-15 23:57:02 +00003065 /* tp_hash see tp_richcompare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003066 COPYSLOT(tp_call);
3067 COPYSLOT(tp_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003068 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_RICHCOMPARE) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00003069 if (type->tp_compare == NULL &&
3070 type->tp_richcompare == NULL &&
3071 type->tp_hash == NULL)
3072 {
Tim Peters6d6c1a32001-08-02 04:15:00 +00003073 type->tp_compare = base->tp_compare;
3074 type->tp_richcompare = base->tp_richcompare;
Guido van Rossumb8f63662001-08-15 23:57:02 +00003075 type->tp_hash = base->tp_hash;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003076 }
3077 }
3078 else {
3079 COPYSLOT(tp_compare);
3080 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003081 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_ITER) {
3082 COPYSLOT(tp_iter);
3083 COPYSLOT(tp_iternext);
3084 }
3085 if (type->tp_flags & base->tp_flags & Py_TPFLAGS_HAVE_CLASS) {
3086 COPYSLOT(tp_descr_get);
3087 COPYSLOT(tp_descr_set);
3088 COPYSLOT(tp_dictoffset);
3089 COPYSLOT(tp_init);
3090 COPYSLOT(tp_alloc);
Guido van Rossumcc8fe042002-04-05 17:10:16 +00003091 COPYSLOT(tp_is_gc);
Tim Peters3cfe7542003-05-21 21:29:48 +00003092 if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) ==
3093 (base->tp_flags & Py_TPFLAGS_HAVE_GC)) {
3094 /* They agree about gc. */
3095 COPYSLOT(tp_free);
3096 }
3097 else if ((type->tp_flags & Py_TPFLAGS_HAVE_GC) &&
3098 type->tp_free == NULL &&
3099 base->tp_free == _PyObject_Del) {
3100 /* A bit of magic to plug in the correct default
3101 * tp_free function when a derived class adds gc,
3102 * didn't define tp_free, and the base uses the
3103 * default non-gc tp_free.
3104 */
3105 type->tp_free = PyObject_GC_Del;
3106 }
3107 /* else they didn't agree about gc, and there isn't something
3108 * obvious to be done -- the type is on its own.
3109 */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003110 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003111}
3112
Jeremy Hylton938ace62002-07-17 16:30:39 +00003113static int add_operators(PyTypeObject *);
Guido van Rossum13d52f02001-08-10 21:24:08 +00003114
Tim Peters6d6c1a32001-08-02 04:15:00 +00003115int
Guido van Rossum528b7eb2001-08-07 17:24:28 +00003116PyType_Ready(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003117{
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003118 PyObject *dict, *bases;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003119 PyTypeObject *base;
3120 int i, n;
3121
Guido van Rossumcab05802002-06-10 15:29:03 +00003122 if (type->tp_flags & Py_TPFLAGS_READY) {
3123 assert(type->tp_dict != NULL);
Guido van Rossumd614f972001-08-10 17:39:49 +00003124 return 0;
Guido van Rossumcab05802002-06-10 15:29:03 +00003125 }
Guido van Rossumd614f972001-08-10 17:39:49 +00003126 assert((type->tp_flags & Py_TPFLAGS_READYING) == 0);
Guido van Rossumd614f972001-08-10 17:39:49 +00003127
3128 type->tp_flags |= Py_TPFLAGS_READYING;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003129
Tim Peters36eb4df2003-03-23 03:33:13 +00003130#ifdef Py_TRACE_REFS
3131 /* PyType_Ready is the closest thing we have to a choke point
3132 * for type objects, so is the best place I can think of to try
3133 * to get type objects into the doubly-linked list of all objects.
3134 * Still, not all type objects go thru PyType_Ready.
3135 */
Tim Peters7571a0f2003-03-23 17:52:28 +00003136 _Py_AddToAllObjects((PyObject *)type, 0);
Tim Peters36eb4df2003-03-23 03:33:13 +00003137#endif
3138
Tim Peters6d6c1a32001-08-02 04:15:00 +00003139 /* Initialize tp_base (defaults to BaseObject unless that's us) */
3140 base = type->tp_base;
3141 if (base == NULL && type != &PyBaseObject_Type)
3142 base = type->tp_base = &PyBaseObject_Type;
3143
Guido van Rossum323a9cf2002-08-14 17:26:30 +00003144 /* Initialize the base class */
3145 if (base && base->tp_dict == NULL) {
3146 if (PyType_Ready(base) < 0)
3147 goto error;
3148 }
3149
Guido van Rossum0986d822002-04-08 01:38:42 +00003150 /* Initialize ob_type if NULL. This means extensions that want to be
3151 compilable separately on Windows can call PyType_Ready() instead of
3152 initializing the ob_type field of their type objects. */
3153 if (type->ob_type == NULL)
3154 type->ob_type = base->ob_type;
3155
Tim Peters6d6c1a32001-08-02 04:15:00 +00003156 /* Initialize tp_bases */
3157 bases = type->tp_bases;
3158 if (bases == NULL) {
3159 if (base == NULL)
3160 bases = PyTuple_New(0);
3161 else
Raymond Hettinger8ae46892003-10-12 19:09:37 +00003162 bases = PyTuple_Pack(1, base);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003163 if (bases == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003164 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003165 type->tp_bases = bases;
3166 }
3167
Guido van Rossum687ae002001-10-15 22:03:32 +00003168 /* Initialize tp_dict */
3169 dict = type->tp_dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003170 if (dict == NULL) {
3171 dict = PyDict_New();
3172 if (dict == NULL)
Guido van Rossumd614f972001-08-10 17:39:49 +00003173 goto error;
Guido van Rossum687ae002001-10-15 22:03:32 +00003174 type->tp_dict = dict;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003175 }
3176
Guido van Rossum687ae002001-10-15 22:03:32 +00003177 /* Add type-specific descriptors to tp_dict */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003178 if (add_operators(type) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003179 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003180 if (type->tp_methods != NULL) {
3181 if (add_methods(type, type->tp_methods) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003182 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003183 }
3184 if (type->tp_members != NULL) {
3185 if (add_members(type, type->tp_members) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003186 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003187 }
3188 if (type->tp_getset != NULL) {
3189 if (add_getset(type, type->tp_getset) < 0)
Guido van Rossumd614f972001-08-10 17:39:49 +00003190 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003191 }
3192
Tim Peters6d6c1a32001-08-02 04:15:00 +00003193 /* Calculate method resolution order */
3194 if (mro_internal(type) < 0) {
Guido van Rossumd614f972001-08-10 17:39:49 +00003195 goto error;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003196 }
3197
Guido van Rossum13d52f02001-08-10 21:24:08 +00003198 /* Inherit special flags from dominant base */
3199 if (type->tp_base != NULL)
3200 inherit_special(type, type->tp_base);
3201
Tim Peters6d6c1a32001-08-02 04:15:00 +00003202 /* Initialize tp_dict properly */
Guido van Rossum2f3ca6e2001-10-15 21:05:10 +00003203 bases = type->tp_mro;
3204 assert(bases != NULL);
3205 assert(PyTuple_Check(bases));
3206 n = PyTuple_GET_SIZE(bases);
3207 for (i = 1; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003208 PyObject *b = PyTuple_GET_ITEM(bases, i);
3209 if (PyType_Check(b))
3210 inherit_slots(type, (PyTypeObject *)b);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003211 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003212
Tim Peters3cfe7542003-05-21 21:29:48 +00003213 /* Sanity check for tp_free. */
3214 if (PyType_IS_GC(type) && (type->tp_flags & Py_TPFLAGS_BASETYPE) &&
3215 (type->tp_free == NULL || type->tp_free == PyObject_Del)) {
3216 /* This base class needs to call tp_free, but doesn't have
3217 * one, or its tp_free is for non-gc'ed objects.
3218 */
3219 PyErr_Format(PyExc_TypeError, "type '%.100s' participates in "
3220 "gc and is a base type but has inappropriate "
3221 "tp_free slot",
3222 type->tp_name);
3223 goto error;
3224 }
3225
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003226 /* if the type dictionary doesn't contain a __doc__, set it from
3227 the tp_doc slot.
3228 */
3229 if (PyDict_GetItemString(type->tp_dict, "__doc__") == NULL) {
3230 if (type->tp_doc != NULL) {
3231 PyObject *doc = PyString_FromString(type->tp_doc);
3232 PyDict_SetItemString(type->tp_dict, "__doc__", doc);
3233 Py_DECREF(doc);
3234 } else {
Guido van Rossumd4641072002-04-03 02:13:37 +00003235 PyDict_SetItemString(type->tp_dict,
3236 "__doc__", Py_None);
Martin v. Löwisf9bd6b02002-02-18 17:46:48 +00003237 }
3238 }
3239
Guido van Rossum13d52f02001-08-10 21:24:08 +00003240 /* Some more special stuff */
3241 base = type->tp_base;
3242 if (base != NULL) {
3243 if (type->tp_as_number == NULL)
3244 type->tp_as_number = base->tp_as_number;
3245 if (type->tp_as_sequence == NULL)
3246 type->tp_as_sequence = base->tp_as_sequence;
3247 if (type->tp_as_mapping == NULL)
3248 type->tp_as_mapping = base->tp_as_mapping;
Guido van Rossumeea47182003-02-11 20:39:59 +00003249 if (type->tp_as_buffer == NULL)
3250 type->tp_as_buffer = base->tp_as_buffer;
Guido van Rossum13d52f02001-08-10 21:24:08 +00003251 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003252
Guido van Rossum1c450732001-10-08 15:18:27 +00003253 /* Link into each base class's list of subclasses */
3254 bases = type->tp_bases;
3255 n = PyTuple_GET_SIZE(bases);
3256 for (i = 0; i < n; i++) {
Tim Petersa91e9642001-11-14 23:32:33 +00003257 PyObject *b = PyTuple_GET_ITEM(bases, i);
3258 if (PyType_Check(b) &&
3259 add_subclass((PyTypeObject *)b, type) < 0)
Guido van Rossum1c450732001-10-08 15:18:27 +00003260 goto error;
3261 }
3262
Guido van Rossum13d52f02001-08-10 21:24:08 +00003263 /* All done -- set the ready flag */
Guido van Rossumd614f972001-08-10 17:39:49 +00003264 assert(type->tp_dict != NULL);
3265 type->tp_flags =
3266 (type->tp_flags & ~Py_TPFLAGS_READYING) | Py_TPFLAGS_READY;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003267 return 0;
Guido van Rossumd614f972001-08-10 17:39:49 +00003268
3269 error:
3270 type->tp_flags &= ~Py_TPFLAGS_READYING;
3271 return -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003272}
3273
Guido van Rossum1c450732001-10-08 15:18:27 +00003274static int
3275add_subclass(PyTypeObject *base, PyTypeObject *type)
3276{
3277 int i;
3278 PyObject *list, *ref, *new;
3279
3280 list = base->tp_subclasses;
3281 if (list == NULL) {
3282 base->tp_subclasses = list = PyList_New(0);
3283 if (list == NULL)
3284 return -1;
3285 }
3286 assert(PyList_Check(list));
3287 new = PyWeakref_NewRef((PyObject *)type, NULL);
3288 i = PyList_GET_SIZE(list);
3289 while (--i >= 0) {
3290 ref = PyList_GET_ITEM(list, i);
3291 assert(PyWeakref_CheckRef(ref));
Guido van Rossum3930bc32002-10-18 13:51:49 +00003292 if (PyWeakref_GET_OBJECT(ref) == Py_None)
3293 return PyList_SetItem(list, i, new);
Guido van Rossum1c450732001-10-08 15:18:27 +00003294 }
3295 i = PyList_Append(list, new);
3296 Py_DECREF(new);
3297 return i;
3298}
3299
Michael W. Hudson98bbc492002-11-26 14:47:27 +00003300static void
3301remove_subclass(PyTypeObject *base, PyTypeObject *type)
3302{
3303 int i;
3304 PyObject *list, *ref;
3305
3306 list = base->tp_subclasses;
3307 if (list == NULL) {
3308 return;
3309 }
3310 assert(PyList_Check(list));
3311 i = PyList_GET_SIZE(list);
3312 while (--i >= 0) {
3313 ref = PyList_GET_ITEM(list, i);
3314 assert(PyWeakref_CheckRef(ref));
3315 if (PyWeakref_GET_OBJECT(ref) == (PyObject*)type) {
3316 /* this can't fail, right? */
3317 PySequence_DelItem(list, i);
3318 return;
3319 }
3320 }
3321}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003322
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003323static int
3324check_num_args(PyObject *ob, int n)
3325{
3326 if (!PyTuple_CheckExact(ob)) {
3327 PyErr_SetString(PyExc_SystemError,
3328 "PyArg_UnpackTuple() argument list is not a tuple");
3329 return 0;
3330 }
3331 if (n == PyTuple_GET_SIZE(ob))
3332 return 1;
3333 PyErr_Format(
3334 PyExc_TypeError,
3335 "expected %d arguments, got %d", n, PyTuple_GET_SIZE(ob));
3336 return 0;
3337}
3338
Tim Peters6d6c1a32001-08-02 04:15:00 +00003339/* Generic wrappers for overloadable 'operators' such as __getitem__ */
3340
3341/* There's a wrapper *function* for each distinct function typedef used
3342 for type object slots (e.g. binaryfunc, ternaryfunc, etc.). There's a
3343 wrapper *table* for each distinct operation (e.g. __len__, __add__).
3344 Most tables have only one entry; the tables for binary operators have two
3345 entries, one regular and one with reversed arguments. */
3346
3347static PyObject *
3348wrap_inquiry(PyObject *self, PyObject *args, void *wrapped)
3349{
3350 inquiry func = (inquiry)wrapped;
3351 int res;
3352
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003353 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003354 return NULL;
3355 res = (*func)(self);
3356 if (res == -1 && PyErr_Occurred())
3357 return NULL;
3358 return PyInt_FromLong((long)res);
3359}
3360
Tim Peters6d6c1a32001-08-02 04:15:00 +00003361static PyObject *
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003362wrap_inquirypred(PyObject *self, PyObject *args, void *wrapped)
3363{
3364 inquiry func = (inquiry)wrapped;
3365 int res;
3366
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003367 if (!check_num_args(args, 0))
Raymond Hettingerf34f2642003-10-11 17:29:04 +00003368 return NULL;
3369 res = (*func)(self);
3370 if (res == -1 && PyErr_Occurred())
3371 return NULL;
3372 return PyBool_FromLong((long)res);
3373}
3374
3375static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003376wrap_binaryfunc(PyObject *self, PyObject *args, void *wrapped)
3377{
3378 binaryfunc func = (binaryfunc)wrapped;
3379 PyObject *other;
3380
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003381 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003382 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003383 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003384 return (*func)(self, other);
3385}
3386
3387static PyObject *
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003388wrap_binaryfunc_l(PyObject *self, PyObject *args, void *wrapped)
3389{
3390 binaryfunc func = (binaryfunc)wrapped;
3391 PyObject *other;
3392
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003393 if (!check_num_args(args, 1))
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003394 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003395 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003396 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003397 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003398 Py_INCREF(Py_NotImplemented);
3399 return Py_NotImplemented;
3400 }
3401 return (*func)(self, other);
3402}
3403
3404static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00003405wrap_binaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3406{
3407 binaryfunc func = (binaryfunc)wrapped;
3408 PyObject *other;
3409
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003410 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003411 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003412 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003413 if (!(self->ob_type->tp_flags & Py_TPFLAGS_CHECKTYPES) &&
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003414 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossum0eb2a6e2001-10-09 11:07:24 +00003415 Py_INCREF(Py_NotImplemented);
3416 return Py_NotImplemented;
3417 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003418 return (*func)(other, self);
3419}
3420
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003421static PyObject *
3422wrap_coercefunc(PyObject *self, PyObject *args, void *wrapped)
3423{
3424 coercion func = (coercion)wrapped;
3425 PyObject *other, *res;
3426 int ok;
3427
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003428 if (!check_num_args(args, 1))
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003429 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003430 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00003431 ok = func(&self, &other);
3432 if (ok < 0)
3433 return NULL;
3434 if (ok > 0) {
3435 Py_INCREF(Py_NotImplemented);
3436 return Py_NotImplemented;
3437 }
3438 res = PyTuple_New(2);
3439 if (res == NULL) {
3440 Py_DECREF(self);
3441 Py_DECREF(other);
3442 return NULL;
3443 }
3444 PyTuple_SET_ITEM(res, 0, self);
3445 PyTuple_SET_ITEM(res, 1, other);
3446 return res;
3447}
3448
Tim Peters6d6c1a32001-08-02 04:15:00 +00003449static PyObject *
3450wrap_ternaryfunc(PyObject *self, PyObject *args, void *wrapped)
3451{
3452 ternaryfunc func = (ternaryfunc)wrapped;
3453 PyObject *other;
3454 PyObject *third = Py_None;
3455
3456 /* Note: This wrapper only works for __pow__() */
3457
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003458 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003459 return NULL;
3460 return (*func)(self, other, third);
3461}
3462
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003463static PyObject *
3464wrap_ternaryfunc_r(PyObject *self, PyObject *args, void *wrapped)
3465{
3466 ternaryfunc func = (ternaryfunc)wrapped;
3467 PyObject *other;
3468 PyObject *third = Py_None;
3469
3470 /* Note: This wrapper only works for __pow__() */
3471
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003472 if (!PyArg_UnpackTuple(args, "", 1, 2, &other, &third))
Guido van Rossum9bea3ab2001-09-28 22:58:52 +00003473 return NULL;
3474 return (*func)(other, self, third);
3475}
3476
Tim Peters6d6c1a32001-08-02 04:15:00 +00003477static PyObject *
3478wrap_unaryfunc(PyObject *self, PyObject *args, void *wrapped)
3479{
3480 unaryfunc func = (unaryfunc)wrapped;
3481
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003482 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003483 return NULL;
3484 return (*func)(self);
3485}
3486
Tim Peters6d6c1a32001-08-02 04:15:00 +00003487static PyObject *
3488wrap_intargfunc(PyObject *self, PyObject *args, void *wrapped)
3489{
3490 intargfunc func = (intargfunc)wrapped;
3491 int i;
3492
3493 if (!PyArg_ParseTuple(args, "i", &i))
3494 return NULL;
3495 return (*func)(self, i);
3496}
3497
Guido van Rossum5d815f32001-08-17 21:57:47 +00003498static int
3499getindex(PyObject *self, PyObject *arg)
3500{
3501 int i;
3502
3503 i = PyInt_AsLong(arg);
3504 if (i == -1 && PyErr_Occurred())
3505 return -1;
3506 if (i < 0) {
3507 PySequenceMethods *sq = self->ob_type->tp_as_sequence;
3508 if (sq && sq->sq_length) {
3509 int n = (*sq->sq_length)(self);
3510 if (n < 0)
3511 return -1;
3512 i += n;
3513 }
3514 }
3515 return i;
3516}
3517
3518static PyObject *
3519wrap_sq_item(PyObject *self, PyObject *args, void *wrapped)
3520{
3521 intargfunc func = (intargfunc)wrapped;
3522 PyObject *arg;
3523 int i;
3524
Guido van Rossumf4593e02001-10-03 12:09:30 +00003525 if (PyTuple_GET_SIZE(args) == 1) {
3526 arg = PyTuple_GET_ITEM(args, 0);
3527 i = getindex(self, arg);
3528 if (i == -1 && PyErr_Occurred())
3529 return NULL;
3530 return (*func)(self, i);
3531 }
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003532 check_num_args(args, 1);
Guido van Rossumf4593e02001-10-03 12:09:30 +00003533 assert(PyErr_Occurred());
3534 return NULL;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003535}
3536
Tim Peters6d6c1a32001-08-02 04:15:00 +00003537static PyObject *
3538wrap_intintargfunc(PyObject *self, PyObject *args, void *wrapped)
3539{
3540 intintargfunc func = (intintargfunc)wrapped;
3541 int i, j;
3542
3543 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3544 return NULL;
3545 return (*func)(self, i, j);
3546}
3547
Tim Peters6d6c1a32001-08-02 04:15:00 +00003548static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003549wrap_sq_setitem(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003550{
3551 intobjargproc func = (intobjargproc)wrapped;
3552 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003553 PyObject *arg, *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003554
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003555 if (!PyArg_UnpackTuple(args, "", 2, 2, &arg, &value))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003556 return NULL;
3557 i = getindex(self, arg);
3558 if (i == -1 && PyErr_Occurred())
Tim Peters6d6c1a32001-08-02 04:15:00 +00003559 return NULL;
3560 res = (*func)(self, i, value);
3561 if (res == -1 && PyErr_Occurred())
3562 return NULL;
3563 Py_INCREF(Py_None);
3564 return Py_None;
3565}
3566
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003567static PyObject *
Guido van Rossum5d815f32001-08-17 21:57:47 +00003568wrap_sq_delitem(PyObject *self, PyObject *args, void *wrapped)
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003569{
3570 intobjargproc func = (intobjargproc)wrapped;
3571 int i, res;
Guido van Rossum5d815f32001-08-17 21:57:47 +00003572 PyObject *arg;
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003573
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003574 if (!check_num_args(args, 1))
Guido van Rossum5d815f32001-08-17 21:57:47 +00003575 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003576 arg = PyTuple_GET_ITEM(args, 0);
Guido van Rossum5d815f32001-08-17 21:57:47 +00003577 i = getindex(self, arg);
3578 if (i == -1 && PyErr_Occurred())
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003579 return NULL;
3580 res = (*func)(self, i, NULL);
3581 if (res == -1 && PyErr_Occurred())
3582 return NULL;
3583 Py_INCREF(Py_None);
3584 return Py_None;
3585}
3586
Tim Peters6d6c1a32001-08-02 04:15:00 +00003587static PyObject *
3588wrap_intintobjargproc(PyObject *self, PyObject *args, void *wrapped)
3589{
3590 intintobjargproc func = (intintobjargproc)wrapped;
3591 int i, j, res;
3592 PyObject *value;
3593
3594 if (!PyArg_ParseTuple(args, "iiO", &i, &j, &value))
3595 return NULL;
3596 res = (*func)(self, i, j, value);
3597 if (res == -1 && PyErr_Occurred())
3598 return NULL;
3599 Py_INCREF(Py_None);
3600 return Py_None;
3601}
3602
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003603static PyObject *
3604wrap_delslice(PyObject *self, PyObject *args, void *wrapped)
3605{
3606 intintobjargproc func = (intintobjargproc)wrapped;
3607 int i, j, res;
3608
3609 if (!PyArg_ParseTuple(args, "ii", &i, &j))
3610 return NULL;
3611 res = (*func)(self, i, j, NULL);
3612 if (res == -1 && PyErr_Occurred())
3613 return NULL;
3614 Py_INCREF(Py_None);
3615 return Py_None;
3616}
3617
Tim Peters6d6c1a32001-08-02 04:15:00 +00003618/* XXX objobjproc is a misnomer; should be objargpred */
3619static PyObject *
3620wrap_objobjproc(PyObject *self, PyObject *args, void *wrapped)
3621{
3622 objobjproc func = (objobjproc)wrapped;
3623 int res;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003624 PyObject *value;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003625
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003626 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003627 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003628 value = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003629 res = (*func)(self, value);
3630 if (res == -1 && PyErr_Occurred())
3631 return NULL;
Guido van Rossum22c3dda2003-10-09 03:46:35 +00003632 else
3633 return PyBool_FromLong(res);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003634}
3635
Tim Peters6d6c1a32001-08-02 04:15:00 +00003636static PyObject *
3637wrap_objobjargproc(PyObject *self, PyObject *args, void *wrapped)
3638{
3639 objobjargproc func = (objobjargproc)wrapped;
3640 int res;
3641 PyObject *key, *value;
3642
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003643 if (!PyArg_UnpackTuple(args, "", 2, 2, &key, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003644 return NULL;
3645 res = (*func)(self, key, value);
3646 if (res == -1 && PyErr_Occurred())
3647 return NULL;
3648 Py_INCREF(Py_None);
3649 return Py_None;
3650}
3651
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003652static PyObject *
3653wrap_delitem(PyObject *self, PyObject *args, void *wrapped)
3654{
3655 objobjargproc func = (objobjargproc)wrapped;
3656 int res;
3657 PyObject *key;
3658
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003659 if (!check_num_args(args, 1))
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003660 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003661 key = PyTuple_GET_ITEM(args, 0);
Guido van Rossum2b8d7bd2001-08-02 15:31:58 +00003662 res = (*func)(self, key, NULL);
3663 if (res == -1 && PyErr_Occurred())
3664 return NULL;
3665 Py_INCREF(Py_None);
3666 return Py_None;
3667}
3668
Tim Peters6d6c1a32001-08-02 04:15:00 +00003669static PyObject *
3670wrap_cmpfunc(PyObject *self, PyObject *args, void *wrapped)
3671{
3672 cmpfunc func = (cmpfunc)wrapped;
3673 int res;
3674 PyObject *other;
3675
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003676 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003677 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003678 other = PyTuple_GET_ITEM(args, 0);
Guido van Rossum3d45d8f2001-09-24 18:47:40 +00003679 if (other->ob_type->tp_compare != func &&
3680 !PyType_IsSubtype(other->ob_type, self->ob_type)) {
Guido van Rossumceccae52001-09-18 20:03:57 +00003681 PyErr_Format(
3682 PyExc_TypeError,
3683 "%s.__cmp__(x,y) requires y to be a '%s', not a '%s'",
3684 self->ob_type->tp_name,
3685 self->ob_type->tp_name,
3686 other->ob_type->tp_name);
3687 return NULL;
3688 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003689 res = (*func)(self, other);
3690 if (PyErr_Occurred())
3691 return NULL;
3692 return PyInt_FromLong((long)res);
3693}
3694
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003695/* Helper to check for object.__setattr__ or __delattr__ applied to a type.
Guido van Rossum52b27052003-04-15 20:05:10 +00003696 This is called the Carlo Verre hack after its discoverer. */
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003697static int
3698hackcheck(PyObject *self, setattrofunc func, char *what)
3699{
3700 PyTypeObject *type = self->ob_type;
3701 while (type && type->tp_flags & Py_TPFLAGS_HEAPTYPE)
3702 type = type->tp_base;
3703 if (type->tp_setattro != func) {
3704 PyErr_Format(PyExc_TypeError,
3705 "can't apply this %s to %s object",
3706 what,
3707 type->tp_name);
3708 return 0;
3709 }
3710 return 1;
3711}
3712
Tim Peters6d6c1a32001-08-02 04:15:00 +00003713static PyObject *
3714wrap_setattr(PyObject *self, PyObject *args, void *wrapped)
3715{
3716 setattrofunc func = (setattrofunc)wrapped;
3717 int res;
3718 PyObject *name, *value;
3719
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003720 if (!PyArg_UnpackTuple(args, "", 2, 2, &name, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003721 return NULL;
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003722 if (!hackcheck(self, func, "__setattr__"))
3723 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003724 res = (*func)(self, name, value);
3725 if (res < 0)
3726 return NULL;
3727 Py_INCREF(Py_None);
3728 return Py_None;
3729}
3730
3731static PyObject *
3732wrap_delattr(PyObject *self, PyObject *args, void *wrapped)
3733{
3734 setattrofunc func = (setattrofunc)wrapped;
3735 int res;
3736 PyObject *name;
3737
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003738 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003739 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003740 name = PyTuple_GET_ITEM(args, 0);
Guido van Rossum4dcdb782003-04-14 21:46:03 +00003741 if (!hackcheck(self, func, "__delattr__"))
3742 return NULL;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003743 res = (*func)(self, name, NULL);
3744 if (res < 0)
3745 return NULL;
3746 Py_INCREF(Py_None);
3747 return Py_None;
3748}
3749
Tim Peters6d6c1a32001-08-02 04:15:00 +00003750static PyObject *
3751wrap_hashfunc(PyObject *self, PyObject *args, void *wrapped)
3752{
3753 hashfunc func = (hashfunc)wrapped;
3754 long res;
3755
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003756 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003757 return NULL;
3758 res = (*func)(self);
3759 if (res == -1 && PyErr_Occurred())
3760 return NULL;
3761 return PyInt_FromLong(res);
3762}
3763
Tim Peters6d6c1a32001-08-02 04:15:00 +00003764static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003765wrap_call(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003766{
3767 ternaryfunc func = (ternaryfunc)wrapped;
3768
Guido van Rossumc8e56452001-10-22 00:43:43 +00003769 return (*func)(self, args, kwds);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003770}
3771
Tim Peters6d6c1a32001-08-02 04:15:00 +00003772static PyObject *
3773wrap_richcmpfunc(PyObject *self, PyObject *args, void *wrapped, int op)
3774{
3775 richcmpfunc func = (richcmpfunc)wrapped;
3776 PyObject *other;
3777
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003778 if (!check_num_args(args, 1))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003779 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003780 other = PyTuple_GET_ITEM(args, 0);
Tim Peters6d6c1a32001-08-02 04:15:00 +00003781 return (*func)(self, other, op);
3782}
3783
3784#undef RICHCMP_WRAPPER
3785#define RICHCMP_WRAPPER(NAME, OP) \
3786static PyObject * \
3787richcmp_##NAME(PyObject *self, PyObject *args, void *wrapped) \
3788{ \
3789 return wrap_richcmpfunc(self, args, wrapped, OP); \
3790}
3791
Jack Jansen8e938b42001-08-08 15:29:49 +00003792RICHCMP_WRAPPER(lt, Py_LT)
3793RICHCMP_WRAPPER(le, Py_LE)
3794RICHCMP_WRAPPER(eq, Py_EQ)
3795RICHCMP_WRAPPER(ne, Py_NE)
3796RICHCMP_WRAPPER(gt, Py_GT)
3797RICHCMP_WRAPPER(ge, Py_GE)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003798
Tim Peters6d6c1a32001-08-02 04:15:00 +00003799static PyObject *
3800wrap_next(PyObject *self, PyObject *args, void *wrapped)
3801{
3802 unaryfunc func = (unaryfunc)wrapped;
3803 PyObject *res;
3804
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003805 if (!check_num_args(args, 0))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003806 return NULL;
3807 res = (*func)(self);
3808 if (res == NULL && !PyErr_Occurred())
3809 PyErr_SetNone(PyExc_StopIteration);
3810 return res;
3811}
3812
Tim Peters6d6c1a32001-08-02 04:15:00 +00003813static PyObject *
3814wrap_descr_get(PyObject *self, PyObject *args, void *wrapped)
3815{
3816 descrgetfunc func = (descrgetfunc)wrapped;
3817 PyObject *obj;
3818 PyObject *type = NULL;
3819
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003820 if (!PyArg_UnpackTuple(args, "", 1, 2, &obj, &type))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003821 return NULL;
Guido van Rossum82ed25c2003-02-11 16:25:43 +00003822 if (obj == Py_None)
3823 obj = NULL;
3824 if (type == Py_None)
3825 type = NULL;
3826 if (type == NULL &&obj == NULL) {
3827 PyErr_SetString(PyExc_TypeError,
3828 "__get__(None, None) is invalid");
3829 return NULL;
3830 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00003831 return (*func)(self, obj, type);
3832}
3833
Tim Peters6d6c1a32001-08-02 04:15:00 +00003834static PyObject *
Guido van Rossum7b9144b2001-10-09 19:39:46 +00003835wrap_descr_set(PyObject *self, PyObject *args, void *wrapped)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003836{
3837 descrsetfunc func = (descrsetfunc)wrapped;
3838 PyObject *obj, *value;
3839 int ret;
3840
Raymond Hettinger56bb16f2003-10-11 19:32:18 +00003841 if (!PyArg_UnpackTuple(args, "", 2, 2, &obj, &value))
Tim Peters6d6c1a32001-08-02 04:15:00 +00003842 return NULL;
3843 ret = (*func)(self, obj, value);
3844 if (ret < 0)
3845 return NULL;
3846 Py_INCREF(Py_None);
3847 return Py_None;
3848}
Guido van Rossum22b13872002-08-06 21:41:44 +00003849
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003850static PyObject *
3851wrap_descr_delete(PyObject *self, PyObject *args, void *wrapped)
3852{
3853 descrsetfunc func = (descrsetfunc)wrapped;
3854 PyObject *obj;
3855 int ret;
3856
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003857 if (!check_num_args(args, 1))
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003858 return NULL;
Raymond Hettinger6a8bbdb2003-12-13 15:21:55 +00003859 obj = PyTuple_GET_ITEM(args, 0);
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00003860 ret = (*func)(self, obj, NULL);
3861 if (ret < 0)
3862 return NULL;
3863 Py_INCREF(Py_None);
3864 return Py_None;
3865}
Tim Peters6d6c1a32001-08-02 04:15:00 +00003866
Tim Peters6d6c1a32001-08-02 04:15:00 +00003867static PyObject *
Guido van Rossumc8e56452001-10-22 00:43:43 +00003868wrap_init(PyObject *self, PyObject *args, void *wrapped, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003869{
3870 initproc func = (initproc)wrapped;
3871
Guido van Rossumc8e56452001-10-22 00:43:43 +00003872 if (func(self, args, kwds) < 0)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003873 return NULL;
3874 Py_INCREF(Py_None);
3875 return Py_None;
3876}
3877
Tim Peters6d6c1a32001-08-02 04:15:00 +00003878static PyObject *
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003879tp_new_wrapper(PyObject *self, PyObject *args, PyObject *kwds)
Tim Peters6d6c1a32001-08-02 04:15:00 +00003880{
Barry Warsaw60f01882001-08-22 19:24:42 +00003881 PyTypeObject *type, *subtype, *staticbase;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003882 PyObject *arg0, *res;
3883
3884 if (self == NULL || !PyType_Check(self))
3885 Py_FatalError("__new__() called with non-type 'self'");
3886 type = (PyTypeObject *)self;
3887 if (!PyTuple_Check(args) || PyTuple_GET_SIZE(args) < 1) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003888 PyErr_Format(PyExc_TypeError,
3889 "%s.__new__(): not enough arguments",
3890 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003891 return NULL;
3892 }
3893 arg0 = PyTuple_GET_ITEM(args, 0);
3894 if (!PyType_Check(arg0)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003895 PyErr_Format(PyExc_TypeError,
3896 "%s.__new__(X): X is not a type object (%s)",
3897 type->tp_name,
3898 arg0->ob_type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003899 return NULL;
3900 }
3901 subtype = (PyTypeObject *)arg0;
3902 if (!PyType_IsSubtype(subtype, type)) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003903 PyErr_Format(PyExc_TypeError,
3904 "%s.__new__(%s): %s is not a subtype of %s",
3905 type->tp_name,
3906 subtype->tp_name,
3907 subtype->tp_name,
3908 type->tp_name);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003909 return NULL;
3910 }
Barry Warsaw60f01882001-08-22 19:24:42 +00003911
3912 /* Check that the use doesn't do something silly and unsafe like
Tim Petersa427a2b2001-10-29 22:25:45 +00003913 object.__new__(dict). To do this, we check that the
Barry Warsaw60f01882001-08-22 19:24:42 +00003914 most derived base that's not a heap type is this type. */
3915 staticbase = subtype;
3916 while (staticbase && (staticbase->tp_flags & Py_TPFLAGS_HEAPTYPE))
3917 staticbase = staticbase->tp_base;
Guido van Rossuma8c60f42001-09-14 19:43:36 +00003918 if (staticbase->tp_new != type->tp_new) {
Barry Warsaw60f01882001-08-22 19:24:42 +00003919 PyErr_Format(PyExc_TypeError,
3920 "%s.__new__(%s) is not safe, use %s.__new__()",
3921 type->tp_name,
3922 subtype->tp_name,
3923 staticbase == NULL ? "?" : staticbase->tp_name);
3924 return NULL;
3925 }
3926
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003927 args = PyTuple_GetSlice(args, 1, PyTuple_GET_SIZE(args));
3928 if (args == NULL)
3929 return NULL;
3930 res = type->tp_new(subtype, args, kwds);
3931 Py_DECREF(args);
3932 return res;
Tim Peters6d6c1a32001-08-02 04:15:00 +00003933}
3934
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003935static struct PyMethodDef tp_new_methoddef[] = {
3936 {"__new__", (PyCFunction)tp_new_wrapper, METH_KEYWORDS,
Neal Norwitz5dc2a372002-08-13 22:19:13 +00003937 PyDoc_STR("T.__new__(S, ...) -> "
3938 "a new object with type S, a subtype of T")},
Tim Peters6d6c1a32001-08-02 04:15:00 +00003939 {0}
3940};
3941
3942static int
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003943add_tp_new_wrapper(PyTypeObject *type)
3944{
Guido van Rossumf040ede2001-08-07 16:40:56 +00003945 PyObject *func;
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003946
Guido van Rossum687ae002001-10-15 22:03:32 +00003947 if (PyDict_GetItemString(type->tp_dict, "__new__") != NULL)
Guido van Rossumf040ede2001-08-07 16:40:56 +00003948 return 0;
3949 func = PyCFunction_New(tp_new_methoddef, (PyObject *)type);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003950 if (func == NULL)
3951 return -1;
Guido van Rossum687ae002001-10-15 22:03:32 +00003952 return PyDict_SetItemString(type->tp_dict, "__new__", func);
Guido van Rossum0d231ed2001-08-06 16:50:37 +00003953}
3954
Guido van Rossumf040ede2001-08-07 16:40:56 +00003955/* Slot wrappers that call the corresponding __foo__ slot. See comments
3956 below at override_slots() for more explanation. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00003957
Guido van Rossumdc91b992001-08-08 22:26:22 +00003958#define SLOT0(FUNCNAME, OPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003959static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003960FUNCNAME(PyObject *self) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003961{ \
Guido van Rossum5592e4d2001-08-28 18:28:21 +00003962 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003963 return call_method(self, OPSTR, &cache_str, "()"); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003964}
3965
Guido van Rossumdc91b992001-08-08 22:26:22 +00003966#define SLOT1(FUNCNAME, OPSTR, ARG1TYPE, ARGCODES) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003967static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00003968FUNCNAME(PyObject *self, ARG1TYPE arg1) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003969{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00003970 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00003971 return call_method(self, OPSTR, &cache_str, "(" ARGCODES ")", arg1); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00003972}
3973
Guido van Rossumcd118802003-01-06 22:57:47 +00003974/* Boolean helper for SLOT1BINFULL().
3975 right.__class__ is a nontrivial subclass of left.__class__. */
3976static int
3977method_is_overloaded(PyObject *left, PyObject *right, char *name)
3978{
3979 PyObject *a, *b;
3980 int ok;
3981
3982 b = PyObject_GetAttrString((PyObject *)(right->ob_type), name);
3983 if (b == NULL) {
3984 PyErr_Clear();
3985 /* If right doesn't have it, it's not overloaded */
3986 return 0;
3987 }
3988
3989 a = PyObject_GetAttrString((PyObject *)(left->ob_type), name);
3990 if (a == NULL) {
3991 PyErr_Clear();
3992 Py_DECREF(b);
3993 /* If right has it but left doesn't, it's overloaded */
3994 return 1;
3995 }
3996
3997 ok = PyObject_RichCompareBool(a, b, Py_NE);
3998 Py_DECREF(a);
3999 Py_DECREF(b);
4000 if (ok < 0) {
4001 PyErr_Clear();
4002 return 0;
4003 }
4004
4005 return ok;
4006}
4007
Guido van Rossumdc91b992001-08-08 22:26:22 +00004008
4009#define SLOT1BINFULL(FUNCNAME, TESTFUNC, SLOTNAME, OPSTR, ROPSTR) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004010static PyObject * \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004011FUNCNAME(PyObject *self, PyObject *other) \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004012{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004013 static PyObject *cache_str, *rcache_str; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004014 int do_other = self->ob_type != other->ob_type && \
4015 other->ob_type->tp_as_number != NULL && \
4016 other->ob_type->tp_as_number->SLOTNAME == TESTFUNC; \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004017 if (self->ob_type->tp_as_number != NULL && \
4018 self->ob_type->tp_as_number->SLOTNAME == TESTFUNC) { \
4019 PyObject *r; \
Guido van Rossum55f20992001-10-01 17:18:22 +00004020 if (do_other && \
Guido van Rossumcd118802003-01-06 22:57:47 +00004021 PyType_IsSubtype(other->ob_type, self->ob_type) && \
4022 method_is_overloaded(self, other, ROPSTR)) { \
Guido van Rossum55f20992001-10-01 17:18:22 +00004023 r = call_maybe( \
4024 other, ROPSTR, &rcache_str, "(O)", self); \
4025 if (r != Py_NotImplemented) \
4026 return r; \
4027 Py_DECREF(r); \
4028 do_other = 0; \
4029 } \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004030 r = call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004031 self, OPSTR, &cache_str, "(O)", other); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004032 if (r != Py_NotImplemented || \
4033 other->ob_type == self->ob_type) \
4034 return r; \
4035 Py_DECREF(r); \
4036 } \
Guido van Rossum55f20992001-10-01 17:18:22 +00004037 if (do_other) { \
Guido van Rossumf21c6be2001-09-14 17:51:50 +00004038 return call_maybe( \
Guido van Rossum717ce002001-09-14 16:58:08 +00004039 other, ROPSTR, &rcache_str, "(O)", self); \
Guido van Rossumdc91b992001-08-08 22:26:22 +00004040 } \
4041 Py_INCREF(Py_NotImplemented); \
4042 return Py_NotImplemented; \
4043}
4044
4045#define SLOT1BIN(FUNCNAME, SLOTNAME, OPSTR, ROPSTR) \
4046 SLOT1BINFULL(FUNCNAME, FUNCNAME, SLOTNAME, OPSTR, ROPSTR)
4047
4048#define SLOT2(FUNCNAME, OPSTR, ARG1TYPE, ARG2TYPE, ARGCODES) \
4049static PyObject * \
4050FUNCNAME(PyObject *self, ARG1TYPE arg1, ARG2TYPE arg2) \
4051{ \
Guido van Rossum2730b132001-08-28 18:22:14 +00004052 static PyObject *cache_str; \
Guido van Rossum717ce002001-09-14 16:58:08 +00004053 return call_method(self, OPSTR, &cache_str, \
4054 "(" ARGCODES ")", arg1, arg2); \
Tim Peters6d6c1a32001-08-02 04:15:00 +00004055}
4056
4057static int
4058slot_sq_length(PyObject *self)
4059{
Guido van Rossum2730b132001-08-28 18:22:14 +00004060 static PyObject *len_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004061 PyObject *res = call_method(self, "__len__", &len_str, "()");
Guido van Rossum26111622001-10-01 16:42:49 +00004062 int len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004063
4064 if (res == NULL)
4065 return -1;
Guido van Rossum26111622001-10-01 16:42:49 +00004066 len = (int)PyInt_AsLong(res);
4067 Py_DECREF(res);
Jeremy Hylton73a088e2002-07-25 16:43:29 +00004068 if (len == -1 && PyErr_Occurred())
4069 return -1;
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004070 if (len < 0) {
Guido van Rossum22b13872002-08-06 21:41:44 +00004071 PyErr_SetString(PyExc_ValueError,
Jeremy Hyltonf20fcf92002-07-25 16:06:15 +00004072 "__len__() should return >= 0");
4073 return -1;
4074 }
Guido van Rossum26111622001-10-01 16:42:49 +00004075 return len;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004076}
4077
Guido van Rossumdc91b992001-08-08 22:26:22 +00004078SLOT1(slot_sq_concat, "__add__", PyObject *, "O")
4079SLOT1(slot_sq_repeat, "__mul__", int, "i")
Guido van Rossumf4593e02001-10-03 12:09:30 +00004080
4081/* Super-optimized version of slot_sq_item.
4082 Other slots could do the same... */
4083static PyObject *
4084slot_sq_item(PyObject *self, int i)
4085{
4086 static PyObject *getitem_str;
4087 PyObject *func, *args = NULL, *ival = NULL, *retval = NULL;
4088 descrgetfunc f;
4089
4090 if (getitem_str == NULL) {
4091 getitem_str = PyString_InternFromString("__getitem__");
4092 if (getitem_str == NULL)
4093 return NULL;
4094 }
4095 func = _PyType_Lookup(self->ob_type, getitem_str);
4096 if (func != NULL) {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004097 if ((f = func->ob_type->tp_descr_get) == NULL)
4098 Py_INCREF(func);
Neal Norwitz673cd822002-10-18 16:33:13 +00004099 else {
Guido van Rossumf4593e02001-10-03 12:09:30 +00004100 func = f(func, self, (PyObject *)(self->ob_type));
Neal Norwitz673cd822002-10-18 16:33:13 +00004101 if (func == NULL) {
4102 return NULL;
4103 }
4104 }
Guido van Rossumf4593e02001-10-03 12:09:30 +00004105 ival = PyInt_FromLong(i);
4106 if (ival != NULL) {
4107 args = PyTuple_New(1);
4108 if (args != NULL) {
4109 PyTuple_SET_ITEM(args, 0, ival);
4110 retval = PyObject_Call(func, args, NULL);
4111 Py_XDECREF(args);
4112 Py_XDECREF(func);
4113 return retval;
4114 }
4115 }
4116 }
4117 else {
4118 PyErr_SetObject(PyExc_AttributeError, getitem_str);
4119 }
4120 Py_XDECREF(args);
4121 Py_XDECREF(ival);
4122 Py_XDECREF(func);
4123 return NULL;
4124}
4125
Guido van Rossumdc91b992001-08-08 22:26:22 +00004126SLOT2(slot_sq_slice, "__getslice__", int, int, "ii")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004127
4128static int
4129slot_sq_ass_item(PyObject *self, int index, PyObject *value)
4130{
4131 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004132 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004133
4134 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004135 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004136 "(i)", index);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004137 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004138 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004139 "(iO)", index, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004140 if (res == NULL)
4141 return -1;
4142 Py_DECREF(res);
4143 return 0;
4144}
4145
4146static int
4147slot_sq_ass_slice(PyObject *self, int i, int j, PyObject *value)
4148{
4149 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004150 static PyObject *delslice_str, *setslice_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004151
4152 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004153 res = call_method(self, "__delslice__", &delslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004154 "(ii)", i, j);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004155 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004156 res = call_method(self, "__setslice__", &setslice_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004157 "(iiO)", i, j, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004158 if (res == NULL)
4159 return -1;
4160 Py_DECREF(res);
4161 return 0;
4162}
4163
4164static int
4165slot_sq_contains(PyObject *self, PyObject *value)
4166{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004167 PyObject *func, *res, *args;
Tim Petersbf9b2442003-03-23 05:35:36 +00004168 int result = -1;
4169
Guido van Rossum60718732001-08-28 17:47:51 +00004170 static PyObject *contains_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004171
Guido van Rossum55f20992001-10-01 17:18:22 +00004172 func = lookup_maybe(self, "__contains__", &contains_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004173 if (func != NULL) {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004174 args = PyTuple_Pack(1, value);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004175 if (args == NULL)
4176 res = NULL;
4177 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004178 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004179 Py_DECREF(args);
4180 }
4181 Py_DECREF(func);
Tim Petersbf9b2442003-03-23 05:35:36 +00004182 if (res != NULL) {
4183 result = PyObject_IsTrue(res);
4184 Py_DECREF(res);
4185 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004186 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004187 else if (! PyErr_Occurred()) {
4188 result = _PySequence_IterSearch(self, value,
4189 PY_ITERSEARCH_CONTAINS);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004190 }
Tim Petersbf9b2442003-03-23 05:35:36 +00004191 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004192}
4193
Guido van Rossumdc91b992001-08-08 22:26:22 +00004194SLOT1(slot_sq_inplace_concat, "__iadd__", PyObject *, "O")
4195SLOT1(slot_sq_inplace_repeat, "__imul__", int, "i")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004196
4197#define slot_mp_length slot_sq_length
4198
Guido van Rossumdc91b992001-08-08 22:26:22 +00004199SLOT1(slot_mp_subscript, "__getitem__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004200
4201static int
4202slot_mp_ass_subscript(PyObject *self, PyObject *key, PyObject *value)
4203{
4204 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004205 static PyObject *delitem_str, *setitem_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004206
4207 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004208 res = call_method(self, "__delitem__", &delitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004209 "(O)", key);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004210 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004211 res = call_method(self, "__setitem__", &setitem_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004212 "(OO)", key, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004213 if (res == NULL)
4214 return -1;
4215 Py_DECREF(res);
4216 return 0;
4217}
4218
Guido van Rossumdc91b992001-08-08 22:26:22 +00004219SLOT1BIN(slot_nb_add, nb_add, "__add__", "__radd__")
4220SLOT1BIN(slot_nb_subtract, nb_subtract, "__sub__", "__rsub__")
4221SLOT1BIN(slot_nb_multiply, nb_multiply, "__mul__", "__rmul__")
4222SLOT1BIN(slot_nb_divide, nb_divide, "__div__", "__rdiv__")
4223SLOT1BIN(slot_nb_remainder, nb_remainder, "__mod__", "__rmod__")
4224SLOT1BIN(slot_nb_divmod, nb_divmod, "__divmod__", "__rdivmod__")
4225
Jeremy Hylton938ace62002-07-17 16:30:39 +00004226static PyObject *slot_nb_power(PyObject *, PyObject *, PyObject *);
Guido van Rossumdc91b992001-08-08 22:26:22 +00004227
4228SLOT1BINFULL(slot_nb_power_binary, slot_nb_power,
4229 nb_power, "__pow__", "__rpow__")
4230
4231static PyObject *
4232slot_nb_power(PyObject *self, PyObject *other, PyObject *modulus)
4233{
Guido van Rossum2730b132001-08-28 18:22:14 +00004234 static PyObject *pow_str;
4235
Guido van Rossumdc91b992001-08-08 22:26:22 +00004236 if (modulus == Py_None)
4237 return slot_nb_power_binary(self, other);
Guido van Rossum23094982002-06-10 14:30:43 +00004238 /* Three-arg power doesn't use __rpow__. But ternary_op
4239 can call this when the second argument's type uses
4240 slot_nb_power, so check before calling self.__pow__. */
4241 if (self->ob_type->tp_as_number != NULL &&
4242 self->ob_type->tp_as_number->nb_power == slot_nb_power) {
4243 return call_method(self, "__pow__", &pow_str,
4244 "(OO)", other, modulus);
4245 }
4246 Py_INCREF(Py_NotImplemented);
4247 return Py_NotImplemented;
Guido van Rossumdc91b992001-08-08 22:26:22 +00004248}
4249
4250SLOT0(slot_nb_negative, "__neg__")
4251SLOT0(slot_nb_positive, "__pos__")
4252SLOT0(slot_nb_absolute, "__abs__")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004253
4254static int
4255slot_nb_nonzero(PyObject *self)
4256{
Tim Petersea7f75d2002-12-07 21:39:16 +00004257 PyObject *func, *args;
Guido van Rossum60718732001-08-28 17:47:51 +00004258 static PyObject *nonzero_str, *len_str;
Tim Petersea7f75d2002-12-07 21:39:16 +00004259 int result = -1;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004260
Guido van Rossum55f20992001-10-01 17:18:22 +00004261 func = lookup_maybe(self, "__nonzero__", &nonzero_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004262 if (func == NULL) {
Guido van Rossum55f20992001-10-01 17:18:22 +00004263 if (PyErr_Occurred())
Guido van Rossumb8f63662001-08-15 23:57:02 +00004264 return -1;
Guido van Rossum55f20992001-10-01 17:18:22 +00004265 func = lookup_maybe(self, "__len__", &len_str);
Tim Petersea7f75d2002-12-07 21:39:16 +00004266 if (func == NULL)
4267 return PyErr_Occurred() ? -1 : 1;
4268 }
4269 args = PyTuple_New(0);
4270 if (args != NULL) {
4271 PyObject *temp = PyObject_Call(func, args, NULL);
4272 Py_DECREF(args);
4273 if (temp != NULL) {
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004274 if (PyInt_CheckExact(temp) || PyBool_Check(temp))
Jeremy Hylton090a3492003-06-27 16:46:45 +00004275 result = PyObject_IsTrue(temp);
4276 else {
4277 PyErr_Format(PyExc_TypeError,
4278 "__nonzero__ should return "
4279 "bool or int, returned %s",
4280 temp->ob_type->tp_name);
Jeremy Hylton3e3159c2003-06-27 17:38:27 +00004281 result = -1;
Jeremy Hylton090a3492003-06-27 16:46:45 +00004282 }
Tim Petersea7f75d2002-12-07 21:39:16 +00004283 Py_DECREF(temp);
Guido van Rossum55f20992001-10-01 17:18:22 +00004284 }
Guido van Rossumb8f63662001-08-15 23:57:02 +00004285 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004286 Py_DECREF(func);
Tim Petersea7f75d2002-12-07 21:39:16 +00004287 return result;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004288}
4289
Guido van Rossumdc91b992001-08-08 22:26:22 +00004290SLOT0(slot_nb_invert, "__invert__")
4291SLOT1BIN(slot_nb_lshift, nb_lshift, "__lshift__", "__rlshift__")
4292SLOT1BIN(slot_nb_rshift, nb_rshift, "__rshift__", "__rrshift__")
4293SLOT1BIN(slot_nb_and, nb_and, "__and__", "__rand__")
4294SLOT1BIN(slot_nb_xor, nb_xor, "__xor__", "__rxor__")
4295SLOT1BIN(slot_nb_or, nb_or, "__or__", "__ror__")
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004296
4297static int
4298slot_nb_coerce(PyObject **a, PyObject **b)
4299{
4300 static PyObject *coerce_str;
4301 PyObject *self = *a, *other = *b;
4302
4303 if (self->ob_type->tp_as_number != NULL &&
4304 self->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4305 PyObject *r;
4306 r = call_maybe(
4307 self, "__coerce__", &coerce_str, "(O)", other);
4308 if (r == NULL)
4309 return -1;
4310 if (r == Py_NotImplemented) {
4311 Py_DECREF(r);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004312 }
Guido van Rossum55f20992001-10-01 17:18:22 +00004313 else {
4314 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4315 PyErr_SetString(PyExc_TypeError,
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004316 "__coerce__ didn't return a 2-tuple");
Guido van Rossum55f20992001-10-01 17:18:22 +00004317 Py_DECREF(r);
4318 return -1;
4319 }
4320 *a = PyTuple_GET_ITEM(r, 0);
4321 Py_INCREF(*a);
4322 *b = PyTuple_GET_ITEM(r, 1);
4323 Py_INCREF(*b);
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004324 Py_DECREF(r);
Guido van Rossum55f20992001-10-01 17:18:22 +00004325 return 0;
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004326 }
Guido van Rossum2ed6bf82001-09-27 20:30:07 +00004327 }
4328 if (other->ob_type->tp_as_number != NULL &&
4329 other->ob_type->tp_as_number->nb_coerce == slot_nb_coerce) {
4330 PyObject *r;
4331 r = call_maybe(
4332 other, "__coerce__", &coerce_str, "(O)", self);
4333 if (r == NULL)
4334 return -1;
4335 if (r == Py_NotImplemented) {
4336 Py_DECREF(r);
4337 return 1;
4338 }
4339 if (!PyTuple_Check(r) || PyTuple_GET_SIZE(r) != 2) {
4340 PyErr_SetString(PyExc_TypeError,
4341 "__coerce__ didn't return a 2-tuple");
4342 Py_DECREF(r);
4343 return -1;
4344 }
4345 *a = PyTuple_GET_ITEM(r, 1);
4346 Py_INCREF(*a);
4347 *b = PyTuple_GET_ITEM(r, 0);
4348 Py_INCREF(*b);
4349 Py_DECREF(r);
4350 return 0;
4351 }
4352 return 1;
4353}
4354
Guido van Rossumdc91b992001-08-08 22:26:22 +00004355SLOT0(slot_nb_int, "__int__")
4356SLOT0(slot_nb_long, "__long__")
4357SLOT0(slot_nb_float, "__float__")
4358SLOT0(slot_nb_oct, "__oct__")
4359SLOT0(slot_nb_hex, "__hex__")
4360SLOT1(slot_nb_inplace_add, "__iadd__", PyObject *, "O")
4361SLOT1(slot_nb_inplace_subtract, "__isub__", PyObject *, "O")
4362SLOT1(slot_nb_inplace_multiply, "__imul__", PyObject *, "O")
4363SLOT1(slot_nb_inplace_divide, "__idiv__", PyObject *, "O")
4364SLOT1(slot_nb_inplace_remainder, "__imod__", PyObject *, "O")
Guido van Rossum6e5680f2002-10-15 01:01:53 +00004365SLOT1(slot_nb_inplace_power, "__ipow__", PyObject *, "O")
Guido van Rossumdc91b992001-08-08 22:26:22 +00004366SLOT1(slot_nb_inplace_lshift, "__ilshift__", PyObject *, "O")
4367SLOT1(slot_nb_inplace_rshift, "__irshift__", PyObject *, "O")
4368SLOT1(slot_nb_inplace_and, "__iand__", PyObject *, "O")
4369SLOT1(slot_nb_inplace_xor, "__ixor__", PyObject *, "O")
4370SLOT1(slot_nb_inplace_or, "__ior__", PyObject *, "O")
4371SLOT1BIN(slot_nb_floor_divide, nb_floor_divide,
4372 "__floordiv__", "__rfloordiv__")
4373SLOT1BIN(slot_nb_true_divide, nb_true_divide, "__truediv__", "__rtruediv__")
4374SLOT1(slot_nb_inplace_floor_divide, "__ifloordiv__", PyObject *, "O")
4375SLOT1(slot_nb_inplace_true_divide, "__itruediv__", PyObject *, "O")
Tim Peters6d6c1a32001-08-02 04:15:00 +00004376
4377static int
Guido van Rossumb8f63662001-08-15 23:57:02 +00004378half_compare(PyObject *self, PyObject *other)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004379{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004380 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004381 static PyObject *cmp_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004382 int c;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004383
Guido van Rossum60718732001-08-28 17:47:51 +00004384 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004385 if (func == NULL) {
4386 PyErr_Clear();
4387 }
4388 else {
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004389 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004390 if (args == NULL)
4391 res = NULL;
4392 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004393 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004394 Py_DECREF(args);
4395 }
Raymond Hettingerab5dae32002-06-24 13:08:16 +00004396 Py_DECREF(func);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004397 if (res != Py_NotImplemented) {
4398 if (res == NULL)
4399 return -2;
4400 c = PyInt_AsLong(res);
4401 Py_DECREF(res);
4402 if (c == -1 && PyErr_Occurred())
4403 return -2;
4404 return (c < 0) ? -1 : (c > 0) ? 1 : 0;
4405 }
4406 Py_DECREF(res);
4407 }
4408 return 2;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004409}
4410
Guido van Rossumab3b0342001-09-18 20:38:53 +00004411/* This slot is published for the benefit of try_3way_compare in object.c */
4412int
4413_PyObject_SlotCompare(PyObject *self, PyObject *other)
Guido van Rossumb8f63662001-08-15 23:57:02 +00004414{
4415 int c;
4416
Guido van Rossumab3b0342001-09-18 20:38:53 +00004417 if (self->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004418 c = half_compare(self, other);
4419 if (c <= 1)
4420 return c;
4421 }
Guido van Rossumab3b0342001-09-18 20:38:53 +00004422 if (other->ob_type->tp_compare == _PyObject_SlotCompare) {
Guido van Rossumb8f63662001-08-15 23:57:02 +00004423 c = half_compare(other, self);
4424 if (c < -1)
4425 return -2;
4426 if (c <= 1)
4427 return -c;
4428 }
4429 return (void *)self < (void *)other ? -1 :
4430 (void *)self > (void *)other ? 1 : 0;
4431}
4432
4433static PyObject *
4434slot_tp_repr(PyObject *self)
4435{
4436 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004437 static PyObject *repr_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004438
Guido van Rossum60718732001-08-28 17:47:51 +00004439 func = lookup_method(self, "__repr__", &repr_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004440 if (func != NULL) {
4441 res = PyEval_CallObject(func, NULL);
4442 Py_DECREF(func);
4443 return res;
4444 }
Barry Warsaw7ce36942001-08-24 18:34:26 +00004445 PyErr_Clear();
4446 return PyString_FromFormat("<%s object at %p>",
4447 self->ob_type->tp_name, self);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004448}
4449
4450static PyObject *
4451slot_tp_str(PyObject *self)
4452{
4453 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004454 static PyObject *str_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004455
Guido van Rossum60718732001-08-28 17:47:51 +00004456 func = lookup_method(self, "__str__", &str_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004457 if (func != NULL) {
4458 res = PyEval_CallObject(func, NULL);
4459 Py_DECREF(func);
4460 return res;
4461 }
4462 else {
4463 PyErr_Clear();
4464 return slot_tp_repr(self);
4465 }
4466}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004467
4468static long
4469slot_tp_hash(PyObject *self)
4470{
Tim Peters61ce0a92002-12-06 23:38:02 +00004471 PyObject *func;
Guido van Rossum60718732001-08-28 17:47:51 +00004472 static PyObject *hash_str, *eq_str, *cmp_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004473 long h;
4474
Guido van Rossum60718732001-08-28 17:47:51 +00004475 func = lookup_method(self, "__hash__", &hash_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004476
4477 if (func != NULL) {
Tim Peters61ce0a92002-12-06 23:38:02 +00004478 PyObject *res = PyEval_CallObject(func, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004479 Py_DECREF(func);
4480 if (res == NULL)
4481 return -1;
4482 h = PyInt_AsLong(res);
Tim Peters61ce0a92002-12-06 23:38:02 +00004483 Py_DECREF(res);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004484 }
4485 else {
4486 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004487 func = lookup_method(self, "__eq__", &eq_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004488 if (func == NULL) {
4489 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004490 func = lookup_method(self, "__cmp__", &cmp_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004491 }
4492 if (func != NULL) {
4493 Py_DECREF(func);
4494 PyErr_SetString(PyExc_TypeError, "unhashable type");
4495 return -1;
4496 }
4497 PyErr_Clear();
4498 h = _Py_HashPointer((void *)self);
4499 }
Tim Peters6d6c1a32001-08-02 04:15:00 +00004500 if (h == -1 && !PyErr_Occurred())
4501 h = -2;
4502 return h;
4503}
4504
4505static PyObject *
4506slot_tp_call(PyObject *self, PyObject *args, PyObject *kwds)
4507{
Guido van Rossum60718732001-08-28 17:47:51 +00004508 static PyObject *call_str;
4509 PyObject *meth = lookup_method(self, "__call__", &call_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004510 PyObject *res;
4511
4512 if (meth == NULL)
4513 return NULL;
4514 res = PyObject_Call(meth, args, kwds);
4515 Py_DECREF(meth);
4516 return res;
4517}
4518
Guido van Rossum14a6f832001-10-17 13:59:09 +00004519/* There are two slot dispatch functions for tp_getattro.
4520
4521 - slot_tp_getattro() is used when __getattribute__ is overridden
4522 but no __getattr__ hook is present;
4523
4524 - slot_tp_getattr_hook() is used when a __getattr__ hook is present.
4525
Guido van Rossumc334df52002-04-04 23:44:47 +00004526 The code in update_one_slot() always installs slot_tp_getattr_hook(); this
4527 detects the absence of __getattr__ and then installs the simpler slot if
4528 necessary. */
Guido van Rossum14a6f832001-10-17 13:59:09 +00004529
Tim Peters6d6c1a32001-08-02 04:15:00 +00004530static PyObject *
4531slot_tp_getattro(PyObject *self, PyObject *name)
4532{
Guido van Rossum14a6f832001-10-17 13:59:09 +00004533 static PyObject *getattribute_str = NULL;
4534 return call_method(self, "__getattribute__", &getattribute_str,
4535 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004536}
4537
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004538static PyObject *
4539slot_tp_getattr_hook(PyObject *self, PyObject *name)
4540{
4541 PyTypeObject *tp = self->ob_type;
4542 PyObject *getattr, *getattribute, *res;
4543 static PyObject *getattribute_str = NULL;
4544 static PyObject *getattr_str = NULL;
4545
4546 if (getattr_str == NULL) {
4547 getattr_str = PyString_InternFromString("__getattr__");
4548 if (getattr_str == NULL)
4549 return NULL;
4550 }
4551 if (getattribute_str == NULL) {
4552 getattribute_str =
4553 PyString_InternFromString("__getattribute__");
4554 if (getattribute_str == NULL)
4555 return NULL;
4556 }
4557 getattr = _PyType_Lookup(tp, getattr_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004558 if (getattr == NULL) {
Guido van Rossumd396b9c2001-10-13 20:02:41 +00004559 /* No __getattr__ hook: use a simpler dispatcher */
4560 tp->tp_getattro = slot_tp_getattro;
4561 return slot_tp_getattro(self, name);
4562 }
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004563 getattribute = _PyType_Lookup(tp, getattribute_str);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004564 if (getattribute == NULL ||
4565 (getattribute->ob_type == &PyWrapperDescr_Type &&
4566 ((PyWrapperDescrObject *)getattribute)->d_wrapped ==
4567 (void *)PyObject_GenericGetAttr))
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004568 res = PyObject_GenericGetAttr(self, name);
4569 else
4570 res = PyObject_CallFunction(getattribute, "OO", self, name);
Guido van Rossum14a6f832001-10-17 13:59:09 +00004571 if (res == NULL && PyErr_ExceptionMatches(PyExc_AttributeError)) {
Guido van Rossum19c1cd52001-09-21 21:24:49 +00004572 PyErr_Clear();
4573 res = PyObject_CallFunction(getattr, "OO", self, name);
4574 }
4575 return res;
4576}
4577
Tim Peters6d6c1a32001-08-02 04:15:00 +00004578static int
4579slot_tp_setattro(PyObject *self, PyObject *name, PyObject *value)
4580{
4581 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004582 static PyObject *delattr_str, *setattr_str;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004583
4584 if (value == NULL)
Guido van Rossum2730b132001-08-28 18:22:14 +00004585 res = call_method(self, "__delattr__", &delattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004586 "(O)", name);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004587 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004588 res = call_method(self, "__setattr__", &setattr_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004589 "(OO)", name, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004590 if (res == NULL)
4591 return -1;
4592 Py_DECREF(res);
4593 return 0;
4594}
4595
4596/* Map rich comparison operators to their __xx__ namesakes */
4597static char *name_op[] = {
4598 "__lt__",
4599 "__le__",
4600 "__eq__",
4601 "__ne__",
4602 "__gt__",
4603 "__ge__",
4604};
4605
4606static PyObject *
Guido van Rossumb8f63662001-08-15 23:57:02 +00004607half_richcompare(PyObject *self, PyObject *other, int op)
Tim Peters6d6c1a32001-08-02 04:15:00 +00004608{
Guido van Rossumb8f63662001-08-15 23:57:02 +00004609 PyObject *func, *args, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004610 static PyObject *op_str[6];
Tim Peters6d6c1a32001-08-02 04:15:00 +00004611
Guido van Rossum60718732001-08-28 17:47:51 +00004612 func = lookup_method(self, name_op[op], &op_str[op]);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004613 if (func == NULL) {
4614 PyErr_Clear();
4615 Py_INCREF(Py_NotImplemented);
4616 return Py_NotImplemented;
4617 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00004618 args = PyTuple_Pack(1, other);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004619 if (args == NULL)
4620 res = NULL;
4621 else {
Guido van Rossum717ce002001-09-14 16:58:08 +00004622 res = PyObject_Call(func, args, NULL);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004623 Py_DECREF(args);
4624 }
4625 Py_DECREF(func);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004626 return res;
4627}
4628
Guido van Rossumb8f63662001-08-15 23:57:02 +00004629/* Map rich comparison operators to their swapped version, e.g. LT --> GT */
4630static int swapped_op[] = {Py_GT, Py_GE, Py_EQ, Py_NE, Py_LT, Py_LE};
4631
4632static PyObject *
4633slot_tp_richcompare(PyObject *self, PyObject *other, int op)
4634{
4635 PyObject *res;
4636
4637 if (self->ob_type->tp_richcompare == slot_tp_richcompare) {
4638 res = half_richcompare(self, other, op);
4639 if (res != Py_NotImplemented)
4640 return res;
4641 Py_DECREF(res);
4642 }
4643 if (other->ob_type->tp_richcompare == slot_tp_richcompare) {
4644 res = half_richcompare(other, self, swapped_op[op]);
4645 if (res != Py_NotImplemented) {
4646 return res;
4647 }
4648 Py_DECREF(res);
4649 }
4650 Py_INCREF(Py_NotImplemented);
4651 return Py_NotImplemented;
4652}
4653
4654static PyObject *
4655slot_tp_iter(PyObject *self)
4656{
4657 PyObject *func, *res;
Guido van Rossum60718732001-08-28 17:47:51 +00004658 static PyObject *iter_str, *getitem_str;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004659
Guido van Rossum60718732001-08-28 17:47:51 +00004660 func = lookup_method(self, "__iter__", &iter_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004661 if (func != NULL) {
Guido van Rossum84b2bed2002-08-16 17:01:09 +00004662 PyObject *args;
4663 args = res = PyTuple_New(0);
4664 if (args != NULL) {
4665 res = PyObject_Call(func, args, NULL);
4666 Py_DECREF(args);
4667 }
4668 Py_DECREF(func);
4669 return res;
Guido van Rossumb8f63662001-08-15 23:57:02 +00004670 }
4671 PyErr_Clear();
Guido van Rossum60718732001-08-28 17:47:51 +00004672 func = lookup_method(self, "__getitem__", &getitem_str);
Guido van Rossumb8f63662001-08-15 23:57:02 +00004673 if (func == NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00004674 PyErr_SetString(PyExc_TypeError,
4675 "iteration over non-sequence");
Guido van Rossumb8f63662001-08-15 23:57:02 +00004676 return NULL;
4677 }
4678 Py_DECREF(func);
4679 return PySeqIter_New(self);
4680}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004681
4682static PyObject *
4683slot_tp_iternext(PyObject *self)
4684{
Guido van Rossum2730b132001-08-28 18:22:14 +00004685 static PyObject *next_str;
Guido van Rossum717ce002001-09-14 16:58:08 +00004686 return call_method(self, "next", &next_str, "()");
Tim Peters6d6c1a32001-08-02 04:15:00 +00004687}
4688
Guido van Rossum1a493502001-08-17 16:47:50 +00004689static PyObject *
4690slot_tp_descr_get(PyObject *self, PyObject *obj, PyObject *type)
4691{
4692 PyTypeObject *tp = self->ob_type;
4693 PyObject *get;
4694 static PyObject *get_str = NULL;
4695
4696 if (get_str == NULL) {
4697 get_str = PyString_InternFromString("__get__");
4698 if (get_str == NULL)
4699 return NULL;
4700 }
4701 get = _PyType_Lookup(tp, get_str);
4702 if (get == NULL) {
4703 /* Avoid further slowdowns */
4704 if (tp->tp_descr_get == slot_tp_descr_get)
4705 tp->tp_descr_get = NULL;
4706 Py_INCREF(self);
4707 return self;
4708 }
Guido van Rossum2c252392001-08-24 10:13:31 +00004709 if (obj == NULL)
4710 obj = Py_None;
4711 if (type == NULL)
4712 type = Py_None;
Guido van Rossum1a493502001-08-17 16:47:50 +00004713 return PyObject_CallFunction(get, "OOO", self, obj, type);
4714}
Tim Peters6d6c1a32001-08-02 04:15:00 +00004715
4716static int
4717slot_tp_descr_set(PyObject *self, PyObject *target, PyObject *value)
4718{
Guido van Rossum2c252392001-08-24 10:13:31 +00004719 PyObject *res;
Guido van Rossum2730b132001-08-28 18:22:14 +00004720 static PyObject *del_str, *set_str;
Guido van Rossum2c252392001-08-24 10:13:31 +00004721
4722 if (value == NULL)
Guido van Rossum1d5b3f22001-12-03 00:08:33 +00004723 res = call_method(self, "__delete__", &del_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004724 "(O)", target);
Guido van Rossum2c252392001-08-24 10:13:31 +00004725 else
Guido van Rossum2730b132001-08-28 18:22:14 +00004726 res = call_method(self, "__set__", &set_str,
Guido van Rossum717ce002001-09-14 16:58:08 +00004727 "(OO)", target, value);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004728 if (res == NULL)
4729 return -1;
4730 Py_DECREF(res);
4731 return 0;
4732}
4733
4734static int
4735slot_tp_init(PyObject *self, PyObject *args, PyObject *kwds)
4736{
Guido van Rossum60718732001-08-28 17:47:51 +00004737 static PyObject *init_str;
4738 PyObject *meth = lookup_method(self, "__init__", &init_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004739 PyObject *res;
4740
4741 if (meth == NULL)
4742 return -1;
4743 res = PyObject_Call(meth, args, kwds);
4744 Py_DECREF(meth);
4745 if (res == NULL)
4746 return -1;
4747 Py_DECREF(res);
4748 return 0;
4749}
4750
4751static PyObject *
4752slot_tp_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
4753{
Guido van Rossum7bed2132002-08-08 21:57:53 +00004754 static PyObject *new_str;
4755 PyObject *func;
Tim Peters6d6c1a32001-08-02 04:15:00 +00004756 PyObject *newargs, *x;
4757 int i, n;
4758
Guido van Rossum7bed2132002-08-08 21:57:53 +00004759 if (new_str == NULL) {
4760 new_str = PyString_InternFromString("__new__");
4761 if (new_str == NULL)
4762 return NULL;
4763 }
4764 func = PyObject_GetAttr((PyObject *)type, new_str);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004765 if (func == NULL)
4766 return NULL;
4767 assert(PyTuple_Check(args));
4768 n = PyTuple_GET_SIZE(args);
4769 newargs = PyTuple_New(n+1);
4770 if (newargs == NULL)
4771 return NULL;
4772 Py_INCREF(type);
4773 PyTuple_SET_ITEM(newargs, 0, (PyObject *)type);
4774 for (i = 0; i < n; i++) {
4775 x = PyTuple_GET_ITEM(args, i);
4776 Py_INCREF(x);
4777 PyTuple_SET_ITEM(newargs, i+1, x);
4778 }
4779 x = PyObject_Call(func, newargs, kwds);
Guido van Rossum25d18072001-10-01 15:55:28 +00004780 Py_DECREF(newargs);
Tim Peters6d6c1a32001-08-02 04:15:00 +00004781 Py_DECREF(func);
4782 return x;
4783}
4784
Guido van Rossumfebd61d2002-08-08 20:55:20 +00004785static void
4786slot_tp_del(PyObject *self)
4787{
4788 static PyObject *del_str = NULL;
4789 PyObject *del, *res;
4790 PyObject *error_type, *error_value, *error_traceback;
4791
4792 /* Temporarily resurrect the object. */
4793 assert(self->ob_refcnt == 0);
4794 self->ob_refcnt = 1;
4795
4796 /* Save the current exception, if any. */
4797 PyErr_Fetch(&error_type, &error_value, &error_traceback);
4798
4799 /* Execute __del__ method, if any. */
4800 del = lookup_maybe(self, "__del__", &del_str);
4801 if (del != NULL) {
4802 res = PyEval_CallObject(del, NULL);
4803 if (res == NULL)
4804 PyErr_WriteUnraisable(del);
4805 else
4806 Py_DECREF(res);
4807 Py_DECREF(del);
4808 }
4809
4810 /* Restore the saved exception. */
4811 PyErr_Restore(error_type, error_value, error_traceback);
4812
4813 /* Undo the temporary resurrection; can't use DECREF here, it would
4814 * cause a recursive call.
4815 */
4816 assert(self->ob_refcnt > 0);
4817 if (--self->ob_refcnt == 0)
4818 return; /* this is the normal path out */
4819
4820 /* __del__ resurrected it! Make it look like the original Py_DECREF
4821 * never happened.
4822 */
4823 {
4824 int refcnt = self->ob_refcnt;
4825 _Py_NewReference(self);
4826 self->ob_refcnt = refcnt;
4827 }
4828 assert(!PyType_IS_GC(self->ob_type) ||
4829 _Py_AS_GC(self)->gc.gc_refs != _PyGC_REFS_UNTRACKED);
4830 /* If Py_REF_DEBUG, the original decref dropped _Py_RefTotal, but
4831 * _Py_NewReference bumped it again, so that's a wash.
4832 * If Py_TRACE_REFS, _Py_NewReference re-added self to the object
4833 * chain, so no more to do there either.
4834 * If COUNT_ALLOCS, the original decref bumped tp_frees, and
4835 * _Py_NewReference bumped tp_allocs: both of those need to be
4836 * undone.
4837 */
4838#ifdef COUNT_ALLOCS
4839 --self->ob_type->tp_frees;
4840 --self->ob_type->tp_allocs;
4841#endif
4842}
4843
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004844
4845/* Table mapping __foo__ names to tp_foo offsets and slot_tp_foo wrapper
Tim Petersbf9b2442003-03-23 05:35:36 +00004846 functions. The offsets here are relative to the 'PyHeapTypeObject'
Guido van Rossume5c691a2003-03-07 15:13:17 +00004847 structure, which incorporates the additional structures used for numbers,
4848 sequences and mappings.
4849 Note that multiple names may map to the same slot (e.g. __eq__,
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004850 __ne__ etc. all map to tp_richcompare) and one name may map to multiple
Guido van Rossumc334df52002-04-04 23:44:47 +00004851 slots (e.g. __str__ affects tp_str as well as tp_repr). The table is
4852 terminated with an all-zero entry. (This table is further initialized and
4853 sorted in init_slotdefs() below.) */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004854
Guido van Rossum6d204072001-10-21 00:44:31 +00004855typedef struct wrapperbase slotdef;
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004856
4857#undef TPSLOT
Guido van Rossumc8e56452001-10-22 00:43:43 +00004858#undef FLSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004859#undef ETSLOT
4860#undef SQSLOT
4861#undef MPSLOT
4862#undef NBSLOT
Guido van Rossum6d204072001-10-21 00:44:31 +00004863#undef UNSLOT
4864#undef IBSLOT
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004865#undef BINSLOT
4866#undef RBINSLOT
4867
Guido van Rossum6d204072001-10-21 00:44:31 +00004868#define TPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004869 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
4870 PyDoc_STR(DOC)}
Guido van Rossumc8e56452001-10-22 00:43:43 +00004871#define FLSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC, FLAGS) \
4872 {NAME, offsetof(PyTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004873 PyDoc_STR(DOC), FLAGS}
Guido van Rossum6d204072001-10-21 00:44:31 +00004874#define ETSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
Guido van Rossume5c691a2003-03-07 15:13:17 +00004875 {NAME, offsetof(PyHeapTypeObject, SLOT), (void *)(FUNCTION), WRAPPER, \
Neal Norwitzd47714a2002-08-13 19:01:38 +00004876 PyDoc_STR(DOC)}
Guido van Rossum6d204072001-10-21 00:44:31 +00004877#define SQSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4878 ETSLOT(NAME, as_sequence.SLOT, FUNCTION, WRAPPER, DOC)
4879#define MPSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4880 ETSLOT(NAME, as_mapping.SLOT, FUNCTION, WRAPPER, DOC)
4881#define NBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4882 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, DOC)
4883#define UNSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4884 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4885 "x." NAME "() <==> " DOC)
4886#define IBSLOT(NAME, SLOT, FUNCTION, WRAPPER, DOC) \
4887 ETSLOT(NAME, as_number.SLOT, FUNCTION, WRAPPER, \
4888 "x." NAME "(y) <==> x" DOC "y")
4889#define BINSLOT(NAME, SLOT, FUNCTION, DOC) \
4890 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_l, \
4891 "x." NAME "(y) <==> x" DOC "y")
4892#define RBINSLOT(NAME, SLOT, FUNCTION, DOC) \
4893 ETSLOT(NAME, as_number.SLOT, FUNCTION, wrap_binaryfunc_r, \
4894 "x." NAME "(y) <==> y" DOC "x")
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004895
4896static slotdef slotdefs[] = {
Guido van Rossum6d204072001-10-21 00:44:31 +00004897 SQSLOT("__len__", sq_length, slot_sq_length, wrap_inquiry,
4898 "x.__len__() <==> len(x)"),
4899 SQSLOT("__add__", sq_concat, slot_sq_concat, wrap_binaryfunc,
4900 "x.__add__(y) <==> x+y"),
4901 SQSLOT("__mul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4902 "x.__mul__(n) <==> x*n"),
4903 SQSLOT("__rmul__", sq_repeat, slot_sq_repeat, wrap_intargfunc,
4904 "x.__rmul__(n) <==> n*x"),
4905 SQSLOT("__getitem__", sq_item, slot_sq_item, wrap_sq_item,
4906 "x.__getitem__(y) <==> x[y]"),
4907 SQSLOT("__getslice__", sq_slice, slot_sq_slice, wrap_intintargfunc,
Brett Cannon154da9b2003-05-20 02:30:04 +00004908 "x.__getslice__(i, j) <==> x[i:j]\n\
4909 \n\
4910 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004911 SQSLOT("__setitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_setitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004912 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum6d204072001-10-21 00:44:31 +00004913 SQSLOT("__delitem__", sq_ass_item, slot_sq_ass_item, wrap_sq_delitem,
Brett Cannonbe67d872003-05-20 02:40:12 +00004914 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004915 SQSLOT("__setslice__", sq_ass_slice, slot_sq_ass_slice,
Guido van Rossum6d204072001-10-21 00:44:31 +00004916 wrap_intintobjargproc,
Brett Cannonbe67d872003-05-20 02:40:12 +00004917 "x.__setslice__(i, j, y) <==> x[i:j]=y\n\
4918 \n\
4919 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004920 SQSLOT("__delslice__", sq_ass_slice, slot_sq_ass_slice, wrap_delslice,
Brett Cannonbe67d872003-05-20 02:40:12 +00004921 "x.__delslice__(i, j) <==> del x[i:j]\n\
4922 \n\
4923 Use of negative indices is not supported."),
Guido van Rossum6d204072001-10-21 00:44:31 +00004924 SQSLOT("__contains__", sq_contains, slot_sq_contains, wrap_objobjproc,
4925 "x.__contains__(y) <==> y in x"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004926 SQSLOT("__iadd__", sq_inplace_concat, slot_sq_inplace_concat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004927 wrap_binaryfunc, "x.__iadd__(y) <==> x+=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004928 SQSLOT("__imul__", sq_inplace_repeat, slot_sq_inplace_repeat,
Guido van Rossum6d204072001-10-21 00:44:31 +00004929 wrap_intargfunc, "x.__imul__(y) <==> x*=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004930
Guido van Rossum6d204072001-10-21 00:44:31 +00004931 MPSLOT("__len__", mp_length, slot_mp_length, wrap_inquiry,
4932 "x.__len__() <==> len(x)"),
Guido van Rossumfd38f8e2001-10-09 20:17:57 +00004933 MPSLOT("__getitem__", mp_subscript, slot_mp_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004934 wrap_binaryfunc,
4935 "x.__getitem__(y) <==> x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004936 MPSLOT("__setitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004937 wrap_objobjargproc,
4938 "x.__setitem__(i, y) <==> x[i]=y"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004939 MPSLOT("__delitem__", mp_ass_subscript, slot_mp_ass_subscript,
Guido van Rossum6d204072001-10-21 00:44:31 +00004940 wrap_delitem,
4941 "x.__delitem__(y) <==> del x[y]"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00004942
Guido van Rossum6d204072001-10-21 00:44:31 +00004943 BINSLOT("__add__", nb_add, slot_nb_add,
4944 "+"),
4945 RBINSLOT("__radd__", nb_add, slot_nb_add,
4946 "+"),
4947 BINSLOT("__sub__", nb_subtract, slot_nb_subtract,
4948 "-"),
4949 RBINSLOT("__rsub__", nb_subtract, slot_nb_subtract,
4950 "-"),
4951 BINSLOT("__mul__", nb_multiply, slot_nb_multiply,
4952 "*"),
4953 RBINSLOT("__rmul__", nb_multiply, slot_nb_multiply,
4954 "*"),
4955 BINSLOT("__div__", nb_divide, slot_nb_divide,
4956 "/"),
4957 RBINSLOT("__rdiv__", nb_divide, slot_nb_divide,
4958 "/"),
4959 BINSLOT("__mod__", nb_remainder, slot_nb_remainder,
4960 "%"),
4961 RBINSLOT("__rmod__", nb_remainder, slot_nb_remainder,
4962 "%"),
4963 BINSLOT("__divmod__", nb_divmod, slot_nb_divmod,
4964 "divmod(x, y)"),
4965 RBINSLOT("__rdivmod__", nb_divmod, slot_nb_divmod,
4966 "divmod(y, x)"),
4967 NBSLOT("__pow__", nb_power, slot_nb_power, wrap_ternaryfunc,
4968 "x.__pow__(y[, z]) <==> pow(x, y[, z])"),
4969 NBSLOT("__rpow__", nb_power, slot_nb_power, wrap_ternaryfunc_r,
4970 "y.__rpow__(x[, z]) <==> pow(x, y[, z])"),
4971 UNSLOT("__neg__", nb_negative, slot_nb_negative, wrap_unaryfunc, "-x"),
4972 UNSLOT("__pos__", nb_positive, slot_nb_positive, wrap_unaryfunc, "+x"),
4973 UNSLOT("__abs__", nb_absolute, slot_nb_absolute, wrap_unaryfunc,
4974 "abs(x)"),
Raymond Hettingerf34f2642003-10-11 17:29:04 +00004975 UNSLOT("__nonzero__", nb_nonzero, slot_nb_nonzero, wrap_inquirypred,
Guido van Rossum6d204072001-10-21 00:44:31 +00004976 "x != 0"),
4977 UNSLOT("__invert__", nb_invert, slot_nb_invert, wrap_unaryfunc, "~x"),
4978 BINSLOT("__lshift__", nb_lshift, slot_nb_lshift, "<<"),
4979 RBINSLOT("__rlshift__", nb_lshift, slot_nb_lshift, "<<"),
4980 BINSLOT("__rshift__", nb_rshift, slot_nb_rshift, ">>"),
4981 RBINSLOT("__rrshift__", nb_rshift, slot_nb_rshift, ">>"),
4982 BINSLOT("__and__", nb_and, slot_nb_and, "&"),
4983 RBINSLOT("__rand__", nb_and, slot_nb_and, "&"),
4984 BINSLOT("__xor__", nb_xor, slot_nb_xor, "^"),
4985 RBINSLOT("__rxor__", nb_xor, slot_nb_xor, "^"),
4986 BINSLOT("__or__", nb_or, slot_nb_or, "|"),
4987 RBINSLOT("__ror__", nb_or, slot_nb_or, "|"),
4988 NBSLOT("__coerce__", nb_coerce, slot_nb_coerce, wrap_coercefunc,
4989 "x.__coerce__(y) <==> coerce(x, y)"),
4990 UNSLOT("__int__", nb_int, slot_nb_int, wrap_unaryfunc,
4991 "int(x)"),
4992 UNSLOT("__long__", nb_long, slot_nb_long, wrap_unaryfunc,
4993 "long(x)"),
4994 UNSLOT("__float__", nb_float, slot_nb_float, wrap_unaryfunc,
4995 "float(x)"),
4996 UNSLOT("__oct__", nb_oct, slot_nb_oct, wrap_unaryfunc,
4997 "oct(x)"),
4998 UNSLOT("__hex__", nb_hex, slot_nb_hex, wrap_unaryfunc,
4999 "hex(x)"),
5000 IBSLOT("__iadd__", nb_inplace_add, slot_nb_inplace_add,
5001 wrap_binaryfunc, "+"),
5002 IBSLOT("__isub__", nb_inplace_subtract, slot_nb_inplace_subtract,
5003 wrap_binaryfunc, "-"),
5004 IBSLOT("__imul__", nb_inplace_multiply, slot_nb_inplace_multiply,
5005 wrap_binaryfunc, "*"),
5006 IBSLOT("__idiv__", nb_inplace_divide, slot_nb_inplace_divide,
5007 wrap_binaryfunc, "/"),
5008 IBSLOT("__imod__", nb_inplace_remainder, slot_nb_inplace_remainder,
5009 wrap_binaryfunc, "%"),
5010 IBSLOT("__ipow__", nb_inplace_power, slot_nb_inplace_power,
Guido van Rossum6e5680f2002-10-15 01:01:53 +00005011 wrap_binaryfunc, "**"),
Guido van Rossum6d204072001-10-21 00:44:31 +00005012 IBSLOT("__ilshift__", nb_inplace_lshift, slot_nb_inplace_lshift,
5013 wrap_binaryfunc, "<<"),
5014 IBSLOT("__irshift__", nb_inplace_rshift, slot_nb_inplace_rshift,
5015 wrap_binaryfunc, ">>"),
5016 IBSLOT("__iand__", nb_inplace_and, slot_nb_inplace_and,
5017 wrap_binaryfunc, "&"),
5018 IBSLOT("__ixor__", nb_inplace_xor, slot_nb_inplace_xor,
5019 wrap_binaryfunc, "^"),
5020 IBSLOT("__ior__", nb_inplace_or, slot_nb_inplace_or,
5021 wrap_binaryfunc, "|"),
5022 BINSLOT("__floordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5023 RBINSLOT("__rfloordiv__", nb_floor_divide, slot_nb_floor_divide, "//"),
5024 BINSLOT("__truediv__", nb_true_divide, slot_nb_true_divide, "/"),
5025 RBINSLOT("__rtruediv__", nb_true_divide, slot_nb_true_divide, "/"),
5026 IBSLOT("__ifloordiv__", nb_inplace_floor_divide,
5027 slot_nb_inplace_floor_divide, wrap_binaryfunc, "//"),
5028 IBSLOT("__itruediv__", nb_inplace_true_divide,
5029 slot_nb_inplace_true_divide, wrap_binaryfunc, "/"),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005030
Guido van Rossum6d204072001-10-21 00:44:31 +00005031 TPSLOT("__str__", tp_str, slot_tp_str, wrap_unaryfunc,
5032 "x.__str__() <==> str(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005033 TPSLOT("__str__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005034 TPSLOT("__repr__", tp_repr, slot_tp_repr, wrap_unaryfunc,
5035 "x.__repr__() <==> repr(x)"),
Guido van Rossumafe7a942001-10-29 14:33:44 +00005036 TPSLOT("__repr__", tp_print, NULL, NULL, ""),
Guido van Rossum6d204072001-10-21 00:44:31 +00005037 TPSLOT("__cmp__", tp_compare, _PyObject_SlotCompare, wrap_cmpfunc,
5038 "x.__cmp__(y) <==> cmp(x,y)"),
5039 TPSLOT("__hash__", tp_hash, slot_tp_hash, wrap_hashfunc,
5040 "x.__hash__() <==> hash(x)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005041 FLSLOT("__call__", tp_call, slot_tp_call, (wrapperfunc)wrap_call,
5042 "x.__call__(...) <==> x(...)", PyWrapperFlag_KEYWORDS),
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005043 TPSLOT("__getattribute__", tp_getattro, slot_tp_getattr_hook,
Guido van Rossum6d204072001-10-21 00:44:31 +00005044 wrap_binaryfunc, "x.__getattribute__('name') <==> x.name"),
5045 TPSLOT("__getattribute__", tp_getattr, NULL, NULL, ""),
5046 TPSLOT("__getattr__", tp_getattro, slot_tp_getattr_hook, NULL, ""),
5047 TPSLOT("__getattr__", tp_getattr, NULL, NULL, ""),
5048 TPSLOT("__setattr__", tp_setattro, slot_tp_setattro, wrap_setattr,
5049 "x.__setattr__('name', value) <==> x.name = value"),
5050 TPSLOT("__setattr__", tp_setattr, NULL, NULL, ""),
5051 TPSLOT("__delattr__", tp_setattro, slot_tp_setattro, wrap_delattr,
5052 "x.__delattr__('name') <==> del x.name"),
5053 TPSLOT("__delattr__", tp_setattr, NULL, NULL, ""),
5054 TPSLOT("__lt__", tp_richcompare, slot_tp_richcompare, richcmp_lt,
5055 "x.__lt__(y) <==> x<y"),
5056 TPSLOT("__le__", tp_richcompare, slot_tp_richcompare, richcmp_le,
5057 "x.__le__(y) <==> x<=y"),
5058 TPSLOT("__eq__", tp_richcompare, slot_tp_richcompare, richcmp_eq,
5059 "x.__eq__(y) <==> x==y"),
5060 TPSLOT("__ne__", tp_richcompare, slot_tp_richcompare, richcmp_ne,
5061 "x.__ne__(y) <==> x!=y"),
5062 TPSLOT("__gt__", tp_richcompare, slot_tp_richcompare, richcmp_gt,
5063 "x.__gt__(y) <==> x>y"),
5064 TPSLOT("__ge__", tp_richcompare, slot_tp_richcompare, richcmp_ge,
5065 "x.__ge__(y) <==> x>=y"),
5066 TPSLOT("__iter__", tp_iter, slot_tp_iter, wrap_unaryfunc,
5067 "x.__iter__() <==> iter(x)"),
5068 TPSLOT("next", tp_iternext, slot_tp_iternext, wrap_next,
5069 "x.next() -> the next value, or raise StopIteration"),
5070 TPSLOT("__get__", tp_descr_get, slot_tp_descr_get, wrap_descr_get,
5071 "descr.__get__(obj[, type]) -> value"),
5072 TPSLOT("__set__", tp_descr_set, slot_tp_descr_set, wrap_descr_set,
5073 "descr.__set__(obj, value)"),
Guido van Rossum0dbab4c52002-08-01 14:39:25 +00005074 TPSLOT("__delete__", tp_descr_set, slot_tp_descr_set,
5075 wrap_descr_delete, "descr.__delete__(obj)"),
Guido van Rossumc8e56452001-10-22 00:43:43 +00005076 FLSLOT("__init__", tp_init, slot_tp_init, (wrapperfunc)wrap_init,
Guido van Rossum6d204072001-10-21 00:44:31 +00005077 "x.__init__(...) initializes x; "
Guido van Rossumc8e56452001-10-22 00:43:43 +00005078 "see x.__class__.__doc__ for signature",
5079 PyWrapperFlag_KEYWORDS),
5080 TPSLOT("__new__", tp_new, slot_tp_new, NULL, ""),
Guido van Rossumfebd61d2002-08-08 20:55:20 +00005081 TPSLOT("__del__", tp_del, slot_tp_del, NULL, ""),
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005082 {NULL}
5083};
5084
Guido van Rossumc334df52002-04-04 23:44:47 +00005085/* Given a type pointer and an offset gotten from a slotdef entry, return a
5086 pointer to the actual slot. This is not quite the same as simply adding
5087 the offset to the type pointer, since it takes care to indirect through the
5088 proper indirection pointer (as_buffer, etc.); it returns NULL if the
5089 indirection pointer is NULL. */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005090static void **
5091slotptr(PyTypeObject *type, int offset)
5092{
5093 char *ptr;
5094
Guido van Rossume5c691a2003-03-07 15:13:17 +00005095 /* Note: this depends on the order of the members of PyHeapTypeObject! */
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005096 assert(offset >= 0);
Guido van Rossume5c691a2003-03-07 15:13:17 +00005097 assert(offset < offsetof(PyHeapTypeObject, as_buffer));
5098 if (offset >= offsetof(PyHeapTypeObject, as_sequence)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005099 ptr = (void *)type->tp_as_sequence;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005100 offset -= offsetof(PyHeapTypeObject, as_sequence);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005101 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005102 else if (offset >= offsetof(PyHeapTypeObject, as_mapping)) {
Guido van Rossum09638c12002-06-13 19:17:46 +00005103 ptr = (void *)type->tp_as_mapping;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005104 offset -= offsetof(PyHeapTypeObject, as_mapping);
Guido van Rossum09638c12002-06-13 19:17:46 +00005105 }
Guido van Rossume5c691a2003-03-07 15:13:17 +00005106 else if (offset >= offsetof(PyHeapTypeObject, as_number)) {
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005107 ptr = (void *)type->tp_as_number;
Guido van Rossume5c691a2003-03-07 15:13:17 +00005108 offset -= offsetof(PyHeapTypeObject, as_number);
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005109 }
5110 else {
5111 ptr = (void *)type;
5112 }
5113 if (ptr != NULL)
5114 ptr += offset;
5115 return (void **)ptr;
5116}
Guido van Rossumf040ede2001-08-07 16:40:56 +00005117
Guido van Rossumc334df52002-04-04 23:44:47 +00005118/* Length of array of slotdef pointers used to store slots with the
5119 same __name__. There should be at most MAX_EQUIV-1 slotdef entries with
5120 the same __name__, for any __name__. Since that's a static property, it is
5121 appropriate to declare fixed-size arrays for this. */
5122#define MAX_EQUIV 10
5123
5124/* Return a slot pointer for a given name, but ONLY if the attribute has
5125 exactly one slot function. The name must be an interned string. */
5126static void **
5127resolve_slotdups(PyTypeObject *type, PyObject *name)
5128{
5129 /* XXX Maybe this could be optimized more -- but is it worth it? */
5130
5131 /* pname and ptrs act as a little cache */
5132 static PyObject *pname;
5133 static slotdef *ptrs[MAX_EQUIV];
5134 slotdef *p, **pp;
5135 void **res, **ptr;
5136
5137 if (pname != name) {
5138 /* Collect all slotdefs that match name into ptrs. */
5139 pname = name;
5140 pp = ptrs;
5141 for (p = slotdefs; p->name_strobj; p++) {
5142 if (p->name_strobj == name)
5143 *pp++ = p;
5144 }
5145 *pp = NULL;
5146 }
5147
5148 /* Look in all matching slots of the type; if exactly one of these has
5149 a filled-in slot, return its value. Otherwise return NULL. */
5150 res = NULL;
5151 for (pp = ptrs; *pp; pp++) {
5152 ptr = slotptr(type, (*pp)->offset);
5153 if (ptr == NULL || *ptr == NULL)
5154 continue;
5155 if (res != NULL)
5156 return NULL;
5157 res = ptr;
5158 }
5159 return res;
5160}
5161
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005162/* Common code for update_slots_callback() and fixup_slot_dispatchers(). This
Guido van Rossumc334df52002-04-04 23:44:47 +00005163 does some incredibly complex thinking and then sticks something into the
5164 slot. (It sees if the adjacent slotdefs for the same slot have conflicting
5165 interests, and then stores a generic wrapper or a specific function into
5166 the slot.) Return a pointer to the next slotdef with a different offset,
5167 because that's convenient for fixup_slot_dispatchers(). */
5168static slotdef *
5169update_one_slot(PyTypeObject *type, slotdef *p)
5170{
5171 PyObject *descr;
5172 PyWrapperDescrObject *d;
5173 void *generic = NULL, *specific = NULL;
5174 int use_generic = 0;
5175 int offset = p->offset;
5176 void **ptr = slotptr(type, offset);
5177
5178 if (ptr == NULL) {
5179 do {
5180 ++p;
5181 } while (p->offset == offset);
5182 return p;
5183 }
5184 do {
5185 descr = _PyType_Lookup(type, p->name_strobj);
5186 if (descr == NULL)
5187 continue;
5188 if (descr->ob_type == &PyWrapperDescr_Type) {
5189 void **tptr = resolve_slotdups(type, p->name_strobj);
5190 if (tptr == NULL || tptr == ptr)
5191 generic = p->function;
5192 d = (PyWrapperDescrObject *)descr;
5193 if (d->d_base->wrapper == p->wrapper &&
5194 PyType_IsSubtype(type, d->d_type))
5195 {
5196 if (specific == NULL ||
5197 specific == d->d_wrapped)
5198 specific = d->d_wrapped;
5199 else
5200 use_generic = 1;
5201 }
5202 }
Guido van Rossum721f62e2002-08-09 02:14:34 +00005203 else if (descr->ob_type == &PyCFunction_Type &&
5204 PyCFunction_GET_FUNCTION(descr) ==
5205 (PyCFunction)tp_new_wrapper &&
5206 strcmp(p->name, "__new__") == 0)
5207 {
5208 /* The __new__ wrapper is not a wrapper descriptor,
5209 so must be special-cased differently.
5210 If we don't do this, creating an instance will
5211 always use slot_tp_new which will look up
5212 __new__ in the MRO which will call tp_new_wrapper
5213 which will look through the base classes looking
5214 for a static base and call its tp_new (usually
5215 PyType_GenericNew), after performing various
5216 sanity checks and constructing a new argument
5217 list. Cut all that nonsense short -- this speeds
5218 up instance creation tremendously. */
Martin v. Löwisa94568a2003-05-10 07:36:56 +00005219 specific = (void *)type->tp_new;
Guido van Rossum721f62e2002-08-09 02:14:34 +00005220 /* XXX I'm not 100% sure that there isn't a hole
5221 in this reasoning that requires additional
5222 sanity checks. I'll buy the first person to
5223 point out a bug in this reasoning a beer. */
5224 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005225 else {
5226 use_generic = 1;
5227 generic = p->function;
5228 }
5229 } while ((++p)->offset == offset);
5230 if (specific && !use_generic)
5231 *ptr = specific;
5232 else
5233 *ptr = generic;
5234 return p;
5235}
5236
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005237/* In the type, update the slots whose slotdefs are gathered in the pp array.
5238 This is a callback for update_subclasses(). */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005239static int
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005240update_slots_callback(PyTypeObject *type, void *data)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005241{
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005242 slotdef **pp = (slotdef **)data;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005243
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005244 for (; *pp; pp++)
Guido van Rossumc334df52002-04-04 23:44:47 +00005245 update_one_slot(type, *pp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005246 return 0;
5247}
5248
Guido van Rossumc334df52002-04-04 23:44:47 +00005249/* Comparison function for qsort() to compare slotdefs by their offset, and
5250 for equal offset by their address (to force a stable sort). */
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005251static int
5252slotdef_cmp(const void *aa, const void *bb)
5253{
5254 const slotdef *a = (const slotdef *)aa, *b = (const slotdef *)bb;
5255 int c = a->offset - b->offset;
5256 if (c != 0)
5257 return c;
5258 else
5259 return a - b;
5260}
5261
Guido van Rossumc334df52002-04-04 23:44:47 +00005262/* Initialize the slotdefs table by adding interned string objects for the
5263 names and sorting the entries. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005264static void
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005265init_slotdefs(void)
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005266{
5267 slotdef *p;
5268 static int initialized = 0;
5269
5270 if (initialized)
5271 return;
5272 for (p = slotdefs; p->name; p++) {
5273 p->name_strobj = PyString_InternFromString(p->name);
5274 if (!p->name_strobj)
Guido van Rossumc334df52002-04-04 23:44:47 +00005275 Py_FatalError("Out of memory interning slotdef names");
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005276 }
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005277 qsort((void *)slotdefs, (size_t)(p-slotdefs), sizeof(slotdef),
5278 slotdef_cmp);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005279 initialized = 1;
5280}
5281
Guido van Rossumc334df52002-04-04 23:44:47 +00005282/* Update the slots after assignment to a class (type) attribute. */
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005283static int
5284update_slot(PyTypeObject *type, PyObject *name)
5285{
Guido van Rossumc334df52002-04-04 23:44:47 +00005286 slotdef *ptrs[MAX_EQUIV];
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005287 slotdef *p;
5288 slotdef **pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005289 int offset;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005290
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005291 init_slotdefs();
5292 pp = ptrs;
5293 for (p = slotdefs; p->name; p++) {
5294 /* XXX assume name is interned! */
5295 if (p->name_strobj == name)
5296 *pp++ = p;
5297 }
5298 *pp = NULL;
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005299 for (pp = ptrs; *pp; pp++) {
5300 p = *pp;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005301 offset = p->offset;
5302 while (p > slotdefs && (p-1)->offset == offset)
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005303 --p;
Guido van Rossumb85a8b72001-10-16 17:00:48 +00005304 *pp = p;
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005305 }
Guido van Rossumc334df52002-04-04 23:44:47 +00005306 if (ptrs[0] == NULL)
5307 return 0; /* Not an attribute that affects any slots */
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005308 return update_subclasses(type, name,
5309 update_slots_callback, (void *)ptrs);
Guido van Rossum875eeaa2001-10-11 18:33:53 +00005310}
5311
Guido van Rossumc334df52002-04-04 23:44:47 +00005312/* Store the proper functions in the slot dispatches at class (type)
5313 definition time, based upon which operations the class overrides in its
5314 dict. */
Tim Peters6d6c1a32001-08-02 04:15:00 +00005315static void
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005316fixup_slot_dispatchers(PyTypeObject *type)
Tim Peters6d6c1a32001-08-02 04:15:00 +00005317{
Guido van Rossum7b9144b2001-10-09 19:39:46 +00005318 slotdef *p;
Tim Peters6d6c1a32001-08-02 04:15:00 +00005319
Guido van Rossumd396b9c2001-10-13 20:02:41 +00005320 init_slotdefs();
Guido van Rossumc334df52002-04-04 23:44:47 +00005321 for (p = slotdefs; p->name; )
5322 p = update_one_slot(type, p);
Tim Peters6d6c1a32001-08-02 04:15:00 +00005323}
Guido van Rossum705f0f52001-08-24 16:47:00 +00005324
Michael W. Hudson98bbc492002-11-26 14:47:27 +00005325static void
5326update_all_slots(PyTypeObject* type)
5327{
5328 slotdef *p;
5329
5330 init_slotdefs();
5331 for (p = slotdefs; p->name; p++) {
5332 /* update_slot returns int but can't actually fail */
5333 update_slot(type, p->name_strobj);
5334 }
5335}
5336
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005337/* recurse_down_subclasses() and update_subclasses() are mutually
5338 recursive functions to call a callback for all subclasses,
5339 but refraining from recursing into subclasses that define 'name'. */
5340
5341static int
5342update_subclasses(PyTypeObject *type, PyObject *name,
5343 update_callback callback, void *data)
5344{
5345 if (callback(type, data) < 0)
5346 return -1;
5347 return recurse_down_subclasses(type, name, callback, data);
5348}
5349
5350static int
5351recurse_down_subclasses(PyTypeObject *type, PyObject *name,
5352 update_callback callback, void *data)
5353{
5354 PyTypeObject *subclass;
5355 PyObject *ref, *subclasses, *dict;
5356 int i, n;
5357
5358 subclasses = type->tp_subclasses;
5359 if (subclasses == NULL)
5360 return 0;
5361 assert(PyList_Check(subclasses));
5362 n = PyList_GET_SIZE(subclasses);
5363 for (i = 0; i < n; i++) {
5364 ref = PyList_GET_ITEM(subclasses, i);
5365 assert(PyWeakref_CheckRef(ref));
5366 subclass = (PyTypeObject *)PyWeakref_GET_OBJECT(ref);
5367 assert(subclass != NULL);
5368 if ((PyObject *)subclass == Py_None)
5369 continue;
5370 assert(PyType_Check(subclass));
5371 /* Avoid recursing down into unaffected classes */
5372 dict = subclass->tp_dict;
5373 if (dict != NULL && PyDict_Check(dict) &&
5374 PyDict_GetItem(dict, name) != NULL)
5375 continue;
5376 if (update_subclasses(subclass, name, callback, data) < 0)
5377 return -1;
5378 }
5379 return 0;
5380}
5381
Guido van Rossum6d204072001-10-21 00:44:31 +00005382/* This function is called by PyType_Ready() to populate the type's
5383 dictionary with method descriptors for function slots. For each
Guido van Rossum09638c12002-06-13 19:17:46 +00005384 function slot (like tp_repr) that's defined in the type, one or more
5385 corresponding descriptors are added in the type's tp_dict dictionary
5386 under the appropriate name (like __repr__). Some function slots
5387 cause more than one descriptor to be added (for example, the nb_add
5388 slot adds both __add__ and __radd__ descriptors) and some function
5389 slots compete for the same descriptor (for example both sq_item and
5390 mp_subscript generate a __getitem__ descriptor).
5391
5392 In the latter case, the first slotdef entry encoutered wins. Since
Tim Petersbf9b2442003-03-23 05:35:36 +00005393 slotdef entries are sorted by the offset of the slot in the
Guido van Rossume5c691a2003-03-07 15:13:17 +00005394 PyHeapTypeObject, this gives us some control over disambiguating
Guido van Rossum8d24ee92003-03-24 23:49:49 +00005395 between competing slots: the members of PyHeapTypeObject are listed
5396 from most general to least general, so the most general slot is
5397 preferred. In particular, because as_mapping comes before as_sequence,
5398 for a type that defines both mp_subscript and sq_item, mp_subscript
5399 wins.
Guido van Rossum09638c12002-06-13 19:17:46 +00005400
5401 This only adds new descriptors and doesn't overwrite entries in
5402 tp_dict that were previously defined. The descriptors contain a
5403 reference to the C function they must call, so that it's safe if they
5404 are copied into a subtype's __dict__ and the subtype has a different
5405 C function in its slot -- calling the method defined by the
5406 descriptor will call the C function that was used to create it,
5407 rather than the C function present in the slot when it is called.
5408 (This is important because a subtype may have a C function in the
5409 slot that calls the method from the dictionary, and we want to avoid
5410 infinite recursion here.) */
Guido van Rossum6d204072001-10-21 00:44:31 +00005411
5412static int
5413add_operators(PyTypeObject *type)
5414{
5415 PyObject *dict = type->tp_dict;
5416 slotdef *p;
5417 PyObject *descr;
5418 void **ptr;
5419
5420 init_slotdefs();
5421 for (p = slotdefs; p->name; p++) {
5422 if (p->wrapper == NULL)
5423 continue;
5424 ptr = slotptr(type, p->offset);
5425 if (!ptr || !*ptr)
5426 continue;
5427 if (PyDict_GetItem(dict, p->name_strobj))
5428 continue;
5429 descr = PyDescr_NewWrapper(type, p, *ptr);
5430 if (descr == NULL)
5431 return -1;
5432 if (PyDict_SetItem(dict, p->name_strobj, descr) < 0)
5433 return -1;
5434 Py_DECREF(descr);
5435 }
5436 if (type->tp_new != NULL) {
5437 if (add_tp_new_wrapper(type) < 0)
5438 return -1;
5439 }
5440 return 0;
5441}
5442
Guido van Rossum705f0f52001-08-24 16:47:00 +00005443
5444/* Cooperative 'super' */
5445
5446typedef struct {
5447 PyObject_HEAD
Guido van Rossume705ef12001-08-29 15:47:06 +00005448 PyTypeObject *type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005449 PyObject *obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005450 PyTypeObject *obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005451} superobject;
5452
Guido van Rossum6f799372001-09-20 20:46:19 +00005453static PyMemberDef super_members[] = {
5454 {"__thisclass__", T_OBJECT, offsetof(superobject, type), READONLY,
5455 "the class invoking super()"},
5456 {"__self__", T_OBJECT, offsetof(superobject, obj), READONLY,
5457 "the instance invoking super(); may be None"},
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005458 {"__self_class__", T_OBJECT, offsetof(superobject, obj_type), READONLY,
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +00005459 "the type of the instance invoking super(); may be None"},
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005460 {0}
5461};
5462
Guido van Rossum705f0f52001-08-24 16:47:00 +00005463static void
5464super_dealloc(PyObject *self)
5465{
5466 superobject *su = (superobject *)self;
5467
Guido van Rossum048eb752001-10-02 21:24:57 +00005468 _PyObject_GC_UNTRACK(self);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005469 Py_XDECREF(su->obj);
5470 Py_XDECREF(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005471 Py_XDECREF(su->obj_type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005472 self->ob_type->tp_free(self);
5473}
5474
5475static PyObject *
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005476super_repr(PyObject *self)
5477{
5478 superobject *su = (superobject *)self;
5479
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005480 if (su->obj_type)
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005481 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005482 "<super: <class '%s'>, <%s object>>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005483 su->type ? su->type->tp_name : "NULL",
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005484 su->obj_type->tp_name);
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005485 else
5486 return PyString_FromFormat(
Guido van Rossuma4cb7882001-09-25 03:56:29 +00005487 "<super: <class '%s'>, NULL>",
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005488 su->type ? su->type->tp_name : "NULL");
5489}
5490
5491static PyObject *
Guido van Rossum705f0f52001-08-24 16:47:00 +00005492super_getattro(PyObject *self, PyObject *name)
5493{
5494 superobject *su = (superobject *)self;
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005495 int skip = su->obj_type == NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005496
Guido van Rossum76ba09f2003-04-16 19:40:58 +00005497 if (!skip) {
5498 /* We want __class__ to return the class of the super object
5499 (i.e. super, or a subclass), not the class of su->obj. */
5500 skip = (PyString_Check(name) &&
5501 PyString_GET_SIZE(name) == 9 &&
5502 strcmp(PyString_AS_STRING(name), "__class__") == 0);
5503 }
5504
5505 if (!skip) {
Tim Petersa91e9642001-11-14 23:32:33 +00005506 PyObject *mro, *res, *tmp, *dict;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005507 PyTypeObject *starttype;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005508 descrgetfunc f;
5509 int i, n;
5510
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005511 starttype = su->obj_type;
Guido van Rossum155db9a2002-04-02 17:53:47 +00005512 mro = starttype->tp_mro;
5513
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005514 if (mro == NULL)
5515 n = 0;
5516 else {
5517 assert(PyTuple_Check(mro));
5518 n = PyTuple_GET_SIZE(mro);
5519 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005520 for (i = 0; i < n; i++) {
Guido van Rossume705ef12001-08-29 15:47:06 +00005521 if ((PyObject *)(su->type) == PyTuple_GET_ITEM(mro, i))
Guido van Rossum705f0f52001-08-24 16:47:00 +00005522 break;
5523 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005524 i++;
5525 res = NULL;
5526 for (; i < n; i++) {
5527 tmp = PyTuple_GET_ITEM(mro, i);
Tim Petersa91e9642001-11-14 23:32:33 +00005528 if (PyType_Check(tmp))
5529 dict = ((PyTypeObject *)tmp)->tp_dict;
5530 else if (PyClass_Check(tmp))
5531 dict = ((PyClassObject *)tmp)->cl_dict;
5532 else
5533 continue;
5534 res = PyDict_GetItem(dict, name);
Guido van Rossum6cc5bb62003-04-16 20:01:36 +00005535 if (res != NULL) {
Guido van Rossum705f0f52001-08-24 16:47:00 +00005536 Py_INCREF(res);
5537 f = res->ob_type->tp_descr_get;
5538 if (f != NULL) {
Guido van Rossumd4641072002-04-03 02:13:37 +00005539 tmp = f(res, su->obj,
5540 (PyObject *)starttype);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005541 Py_DECREF(res);
5542 res = tmp;
5543 }
5544 return res;
5545 }
5546 }
5547 }
5548 return PyObject_GenericGetAttr(self, name);
5549}
5550
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005551static PyTypeObject *
Guido van Rossum5b443c62001-12-03 15:38:28 +00005552supercheck(PyTypeObject *type, PyObject *obj)
5553{
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005554 /* Check that a super() call makes sense. Return a type object.
5555
5556 obj can be a new-style class, or an instance of one:
5557
5558 - If it is a class, it must be a subclass of 'type'. This case is
5559 used for class methods; the return value is obj.
5560
5561 - If it is an instance, it must be an instance of 'type'. This is
5562 the normal case; the return value is obj.__class__.
5563
5564 But... when obj is an instance, we want to allow for the case where
5565 obj->ob_type is not a subclass of type, but obj.__class__ is!
5566 This will allow using super() with a proxy for obj.
5567 */
5568
Guido van Rossum8e80a722003-02-18 19:22:22 +00005569 /* Check for first bullet above (special case) */
5570 if (PyType_Check(obj) && PyType_IsSubtype((PyTypeObject *)obj, type)) {
5571 Py_INCREF(obj);
5572 return (PyTypeObject *)obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005573 }
Guido van Rossum8e80a722003-02-18 19:22:22 +00005574
5575 /* Normal case */
5576 if (PyType_IsSubtype(obj->ob_type, type)) {
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005577 Py_INCREF(obj->ob_type);
5578 return obj->ob_type;
5579 }
5580 else {
5581 /* Try the slow way */
5582 static PyObject *class_str = NULL;
5583 PyObject *class_attr;
5584
5585 if (class_str == NULL) {
5586 class_str = PyString_FromString("__class__");
5587 if (class_str == NULL)
5588 return NULL;
5589 }
5590
5591 class_attr = PyObject_GetAttr(obj, class_str);
5592
5593 if (class_attr != NULL &&
5594 PyType_Check(class_attr) &&
5595 (PyTypeObject *)class_attr != obj->ob_type)
5596 {
5597 int ok = PyType_IsSubtype(
5598 (PyTypeObject *)class_attr, type);
5599 if (ok)
5600 return (PyTypeObject *)class_attr;
5601 }
5602
5603 if (class_attr == NULL)
5604 PyErr_Clear();
5605 else
5606 Py_DECREF(class_attr);
5607 }
5608
Tim Peters97e5ff52003-02-18 19:32:50 +00005609 PyErr_SetString(PyExc_TypeError,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005610 "super(type, obj): "
5611 "obj must be an instance or subtype of type");
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005612 return NULL;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005613}
5614
Guido van Rossum705f0f52001-08-24 16:47:00 +00005615static PyObject *
5616super_descr_get(PyObject *self, PyObject *obj, PyObject *type)
5617{
5618 superobject *su = (superobject *)self;
5619 superobject *new;
5620
5621 if (obj == NULL || obj == Py_None || su->obj != NULL) {
5622 /* Not binding to an object, or already bound */
5623 Py_INCREF(self);
5624 return self;
5625 }
Guido van Rossum5b443c62001-12-03 15:38:28 +00005626 if (su->ob_type != &PySuper_Type)
Brett Cannon10147f72003-06-11 20:50:33 +00005627 /* If su is not an instance of a subclass of super,
Guido van Rossum5b443c62001-12-03 15:38:28 +00005628 call its type */
5629 return PyObject_CallFunction((PyObject *)su->ob_type,
5630 "OO", su->type, obj);
5631 else {
5632 /* Inline the common case */
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005633 PyTypeObject *obj_type = supercheck(su->type, obj);
5634 if (obj_type == NULL)
Guido van Rossum5b443c62001-12-03 15:38:28 +00005635 return NULL;
5636 new = (superobject *)PySuper_Type.tp_new(&PySuper_Type,
5637 NULL, NULL);
5638 if (new == NULL)
5639 return NULL;
5640 Py_INCREF(su->type);
5641 Py_INCREF(obj);
5642 new->type = su->type;
5643 new->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005644 new->obj_type = obj_type;
Guido van Rossum5b443c62001-12-03 15:38:28 +00005645 return (PyObject *)new;
5646 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005647}
5648
5649static int
5650super_init(PyObject *self, PyObject *args, PyObject *kwds)
5651{
5652 superobject *su = (superobject *)self;
Guido van Rossume705ef12001-08-29 15:47:06 +00005653 PyTypeObject *type;
5654 PyObject *obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005655 PyTypeObject *obj_type = NULL;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005656
5657 if (!PyArg_ParseTuple(args, "O!|O:super", &PyType_Type, &type, &obj))
5658 return -1;
5659 if (obj == Py_None)
5660 obj = NULL;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005661 if (obj != NULL) {
5662 obj_type = supercheck(type, obj);
5663 if (obj_type == NULL)
5664 return -1;
5665 Py_INCREF(obj);
5666 }
Guido van Rossum705f0f52001-08-24 16:47:00 +00005667 Py_INCREF(type);
Guido van Rossum705f0f52001-08-24 16:47:00 +00005668 su->type = type;
5669 su->obj = obj;
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005670 su->obj_type = obj_type;
Guido van Rossum705f0f52001-08-24 16:47:00 +00005671 return 0;
5672}
5673
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005674PyDoc_STRVAR(super_doc,
Guido van Rossum705f0f52001-08-24 16:47:00 +00005675"super(type) -> unbound super object\n"
5676"super(type, obj) -> bound super object; requires isinstance(obj, type)\n"
Guido van Rossume705ef12001-08-29 15:47:06 +00005677"super(type, type2) -> bound super object; requires issubclass(type2, type)\n"
Guido van Rossum705f0f52001-08-24 16:47:00 +00005678"Typical use to call a cooperative superclass method:\n"
5679"class C(B):\n"
5680" def meth(self, arg):\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005681" super(C, self).meth(arg)");
Guido van Rossum705f0f52001-08-24 16:47:00 +00005682
Guido van Rossum048eb752001-10-02 21:24:57 +00005683static int
5684super_traverse(PyObject *self, visitproc visit, void *arg)
5685{
5686 superobject *su = (superobject *)self;
5687 int err;
5688
5689#define VISIT(SLOT) \
5690 if (SLOT) { \
5691 err = visit((PyObject *)(SLOT), arg); \
5692 if (err) \
5693 return err; \
5694 }
5695
5696 VISIT(su->obj);
5697 VISIT(su->type);
Guido van Rossuma89d10e2003-02-12 03:58:38 +00005698 VISIT(su->obj_type);
Guido van Rossum048eb752001-10-02 21:24:57 +00005699
5700#undef VISIT
5701
5702 return 0;
5703}
5704
Guido van Rossum705f0f52001-08-24 16:47:00 +00005705PyTypeObject PySuper_Type = {
5706 PyObject_HEAD_INIT(&PyType_Type)
5707 0, /* ob_size */
5708 "super", /* tp_name */
5709 sizeof(superobject), /* tp_basicsize */
5710 0, /* tp_itemsize */
5711 /* methods */
5712 super_dealloc, /* tp_dealloc */
5713 0, /* tp_print */
5714 0, /* tp_getattr */
5715 0, /* tp_setattr */
5716 0, /* tp_compare */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005717 super_repr, /* tp_repr */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005718 0, /* tp_as_number */
5719 0, /* tp_as_sequence */
5720 0, /* tp_as_mapping */
5721 0, /* tp_hash */
5722 0, /* tp_call */
5723 0, /* tp_str */
5724 super_getattro, /* tp_getattro */
5725 0, /* tp_setattro */
5726 0, /* tp_as_buffer */
Guido van Rossum048eb752001-10-02 21:24:57 +00005727 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |
5728 Py_TPFLAGS_BASETYPE, /* tp_flags */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005729 super_doc, /* tp_doc */
Guido van Rossum048eb752001-10-02 21:24:57 +00005730 super_traverse, /* tp_traverse */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005731 0, /* tp_clear */
5732 0, /* tp_richcompare */
5733 0, /* tp_weaklistoffset */
5734 0, /* tp_iter */
5735 0, /* tp_iternext */
5736 0, /* tp_methods */
Guido van Rossum41eb14d2001-08-30 23:13:11 +00005737 super_members, /* tp_members */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005738 0, /* tp_getset */
5739 0, /* tp_base */
5740 0, /* tp_dict */
5741 super_descr_get, /* tp_descr_get */
5742 0, /* tp_descr_set */
5743 0, /* tp_dictoffset */
5744 super_init, /* tp_init */
5745 PyType_GenericAlloc, /* tp_alloc */
5746 PyType_GenericNew, /* tp_new */
Neil Schemenauer09a2ae52002-04-12 03:06:53 +00005747 PyObject_GC_Del, /* tp_free */
Guido van Rossum705f0f52001-08-24 16:47:00 +00005748};